Skip to main content

Auki::ConjureKit::ConjureKitModule

Base class for ConjureKit modules.

Inherits from Auki.ConjureKit.IConjureKitModule

Public Functions​

Name
virtual Tuple< uint, uint >_GetMessageTypeRange()
(Internal) Returns the message type range expected by the module.
virtual void_HandleMessage(uint messageType, byte[] data)
(Internal) Handles a message.
virtual void_Update()
(Internal) Game loop per-frame update.
virtual void_Init(Action onComplete, Action< string > onFailed)
(Internal) Called by ConjureKit.Init() for post-constructor online initializations.
virtual void_InvokeOnInit(ConjureKitConfiguration config)
(Internal) Called by ConjureKit.Init() for post-constructor online initializations.
virtual string_Name()
(Internal) Used to identify modules and to prevent duplicate registration of modules, in particular.
ConjureKitModule(IConjureKit conjureKit)
Base constructor for AukiModules.

Public Properties​

Name
Action< ConjureKitConfiguration >OnInit
Called after successful initialization or re-initialization of the module. The argument passed to OnInit is the configuration for which initialization took place.

Public Attributes​

Name
Tuple< uint, uint >NoMessageRange
(Internal) Default range for no messages expected by the module.

Protected Attributes​

Name
IConjureKit_conjureKit
(Internal) IConjureKit-implementing object that manages the module.

Public Functions Documentation​

function _GetMessageTypeRange​

virtual Tuple< uint, uint > _GetMessageTypeRange()

(Internal) Returns the message type range expected by the module.

Return: Message type range tuple

Reimplements: Auki::ConjureKit::IConjureKitModule::_GetMessageTypeRange

function _HandleMessage​

virtual void _HandleMessage(
    uint messageType,
    byte[] data
)

(Internal) Handles a message.

Parameters:

  • messageType Message type
  • data Byte array-encoded data

Reimplements: Auki::ConjureKit::IConjureKitModule::_HandleMessage

function _Update​

virtual void _Update()

(Internal) Game loop per-frame update.

Reimplements: Auki::ConjureKit::IConjureKitModule::_Update

function _Init​

virtual void _Init(
    Action onComplete,
    Action< string > onFailed
)

(Internal) Called by ConjureKit.Init() for post-constructor online initializations.

Reimplements: Auki::ConjureKit::IConjureKitModule::_Init

function _InvokeOnInit​

virtual void _InvokeOnInit(
    ConjureKitConfiguration config
)

(Internal) Called by ConjureKit.Init() for post-constructor online initializations.

function _Name​

virtual string _Name()

(Internal) Used to identify modules and to prevent duplicate registration of modules, in particular.

Reimplements: Auki::ConjureKit::IConjureKitModule::_Name

function ConjureKitModule​

ConjureKitModule(
    IConjureKit conjureKit
)

Base constructor for AukiModules.

Parameters:

  • conjureKit IConjureKit-implementing object

Exceptions:

  • Exception Throws an exception if the IConjureKit-implementing object is null

Public Property Documentation​

property OnInit​

Action< ConjureKitConfiguration > OnInit;

Called after successful initialization or re-initialization of the module. The argument passed to OnInit is the configuration for which initialization took place.

Public Attributes Documentation​

variable NoMessageRange​

static Tuple< uint, uint > NoMessageRange = new (0, 0);

(Internal) Default range for no messages expected by the module.

Protected Attributes Documentation​

variable _conjureKit​

IConjureKit _conjureKit;

(Internal) IConjureKit-implementing object that manages the module.