GameEntity

Inherits from SpatialEntity

Summary

Constructors

GameEntity(other: EntityBusPeer)
GameEntity(other: Entity)
GameEntity(other: SpatialEntity)

Properties

Name Type
updateInterval int

Methods

Method Returns
Spawn(transform: LinearTransform, fireEnableEvent: bool) 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

Constructors

GameEntity

GameEntity(other: EntityBusPeer)

Parameters

Name Type Description
other EntityBusPeer

GameEntity

GameEntity(other: Entity)

Parameters

Name Type Description
other Entity

GameEntity

GameEntity(other: SpatialEntity)

Parameters

Name Type Description
other SpatialEntity

Properties

updateInterval

int

Methods

Spawn

Spawn(transform: LinearTransform, fireEnableEvent: bool)

Parameters

Name Type Description
transform LinearTransform
fireEnableEvent bool

RegisterSpawnCallback

RegisterSpawnCallback(callback: callable): int

Parameters

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

Returns

Type Description
int

UnregisterUnspawnCallback

UnregisterUnspawnCallback(handle: int)

Parameters

Name Type Description
handle int
Last modified May 23, 2022: fix: inherits from EntityBusPeer (4eabb2cb)