Entity

Inherits from EntityBusPeer

Summary

Constructors

Entity(other: EntityBusPeer)

Properties

Name Type
uniqueId int
isPendingDestruction bool

Methods

Method Returns
Init(realm: Realm, enableAllowed: bool, isGhost: bool = false) void
Destroy() void
RegisterInitCallback(callback: callable) int
RegisterInitCallback(context: any, callback: callable) int
UnregisterInitCallback(handle: int) void
RegisterDeinitCallback(callback: callable) int
RegisterDeinitCallback(context: any, callback: callable) int
UnregisterDeinitCallback(handle: int) void

Static members

Name Type
Entity.typeInfo TypeInformation

Constructors

Entity

Entity(other: EntityBusPeer)

Parameters

Name Type Description
other EntityBusPeer

Properties

uniqueId

int

isPendingDestruction

bool

Methods

Init

Init(realm: Realm, enableAllowed: bool, isGhost: bool = false)

Parameters

Name Type Description
realm Realm
enableAllowed bool
isGhost bool

Destroy

Destroy()

RegisterInitCallback

RegisterInitCallback(callback: callable): int

Parameters

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

Returns

Type Description
int

RegisterInitCallback

RegisterInitCallback(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

UnregisterInitCallback

UnregisterInitCallback(handle: int)

Parameters

Name Type Description
handle int

RegisterDeinitCallback

RegisterDeinitCallback(callback: callable): int

Parameters

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

Returns

Type Description
int

UnregisterDeinitCallback

UnregisterDeinitCallback(handle: int)

Parameters

Name Type Description
handle int

Static members

typeInfo

TypeInformation

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