Protected
awaitingProtected
cursorPrivate
cursorProtected
localPrivate
messageProtected
modePrivate
navigationProtected
navigationProtected
onPrivate
optionPrivate
optionsPrivate
optionsPrivate
optionPrivate
reloadProtected
rowsPrivate
scrollPrivate
scrollPrivate
settingProtected
settingsPrivate
settingsProtected
textProtected
textProtected
titleActivate the specified setting if it is activatable.
The setting to activate.
Whether the setting was successfully activated.
Clear the UI elements and state.
To be implemented by individual handlers when necessary to free memory Called when BattleScene is reset
Erase the cursor from the UI.
Add the sprite to be displayed at the end of messages with prompts
the container to add the sprite to
Create a semi transparent overlay that will get shown during tutorials
the container to add the overlay to
Processes input from a specified button. This method handles navigation through a UI menu, including movement through menu items and handling special actions like cancellation. Each button press may adjust the cursor position or the menu scroll, and plays a sound effect if the action was successful.
The button pressed by the user.
true
if the action associated with the button was successfully processed, false
otherwise.
Private
processSubmethod of processInput
to handle left/right input for changing option values
Current cursor position in the settings menu
Direction to pan when scrolling, -1 for left, 1 for right
true
if the action associated with the button was successfully processed, false
otherwise.
Set the cursor to the specified position.
The cursor position to set.
true
if the cursor was set successfully.
Protected
setChanges the style of the mouse cursor.
cursor style to apply
Set the option cursor to the specified position.
The index of the setting or -1 to change the current setting
The cursor position to set.
Optional
save: booleanWhether to save the setting to local storage.
true
if the option cursor was set successfully.
Set the scroll cursor to the specified position.
The scroll cursor position to set.
true
if the scroll cursor was set successfully.
Setup UI elements
Show the UI with the provided arguments.
Arguments to be passed to the show method.
true
if successful.
Optional
_name: stringOptional
delay: null | numberOptional
callback: null | FunctionOptional
callbackDelay: null | numberOptional
prompt: null | booleanOptional
promptDelay: null | numberOptional
callback: null | FunctionOptional
callbackDelay: null | numberUpdate the bindings for the current active device configuration.
Update the scroll position of the settings UI.
Abstract class for handling UI elements related to settings.