Plugin functions


These are the functions that will be called for each plugin, if the function exists.

void Main()

The main entry point. (Yieldable)

void Update(float dt)

Called every frame. dt is the delta time (milliseconds since last frame).

void Render()

Render function called every frame.

void RenderInterface()

Render function called every frame intended for UI.

void RenderMenu()

Render function called every frame intended only for menu items in UI.

void RenderMenuMain()

Render function called every frame intended only for menu items in the main menu of the UI.

void RenderSettings()

Render function called every frame intended only for within Openplanet's settings window for UI.

bool OnKeyPress(bool down, VirtualKey key)

Called whenever a key is pressed on the keyboard. See the documentation for the VirtualKey enum.

bool OnMouseButton(bool down, int button, int x, int y)

Called whenever a mouse button is pressed.

void OnMouseMove(int x, int y)

Called whenever the mouse moves.

void OnSettingsChanged()

Called when a setting in the settings panel was changed.

void OnSettingsSave(Settings::Section& section)

Called when the settings for the plugin are being saved. See the documentation for Settings::Section.

void OnSettingsLoad(Settings::Section& section)

Called when the settings for the plugin are being loaded. See the documentation for Settings::Section.

void OnLoadCallback(CMwNod@ nod)

Called when a Nod is loaded from a file. You have to call RegisterLoadCallback first before this is called. This callback is meant as an early callback for a loaded nod. If you're not sure whether you need an early callback and you can avoid using this callback, then avoid using this function.

void OnDisabled()

Called when the plugin is getting disabled from the settings, the menu, or programatically via the Meta API.

void OnDestroyed()

Called when the plugin is unloaded and completely removed from memory.