Class Entity

实体基类

Export

Date

2022.3.19

Author

lyx

Hierarchy

EngineObject
- Entity

Index

Constructors

constructor

new Entity(engine, parameters?): Entity
Parameters
- engine: Engine
- parameters: EntityParameters = {}
Returns Entity

Overrides EngineObject.constructor

Properties

`Protected` _engine

_engine: Engine

`Readonly` camera

camera: Camera = null

相机组件

Memberof

Entity

`Readonly` guid

guid: string

实体GUID

Memberof

Entity

`Readonly` isCamera

isCamera: boolean

标识是否是相机实体

Memberof

Entity

layer

layer: string

实体所属图层

Memberof

Entity

name

name: string

实体名称

Memberof

Entity

tag

tag: string

实体标签

Memberof

Entity

`Readonly` transform

transform: Transform = null

Transform组件

Memberof

Entity

`Readonly` type

type: string

实体类型

Memberof

Entity

userData

userData: {
[key: string]: any;
}

用户数据

Type declaration

[key: string]: any

Memberof

Entity

Accessors

engine

get engine(): Engine
获取引擎对象

Returns Engine

Memberof
EngineObject

Inherited from EngineObject.engine

scripts

get scripts(): Readonly<DisorderedArray<Script>>
获取脚本数组

Returns Readonly<DisorderedArray<Script>>

Memberof
Entity

Methods

addComponent

addComponent<T, B>(type, parameters?): T
添加组件
Type Parameters
- T extends Component
- B extends ComponentParameters
Parameters
- type: ComponentCtor<T, B>
  
  组件类型
- Optional parameters: B
  
  组件参数，可选
Returns T
组件对象

Memberof
Entity

addEventListener

addEventListener(type, callback, parameters?): number
添加事件监听器
Parameters
- type: string
  
  事件类型（不区分大小写）
- callback: ((event) => void)
  
  事件监听回调
  - - (event): void
    - Parameters
      
      event: {
      type: string;
      [key: string]: any;
      }
      
      [key: string]: any
      
      type: string
      
      Returns void
- Optional parameters: {
  priority?: Priority;
  target?: any;
  } = {}
  
  事件参数
  - Optional priority?: Priority
  - Optional target?: any
Returns number

Memberof
EventDispatcher

Inherited from EngineObject.addEventListener

destroy

destroy(): void
销毁实体

Returns void

Memberof
Entity

dispatchEvent

dispatchEvent(event): void
分发事件
Parameters
- event: {
  type: string;
  [key: string]: any;
  }
  - [key: string]: any
  - type: string
Returns void

Memberof
EventDispatcher

Inherited from EngineObject.dispatchEvent

dispose

dispose(): void
释放接口

Returns void

Memberof
EventDispatcher

Inherited from EngineObject.dispose

getAllComponents

getAllComponents(): Component[]
获取实体所有组件

Returns Component[]

Memberof
BaseEntity

getComponent

getComponent<T, B>(type): T
获取指定类型组件
Type Parameters
- T extends Component
- B extends ComponentParameters
Parameters
- type: ComponentCtor<T, B>
  
  组件类型
Returns T

Memberof
Entity

hasComponent

hasComponent<T, B>(type): boolean
判断指定类型的组件是否存在
Type Parameters
- T extends Component
- B extends ComponentParameters
Parameters
- type: ComponentCtor<T, B>
  
  组件类型
Returns boolean

Memberof
Entity

removeAllComponents

removeAllComponents(): void
移除所有组件

Returns void

Memberof
Entity

removeAllEventListeners

removeAllEventListeners(): void
移除所有事件监听器

Returns void

Memberof
EventDispatcher

Inherited from EngineObject.removeAllEventListeners

removeComponent

removeComponent<T, B>(type): void
移除组件
Type Parameters
- T extends Component
- B extends ComponentParameters
Parameters
- type: ComponentCtor<T, B>
  
  组件类型
Returns void

Memberof
Entity

removeEventListener

removeEventListener(type, callback?): void
移除事件监听器
Parameters
- type: string
  
  事件类型（不区分大小写）
- Optional callback: ((event) => void)
  
  事件监听回调（可选，不设置则表示移除所有监听器）
  - - (event): void
    - Parameters
      
      event: {
      type: string;
      [key: string]: any;
      }
      
      [key: string]: any
      
      type: string
      
      Returns void
Returns void

Memberof
EventDispatcher

Inherited from EngineObject.removeEventListener

removeEventListenerByEventId

removeEventListenerByEventId(eventID): void
通过事件Id移除事件监听器
Parameters
- eventID: number
Returns void

Memberof
EventDispatcher

Inherited from EngineObject.removeEventListenerByEventId

`Static` findByComponent

findByComponent<T, B>(root, type): Entity[]
查找包含指定组件的实体
Type Parameters
- T extends Component
- B extends ComponentParameters
Parameters
- root: Entity
  
  查找入口实体
- type: ComponentCtor<T, B>
  
  组件类型
Returns Entity[]
实体对象数组

Static

Memberof
Entity

`Static` findByCondition

findByCondition(root, condition): Entity[]
查找满足指定查询条件的实体
Parameters
- root: Entity
  
  查找入口实体
- condition: ((entity) => boolean)
  
  查找条件
  - - (entity): boolean
    - Parameters
      
      entity: Entity
      
      Returns boolean
Returns Entity[]
满足条件的实体列表

Static

Memberof
Entity

`Static` findByGUID

findByGUID(root, guid): Entity
查找指定GUID的实体
Parameters
- root: Entity
  
  查找入口实体
- guid: string
  
  实体GUID
Returns Entity
成功返回实体对象，失败返回null

Static

Memberof
Entity

`Static` findByName

findByName(root, name): Entity[]
查找指定名称的实体
Parameters
- root: Entity
  
  查找入口实体
- name: string
  
  实体GUID
Returns Entity[]
实体对象数组（由于实体名称不唯一故返回一个数组）

Static

Memberof
Entity

`Static` traverse

traverse(root, callback): void
广度遍历实体及子实体
Parameters
- root: Entity
  
  遍历入口实体
- callback: ((entity) => void)
  
  遍历回调函数
  - - (entity): void
    - Parameters
      
      entity: Entity
      
      Returns void
Returns void

Static

Memberof
Entity