Class Entity

实体

Entity与Component构成实体组件系统（ECS）。

Hierarchy

Entity

Index

Constructors

constructor

new Entity(): Entity
Returns Entity

Properties

`Protected` _components

`Readonly` emitter

emitter: EventEmitter<EntityEventMap> = ...

事件发射器。

name

name: string

名称

Accessors

components

get components(): (Component | Scene3D | Camera3D | TransformLayout3D | Button | Canvas | DirectionalLight3D | PointLight3D | SpotLight3D | Mesh3D | CanvasRenderer | Image | Rect | Text | AudioListener3D | AudioSource3D | OrthographicCamera3D | PerspectiveCamera3D | Billboard3D | Graphics3D | HoldSize3D | MouseRay3D | FPSController3D | MouseEvent3D | Cartoon3D | OutLine3D | SkyBox3D | Wireframe3D | WebGLRenderer3D | ParticleSystem3D | Skeleton3D | SkinnedMesh3D | Terrain3D | Water3D | Animation | Stats)[]
组件列表

Returns (Component | Scene3D | Camera3D | TransformLayout3D | Button | Canvas | DirectionalLight3D | PointLight3D | SpotLight3D | Mesh3D | CanvasRenderer | Image | Rect | Text | AudioListener3D | AudioSource3D | OrthographicCamera3D | PerspectiveCamera3D | Billboard3D | Graphics3D | HoldSize3D | MouseRay3D | FPSController3D | MouseEvent3D | Cartoon3D | OutLine3D | SkyBox3D | Wireframe3D | WebGLRenderer3D | ParticleSystem3D | Skeleton3D | SkinnedMesh3D | Terrain3D | Water3D | Animation | Stats)[]
- Defined in src/ecs/Entity.ts:49
set components(value: (Component | Scene3D | Camera3D | TransformLayout3D | Button | Canvas | DirectionalLight3D | PointLight3D | SpotLight3D | Mesh3D | CanvasRenderer | Image | Rect | Text | AudioListener3D | AudioSource3D | OrthographicCamera3D | PerspectiveCamera3D | Billboard3D | Graphics3D | HoldSize3D | MouseRay3D | FPSController3D | MouseEvent3D | Cartoon3D | OutLine3D | SkyBox3D | Wireframe3D | WebGLRenderer3D | ParticleSystem3D | Skeleton3D | SkinnedMesh3D | Terrain3D | Water3D | Animation | Stats)[]): void
Parameters
- value: (Component | Scene3D | Camera3D | TransformLayout3D | Button | Canvas | DirectionalLight3D | PointLight3D | SpotLight3D | Mesh3D | CanvasRenderer | Image | Rect | Text | AudioListener3D | AudioSource3D | OrthographicCamera3D | PerspectiveCamera3D | Billboard3D | Graphics3D | HoldSize3D | MouseRay3D | FPSController3D | MouseEvent3D | Cartoon3D | OutLine3D | SkyBox3D | Wireframe3D | WebGLRenderer3D | ParticleSystem3D | Skeleton3D | SkinnedMesh3D | Terrain3D | Water3D | Animation | Stats)[]
Returns void
- Defined in src/ecs/Entity.ts:56

numComponents

get numComponents(): number
子组件个数

Returns number
- Defined in src/ecs/Entity.ts:77

Methods

addComponent

addComponent<K>(componentName: K, params?: gPartial<ComponentMap[K]>): ComponentMap[K]
添加一个类型为type的组件到游戏对象。

Returns
被添加的组件。
Type Parameters
- K extends keyof ComponentMap
Parameters
- componentName: K
- Optional params: gPartial<ComponentMap[K]>
Returns ComponentMap[K]
- Defined in src/ecs/Entity.ts:94

`Protected` addComponentAt

addComponentAt(component: Component, index: number): void
添加组件到指定位置
Parameters
- component: Component
  
  被添加的组件
- index: number
  
  插入的位置
Returns void
- Defined in src/ecs/Entity.ts:299

dispose

dispose(): void
销毁

Returns void
- Defined in src/ecs/Entity.ts:340

getComponent

getComponent<K>(componentName: K): ComponentMap[K]
返回游戏对象附加的一个指定类型的组件，如果没有，则返回 null。

使用 Entity.GetComponent 将返回找到的第一个组件。如果您希望有多个相同类型的组件，请改用 Entity.GetComponents，并循环通过返回的组件测试某些唯一属性。

Returns
要检索的组件。
Type Parameters
- K extends keyof ComponentMap
Parameters
- componentName: K
  
  要检索的组件类型。
Returns ComponentMap[K]
- Defined in src/ecs/Entity.ts:123

getComponentAt

getComponentAt(index: number): Component
获取指定位置索引的子组件

Returns
子组件
Parameters
- index: number
  
  位置索引
Returns Component
- Defined in src/ecs/Entity.ts:167

getComponentIndex

getComponentIndex(component: Component): number
获取组件在容器的索引位置

Returns
组件在容器的索引位置
Parameters
- component: Component
  
  查询的组件
Returns number
- Defined in src/ecs/Entity.ts:221

getComponents

getComponents<K>(component?: K, results?: ComponentMap[K][]): ComponentMap[K][]
返回Entity中指定类型的所有组件。

Returns
Entity中指定类型的所有组件。
Type Parameters
- K extends keyof ComponentMap
Parameters
- Optional component: K
  
  要检索的组件。
- results: ComponentMap[K][] = []
  
  列出接收找到的组件。
Returns ComponentMap[K][]
- Defined in src/ecs/Entity.ts:146

getShareTargets

getShareTargets(): (Component | Scene3D | Camera3D | TransformLayout3D | Button | Canvas | DirectionalLight3D | PointLight3D | SpotLight3D | Mesh3D | CanvasRenderer | Image | Rect | Text | AudioListener3D | AudioSource3D | OrthographicCamera3D | PerspectiveCamera3D | Billboard3D | Graphics3D | HoldSize3D | MouseRay3D | FPSController3D | MouseEvent3D | Cartoon3D | OutLine3D | SkyBox3D | Wireframe3D | WebGLRenderer3D | ParticleSystem3D | Skeleton3D | SkinnedMesh3D | Terrain3D | Water3D | Animation | Stats)[]
把事件分享到每个组件上。

Returns (Component | Scene3D | Camera3D | TransformLayout3D | Button | Canvas | DirectionalLight3D | PointLight3D | SpotLight3D | Mesh3D | CanvasRenderer | Image | Rect | Text | AudioListener3D | AudioSource3D | OrthographicCamera3D | PerspectiveCamera3D | Billboard3D | Graphics3D | HoldSize3D | MouseRay3D | FPSController3D | MouseEvent3D | Cartoon3D | OutLine3D | SkyBox3D | Wireframe3D | WebGLRenderer3D | ParticleSystem3D | Skeleton3D | SkinnedMesh3D | Terrain3D | Water3D | Animation | Stats)[]
- Defined in src/ecs/Entity.ts:332

removeComponent

removeComponent(component: Component): void
移除组件
Parameters
- component: Component
  
  被移除组件
Returns void
- Defined in src/ecs/Entity.ts:208

removeComponentAt

removeComponentAt(index: number): Component
移除组件
Parameters
- index: number
  
  要删除的 Component 的子索引。
Returns Component
- Defined in src/ecs/Entity.ts:234

removeComponentsByType

removeComponentsByType<K>(component: K | Constructor<ComponentMap[K]>): ComponentMap[K][]
移除指定类型组件
Type Parameters
- K extends keyof ComponentMap
Parameters
- component: K | Constructor<ComponentMap[K]>
  
  组件类型
Returns ComponentMap[K][]
- Defined in src/ecs/Entity.ts:278

setComponentAt

setComponentAt(component: Component, index: number): void
设置组件到指定位置
Parameters
- component: Component
  
  被设置的组件
- index: number
  
  索引
Returns void
- Defined in src/ecs/Entity.ts:195

setComponentIndex

setComponentIndex(component: Component, index: number): void
设置子组件的位置
Parameters
- component: Component
  
  子组件
- index: number
  
  位置索引
Returns void
- Defined in src/ecs/Entity.ts:179

swapComponents

swapComponents(a: Component, b: Component): void
交换子组件位置
Parameters
- a: Component
  
  第一个子组件
- b: Component
  
  第二个子组件
Returns void
- Defined in src/ecs/Entity.ts:266

swapComponentsAt

swapComponentsAt(index1: number, index2: number): void
交换子组件位置
Parameters
- index1: number
  
  第一个子组件的索引位置
- index2: number
  
  第二个子组件的索引位置
Returns void
- Defined in src/ecs/Entity.ts:251

Class Entity

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Returns Entity

Properties

Protected _components

Readonly emitter

name

Accessors

components

Parameters

Returns void

numComponents

Returns number

Methods

addComponent

Returns

Type Parameters

K extends keyof ComponentMap

Parameters

componentName: K

Optional params: gPartial<ComponentMap[K]>

Returns ComponentMap[K]

Protected addComponentAt

Parameters

component: Component

index: number

Returns void

dispose

Returns void

getComponent

Returns

Type Parameters

K extends keyof ComponentMap

Parameters

componentName: K

Returns ComponentMap[K]

getComponentAt

Returns

Parameters

index: number

Returns Component

getComponentIndex

Returns

Parameters

component: Component

Returns number

getComponents

Returns

Type Parameters

K extends keyof ComponentMap

Parameters

Optional component: K

results: ComponentMap[K][] = []

Returns ComponentMap[K][]

getShareTargets

removeComponent

Parameters

component: Component

Returns void

removeComponentAt

Parameters

index: number

Returns Component

removeComponentsByType

Type Parameters

K extends keyof ComponentMap

Parameters

component: K | Constructor<ComponentMap[K]>

Returns ComponentMap[K][]

setComponentAt

Parameters

component: Component

index: number

`Protected` _components

`Readonly` emitter

`Optional` params: gPartial<ComponentMap[K]>

`Protected` addComponentAt

`Optional` component: K