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⮭

SetFlagEvent

┗> Event > Object > Class


An Overworld region that sets a flag when the player steps into it.
SetFlagEvent is an Event - naming an object setflag on an objects layer in a map creates this object.
See this object's Fields for the configurable properties on this object.


Constructor

SetFlagEvent(x: any, y: any, shape: any, properties: any)

Arguments:

x: any
y: any
shape: any
properties: any



Methods


SetFlagEvent:onEnter(chara: any)

Arguments:

chara: any

Returns:

1: boolean


Fields

SetFlagEvent.flag: string

[Property flag] The name of the flag to set a value on

SetFlagEvent.map_flag: string

[Property mapflag] The name of the flag to set a value on, only affecting the current map

SetFlagEvent.once: boolean

[Property once] Whether the flag can only be set by this region once (Defaults to false)

SetFlagEvent.value: any

[Property value] The value to set on the flag


Undocumented