Developer

API Reference

ILua_Ref()

Brew Release
Brew MP 1.0.2
See Also
ILua_UnRef(), ILua_RawGetI(), ILua_REGISTRYINDEX
Description
Creates a reference, a unique integer key in the table at the given index, to the object that is popped from the top of the stack. This reference can be used to later retrieve the object from the same table using ILua_RawGetI(). The reference may be freed using ILua_UnRef().
Parameters
  • pif
    []:
    a pointer to the ILua object
  • nIndex
    []:
    index of the table in whic hto create the reference
  • pnRef
    []:
    a pointer to resulting value, a unique integer index to the given table whose value is the referred object. If the object at the top of the stack was nil, this function returns ILua_REFNIL. All return values are guaranteed to be different from ILua_NOREF.
Interface
Prototype
   AEEResult ILua_Ref(ILua *pif, int nIndex, int *pnRef)
Return
Returns 0 or the value specific to the type of collection task.
  • Follow