Class CharsMenu

Hierarchy

CharsMenu

Constructors

constructor

new CharsMenu(game: Game, data: GoldenSun, on_change: ((char_key?: string, char_index?: number) => void)): CharsMenu

- Defined in base/support_menus/CharsMenu.ts:93
Parameters
- game: Game
- data: GoldenSun
- on_change: ((char_key?: string, char_index?: number) => void)
  - - (char_key?: string, char_index?: number): void
    - Parameters
      - Optional char_key: string
      - Optional char_index: number
      Returns void
Returns CharsMenu

Properties

arrow_group

arrow_group: Group

arrow_tweens

arrow_tweens: Tween[]

char_group

char_group: Group

char_sprites

char_sprites: Sprite[]

current_line

current_line: number

data

data: GoldenSun

down_arrow

down_arrow: Sprite

game

game: Game

is_active

is_active: boolean

is_open

is_open: boolean

lines

lines: MainChar[][]

mode

mode: CharsMenuModes

on_change

on_change: ((char_key?: string, char_index?: number) => void)

Type declaration

- (char_key?: string, char_index?: number): void
- Parameters
  - Optional char_key: string
  - Optional char_index: number
  Returns void

selected_index

selected_index: number

selected_statuses

selected_statuses: permanent_status[]

up_arrow

up_arrow: Sprite

window

window: Window

Accessors

selected_char_sprite

get selected_char_sprite(): Sprite

- Defined in base/support_menus/CharsMenu.ts:127
Returns Sprite

Methods

activate

activate(): void

- Defined in base/support_menus/CharsMenu.ts:470
Returns void

change_line

change_line(line: number, force_index?: number, no_cursor?: boolean): void

- Defined in base/support_menus/CharsMenu.ts:267
Parameters
- line: number
- Optional force_index: number
- Optional no_cursor: boolean
Returns void

check_arrows

check_arrows(): void

- Defined in base/support_menus/CharsMenu.ts:177
Returns void

check_mode

check_mode(): void

- Defined in base/support_menus/CharsMenu.ts:131
Returns void

clear_arrow_tweens

clear_arrow_tweens(): void

- Defined in base/support_menus/CharsMenu.ts:210
Returns void

close

close(callback?: (() => void), hide_cursor?: boolean): void

- Defined in base/support_menus/CharsMenu.ts:503
Parameters
- Optional callback: (() => void)
  - - (): void
    - Returns void
- hide_cursor: boolean = false
Returns void

deactivate

deactivate(): void

- Defined in base/support_menus/CharsMenu.ts:475
Returns void

grant_control

grant_control(on_cancel?: Function, on_select?: Function, enable_swap?: boolean, extra_controls?: Control[], confirm_sfx?: string | (() => string)): void

- Defined in base/support_menus/CharsMenu.ts:407
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

- Defined in base/support_menus/CharsMenu.ts:190
Returns void

make_lines

make_lines(): void

- Defined in base/support_menus/CharsMenu.ts:250
Returns void

move_cursor

move_cursor(pos?: number, on_complete?: Function): void

- Defined in base/support_menus/CharsMenu.ts:442
Parameters
- Optional pos: number
- Optional on_complete: Function
Returns void

next_char

next_char(no_cursor?: boolean): void

- Defined in base/support_menus/CharsMenu.ts:345
Parameters
- Optional no_cursor: boolean
Returns void

next_line

next_line(force_index?: number, no_cursor?: boolean): void

- Defined in base/support_menus/CharsMenu.ts:290
Parameters
- Optional force_index: number
- Optional no_cursor: boolean
Returns void

open

open(select_index?: number, mode?: CharsMenuModes, open_callback?: (() => void), silent?: boolean, selected_statuses?: permanent_status[]): void

- Defined in base/support_menus/CharsMenu.ts:480
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?: boolean): void

- Defined in base/support_menus/CharsMenu.ts:358
Parameters
- Optional no_cursor: boolean
Returns void

previous_line

previous_line(force_index?: number, no_cursor?: boolean): void

- Defined in base/support_menus/CharsMenu.ts:297
Parameters
- Optional force_index: number
- Optional no_cursor: boolean
Returns void

select_char

select_char(index?: number, no_cursor?: boolean, silent?: boolean): void

- Defined in base/support_menus/CharsMenu.ts:322
Parameters
- Optional index: number
- Optional no_cursor: boolean
- Optional silent: boolean
Returns void

set_arrows

set_arrows(up?: boolean, down?: boolean): void

- Defined in base/support_menus/CharsMenu.ts:164
Parameters
- up: boolean = false
- down: boolean = false
Returns void

set_character

set_character(index: number): void

- Defined in base/support_menus/CharsMenu.ts:304
Parameters
- index: number
Returns void

set_chars

set_chars(): void

- Defined in base/support_menus/CharsMenu.ts:216
Returns void

swap_next

swap_next(): void

- Defined in base/support_menus/CharsMenu.ts:371
Returns void

swap_previous

swap_previous(): void

- Defined in base/support_menus/CharsMenu.ts:391
Returns void

unset_character

unset_character(index: number): void

- Defined in base/support_menus/CharsMenu.ts:312
Parameters
- index: number
Returns void

Generated using TypeDoc