Class RopeEvent

An event that deals with walking or climbing (depending on the rope angle) over a rope.

Hierarchy (view full)

TileEvent
- RopeEvent

Index

Constructors

Accessors

activation_collision_layers activation_directions affected_by_reveal allow_active_in_diagonal id initial_activation_directions key_name location_key origin_interactable_object type x y events

Constructors

constructor

new RopeEvent(game, data, x, y, activation_directions, initial_disabled_directions, activation_collision_layers, active_storage_key, affected_by_reveal, key_name, origin_interactable_object, walk_over_rope, dock_exit_collision_layer, rope_collision_layer): RopeEvent
Parameters
- game: Game
- data: GoldenSun
- x: number
- y: number
- activation_directions: any
- initial_disabled_directions: any
- activation_collision_layers: any
- active_storage_key: any
- affected_by_reveal: any
- key_name: string
- origin_interactable_object: InteractableObjects
- walk_over_rope: boolean
- dock_exit_collision_layer: number
- rope_collision_layer: number
Returns RopeEvent
Overrides TileEvent.constructor
- Defined in base/tile_events/RopeEvent.ts:24

Properties

`Protected` _activation_collision_layers

_activation_collision_layers: Set<number>

`Protected` _activation_directions

_activation_directions: Set<directions>

`Protected` _affected_by_reveal

_affected_by_reveal: Set<directions>

`Protected` _allow_active_in_diagonal

_allow_active_in_diagonal: boolean

`Private` _dock_exit_collision_layer

_dock_exit_collision_layer: number

Collision layer that the char will be on dock exit.

`Protected` _id

_id: number

`Protected` _initial_activation_directions

_initial_activation_directions: Set<directions>

`Protected` _initial_disabled_directions

_initial_disabled_directions: Set<directions>

`Protected` _key_name

_key_name: string

`Protected` _location_key

_location_key: number

`Protected` _origin_interactable_object

_origin_interactable_object: RopeDock

The interactable object that originated this event. Overriding with appropriate inheritance.

`Private` _rope_collision_layer

_rope_collision_layer: number

Collision layer that the char will be when walking over the rope.

`Private` _starting_rope_dock

_starting_rope_dock: RopeDock

The staring rope dock.

`Protected` _type

_type: event_types

`Private` _walk_over_rope

_walk_over_rope: boolean

Whether the char will be walking over the rope.

`Protected` _x

_x: number

`Protected` _y

_y: number

collision_layer_shift_from_source

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.

`Protected` data

data: GoldenSun

`Protected` game

game: Game

in_map

in_map: boolean

Whether this event is in the map.

`Static` `Protected` _events

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

Type declaration

[id: number]: TileEvent

`Static` `Protected` id_incrementer

id_incrementer: number

`Static` `Protected` labeled_events

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

Type declaration

[key_name: number]: TileEvent

Accessors

activation_collision_layers

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

Returns Set<number>
Inherited from TileEvent.activation_collision_layers
- Defined in base/tile_events/TileEvent.ts:160

activation_directions

get activation_directions(): Set<directions>
The set of directions that this event can be fired.

Returns Set<directions>
Inherited from TileEvent.activation_directions
- Defined in base/tile_events/TileEvent.ts:156

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>
Inherited from TileEvent.affected_by_reveal
- Defined in base/tile_events/TileEvent.ts:172

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
Inherited from TileEvent.allow_active_in_diagonal
- Defined in base/tile_events/TileEvent.ts:183

id

get id(): number
This event id number.

Returns number
Inherited from TileEvent.id
- Defined in base/tile_events/TileEvent.ts:152

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>
Inherited from TileEvent.initial_activation_directions
- Defined in base/tile_events/TileEvent.ts:164

key_name

get key_name(): string
This event unique label/key name.

Returns string
Inherited from TileEvent.key_name
- Defined in base/tile_events/TileEvent.ts:176

location_key

get location_key(): number
Returns number
Inherited from TileEvent.location_key
- Defined in base/tile_events/TileEvent.ts:148

origin_interactable_object

get origin_interactable_object(): RopeDock
The interactable object that created this event (in the case of it has been created from it).

Returns RopeDock
Overrides TileEvent.origin_interactable_object
- Defined in base/tile_events/RopeEvent.ts:60

type

get type(): event_types
Returns the tile event type.

Returns event_types
Inherited from TileEvent.type
- Defined in base/tile_events/TileEvent.ts:137

x

get x(): number
The x tile position.

Returns number
Inherited from TileEvent.x
- Defined in base/tile_events/TileEvent.ts:141

y

get y(): number
The y tile position.

Returns number
Inherited from TileEvent.y
- Defined in base/tile_events/TileEvent.ts:145

`Static` events

get events(): {
[id: number]: TileEvent;
}
Gets all active/available events.

Returns {
[id: number]: TileEvent;
}
- [id: number]: TileEvent
Inherited from TileEvent.events
- Defined in base/tile_events/TileEvent.ts:351

Methods

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
Inherited from TileEvent.activate
- Defined in base/tile_events/TileEvent.ts:254

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
Inherited from TileEvent.activate_at
- Defined in base/tile_events/TileEvent.ts:230

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.
Inherited from TileEvent.check_if_disabled_by_storage
- Defined in base/tile_events/TileEvent.ts:280

check_position

check_position(): boolean
Checks whether the hero is over this tile event.

Returns boolean
whether the hero position is correct or not.
Inherited from TileEvent.check_position
- Defined in base/tile_events/TileEvent.ts:272

deactivate

deactivate(): void
Deactivates this event in all directions.

Returns void
Inherited from TileEvent.deactivate
- Defined in base/tile_events/TileEvent.ts:264

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
Inherited from TileEvent.deactivate_at
- Defined in base/tile_events/TileEvent.ts:242

destroy

destroy(): void
Destroys this tile event.

Returns void
Overrides TileEvent.destroy
- Defined in base/tile_events/RopeEvent.ts:148

finish_walking

finish_walking(): Promise<void>
Returns Promise<void>
- Defined in base/tile_events/RopeEvent.ts:123

fire

fire(): Promise<void>
Fires this tile event.

Returns Promise<void>
Overrides TileEvent.fire
- Defined in base/tile_events/RopeEvent.ts:64

get_activation_direction

get_activation_direction(): directions
Gets an activation direction of this event.

Returns directions
returns an direction.
Inherited from TileEvent.get_activation_direction
- Defined in base/tile_events/TileEvent.ts:291

is_active

is_active(): boolean
Checks whether this event is active in any direction.

Returns boolean
returns true if active.
Inherited from TileEvent.is_active
- Defined in base/tile_events/TileEvent.ts:222

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
Inherited from TileEvent.is_active_at_collision_layer
- Defined in base/tile_events/TileEvent.ts:327

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.
Inherited from TileEvent.is_active_at_direction
- Defined in base/tile_events/TileEvent.ts:203

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
Inherited from TileEvent.set_activation_collision_layers
- Defined in base/tile_events/TileEvent.ts:318

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
Inherited from TileEvent.set_position
- Defined in base/tile_events/TileEvent.ts:301

start_walking

start_walking(): Promise<void>
Returns Promise<void>
- Defined in base/tile_events/RopeEvent.ts:96

update

update(): void
This method will be called on map update. If necessary, overrides it.

Returns void
Inherited from TileEvent.update
- Defined in base/tile_events/TileEvent.ts:334

`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.
Inherited from TileEvent.get_event
- Defined in base/tile_events/TileEvent.ts:360

`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.
Inherited from TileEvent.get_labeled_event
- Defined in base/tile_events/TileEvent.ts:369

`Static` reset

reset(): void
Destroys and resets all tile events that are instantiated currently.

Returns void
Inherited from TileEvent.reset
- Defined in base/tile_events/TileEvent.ts:376

Class RopeEvent

Hierarchy (view full)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns RopeEvent

Properties

Protected _activation_collision_layers

Protected _activation_directions

Protected _affected_by_reveal

Protected _allow_active_in_diagonal

Private _dock_exit_collision_layer

Protected _id

Protected _initial_activation_directions

Protected _initial_disabled_directions

Protected _key_name

Protected _location_key

Protected _origin_interactable_object

Private _rope_collision_layer

Private _starting_rope_dock

Protected _type

Private _walk_over_rope

Protected _x

Protected _y

collision_layer_shift_from_source

Protected data

Protected game

in_map

Static Protected _events

Type declaration

[id: number]: TileEvent

Static Protected id_incrementer

Static Protected labeled_events

Type declaration

[key_name: number]: TileEvent

Accessors

activation_collision_layers

Returns Set<number>

activation_directions

Returns Set<directions>

affected_by_reveal

Returns Set<directions>

allow_active_in_diagonal

Returns boolean

id

Returns number

initial_activation_directions

Returns Set<directions>

key_name

Returns string

location_key

Returns number

origin_interactable_object

Returns RopeDock

type

Returns event_types

x

Returns number

y

Returns number

Static events

Returns { [id: number]: TileEvent; }

[id: number]: TileEvent

Methods

activate

Parameters

Returns void

activate_at

Parameters

Returns void

check_if_disabled_by_storage

Returns boolean

check_position

Returns boolean

deactivate

`Protected` _activation_collision_layers

`Protected` _activation_directions

`Protected` _affected_by_reveal

`Protected` _allow_active_in_diagonal

`Private` _dock_exit_collision_layer

`Protected` _id

`Protected` _initial_activation_directions

`Protected` _initial_disabled_directions

`Protected` _key_name

`Protected` _location_key

`Protected` _origin_interactable_object

`Private` _rope_collision_layer

`Private` _starting_rope_dock

`Protected` _type

`Private` _walk_over_rope

`Protected` _x

`Protected` _y

`Protected` data

`Protected` game

`Static` `Protected` _events

`Static` `Protected` id_incrementer

`Static` `Protected` labeled_events

`Static` events

Returns {
[id: number]: TileEvent;
}

`Static` get_event

`Static` get_labeled_event

`Static` reset