Class default

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

Hierarchy (view full)

default
- default

Constructors

constructor

new default(): default
Returns default
Overrides default.constructor
- Defined in src/ui/confirm-ui-handler.ts:16

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

scale: number = 0.1666666667

`Protected`scrollCursor

scrollCursor: number = 0

`Protected`unskippedIndices

unskippedIndices: number[] = []

`Static` `Readonly`windowWidth

windowWidth: number = 48

Methods

clear

clear(): void
Returns void
Inherited from default.clear
- Defined in src/ui/abstact-option-select-ui-handler.ts:393

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

eraseCursor

eraseCursor(): void
Returns void
Inherited from default.eraseCursor
- Defined in src/ui/abstact-option-select-ui-handler.ts:402

getCursor

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

getOptionsWithScroll

getOptionsWithScroll(): OptionSelectItem[]
Returns OptionSelectItem[]
Inherited from default.getOptionsWithScroll
- Defined in src/ui/abstact-option-select-ui-handler.ts:285

getTextColor

getTextColor(style, shadow?): 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

getUnskippedIndices

getUnskippedIndices(options): number[]
Parameters
- options: OptionSelectItem[]
Returns number[]
Inherited from default.getUnskippedIndices
- Defined in src/ui/abstact-option-select-ui-handler.ts:324

getWindowHeight

getWindowHeight(): number
Returns number
Inherited from default.getWindowHeight
- Defined in src/ui/abstact-option-select-ui-handler.ts:64

getWindowWidth

getWindowWidth(): number
Returns number
Overrides default.getWindowWidth
- Defined in src/ui/confirm-ui-handler.ts:20

processInput

processInput(button): boolean
Parameters
- button: Button
Returns boolean
Overrides default.processInput
- Defined in src/ui/confirm-ui-handler.ts:100

setCursor

setCursor(cursor): boolean
Parameters
- cursor: number
Returns boolean
Overrides default.setCursor
- Defined in src/ui/confirm-ui-handler.ts:108

`Protected`setMouseCursorStyle

setMouseCursorStyle(cursorStyle): 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
Returns void
Inherited from default.setup
- Defined in src/ui/abstact-option-select-ui-handler.ts:68

`Protected`setupOptions

setupOptions(): void
Returns void
Inherited from default.setupOptions
- Defined in src/ui/abstact-option-select-ui-handler.ts:88

show

show(args): boolean
Parameters
- args: any[]
Returns boolean
Overrides default.show
- Defined in src/ui/confirm-ui-handler.ts:24

unblockInput

unblockInput(): void
Returns void
Inherited from default.unblockInput
- Defined in src/ui/abstact-option-select-ui-handler.ts:275

Class default

Hierarchy (view full)

Index

Constructors

Properties

Methods

Constructors

constructor

Returns default

Properties

active

ProtectedblockInput

Protectedconfig

Protectedcursor

ProtecteddefaultTextStyle

ProtectedfullCursor

Protectedmode

ProtectedoptionSelectBg

ProtectedoptionSelectContainer

ProtectedoptionSelectIcons

ProtectedoptionSelectText

Protectedscale

ProtectedscrollCursor

ProtectedunskippedIndices

Static ReadonlywindowWidth

Methods

clear

Returns void

destroy

Returns void

eraseCursor

Returns void

getCursor

Returns number

getOptionsWithScroll

Returns OptionSelectItem[]

getTextColor

Parameters

Returns string

getUi

Returns default

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

`Protected`scrollCursor

`Protected`unskippedIndices

`Static` `Readonly`windowWidth

`Protected`setMouseCursorStyle

`Protected`setupOptions