UIButton | 小游戏框架

按钮组件。

export

Hierarchy

Touchable
- UIButton

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new UIButton(entity: Entity2D): UIButton

Overrides Touchable.constructor
- Defined in src/engine/game/2D/UIButton.ts:341
Parameters
- entity: Entity2D
Returns UIButton

Properties

Readonly entity

entity: Entity2D

物体对象。

memberof: Touchable

Readonly id

id: number = ...

Readonly isDestroyed

isDestroyed: boolean = false

Readonly isDestroying

isDestroying: boolean = false

Readonly priority

priority: number = ...

transition

transition: number = 0

状态转移动画效果时长。

memberof: UIButton

Static Priority

Priority: { Align: number; Layout: number; Low: number; Physics: number; Render: number; Tool: number } = ...

Type declaration

Align: number
Layout: number
Low: number
Physics: number
Render: number
Tool: number

Static Optional Serialize

Serialize: (...args: any[]) => any

Type declaration

- (...args: any[]): any
- Parameters
  - Rest ...args: any[]
  Returns any

Static State

State: typeof ButtonState = ...

按钮状态类型枚举值

static
memberof: UIButton

Accessors

active

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

- Defined in src/engine/game/component.ts:57
Returns boolean
- Defined in src/engine/game/component.ts:60
Parameters
- value: boolean
Returns void

activeInHierarchy

get activeInHierarchy(): boolean

- Defined in src/engine/game/component.ts:79
在场景树中是否active

readonly

memberof

Component

Returns boolean

disable

get disable(): boolean
set disable(disable: boolean): void

- Defined in src/engine/game/2D/UIButton.ts:271
是否将UIButton设置为不可用

Returns boolean
- Defined in src/engine/game/2D/UIButton.ts:257
是否将UIButton设置为不可用

memberof

UIButton

Parameters
- disable: boolean
Returns void

disabledColor

get disabledColor(): Color
set disabledColor(val: Color): void

- Defined in src/engine/game/2D/UIButton.ts:231
不可用状态下按钮的图像混合的颜色。

Returns Color
- Defined in src/engine/game/2D/UIButton.ts:216
不可用状态下按钮的图像混合的颜色。

readonly

memberof

UIButton

Parameters
- val: Color
Returns void

disabledSprite

get disabledSprite(): SpriteFrame
set disabledSprite(disabledSprite: SpriteFrame): void

- Defined in src/engine/game/2D/UIButton.ts:173
点击状态下按钮的图片。

Returns SpriteFrame
- Defined in src/engine/game/2D/UIButton.ts:164
点击状态下按钮的图片。

memberof

UIButton

Parameters
- disabledSprite: SpriteFrame
Returns void

grayScaleOnDisable

get grayScaleOnDisable(): boolean
set grayScaleOnDisable(grayScaleOnDisable: boolean): void

- Defined in src/engine/game/2D/UIButton.ts:291
disable状态下是否将按钮渲染为灰阶

Returns boolean
- Defined in src/engine/game/2D/UIButton.ts:284
disable状态下是否将按钮渲染为灰阶

memberof

UIButton

Parameters
- grayScaleOnDisable: boolean
Returns void

normalColor

get normalColor(): Color
set normalColor(color: Color): void

- Defined in src/engine/game/2D/UIButton.ts:77
普通状态下按钮图像混合的颜色。

Returns Color
- Defined in src/engine/game/2D/UIButton.ts:68
普通状态下按钮图像混合的颜色。

memberof

UIButton

Parameters
- color: Color
Returns void

normalSprite

get normalSprite(): SpriteFrame
set normalSprite(spriteFrame: SpriteFrame): void

- Defined in src/engine/game/2D/UIButton.ts:119
普通状态下按钮的图片。

Returns SpriteFrame
- Defined in src/engine/game/2D/UIButton.ts:105
普通状态下按钮的图片。

memberof

UIButton

Parameters
- spriteFrame: SpriteFrame
Returns void

onClick

get onClick(): Delegate<this, Readonly<{ allowThrough: boolean; originalEvent: TouchEvent; touches: DeepImmutableArray<TouchPoint>; type: TouchEventNames; stopTouchThrough: any }>>

- Defined in src/engine/game/2D/input/TouchInputComponent.ts:272
点击事件，只有触发过触摸开始事件才可能触发。

readonly

memberof

Touchable

Returns Delegate<this, Readonly<{ allowThrough: boolean; originalEvent: TouchEvent; touches: DeepImmutableArray<TouchPoint>; type: TouchEventNames; stopTouchThrough: any }>>

onTouchCancel

get onTouchCancel(): Delegate<this, Readonly<{ allowThrough: boolean; originalEvent: TouchEvent; touches: DeepImmutableArray<TouchPoint>; type: TouchEventNames; stopTouchThrough: any }>>

- Defined in src/engine/game/2D/input/TouchInputComponent.ts:232
触摸取消事件，只有触发过触摸开始事件才可能触发。

readonly

memberof

Touchable

Returns Delegate<this, Readonly<{ allowThrough: boolean; originalEvent: TouchEvent; touches: DeepImmutableArray<TouchPoint>; type: TouchEventNames; stopTouchThrough: any }>>

onTouchEnd

get onTouchEnd(): Delegate<this, Readonly<{ allowThrough: boolean; originalEvent: TouchEvent; touches: DeepImmutableArray<TouchPoint>; type: TouchEventNames; stopTouchThrough: any }>>

- Defined in src/engine/game/2D/input/TouchInputComponent.ts:167
触摸结束事件，只有触发过触摸开始事件才可能触发。

readonly

memberof

Touchable

Returns Delegate<this, Readonly<{ allowThrough: boolean; originalEvent: TouchEvent; touches: DeepImmutableArray<TouchPoint>; type: TouchEventNames; stopTouchThrough: any }>>

onTouchEnter

get onTouchEnter(): Delegate<this, Readonly<{ allowThrough: boolean; originalEvent: TouchEvent; touches: DeepImmutableArray<TouchPoint>; type: TouchEventNames; stopTouchThrough: any }>>

- Defined in src/engine/game/2D/input/TouchInputComponent.ts:193
触摸进入事件，只有触发过触摸开始事件才可能触发。

readonly

memberof

Touchable

Returns Delegate<this, Readonly<{ allowThrough: boolean; originalEvent: TouchEvent; touches: DeepImmutableArray<TouchPoint>; type: TouchEventNames; stopTouchThrough: any }>>

onTouchLeave

get onTouchLeave(): Delegate<this, Readonly<{ allowThrough: boolean; originalEvent: TouchEvent; touches: DeepImmutableArray<TouchPoint>; type: TouchEventNames; stopTouchThrough: any }>>

- Defined in src/engine/game/2D/input/TouchInputComponent.ts:206
触摸离开事件，只有触发过触摸开始事件才可能触发。

readonly

memberof

Touchable

Returns Delegate<this, Readonly<{ allowThrough: boolean; originalEvent: TouchEvent; touches: DeepImmutableArray<TouchPoint>; type: TouchEventNames; stopTouchThrough: any }>>

onTouchMove

get onTouchMove(): Delegate<this, Readonly<{ allowThrough: boolean; originalEvent: TouchEvent; touches: DeepImmutableArray<TouchPoint>; type: TouchEventNames; stopTouchThrough: any }>>

- Defined in src/engine/game/2D/input/TouchInputComponent.ts:180
触摸移动事件，只有触发过触摸开始事件才可能触发。

readonly

memberof

Touchable

Returns Delegate<this, Readonly<{ allowThrough: boolean; originalEvent: TouchEvent; touches: DeepImmutableArray<TouchPoint>; type: TouchEventNames; stopTouchThrough: any }>>

onTouchOut

get onTouchOut(): Delegate<this, Readonly<{ allowThrough: boolean; originalEvent: TouchEvent; touches: DeepImmutableArray<TouchPoint>; type: TouchEventNames; stopTouchThrough: any }>>

- Defined in src/engine/game/2D/input/TouchInputComponent.ts:245
触摸掠过后移出事件，没有触发过触摸开始事件才能触发。

readonly

memberof

Touchable

Returns Delegate<this, Readonly<{ allowThrough: boolean; originalEvent: TouchEvent; touches: DeepImmutableArray<TouchPoint>; type: TouchEventNames; stopTouchThrough: any }>>

onTouchOver

get onTouchOver(): Delegate<this, Readonly<{ allowThrough: boolean; originalEvent: TouchEvent; touches: DeepImmutableArray<TouchPoint>; type: TouchEventNames; stopTouchThrough: any }>>

- Defined in src/engine/game/2D/input/TouchInputComponent.ts:219
触摸掠过事件，没有触发过触摸开始事件才能触发。

readonly

memberof

Touchable

Returns Delegate<this, Readonly<{ allowThrough: boolean; originalEvent: TouchEvent; touches: DeepImmutableArray<TouchPoint>; type: TouchEventNames; stopTouchThrough: any }>>

onTouchStart

get onTouchStart(): Delegate<this, Readonly<{ allowThrough: boolean; originalEvent: TouchEvent; touches: DeepImmutableArray<TouchPoint>; type: TouchEventNames; stopTouchThrough: any }>>

- Defined in src/engine/game/2D/input/TouchInputComponent.ts:154
触摸开始事件。

readonly

memberof

Touchable

Returns Delegate<this, Readonly<{ allowThrough: boolean; originalEvent: TouchEvent; touches: DeepImmutableArray<TouchPoint>; type: TouchEventNames; stopTouchThrough: any }>>

onTouchUp

get onTouchUp(): Delegate<this, Readonly<{ allowThrough: boolean; originalEvent: TouchEvent; touches: DeepImmutableArray<TouchPoint>; type: TouchEventNames; stopTouchThrough: any }>>

- Defined in src/engine/game/2D/input/TouchInputComponent.ts:258
触摸掠过后移出事件，没有触发过触摸开始事件才能触发。

readonly

memberof

Touchable

Returns Delegate<this, Readonly<{ allowThrough: boolean; originalEvent: TouchEvent; touches: DeepImmutableArray<TouchPoint>; type: TouchEventNames; stopTouchThrough: any }>>

pressedColor

get pressedColor(): Color
set pressedColor(val: Color): void

- Defined in src/engine/game/2D/UIButton.ts:200
不可用状态下按钮的图像混合的颜色。

Returns Color
- Defined in src/engine/game/2D/UIButton.ts:185
不可用状态下按钮的图像混合的颜色。

memberof

UIButton

Parameters
- val: Color
Returns void

pressedSprite

get pressedSprite(): SpriteFrame
set pressedSprite(pressedSprite: SpriteFrame): void

- Defined in src/engine/game/2D/UIButton.ts:151
点击状态下按钮的图片。

Returns SpriteFrame
- Defined in src/engine/game/2D/UIButton.ts:142
点击状态下按钮的图片。

memberof

UIButton

Parameters
- pressedSprite: SpriteFrame
Returns void

state

get state(): ButtonState
set state(state: ButtonState): void

- Defined in src/engine/game/2D/UIButton.ts:59
当前按钮的状态

Returns ButtonState
- Defined in src/engine/game/2D/UIButton.ts:55
当前按钮的状态

memberof

UIButton

Parameters
- state: ButtonState
Returns void

useClickOnDisable

get useClickOnDisable(): boolean
set useClickOnDisable(clickOnDisable: boolean): void

- Defined in src/engine/game/2D/UIButton.ts:312
disable状态下是否将按钮渲染为灰阶

Returns boolean
- Defined in src/engine/game/2D/UIButton.ts:304
disable状态下是否将按钮渲染为灰阶

memberof

UIButton

Parameters
- clickOnDisable: boolean
Returns void

Methods

destroy

destroy(): void

Inherited from Touchable.destroy
- Defined in src/engine/game/component.ts:133
Returns void

getTypeName

getTypeName(): string

Inherited from Touchable.getTypeName
- Defined in src/engine/game/component.ts:129
Returns string

isDetached

isDetached(): boolean

Inherited from Touchable.isDetached
- Defined in src/engine/game/component.ts:145
Returns boolean

resetProperties

resetProperties(): void

Inherited from Touchable.resetProperties
- Defined in src/engine/game/component.ts:169
Returns void

setState

setState(state: ButtonState, animation?: boolean, forceUpdate?: boolean): void

- Defined in src/engine/game/2D/UIButton.ts:360
设置按钮状态。

memberof

UIButton

Parameters
- state: ButtonState
  
  目标状态。
- animation: boolean = true
- forceUpdate: boolean = false
Returns void

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

entity: Entity2D

Returns UIButton

Properties

Readonly entity

Readonly id

Readonly isDestroyed

Readonly isDestroying

Readonly priority

transition

Static Priority

Type declaration

Align: number

Layout: number

Low: number

Physics: number

Render: number

Tool: number

Static Optional Serialize

Type declaration

Parameters

Rest ...args: any[]

Returns any

Static State

Accessors

active

Returns boolean

Parameters

value: boolean

Returns void

activeInHierarchy

Returns boolean

disable

Returns boolean

Parameters

disable: boolean

Returns void

disabledColor

Returns Color

Parameters

val: Color

Returns void

disabledSprite

Returns SpriteFrame

Parameters

disabledSprite: SpriteFrame

Returns void

grayScaleOnDisable

Returns boolean

Parameters

grayScaleOnDisable: boolean

Returns void

normalColor

Returns Color

Parameters

color: Color

Returns void

normalSprite

Returns SpriteFrame

Parameters

spriteFrame: SpriteFrame

Returns void

onClick

Returns Delegate<this, Readonly<{ allowThrough: boolean; originalEvent: TouchEvent; touches: DeepImmutableArray<TouchPoint>; type: TouchEventNames; stopTouchThrough: any }>>

onTouchCancel

Returns Delegate<this, Readonly<{ allowThrough: boolean; originalEvent: TouchEvent; touches: DeepImmutableArray<TouchPoint>; type: TouchEventNames; stopTouchThrough: any }>>

onTouchEnd

Returns Delegate<this, Readonly<{ allowThrough: boolean; originalEvent: TouchEvent; touches: DeepImmutableArray<TouchPoint>; type: TouchEventNames; stopTouchThrough: any }>>

onTouchEnter

Returns Delegate<this, Readonly<{ allowThrough: boolean; originalEvent: TouchEvent; touches: DeepImmutableArray<TouchPoint>; type: TouchEventNames; stopTouchThrough: any }>>

onTouchLeave

Returns Delegate<this, Readonly<{ allowThrough: boolean; originalEvent: TouchEvent; touches: DeepImmutableArray<TouchPoint>; type: TouchEventNames; stopTouchThrough: any }>>