Class TileEventAbstract

constructor

• new TileEvent(game, data, type, x, y, activation_directions, initial_disabled_directions, activation_collision_layers, active_storage_key, origin_interactable_object, affected_by_reveal, key_name, allow_active_in_diagonal?): TileEvent

• Parameters

  • game: any
  • data: any
  • type: any
  • x: any
  • y: any
  • activation_directions: any
  • initial_disabled_directions: any
  • activation_collision_layers: any
  • active_storage_key: any
  • origin_interactable_object: any
  • affected_by_reveal: any
  • key_name: any
  • allow_active_in_diagonal: boolean = true

  Returns TileEvent

collision_layer_shift_from_source

in_map

activation_collision_layers

• get activation_collision_layers(): Set<number>

• The set of collision layers that this event can be fired.

  Returns Set<number>

activation_directions

• get activation_directions(): Set<directions>

• The set of directions that this event can be fired.

  Returns Set<directions>

affected_by_reveal

• get affected_by_reveal(): Set<directions>

• The set of directions that cause this event to have its activation toggled when reveal is casted.

  Returns Set<directions>

allow_active_in_diagonal

• 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

id

• get id(): number

• This event id number.

  Returns number

initial_activation_directions

• get initial_activation_directions(): Set<directions>

• The set of directions that this event can be fired when it was created.

  Returns Set<directions>

key_name

• get key_name(): string

• This event unique label/key name.

  Returns string

location_key

• get location_key(): number

• Returns number

origin_interactable_object

• get origin_interactable_object(): InteractableObjects

• The interactable object that created this event (in the case of it has been created from it).

  Returns InteractableObjects

type

• get type(): event_types

• Returns the tile event type.

  Returns event_types

x

• get x(): number

• The x tile position.

  Returns number

y

• get y(): number

• The y tile position.

  Returns number

Static events

• get events(): {
      [id: number]: TileEvent;
  }

• Gets all active/available events.

  Returns {
      [id: number]: TileEvent;
  }

  • [id: number]: TileEvent

activate

• activate(include_affected_by_reveal?): void

• 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

activate_at

• activate_at(direction): void

• Activates this event in a given direction.

  Parameters

  • direction: directions | "all"

    the direction to activate this event. If "all" is passed, all directions will be activated.

  Returns void

check_if_disabled_by_storage

• check_if_disabled_by_storage(): boolean

• Checks whether this event is disabled due to a storage value.

  Returns boolean

  whether its disabled by storage value.

check_position

• check_position(): boolean

• Checks whether the hero is over this tile event.

  Returns boolean

  whether the hero position is correct or not.

deactivate

• deactivate(): void

• Deactivates this event in all directions.

  Returns void

deactivate_at

• deactivate_at(direction): void

• Deactivates this event in a given direction.

  Parameters

  • direction: directions | "all"

    the direction to deactivate this event. If "all" is passed, all directions will be deactivated.

  Returns void

Abstract destroy

• destroy(): void

• Destroys this tile event.

  Returns void

Abstract fire

• fire(): void

• Fires this tile event.

  Returns void

get_activation_direction

• get_activation_direction(): directions

• Gets an activation direction of this event.

  Returns directions

  returns an direction.

is_active

• is_active(): boolean

• Checks whether this event is active in any direction.

  Returns boolean

  returns true if active.

is_active_at_collision_layer

• is_active_at_collision_layer(collision_layer): boolean

• Checks if this event is active in a given collision layer.

  Parameters

  • collision_layer: number

    the collision layer index to be checked.

  Returns boolean

is_active_at_direction

• is_active_at_direction(direction?): boolean

• 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.

set_activation_collision_layers

• set_activation_collision_layers(...collision_layers_indexes): void

• Sets new collision layers that this event can active.

  Parameters

  • Rest ...collision_layers_indexes: number[]

    the collision layers indexes.

  Returns void

set_position

• set_position(x_tile?, y_tile?, change_in_map?): void

• 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

update

• update(): void

• This method will be called on map update. If necessary, overrides it.

  Returns void

Static get_event

• get_event(id): TileEvent

• Gets an event by its id number.

  Parameters

  • id: number

    the event id.

  Returns TileEvent

  returns the TileEvent instance.

Static get_labeled_event

• get_labeled_event(key_name): TileEvent

• Gets an event by its unique label/key name.

  Parameters

  • key_name: string

    the event unique label/key name.

  Returns TileEvent

  returns the TileEvent instance.

Static reset

• reset(): void

• Destroys and resets all tile events that are instantiated currently.

  Returns void