Class AbstractOptionSelectUiHandler`Abstract`

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

Hierarchy (View Summary)

UiHandler
- AbstractOptionSelectUiHandler

Constructors

constructor

new AbstractOptionSelectUiHandler(
mode?: null | UiMode,
): AbstractOptionSelectUiHandler
Parameters
- mode: null | UiMode = null
  The mode of the UI element. These should be unique.
Returns AbstractOptionSelectUiHandler
Inherited from UiHandler.constructor
- Defined in src/ui/handlers/ui-handler.ts:16

Properties

active

active: boolean = false

`Protected`blockInput

blockInput: boolean

`Protected`config

config: null | OptionSelectConfig

`Protected`cursor

cursor: number = 0

`Private`cursorObj

cursorObj: null | Image

`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
Overrides UiHandler.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 UiHandler.destroy
- Defined in src/ui/handlers/ui-handler.ts:63

eraseCursor

eraseCursor(): void
Returns void
- Defined in src/ui/handlers/abstract-option-select-ui-handler.ts:427

getCursor

getCursor(): number
Returns number
Inherited from UiHandler.getCursor
- Defined in src/ui/handlers/ui-handler.ts:34

getOptionsWithScroll

getOptionsWithScroll(): OptionSelectItem[]
Returns OptionSelectItem[]
- Defined in src/ui/handlers/abstract-option-select-ui-handler.ts:303

getUi

getUi(): UI
Returns UI
Inherited from UiHandler.getUi
- Defined in src/ui/handlers/ui-handler.ts:30

getUnskippedIndices

getUnskippedIndices(options: OptionSelectItem[]): number[]
Parameters
- options: OptionSelectItem[]
Returns number[]
- Defined in src/ui/handlers/abstract-option-select-ui-handler.ts:346

getWindowHeight

getWindowHeight(): number
Returns number
- Defined in src/ui/handlers/abstract-option-select-ui-handler.ts:62

`Abstract`getWindowWidth

getWindowWidth(): number
Returns number
- Defined in src/ui/handlers/abstract-option-select-ui-handler.ts:60

processInput

processInput(button: Button): boolean
Parameters
- button: Button
Returns boolean
Overrides UiHandler.processInput
- Defined in src/ui/handlers/abstract-option-select-ui-handler.ts:218

setCursor

setCursor(fullCursor: number): boolean
Parameters
- fullCursor: number
Returns boolean
Overrides UiHandler.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 UiHandler.setMouseCursorStyle
- Defined in src/ui/handlers/ui-handler.ts:52

setup

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

`Protected`setupOptions

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

show

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

unblockInput

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

Class AbstractOptionSelectUiHandlerAbstract

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns AbstractOptionSelectUiHandler

Properties

active

ProtectedblockInput

Protectedconfig

Protectedcursor

PrivatecursorObj

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

AbstractgetWindowWidth

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

Class AbstractOptionSelectUiHandler`Abstract`

`Protected`blockInput

`Protected`config

`Protected`cursor

`Private`cursorObj

`Protected`defaultTextStyle

`Protected`fullCursor

`Protected`mode

`Protected`optionSelectBg

`Protected`optionSelectContainer

`Protected`optionSelectIcons

`Protected`optionSelectText

`Protected`optionSelectTextContainer

`Protected`scale

`Protected`scrollCursor

`Protected`textContent

`Protected`unskippedIndices

`Abstract`getWindowWidth

`Protected`setMouseCursorStyle

`Protected`setupOptions