ClimbMover

┗> ClimbArea > Event > Object > Class


A ClimbMover is an area the player can climb onto. Once they're on it, it will move to a pre-set location.

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


Constructor


ClimbMover(x: number?, y: number?, shape: number, y?]?, settings: ClimbMoverSettings?)

Arguments:

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

The settings for a ClimbMover.





Methods




ClimbMover:onCollide(char: Player)

Arguments:

char: Player

The character controlled by the player when in the Overworld.





ClimbMover: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.








Fields


ClimbMover.exit: (string|integer|table|[number, number]| integer })?

The identifier of the exit marker that this ClimbMover will dismount the player to.


ClimbMover.exit_x: number?

The x position that the player will be dismounted to.


ClimbMover.exit_y: number?

The y position that the player will be dismounted to.


ClimbMover.start_exit: (string|integer|table|[number, number]| integer })?

The identifier of the exit marker that this ClimbMover will dismount the player to when returning to the start position.


ClimbMover.start_exit_x: number?

The x position that the player will be dismounted to when returning to the start position.


ClimbMover.start_exit_y: number?

The y position that the player will be dismounted to when returning to the start position.


ClimbMover.target: string|integer|table|[number, number]| integer }

The identifier of the target event that this ClimbMover leads to.


ClimbMover.target_x: number?

The x position that the player will jump to.


ClimbMover.target_y: number?

The y position that the player will jump to.



Undocumented