API Reference | developer.brewmp.com API Reference | developer.brewmp.com

Developer

API Reference

ILUAEX_CHECKINTERFACE()

Brew Release
Brew MP 1.0.2
See Also
ILua_IsInterface(), ILua_ToInterface(), ILua_PushInterface(),
Description
Verifies the element at position nIndex on the Lua stack is an object with the given interface ID and returns the pointer to its IQI-derived interface. If the object is not an IQI-derived interface object or if the IID does not match, then this function will raise an error.
Like the other ILua_Check() family of functions, this function should preferably be called in a protected environment, and with positive argument values best used to check C function arguments.
Params
pif
[]:
a pointer to the ILua object
nIndex
[]:
the argument index of the object to check
iid
[]:
the interface ID of the object, if known. May be 0 or AEEIID_IQI if unknown or if validation is not desired
Interface
Prototype
  •    IQI* ILua_CheckInterface(ILua *pif, int nIndex, AEEIID iid)
    
Return
  • An IQI* pointer that can be downcasted to the desired interface type matching iid.
Side Effect
  • This function does not return, but if the argument is not an interface type it will throw an error.