Class PlayerSprite

constructor

• new PlayerSprite(game, data, parent_group, player_info, sprite_base, is_ally, initial_action, initial_position, hue_angle): PlayerSprite

• Parameters

  • game: Game
  • data: GoldenSun
  • parent_group: Group
  • player_info: PlayerInfo
  • sprite_base: SpriteBase
  • is_ally: boolean
  • initial_action: battle_actions
  • initial_position: battle_positions
  • hue_angle: number

  Returns PlayerSprite

center_shift

ellipses_semi_major

ellipses_semi_minor

force_stage_update

is_ally

player_instance

stage_angle

action

• get action(): battle_actions

• Returns battle_actions

active

• get active(): boolean

• Returns boolean

alpha

• get alpha(): number

• Returns number

• set alpha(alpha): void

• Parameters

  • alpha: number

  Returns void

anchor

• get anchor(): Point

• Returns Point

• set anchor(anchor): void

• Parameters

  • anchor: Point

  Returns void

animations

• get animations(): AnimationManager

• Returns AnimationManager

available_filters

• get available_filters(): {
      [key_name: string]: AbstractFilter;
  }

• Returns {
      [key_name: string]: AbstractFilter;
  }

  • [key_name: string]: AbstractFilter

• set available_filters(available_filters): void

• Parameters

  • available_filters: {
        [key_name: string]: AbstractFilter;
    }

    • [key_name: string]: AbstractFilter

  Returns void

avoidFilterCapping

• get avoidFilterCapping(): boolean

• Returns boolean

• set avoidFilterCapping(avoidFilterCapping): void

• Parameters

  • avoidFilterCapping: boolean

  Returns void

battle_key

• get battle_key(): string

• Returns string

blendMode

• get blendMode(): blendModes

• Returns blendModes

• set blendMode(blendMode): void

• Parameters

  • blendMode: blendModes

  Returns void

char_sprite

• get char_sprite(): Sprite

• Returns Sprite

data

• get data(): any

• Returns any

filters

• get filters(): AbstractFilter[]

• Returns AbstractFilter[]

• set filters(filters): void

• Parameters

  • filters: AbstractFilter[]

  Returns void

frameName

• get frameName(): string

• Returns string

• set frameName(frameName): void

• Parameters

  • frameName: string

  Returns void

group

• get group(): Group

• Returns Group

height

• get height(): number

• Returns number

• set height(height): void

• Parameters

  • height: number

  Returns void

key

• get key(): string

• Returns string

player_info

• get player_info(): PlayerInfo

• Returns PlayerInfo

position

• get position(): battle_positions

• Returns battle_positions

rotation

• get rotation(): number

• Returns number

• set rotation(rotation): void

• Parameters

  • rotation: number

  Returns void

scale

• get scale(): Point

• Returns Point

• set scale(scale): void

• Parameters

  • scale: Point

  Returns void

shadow_sprite

• get shadow_sprite(): Sprite

• Returns Sprite

texture

• get texture(): Texture

• Returns Texture

tint

• get tint(): number

• Returns number

• set tint(tint): void

• Parameters

  • tint: number

  Returns void

visible

• get visible(): boolean

• Returns boolean

• set visible(visible): void

• Parameters

  • visible: boolean

  Returns void

width

• get width(): number

• Returns number

• set width(width): void

• Parameters

  • width: number

  Returns void

x

• get x(): number

• Returns number

• set x(x): void

• Parameters

  • x: number

  Returns void

y

• get y(): number

• Returns number

• set y(y): void

• Parameters

  • y: number

  Returns void

activate

• activate(): void

• Returns void

deactive

• deactive(): void

• Returns void

destroy

• destroy(): void

• Returns void

get_animation_key

• get_animation_key(action, position): string

• Parameters

  • action: battle_actions
  • position: battle_positions

  Returns string

initialize_player

• initialize_player(): void

• Returns void

play_position

• play_position(frame_rate?, loop?): void

• Parameters

  • Optional frame_rate: number
  • Optional loop: boolean

  Returns void

remove_from_stage

• remove_from_stage(): {
      index: number;
      x: number;
      y: number;
  }

• Returns {
      index: number;
      x: number;
      y: number;
  }

  • index: number

  • x: number

  • y: number

reset_hue_angle

• reset_hue_angle(): void

• Returns void

return_to_stage

• return_to_stage(player_stage_info): void

• Parameters

  • player_stage_info: {
        index: number;
        x: number;
        y: number;
    }

    • index: number

    • x: number

    • y: number

  Returns void

set_action

• set_action(action, play?): void

• Parameters

  • action: battle_actions
  • play: boolean = true

  Returns void

set_next_status_sprite

• set_next_status_sprite(): void

• Returns void

set_position

• set_position(position, play?): void

• Parameters

  • position: battle_positions
  • play: boolean = true

  Returns void

unmount_by_dissolving

• unmount_by_dissolving(): Promise<void>

• Returns Promise<void>