Class default

Abstract class for handling UI elements related to button bindings.

Hierarchy (view full)

default
- default

Constructors

constructor

new default(scene, mode?): default
Parameters
- scene: default
- Optional mode: Mode
Returns default
Overrides default.constructor
- Defined in src/ui/settings/keyboard-binding-ui-handler.ts:11

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
Inherited from default.clear
- Defined in src/ui/settings/abstract-binding-ui-handler.ts:224

getCursor

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

getSelectedDevice

getSelectedDevice(): any
Returns any
- Defined in src/ui/settings/keyboard-binding-ui-handler.ts:33

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.
Inherited from default.getWindowHeight
- Defined in src/ui/settings/abstract-binding-ui-handler.ts:154

getWindowWidth

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

Returns number
The window width.
Inherited from default.getWindowWidth
- Defined in src/ui/settings/abstract-binding-ui-handler.ts:145

manageAutoCloseTimer

manageAutoCloseTimer(): void
Returns void
Inherited from default.manageAutoCloseTimer
- Defined in src/ui/settings/abstract-binding-ui-handler.ts:102

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
Inherited from default.onInputDown
- Defined in src/ui/settings/abstract-binding-ui-handler.ts:245

onKeyDown

onKeyDown(event): void
Parameters
- event: any
Returns void
- Defined in src/ui/settings/keyboard-binding-ui-handler.ts:37

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.
Inherited from default.processInput
- Defined in src/ui/settings/abstract-binding-ui-handler.ts:164

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.
Inherited from default.setCursor
- Defined in src/ui/settings/abstract-binding-ui-handler.ts:205

setup

setup(): void
Setup UI elements.

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

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.
Inherited from default.show
- Defined in src/ui/settings/abstract-binding-ui-handler.ts:121

swapAction

swapAction(): boolean
Returns boolean
Overrides default.swapAction
- Defined in src/ui/settings/keyboard-binding-ui-handler.ts:64

Class default

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

getSelectedDevice

Returns any

getTextColor

Parameters

Returns string

getUi

Returns default

getWindowHeight

Returns number

getWindowWidth

Returns number

manageAutoCloseTimer

Returns void

onInputDown

Parameters

Returns void

onKeyDown

Parameters

Returns void

processInput

Parameters

Returns boolean

setCursor

Parameters

Returns boolean

setup

Returns void

show

Parameters

Returns boolean

swapAction

Returns boolean

Settings

Member Visibility

Theme

On This Page

`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