Button
Defined in: ui/Button.ts:95
Extends
Section titled “Extends”_Button
Implements
Section titled “Implements”Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new Button(
config):Button
Defined in: ui/Button.ts:133
Parameters
Section titled “Parameters”config
Section titled “config”Partial<ButtonConfig>
The configuration for the button.
Returns
Section titled “Returns”Button
Overrides
Section titled “Overrides”_Button.constructor
Properties
Section titled “Properties”add:
object
Defined in: mixins/factory/Factory.ts:6
animatedSprite()
Section titled “animatedSprite()”animatedSprite: (
props?) =>AnimatedSprite
Parameters
Section titled “Parameters”props?
Section titled “props?”Partial<AnimatedSpriteProps>
Returns
Section titled “Returns”bitmapText()
Section titled “bitmapText()”bitmapText: (
props?) =>BitmapText
Parameters
Section titled “Parameters”props?
Section titled “props?”Partial<BitmapTextProps>
Returns
Section titled “Returns”BitmapText
button()
Section titled “button()”button: (
props?) =>Button
Parameters
Section titled “Parameters”props?
Section titled “props?”Partial<ButtonProps>
Returns
Section titled “Returns”Button
container()
Section titled “container()”container: (
props?) =>Container
Parameters
Section titled “Parameters”props?
Section titled “props?”Partial<ContainerProps>
Returns
Section titled “Returns”existing()
Section titled “existing()”existing: <
TEntity>(entity,props?) =>TEntity
Type Parameters
Section titled “Type Parameters”TEntity
Section titled “TEntity”TEntity
Parameters
Section titled “Parameters”entity
Section titled “entity”TEntity
props?
Section titled “props?”Partial<ExistingProps>
Returns
Section titled “Returns”TEntity
flexContainer()
Section titled “flexContainer()”flexContainer: (
props?) =>FlexContainer
Parameters
Section titled “Parameters”props?
Section titled “props?”Partial<FlexContainerProps>
Returns
Section titled “Returns”graphics()
Section titled “graphics()”graphics: (
props?) =>Graphics
Parameters
Section titled “Parameters”props?
Section titled “props?”Partial<GraphicsProps>
Returns
Section titled “Returns”Graphics
htmlText()
Section titled “htmlText()”htmlText: (
props?) =>HTMLText
Parameters
Section titled “Parameters”props?
Section titled “props?”Partial<HTMLTextProps>
Returns
Section titled “Returns”HTMLText
particleContainer()
Section titled “particleContainer()”particleContainer: (
props?) =>ParticleContainer
Parameters
Section titled “Parameters”props?
Section titled “props?”Partial<ParticleContainerProps>
Returns
Section titled “Returns”spine()
Section titled “spine()”spine: (
props?) =>Spine
Parameters
Section titled “Parameters”props?
Section titled “props?”Partial<SpineProps>
Returns
Section titled “Returns”spineAnimation()
Section titled “spineAnimation()”spineAnimation: <
ANames>(props?) =>SpineAnimation<ANames>
Type Parameters
Section titled “Type Parameters”ANames
Section titled “ANames”ANames extends string = string
Parameters
Section titled “Parameters”props?
Section titled “props?”Partial<SpineProps>
Returns
Section titled “Returns”SpineAnimation<ANames>
sprite()
Section titled “sprite()”sprite: (
props?) =>Sprite
Parameters
Section titled “Parameters”props?
Section titled “props?”Partial<SpriteProps>
Returns
Section titled “Returns”Sprite
text()
Section titled “text()”text: (
props?) =>Text
Parameters
Section titled “Parameters”props?
Section titled “props?”Partial<TextProps>
Returns
Section titled “Returns”Text
texture()
Section titled “texture()”texture: (
props?) =>Texture=resolveTexture
Parameters
Section titled “Parameters”props?
Section titled “props?”Partial<TextureProps>
Returns
Section titled “Returns”Texture
tilingSprite()
Section titled “tilingSprite()”tilingSprite: (
props?) =>TilingSprite
Parameters
Section titled “Parameters”props?
Section titled “props?”Partial<TilingSpriteProps>
Returns
Section titled “Returns”TilingSprite
toaster()
Section titled “toaster()”toaster: (
toasterConfig?,defaultToastConfig) =>Toaster
Parameters
Section titled “Parameters”toasterConfig?
Section titled “toasterConfig?”Partial<ToasterConfig>
defaultToastConfig?
Section titled “defaultToastConfig?”Partial<ToastConfig> = {}
Returns
Section titled “Returns”uiCanvas()
Section titled “uiCanvas()”uiCanvas: (
props?) =>UICanvas
Parameters
Section titled “Parameters”props?
Section titled “props?”Partial<UICanvasFactoryProps>
Returns
Section titled “Returns”svg(
props):Svg
Parameters
Section titled “Parameters”WithRequiredProps<SvgProps, "ctx">
Returns
Section titled “Returns”Inherited from
Section titled “Inherited from”_Button.add
focusEnabled
Section titled “focusEnabled”focusEnabled:
boolean
Defined in: plugins/focus/FocusManagerPlugin.ts:19
Inherited from
Section titled “Inherited from”_Button.focusEnabled
id:
string
Defined in: ui/Button.ts:107
Implementation of
Section titled “Implementation of”isDown
Section titled “isDown”isDown:
boolean
Defined in: ui/Button.ts:111
Implementation of
Section titled “Implementation of”isFocused
Section titled “isFocused”isFocused:
boolean
Defined in: plugins/focus/FocusManagerPlugin.ts:17
Inherited from
Section titled “Inherited from”_Button.isFocused
isKeyDown
Section titled “isKeyDown”isKeyDown:
boolean
Defined in: plugins/focus/FocusManagerPlugin.ts:18
Inherited from
Section titled “Inherited from”_Button.isKeyDown
isOver
Section titled “isOver”isOver:
boolean
Defined in: ui/Button.ts:112
Implementation of
Section titled “Implementation of”make:
object
Defined in: mixins/factory/Factory.ts:7
animatedSprite()
Section titled “animatedSprite()”animatedSprite: (
props?) =>AnimatedSprite
Parameters
Section titled “Parameters”props?
Section titled “props?”Partial<AnimatedSpriteProps>
Returns
Section titled “Returns”bitmapText()
Section titled “bitmapText()”bitmapText: (
props?) =>BitmapText
Parameters
Section titled “Parameters”props?
Section titled “props?”Partial<BitmapTextProps>
Returns
Section titled “Returns”BitmapText
button()
Section titled “button()”button: (
props?) =>Button
Parameters
Section titled “Parameters”props?
Section titled “props?”Partial<ButtonProps>
Returns
Section titled “Returns”Button
container()
Section titled “container()”container: (
props?) =>Container
Parameters
Section titled “Parameters”props?
Section titled “props?”Partial<ContainerProps>
Returns
Section titled “Returns”existing()
Section titled “existing()”existing: <
TEntity>(entity,props?) =>TEntity
Type Parameters
Section titled “Type Parameters”TEntity
Section titled “TEntity”TEntity
Parameters
Section titled “Parameters”entity
Section titled “entity”TEntity
props?
Section titled “props?”Partial<ExistingProps>
Returns
Section titled “Returns”TEntity
flexContainer()
Section titled “flexContainer()”flexContainer: (
props?) =>FlexContainer
Parameters
Section titled “Parameters”props?
Section titled “props?”Partial<FlexContainerProps>
Returns
Section titled “Returns”graphics()
Section titled “graphics()”graphics: (
props?) =>Graphics
Parameters
Section titled “Parameters”props?
Section titled “props?”Partial<GraphicsProps>
Returns
Section titled “Returns”Graphics
htmlText()
Section titled “htmlText()”htmlText: (
props?) =>HTMLText
Parameters
Section titled “Parameters”props?
Section titled “props?”Partial<HTMLTextProps>
Returns
Section titled “Returns”HTMLText
particleContainer()
Section titled “particleContainer()”particleContainer: (
props?) =>ParticleContainer
Parameters
Section titled “Parameters”props?
Section titled “props?”Partial<ParticleContainerProps>
Returns
Section titled “Returns”spine()
Section titled “spine()”spine: (
props?) =>Spine
Parameters
Section titled “Parameters”props?
Section titled “props?”Partial<SpineProps>
Returns
Section titled “Returns”spineAnimation()
Section titled “spineAnimation()”spineAnimation: <
ANames>(props?) =>SpineAnimation<ANames>
Type Parameters
Section titled “Type Parameters”ANames
Section titled “ANames”ANames extends string = string
Parameters
Section titled “Parameters”props?
Section titled “props?”Partial<SpineProps>
Returns
Section titled “Returns”SpineAnimation<ANames>
sprite()
Section titled “sprite()”sprite: (
props?) =>Sprite
Parameters
Section titled “Parameters”props?
Section titled “props?”Partial<SpriteProps>
Returns
Section titled “Returns”Sprite
text()
Section titled “text()”text: (
props?) =>Text
Parameters
Section titled “Parameters”props?
Section titled “props?”Partial<TextProps>
Returns
Section titled “Returns”Text
texture()
Section titled “texture()”texture: (
props?) =>Texture=resolveTexture
Parameters
Section titled “Parameters”props?
Section titled “props?”Partial<TextureProps>
Returns
Section titled “Returns”Texture
tilingSprite()
Section titled “tilingSprite()”tilingSprite: (
props?) =>TilingSprite
Parameters
Section titled “Parameters”props?
Section titled “props?”Partial<TilingSpriteProps>
Returns
Section titled “Returns”TilingSprite
toaster()
Section titled “toaster()”toaster: (
toasterConfig?,defaultToastConfig) =>Toaster
Parameters
Section titled “Parameters”toasterConfig?
Section titled “toasterConfig?”Partial<ToasterConfig>
defaultToastConfig?
Section titled “defaultToastConfig?”Partial<ToastConfig> = {}
Returns
Section titled “Returns”uiCanvas()
Section titled “uiCanvas()”uiCanvas: (
props?) =>UICanvas
Parameters
Section titled “Parameters”props?
Section titled “props?”Partial<UICanvasFactoryProps>
Returns
Section titled “Returns”svg(
props):Svg
Parameters
Section titled “Parameters”WithRequiredProps<SvgProps, "ctx">
Returns
Section titled “Returns”Inherited from
Section titled “Inherited from”_Button.make
onBlur
Section titled “onBlur”onBlur:
Signal<(focusable) =>void>
Defined in: plugins/focus/FocusManagerPlugin.ts:35
Inherited from
Section titled “Inherited from”_Button.onBlur
onClick
Section titled “onClick”onClick:
Signal<() =>void>
Defined in: ui/Button.ts:102
Implementation of
Section titled “Implementation of”onDestroy
Section titled “onDestroy”onDestroy:
Signal<() =>void>
Defined in: ui/Button.ts:106
Implementation of
Section titled “Implementation of”onDisabled
Section titled “onDisabled”onDisabled:
Signal<() =>void>
Defined in: ui/Button.ts:104
Implementation of
Section titled “Implementation of”onDown
Section titled “onDown”onDown:
Signal<() =>void>
Defined in: ui/Button.ts:97
Implementation of
Section titled “Implementation of”onEnabled
Section titled “onEnabled”onEnabled:
Signal<() =>void>
Defined in: ui/Button.ts:103
Implementation of
Section titled “Implementation of”onFocus
Section titled “onFocus”onFocus:
Signal<(focusable) =>void>
Defined in: plugins/focus/FocusManagerPlugin.ts:34
Inherited from
Section titled “Inherited from”_Button.onFocus
onFocusIn
Section titled “onFocusIn”onFocusIn:
Signal<(focusable) =>void>
Defined in: plugins/focus/FocusManagerPlugin.ts:32
Inherited from
Section titled “Inherited from”_Button.onFocusIn
onFocusOut
Section titled “onFocusOut”onFocusOut:
Signal<(focusable) =>void>
Defined in: plugins/focus/FocusManagerPlugin.ts:33
Inherited from
Section titled “Inherited from”_Button.onFocusOut
onInteraction()
Section titled “onInteraction()”onInteraction: (
eventName) =>InteractionSignal
Defined in: mixins/interaction.ts:16
Parameters
Section titled “Parameters”eventName
Section titled “eventName”keyof FederatedEventMap | keyof GlobalFederatedEventMap
Returns
Section titled “Returns”Inherited from
Section titled “Inherited from”_Button.onInteraction
onKeyboardEvent
Section titled “onKeyboardEvent”onKeyboardEvent:
Signal<(key) =>void>
Defined in: ui/Button.ts:105
Implementation of
Section titled “Implementation of”onOut:
Signal<() =>void>
Defined in: ui/Button.ts:100
Implementation of
Section titled “Implementation of”onOver
Section titled “onOver”onOver:
Signal<() =>void>
Defined in: ui/Button.ts:101
Implementation of
Section titled “Implementation of”onUp:
Signal<() =>void>
Defined in: ui/Button.ts:98
Implementation of
Section titled “Implementation of”onUpOutside
Section titled “onUpOutside”onUpOutside:
Signal<() =>void>
Defined in: ui/Button.ts:99
Implementation of
Section titled “Implementation of”signalConnections
Section titled “signalConnections”signalConnections:
SignalConnections
Defined in: mixins/signals.ts:9
Inherited from
Section titled “Inherited from”_Button.signalConnections
view:
Sprite
Defined in: ui/Button.ts:109
Implementation of
Section titled “Implementation of”Accessors
Section titled “Accessors”Get Signature
Section titled “Get Signature”get app():
IApplication
Defined in: ui/Button.ts:257
Returns
Section titled “Returns”enabled
Section titled “enabled”Get Signature
Section titled “Get Signature”get enabled():
boolean
Defined in: ui/Button.ts:253
Returns
Section titled “Returns”boolean
Set Signature
Section titled “Set Signature”set enabled(
enabled):void
Defined in: ui/Button.ts:198
Sets the enabled state of the button.
Parameters
Section titled “Parameters”enabled
Section titled “enabled”boolean
Whether the button is enabled.
Returns
Section titled “Returns”void
textLabel
Section titled “textLabel”Get Signature
Section titled “Get Signature”get textLabel():
undefined|Text|HTMLText|BitmapText
Defined in: ui/Button.ts:125
The text label of the button.
Returns
Section titled “Returns”undefined | Text | HTMLText | BitmapText
The text label instance.
Methods
Section titled “Methods”addIsDownCallback()
Section titled “addIsDownCallback()”addIsDownCallback(
callbackId,callback):void
Defined in: ui/Button.ts:282
Parameters
Section titled “Parameters”callbackId
Section titled “callbackId”string
callback
Section titled “callback”() => void
Returns
Section titled “Returns”void
addLabel()
Section titled “addLabel()”addLabel<
T>(config):T
Defined in: ui/Button.ts:220
Type Parameters
Section titled “Type Parameters”T extends Text | HTMLText | BitmapText
Parameters
Section titled “Parameters”config
Section titled “config”T | Partial<TextProps | HTMLTextProps> & { type?: “text” | “html” | “bitmap” | undefined; }
Returns
Section titled “Returns”T
addSignalConnection()
Section titled “addSignalConnection()”addSignalConnection(…
args):void
Defined in: mixins/signals.ts:13
Parameters
Section titled “Parameters”…SignalConnection[]
Returns
Section titled “Returns”void
Inherited from
Section titled “Inherited from”_Button.addSignalConnection
blur()
Section titled “blur()”blur():
void
Defined in: ui/Button.ts:272
Returns
Section titled “Returns”void
Overrides
Section titled “Overrides”_Button.blur
click()
Section titled “click()”click():
void
Defined in: plugins/focus/FocusManagerPlugin.ts:41
Returns
Section titled “Returns”void
Inherited from
Section titled “Inherited from”_Button.click
connectAction()
Section titled “connectAction()”connectAction(…
args):void
Defined in: mixins/signals.ts:15
Parameters
Section titled “Parameters”…SignalConnection[]
Returns
Section titled “Returns”void
Inherited from
Section titled “Inherited from”_Button.connectAction
connectSignal()
Section titled “connectSignal()”connectSignal(…
args):void
Defined in: mixins/signals.ts:14
Parameters
Section titled “Parameters”…SignalConnection[]
Returns
Section titled “Returns”void
Inherited from
Section titled “Inherited from”_Button.connectSignal
destroy()
Section titled “destroy()”destroy(
options?):void
Defined in: ui/Button.ts:261
Removes all internal references and listeners as well as removes children from the display list.
Do not use a Container after calling destroy.
Parameters
Section titled “Parameters”options?
Section titled “options?”DestroyOptions
Options parameter. A boolean will act as if all options have been set to that value
Returns
Section titled “Returns”void
Example
Section titled “Example”container.destroy();container.destroy(true);container.destroy({ children: true });container.destroy({ children: true, texture: true, textureSource: true });Overrides
Section titled “Overrides”_Button.destroy
focusIn()
Section titled “focusIn()”focusIn():
void
Defined in: plugins/focus/FocusManagerPlugin.ts:37
Returns
Section titled “Returns”void
Inherited from
Section titled “Inherited from”_Button.focusIn
focusOut()
Section titled “focusOut()”focusOut():
void
Defined in: ui/Button.ts:266
Returns
Section titled “Returns”void
Overrides
Section titled “Overrides”_Button.focusOut
getFocusArea()
Section titled “getFocusArea()”getFocusArea():
Bounds
Defined in: ui/Button.ts:278
Returns
Section titled “Returns”Bounds
Overrides
Section titled “Overrides”_Button.getFocusArea
getFocusPosition()
Section titled “getFocusPosition()”getFocusPosition():
null|PointLike
Defined in: plugins/focus/FocusManagerPlugin.ts:49
Returns
Section titled “Returns”null | PointLike
Inherited from
Section titled “Inherited from”_Button.getFocusPosition
getFocusSize()
Section titled “getFocusSize()”getFocusSize():
null|PointLike
Defined in: plugins/focus/FocusManagerPlugin.ts:51
Returns
Section titled “Returns”null | PointLike
Inherited from
Section titled “Inherited from”_Button.getFocusSize
positionLabel()
Section titled “positionLabel()”positionLabel():
void
Defined in: ui/Button.ts:247
Returns
Section titled “Returns”void
removeIsDownCallback()
Section titled “removeIsDownCallback()”removeIsDownCallback(
callbackId):void
Defined in: ui/Button.ts:287
Parameters
Section titled “Parameters”callbackId
Section titled “callbackId”string
Returns
Section titled “Returns”void
setTexture()
Section titled “setTexture()”setTexture(
textureId,texture):void
Defined in: ui/Button.ts:291
Parameters
Section titled “Parameters”textureId
Section titled “textureId”ButtonTextureId
texture
Section titled “texture”Returns
Section titled “Returns”void