EntityBusPeer

Summary

Properties

Name Type
typeInfo TypeInformation
data DataContainer | nil
instanceId int
bus EntityBus | nil
computedWorldTransform LinearTransform | nil

Methods

Method Returns
Is(typeName: string) bool
FireEvent(eventId: int) void
FireEvent(eventName: string) void
FireEvent(event: EntityEvent) void
PropertyChanged(propertyId: int) void
PropertyChanged(propertyId: int, value: any) void
PropertyChanged(propertyName: string) void
PropertyChanged(propertyName: string, value: any) void
RegisterEventCallback(callback: callable) int
RegisterEventCallback(context: any, callback: callable) int
UnregisterEventCallback(handle: int) void
RegisterCreateCallback(callback: callable) int
RegisterCreateCallback(context: any, callback: callable) int
UnregisterCreateCallback(handle: int) void
RegisterDestroyCallback(callback: callable) int
RegisterDestroyCallback(context: any, callback: callable) int
UnregisterDestroyCallback(handle: int) void
RegisterPropertyChangedCallback(callback: callable) int
RegisterPropertyChangedCallback(context: any, callback: callable) int
UnregisterPropertyChangedCallback(handle: int) void

Operators

Operator Rhs Returns
== EntityBusPeer bool

Static members

Name Type
EntityBusPeer.typeInfo TypeInformation

Properties

typeInfo

TypeInformation

data

DataContainer | nil

instanceId

int

bus

EntityBus | nil

computedWorldTransform

LinearTransform | nil

Methods

Is

Is(typeName: string): bool

Parameters

Name Type Description
typeName string

Returns

Type Description
bool

FireEvent

FireEvent(eventId: int)

Parameters

Name Type Description
eventId int

FireEvent

FireEvent(eventName: string)

Parameters

Name Type Description
eventName string

FireEvent

FireEvent(event: EntityEvent)

Parameters

Name Type Description
event EntityEvent

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

RegisterEventCallback

RegisterEventCallback(callback: callable): int

Parameters

Name Type Description
callback callable A callback in the form function(peer: Entity | Component, 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, peer: Entity | Component, event: EntityEvent): bool.

Returns

Type Description
int

UnregisterEventCallback

UnregisterEventCallback(handle: int)

Parameters

Name Type Description
handle int

RegisterCreateCallback

RegisterCreateCallback(callback: callable): int

Parameters

Name Type Description
callback callable A callback in the form function(peer: Entity | Component, transform: LinearTransform): bool.

Returns

Type Description
int

RegisterCreateCallback

RegisterCreateCallback(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, peer: Entity | Component, transform: LinearTransform): bool.

Returns

Type Description
int

UnregisterCreateCallback

UnregisterCreateCallback(handle: int)

Parameters

Name Type Description
handle int

RegisterDestroyCallback

RegisterDestroyCallback(callback: callable): int

Parameters

Name Type Description
callback callable A callback in the form function(peer: Entity | Component): bool.

Returns

Type Description
int

RegisterDestroyCallback

RegisterDestroyCallback(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, peer: Entity | Component): bool.

Returns

Type Description
int

UnregisterDestroyCallback

UnregisterDestroyCallback(handle: int)

Parameters

Name Type Description
handle int

RegisterPropertyChangedCallback

RegisterPropertyChangedCallback(callback: callable): int

Parameters

Name Type Description
callback callable A callback in the form function(peer: Entity | Component, propertyName: string): bool.

Returns

Type Description
int

RegisterPropertyChangedCallback

RegisterPropertyChangedCallback(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, peer: Entity | Component, propertyName: string): bool.

Returns

Type Description
int

UnregisterPropertyChangedCallback

UnregisterPropertyChangedCallback(handle: int)

Parameters

Name Type Description
handle int

Operators

operator==

operator==(rhs: EntityBusPeer): bool

Parameters

Name Type Description
rhs EntityBusPeer

Returns

Type Description
bool

Static members

typeInfo

TypeInformation

Last modified July 20, 2022: Re-generate documentation (8940418c)