Class Battle

Hierarchy (view full)

BattleBase
- Battle

Index

Constructors

constructor

Constructors

constructor

new Battle(game, data, background_key, enemy_party_key, bgm, reset_previous_bgm, before_fade_finish_callback?, finish_callback?): Battle
Parameters
- game: Game
- data: GoldenSun
- background_key: string
- enemy_party_key: string
- bgm: string
- reset_previous_bgm: boolean
- Optional before_fade_finish_callback: ((victory, all_party_fled) => Promise<void>)
  - - (victory, all_party_fled): Promise<void>
    - Parameters
      victory: boolean
      all_party_fled: boolean
      Returns Promise<void>
- Optional finish_callback: ((victory, all_party_fled?) => void)
  - - (victory, all_party_fled?): void
    - Parameters
      victory: boolean
      Optional all_party_fled: boolean
      Returns void
Returns Battle
Overrides BattleBase.constructor
- Defined in base/battle/Battle.ts:86

Properties

advance_log_control_key

advance_log_control_key: number

advance_log_resolve

advance_log_resolve: (() => void)

Type declaration

- (): void
- Returns void

allies_abilities

allies_abilities: PlayerAbilities

allies_defeated

allies_defeated: boolean

allies_info

allies_info: PlayerInfo[]

allies_map_sprite

allies_map_sprite: {
[player_key: string]: PlayerSprite;
}

Type declaration

[player_key: string]: PlayerSprite

animation_manager

animation_manager: BattleAnimationManager

background_key

background_key: string

battle_finishing

battle_finishing: boolean

battle_log

battle_log: BattleLog

battle_menu

battle_menu: MainBattleMenu

battle_phase

battle_phase: number

battle_stage

battle_stage: BattleStage

before_fade_finish_callback

before_fade_finish_callback: ((victory, all_party_fled) => Promise<void>)

Type declaration

- (victory, all_party_fled): Promise<void>
- Parameters
  - victory: boolean
  - all_party_fled: boolean
  Returns Promise<void>

bgm

bgm: string

can_escape

can_escape: boolean

data

data: GoldenSun

enemies_abilities

enemies_abilities: PlayerAbilities

enemies_defeated

enemies_defeated: boolean

enemies_info

enemies_info: PlayerInfo[]

enemies_map_sprite

enemies_map_sprite: {
[player_key: string]: PlayerSprite;
}

Type declaration

[player_key: string]: PlayerSprite

enemies_party_name

enemies_party_name: string

finish_callback

finish_callback: ((victory, all_party_fled?) => void)

Type declaration

- (victory, all_party_fled?): void
- Parameters
  - victory: boolean
  - Optional all_party_fled: boolean
  Returns void

flee_attemps

flee_attemps: {
allies: number;
enemies: number;
}

Type declaration

allies: number
enemies: number

game

game: Game

on_going_effects

on_going_effects: Effect[]

party_fled

party_fled: boolean

previous_bgm

previous_bgm: string

previous_map_state

previous_map_state: {
    previously_inactive_io: Set<number>;
    previously_inactive_npc: Set<number>;
    previously_not_visible_layers: Set<number>;
}

Type declaration

previously_inactive_io: Set<number>
previously_inactive_npc: Set<number>
previously_not_visible_layers: Set<number>

reset_previous_bgm

reset_previous_bgm: boolean

round_end_effects

round_end_effects: {
    ability: Ability;
    action: PlayerAbility;
    effect: any;
}[]

Type declaration

ability: Ability
action: PlayerAbility
effect: any

target_window

target_window: ChoosingTargetWindow

this_enemies_list

this_enemies_list: {
[battle_key: string]: Enemy;
}

Type declaration

[battle_key: string]: Enemy

turns_actions

turns_actions: PlayerAbility[]

`Static` `Readonly` MAX_CHARS_IN_BATTLE

MAX_CHARS_IN_BATTLE: 4 = 4

Methods

apply_battle_recovery

apply_battle_recovery(party, is_hp_recovery): Promise<void>
Parameters
- party: PlayerInfo[]
- is_hp_recovery: boolean
Returns Promise<void>
- Defined in base/battle/Battle.ts:1642

apply_damage

apply_damage(action, ability): {
    check_downed?: Enemy | MainChar;
    msg?: string;
    update_chars_info?: boolean;
}[]
Parameters
- action: PlayerAbility
- ability: Ability
Returns {
    check_downed?: Enemy | MainChar;
    msg?: string;
    update_chars_info?: boolean;
}[]
- Defined in base/battle/Battle.ts:839

apply_effects

apply_effects(action, ability, effect_obj): {
    end_turn_effect: boolean;
    had_no_effect: boolean;
    log_messages: {
        action_changes?: {
            action: battle_actions;
            player_sprite: PlayerSprite;
        }[];
        check_downed?: Enemy | MainChar;
        msg?: string;
        update_chars_info?: boolean;
    }[];
}
Parameters
- action: PlayerAbility
- ability: Ability
- effect_obj: any
Returns {
    end_turn_effect: boolean;
    had_no_effect: boolean;
    log_messages: {
        action_changes?: {
            action: battle_actions;
            player_sprite: PlayerSprite;
        }[];
        check_downed?: Enemy | MainChar;
        msg?: string;
        update_chars_info?: boolean;
    }[];
}
- end_turn_effect: boolean
- had_no_effect: boolean
- log_messages: {
      action_changes?: {
          action: battle_actions;
          player_sprite: PlayerSprite;
      }[];
      check_downed?: Enemy | MainChar;
      msg?: string;
      update_chars_info?: boolean;
  }[]
- Defined in base/battle/Battle.ts:1243

apply_item_ability_side_effects

apply_item_ability_side_effects(action): Promise<void>
Parameters
- action: PlayerAbility
Returns Promise<void>
- Defined in base/battle/Battle.ts:1158

apply_summon_power_buff

apply_summon_power_buff(action, ability): Promise<void>
Parameters
- action: PlayerAbility
- ability: Ability
Returns Promise<void>
- Defined in base/battle/Battle.ts:1131

battle_fadein

battle_fadein(): Promise<void>
Returns Promise<void>
Inherited from BattleBase.battle_fadein
- Defined in base/battle/BattleBase.ts:127

battle_phase_combat

battle_phase_combat(): Promise<void>
Returns Promise<void>
Overrides BattleBase.battle_phase_combat
- Defined in base/battle/Battle.ts:520

battle_phase_end

battle_phase_end(): Promise<void>
Returns Promise<void>
- Defined in base/battle/Battle.ts:1679

battle_phase_flee

battle_phase_flee(): Promise<void>
Returns Promise<void>
- Defined in base/battle/Battle.ts:1663

battle_phase_menu

battle_phase_menu(): void
Returns void
- Defined in base/battle/Battle.ts:364

battle_phase_none

battle_phase_none(): Promise<void>
Returns Promise<void>
Overrides BattleBase.battle_phase_none
- Defined in base/battle/Battle.ts:320

battle_phase_round_end

battle_phase_round_end(): Promise<void>
Returns Promise<void>
- Defined in base/battle/Battle.ts:1503

battle_phase_round_start

battle_phase_round_start(): Promise<void>
Returns Promise<void>
Overrides BattleBase.battle_phase_round_start
- Defined in base/battle/Battle.ts:379

can_flee

can_flee(ally_attempt): boolean
Parameters
- ally_attempt: boolean
Returns boolean
- Defined in base/battle/Battle.ts:223

check_death_curse

check_death_curse(action): Promise<void>
Parameters
- action: PlayerAbility
Returns Promise<void>
- Defined in base/battle/Battle.ts:1207

check_downed

check_downed(target): Promise<void>
Parameters
- target: Enemy | MainChar
Returns Promise<void>
- Defined in base/battle/Battle.ts:482

check_for_attack_dodge

check_for_attack_dodge(action, ability): void
Parameters
- action: PlayerAbility
- ability: Ability
Returns void
- Defined in base/battle/Battle.ts:785

check_if_ability_will_unleash

check_if_ability_will_unleash(action, ability, item_name): Promise<{
ability: Ability;
item_name: string;
}>
Parameters
- action: PlayerAbility
- ability: Ability
- item_name: string
Returns Promise<{
ability: Ability;
item_name: string;
}>
- Defined in base/battle/Battle.ts:1066

check_if_all_targets_are_downed

check_if_all_targets_are_downed(action): boolean
Parameters
- action: PlayerAbility
Returns boolean
- Defined in base/battle/Battle.ts:1008

check_if_char_is_paralyzed

check_if_char_is_paralyzed(action): Promise<boolean>
Parameters
- action: PlayerAbility
Returns Promise<boolean>
- Defined in base/battle/Battle.ts:984

check_if_curse_will_take_effect

check_if_curse_will_take_effect(action): Promise<boolean>
Parameters
- action: PlayerAbility
Returns Promise<boolean>
- Defined in base/battle/Battle.ts:999

check_parties

check_parties(): void
Returns void
- Defined in base/battle/Battle.ts:169

check_phases

check_phases(): void
Returns void
- Defined in base/battle/Battle.ts:180

check_poison_damage

check_poison_damage(action): Promise<void>
Parameters
- action: PlayerAbility
Returns Promise<void>
- Defined in base/battle/Battle.ts:1179

choose_targets

choose_targets(ability_key, action, callback, caster, item_obj?): void
Parameters
- ability_key: string
- action: string
- callback: Function
- caster: Player
- Optional item_obj: ItemSlot
Returns void
- Defined in base/battle/Battle.ts:134

down_a_char

down_a_char(target): Promise<void>
Parameters
- target: Enemy | MainChar
Returns Promise<void>
- Defined in base/battle/Battle.ts:490

flee

flee(ally_attempt, enemy_battle_key?): Promise<void>
Parameters
- ally_attempt: boolean
- Optional enemy_battle_key: string
Returns Promise<void>
- Defined in base/battle/Battle.ts:250

get_phase_ability

get_phase_ability(action): Promise<Ability>
Parameters
- action: PlayerAbility
Returns Promise<Ability>
- Defined in base/battle/Battle.ts:1031

initialize_battle_objs

initialize_battle_objs(): void
Returns void
Overrides BattleBase.initialize_battle_objs
- Defined in base/battle/Battle.ts:208

manage_djinn_or_summon_ability

manage_djinn_or_summon_ability(action, ability): Promise<boolean>
Parameters
- action: PlayerAbility
- ability: Ability
Returns Promise<boolean>
- Defined in base/battle/Battle.ts:1094

on_abilities_choose

on_abilities_choose(abilities): void
Parameters
- abilities: PlayerAbilities
Returns void
- Defined in base/battle/Battle.ts:122

play_battle_animation

play_battle_animation(action, ability, ability_had_no_effect?): Promise<void>
Parameters
- action: PlayerAbility
- ability: Ability
- Optional ability_had_no_effect: boolean
Returns Promise<void>
Inherited from BattleBase.play_battle_animation
- Defined in base/battle/BattleBase.ts:189

set_action_animation_settings

set_action_animation_settings(action, ability): Promise<void>
Parameters
- action: PlayerAbility
- ability: Ability
Returns Promise<void>
Overrides BattleBase.set_action_animation_settings
- Defined in base/battle/Battle.ts:460

setup_battle_sound

setup_battle_sound(): Promise<void>
Returns Promise<void>
- Defined in base/battle/Battle.ts:310

start_battle

start_battle(): void
Returns void
Overrides BattleBase.start_battle
- Defined in base/battle/Battle.ts:118

unset_battle

unset_battle(): void
Returns void
Overrides BattleBase.unset_battle
- Defined in base/battle/Battle.ts:1802

update

update(): void
Returns void
Inherited from BattleBase.update
- Defined in base/battle/BattleBase.ts:281

wait_for_key

wait_for_key(): Promise<void>
Returns Promise<void>
Inherited from BattleBase.wait_for_key
- Defined in base/battle/BattleBase.ts:183

Class Battle

Hierarchy (view full)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Parameters

Returns Promise<void>

Parameters

Returns void

Returns Battle

Properties

advance_log_control_key

advance_log_resolve

Type declaration

Returns void

allies_abilities

allies_defeated

allies_info

allies_map_sprite

Type declaration

[player_key: string]: PlayerSprite

animation_manager

background_key

battle_finishing

battle_log

battle_menu

battle_phase

battle_stage

before_fade_finish_callback

Type declaration

Parameters

Returns Promise<void>

bgm

can_escape

data

enemies_abilities

enemies_defeated

enemies_info

enemies_map_sprite

Type declaration

[player_key: string]: PlayerSprite

enemies_party_name

finish_callback

Type declaration

Parameters

Returns void

flee_attemps

Type declaration

allies: number

enemies: number

game

on_going_effects

party_fled

previous_bgm

previous_map_state

Type declaration

previously_inactive_io: Set<number>

previously_inactive_npc: Set<number>

previously_not_visible_layers: Set<number>

reset_previous_bgm

round_end_effects

Type declaration

ability: Ability

action: PlayerAbility

effect: any

target_window

this_enemies_list

Type declaration

[battle_key: string]: Enemy

turns_actions

Static Readonly MAX_CHARS_IN_BATTLE

Methods

apply_battle_recovery

Parameters

Returns Promise<void>

apply_damage

`Static` `Readonly` MAX_CHARS_IN_BATTLE

Returns {
check_downed?: Enemy | MainChar;
msg?: string;
update_chars_info?: boolean;
}[]

Returns {
end_turn_effect: boolean;
had_no_effect: boolean;
log_messages: {
action_changes?: {
action: battle_actions;
player_sprite: PlayerSprite;
}[];
check_downed?: Enemy | MainChar;
msg?: string;
update_chars_info?: boolean;
}[];
}

log_messages: {
action_changes?: {
action: battle_actions;
player_sprite: PlayerSprite;
}[];
check_downed?: Enemy | MainChar;
msg?: string;
update_chars_info?: boolean;
}[]

Returns Promise<{
ability: Ability;
item_name: string;
}>