Legacy: GetGlobalInstance routine

You are reading the documentation of YYToolkit Legacy (v2.x.x) - for documentation on current-gen YYTK, see the Homepage.

---

Returns the global GML namespace as a CInstance pointer.

Syntax

bool GetGlobalInstance(
    CInstance*& outInstance
);

Parameters

outInstance

A reference to a CInstance pointer, to which the pointer to the global namespace will be written.

Return Value

The function returns true if the function succeeds and outInstance is populated.

Otherwise, the function returns false and outInstance's contents are unchanged.

Remarks

Due to how lookups of the global instance work in recent YYToolkit versions, the function will fail if the runner doesn't have the @@GlobalScope@@ function. This shouldn't be the case in anything newer than GMS version 1.4.9999.