Home
Wiki
Source
Downloads
Discord

Kristal Wiki


General Information

These pages get you ready to use the engine.


General Project Creation

These pages teach you about project development.


The Overworld

Everything to do with the overworld.


Battles

Everything related to creating battles.


Advanced

These pages teach you more complex but powerful parts of the engine.


API Reference

An auto-generated API reference for Kristal.

⮬ Back to Top ⮭

Kristal Wiki


General Information

These pages get you ready to use the engine.


General Project Creation

These pages teach you about project development.


The Overworld

Everything to do with the overworld.


Battles

Everything related to creating battles.


Advanced

These pages teach you more complex but powerful parts of the engine.


API Reference

An auto-generated API reference for Kristal.

⮬ Back to Top ⮭

Follower

┗> Character > Object > Class


Followers are a type of Overworld character that follow the player's movements.


Constructor

Follower(chara: number, x: number, y: number, target: any)

Arguments:

chara: number
x: number
y: number
target: any



Methods


Follower:copyHistoryFrom(target: any)

Arguments:

target: any


Follower:getFollowDelay()

Gets the delay in seconds this follower will follow its target's position, taking into account the delay of followers in front of itself.

Returns:

1: unknown


Follower:getTargetPosition()

Returns:

1: unknown
2: unknown
3: "down"|"left"|"right"|"up"
4: unknown
5: unknown

Follower:interpolateHistory()

Adds this follower's current position to their movement history.



Follower:moveToTarget(speed: any)

Arguments:

speed: any

Returns:

1: number|unknown
2: number|unknown

Follower:onAdd(parent: Object)

Arguments:

parent: Object

The base class of all objects in Kristal.
When added to the stage, an object will be updated and rendered.


Follower:onRemove(parent: Object)

Arguments:

parent: Object

The base class of all objects in Kristal.
When added to the stage, an object will be updated and rendered.


Follower:returnToFollowing(speed: any)

Arguments:

speed: any


Follower:updateHistory(moved: any, auto: any)

Arguments:

moved: any
auto: any



Undocumented