Class RetreatFieldPsynergy

Defines and manages the usage of field psynergy. Classes that inherit this one, are expected to at least:

  • call FieldAbilities.set_bootstrap_method on construction;
  • call FieldAbilities.close_field_psynergy_window in an appropriate time.
  • call FieldAbilities.stop_casting and FieldAbilities.return_to_idle_anim possibly on cast finish.
  • implement FieldAbilities.update abstract method, even if empty.

This class already do initial checks, search for target, init casting aura and colorize the map automatically.

Hierarchy (view full)

Constructors

constructor

Properties

cast_direction caster controllable_char data enable_update game is_custom_psynergy reset_map stop_casting target_object ABILITY_KEY_NAME ACTION_KEY_NAME EMITTER_DATA_NAME RISE_TIME

Methods

cast check_if_can_retreat close_field_psynergy_window finish_psynergy init move_char return_to_idle_anim set_bootstrap_method set_cast_finisher_method set_extra_cast_check start_particles_emitter update colorize_map_layers init_cast_aura

Constructors

constructor

Properties

Protected cast_direction

cast_direction: number

The direction that the controllable char is casting thie psynergy.

Protected caster

caster: MainChar

The main char that it casting the psynergy.

Protected controllable_char

controllable_char: ControllableChar

The controllable char that's casting this psynergy.

Protected data

data: GoldenSun

The GoldenSun object.

Private enable_update

enable_update: boolean

Protected game

game: Game

The Phaser.Game object.

is_custom_psynergy

is_custom_psynergy: boolean

Protected reset_map

reset_map: (() => void)

Resets the map to default colors.

Type declaration

    • (): void

    • Returns void

Protected stop_casting

stop_casting: ((reset_casting_psy_flag?, reset_map_tint?) => Promise<void>)

If called, the casting aura is destroyed.

Type declaration

    • (reset_casting_psy_flag?, reset_map_tint?): Promise<void>

    • Parameters

      • Optional reset_casting_psy_flag: boolean
      • Optional reset_map_tint: boolean

      Returns Promise<void>

Protected target_object

target_object: InteractableObjects | NPC

The target object of this psynergy. Might not be necessary depending on the psynergy.

Static Private Readonly ABILITY_KEY_NAME

ABILITY_KEY_NAME: "retreat" = "retreat"

Static Private Readonly ACTION_KEY_NAME

ACTION_KEY_NAME: CAST = base_actions.CAST

Static Private Readonly EMITTER_DATA_NAME

EMITTER_DATA_NAME: "retreat_particles" = "retreat_particles"

Static Private Readonly RISE_TIME

RISE_TIME: 1500 = 1500

Methods

cast

check_if_can_retreat

Protected close_field_psynergy_window

finish_psynergy

  • finish_psynergy(force?, stop_char?, finish_callback?): void

  • Generic funcion that can be overriden. When calling this, the psynergy effect should be finished.

    Parameters

    • force: boolean = false

      for the psynergy to finish.

    • stop_char: boolean = true

      stops the char current animation.

    • Optional finish_callback: (() => void)

      the callback method to be called on psynergy end finish.

        • (): void

        • Returns void

    Returns void

init

move_char

Protected return_to_idle_anim

Protected set_bootstrap_method

Protected set_cast_finisher_method

Protected set_extra_cast_check

  • set_extra_cast_check(method): void

  • Adds an extra check for this psynergy to be casted. The given function is tested on this psynergy cast initialization. If the given function call returns false, this psynergy won't be casted.

    Parameters

    • method: (() => boolean)

      the method to be tested.

        • (): boolean

        • Returns boolean

    Returns void

start_particles_emitter

update

Static colorize_map_layers

  • colorize_map_layers(game, map, options?): (() => void)

  • Colorizes the map for psynergy casting.

    Parameters

    • game: Game

      the Phaser.Game object.

    • map: Map

      the current map.

    • Optional options: {
          after_colorize?: (() => void);
          after_destroy?: (() => void);
          color?: number;
          intensity?: number;
          map_colors_sequence?: boolean;
      }

      some options.

      • Optional after_colorize?: (() => void)

        after the map gets colorized callback.

          • (): void

          • Returns void

      • Optional after_destroy?: (() => void)

        after colorize filter destruction callback.

          • (): void

          • Returns void

      • Optional color?: number

        the color to colorize the map. In the RGB spectre, values between 0 and 1. Default is random.

      • Optional intensity?: number

        the colorize intensity.

      • Optional map_colors_sequence?: boolean

        if true, it will keep changing colorization color over time.

    Returns (() => void)

    returns a function that if called, it will return the map colors to normal.

      • (): void

      • Returns void

Static init_cast_aura

  • init_cast_aura(game, data, char, after_init?, after_destroy?, before_destroy?): ((reset_casting_psy_flag?, reset_map_tint?) => Promise<void>)

  • Initializes a casting aura around the caster.

    Parameters

    • game: Game

      the Phase.Game object.

    • data: GoldenSun

      the GoldenSun object.

    • char: ControllableChar

      the caster controllable char.

    • Optional after_init: (() => void)

      after the aura is initialized callback.

        • (): void

        • Returns void

    • Optional after_destroy: ((reset_casting_psy_flag) => void)

      after the aura is completely destroyed callback.

        • (reset_casting_psy_flag): void

        • Parameters

          • reset_casting_psy_flag: boolean

          Returns void

    • Optional before_destroy: ((reset_map_tint) => void)

      on aura destruction init callback.

        • (reset_map_tint): void

        • Parameters

          • reset_map_tint: boolean

          Returns void

    Returns ((reset_casting_psy_flag?, reset_map_tint?) => Promise<void>)

    returns a function that when called, will stop the casting aura.

      • (reset_casting_psy_flag?, reset_map_tint?): Promise<void>

      • Parameters

        • Optional reset_casting_psy_flag: boolean
        • Optional reset_map_tint: boolean

        Returns Promise<void>

Settings

Member Visibility

Theme

On This Page

constructorcast_directioncastercontrollable_chardataenable_updategameis_custom_psynergyreset_mapstop_castingtarget_objectABILITY_KEY_NAMEACTION_KEY_NAMEEMITTER_DATA_NAMERISE_TIMEcastcheck_if_can_retreatclose_field_psynergy_windowfinish_psynergyinitmove_charreturn_to_idle_animset_bootstrap_methodset_cast_finisher_methodset_extra_cast_checkstart_particles_emitterupdatecolorize_map_layersinit_cast_aura