Class DouseFieldPsynergy

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)

FieldAbilities
- DouseFieldPsynergy

Constructors

constructor

new DouseFieldPsynergy(game, data): DouseFieldPsynergy
Parameters
- game: any
- data: any
Returns DouseFieldPsynergy
Overrides FieldAbilities.constructor
- Defined in base/field_abilities/DouseFieldPsynergy.ts:17

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.

`Private` cloud_sprite

cloud_sprite: Sprite

`Protected` controllable_char

controllable_char: ControllableChar

The controllable char that's casting this psynergy.

`Protected` data

data: GoldenSun

The GoldenSun object.

`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

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

`Static` `Private` `Readonly` ABILITY_KEY_NAME

ABILITY_KEY_NAME: "douse" = "douse"

`Static` `Private` `Readonly` ACTION_KEY_NAME

ACTION_KEY_NAME: CAST = base_actions.CAST

`Static` `Private` `Readonly` CLOUD_ANIM_KEY_NAME

CLOUD_ANIM_KEY_NAME: "cloud" = "cloud"

`Static` `Private` `Readonly` CLOUD_KEY_NAME

CLOUD_KEY_NAME: "douse" = "douse"

`Static` `Private` `Readonly` DOUSE_HEIGHT

DOUSE_HEIGHT: 45 = 45

`Static` `Private` `Readonly` DOUSE_MAX_RANGE

DOUSE_MAX_RANGE: 12 = 12

Methods

cast

cast(controllable_char, caster_key_name): void
Casts this psynergy.
Parameters
- controllable_char: ControllableChar
  the controllable char that's casting this psynergy.
- caster_key_name: string
  the main char key name that's casting this psyerngy.
Returns void
Inherited from FieldAbilities.cast
- Defined in base/field_abilities/FieldAbilities.ts:448

`Protected` close_field_psynergy_window

close_field_psynergy_window(): void
Closes the field psynergy window that shows its name.

Returns void
Inherited from FieldAbilities.close_field_psynergy_window
- Defined in base/field_abilities/FieldAbilities.ts:310

drops

drops(): Promise<void>
Returns Promise<void>
- Defined in base/field_abilities/DouseFieldPsynergy.ts:104

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
Inherited from FieldAbilities.finish_psynergy
- Defined in base/field_abilities/FieldAbilities.ts:201

init

init(): Promise<void>
Returns Promise<void>
- Defined in base/field_abilities/DouseFieldPsynergy.ts:30

init_cloud

init_cloud(): void
Returns void
- Defined in base/field_abilities/DouseFieldPsynergy.ts:43

move_cloud_in

move_cloud_in(): Promise<void>
Returns Promise<void>
- Defined in base/field_abilities/DouseFieldPsynergy.ts:159

move_cloud_out

move_cloud_out(): Promise<void>
Returns Promise<void>
- Defined in base/field_abilities/DouseFieldPsynergy.ts:59

`Protected` return_to_idle_anim

return_to_idle_anim(): Promise<void>
Returns the hero from cast animation to idle animation.

Returns Promise<void>
returns a promise for animation end.
Inherited from FieldAbilities.return_to_idle_anim
- Defined in base/field_abilities/FieldAbilities.ts:156

`Protected` set_bootstrap_method

set_bootstrap_method(method): void
Sets the bootstrap method that will be called once psynergy cast is initialized. Each psynergy will have its own bootstrap function.
Parameters
- method: Function
  the bootstrap method.
Returns void
Inherited from FieldAbilities.set_bootstrap_method
- Defined in base/field_abilities/FieldAbilities.ts:173

`Protected` set_cast_finisher_method

set_cast_finisher_method(method): void
Pass a method to be called on psynergy cast end when the casting aura starts to be destructed.
Parameters
- method: Function
  the method to be called.
Returns void
Inherited from FieldAbilities.set_cast_finisher_method
- Defined in base/field_abilities/FieldAbilities.ts:191

`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
Inherited from FieldAbilities.set_extra_cast_check
- Defined in base/field_abilities/FieldAbilities.ts:183

update

update(): void
Abstract method. This function is called on game main update funcion.

Returns void
Overrides FieldAbilities.update
- Defined in base/field_abilities/DouseFieldPsynergy.ts:192

`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
Inherited from FieldAbilities.colorize_map_layers
- Defined in base/field_abilities/FieldAbilities.ts:655

`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>
Inherited from FieldAbilities.init_cast_aura
- Defined in base/field_abilities/FieldAbilities.ts:498

Class DouseFieldPsynergy

Hierarchy (view full)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns DouseFieldPsynergy

Properties

Protected cast_direction

Protected caster

Private cloud_sprite

Protected controllable_char

Protected data

Protected game

is_custom_psynergy

Protected reset_map

Type declaration

Returns void

Protected stop_casting

Type declaration

Parameters

Returns Promise<void>

Protected target_object

Static Private Readonly ABILITY_KEY_NAME

Static Private Readonly ACTION_KEY_NAME

Static Private Readonly CLOUD_ANIM_KEY_NAME

Static Private Readonly CLOUD_KEY_NAME

Static Private Readonly DOUSE_HEIGHT

Static Private Readonly DOUSE_MAX_RANGE

Methods

cast

Parameters

Returns void

Protected close_field_psynergy_window

Returns void

drops

Returns Promise<void>

finish_psynergy

Parameters

Returns void

Returns void

init

Returns Promise<void>

init_cloud

Returns void

move_cloud_in

Returns Promise<void>

move_cloud_out

Returns Promise<void>

Protected return_to_idle_anim

Returns Promise<void>

Protected set_bootstrap_method

Parameters

Returns void

Protected set_cast_finisher_method

Parameters

Returns void

Protected set_extra_cast_check

Parameters

Returns boolean

Returns void

update

Returns void

Static colorize_map_layers

Parameters

Optional after_colorize?: (() => void)

Returns void

Optional after_destroy?: (() => void)

Returns void

Optional color?: number

Optional intensity?: number

Optional map_colors_sequence?: boolean

Returns (() => void)

Returns void

Static init_cast_aura

Parameters

Returns void

`Protected` cast_direction

`Protected` caster

`Private` cloud_sprite

`Protected` controllable_char

`Protected` data

`Protected` game

`Protected` reset_map

`Protected` stop_casting

`Protected` target_object

`Static` `Private` `Readonly` ABILITY_KEY_NAME

`Static` `Private` `Readonly` ACTION_KEY_NAME

`Static` `Private` `Readonly` CLOUD_ANIM_KEY_NAME

`Static` `Private` `Readonly` CLOUD_KEY_NAME

`Static` `Private` `Readonly` DOUSE_HEIGHT

`Static` `Private` `Readonly` DOUSE_MAX_RANGE

`Protected` close_field_psynergy_window

`Protected` return_to_idle_anim

`Protected` set_bootstrap_method

`Protected` set_cast_finisher_method

`Protected` set_extra_cast_check

`Static` colorize_map_layers

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

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

`Optional` color?: number

`Optional` intensity?: number

`Optional` map_colors_sequence?: boolean

`Static` init_cast_aura