Skip to main content

Auki::ConjureKit::IConjureKitModule

Inherited by Auki.ConjureKit.ConjureKitModule

Public Functions

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

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 Functions Documentation

function _GetMessageTypeRange

Tuple< uint, uint > _GetMessageTypeRange()

(Internal) Returns the message type range expected by the module. Invoked by the IConjureKit-implementing object the module was constructed with.

Return: Message type range tuple

function _HandleMessage

void _HandleMessage(
uint messageType,
byte[] data
)

(Internal) Handles a message. Invoked by the IConjureKit-implementing object the module was constructed with.

Parameters:

  • messageType Message type
  • data Byte array-encoded data

function _Update

void _Update()

(Internal) Game loop per-frame update. Invoked by the IConjureKit-implementing object the module was constructed with.

function _Init

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

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

function _Name

string _Name()

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

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.