Class Entity

场景节点类。

export

Hierarchy

Entity

Index

Constructors

constructor

Properties

Accessors

Methods

Constructors

constructor

new Entity(game: Game, name?: string): Entity

- Defined in src/engine/scene/entity.ts:253
创建一个节点。

memberof

Entity

Parameters
- game: Game
  
  所依附的游戏运行实例。
- name: string = "NewEntity"
Returns Entity

Properties

game

game: Game

节点场景所在的游戏运行实例，当节点被销毁后该属性会置位null。

memberof: Entity

Readonly isDestroyed

isDestroyed: boolean = false

节点是否已经被销毁。

memberof: Entity

name

name: string

节点的名字

memberof: Entity

Optional transform

transform: Transform3D

3D变换信息，2D节点该属性为空。

memberof: Entity

Optional transform2D

transform2D: Transform2D

2D变换信息，3D节点该属性为空。

memberof: Entity

Accessors

active

get active(): boolean
set active(val: boolean): void

- Defined in src/engine/scene/entity.ts:214
节点是否处于激活状态。

memberof

Entity

Returns boolean
- Defined in src/engine/scene/entity.ts:217
节点是否处于激活状态。

Parameters
- val: boolean
Returns void

activeInHierarchy

get activeInHierarchy(): boolean

- Defined in src/engine/scene/entity.ts:232
节点在层级结构中是否处于激活状态。

readonly

memberof

Entity

Returns boolean

components

get components(): Component[]

- Defined in src/engine/scene/entity.ts:323
获取所有组件列表。

readonly

memberof

Entity

Returns Component[]

layer

get layer(): number
set layer(l: number): void

- Defined in src/engine/scene/entity.ts:604
Returns number
- Defined in src/engine/scene/entity.ts:607
Parameters
- l: number
Returns void

Methods

addComponent

addComponent<T>(ctor: typeof Component): T

- Defined in src/engine/scene/entity.ts:345
添加组件。

memberof

Entity

Type parameters
- T: Component<T>
Parameters
- ctor: typeof Component
Returns T

destroy

destroy(): void

- Defined in src/engine/scene/entity.ts:537
销毁节点。

memberof

Entity

Returns void

destroyImmediate

destroyImmediate(): void

- Defined in src/engine/scene/entity.ts:546
立即销毁节点。

memberof

Entity

Returns void

disposeScriptCompEventEmitter

disposeScriptCompEventEmitter(): void

- Defined in src/engine/scene/entity.ts:504
Returns void

fireScriptCompEventEmitter

fireScriptCompEventEmitter(eventName: string, ...args: any[]): boolean

- Defined in src/engine/scene/entity.ts:475
Parameters
- eventName: string
- Rest ...args: any[]
Returns boolean

getAllComponents

getAllComponents(): Component[]

- Defined in src/engine/scene/entity.ts:333
获取所有组件列表。

deprecated

memberof

Entity

Returns Component[]

getComponent

getComponent<T>(ctor: typeof Component): T

- Defined in src/engine/scene/entity.ts:297
获取某一类型的组件。

memberof

Entity

Type parameters
- T: Component<T>
Parameters
- ctor: typeof Component
Returns T

getComponents

getComponents<T>(ctor: typeof Component): T[]

- Defined in src/engine/scene/entity.ts:313
获取某一类型的组件列表。

memberof

Entity

Type parameters
- T: Component<T>
Parameters
- ctor: typeof Component
Returns T[]

registScriptCompEvent

registScriptCompEvent(scriptComp: Component): void

- Defined in src/engine/scene/entity.ts:427
Parameters
- scriptComp: Component
Returns void

removeComponent

removeComponent(comp: Component): void

- Defined in src/engine/scene/entity.ts:520
移除组件。

memberof

Entity

Parameters
- comp: Component
Returns void

removeScriptCompEventListener

removeScriptCompEventListener(scriptComp: Component): void

- Defined in src/engine/scene/entity.ts:485
Parameters
- scriptComp: Component
Returns void

Static createEntity2D

createEntity2D(name: string): Entity2D

- Defined in src/engine/scene/entity.ts:282
创建2D节点。

deprecated

static

memberof

Entity

Parameters
- name: string
Returns Entity2D

Static createEntity3D

createEntity3D(name: string): Entity3D

- Defined in src/engine/scene/entity.ts:266
创建3D节点。

deprecated

static

memberof

Entity

Parameters
- name: string
Returns Entity3D

Generated using TypeDoc