KROYSDOCS
HomeWhat's newv0.1.0
C/C++ SDK / C++ layer · Plugin / kroys::Plugin

kroys::Plugin

One object per target the module serves (a module for both targets gets two: check host.IsEditor() / host.IsRuntime()).

Kindclass
Headerkroys/plugin.hpp
Members4
DECLARATION

Declaration

Declared in kroys/plugin.hpp.

plugin.hpp
class Plugin
REFERENCE

Members

Methods
#virtual bool OnLoad(Host& host) = 0;

Registers the plugin's extensions. False refuses the plugin (with a log message).

method
#virtual void OnUnload();

Last call; the host already removed the registrations.

method
#virtual void OnWorldStarted(const World& world);

Runtime target: a game world starts (before its first frame).

method
#virtual void OnWorldStopping(const World& world);

Runtime target: a game world is about to stop (after its last frame).

method
Signatures
virtual bool OnLoad(Host& host) = 0;
virtual void OnUnload();
virtual void OnWorldStarted(const World& world);
virtual void OnWorldStopping(const World& world);

KroysEngine 0.1.0 documentation, built from the engine repository by Tools/BuildDocsSite.py.