EntityBus

Summary

Properties

Name	Type
entities	Entity{}
components	Component{}
peers	EntityBusPeer{}
parent	EntityBus | nil
parentRepresentative	DataContainer | nil
data	DataContainer | nil
dataId	NetworkDataId
instanceId	int
networkId	int

Methods

Method	Returns
FireEvent(targetData: DataContainer, eventId: int)	void
FireEvent(targetData: DataContainer, eventName: string)	void
FireEvent(targetData: DataContainer, event: EntityEvent)	void
GetEntity(forData: DataContainer)	Entity | Component | nil
PropertyChanged(propertyId: int)	void
PropertyChanged(propertyId: int, value: any)	void
PropertyChanged(propertyName: string)	void
PropertyChanged(propertyName: string, value: any)	void
GetLinks(toData: DataContainer, fieldId: int)	(Entity | Component){}
GetLinks(toData: DataContainer, fieldName: string)	(Entity | Component){}
RegisterEventCallback(callback: callable)	int
RegisterEventCallback(context: any, callback: callable)	int
UnregisterEventCallback(handle: int)	void

Operators

Operator	Rhs	Returns
==	EntityBus	bool

Properties

entities

Entity{}

components

Component{}

peers

EntityBusPeer{}

parent

EntityBus | nil

parentRepresentative

DataContainer | nil

data

DataContainer | nil

dataId

NetworkDataId

instanceId

int

networkId

int

Methods

FireEvent

FireEvent(targetData: DataContainer, eventId: int)

Parameters

Name	Type	Description
targetData	DataContainer
eventId	int

FireEvent

FireEvent(targetData: DataContainer, eventName: string)

Parameters

Name	Type	Description
targetData	DataContainer
eventName	string

FireEvent

FireEvent(targetData: DataContainer, event: EntityEvent)

Parameters

Name	Type	Description
targetData	DataContainer
event	EntityEvent

GetEntity

GetEntity(forData: DataContainer): Entity | Component | nil

Parameters

Name	Type	Description
forData	DataContainer

Returns

Type	Description
Entity | Component | nil

PropertyChanged

PropertyChanged(propertyId: int)

Parameters

Name	Type	Description
propertyId	int

PropertyChanged

PropertyChanged(propertyId: int, value: any)

Parameters

Name	Type	Description
propertyId	int
value	any

PropertyChanged

PropertyChanged(propertyName: string)

Parameters

Name	Type	Description
propertyName	string

PropertyChanged

PropertyChanged(propertyName: string, value: any)

Parameters

Name	Type	Description
propertyName	string
value	any

GetLinks

GetLinks(toData: DataContainer, fieldId: int): (Entity | Component){}

Parameters

Name	Type	Description
toData	DataContainer
fieldId	int

Returns

Type	Description
(Entity | Component){}

GetLinks

GetLinks(toData: DataContainer, fieldName: string): (Entity | Component){}

Parameters

Name	Type	Description
toData	DataContainer
fieldName	string

Returns

Type	Description
(Entity | Component){}

RegisterEventCallback

RegisterEventCallback(callback: callable): int

Parameters

Name	Type	Description
callback	callable	A callback in the form function(bus: EntityBus, data: DataContainer, event: EntityEvent): bool.

Returns

Type	Description
int

RegisterEventCallback

RegisterEventCallback(context: any, callback: callable): int

Parameters

Name	Type	Description
context	any	A context value to pass to the callback.
callback	callable	A callback in the form function(context: any, bus: EntityBus, data: DataContainer, event: EntityEvent): bool.

Returns

Type	Description
int

UnregisterEventCallback

UnregisterEventCallback(handle: int)

Parameters

Name	Type	Description
handle	int

Operators

operator==

operator==(rhs: EntityBus): bool

Parameters

Name	Type	Description
rhs	EntityBus

Returns

Type	Description
bool