Class Breakable

allow_jumping_over_it

allow_jumping_through_it

sprite

active

• get active(): boolean

• When active is false, the io is removed from the map.

  Returns boolean

active_filters

• get active_filters(): {
      alpha_gray: boolean;
      color_blend: boolean;
      colorize: boolean;
      flame: boolean;
      glow: boolean;
      gray: boolean;
      hue: boolean;
      levels: boolean;
      mode7: boolean;
      outline: boolean;
      pixel_shift: boolean;
      tint: boolean;
      watery: boolean;
  }

• An object containing which filters are active in this IO.

  Returns {
      alpha_gray: boolean;
      color_blend: boolean;
      colorize: boolean;
      flame: boolean;
      glow: boolean;
      gray: boolean;
      hue: boolean;
      levels: boolean;
      mode7: boolean;
      outline: boolean;
      pixel_shift: boolean;
      tint: boolean;
      watery: boolean;
  }

  • alpha_gray: boolean

  • color_blend: boolean

  • colorize: boolean

  • flame: boolean

  • glow: boolean

  • gray: boolean

  • hue: boolean

  • levels: boolean

  • mode7: boolean

  • outline: boolean

  • pixel_shift: boolean

  • tint: boolean

  • watery: boolean

affected_by_reveal

• get affected_by_reveal(): boolean

• Whether this IO is affected by Reveal psynergy or not.

  Returns boolean

after_psynergy_cast_events

• get after_psynergy_cast_events(): {
      [psynergy_key: string]: GameEvent[];
  }

• Object that contains lists of Game Events to fired per psynergy after it finishes. Psynergy is the key, the list of events is the value of this object.

  Returns {
      [psynergy_key: string]: GameEvent[];
  }

  • [psynergy_key: string]: GameEvent[]

base_collision_layer

• get base_collision_layer(): number

• Returns number

before_psynergy_cast_events

• get before_psynergy_cast_events(): {
      [psynergy_key: string]: GameEvent[];
  }

• Object that contains lists of Game Events to fired per psynergy before it starts. Psynergy is the key, the list of events is the value of this object.

  Returns {
      [psynergy_key: string]: GameEvent[];
  }

  • [psynergy_key: string]: GameEvent[]

blocking_stair_block

• get blocking_stair_block(): Body

• Returns Body

body

• get body(): any

• This IO body if available.

  Returns any

breakable

• get breakable(): boolean

• Returns boolean

bush_sprite

• get bush_sprite(): Sprite

• Returns Sprite

collision_tiles_bodies

• get collision_tiles_bodies(): Body[]

• Returns Body[]

color_blend_filter

• get color_blend_filter(): ColorBlend

• Returns ColorBlend

colorize_filter

• get colorize_filter(): Colorize

• Returns Colorize

current_action

• get current_action(): string

• Returns string

current_animation

• get current_animation(): string

• Returns string

enable

• get enable(): boolean

• When enable is false, the io is on the map, but a char can't interact with it.

  Returns boolean

entangled_by_bush

• get entangled_by_bush(): boolean

• Returns boolean

flame_filter

• get flame_filter(): Flame

• Returns Flame

gray_filter

• get gray_filter(): Gray

• Returns Gray

has_shadow

• get has_shadow(): boolean

• Returns boolean

height

• get height(): number

• Returns number

hue_filter

• get hue_filter(): Hue

• Returns Hue

is_interactable_object

• get is_interactable_object(): boolean

• Returns boolean

is_rope_dock

• get is_rope_dock(): boolean

• Returns boolean

key_name

• get key_name(): string

• Returns string

label

• get label(): string

• The unique label that identifies this Interactable Object.

  Returns string

levels_filter

• get levels_filter(): Levels

• Returns Levels

map_index

• get map_index(): number

• Returns number

object_drop_tiles

• get object_drop_tiles(): {
      animation_duration: number;
      dest_x: number;
      dest_y: number;
      destination_collision_layer: number;
      dust_animation: boolean;
      water_animation: boolean;
      x: number;
      y: number;
  }[]

• Returns {
      animation_duration: number;
      dest_x: number;
      dest_y: number;
      destination_collision_layer: number;
      dust_animation: boolean;
      water_animation: boolean;
      x: number;
      y: number;
  }[]

psynergies_info

• get psynergies_info(): {
      [psynergy_key: string]: {
          after_psynergy_cast_events: any[];
          before_psynergy_cast_events: any[];
          destination_collision_layer: LiftFieldPsynergy["destination_collision_layer"];
          destination_y_pos: LiftFieldPsynergy["destination_y_pos"];
          interaction_type: interactable_object_interaction_types;
          [psynergy_specific_properties: string]: any;
      };
  }

• Returns {
      [psynergy_key: string]: {
          after_psynergy_cast_events: any[];
          before_psynergy_cast_events: any[];
          destination_collision_layer: LiftFieldPsynergy["destination_collision_layer"];
          destination_y_pos: LiftFieldPsynergy["destination_y_pos"];
          interaction_type: interactable_object_interaction_types;
          [psynergy_specific_properties: string]: any;
      };
  }

  • [psynergy_key: string]: {
        after_psynergy_cast_events: any[];
        before_psynergy_cast_events: any[];
        destination_collision_layer: LiftFieldPsynergy["destination_collision_layer"];
        destination_y_pos: LiftFieldPsynergy["destination_y_pos"];
        interaction_type: interactable_object_interaction_types;
        [psynergy_specific_properties: string]: any;
    }

    • [psynergy_specific_properties: string]: any

    • after_psynergy_cast_events: any[]

    • before_psynergy_cast_events: any[]

    • destination_collision_layer: LiftFieldPsynergy["destination_collision_layer"]

    • destination_y_pos: LiftFieldPsynergy["destination_y_pos"]

    • interaction_type: interactable_object_interaction_types

psynergy_casted

• get psynergy_casted(): {
      [field_psynergy_key: string]: boolean;
  }

• Returns {
      [field_psynergy_key: string]: boolean;
  }

  • [field_psynergy_key: string]: boolean

pushable

• get pushable(): boolean

• Returns boolean

rollable

• get rollable(): boolean

• Returns boolean

shadow

• get shadow(): Sprite

• Returns Sprite

shapes_collision_active

• get shapes_collision_active(): boolean

• Whether the shapes of this IO body are active (colliding) or not.

  Returns boolean

snapshot_info

• get snapshot_info(): {
      action: string;
      active: boolean;
      active_filters: {
          alpha_gray: boolean;
          color_blend: boolean;
          colorize: boolean;
          flame: boolean;
          glow: boolean;
          gray: boolean;
          hue: boolean;
          levels: boolean;
          mode7: boolean;
          outline: boolean;
          pixel_shift: boolean;
          tint: boolean;
          watery: boolean;
      };
      allow_jumping_over_it: boolean;
      allow_jumping_through_it: boolean;
      anchor: {
          x: number;
          y: number;
      };
      anim_is_playing: boolean;
      animation: string;
      base_collision_layer: number;
      body_in_map: boolean;
      enable: boolean;
      entangled_by_bush: boolean;
      filter_settings?: FilterSettings;
      frame: string;
      index: number;
      key_name: string;
      position: {
          x: number;
          x_px: number;
          y: number;
          y_px: number;
      };
      psynergy_casted: {
          [field_psynergy_key: string]: boolean;
      };
      scale: {
          x: number;
          y: number;
      };
      send_to_back: boolean;
      send_to_front: boolean;
      shadow: {
          x: number;
          y: number;
      };
      shapes_collision_active: boolean;
      state_by_type: {
          breakable?: {
              one_level_broken: boolean;
              two_level_broken: boolean;
          };
          pushable?: {
              docked: boolean;
          };
          rollable?: {
              pillar_is_stuck: boolean;
          };
          rope_dock?: {
              tied: boolean;
          };
      };
      type: {
          breakable: boolean;
          is_rope_dock: boolean;
          rollable: boolean;
      };
      visible: boolean;
  }

• Returns {
      action: string;
      active: boolean;
      active_filters: {
          alpha_gray: boolean;
          color_blend: boolean;
          colorize: boolean;
          flame: boolean;
          glow: boolean;
          gray: boolean;
          hue: boolean;
          levels: boolean;
          mode7: boolean;
          outline: boolean;
          pixel_shift: boolean;
          tint: boolean;
          watery: boolean;
      };
      allow_jumping_over_it: boolean;
      allow_jumping_through_it: boolean;
      anchor: {
          x: number;
          y: number;
      };
      anim_is_playing: boolean;
      animation: string;
      base_collision_layer: number;
      body_in_map: boolean;
      enable: boolean;
      entangled_by_bush: boolean;
      filter_settings?: FilterSettings;
      frame: string;
      index: number;
      key_name: string;
      position: {
          x: number;
          x_px: number;
          y: number;
          y_px: number;
      };
      psynergy_casted: {
          [field_psynergy_key: string]: boolean;
      };
      scale: {
          x: number;
          y: number;
      };
      send_to_back: boolean;
      send_to_front: boolean;
      shadow: {
          x: number;
          y: number;
      };
      shapes_collision_active: boolean;
      state_by_type: {
          breakable?: {
              one_level_broken: boolean;
              two_level_broken: boolean;
          };
          pushable?: {
              docked: boolean;
          };
          rollable?: {
              pillar_is_stuck: boolean;
          };
          rope_dock?: {
              tied: boolean;
          };
      };
      type: {
          breakable: boolean;
          is_rope_dock: boolean;
          rollable: boolean;
      };
      visible: boolean;
  }

  • action: string

  • active: boolean

  • active_filters: {
        alpha_gray: boolean;
        color_blend: boolean;
        colorize: boolean;
        flame: boolean;
        glow: boolean;
        gray: boolean;
        hue: boolean;
        levels: boolean;
        mode7: boolean;
        outline: boolean;
        pixel_shift: boolean;
        tint: boolean;
        watery: boolean;
    }

    • alpha_gray: boolean

    • color_blend: boolean

    • colorize: boolean

    • flame: boolean

    • glow: boolean

    • gray: boolean

    • hue: boolean

    • levels: boolean

    • mode7: boolean

    • outline: boolean

    • pixel_shift: boolean

    • tint: boolean

    • watery: boolean

  • allow_jumping_over_it: boolean

  • allow_jumping_through_it: boolean

  • anchor: {
        x: number;
        y: number;
    }

    • x: number

    • y: number

  • anim_is_playing: boolean

  • animation: string

  • base_collision_layer: number

  • body_in_map: boolean

  • enable: boolean

  • entangled_by_bush: boolean

  • Optional filter_settings?: FilterSettings

  • frame: string

  • index: number

  • key_name: string

  • position: {
        x: number;
        x_px: number;
        y: number;
        y_px: number;
    }

    • x: number

    • x_px: number

    • y: number

    • y_px: number

  • psynergy_casted: {
        [field_psynergy_key: string]: boolean;
    }

    • [field_psynergy_key: string]: boolean

  • scale: {
        x: number;
        y: number;
    }

    • x: number

    • y: number

  • send_to_back: boolean

  • send_to_front: boolean

  • shadow: {
        x: number;
        y: number;
    }

    • x: number

    • y: number

  • shapes_collision_active: boolean

  • state_by_type: {
        breakable?: {
            one_level_broken: boolean;
            two_level_broken: boolean;
        };
        pushable?: {
            docked: boolean;
        };
        rollable?: {
            pillar_is_stuck: boolean;
        };
        rope_dock?: {
            tied: boolean;
        };
    }

    • Optional breakable?: {
          one_level_broken: boolean;
          two_level_broken: boolean;
      }

      • one_level_broken: boolean

      • two_level_broken: boolean

    • Optional pushable?: {
          docked: boolean;
      }

      • docked: boolean

    • Optional rollable?: {
          pillar_is_stuck: boolean;
      }

      • pillar_is_stuck: boolean

    • Optional rope_dock?: {
          tied: boolean;
      }

      • tied: boolean

  • type: {
        breakable: boolean;
        is_rope_dock: boolean;
        rollable: boolean;
    }

    • breakable: boolean

    • is_rope_dock: boolean

    • rollable: boolean

  • visible: boolean

sprite_info

• get sprite_info(): SpriteBase

• Returns SpriteBase

tile_pos

• get tile_pos(): {
      x: number;
      y: number;
  }

• Gets the tile pos object for this interactable object.

  Returns {
      x: number;
      y: number;
  }

  • x: number

  • y: number

tile_x_pos

• get tile_x_pos(): number

• Gets the current x tile position of this interactable object.

  Returns number

tile_y_pos

• get tile_y_pos(): number

• Gets the current y tile position of this interactable object.

  Returns number

tint_filter

• get tint_filter(): Tint

• Returns Tint

whirlwind_source

• get whirlwind_source(): boolean

• Returns boolean

width

• get width(): number

• Returns number

x

• get x(): number

• Gets the x position in px.

  Returns number
• set x(x): void

• Sets the current x position in px.

  Parameters

  • x: number

  Returns void

y

• get y(): number

• Gets the y position in px.

  Returns number
• set y(y): void

• Sets the current y position in px.

  Parameters

  • y: number

  Returns void

add_unset_callback

• add_unset_callback(callback): void

• Parameters

  • callback: (() => void)
    • • (): void

      • Returns void

  Returns void

change_collision_layer

• change_collision_layer(destination_collision_layer, update_on_map?): void

• Parameters

  • destination_collision_layer: number
  • update_on_map: boolean = true

  Returns void

check_psynergy_casted_on_restore

• check_psynergy_casted_on_restore(): void

• Checks whether it's necessary to restore any custom state related to psynergy cast on this IO when restoring a snapshot.

  Returns void

check_storage_keys

• check_storage_keys(): void

• Updates this IO properties according to current storage values.

  Returns void

clear_snapshot

• clear_snapshot(): void

• Removes this IO snapshot reference.

  Returns void

config_body

• config_body(): void

• Returns void

create_engine_storage_key

• create_engine_storage_key(property_name): string

• Parameters

  • property_name: string

  Returns string

custom_unset

• custom_unset(): void

• Method to be overriden.

  Returns void

destroy_body

• destroy_body(update_map?): void

• Destroys the collision body of this IO.

  Parameters

  • update_map: boolean = true

    if true, will tell the map that this body was removed.

  Returns void

destroy_bush

• destroy_bush(): void

• Returns void

destroy_collision_tiles_bodies

• destroy_collision_tiles_bodies(): void

• Returns void

get_body_radius

• get_body_radius(): number

• Gets this IO body radius or similar number.

  Returns number

get_current_position

• get_current_position(): {
      x: number;
      y: number;
  }

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

  • x: number

  • y: number

get_events

• get_events(): TileEvent[]

• Returns TileEvent[]

init_bush

• init_bush(map): void

• Parameters

  • map: Map

  Returns void

initial_config

• initial_config(map, snapshot_info): void

• Parameters

  • map: Map
  • snapshot_info: {
        action: string;
        active: boolean;
        active_filters: {
            alpha_gray: boolean;
            color_blend: boolean;
            colorize: boolean;
            flame: boolean;
            glow: boolean;
            gray: boolean;
            hue: boolean;
            levels: boolean;
            mode7: boolean;
            outline: boolean;
            pixel_shift: boolean;
            tint: boolean;
            watery: boolean;
        };
        allow_jumping_over_it: boolean;
        allow_jumping_through_it: boolean;
        anchor: {
            x: number;
            y: number;
        };
        anim_is_playing: boolean;
        animation: string;
        base_collision_layer: number;
        body_in_map: boolean;
        enable: boolean;
        entangled_by_bush: boolean;
        filter_settings?: FilterSettings;
        frame: string;
        index: number;
        key_name: string;
        position: {
            x: number;
            x_px: number;
            y: number;
            y_px: number;
        };
        psynergy_casted: {
            [field_psynergy_key: string]: boolean;
        };
        scale: {
            x: number;
            y: number;
        };
        send_to_back: boolean;
        send_to_front: boolean;
        shadow: {
            x: number;
            y: number;
        };
        shapes_collision_active: boolean;
        state_by_type: {
            breakable?: {
                one_level_broken: boolean;
                two_level_broken: boolean;
            };
            pushable?: {
                docked: boolean;
            };
            rollable?: {
                pillar_is_stuck: boolean;
            };
            rope_dock?: {
                tied: boolean;
            };
        };
        type: {
            breakable: boolean;
            is_rope_dock: boolean;
            rollable: boolean;
        };
        visible: boolean;
    }

    • action: string

    • active: boolean

    • active_filters: {
          alpha_gray: boolean;
          color_blend: boolean;
          colorize: boolean;
          flame: boolean;
          glow: boolean;
          gray: boolean;
          hue: boolean;
          levels: boolean;
          mode7: boolean;
          outline: boolean;
          pixel_shift: boolean;
          tint: boolean;
          watery: boolean;
      }

      • alpha_gray: boolean

      • color_blend: boolean

      • colorize: boolean

      • flame: boolean

      • glow: boolean

      • gray: boolean

      • hue: boolean

      • levels: boolean

      • mode7: boolean

      • outline: boolean

      • pixel_shift: boolean

      • tint: boolean

      • watery: boolean

    • allow_jumping_over_it: boolean

    • allow_jumping_through_it: boolean

    • anchor: {
          x: number;
          y: number;
      }

      • x: number

      • y: number

    • anim_is_playing: boolean

    • animation: string

    • base_collision_layer: number

    • body_in_map: boolean

    • enable: boolean

    • entangled_by_bush: boolean

    • Optional filter_settings?: FilterSettings

    • frame: string

    • index: number

    • key_name: string

    • position: {
          x: number;
          x_px: number;
          y: number;
          y_px: number;
      }

      • x: number

      • x_px: number

      • y: number

      • y_px: number

    • psynergy_casted: {
          [field_psynergy_key: string]: boolean;
      }

      • [field_psynergy_key: string]: boolean

    • scale: {
          x: number;
          y: number;
      }

      • x: number

      • y: number

    • send_to_back: boolean

    • send_to_front: boolean

    • shadow: {
          x: number;
          y: number;
      }

      • x: number

      • y: number

    • shapes_collision_active: boolean

    • state_by_type: {
          breakable?: {
              one_level_broken: boolean;
              two_level_broken: boolean;
          };
          pushable?: {
              docked: boolean;
          };
          rollable?: {
              pillar_is_stuck: boolean;
          };
          rope_dock?: {
              tied: boolean;
          };
      }

      • Optional breakable?: {
            one_level_broken: boolean;
            two_level_broken: boolean;
        }

        • one_level_broken: boolean

        • two_level_broken: boolean

      • Optional pushable?: {
            docked: boolean;
        }

        • docked: boolean

      • Optional rollable?: {
            pillar_is_stuck: boolean;
        }

        • pillar_is_stuck: boolean

      • Optional rope_dock?: {
            tied: boolean;
        }

        • tied: boolean

    • type: {
          breakable: boolean;
          is_rope_dock: boolean;
          rollable: boolean;
      }

      • breakable: boolean

      • is_rope_dock: boolean

      • rollable: boolean

    • visible: boolean

  Returns void

initialize_related_events

• initialize_related_events(map): void

• Parameters

  • map: Map

  Returns void

insert_event

• insert_event(id): void

• Parameters

  • id: number

  Returns void

manage_filter

• manage_filter(filter, set): void

• Sets or unsets a Phaser.Filter in this char.

  Parameters

  • filter: Filter

    the filter you want to set.
  • set: boolean

    whether it's to set or unset the filter.

  Returns void

parse_allowed_tiles

• parse_allowed_tiles(allowed_tiles): void

• Parameters

  • allowed_tiles: {
        collision_layer: number;
        type: "tile" | "rect";
        x?: number;
        x0?: number;
        x1?: number;
        y?: number;
        y0?: number;
        y1?: number;
    }[]

  Returns void

play

• play(animation?, action?, start?, frame_rate?, loop?): Animation

• Parameters

  • Optional animation: string
  • Optional action: string
  • start: boolean = true
  • Optional frame_rate: number
  • Optional loop: boolean

  Returns Animation

position_allowed

• position_allowed(x, y): boolean

• Parameters

  • x: number
  • y: number

  Returns boolean

remove_event

• remove_event(id): void

• Parameters

  • id: number

  Returns void

set_enable

• set_enable(enable, came_from_value_change?): void

• Parameters

  • enable: boolean
  • came_from_value_change: boolean = false

  Returns void

set_entangled_by_bush

• set_entangled_by_bush(entangled_by_bush): void

• Parameters

  • entangled_by_bush: boolean

  Returns void

set_shadow

• set_shadow(group, options?): void

• Initialize the shadow sprite of this IO.

  Parameters

  • group: Group

    the group where the shadow sprite is going to be inserted.
  • Optional options: {
        is_world_map?: boolean;
        key_name?: string;
        shadow_anchor_x?: number;
        shadow_anchor_y?: number;
    }

    options to be set like anchor values and whether it's a world map.

    • Optional is_world_map?: boolean

    • Optional key_name?: string

    • Optional shadow_anchor_x?: number

    • Optional shadow_anchor_y?: number

  Returns void

set_tile_position

• set_tile_position(pos, update_on_map?): void

• Parameters

  • pos: {
        x?: number;
        y?: number;
    }

    • Optional x?: number

    • Optional y?: number

  • update_on_map: boolean = true

  Returns void

set_visible

• set_visible(visible, came_from_value_change?): void

• Sets this IO visibility.

  Parameters

  • visible: boolean

    whether to be visible or not.
  • came_from_value_change: boolean = false

    if this call came from storage value change, won't update it again.

  Returns void

shift_events

• shift_events(event_shift_x, event_shift_y, manipulate_collision?): void

• Shifts the related events of this interactable object.

  Parameters

  • event_shift_x: number

    the x shift amount.
  • event_shift_y: number

    the y shift amount.
  • Optional manipulate_collision: {
        prev_collision_layer: number;
    }

    • prev_collision_layer: number

  Returns void

toggle_active

• toggle_active(active, came_from_value_change?): void

• Activates or deactivates this IO.

  Parameters

  • active: boolean

    true, if you want to activate it.
  • came_from_value_change: boolean = false

    if this call came from storage value change, won't update it again.

  Returns void

toggle_collision

• toggle_collision(enable): void

• Sets whether the collision body of this IO is enable or not.

  Parameters

  • enable: boolean

    if true, activates the collision.

  Returns void

unset

• unset(remove_from_middlelayer_group?): void

• Parameters

  • remove_from_middlelayer_group: boolean = true

  Returns void

update

• update(): void

• Method to be overriden.

  Returns void

update_shadow

• update_shadow(): void

• The update function for the shadow sprite.

  Returns void