Class default

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

Hierarchy (view full)

default
- default
  - default

Constructors

constructor

new default(scene, mode?): default
Parameters
- scene: default
- mode: Mode = Mode.OPTION_SELECT
Returns default
Overrides default.constructor
- Defined in src/ui/settings/option-select-ui-handler.ts:6

Properties

active

active: boolean = false

`Protected`blockInput

blockInput: boolean

`Protected`config

config: null | OptionSelectConfig

`Protected`cursor

cursor: number = 0

`Protected`mode

mode: null | number

`Protected`optionSelectBg

optionSelectBg: NineSlice

`Protected`optionSelectContainer

optionSelectContainer: Container

`Protected`optionSelectIcons

optionSelectIcons: Sprite[]

`Protected`optionSelectText

optionSelectText: Text

`Protected`scale

scale: number = 0.1666666667

`Protected`scene

scene: default

`Protected`scrollCursor

scrollCursor: number = 0

Methods

clear

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

eraseCursor

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

getCursor

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

getOptionsWithScroll

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

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
Returns number
Inherited from default.getWindowHeight
- Defined in src/ui/abstact-option-select-ui-handler.ts:55

getWindowWidth

getWindowWidth(): number
Returns number
Overrides default.getWindowWidth
- Defined in src/ui/settings/option-select-ui-handler.ts:10

processInput

processInput(button): boolean
Parameters
- button: Button
Returns boolean
Inherited from default.processInput
- Defined in src/ui/abstact-option-select-ui-handler.ts:175

setCursor

setCursor(cursor): boolean
Parameters
- cursor: number
Returns boolean
Inherited from default.setCursor
- Defined in src/ui/abstact-option-select-ui-handler.ts:298

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

setup

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

`Protected`setupOptions

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

show

show(args): boolean
Parameters
- args: any[]
Returns boolean
Inherited from default.show
- Defined in src/ui/abstact-option-select-ui-handler.ts:149

unblockInput

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