Options
All
  • Public
  • Public/Protected
  • All
Menu

Class RopeDock

The rope dock interactable object. The rope fragments and rope events are created from this object.

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

  • new RopeDock(game: any, data: any, key_name: any, map_index: any, x: any, y: any, storage_keys: any, allowed_tiles: any, base_collision_layer: any, not_allowed_tiles: any, object_drop_tiles: any, anchor_x: any, anchor_y: any, scale_x: any, scale_y: any, block_climb_collision_layer_shift: any, events_info: any, enable: any, entangled_by_bush: any, toggle_enable_events: any, label: any, allow_jumping_over_it: any, allow_jumping_through_it: any, psynergies_info: any, has_shadow: any, animation: any, action: any, snapshot_info: any, affected_by_reveal: any, active: any, visible: any): RopeDock

  • Parameters

    • game: any
    • data: any
    • key_name: any
    • map_index: any
    • x: any
    • y: any
    • storage_keys: any
    • allowed_tiles: any
    • base_collision_layer: any
    • not_allowed_tiles: any
    • object_drop_tiles: any
    • anchor_x: any
    • anchor_y: any
    • scale_x: any
    • scale_y: any
    • block_climb_collision_layer_shift: any
    • events_info: any
    • enable: any
    • entangled_by_bush: any
    • toggle_enable_events: any
    • label: any
    • allow_jumping_over_it: any
    • allow_jumping_through_it: any
    • psynergies_info: any
    • has_shadow: any
    • animation: any
    • action: any
    • snapshot_info: any
    • affected_by_reveal: any
    • active: any
    • visible: any

    Returns RopeDock

Properties

Protected _breakable

_breakable: boolean

Private _dest_rope_dock

_dest_rope_dock: RopeDock

The staring rope dock. null if it's the starting rope dock.

Private _dest_x

_dest_x: number

The destiny dock x tile position.

Private _dest_y

_dest_y: number

The destiny dock y tile position.

Protected _extra_sprites

_extra_sprites: (Sprite | Group | Graphics)[]

Private _frag_able_to_swing

_frag_able_to_swing: boolean[]

Array of booleans that says whether a frag can swing or not.

Private _frag_overlap_group

_frag_overlap_group: Group

Not practical group. Holds a copy of the first OVERLAP_LIMIT frags to show over the dock.

Private _fragment_angle

_fragment_angle: number

The angle in which the rope fragments are.

Private _hero_walking_factor

_hero_walking_factor: number

Factor that will increase rope bounce on hero walk.

Protected _is_rope_dock

_is_rope_dock: boolean

Private _is_starting_dock

_is_starting_dock: boolean

Whether this event is the rope starting dock.

Protected _pushable

_pushable: boolean

Protected _rollable

_rollable: boolean

Private _rope_frag_base_pos

_rope_frag_base_pos: { x: number; y: number }[]

Rope fragments base positions.

Private _rope_fragments_group

_rope_fragments_group: Group

Groups that holds the rope fragments.

Private _rope_width

_rope_width: number

The rope width. Only x axis.

Private _tied

_tied: boolean

Whether the rope is tied or not. This variable is only used if it's a starting dock.

Protected _whirlwind_source

_whirlwind_source: boolean

allow_jumping_over_it

allow_jumping_over_it: boolean

allow_jumping_through_it

allow_jumping_through_it: boolean

Protected anchor_x

anchor_x: number

Protected anchor_y

anchor_y: number

Protected data

data: GoldenSun

Protected game

game: Game

Protected scale_x

scale_x: number

Protected scale_y

scale_y: number

sprite

sprite: Sprite

Protected storage_keys

storage_keys: { action?: string; active?: string; affected_by_reveal?: string; anchor?: string; animation?: string; base_collision_layer?: string; enable?: string; entangled_by_bush?: string; position?: string; position_px?: string; scale?: string; visible?: string }

Type declaration

  • Optional action?: string
  • Optional active?: string
  • Optional affected_by_reveal?: string
  • Optional anchor?: string
  • Optional animation?: string
  • Optional base_collision_layer?: string
  • Optional enable?: string
  • Optional entangled_by_bush?: string
  • Optional position?: string
  • Optional position_px?: string
  • Optional scale?: string
  • Optional visible?: string

swing_tween

swing_tween: Tween

The tween that controls the rope bounce.

Static Private Readonly HERO_CLIMB_Y_SHIFT

HERO_CLIMB_Y_SHIFT: -2 = -2

Static Private Readonly HERO_WALKING_DELTA

HERO_WALKING_DELTA: 0.015 = 0.015

Static Private Readonly MAX_FRAG_SPIRAL

MAX_FRAG_SPIRAL: 20 = 20

Static Private Readonly ROPE_DOCK_EMPTY

ROPE_DOCK_EMPTY: "dock_empty" = "dock_empty"

Static Private Readonly ROPE_DOCK_KEY

ROPE_DOCK_KEY: "rope_dock" = "rope_dock"

Static Private Readonly ROPE_DOCK_TIED

ROPE_DOCK_TIED: "dock_tied" = "dock_tied"

Static Private Readonly ROPE_FRAGMENT

ROPE_FRAGMENT: "rope_fragment" = "rope_fragment"

Static Private Readonly ROPE_FRAGMENT_WIDTH

ROPE_FRAGMENT_WIDTH: 8 = 8

Static Private Readonly ROPE_Y_SHIFT

ROPE_Y_SHIFT: 1 = 1

Static Private Readonly SPIRAL_ANG_VELOCITY

SPIRAL_ANG_VELOCITY: 88 = 88

Static Private Readonly SPIRAL_VELOCITY

SPIRAL_VELOCITY: 60 = 60

Static Private Readonly SPIRAL_X_SHIFT

SPIRAL_X_SHIFT: -2 = -2

Static Private Readonly SPIRAL_Y_SHIFT

SPIRAL_Y_SHIFT: 4 = 4

Static Private Readonly SWING_SIZE

SWING_SIZE: 6 = 6

Static Private Readonly SWING_TIME

SWING_TIME: 175 = 175

Accessors

active

  • get active(): boolean

active_filters

  • get active_filters(): { color_blend: boolean; colorize: boolean; flame: 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 { color_blend: boolean; colorize: boolean; flame: boolean; gray: boolean; hue: boolean; levels: boolean; mode7: boolean; outline: boolean; pixel_shift: boolean; tint: boolean; watery: boolean }

    • color_blend: boolean
    • colorize: boolean
    • flame: 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

after_psynergy_cast_events

  • get after_psynergy_cast_events(): {}

  • 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 {}

base_collision_layer

  • get base_collision_layer(): number

before_psynergy_cast_events

  • get before_psynergy_cast_events(): {}

  • 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 {}

blocking_stair_block

  • get blocking_stair_block(): Body

body

  • get body(): any

breakable

  • get breakable(): boolean

bush_sprite

  • get bush_sprite(): Sprite

collision_tiles_bodies

  • get collision_tiles_bodies(): Body[]

color_blend_filter

  • get color_blend_filter(): ColorBlend

colorize_filter

  • get colorize_filter(): Colorize

current_action

  • get current_action(): string

current_animation

  • get current_animation(): string

dest_rope_dock

dest_x

  • get dest_x(): number

dest_y

  • get dest_y(): number

enable

  • get enable(): boolean

entangled_by_bush

  • get entangled_by_bush(): boolean

flame_filter

  • get flame_filter(): Flame

frag_able_to_swing

  • get frag_able_to_swing(): boolean[]

fragment_angle

  • get fragment_angle(): number

gray_filter

  • get gray_filter(): Gray

has_shadow

  • get has_shadow(): boolean

height

  • get height(): number

hue_filter

  • get hue_filter(): Hue

is_interactable_object

  • get is_interactable_object(): boolean

is_rope_dock

  • get is_rope_dock(): boolean

is_starting_dock

  • get is_starting_dock(): boolean

key_name

  • get key_name(): string

label

  • get label(): string

levels_filter

  • get levels_filter(): Levels

map_index

  • get map_index(): 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_casted

  • get psynergy_casted(): {}

pushable

  • get pushable(): boolean

rollable

  • get rollable(): boolean

rope_frag_base_pos

  • get rope_frag_base_pos(): { x: number; y: number }[]

rope_fragments_group

  • get rope_fragments_group(): Group

rope_width

  • get rope_width(): number

shadow

  • get shadow(): Sprite

shapes_collision_active

  • get shapes_collision_active(): boolean

snapshot_info

  • get snapshot_info(): { action: string; active: boolean; active_filters: { color_blend: boolean; colorize: boolean; flame: 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: {}; 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: { color_blend: boolean; colorize: boolean; flame: 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: {}; 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: { color_blend: boolean; colorize: boolean; flame: boolean; gray: boolean; hue: boolean; levels: boolean; mode7: boolean; outline: boolean; pixel_shift: boolean; tint: boolean; watery: boolean }
      • color_blend: boolean
      • colorize: boolean
      • flame: 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
    • 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

tied

  • get tied(): boolean

tile_pos

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

tile_x_pos

  • get tile_x_pos(): number

tile_y_pos

  • get tile_y_pos(): number

tint_filter

  • get tint_filter(): Tint

whirlwind_source

  • get whirlwind_source(): boolean

width

  • get width(): number

x

  • get x(): number
  • set x(x: number): void

y

  • get y(): number
  • set y(y: number): void

Methods

add_unset_callback

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

change_collision_layer

  • change_collision_layer(destination_collision_layer: number, update_on_map?: boolean): void

check_psynergy_casted_on_restore

  • check_psynergy_casted_on_restore(): void

check_storage_keys

  • check_storage_keys(): void

clear_snapshot

  • clear_snapshot(): void

config_body

  • config_body(): void

create_engine_storage_key

  • create_engine_storage_key(property_name: string): string

custom_unset

  • custom_unset(): void

destroy_body

  • destroy_body(update_map?: boolean): void

destroy_bush

  • destroy_bush(): void

destroy_collision_tiles_bodies

  • destroy_collision_tiles_bodies(): void

destroy_overlapping_fragments

  • destroy_overlapping_fragments(): void

find_dest_dock

  • find_dest_dock(map: Map): void

get_body_radius

  • get_body_radius(): number

get_current_position

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

get_events

init_bush

  • init_bush(map: Map): void

initial_config

  • initial_config(map: Map, snapshot_info: { action: string; active: boolean; active_filters: { color_blend: boolean; colorize: boolean; flame: 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: {}; 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 }): void

  • Parameters

    • map: Map
    • snapshot_info: { action: string; active: boolean; active_filters: { color_blend: boolean; colorize: boolean; flame: 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: {}; 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: { color_blend: boolean; colorize: boolean; flame: boolean; gray: boolean; hue: boolean; levels: boolean; mode7: boolean; outline: boolean; pixel_shift: boolean; tint: boolean; watery: boolean }
        • color_blend: boolean
        • colorize: boolean
        • flame: 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
      • 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: Map): void

initialize_rope

  • initialize_rope(map: Map): void

insert_event

  • insert_event(id: number): void

intialize_dock_info

  • intialize_dock_info(dest_x: number, dest_y: number, starting_dock: boolean, tied: boolean): void

  • Initializes this rope dock properties.

    Parameters

    • dest_x: number

      The destiny dock x tile position.

    • dest_y: number

      The destiny dock y tile position.

    • starting_dock: boolean

      Whether this event is the rope starting dock.

    • tied: boolean

      Whether the rope is tied or not. This variable is only used if it's a starting dock.

    Returns void

intialize_swing

  • intialize_swing(force?: boolean): void

manage_filter

  • manage_filter(filter: Filter, set: boolean): void

parse_allowed_tiles

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

play

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

position_allowed

  • position_allowed(x: number, y: number): boolean

remove_event

  • remove_event(id: number): void

reset_fragments_pos

  • reset_fragments_pos(): void

set_enable

  • set_enable(enable: boolean): void

set_entangled_by_bush

  • set_entangled_by_bush(entangled_by_bush: boolean): void

set_rope_fragments

  • set_rope_fragments(map: Map): void

set_shadow

  • set_shadow(group: Group, options?: { is_world_map?: boolean; key_name?: string; shadow_anchor_x?: number; shadow_anchor_y?: number }): 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_sprites_z_sorting

  • set_sprites_z_sorting(send_to_back: boolean): void

  • Sets the rope fragments z sorting order by sending them to back or not.

    Parameters

    • send_to_back: boolean

      if true, the rope fragments are sent to back.

    Returns void

set_tile_position

  • set_tile_position(pos: { x?: number; y?: number }, update_on_map?: boolean): void

set_visible

  • set_visible(visible: boolean): void

shift_events

  • shift_events(event_shift_x: number, event_shift_y: number, manipulate_collision?: { prev_collision_layer: number }): void

tie

  • tie(): void

toggle_active

  • toggle_active(active: boolean): void

toggle_collision

  • toggle_collision(enable: boolean): void

unset

  • unset(remove_from_middlelayer_group?: boolean): void

update

  • update(): void

update_shadow

  • update_shadow(): void

Generated using TypeDoc