Component

Inherits from EntityBusPeer

Summary

Constructors

Component(other: EntityBusPeer)

Properties

Name Type
componentData DataContainer
localBoundingBox AxisAlignedBox | nil

Methods

Method Returns
SetTransform(transform: LinearTransform) void
RegisterDeinitCallback(callback: callable) int
RegisterDeinitCallback(context: any, callback: callable) int
UnregisterDeinitCallback(handle: int) void
RegisterSpawnCallback(callback: callable) int
RegisterSpawnCallback(context: any, callback: callable) int
UnregisterSpawnCallback(handle: int) void
RegisterUnSpawnCallback(callback: callable) int
RegisterUnSpawnCallback(context: any, callback: callable) int
UnregisterUnSpawnCallback(handle: int) void
RegisterImpulseCallback(callback: callable) int
RegisterImpulseCallback(context: any, callback: callable) int
UnregisterImpulseCallback(handle: int) void
RegisterComponentMessageCallback(callback: callable) int
RegisterComponentMessageCallback(context: any, callback: callable) int
UnregisterComponentMessageCallback(handle: int) void

Static members

Name Type
Component.typeInfo TypeInformation

Constructors

Component

Component(other: EntityBusPeer)

Parameters

Name Type Description
other EntityBusPeer

Properties

componentData

DataContainer

localBoundingBox

AxisAlignedBox | nil

Methods

SetTransform

SetTransform(transform: LinearTransform)

Parameters

Name Type Description
transform LinearTransform

RegisterDeinitCallback

RegisterDeinitCallback(callback: callable): int

Parameters

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

Returns

Type Description
int

RegisterDeinitCallback

RegisterDeinitCallback(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, component: Component): bool.

Returns

Type Description
int

UnregisterDeinitCallback

UnregisterDeinitCallback(handle: int)

Parameters

Name Type Description
handle int

RegisterSpawnCallback

RegisterSpawnCallback(callback: callable): int

Parameters

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

Returns

Type Description
int

RegisterSpawnCallback

RegisterSpawnCallback(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, component: Component): bool.

Returns

Type Description
int

UnregisterSpawnCallback

UnregisterSpawnCallback(handle: int)

Parameters

Name Type Description
handle int

RegisterUnSpawnCallback

RegisterUnSpawnCallback(callback: callable): int

Parameters

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

Returns

Type Description
int

RegisterUnSpawnCallback

RegisterUnSpawnCallback(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, component: Component): bool.

Returns

Type Description
int

UnregisterUnSpawnCallback

UnregisterUnSpawnCallback(handle: int)

Parameters

Name Type Description
handle int

RegisterImpulseCallback

RegisterImpulseCallback(callback: callable): int

Parameters

Name Type Description
callback callable A callback in the form function(component: Component, data: ImpulseData | null): bool.

Returns

Type Description
int

RegisterImpulseCallback

RegisterImpulseCallback(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, component: Component, data: ImpulseData | null): bool.

Returns

Type Description
int

UnregisterImpulseCallback

UnregisterImpulseCallback(handle: int)

Parameters

Name Type Description
handle int

RegisterComponentMessageCallback

RegisterComponentMessageCallback(callback: callable): int

Parameters

Name Type Description
callback callable A callback in the form function(component: Component, message: Message): bool.

Returns

Type Description
int

RegisterComponentMessageCallback

RegisterComponentMessageCallback(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, component: Component, message: Message): bool.

Returns

Type Description
int

UnregisterComponentMessageCallback

UnregisterComponentMessageCallback(handle: int)

Parameters

Name Type Description
handle int

Static members

typeInfo

TypeInformation

Last modified May 23, 2022: fix: inherits from EntityBusPeer (4eabb2cb)