Documentation

Global namespace

Namespace

The global namespace.

Base array structure type used in ManiaPlanet. Can not be modified right now.

Strided array structure type used in ManiaPlanet. Can not be modified right now.

Array type used in ManiaPlanet.

Buffer type used in ManiaPlanet.

Buffer cat type used in ManiaPlanet.

Reference buffer type used in ManiaPlanet, which contains a static 32 item buffer.

An allocated pool of nods.

A virtually accessed array.

The main array type used in Openplanet. For usage information, see Angelscript's documentation. Note that the members are not named the same in Openplanet as they are normally in Angelscript.

The string class used in Openplanet as well as the game.

The wide string class used primarily in the game for unicode strings. Since Trackmania (2020) the game switched to UTF-8 by default, making wstring essentially the same as string.

The main dictionary type used in Openplanet.

A 2-dimensional vector.

A 3-dimensional vector.

A 4-dimensional vector.

A 2-dimensional vector for integers.

A 3-dimensional vector for integers.

A 2-dimensional vector for unsigned integers.

A 3-dimensional vector for unsigned integers.

A matrix with 3 rows and 2 columns.

A matrix with 3 rows and 3 columns.

A matrix with 4 rows and 3 columns.

A matrix with 4 rows and 4 columns.

A quaternion.

The RGBAColor type used in Maniaplanet.

A buffer of memory. Can be used in IO or Import calls. You can write to this or read from it, which moves the cursor within the buffer.

The data reference type used in Maniaplanet.

Stack class used for calling engine procs.

Returns a string representation of the given object, if possible. Will call an object's ToString() method if it exists. Throws an exception if it was unable to.

Returns string

Prints a trace to Openplanet's log.

Prints a line to Openplanet's log.

Prints a warning to Openplanet's log.

Prints an error to Openplanet's log.

Prints a trace to Openplanet's log. Will call a passed object's ToString() method if it exists.

Prints a line to Openplanet's log. Will call a passed object's ToString() method if it exists.

Prints a warning to Openplanet's log. Will call a passed object's ToString() method if it exists.

Prints an error to Openplanet's log. Will call a passed object's ToString() method if it exists.

Throws a script exception.

Returns the exception string.

Returns string

Yields the current execution for a given period of time. Execution will be resumed after that time.

Yields the current execution. Execution will be resumed the next game tick. This is the same as calling yield(1).

Yields the current execution for a specific number of frames. Execution will be resumed after the given number of frames have passed. Do not use this function to yield for a specific time as this function is framerate dependant - use sleep() for that instead.

Yields the current execution until the given coroutine has finished.

Yields the current execution until all the given coroutines have finished.

Yields the current execution until at least 1 of the given coroutines have finished.

Starts a new yieldable coroutine from the given function. Function should be a declaration of 'void Func()'.

Starts a new yieldable coroutine from the given function which also provides a userdata handle parameter. Function should be a declaration of 'void Func(ref@)'.

Starts a new yieldable coroutine from the given function which also provides a userdata signed integer. Function should be a declaration of 'void Func(int64)'.

Starts a new yieldable coroutine from the given function which also provides a userdata signed integer. Function should be a declaration of 'void Func(int64)'.

Starts a new yieldable coroutine from the given function which also provides a userdata unsigned integer. Function should be a declaration of 'void Func(uint64)'.

Starts a new yieldable coroutine from the given function which also provides a userdata unsigned integer. Function should be a declaration of 'void Func(uint64)'.

Starts a new yieldable coroutine from the given function which also provides a userdata floating point number. Function should be a declaration of 'void Func(double)'.

Starts a new yieldable coroutine from the given function which also provides a userdata string. Function should be a declaration of 'void Func(const string &in)'.

Prints the currently active context stack trace to the log.

Opens the Nod Explorer with the given nod and the given tab name.

Opens the Nod Explorer with the given nod, the given tab name, and the given class info. Only use this for exploring structs.

Opens the Nod Explorer with the given nod.

Returns true if Openplanet has full permissions. (On Trackmania, this means having the Club Edition of the game.)

Returns bool

Returns true if Openplanet has (at least) paid permissions. (On Trackmania, this means having the Standard or Club Edition of the game.)

Returns bool

Gets the main game app object.

Returns CGameCtnApp@

Gets the fid of the given nod, if it's set.

Returns CSystemFidFile@

Gets the logged in user's username.

Returns string

Tells the scripting to invoke the currently executing plugin when nods are loaded with the given class ID.

Tells the scripting to stop invoking the currently executing plugin when nods are loaded with the given class ID.

Opens the default web browser with the given URL.

Opens Windows explorer to the specified absolute path.

Virtual keys that can be pressed by the user and received in scripts.

Non-const sorting funcdef, used in SortNonConst.

Returns bool

A basic coroutine function.

A coroutine function with a userdata handle.

A coroutine function with a userdata integer.

A coroutine function with a userdata unsigned integer.

A coroutine function with a userdata double.

A coroutine function with a userdata string.