ORK Framework  2.23.0
API Documentation
ORKFramework.CorePlugin Class Referenceabstract

Base plugin class. More...

Inheritance diagram for ORKFramework.CorePlugin:
ORKFramework.BaseData ORKFramework.IBaseData

Public Member Functions

abstract void OnInitializeORK ()
 Called after ORK Framework has been initialized. More...
 
abstract void OnNewGame ()
 Called before a new game is started. More...
 
abstract void OnLoadGame ()
 Called before a save game is loaded. More...
 
abstract void Tick ()
 Called every Update tick when enabled in the plugin's settings. More...
 
abstract void GUITick ()
 Called every OnGUI tick when enabled in the plugin's settings. More...
 
abstract void SceneLoaded ()
 Called on SceneManager.sceneLoaded when enabled in the plugin's settings. More...
 
abstract bool Call (string info)
 Called from selected parts of ORK Framework, e.g. from custom main menu choices or the event system. More...
 
- Public Member Functions inherited from ORKFramework.BaseData
virtual DataObject GetData ()
 Gets a ORKFramework.DataObject representing the class. More...
 
virtual void SetData (DataObject data)
 Sets the variables of the class using a ORKFramework.DataObject. More...
 
virtual void EditorAutoSetup (string fieldName)
 Called for all fields using the autoSetup option of the ORKFramework.ORKEditorLayoutAttribute. More...
 

Properties

abstract string Version [get]
 Gets the version of the plugin. More...
 

Detailed Description

Base plugin class.

Member Function Documentation

abstract bool ORKFramework.CorePlugin.Call ( string  info)
pure virtual

Called from selected parts of ORK Framework, e.g. from custom main menu choices or the event system.

Parameters
infoThe information text that can be used to call different functionality of a plugin.
abstract void ORKFramework.CorePlugin.GUITick ( )
pure virtual

Called every OnGUI tick when enabled in the plugin's settings.

abstract void ORKFramework.CorePlugin.OnInitializeORK ( )
pure virtual

Called after ORK Framework has been initialized.

abstract void ORKFramework.CorePlugin.OnLoadGame ( )
pure virtual

Called before a save game is loaded.

abstract void ORKFramework.CorePlugin.OnNewGame ( )
pure virtual

Called before a new game is started.

abstract void ORKFramework.CorePlugin.SceneLoaded ( )
pure virtual

Called on SceneManager.sceneLoaded when enabled in the plugin's settings.

abstract void ORKFramework.CorePlugin.Tick ( )
pure virtual

Called every Update tick when enabled in the plugin's settings.

Property Documentation

abstract string ORKFramework.CorePlugin.Version
get

Gets the version of the plugin.

The version of the plugin.