Button

Defined in: ui/Button.ts:97

Extends

• _Button

Implements

• IButton

Constructors

Constructor

new Button(config): Button

Defined in: ui/Button.ts:127

Parameters

config

Partial<ButtonConfig>

The configuration for the button.

Returns

Button

Overrides

_Button.constructor

Properties

add

add: object

Defined in: mixins/factory/Factory.ts:6

animatedSprite()

animatedSprite: (props?) => AnimatedSprite

Parameters

props?

Partial<AnimatedSpriteProps>

Returns

AnimatedSprite

bitmapText()

bitmapText: (props?) => BitmapText

Parameters

props?

Partial<TextProps>

Returns

BitmapText

button()

button: (props?) => Button

Parameters

props?

Partial<ButtonProps>

Returns

Button

container()

container: (props?) => Container<Application<DataSchema, ActionContext, Action, Renderer>>

Parameters

props?

Partial<ContainerProps>

Returns

Container<Application<DataSchema, ActionContext, Action, Renderer>>

existing()

existing: <TEntity>(entity, props?) => TEntity

Type Parameters

TEntity

TEntity

Parameters

entity

TEntity

props?

Partial<ExistingProps>

Returns

TEntity

flexContainer()

flexContainer: (props?) => FlexContainer

Parameters

props?

Partial<FlexContainerProps>

Returns

FlexContainer

graphics()

graphics: (props?) => Graphics

Parameters

props?

Partial<GraphicsProps>

Returns

Graphics

htmlText()

htmlText: (props?) => HTMLText

Parameters

props?

Partial<HTMLTextProps>

Returns

HTMLText

particleContainer()

particleContainer: (props?) => ParticleContainer<Application<DataSchema, ActionContext, Action, Renderer>>

Parameters

props?

Partial<ParticleContainerProps>

Returns

ParticleContainer<Application<DataSchema, ActionContext, Action, Renderer>>

spine()

spine: (props?) => Spine

Parameters

props?

Partial<SpineProps>

Returns

Spine

spineAnimation()

spineAnimation: <ANames, A>(props?) => SpineAnimation<ANames, A>

Type Parameters

ANames

ANames extends string = string

A

A extends Application<DataSchema, ActionContext, Action, Renderer> = Application<DataSchema, ActionContext, Action, Renderer>

Parameters

props?

Partial<SpineProps>

Returns

SpineAnimation<ANames, A>

sprite()

sprite: (props?) => Sprite

Parameters

props?

Partial<SpriteProps>

Returns

Sprite

text()

text: (props?) => Text

Parameters

props?

Partial<TextProps>

Returns

Text

texture()

texture: (props?) => Texture = resolveTexture

Parameters

props?

Partial<TextureProps>

Returns

Texture

tilingSprite()

tilingSprite: (props?) => TilingSprite

Parameters

props?

Partial<TilingSpriteProps>

Returns

TilingSprite

toaster()

toaster: (toasterConfig?, defaultToastConfig) => Toaster

Parameters

toasterConfig?

Partial<ToasterConfig>

defaultToastConfig?

Partial<ToastConfig> = {}

Returns

Toaster

uiCanvas()

uiCanvas: (props?) => UICanvas

Parameters

props?

Partial<UICanvasFactoryProps>

Returns

UICanvas

svg()

svg(props): Svg

Parameters

props

WithRequiredProps<SvgProps, "ctx">

Returns

Svg

Inherited from

_Button.add

---

focusEnabled

focusEnabled: boolean

Defined in: plugins/focus/FocusManagerPlugin.ts:20

Inherited from

_Button.focusEnabled

---

id

id: string

Defined in: ui/Button.ts:109

Implementation of

IButton.id

---

isDown

isDown: boolean

Defined in: ui/Button.ts:113

Implementation of

IButton.isDown

---

isFocused

isFocused: boolean

Defined in: plugins/focus/FocusManagerPlugin.ts:18

Inherited from

_Button.isFocused

---

isKeyDown

isKeyDown: boolean

Defined in: plugins/focus/FocusManagerPlugin.ts:19

Inherited from

_Button.isKeyDown

---

isOver

isOver: boolean

Defined in: ui/Button.ts:114

Implementation of

IButton.isOver

---

make

make: object

Defined in: mixins/factory/Factory.ts:7

animatedSprite()

animatedSprite: (props?) => AnimatedSprite

Parameters

props?

Partial<AnimatedSpriteProps>

Returns

AnimatedSprite

bitmapText()

bitmapText: (props?) => BitmapText

Parameters

props?

Partial<TextProps>

Returns

BitmapText

button()

button: (props?) => Button

Parameters

props?

Partial<ButtonProps>

Returns

Button

container()

container: (props?) => Container<Application<DataSchema, ActionContext, Action, Renderer>>

Parameters

props?

Partial<ContainerProps>

Returns

Container<Application<DataSchema, ActionContext, Action, Renderer>>

existing()

existing: <TEntity>(entity, props?) => TEntity

Type Parameters

TEntity

TEntity

Parameters

entity

TEntity

props?

Partial<ExistingProps>

Returns

TEntity

flexContainer()

flexContainer: (props?) => FlexContainer

Parameters

props?

Partial<FlexContainerProps>

Returns

FlexContainer

graphics()

graphics: (props?) => Graphics

Parameters

props?

Partial<GraphicsProps>

Returns

Graphics

htmlText()

htmlText: (props?) => HTMLText

Parameters

props?

Partial<HTMLTextProps>

Returns

HTMLText

particleContainer()

particleContainer: (props?) => ParticleContainer<Application<DataSchema, ActionContext, Action, Renderer>>

Parameters

props?

Partial<ParticleContainerProps>

Returns

ParticleContainer<Application<DataSchema, ActionContext, Action, Renderer>>

spine()

spine: (props?) => Spine

Parameters

props?

Partial<SpineProps>

Returns

Spine

spineAnimation()

spineAnimation: <ANames, A>(props?) => SpineAnimation<ANames, A>

Type Parameters

ANames

ANames extends string = string

A

A extends Application<DataSchema, ActionContext, Action, Renderer> = Application<DataSchema, ActionContext, Action, Renderer>

Parameters

props?

Partial<SpineProps>

Returns

SpineAnimation<ANames, A>

sprite()

sprite: (props?) => Sprite

Parameters

props?

Partial<SpriteProps>

Returns

Sprite

text()

text: (props?) => Text

Parameters

props?

Partial<TextProps>

Returns

Text

texture()

texture: (props?) => Texture = resolveTexture

Parameters

props?

Partial<TextureProps>

Returns

Texture

tilingSprite()

tilingSprite: (props?) => TilingSprite

Parameters

props?

Partial<TilingSpriteProps>

Returns

TilingSprite

toaster()

toaster: (toasterConfig?, defaultToastConfig) => Toaster

Parameters

toasterConfig?

Partial<ToasterConfig>

defaultToastConfig?

Partial<ToastConfig> = {}

Returns

Toaster

uiCanvas()

uiCanvas: (props?) => UICanvas

Parameters

props?

Partial<UICanvasFactoryProps>

Returns

UICanvas

svg()

svg(props): Svg

Parameters

props

WithRequiredProps<SvgProps, "ctx">

Returns

Svg

Inherited from

_Button.make

---

onBlur

onBlur: Signal<(focusable) => void>

Defined in: plugins/focus/FocusManagerPlugin.ts:36

Inherited from

_Button.onBlur

---

onClick

onClick: Signal<() => void>

Defined in: ui/Button.ts:104

Implementation of

IButton.onClick

---

onDestroy

onDestroy: Signal<() => void>

Defined in: ui/Button.ts:108

Implementation of

IButton.onDestroy

---

onDisabled

onDisabled: Signal<() => void>

Defined in: ui/Button.ts:106

Implementation of

IButton.onDisabled

---

onDown

onDown: Signal<() => void>

Defined in: ui/Button.ts:99

Implementation of

IButton.onDown

---

onEnabled

onEnabled: Signal<() => void>

Defined in: ui/Button.ts:105

Implementation of

IButton.onEnabled

---

onFocus

onFocus: Signal<(focusable) => void>

Defined in: plugins/focus/FocusManagerPlugin.ts:35

Inherited from

_Button.onFocus

---

onFocusIn

onFocusIn: Signal<(focusable) => void>

Defined in: plugins/focus/FocusManagerPlugin.ts:33

Inherited from

_Button.onFocusIn

---

onFocusOut

onFocusOut: Signal<(focusable) => void>

Defined in: plugins/focus/FocusManagerPlugin.ts:34

Inherited from

_Button.onFocusOut

---

onInteraction()

onInteraction: (eventName) => InteractionSignal

Defined in: mixins/interaction.ts:16

Parameters

eventName

keyof FederatedEventMap | keyof GlobalFederatedEventMap

Returns

InteractionSignal

Inherited from

_Button.onInteraction

---

onKeyboardEvent

onKeyboardEvent: Signal<(key) => void>

Defined in: ui/Button.ts:107

Implementation of

IButton.onKeyboardEvent

---

onOut

onOut: Signal<() => void>

Defined in: ui/Button.ts:102

Implementation of

IButton.onOut

---

onOver

onOver: Signal<() => void>

Defined in: ui/Button.ts:103

Implementation of

IButton.onOver

---

onUp

onUp: Signal<() => void>

Defined in: ui/Button.ts:100

Implementation of

IButton.onUp

---

onUpOutside

onUpOutside: Signal<() => void>

Defined in: ui/Button.ts:101

Implementation of

IButton.onUpOutside

---

signalConnections

signalConnections: SignalConnections

Defined in: mixins/signals.ts:9

Inherited from

_Button.signalConnections

---

view

view: Sprite

Defined in: ui/Button.ts:111

Implementation of

IButton.view

Accessors

app

Get Signature

get app(): IApplication

Defined in: ui/Button.ts:247

Returns

IApplication

---

enabled

Get Signature

get enabled(): boolean

Defined in: ui/Button.ts:243

Returns

boolean

Set Signature

set enabled(enabled): void

Defined in: ui/Button.ts:190

Sets the enabled state of the button.

Parameters

enabled

boolean

Whether the button is enabled.

Returns

void

Methods

addIsDownCallback()

addIsDownCallback(callbackId, callback): void

Defined in: ui/Button.ts:272

Parameters

callbackId

string

callback

() => void

Returns

void

---

addLabel()

addLabel<T>(config): T

Defined in: ui/Button.ts:212

Type Parameters

T

T extends Text | HTMLText | BitmapText

Parameters

config

T | Partial<TextProps | HTMLTextProps> & { type?: “text” | “html” | “bitmap” | undefined; }

Returns

T

---

addSignalConnection()

addSignalConnection(…args): void

Defined in: mixins/signals.ts:13

Parameters

args

…SignalConnection[]

Returns

void

Inherited from

_Button.addSignalConnection

---

blur()

blur(): void

Defined in: ui/Button.ts:262

Returns

void

Overrides

_Button.blur

---

click()

click(): void

Defined in: plugins/focus/FocusManagerPlugin.ts:42

Returns

void

Inherited from

_Button.click

---

connectAction()

connectAction(…args): void

Defined in: mixins/signals.ts:15

Parameters

args

…SignalConnection[]

Returns

void

Inherited from

_Button.connectAction

---

connectSignal()

connectSignal(…args): void

Defined in: mixins/signals.ts:14

Parameters

args

…SignalConnection[]

Returns

void

Inherited from

_Button.connectSignal

---

destroy()

destroy(options?): void

Defined in: ui/Button.ts:251

Removes all internal references and listeners as well as removes children from the display list. Do not use a Container after calling destroy.

Parameters

options?

DestroyOptions

Options parameter. A boolean will act as if all options have been set to that value

Returns

void

Example

container.destroy();
container.destroy(true);
container.destroy({ children: true });
container.destroy({ children: true, texture: true, textureSource: true });

Overrides

_Button.destroy

---

focusIn()

focusIn(): void

Defined in: plugins/focus/FocusManagerPlugin.ts:38

Returns

void

Inherited from

_Button.focusIn

---

focusOut()

focusOut(): void

Defined in: ui/Button.ts:256

Returns

void

Overrides

_Button.focusOut

---

getFocusArea()

getFocusArea(): Bounds

Defined in: ui/Button.ts:268

Returns

Bounds

Overrides

_Button.getFocusArea

---

getFocusPosition()

getFocusPosition(): null | PointLike

Defined in: plugins/focus/FocusManagerPlugin.ts:50

Returns

null | PointLike

Inherited from

_Button.getFocusPosition

---

getFocusSize()

getFocusSize(): null | PointLike

Defined in: plugins/focus/FocusManagerPlugin.ts:52

Returns

null | PointLike

Inherited from

_Button.getFocusSize

---

positionLabel()

positionLabel(): void

Defined in: ui/Button.ts:237

Returns

void

---

removeIsDownCallback()

removeIsDownCallback(callbackId): void

Defined in: ui/Button.ts:277

Parameters

callbackId

string

Returns

void

---

setTexture()

setTexture(textureId, texture): void

Defined in: ui/Button.ts:281

Parameters

textureId

ButtonTextureId

texture

TextureLike

Returns

void