Class default`Abstract`

Abstract class for handling UI elements related to button bindings.

Hierarchy (View Summary)

default
- default
  - default
  - default

Constructors

constructor

new default(mode?: null | Mode): default
Constructor for the AbstractBindingUiHandler.
Parameters
- mode: null | Mode = null
  The UI mode.
Returns default
Overrides default.constructor
- Defined in src/ui/settings/abstract-binding-ui-handler.ts:54

Properties

`Protected`actionBg

actionBg: NineSlice

`Protected`actionLabel

actionLabel: Text

`Protected`actionsContainer

actionsContainer: Container

active

active: boolean = false

`Protected`buttonPressed

buttonPressed: null | number = null

`Protected`cancelFn

cancelFn: null | CancelFn

`Protected`cancelLabel

cancelLabel: Text

`Protected`countdownTimer

countdownTimer: any

`Protected`cursor

cursor: number = 0

`Protected`listening

listening: boolean = false

`Protected`mode

mode: null | number

`Protected`newButtonIcon

newButtonIcon: Sprite

`Protected`optionSelectBg

optionSelectBg: NineSlice

`Protected`optionSelectContainer

optionSelectContainer: Container

`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:240

destroy

destroy(): void
To be implemented by individual handlers when necessary to free memory Called when BattleScene is reset

Returns void
Inherited from default.destroy
- Defined in src/ui/ui-handler.ts:69

getCursor

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

getTextColor

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

getUi

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

getWindowHeight

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

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

getWindowWidth

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

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

manageAutoCloseTimer

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

onInputDown

onInputDown(
    buttonIcon: string,
    assignedButtonIcon: null | string,
    type: string,
): void
Handle input down events.
Parameters
- buttonIcon: string
  The icon of the button that was pressed.
- assignedButtonIcon: null | 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:261

processInput

processInput(button: 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:180

setCursor

setCursor(cursor: number): 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:221

`Protected`setMouseCursorStyle

setMouseCursorStyle(cursorStyle: "default" | "pointer"): void
Changes the style of the mouse cursor.
Parameters
- cursorStyle: "default" | "pointer"
  cursor style to apply
Returns void
See
https://developer.mozilla.org/en-US/docs/Web/CSS/cursor
Inherited from default.setMouseCursorStyle
- Defined in src/ui/ui-handler.ts:58

setup

setup(): void
Setup UI elements.

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

show

show(args: any[]): 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:137

`Abstract`swapAction

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

Class defaultAbstract

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns default

Properties

ProtectedactionBg

ProtectedactionLabel

ProtectedactionsContainer

active

ProtectedbuttonPressed

ProtectedcancelFn

ProtectedcancelLabel

ProtectedcountdownTimer

Protectedcursor

Protectedlistening

Protectedmode

ProtectednewButtonIcon

ProtectedoptionSelectBg

ProtectedoptionSelectContainer

ProtectedswapText

Protectedtarget

ProtectedtargetButtonIcon

ProtectedtimeLeftAutoClose

ProtectedtimerText

ProtectedtitleBg

ProtectedunlockText

Methods

clear

Returns void

destroy

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

ProtectedsetMouseCursorStyle

Parameters

Returns void

See

setup

Returns void

show

Parameters

Returns boolean

AbstractswapAction

Returns boolean

Settings

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`swapText

`Protected`target

`Protected`targetButtonIcon

`Protected`timeLeftAutoClose

`Protected`timerText

`Protected`titleBg

`Protected`unlockText

`Protected`setMouseCursorStyle

`Abstract`swapAction