Class default`Abstract`

Abstract class for handling UI elements related to button bindings.

Hierarchy (view full)

default
- default
  - default
  - default

Constructors

constructor

new default(scene, mode?): default
Constructor for the AbstractBindingUiHandler.
Parameters
- scene: default
  The BattleScene instance.
- Optional mode: Mode
  The UI mode.
Returns default
Overrides default.constructor
- Defined in src/ui/settings/abstract-binding-ui-handler.ts:52

Properties

`Protected` actionBg

actionBg: NineSlice

`Protected` actionLabel

actionLabel: Text

`Protected` actionsContainer

actionsContainer: Container

active

active: boolean = false

`Protected` buttonPressed

buttonPressed: number = null

`Protected` cancelFn

cancelFn: ((boolean?) => boolean)

Type declaration

- (boolean?): boolean
- Parameters
  - Optional boolean: any
  Returns boolean

`Protected` cancelLabel

cancelLabel: Text

`Protected` countdownTimer

countdownTimer: any

`Protected` cursor

cursor: number = 0

`Protected` listening

listening: boolean = false

`Protected` mode

mode: number

`Protected` newButtonIcon

newButtonIcon: Sprite

`Protected` optionSelectBg

optionSelectBg: NineSlice

`Protected` optionSelectContainer

optionSelectContainer: Container

`Protected` scene

scene: default

`Protected` swapText

swapText: Text

`Protected` target

target: any

`Protected` targetButtonIcon

targetButtonIcon: Sprite

`Protected` timeLeftAutoClose

timeLeftAutoClose: number = 5

`Protected` timerText

timerText: Text

`Protected` titleBg

titleBg: NineSlice

`Protected` unlockText

unlockText: Text

Methods

clear

clear(): void
Clear the UI elements and state.

Returns void
Overrides default.clear
- Defined in src/ui/settings/abstract-binding-ui-handler.ts:223

getCursor

getCursor(): number
Returns number
Inherited from default.getCursor
- Defined in src/ui/ui-handler.ts:42

getTextColor

getTextColor(style, shadow?): string
Parameters
- style: TextStyle
- shadow: boolean = false
Returns string
Inherited from default.getTextColor
- Defined in src/ui/ui-handler.ts:38

getUi

getUi(): default
Returns default
Inherited from default.getUi
- Defined in src/ui/ui-handler.ts:34

getWindowHeight

getWindowHeight(): number
Get the height of the window.

Returns number
The window height.
- Defined in src/ui/settings/abstract-binding-ui-handler.ts:153

getWindowWidth

getWindowWidth(): number
Get the width of the window.

Returns number
The window width.
- Defined in src/ui/settings/abstract-binding-ui-handler.ts:144

manageAutoCloseTimer

manageAutoCloseTimer(): void
Returns void
- Defined in src/ui/settings/abstract-binding-ui-handler.ts:101

onInputDown

onInputDown(buttonIcon, assignedButtonIcon, type): void
Handle input down events.
Parameters
- buttonIcon: string
  The icon of the button that was pressed.
- assignedButtonIcon: string
  The icon of the button that is assigned.
- type: string
  The type of button press.
Returns void
- Defined in src/ui/settings/abstract-binding-ui-handler.ts:244

processInput

processInput(button): boolean
Process the input for the given button.
Parameters
- button: Button
  The button to process.
Returns boolean
true if the input was processed successfully.
Overrides default.processInput
- Defined in src/ui/settings/abstract-binding-ui-handler.ts:163

setCursor

setCursor(cursor): boolean
Set the cursor to the specified position.
Parameters
- cursor: number
  The cursor position to set.
Returns boolean
true if the cursor was set successfully.
Overrides default.setCursor
- Defined in src/ui/settings/abstract-binding-ui-handler.ts:204

setup

setup(): void
Setup UI elements.

Returns void
Overrides default.setup
- Defined in src/ui/settings/abstract-binding-ui-handler.ts:59

show

show(args): boolean
Show the UI with the provided arguments.
Parameters
- args: any[]
  Arguments to be passed to the show method.
Returns boolean
true if successful.
Overrides default.show
- Defined in src/ui/settings/abstract-binding-ui-handler.ts:120

`Abstract` swapAction

swapAction(): boolean
Returns boolean
- Defined in src/ui/settings/abstract-binding-ui-handler.ts:38

Class defaultAbstract

Hierarchy (view full)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns default

Properties

Protected actionBg

Protected actionLabel

Protected actionsContainer

active

Protected buttonPressed

Protected cancelFn

Type declaration

Parameters

Returns boolean

Protected cancelLabel

Protected countdownTimer

Protected cursor

Protected listening

Protected mode

Protected newButtonIcon

Protected optionSelectBg

Protected optionSelectContainer

Protected scene

Protected swapText

Protected target

Protected targetButtonIcon

Protected timeLeftAutoClose

Protected timerText

Protected titleBg

Protected unlockText

Methods

clear

Returns void

getCursor

Returns number

getTextColor

Parameters

Returns string

getUi

Returns default

getWindowHeight

Returns number

getWindowWidth

Returns number

manageAutoCloseTimer

Returns void

onInputDown

Parameters

Returns void

processInput

Parameters

Returns boolean

setCursor

Parameters

Returns boolean

setup

Returns void

show

Parameters

Returns boolean

Abstract swapAction

Returns boolean

Settings

Member Visibility

Theme

On This Page

Class default`Abstract`

`Protected` actionBg

`Protected` actionLabel

`Protected` actionsContainer

`Protected` buttonPressed

`Protected` cancelFn

`Protected` cancelLabel

`Protected` countdownTimer

`Protected` cursor

`Protected` listening

`Protected` mode

`Protected` newButtonIcon

`Protected` optionSelectBg

`Protected` optionSelectContainer

`Protected` scene

`Protected` swapText

`Protected` target

`Protected` targetButtonIcon

`Protected` timeLeftAutoClose

`Protected` timerText

`Protected` titleBg

`Protected` unlockText

`Abstract` swapAction