Changes from Version 1 of documentation/C++Manual/Plugins

Author:

lloydw (IP: 192.168.0.1)

Timestamp:

11/19/07 19:34:08 (10 years ago)

Comment:

--

documentation/C++Manual/Plugins

@@ +1 @@
+[[PageOutline(1-5, Contents)]]
+= Plugins =
+
+Rocket has a simple, straightforward system for writing plugins. Plugins receive notification when contexts and elements are created and destroyed.
+
+== Creating a plugin ==
+
+All plugins derive from the Rocket::Core::Plugin class. The virtual functions that can be overridden are:
+
+{{{
+// Called when Rocket is initialised.
+virtual void OnInitialise();
+
+// Called when Rocket shuts down.
+virtual void OnShutdown();
+
+// Called when a new context is created.
+virtual void OnContextCreate(Rocket::Core::Context* context);
+
+// Called when a context is destroyed.
+virtual void OnContextDestroy(Rocket::Core::Context* context);
+
+// Called when a new element is created.
+virtual void OnElementCreate(Rocket::Core::Element* element);
+
+// Called when an element is destroyed.
+virtual void OnElementDestroy(Rocket::Core::Element* element);
+}}}
+
+=== Rocket engine events ===
+
+The OnInitialise() function will be called on all registered plugins when Rocket is successfully initialised. If Rocket is already initialised when a plugin is registered, OnInitialise() will be immediately called on the plugin.
+
+OnShutdown() is called on all registered plugins when Rocket is shut down, immediately after all the contexts and elements are destroyed. Plugins must release any resources they have allocated, including themselves, during this call.
+
+=== Context events ===
+
+OnContextCreate() and OnContextDestroy() are called on every registered plugin when a context is successfully created or destroyed.
+
+=== Element events ===
+
+OnElementCreate() and OnElementDestroy() are called on every registered plugin when an element is successfully created or destroyed.
+
+== Registering a plugin ==
+
+To register a plugin, call the RegisterPlugin() function in Rocket::Core.
+
+{{{
+Rocket::Core::Plugin* plugin = new CustomPlugin();
+Rocket::Core::RegisterPlugin(plugin);
+}}}