Class ButtonHelper

createjs-compatible ButtonHelper: sends its target to the out / over / down frames on mouse events, and stops it on the out frame from the start.

Index

Constructors

Properties

_enabled _isOver _isPressed downLabel outLabel overLabel play target

Accessors

Methods

handleEvent toString

Constructors

constructor

new ButtonHelper(
    target: IButtonTarget,
    outLabel?: string | number | null,
    overLabel?: string | number | null,
    downLabel?: string | number | null,
    play?: boolean,
    hitArea?: IButtonTarget | null,
    hitLabel?: string | number | null,
): ButtonHelper
Parameters
- target: IButtonTarget
- OptionaloutLabel: string | number | null
- OptionaloverLabel: string | number | null
- OptionaldownLabel: string | number | null
- Optionalplay: boolean
- OptionalhitArea: IButtonTarget | null
- OptionalhitLabel: string | number | null
Returns ButtonHelper
- Defined in packages/pixi-animate-runtime/src/player/objects.ts:1164

Properties

_enabled

_enabled: boolean = false

_isOver

_isOver: boolean = false

_isPressed

_isPressed: boolean = false

downLabel

downLabel: string | number

outLabel

outLabel: string | number

overLabel

overLabel: string | number

play

play: boolean

`Readonly`target

target: IButtonTarget

Accessors

enabled

get enabled(): boolean
Returns boolean
- Defined in packages/pixi-animate-runtime/src/player/objects.ts:1184
set enabled(value: boolean): void
Parameters
- value: boolean
Returns void
- Defined in packages/pixi-animate-runtime/src/player/objects.ts:1185

Methods

handleEvent

handleEvent(event: Event): void
Parameters
- event: Event
Returns void
- Defined in packages/pixi-animate-runtime/src/player/objects.ts:1219

toString

toString(): string
Returns string
- Defined in packages/pixi-animate-runtime/src/player/objects.ts:1242