Gameplay · guide

Quests, stages and objectives

A quest is stages, a stage is objectives, and an objective is a subscription with a tag query — so it costs nothing when nothing dies.

Edit this page on GitHub

What it is#

A quest is stages; a stage is objectives; an objective is a *type* plus parameters. The engine ships ten types — Kill, Collect, Reach, Interact, Escort, Survive, Deliver, Discover, Craft, Spend — and a game adds an eleventh by implementing IQuestObjective.

A QuestJournal is one character's quests: what is taken, how far along, and what has finished.

What it is for#

Everything a player is told to go and do, without any of it polling. An objective subscribes to a gameplay event with a tag query and a scene filter, so "kill ten undead in Queensdale" costs nothing at all until something dies.

Using it#

Compile a catalog into a QuestLibrary, read its Problems, and give each character a journal over the shared bus. Accept, Abandon and TurnIn are the whole surface; progress happens by itself.

⚠ The ten shipped types are nine verbs, one clock and one level. The variety is in the *filter*, which a designer writes — "kill ten undead" and "kill the Shatterer" are both Kill. Which is why a game's own type is five lines.

⚠ Collect is a level and the rest are tallies. Having ten ore stops being true when nine are sold; ten undead stay killed.

⚠ Completion is latched. Progress moves both ways; *finished* is a one-way door. Otherwise selling an ore un-finishes a stage that has already advanced.

⚠ A quest chain is a requirement and not a second mechanism. Turning a quest in grants its tag:, and the next quest asks HasTag(Quest.Completed.Prologue) — the same algebra a vendor uses, so the greyed-out giver and the refused accept cannot disagree.

⚠ TurnIn reports the reward and does not pay it. Doc 28's authority table puts quest rewards in the grain; a journal that handed out an item would be a realm deciding a durable question.

⚠ The journal takes a requirement context and a tag set separately. In a real game they are different objects — the level is a progression state's, the tags are the character's — and CompositeRequirementContext is how a caller puts them together.

Examples#

A quest:

yaml

# Assets/Quests/prologue.vxquest!QuestDefinitiondisplayName: A Prologuetag: Quest.Completed.Prologue      # what having finished it isgrantsTags: [ Quest.Active.Prologue ]stages:  - id: hunt    displayName: Cull the skeletons    objectives:      - type: Kill        displayName: Skeletons slain        count: 3        targetTags: [ Creature.Undead ]        scene: maps/queensdale  - id: gather    objectives:      - { type: Collect, count: 2, target: items/ore }      - { type: Discover, optional: true }rewards:  experience: 500  items: [ { def: items/sword } ]  choices: [ { def: items/shield }, { def: items/wand } ]

Running one:

csharp

using Vixen.Gameplay;using Vixen.Gameplay.Quests;static class Giver {    public static QuestRefusal Accept(QuestJournal journal, DefId quest) {        // The same call the client makes to grey the giver out, out of one assembly.        var refusal = journal.CanAccept(quest);        return refusal != QuestRefusal.None ? refusal : journal.Accept(quest);    }    public static void Complete(QuestJournal journal, DefId quest, int choice) {        if (journal.TurnIn(quest, choice, out var reward) != QuestRefusal.None || reward is null) {            return;        }        // What is owed, not what was paid: the caller's ledger transaction does that.        foreach (var grant in reward.Items) {            Pay(grant);        }    }    static void Pay(QuestGrant grant) { }}

A game's eleventh objective type: