Class BattleAnimation

Index

Constructors

Properties

ability_sprites_groups allies_sprites alpha_gray_filter_sequence alpha_sequence back_group background_sprites battle_stage blend_mode_sequence blink_sequence cast_type caster_sprite center_shift_sequence color_blend_filter_sequence colorize_sequence data destroy_sprites element flame_filter_sequence follow_caster follow_caster_prev_pos front_group game glow_filter_sequence grayscale_sequence group_caster group_enemy hue_angle_sequence init_pos key_name levels_filter_sequence lighting_sequence mirrored misc_sequence non_targets_sprites particles_sequence per_target_sprites play_sequence promises render_callbacks rotation_sequence running set_frame_sequence sfx_sequence shake_sequence sprites sprites_keys sprites_prev_properties stage_angle_sequence stage_prev_value super_group target_dodged targets_sprites texture_displacement_sequence tint_sequence trails_bmps trails_objs wait_for_cast_animation x_anchor_sequence x_ellipse_axis_factor_sequence x_scale_sequence x_sequence y_anchor_sequence y_ellipse_axis_factor_sequence y_scale_sequence y_sequence

Constructors

constructor

new BattleAnimation(game, data, key_name, sprites_keys, x_sequence, y_sequence, x_ellipse_axis_factor_sequence, y_ellipse_axis_factor_sequence, center_shift_sequence, x_scale_sequence, y_scale_sequence, x_anchor_sequence, y_anchor_sequence, alpha_sequence, rotation_sequence, stage_angle_sequence, hue_angle_sequence, tint_sequence, grayscale_sequence, colorize_sequence, glow_filter_sequence, play_sequence, set_frame_sequence, blend_mode_sequence, levels_filter_sequence, color_blend_filter_sequence, flame_filter_sequence, alpha_gray_filter_sequence, particles_sequence, sfx_sequence, blink_sequence, shake_sequence, texture_displacement_sequence, misc_sequence, lighting_sequence, cast_type, wait_for_cast_animation, follow_caster, mirrored, element): BattleAnimation
Parameters
- game: any
- data: any
- key_name: any
- sprites_keys: any
- x_sequence: any
- y_sequence: any
- x_ellipse_axis_factor_sequence: any
- y_ellipse_axis_factor_sequence: any
- center_shift_sequence: any
- x_scale_sequence: any
- y_scale_sequence: any
- x_anchor_sequence: any
- y_anchor_sequence: any
- alpha_sequence: any
- rotation_sequence: any
- stage_angle_sequence: any
- hue_angle_sequence: any
- tint_sequence: any
- grayscale_sequence: any
- colorize_sequence: any
- glow_filter_sequence: any
- play_sequence: any
- set_frame_sequence: any
- blend_mode_sequence: any
- levels_filter_sequence: any
- color_blend_filter_sequence: any
- flame_filter_sequence: any
- alpha_gray_filter_sequence: any
- particles_sequence: any
- sfx_sequence: any
- blink_sequence: any
- shake_sequence: any
- texture_displacement_sequence: any
- misc_sequence: any
- lighting_sequence: any
- cast_type: any
- wait_for_cast_animation: any
- follow_caster: any
- mirrored: any
- element: any
Returns BattleAnimation
- Defined in base/battle/BattleAnimation.ts:394

Properties

ability_sprites_groups

ability_sprites_groups: {
    behind: Group;
    between: Group;
    over: Group;
}

Type declaration

behind: Group
between: Group
over: Group

allies_sprites

allies_sprites: PlayerSprite[]

alpha_gray_filter_sequence

alpha_gray_filter_sequence: GeneralFilterAttr[] = []

alpha_sequence

alpha_sequence: DefaultAttr[] = []

back_group

back_group: Group

background_sprites

background_sprites: TileSprite[]

battle_stage

battle_stage: BattleStage

blend_mode_sequence

blend_mode_sequence: {
    ignore_if_dodge?: boolean;
    mode: string;
    sprite_index: string | number | number[];
    start_delay: number | number[];
}[] = []

Type declaration

Optional ignore_if_dodge?: boolean
mode: string
sprite_index: string | number | number[]
start_delay: number | number[]

blink_sequence

blink_sequence: BlinkAttr[] = []

cast_type

cast_type: string

caster_sprite

caster_sprite: PlayerSprite

center_shift_sequence

center_shift_sequence: DefaultAttr[] = []

color_blend_filter_sequence

color_blend_filter_sequence: (GeneralFilterAttr & {
    b: number;
    duration: number;
    fake_blend: boolean;
    g: number;
    r: number;
    tween: string;
})[] = []

colorize_sequence

colorize_sequence: (GeneralFilterAttr & {
    color: number;
    intensity: number;
    tween: string;
})[] = []

data

data: GoldenSun

`Private` destroy_sprites

destroy_sprites: boolean

element

element: elements

flame_filter_sequence

flame_filter_sequence: GeneralFilterAttr[] = []

follow_caster

follow_caster: boolean

follow_caster_prev_pos

follow_caster_prev_pos: {
x: number;
y: number;
}

Type declaration

x: number
y: number

front_group

front_group: Group

game

game: Game

glow_filter_sequence

glow_filter_sequence: (GeneralFilterAttr & {
    b: number;
    distance: number;
    g: number;
    quality: number;
    r: number;
    strength: number;
})[] = []

grayscale_sequence

grayscale_sequence: DefaultAttr[] = []

group_caster

group_caster: Group

group_enemy

group_enemy: Group

hue_angle_sequence

hue_angle_sequence: DefaultAttr[] = []

init_pos

init_pos: {
x: number;
y: number;
}

Type declaration

x: number
y: number

key_name

key_name: string

levels_filter_sequence

levels_filter_sequence: (GeneralFilterAttr & {
    gamma: number;
    max_input: number;
    min_input: number;
})[] = []

lighting_sequence

lighting_sequence: {
    count: number;
    duration: number;
    from: {
        delta: {
            x: number;
            y: number;
        };
        pos: {
            x: number | target_types;
            y: number | target_types;
        };
        range_delta: {
            x: number;
            y: number;
        };
    };
    glow: {
        b: number;
        distance: number;
        g: number;
        quality: number;
        r: number;
        strength: number;
    };
    ignore_if_dodge?: boolean;
    interval_time: number | number[];
    render_position: battle_positions;
    roughness: number;
    start_delay: number | number[] | CompactValuesSpecifier;
    thickness: {
        base_value: number;
        range_delta: number;
    };
    to: {
        delta: {
            x: number;
            y: number;
        };
        pos: {
            x: number | target_types;
            y: number | target_types;
        };
        range_delta: {
            x: number;
            y: number;
        };
    };
    trail: boolean;
    trail_colorize: {
        color: number;
        intensity: number;
    };
    trail_count: number;
    trail_factor: number;
}[] = []

Type declaration

count: number
duration: number
from: {
    delta: {
        x: number;
        y: number;
    };
    pos: {
        x: number | target_types;
        y: number | target_types;
    };
    range_delta: {
        x: number;
        y: number;
    };
}
- delta: {
  x: number;
  y: number;
  }
  - x: number
  - y: number
- pos: {
  x: number | target_types;
  y: number | target_types;
  }
  - x: number | target_types
  - y: number | target_types
- range_delta: {
  x: number;
  y: number;
  }
  - x: number
  - y: number
glow: {
    b: number;
    distance: number;
    g: number;
    quality: number;
    r: number;
    strength: number;
}
- b: number
- distance: number
- g: number
- quality: number
- r: number
- strength: number
Optional ignore_if_dodge?: boolean
interval_time: number | number[]
render_position: battle_positions
roughness: number
start_delay: number | number[] | CompactValuesSpecifier
thickness: {
base_value: number;
range_delta: number;
}
- base_value: number
- range_delta: number
to: {
    delta: {
        x: number;
        y: number;
    };
    pos: {
        x: number | target_types;
        y: number | target_types;
    };
    range_delta: {
        x: number;
        y: number;
    };
}
- delta: {
  x: number;
  y: number;
  }
  - x: number
  - y: number
- pos: {
  x: number | target_types;
  y: number | target_types;
  }
  - x: number | target_types
  - y: number | target_types
- range_delta: {
  x: number;
  y: number;
  }
  - x: number
  - y: number
trail: boolean
trail_colorize: {
color: number;
intensity: number;
}
- color: number
- intensity: number
trail_count: number
trail_factor: number

mirrored

mirrored: boolean

misc_sequence

misc_sequence: MiscAttr[] = []

non_targets_sprites

non_targets_sprites: PlayerSprite[]

particles_sequence

particles_sequence: ParticlesInfo

per_target_sprites

per_target_sprites: {
[key: string]: (Phaser.Sprite | Phaser.Graphics)[];
}

Type declaration

[key: string]: (Phaser.Sprite | Phaser.Graphics)[]

play_sequence

play_sequence: {
    animation_key: string;
    frame_rate: number;
    hide_on_complete: boolean;
    ignore_if_dodge?: boolean;
    repeat: boolean;
    reverse: boolean;
    sprite_index: number | number[] | target_types;
    start_delay: number | number[];
    wait: boolean;
    wait_for_index: number;
}[] = []

Type declaration

animation_key: string
frame_rate: number
hide_on_complete: boolean
Optional ignore_if_dodge?: boolean
repeat: boolean
reverse: boolean
sprite_index: number | number[] | target_types
start_delay: number | number[]
wait: boolean
wait_for_index: number

promises

promises: Promise<any>[]

render_callbacks

render_callbacks: {
[callback_key: string]: Function;
}

Type declaration

[callback_key: string]: Function

rotation_sequence

rotation_sequence: DefaultAttr[] = []

running

running: boolean

set_frame_sequence

set_frame_sequence: {
    frame_name: string;
    ignore_if_dodge?: boolean;
    sprite_index: number | number[] | target_types;
    start_delay: number | number[];
}[] = []

Type declaration

frame_name: string
Optional ignore_if_dodge?: boolean
sprite_index: number | number[] | target_types
start_delay: number | number[]

sfx_sequence

sfx_sequence: {
    ignore_if_dodge?: boolean;
    position_shift: number;
    sfx_key: string;
    start_delay: number;
    volume: number;
}[] = []

Type declaration

Optional ignore_if_dodge?: boolean
position_shift: number
sfx_key: string
start_delay: number
volume: number

shake_sequence

shake_sequence: ShakeAttr[] = []

sprites

sprites: (Sprite | Graphics | Image | PlayerSprite | TileSprite)[]

sprites_keys

sprites_keys: target_types | SpriteKey[]

sprites_prev_properties

sprites_prev_properties: {
    [key: string]: {
        [property: string]: any;
    };
}

Type declaration

[key: string]: {
[property: string]: any;
}
- [property: string]: any

stage_angle_sequence

stage_angle_sequence: DefaultAttr[] = []

stage_prev_value

stage_prev_value: number

super_group

super_group: Group

target_dodged

target_dodged: boolean

targets_sprites

targets_sprites: PlayerSprite[]

texture_displacement_sequence

texture_displacement_sequence: (GeneralFilterAttr & {
    duration: number;
    repeat_texture: boolean;
    shift: {
        x?: number;
        y?: number;
    };
    tween: string;
    yoyo: boolean;
})[] = []

tint_sequence

tint_sequence: (GeneralFilterAttr & {
    b: number;
    g: number;
    r: number;
})[] = []

trails_bmps

trails_bmps: BitmapData[]

trails_objs

trails_objs: Image[]

wait_for_cast_animation

wait_for_cast_animation: boolean

x_anchor_sequence

x_anchor_sequence: DefaultAttr[] = []

x_ellipse_axis_factor_sequence

x_ellipse_axis_factor_sequence: DefaultAttr[] = []

x_scale_sequence

x_scale_sequence: DefaultAttr[] = []

x_sequence

x_sequence: DefaultAttr[] = []

y_anchor_sequence

y_anchor_sequence: DefaultAttr[] = []

y_ellipse_axis_factor_sequence

y_ellipse_axis_factor_sequence: DefaultAttr[] = []

y_scale_sequence

y_scale_sequence: DefaultAttr[] = []

y_sequence

y_sequence: DefaultAttr[] = []

Methods

get_expanded_values

get_expanded_values(recipe, number): number[]
Parameters
- recipe: CompactValuesSpecifier
- number: number | target_types
Returns number[]
- Defined in base/battle/BattleAnimation.ts:789

get_sprite_xy_pos

get_sprite_xy_pos(x, y, shift_x, shift_y): {
x: number;
y: number;
}
Parameters
- x: string | number
- y: string | number
- shift_x: number
- shift_y: number
Returns {
x: number;
y: number;
}
- x: number
- y: number
- Defined in base/battle/BattleAnimation.ts:2021

get_sprites

get_sprites(seq, obj_propety?): {
    [key: string]: {
        index: number;
        obj: PIXI.DisplayObject | PlayerSprite | keyof PlayerSprite | Phaser.Filter;
        sprite?: PIXI.DisplayObject | PlayerSprite;
    };
}
Parameters
- seq: any
- Optional obj_propety: string
Returns {
    [key: string]: {
        index: number;
        obj: PIXI.DisplayObject | PlayerSprite | keyof PlayerSprite | Phaser.Filter;
        sprite?: PIXI.DisplayObject | PlayerSprite;
    };
}
- [key: string]: {
      index: number;
      obj: PIXI.DisplayObject | PlayerSprite | keyof PlayerSprite | Phaser.Filter;
      sprite?: PIXI.DisplayObject | PlayerSprite;
  }
  - index: number
  - obj: PIXI.DisplayObject | PlayerSprite | keyof PlayerSprite | Phaser.Filter
  - Optional sprite?: PIXI.DisplayObject | PlayerSprite
- Defined in base/battle/BattleAnimation.ts:902

initialize

initialize(caster_sprite, targets_sprites, allies_sprites, enemies_sprites, group_caster, group_enemy, super_group, battle_stage, background_sprites, sprite_key?, target_dodged?): void
Parameters
- caster_sprite: PlayerSprite
- targets_sprites: PlayerSprite[]
- allies_sprites: PlayerSprite[]
- enemies_sprites: PlayerSprite[]
- group_caster: Group
- group_enemy: Group
- super_group: Group
- battle_stage: BattleStage
- background_sprites: TileSprite[]
- Optional sprite_key: string
- Optional target_dodged: boolean
Returns void
- Defined in base/battle/BattleAnimation.ts:491

manage_filter

manage_filter(filter, sprite, remove): void
Parameters
- filter: Filter
- sprite: DisplayObject | PlayerSprite
- remove: boolean
Returns void
- Defined in base/battle/BattleAnimation.ts:733

play

play(finish_callback): void
Parameters
- finish_callback: (() => void)
  - - (): void
    - Returns void
Returns void
- Defined in base/battle/BattleAnimation.ts:816

play_alpha_gray_filter

play_alpha_gray_filter(): void
Returns void
- Defined in base/battle/BattleAnimation.ts:1695

play_blend_modes

play_blend_modes(): void
Returns void
- Defined in base/battle/BattleAnimation.ts:1329

play_blink_sequence

play_blink_sequence(): void
Returns void
- Defined in base/battle/BattleAnimation.ts:1870

play_color_blend_filter

play_color_blend_filter(): void
Returns void
- Defined in base/battle/BattleAnimation.ts:1659

play_colorize_filter

play_colorize_filter(): void
Returns void
- Defined in base/battle/BattleAnimation.ts:1711

play_flame_filter

play_flame_filter(): void
Returns void
- Defined in base/battle/BattleAnimation.ts:1691

play_general_filter

play_general_filter(sequence, filter_key, set_filter): void
Parameters
- sequence: GeneralFilterAttr[]
- filter_key: engine_filters
- set_filter: ((sequence, filter, sprite?, sprite_index?) => void)
  - - (sequence, filter, sprite?, sprite_index?): void
    - Parameters
      sequence: GeneralFilterAttr
      filter: Filter
      Optional sprite: Sprite | PlayerSprite
      Optional sprite_index: number
      Returns void
Returns void
- Defined in base/battle/BattleAnimation.ts:1578

play_glow_filter

play_glow_filter(): void
Returns void
- Defined in base/battle/BattleAnimation.ts:1739

play_levels_filter

play_levels_filter(): void
Returns void
- Defined in base/battle/BattleAnimation.ts:1628

play_lightning_sequence

play_lightning_sequence(): void
Returns void
- Defined in base/battle/BattleAnimation.ts:1367

play_misc_sequence

play_misc_sequence(): void
Returns void
- Defined in base/battle/BattleAnimation.ts:1539

play_number_property_sequence

play_number_property_sequence(sequence, target_property, options?): void
Parameters
- sequence: DefaultAttr[]
- target_property: string
- Optional options: {
      filter_key?: string;
      rotate_in_4h_quadrant?: boolean;
      rotational_property?: boolean;
  }
  - Optional filter_key?: string
  - Optional rotate_in_4h_quadrant?: boolean
  - Optional rotational_property?: boolean
Returns void
- Defined in base/battle/BattleAnimation.ts:1008

play_particles

play_particles(): void
Returns void
- Defined in base/battle/BattleAnimation.ts:2072

play_set_frame_sequence

play_set_frame_sequence(): void
Returns void
- Defined in base/battle/BattleAnimation.ts:1296

play_sfx

play_sfx(): void
Returns void
- Defined in base/battle/BattleAnimation.ts:1516

play_shake_sequence

play_shake_sequence(): void
Returns void
- Defined in base/battle/BattleAnimation.ts:1804

play_sprite_sequence

play_sprite_sequence(): void
Returns void
- Defined in base/battle/BattleAnimation.ts:1213

play_stage_angle_sequence

play_stage_angle_sequence(): void
Returns void
- Defined in base/battle/BattleAnimation.ts:1942

play_texture_displacement_sequence

play_texture_displacement_sequence(): void
Returns void
- Defined in base/battle/BattleAnimation.ts:1754

play_tint_filter

play_tint_filter(): void
Returns void
- Defined in base/battle/BattleAnimation.ts:1699

render

render(): void
Returns void
- Defined in base/battle/BattleAnimation.ts:2083

set_filters

set_filters(): void
Returns void
- Defined in base/battle/BattleAnimation.ts:751

unmount_animation

unmount_animation(finish_callback): void
Parameters
- finish_callback: any
Returns void
- Defined in base/battle/BattleAnimation.ts:861

`Static` get_angle_by_direction

get_angle_by_direction(incoming_current_angle, incoming_target_angle, direction, fourth_quadrant?): any
Parameters
- incoming_current_angle: any
- incoming_target_angle: any
- direction: any
- fourth_quadrant: boolean = false
Returns any
- Defined in base/battle/BattleAnimation.ts:2130

Class BattleAnimation

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns BattleAnimation

Properties

ability_sprites_groups

Type declaration

behind: Group

between: Group

over: Group

allies_sprites

alpha_gray_filter_sequence

alpha_sequence

back_group

background_sprites

battle_stage

blend_mode_sequence

Type declaration

Optional ignore_if_dodge?: boolean

mode: string

sprite_index: string | number | number[]

start_delay: number | number[]

blink_sequence

cast_type

caster_sprite

center_shift_sequence

color_blend_filter_sequence

colorize_sequence

data

Private destroy_sprites

element

flame_filter_sequence

follow_caster

follow_caster_prev_pos

Type declaration

x: number

y: number

front_group

game

glow_filter_sequence

grayscale_sequence

group_caster

group_enemy

hue_angle_sequence

init_pos

Type declaration

x: number

y: number

key_name

levels_filter_sequence

lighting_sequence

Type declaration

count: number

duration: number

from: { delta: { x: number; y: number; }; pos: { x: number | target_types; y: number | target_types; }; range_delta: { x: number; y: number; }; }

delta: { x: number; y: number; }

x: number

y: number

pos: { x: number | target_types; y: number | target_types; }

x: number | target_types

y: number | target_types

range_delta: { x: number; y: number; }

x: number

y: number

glow: { b: number; distance: number; g: number; quality: number; r: number; strength: number; }

b: number

distance: number

g: number

quality: number

r: number

strength: number

Optional ignore_if_dodge?: boolean

interval_time: number | number[]

render_position: battle_positions

roughness: number

`Optional` ignore_if_dodge?: boolean

`Private` destroy_sprites

from: {
delta: {
x: number;
y: number;
};
pos: {
x: number | target_types;
y: number | target_types;
};
range_delta: {
x: number;
y: number;
};
}

delta: {
x: number;
y: number;
}

pos: {
x: number | target_types;
y: number | target_types;
}

range_delta: {
x: number;
y: number;
}

glow: {
b: number;
distance: number;
g: number;
quality: number;
r: number;
strength: number;
}

`Optional` ignore_if_dodge?: boolean

thickness: {
base_value: number;
range_delta: number;
}

to: {
delta: {
x: number;
y: number;
};
pos: {
x: number | target_types;
y: number | target_types;
};
range_delta: {
x: number;
y: number;
};
}

delta: {
x: number;
y: number;
}

pos: {
x: number | target_types;
y: number | target_types;
}

range_delta: {
x: number;
y: number;
}

trail_colorize: {
color: number;
intensity: number;
}

`Optional` ignore_if_dodge?: boolean

`Optional` ignore_if_dodge?: boolean

`Optional` ignore_if_dodge?: boolean

[key: string]: {
[property: string]: any;
}