This class is responsible for the class of events that are placed on the map. Generally, this kind of event is fired when the hero reaches the position where an event of this type is placed. Use these events to make the hero jump, slide, climb, teleport, etc. Tile Events are set as map properties (and sometimes, Interactable Objects can also create some Tile Events automatically).

Hierarchy (view full)

Constructors

  • Parameters

    • game: any
    • data: any
    • x: any
    • y: any
    • activation_directions: any
    • initial_disabled_directions: any
    • activation_collision_layers: any
    • active_storage_key: any
    • affected_by_reveal: any
    • key_name: string
    • y_destination_position: any
    • dest_collision_layer: any
    • show_exclamation_emoticon: any
    • splash_sweat_drops: any
    • walking_in_the_air: any
    • ground_hit_animation: any
    • teleport: any

    Returns FallEvent

Properties

_activation_collision_layers: Set<number>
_activation_directions: Set<directions>
_affected_by_reveal: Set<directions>
_allow_active_in_diagonal: boolean
_id: number
_initial_activation_directions: Set<directions>
_initial_disabled_directions: Set<directions>
_key_name: string
_location_key: number
_origin_interactable_object: InteractableObjects
_x: number
_y: number
collision_layer_shift_from_source: number

The collision layer shift value from origin Inter. Obj. base collision layer that will be summed up to it which will form the activation collision layer of this event.

data: GoldenSun
game: Game
in_map: boolean

Whether this event is in the map.

options: {
    dest_collision_layer?: number;
    ground_hit_animation?: boolean;
    on_fall_finish_callback?: (() => void);
    show_exclamation_emoticon?: boolean;
    splash_sweat_drops?: boolean;
    teleport?: {
        dest_collision_layer: number;
        destination: string;
        destination_position: {
            x: number;
            y: number;
        };
        diminish_on_transition?: boolean;
        on_before_teleport?: (() => void);
        origin_position?: {
            x: number;
            y: number;
        };
        send_to_front_on_teleport?: boolean;
    };
    walking_in_the_air?: boolean;
    y_destination_position: number;
}

Type declaration

  • Optional dest_collision_layer?: number

    The destination collision layer index.

  • Optional ground_hit_animation?: boolean

    Whether the char will perform a ground hit animation.

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

    Callback to be called after hitting the ground.

      • (): void
      • Returns void

  • Optional show_exclamation_emoticon?: boolean

    Whether an exclamation emoticon will appear over the char before falling.

  • Optional splash_sweat_drops?: boolean

    The char will splash sweat drops before falling.

  • Optional teleport?: {
        dest_collision_layer: number;
        destination: string;
        destination_position: {
            x: number;
            y: number;
        };
        diminish_on_transition?: boolean;
        on_before_teleport?: (() => void);
        origin_position?: {
            x: number;
            y: number;
        };
        send_to_front_on_teleport?: boolean;
    }

    Teleport info. If passed, the char will teleport to another map while falling.

    • dest_collision_layer: number

      The destination collision layer index in the dest map.

    • destination: string

      The teleport map key name destination.

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

      The destination position.

      • x: number

        The x tile position.

      • y: number

        The y tile position.

    • Optional diminish_on_transition?: boolean

      If true, the char will diminish instead of fall before teleport.

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

      Callback to be called before teleport begin.

        • (): void
        • Returns void

    • Optional origin_position?: {
          x: number;
          y: number;
      }

      The origin position that the char will be just after the teleport.

      • x: number

        The x tile position.

      • y: number

        The y tile position.

    • Optional send_to_front_on_teleport?: boolean

      If true, the char sprite will be brought to the top on z-index while falling.

  • Optional walking_in_the_air?: boolean

    Whether the char will performa a walking in the air animation before falling.

  • y_destination_position: number

    The final y-tile position that the char will reach after falling.

_events: {
    [id: number]: TileEvent;
}

Type declaration

id_incrementer: number
labeled_events: {
    [key_name: number]: TileEvent;
}

Type declaration

Accessors

  • get activation_collision_layers(): Set<number>
  • The set of collision layers that this event can be fired.

    Returns Set<number>

  • get allow_active_in_diagonal(): boolean
  • When activating this event in diagonal, and if this var is not true, the diagonal direction whether the hero is trying to activate this event won't be splitted.

    Returns boolean

Methods

  • Activates this event in all initial directions.

    Parameters

    • include_affected_by_reveal: boolean = false

      if true, it will also make this event sensible to reveal.

    Returns void

  • Tests whether a given direction is available to active this event. If no directions given, tests if at least one direction is active.

    Parameters

    • Optional direction: directions

      the direction to test if it's active.

    Returns boolean

    Returns whether it's active or not.

  • Updates the position of this event.

    Parameters

    • Optional x_tile: number

      the new x tile position.

    • Optional y_tile: number

      the new y tile position

    • change_in_map: boolean = false

      folow the position change up to map events list.

    Returns void