Class CharsMenu

constructor

• new CharsMenu(game, data, on_change): CharsMenu

• Parameters

  • game: Game
  • data: GoldenSun
  • on_change: ((char_key?, char_index?) => void)
    • • (char_key?, char_index?): void

      • Parameters

        • Optional char_key: string
        • Optional char_index: number

        Returns void

  Returns CharsMenu

arrow_group

arrow_tweens

char_group

char_sprites

current_line

data

down_arrow

game

is_active

is_open

lines

mode

on_change

selected_index

selected_statuses

up_arrow

window

selected_char_sprite

• get selected_char_sprite(): Sprite

• Returns Sprite

activate

• activate(): void

• Returns void

change_line

• change_line(line, force_index?, no_cursor?): void

• Parameters

  • line: number
  • Optional force_index: number
  • Optional no_cursor: boolean

  Returns void

check_arrows

• check_arrows(): void

• Returns void

check_mode

• check_mode(): void

• Returns void

clear_arrow_tweens

• clear_arrow_tweens(): void

• Returns void

close

• close(callback?, hide_cursor?): void

• Parameters

  • Optional callback: (() => void)
    • • (): void

      • Returns void

  • hide_cursor: boolean = false

  Returns void

deactivate

• deactivate(): void

• Returns void

grant_control

• grant_control(on_cancel?, on_select?, enable_swap?, extra_controls?, confirm_sfx?): void

• Parameters

  • Optional on_cancel: Function
  • Optional on_select: Function
  • Optional enable_swap: boolean
  • Optional extra_controls: Control[]
  • Optional confirm_sfx: string | (() => string)

  Returns void

init_arrow_tweens

• init_arrow_tweens(): void

• Returns void

make_lines

• make_lines(): void

• Returns void

move_cursor

• move_cursor(pos?, on_complete?): void

• Parameters

  • Optional pos: number
  • Optional on_complete: Function

  Returns void

next_char

• next_char(no_cursor?): void

• Parameters

  • Optional no_cursor: boolean

  Returns void

next_line

• next_line(force_index?, no_cursor?): void

• Parameters

  • Optional force_index: number
  • Optional no_cursor: boolean

  Returns void

open

• open(select_index?, mode?, open_callback?, silent?, selected_statuses?): void

• Parameters

  • select_index: number = 0
  • mode: CharsMenuModes = CharsMenuModes.SHOP
  • Optional open_callback: (() => void)
    • • (): void

      • Returns void

  • Optional silent: boolean
  • Optional selected_statuses: permanent_status[]

  Returns void

previous_char

• previous_char(no_cursor?): void

• Parameters

  • Optional no_cursor: boolean

  Returns void

previous_line

• previous_line(force_index?, no_cursor?): void

• Parameters

  • Optional force_index: number
  • Optional no_cursor: boolean

  Returns void

select_char

• select_char(index?, no_cursor?, silent?): void

• Parameters

  • Optional index: number
  • Optional no_cursor: boolean
  • Optional silent: boolean

  Returns void

set_arrows

• set_arrows(up?, down?): void

• Parameters

  • up: boolean = false
  • down: boolean = false

  Returns void

set_character

• set_character(index): void

• Parameters

  • index: number

  Returns void

set_chars

• set_chars(): void

• Returns void

swap_next

• swap_next(): void

• Returns void

swap_previous

• swap_previous(): void

• Returns void

unset_character

• unset_character(index): void

• Parameters

  • index: number

  Returns void