Class Button

按钮

Hierarchy

Component2D
- Button

Constructors

constructor

new Button(): Button
Returns Button
Overrides Component2D.constructor
- Defined in src/2d/Button.ts:75

Properties

`Protected` _entity

_entity: Entity

`Private` _stateInvalid

_stateInvalid: boolean = true

allStateData

allStateData: {} = {}

所有状态数据，每一个状态数据中记录了子对象的当前数据。

Type declaration

emitter

emitter: EventEmitter<Node2DEventMap>

enabled

enabled: boolean = true

是否启用update方法

hideFlags

hideFlags: HideFlags = HideFlags.None

隐藏标记，用于控制是否在层级界面、检查器显示，是否保存

runEnvironment

runEnvironment: RunEnvironment = RunEnvironment.all

可运行环境

state

state: ButtonState = ButtonState.up

按钮所处状态。

Accessors

entity

get entity(): Entity
此组件附加到的游戏对象。组件总是附加到游戏对象上。

Returns Entity
Inherited from Component2D.entity
- Defined in src/ecs/Component.ts:117

isVisibleAndEnabled

get isVisibleAndEnabled(): boolean
Has the Behaviour had enabled called. 是否所在Object3D显示且该行为已启动。

Returns boolean
Inherited from Component2D.isVisibleAndEnabled
- Defined in src/core/NodeComponent.ts:26

node

get node(): Node
2D节点。

Returns Node
Inherited from Component2D.node
- Defined in src/core/NodeComponent.ts:17

node2d

get node2d(): Node2D
2D节点。

Returns Node2D
Inherited from Component2D.node2d
- Defined in src/2d/core/Component2D.ts:11

Methods

`Private` _onStateChanged

_onStateChanged(): void
Returns void
- Defined in src/2d/Button.ts:104

`Private` _updateState

_updateState(): void
更新状态

Returns void
- Defined in src/2d/Button.ts:124

addComponent

addComponent<K>(type: K): ComponentMap[K]
Adds a component class of type componentType to the game object.

Returns
被添加的组件。
Type Parameters
- K extends keyof ComponentMap
Parameters
- type: K
  
  组件类定义。
Returns ComponentMap[K]
Inherited from Component2D.addComponent
- Defined in src/ecs/Component.ts:148

beforeRender

beforeRender(_renderAtomic: RenderAtomic, _scene: Scene3D, _camera: Camera3D): void
Parameters
- _renderAtomic: RenderAtomic
- _scene: Scene3D
- _camera: Camera3D
Returns void
Inherited from Component2D.beforeRender
- Defined in src/ecs/Component.ts:195

dispose

dispose(): void
销毁

Returns void
Inherited from Component2D.dispose
- Defined in src/ecs/Component.ts:189

getComponent

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

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

Returns
要检索的组件。
Type Parameters
- K extends keyof ComponentMap
Parameters
- component: K
  
  要检索的组件类型。
Returns ComponentMap[K]
Inherited from Component2D.getComponent
- Defined in src/ecs/Component.ts:161

getComponentInChildren

getComponentInChildren<K>(component: K, includeInactive?: boolean): ComponentMap[K]
使用深度优先搜索返回 Entity 或其任何子项中的 Type 组件。

Returns
匹配类型的组件（如果找到）。
Type Parameters
- K extends keyof ComponentMap
Parameters
- component: K
  
  要检索的组件类型。
- includeInactive: boolean = false
  
  是否包含不活跃组件。
Returns ComponentMap[K]
Inherited from Component2D.getComponentInChildren
- Defined in src/core/NodeComponent.ts:40

getComponentInParent

getComponentInParent<K>(component: K, includeInactive?: boolean): ComponentMap[K]
检索 Entity 或其任何父项type中的 Type 组件。

此方法向上递归，直到找到具有匹配组件的 Entity。仅匹配活动游戏对象上的组件。

Returns
如果找到与类型匹配的组件，则返回一个组件。否则返回 null。
Type Parameters
- K extends keyof ComponentMap
Parameters
- component: K
  
  要查找的组件类型。
- includeInactive: boolean = false
  
  是否包含不活跃组件。
Returns ComponentMap[K]
Inherited from Component2D.getComponentInParent
- Defined in src/core/NodeComponent.ts:54

getComponents

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

Returns
实体中指定类型的所有组件。
Type Parameters
- K extends keyof ComponentMap
Parameters
- type: K
  
  要检索的组件类型。
- results: ComponentMap[K][] = []
  
  列出接收找到的组件。
Returns ComponentMap[K][]
Inherited from Component2D.getComponents
- Defined in src/ecs/Component.ts:173

getComponentsInChildren

getComponentsInChildren<K>(component: K, includeInactive?: boolean, results?: ComponentMap[K][]): ComponentMap[K][]
使用深度优先搜索返回当前实体或其任何子子项中 Type 的所有组件。递归工作。

在子游戏对象上递归搜索组件。这意味着它还包括目标实体的所有子实体，以及所有后续子实体。

Returns
所有找到的组件。
Type Parameters
- K extends keyof ComponentMap
Parameters
- component: K
  
  要检索的组件类型。
- includeInactive: boolean = false
  
  非活动游戏对象上的组件是否应该包含在搜索结果中？
- results: ComponentMap[K][] = []
  
  列出接收找到的组件。
Returns ComponentMap[K][]
Inherited from Component2D.getComponentsInChildren
- Defined in src/core/NodeComponent.ts:68

getComponentsInParent

getComponentsInParent<K>(component: K, includeInactive?: boolean, results?: ComponentMap[K][]): ComponentMap[K][]
返回当前实体或其任何父级中指定的所有组件。

Returns
实体或其任何父级中指定的所有组件。
Type Parameters
- K extends keyof ComponentMap
Parameters
- component: K
  
  要检索的组件类型。
- includeInactive: boolean = false
  
  非活动组件是否应该包含在搜索结果中？
- results: ComponentMap[K][] = []
  
  列出找到的组件。
Returns ComponentMap[K][]
Inherited from Component2D.getComponentsInParent
- Defined in src/core/NodeComponent.ts:81

getShareTargets

getShareTargets(): Entity[]
把事件分享到实体上。

Returns Entity[]
Inherited from Component2D.getShareTargets
- Defined in src/ecs/Component.ts:181

init

init(): void
初始化组件

在添加到Entity时立即被调用。

Returns void
Inherited from Component2D.init
- Defined in src/ecs/Component.ts:132

saveState

saveState(): void
保存当前状态，例如在编辑器中编辑完按钮某一状态后调用该方法进行保存当前状态数据。

Returns void
- Defined in src/2d/Button.ts:84

`Private` setEntity

setEntity(entity: Entity): void
Private
该方法仅在Entity中使用
Parameters
- entity: Entity
  
  游戏对象
Returns void
Inherited from Component2D.setEntity
- Defined in src/ecs/Component.ts:206

update

update(_interval?: number): void
每帧执行
Parameters
- Optional _interval: number
Returns void
- Defined in src/2d/Button.ts:112

`Static` `Private` create

__create__<T>(this: Constructor<T>): T
Private
组件无法直接使用关键字 new 来构造。

Returns
新建的组件实例。

See
getInstance
Type Parameters
- T
Parameters
- this: Constructor<T>
Returns T
Inherited from Component2D.__create__
- Defined in src/ecs/Component.ts:230

`Static` getDependencies

getDependencies<K>(component: K): (keyof ComponentMap)[]
获取组件依赖列表
Type Parameters
- K extends keyof ComponentMap
Parameters
- component: K
  
  组件类定义
Returns (keyof ComponentMap)[]
Inherited from Component2D.getDependencies
- Defined in src/ecs/Component.ts:240

`Static` isSingleComponent

isSingleComponent<K>(component: K | ComponentMap[K] | Constructor<ComponentMap[K]>): boolean
判断组件是否为唯一组件。
Type Parameters
- K extends keyof ComponentMap
Parameters
- component: K | ComponentMap[K] | Constructor<ComponentMap[K]>
  
  组件类定义
Returns boolean
Inherited from Component2D.isSingleComponent
- Defined in src/ecs/Component.ts:260

Class Button

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Returns Button

Properties

Protected _entity

Private _stateInvalid

allStateData

Type declaration

emitter

enabled

hideFlags

runEnvironment

state

Accessors

entity

Returns Entity

isVisibleAndEnabled

Returns boolean

node

Returns Node

node2d

Returns Node2D

Methods

Private _onStateChanged

Returns void

Private _updateState

Returns void

addComponent

Returns

Type Parameters

K extends keyof ComponentMap

Parameters

type: K

Returns ComponentMap[K]

beforeRender

Parameters

_renderAtomic: RenderAtomic

_scene: Scene3D

_camera: Camera3D

Returns void

dispose

Returns void

getComponent

Returns

Type Parameters

K extends keyof ComponentMap

Parameters

component: K

Returns ComponentMap[K]

getComponentInChildren

Returns

Type Parameters

K extends keyof ComponentMap

Parameters

component: K

includeInactive: boolean = false

Returns ComponentMap[K]

getComponentInParent

Returns

Type Parameters

K extends keyof ComponentMap

Parameters

component: K

includeInactive: boolean = false

Returns ComponentMap[K]

getComponents

Returns

Type Parameters

K extends keyof ComponentMap

Parameters

type: K

results: ComponentMap[K][] = []

Returns ComponentMap[K][]

`Protected` _entity

`Private` _stateInvalid

`Private` _onStateChanged

`Private` _updateState

`Private` setEntity

`Optional` _interval: number

`Static` `Private` create

`Static` getDependencies

`Static` isSingleComponent