Class Entity

Hierarchy

Entity

Index

Constructors

constructor

new Entity(name: any, properties: any, rawProperties: any): Entity
Parameters
- name: any
- properties: any
- rawProperties: any
Returns Entity
- Defined in docs/dev/projekte/2023/typespritejs/repos/typesprite-engine/src/entity/Entity.ts:55

Properties

`Private` _componentBeforeInit

_componentBeforeInit: (<T>(targetCmp: T) => string | void)[] = []

`Private` _componentNames

_componentNames: string[] = []

`Private` _components

_components: Component[] = []

`Private` _instanceProperties

_instanceProperties: any

`Private` _state

_state: EntityState = EntityState.Uninited

the state of the entity

uninited: new entity initing: the initprocess is in progress inited: entity is ready and working active: entity is activly working/running deactive: entity is sleeping ignored: entity is okay but should not be used error: the entity cannot be used disposed: the entity can be deleted

`Private` _stateMsg

_stateMsg: string = ""

description of the state

id

id: number = 0

name

name: string

origin

origin: any = null

name of the ED the entity is created from

props

props: Record<string, any>

world

world: World

Accessors

manager

get manager(): World
Deprecated
use world instead.

Returns World
- Defined in docs/dev/projekte/2023/typespritejs/repos/typesprite-engine/src/entity/Entity.ts:64

Methods

addComponent

addComponent(cmp: Component, cmpName: string, beforeInit: (<T>(targetCmp: T) => string | void)): void
Parameters
- cmp: Component
- cmpName: string
- beforeInit: (<T>(targetCmp: T) => string | void)
  - - <T>(targetCmp: T): string | void
    - Type Parameters
      
      T extends Component<T>
      
      Parameters
      
      targetCmp: T
      
      Returns string | void
Returns void
- Defined in docs/dev/projekte/2023/typespritejs/repos/typesprite-engine/src/entity/Entity.ts:73

componentExists

componentExists(cmpName: string): boolean
true if the given component exists. Other than "findComponent" this function does not check the internal init-state.
Parameters
- cmpName: string
Returns boolean
- Defined in docs/dev/projekte/2023/typespritejs/repos/typesprite-engine/src/entity/Entity.ts:96

dispose

dispose(): void
flag this object as garbage

Returns void
- Defined in docs/dev/projekte/2023/typespritejs/repos/typesprite-engine/src/entity/Entity.ts:117

dump

dump(ret?: boolean): string
Parameters
- ret: boolean = false
Returns string
- Defined in docs/dev/projekte/2023/typespritejs/repos/typesprite-engine/src/entity/Entity.ts:234

findComponent

findComponent(cmpName: string): any
Parameters
- cmpName: string
Returns any
- Defined in docs/dev/projekte/2023/typespritejs/repos/typesprite-engine/src/entity/Entity.ts:79

getInstanceProperties

getInstanceProperties(): any
properties for ...

Returns any
- Defined in docs/dev/projekte/2023/typespritejs/repos/typesprite-engine/src/entity/Entity.ts:69

getState

getState(): EntityState
Returns EntityState
- Defined in docs/dev/projekte/2023/typespritejs/repos/typesprite-engine/src/entity/Entity.ts:113

getStateDescription

getStateDescription(): string
for some states (like error) this contains additional expl

Returns string
- Defined in docs/dev/projekte/2023/typespritejs/repos/typesprite-engine/src/entity/Entity.ts:131

isGarbage

isGarbage(): boolean
true if object is not needed anymore

Returns boolean
- Defined in docs/dev/projekte/2023/typespritejs/repos/typesprite-engine/src/entity/Entity.ts:121

onActivate

onActivate(): void
Returns void
- Defined in docs/dev/projekte/2023/typespritejs/repos/typesprite-engine/src/entity/Entity.ts:200

onDeactivate

onDeactivate(): void
Returns void
- Defined in docs/dev/projekte/2023/typespritejs/repos/typesprite-engine/src/entity/Entity.ts:207

onDispose

onDispose(): void
Returns void
- Defined in docs/dev/projekte/2023/typespritejs/repos/typesprite-engine/src/entity/Entity.ts:214

onInit

onInit(): void
Returns void
- Defined in docs/dev/projekte/2023/typespritejs/repos/typesprite-engine/src/entity/Entity.ts:134

onRender

onRender(elapsed: number): void
Note: only works when object entity is flagged as renderer
Parameters
- elapsed: number
  
  f
Returns void
- Defined in docs/dev/projekte/2023/typespritejs/repos/typesprite-engine/src/entity/Entity.ts:228

onUpdate

onUpdate(time: number): void
Parameters
- time: number
Returns void
- Defined in docs/dev/projekte/2023/typespritejs/repos/typesprite-engine/src/entity/Entity.ts:194

sendMessage

sendMessage(name: string, params?: any): void
Parameters
- name: string
- Optional params: any
Returns void
- Defined in docs/dev/projekte/2023/typespritejs/repos/typesprite-engine/src/entity/Entity.ts:247

setError

setError(reason?: string): void
Parameters
- Optional reason: string
Returns void
- Defined in docs/dev/projekte/2023/typespritejs/repos/typesprite-engine/src/entity/Entity.ts:109

setState

setState(newState: EntityState, stateReason?: string): void
Parameters
- newState: EntityState
- Optional stateReason: string
Returns void
- Defined in docs/dev/projekte/2023/typespritejs/repos/typesprite-engine/src/entity/Entity.ts:105

Class Entity

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

name: any

properties: any

rawProperties: any

Returns Entity

Properties

Private _componentBeforeInit

Private _componentNames

Private _components

Private _instanceProperties

Private _state

Private _stateMsg

id

name

origin

props

world

Accessors

manager

Deprecated

Returns World

Methods

addComponent

Parameters

cmp: Component

cmpName: string

beforeInit: (<T>(targetCmp: T) => string | void)

Type Parameters

T extends Component<T>

Parameters

targetCmp: T

Returns string | void

Returns void

componentExists

Parameters

cmpName: string

Returns boolean

dispose

Returns void

dump

Parameters

ret: boolean = false

Returns string

findComponent

Parameters

cmpName: string

Returns any

getInstanceProperties

Returns any

getState

Returns EntityState

getStateDescription

Returns string

isGarbage

Returns boolean

onActivate

Returns void

onDeactivate

Returns void

onDispose

Returns void

onInit

Returns void

onRender

Parameters

elapsed: number

Returns void

onUpdate

Parameters

time: number

Returns void

`Private` _componentBeforeInit

`Private` _componentNames

`Private` _components

`Private` _instanceProperties

`Private` _state

`Private` _stateMsg

`Optional` params: any

`Optional` reason: string

`Optional` stateReason: string