HomeWikiSourceDownloadsDiscord

Kristal Wiki

Getting Started

These pages get you ready to use the engine.


General Mod Creation

These pages teach you about mod 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

Getting Started

These pages get you ready to use the engine.


General Mod Creation

These pages teach you about mod 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⮭

Savepoint

┗> Interactable > Event > Object > Class


Savepoints allow the player to SAVE their game.
Savepoint is an Event - naming an object savepoint on an objects layer in a map creates this object.
See this object's Fields for the configurable properties on this object. The location displayed on the savefile is determined by the map's name property.


Constructor

Savepoint(x: any, y: any, properties: any)

Arguments:

x: any
y: any
properties: any



Methods


Savepoint:onInteract(player: any, dir: any)

Arguments:

player: any
dir: any

Returns:

1: boolean|nil




Fields

Savepoint.heals: boolean

[Property heals] Whether this Savepoint heals the party when interacted with (Defaults to true)

Savepoint.marker: string

[Property marker] The name of the marker that the party should spawn at when a save from here is loaded

Savepoint.simple_menu: boolean

[Property simple] Whether this Savepoint uses the Simple (one slot, no storage/recruits) save menu

Savepoint.text_once: boolean

[Prpoerty text_once] Whether this Savepoint doesn't display its text on repeat interactions (Defaults to false)


Undocumented