Method Maps2
SymbolDescription
GlobalForward
PrivateForward
Enumerations2
SymbolDescription
ExecTypeDefines how a forward iterates through plugin functions.
ParamTypeDescribes the various ways to pass parameters to functions or forwards.
Type Sets2
SymbolDescription
NativeCall
RequestFrameCallbackDefines a RequestFrame Callback.
Defines31
SymbolDescription
SM_PARAM_COPYBACKCopy an array/reference back after call
SM_PARAM_STRING_BINARYTreat the string as a binary string
SM_PARAM_STRING_COPYString should be copied into the plugin
SM_PARAM_STRING_UTF8String should be UTF-8 handled
SP_ERROR_ABORTEDFunction call was aborted
SP_ERROR_ARRAY_BOUNDSArray index is out of bounds
SP_ERROR_ARRAY_TOO_BIGA dynamic array is too big
SP_ERROR_DECOMPRESSORA decompressor was not found
SP_ERROR_DIVIDE_BY_ZERODivision by zero
SP_ERROR_FILE_FORMATFile format unrecognized
SP_ERROR_HEAPLEAKA native leaked an item on the heap
SP_ERROR_HEAPLOWNot enough space left on the heap
SP_ERROR_HEAPMINHeap went beyond its minimum value
SP_ERROR_INDEXInvalid index parameter
SP_ERROR_INSTRUCTION_PARAMInstruction had an invalid parameter
SP_ERROR_INVALID_ADDRESSA memory address was not valid
SP_ERROR_INVALID_INSTRUCTIONInvalid instruction was encountered
SP_ERROR_INVALID_NATIVENative was pending or invalid
SP_ERROR_MEMACCESSInvalid memory access
SP_ERROR_NATIVEError originates from a native
SP_ERROR_NONENo error occurred
SP_ERROR_NOT_FOUNDThe object in question was not found
SP_ERROR_NOT_RUNNABLEFunction or plugin is not runnable
SP_ERROR_NOTDEBUGGINGDebug mode was not on or debug section not found
SP_ERROR_PARAMInvalid parameter or parameter type
SP_ERROR_PARAMS_MAXMaximum number of parameters reached
SP_ERROR_STACKLEAKA native leaked an item on the stack
SP_ERROR_STACKLOWNot enough space left on the stack
SP_ERROR_STACKMINStack went beyond its minimum value
SP_ERROR_TRACKER_BOUNDSTracker stack is out of bounds
SP_PARAMFLAG_BYREFInternal use only.
Functions34
SymbolDescription
AddToForwardAdds a function to a private forward's call list.
Call_CancelCancels a call to a function or forward's call list.
Call_FinishCompletes a call to a function or forward's call list.
Call_PushArrayPushes an array onto the current call.
Call_PushArrayExPushes an array onto the current call.
Call_PushCellPushes a cell onto the current call.
Call_PushCellRefPushes a cell by reference onto the current call.
Call_PushFloatPushes a float onto the current call.
Call_PushFloatRefPushes a float by reference onto the current call.
Call_PushStringPushes a string onto the current call.
Call_PushStringExPushes a string onto the current call.
Call_StartForwardStarts a call to functions in a forward's call list.
Call_StartFunctionStarts a call to a function.
CreateForwardCreates a private forward.
CreateGlobalForwardCreates a global forward.
CreateNativeCreates a dynamic native. This should only be called in AskPluginLoad(), or else you risk not having your native shared with other plugins.
FormatNativeStringFormats a string using parameters from a native.
GetForwardFunctionCountReturns the number of functions in a global or private forward's call list.
GetFunctionByNameGets a function id from a function name.
GetNativeArrayGets an array from a native parameter (always by reference).
GetNativeCellGets a cell from a native parameter.
GetNativeCellRefGets a cell from a native parameter, by reference.
GetNativeFunctionGets a function pointer from a native parameter.
GetNativeStringRetrieves a string from a native parameter.
GetNativeStringLengthRetrieves the string length from a native parameter string. This is useful for fetching the entire string using dynamic arrays.
IsNativeParamNullStringCheck if the native parameter is the NULL_STRING.
IsNativeParamNullVectorCheck if the native parameter is the NULL_VECTOR.
RemoveAllFromForwardRemoves all instances of a plugin from a private forward's call list.
RemoveFromForwardRemoves a function from a private forward's call list.
RequestFrameCreates a single use Next Frame hook.
SetNativeArrayCopies a local array into a native parameter array (always by reference).
SetNativeCellRefSets a cell from a native parameter, by reference.
SetNativeStringSets a string in a native parameter.
ThrowNativeErrorThrows an error in the calling plugin of a native, instead of your own plugin.