Craftengine Clear Quest State
Drop a player's own state for a quest zone
Fields
| Field | Type | Default | Description |
|---|---|---|---|
artifact | Ref<QuestStateArtifactEntry> | — | Where this zone's state is stored. |
zoneId | String | — | The zone to clear, as named on the zone audience. Empty clears every zone of this artifact for the player. |
group | Ref<GroupEntry> | — | The group the zone shares its state with, if any. Must match the zone audience. |
returnStashedItems | Boolean | true | Hand stashed items back before dropping the record. |
Common TypeWriter fields (criteria, modifiers, triggers)
| Field | Type | Default | Description |
|---|---|---|---|
criteria | List<Criteria> | empty | — |
modifiers | List<Modifier> | empty | — |
triggers | List<Ref<TriggerableEntry>> | empty | — |
How to use it
Drops what was recorded for the player, and for their group when the zone is shared. Call it when a quest is abandoned or finished. Leaving a zone keeps the state so the player finds it again; this action erases it.
An empty zoneId clears every zone of the artifact for the player. With returnStashedItems on, items stashed by the zone are handed back first, both the zone's and the outside ones, wherever there is room rather than slot for slot, so clearing never destroys what a player carried.