Next: GetScriptData

Retrieves a pointer to the CScript object for a given script ID.

Syntax

AurieStatus GetScriptData(
    [in]  int       Index,
    [out] CScript*& Script
);

Parameters

Index

The index of an element within the runner's script array, the data of which to retrieve. Please note that while the GameMaker engine scripts' IDs are generally above 100000, this isn't the case for raw array accesses. To convert a script's ID retrieved from GameMaker functions to an array index, callers must subtract 100000 from the script's ID.

Script

A reference to a pointer-sized buffer, into which the address of the script's data will be written. The contents of this buffer are guaranteed to be left untouched if the function fails.

Return Value

The function returns AURIE_SUCCESS on success, otherwise returns a matching error code. If the internal runner function needed for indexing the script array isn't available, the AURIE_MODULE_INTERNAL_ERROR status code is returned. The function returns AURIE_OBJECT_NOT_FOUND array index provided via the Index parameter is out of bounds.