Class OptionSelectUiHandler

A basic abstract class to act as a holder and processor for UI elements.

Hierarchy (View Summary)

AbstractOptionSelectUiHandler
- OptionSelectUiHandler
  - TitleUiHandler

Constructors

constructor

new OptionSelectUiHandler(mode?: UiMode): OptionSelectUiHandler
Parameters
- mode: UiMode = UiMode.OPTION_SELECT
Returns OptionSelectUiHandler
Overrides AbstractOptionSelectUiHandler.constructor
- Defined in src/ui/settings/option-select-ui-handler.ts:5

Properties

active

active: boolean = false

`Protected`blockInput

blockInput: boolean

`Protected`config

config: null | OptionSelectConfig

`Protected`cursor

cursor: number = 0

`Protected`defaultTextStyle

defaultTextStyle: TextStyle = TextStyle.WINDOW

`Protected`fullCursor

fullCursor: number = 0

`Protected`mode

mode: null | number

`Protected`optionSelectBg

optionSelectBg: NineSlice

`Protected`optionSelectContainer

optionSelectContainer: Container

`Protected`optionSelectIcons

optionSelectIcons: Sprite[]

`Protected`optionSelectText

optionSelectText: BBCodeText

`Protected`optionSelectTextContainer

optionSelectTextContainer: Container

`Protected`scale

scale: number = 0.1666666667

`Protected`scrollCursor

scrollCursor: number = 0

`Protected`textContent

textContent: string

`Protected`unskippedIndices

unskippedIndices: number[] = []

Methods

clear

clear(): void
Returns void
Inherited from AbstractOptionSelectUiHandler.clear
- Defined in src/ui/handlers/abstract-option-select-ui-handler.ts:418

destroy

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

Returns void
Inherited from AbstractOptionSelectUiHandler.destroy
- Defined in src/ui/handlers/ui-handler.ts:63

setCursor

setCursor(fullCursor: number): boolean
Parameters
- fullCursor: number
Returns boolean
Inherited from AbstractOptionSelectUiHandler.setCursor
- Defined in src/ui/handlers/abstract-option-select-ui-handler.ts:353

`Protected`setMouseCursorStyle

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

setup

setup(): void
Returns void
Inherited from AbstractOptionSelectUiHandler.setup
- Defined in src/ui/handlers/abstract-option-select-ui-handler.ts:66

`Protected`setupOptions

setupOptions(): void
Returns void
Inherited from AbstractOptionSelectUiHandler.setupOptions
- Defined in src/ui/handlers/abstract-option-select-ui-handler.ts:89

show

show(args: any[]): boolean
Parameters
- args: any[]
Returns boolean
Inherited from AbstractOptionSelectUiHandler.show
- Defined in src/ui/handlers/abstract-option-select-ui-handler.ts:186

unblockInput

unblockInput(): void
Returns void
Inherited from AbstractOptionSelectUiHandler.unblockInput
- Defined in src/ui/handlers/abstract-option-select-ui-handler.ts:293

Class OptionSelectUiHandler

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns OptionSelectUiHandler

Properties

active

ProtectedblockInput

Protectedconfig

Protectedcursor

ProtecteddefaultTextStyle

ProtectedfullCursor

Protectedmode

ProtectedoptionSelectBg

ProtectedoptionSelectContainer

ProtectedoptionSelectIcons

ProtectedoptionSelectText

ProtectedoptionSelectTextContainer

Protectedscale

ProtectedscrollCursor

ProtectedtextContent

ProtectedunskippedIndices

Methods

clear

Returns void

destroy

Returns void

eraseCursor

Returns void

getCursor

Returns number

getOptionsWithScroll

Returns OptionSelectItem[]

getUi

Returns UI

getUnskippedIndices

Parameters

Returns number[]

getWindowHeight

Returns number

getWindowWidth

Returns number

processInput

Parameters

Returns boolean

setCursor

Parameters

Returns boolean

ProtectedsetMouseCursorStyle

Parameters

Returns void

See

setup

Returns void

ProtectedsetupOptions

Returns void

show

Parameters

Returns boolean

unblockInput

Returns void

Settings

On This Page

`Protected`blockInput

`Protected`config

`Protected`cursor

`Protected`defaultTextStyle

`Protected`fullCursor

`Protected`mode

`Protected`optionSelectBg

`Protected`optionSelectContainer

`Protected`optionSelectIcons

`Protected`optionSelectText

`Protected`optionSelectTextContainer

`Protected`scale

`Protected`scrollCursor

`Protected`textContent

`Protected`unskippedIndices

`Protected`setMouseCursorStyle

`Protected`setupOptions