Documentation

Meta

Namespace

Openplanet meta plugin API.

Information about a plugin's setting.

Information about an Openplanet plugin.

An index of plugin information that can be sorted by its dependency tree.

An item in a PluginIndex.

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

Returns awaitable@

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@)'.

Returns awaitable@

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)'.

Returns awaitable@

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)'.

Returns awaitable@

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)'.

Returns awaitable@

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)'.

Returns awaitable@

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)'.

Returns awaitable@

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)'.

Returns awaitable@

Opens the preferred text editor with the given path and line number.

Gets the currently executing plugin.

Returns Meta::Plugin@

Gets all plugins that are loaded.

Gets the identifiers of all unloaded plugins. Note that this function may be slow!

Gets a plugin from its site ID, if set.

Returns Meta::Plugin@

Loads a plugin into memory from the given absolute path and returns a handle to the plugin.

Returns Meta::Plugin@

Queues a plugin to be unloaded from memory completely when it is safe to do so. Note that this will invalidate the plugin object passed in on the next frame! Do not use the Plugin handle after calling this!

Queues a plugin to be reloaded when it is safe to do so. Note that this will invalidate the plugin object passed in on the next frame! Do not use the Plugin handle after calling this!

Forces Openplanet to save its settings immediately. Normally this happens on game shutdown or when the settings window is closed. You should not have to call this function unless you know you really need to!

Returns true if developer mode is currently enabled.

Returns bool

Returns true when the current session is whitelisted by school mode, and school mode is enabled. If you want to check if school mode is enabled, use the SIG_SCHOOL preprocessor define instead.

Returns bool

Returns the current version of Openplanet.

Returns string

Returns the current date of Openplanet's build.

Returns string

Returns the current build info of Openplanet's build.

Returns string

Immediately terminates the game process. This is the same as clicking "Exit" in the Openplanet menu.

Type of text editor.

The type of plugin.

Where this plugin is loaded from.

The type of this setting variable.

Execution context for a coroutine.