FallingClimbArea

┗> ClimbArea > Event > Object > Class


A FallingClimbArea is an area the player can climb on. It will fall once the player leaves it.

FallingClimbArea is an Event - naming an object FallingClimbArea on an objects layer in a map creates this object.


Constructor


FallingClimbArea(x: number?, y: number?, shape: number, y?]?, settings: FallingClimbAreaSettings?)

Arguments:

x: number?
y: number?
shape: number, y?]?
settings: FallingClimbAreaSettings?

The settings for a FallingClimbArea.





Methods


FallingClimbArea:applyTileObject(data: any, map: any)

Arguments:

data: any
map: any


FallingClimbArea:onCollide(character: Player)

Arguments:

character: Player

The character controlled by the player when in the Overworld.





FallingClimbArea:onRemove(parent: Event|World)

Arguments:

parent: Event|World

The World Object manages everything relating to the overworld in Kristal.
A globally available instance of World is stored in Game.world.






Undocumented





FallingClimbArea.dont_break: ("down"|"left"|"right"|"up")?







FallingClimbArea.state: integer

0 = idle, 1 = player overlapping, 2 = falling







FallingClimbArea.unsafe_area: nil

A ClimbUnsafe event is an area deemed unsafe. Climbing sometimes needs the player's last "safe location" (ex. when you fall off the map, it tries to put you back somewhere safe). This object is to denote where may be unsafe.

ClimbUnsafe is an Event - naming an object climbunsafe on an objects layer in a map creates this object.