Class ModifierSelectUiHandler

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

Hierarchy (View Summary)

AwaitableUiHandler
- ModifierSelectUiHandler

Constructors

constructor

new ModifierSelectUiHandler(): ModifierSelectUiHandler
Returns ModifierSelectUiHandler
Overrides AwaitableUiHandler.constructor
- Defined in src/ui/handlers/modifier-select-ui-handler.ts:53

Properties

active

active: boolean = false

`Protected`awaitingActionInput

awaitingActionInput: boolean

`Private`checkButtonContainer

checkButtonContainer: Container

`Private`checkButtonWidth

checkButtonWidth: number

`Private`continueButtonContainer

continueButtonContainer: Container

`Protected`cursor

cursor: number = 0

`Private`cursorObj

cursorObj: null | Image

`Private`lockRarityButtonContainer

lockRarityButtonContainer: Container

`Private`lockRarityButtonText

lockRarityButtonText: Text

`Protected`mode

mode: null | number

`Private`modifierContainer

modifierContainer: Container

`Private`moveInfoOverlay

moveInfoOverlay: MoveInfoOverlay

`Private`moveInfoOverlayActive

moveInfoOverlayActive: boolean = false

`Protected`onActionInput

onActionInput: null | Function

options

options: ModifierOption[]

`Private`player

player: boolean

`Private`rerollButtonContainer

rerollButtonContainer: Container

`Private`rerollCost

rerollCost: number

If reroll cost is negative, it is assumed there are 0 items in the shop. It will cause reroll button to be disabled, and a "Continue" button to show in the place of shop items

`Private`rerollCostText

rerollCostText: Text

`Private`rowCursor

rowCursor: number = 0

shopOptionsRows

shopOptionsRows: ModifierOption[][]

`Private`transferButtonContainer

transferButtonContainer: Container

`Private`transferButtonWidth

transferButtonWidth: number

tutorialActive

tutorialActive: boolean = false

tutorialOverlay

tutorialOverlay: Rectangle

Methods

clear

clear(): void
Returns void
Overrides AwaitableUiHandler.clear
- Defined in src/ui/handlers/modifier-select-ui-handler.ts:695

destroy

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

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

eraseCursor

eraseCursor(): void
Returns void
- Defined in src/ui/handlers/modifier-select-ui-handler.ts:757

getCursor

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

`Private`getRowItems

getRowItems(rowCursor: number): number
Parameters
- rowCursor: number
Returns number
- Defined in src/ui/handlers/modifier-select-ui-handler.ts:649

getUi

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

initTutorialOverlay

initTutorialOverlay(container: Container): void
Create a semi transparent overlay that will get shown during tutorials
Parameters
- container: Container
  the container to add the overlay to
Returns void
Inherited from AwaitableUiHandler.initTutorialOverlay
- Defined in src/ui/handlers/awaitable-ui-handler.ts:33

processInput

processInput(button: Button): boolean
Parameters
- button: Button
Returns boolean
Overrides AwaitableUiHandler.processInput
- Defined in src/ui/handlers/modifier-select-ui-handler.ts:396

processTutorialInput

processTutorialInput(button: Button): boolean
Parameters
- button: Button
Returns boolean
Inherited from AwaitableUiHandler.processTutorialInput
- Defined in src/ui/handlers/awaitable-ui-handler.ts:16

setCursor

setCursor(cursor: number): boolean
Parameters
- cursor: number
Returns boolean
Overrides AwaitableUiHandler.setCursor
- Defined in src/ui/handlers/modifier-select-ui-handler.ts:532

`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 AwaitableUiHandler.setMouseCursorStyle
- Defined in src/ui/handlers/ui-handler.ts:52

setRerollCost

setRerollCost(rerollCost: number): void
Parameters
- rerollCost: number
Returns void
- Defined in src/ui/handlers/modifier-select-ui-handler.ts:660

setRowCursor

setRowCursor(rowCursor: number): boolean
Parameters
- rowCursor: number
Returns boolean
- Defined in src/ui/handlers/modifier-select-ui-handler.ts:610

setup

setup(): void
Returns void
Overrides AwaitableUiHandler.setup
- Defined in src/ui/handlers/modifier-select-ui-handler.ts:60

show

show(args: any[]): boolean
Parameters
- args: any[]
Returns boolean
Overrides AwaitableUiHandler.show
- Defined in src/ui/handlers/modifier-select-ui-handler.ts:159

updateCostText

updateCostText(): void
Returns void
- Defined in src/ui/handlers/modifier-select-ui-handler.ts:664

updateLockRaritiesText

updateLockRaritiesText(): void
Returns void
- Defined in src/ui/handlers/modifier-select-ui-handler.ts:689

updateRerollCostText

updateRerollCostText(): void
Returns void
- Defined in src/ui/handlers/modifier-select-ui-handler.ts:673

Class ModifierSelectUiHandler

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Returns ModifierSelectUiHandler

Properties

active

ProtectedawaitingActionInput

PrivatecheckButtonContainer

PrivatecheckButtonWidth

PrivatecontinueButtonContainer

Protectedcursor

PrivatecursorObj

PrivatelockRarityButtonContainer

PrivatelockRarityButtonText

Protectedmode

PrivatemodifierContainer

PrivatemoveInfoOverlay

PrivatemoveInfoOverlayActive

ProtectedonActionInput

options

Privateplayer

PrivatererollButtonContainer

PrivatererollCost

PrivatererollCostText

PrivaterowCursor

shopOptionsRows

PrivatetransferButtonContainer

PrivatetransferButtonWidth

tutorialActive

tutorialOverlay

Methods

clear

Returns void

destroy

Returns void

eraseCursor

Returns void

getCursor

Returns number

PrivategetRowItems

Parameters

Returns number

getUi

Returns UI

initTutorialOverlay

Parameters

Returns void

processInput

Parameters

Returns boolean

processTutorialInput

Parameters

Returns boolean

setCursor

Parameters

Returns boolean

ProtectedsetMouseCursorStyle

Parameters

Returns void

See

setRerollCost

Parameters

Returns void

setRowCursor

Parameters

Returns boolean

setup

Returns void

show

Parameters

Returns boolean

updateCostText

Returns void

updateLockRaritiesText

Returns void

`Protected`awaitingActionInput

`Private`checkButtonContainer

`Private`checkButtonWidth

`Private`continueButtonContainer

`Protected`cursor

`Private`cursorObj

`Private`lockRarityButtonContainer

`Private`lockRarityButtonText

`Protected`mode

`Private`modifierContainer

`Private`moveInfoOverlay

`Private`moveInfoOverlayActive

`Protected`onActionInput

`Private`player

`Private`rerollButtonContainer

`Private`rerollCost

`Private`rerollCostText

`Private`rowCursor

`Private`transferButtonContainer

`Private`transferButtonWidth

`Private`getRowItems

`Protected`setMouseCursorStyle