Class HorizontalMenu

Hierarchy

HorizontalMenu

Constructors

constructor

new HorizontalMenu(game: Game, data: GoldenSun, buttons: string[], titles: string[], callbacks: { on_cancel?: Function; on_press: Function }, title_window_width?: number, dock_right?: boolean): HorizontalMenu

- Defined in base/support_menus/HorizontalMenu.ts:52
Parameters
- game: Game
- data: GoldenSun
- buttons: string[]
- titles: string[]
- callbacks: { on_cancel?: Function; on_press: Function }
  - Optional on_cancel?: Function
  - on_press: Function
- Optional title_window_width: number
- dock_right: boolean = false
Returns HorizontalMenu

Properties

buttons

buttons: { sprite: Sprite; title: string }[]

buttons_keys

buttons_keys: string[]

buttons_number

buttons_number: number

custom_scale

custom_scale: { active_default: number; max_scale: number }

Type declaration

active_default: number
max_scale: number

data

data: GoldenSun

dock_right

dock_right: boolean

game

game: Game

group

group: Group

menu_active

menu_active: boolean

menu_open

menu_open: boolean

on_cancel

on_cancel: Function

on_press

on_press: Function

selected_button_index

selected_button_index: number

selected_button_tween

selected_button_tween: Tween

title_text_obj

title_text_obj: TextObj

title_window

title_window: Window

title_window_width

title_window_width: number

titles

titles: string[]

x

x: number

y

y: number

Methods

activate

activate(): void

- Defined in base/support_menus/HorizontalMenu.ts:314
Returns void

change_button

change_button(step: number): void

- Defined in base/support_menus/HorizontalMenu.ts:170
Parameters
- step: number
Returns void

close

close(callback?: Function, animate?: boolean): void

- Defined in base/support_menus/HorizontalMenu.ts:274
Parameters
- Optional callback: Function
- animate: boolean = true
Returns void

deactivate

deactivate(hide?: boolean): void

- Defined in base/support_menus/HorizontalMenu.ts:330
Parameters
- hide: boolean = false
Returns void

destroy

destroy(): void

- Defined in base/support_menus/HorizontalMenu.ts:343
Returns void

mount_buttons

mount_buttons(filtered_buttons?: string[]): void

- Defined in base/support_menus/HorizontalMenu.ts:142
Parameters
- filtered_buttons: string[] = []
Returns void

next_button

next_button(): void

- Defined in base/support_menus/HorizontalMenu.ts:182
Returns void

open

open(callback?: Function, select_index?: number, start_active?: boolean, custom_scale?: { active_default: number; max_scale: number }, confirm_sfx?: string | (() => string)): void

- Defined in base/support_menus/HorizontalMenu.ts:225
Parameters
- Optional callback: Function
- select_index: number = 0
- start_active: boolean = true
- Optional custom_scale: { active_default: number; max_scale: number }
  - active_default: number
  - max_scale: number
- Optional confirm_sfx: string | (() => string)
Returns void

previous_button

previous_button(): void

- Defined in base/support_menus/HorizontalMenu.ts:186
Returns void

reset_button

reset_button(): void

- Defined in base/support_menus/HorizontalMenu.ts:215
Returns void

set_button

set_button(): void

- Defined in base/support_menus/HorizontalMenu.ts:199
Returns void

set_controls

set_controls(confirm_sfx?: string | (() => string)): void

- Defined in base/support_menus/HorizontalMenu.ts:127
Parameters
- Optional confirm_sfx: string | (() => string)
Returns void

set_to_position

set_to_position(index: number): void

- Defined in base/support_menus/HorizontalMenu.ts:190
Parameters
- index: number
Returns void

Generated using TypeDoc