Quests & Quest Sets
Table of Contents
UPulseQuest– Quest Definition- Quest Flags (
EPulseQuestFlags) - Conditions
- Rewards
UPulseQuestSet– Quest PoolFPulseQuestAddParamsUPulseQuestData– Runtime Quest StateUPulseQuestInstance– Quest Execution (Authority Only)EPulseQuestFinishResult- In the editor
UPulseQuest – Quest Definition
A const data asset per quest. Its tag is its id: PulseQuest:<tag> (see Quest Catalog). Quest managers find quests through the definitions of PulseFoundation, so a quest can also be made at runtime and registered.
| Property | Type | Description |
|---|---|---|
Tag | FGameplayTag | Unique identifier of the quest and its id (PulseQuest:<tag>). Required. Data validation reports tags used by two quests (a copy of a plugin example under /Game may keep its tag: quest managers take the copy) and quests that must be saved again to be found by their tag |
DisplayName | FText | Name for UI |
Description | FText | Description for UI |
DefaultFlags | EPulseQuestFlags bitmask | Flags every run of this quest gets |
QuestDataClass | TSubclassOf<UPulseQuestData> | Data object of a running quest |
MetaData | UObject* | Optional extra data (icon, category, …) |
Conditions | FPulseConditionList | Must pass to start the quest (see Conditions) |
Rewards | FPulseRewardList | Granted to every player when the quest succeeds (see Rewards) |
StateTree | FStateTreeReference | Quest logic, schema Pulse Quest |
Quest Flags (EPulseQuestFlags)
| Flag | Meaning |
|---|---|
PQF_NoSave (No Save) | The quest is not saved |
PQF_NoStartOnLoad (No Start On Load) | The quest is not restarted after loading |
PQF_NoHistory (No History) | The quest is not recorded in the quest history when it finishes |
Flags of a run are DefaultFlags of the quest combined with the flags in FPulseQuestAddParams.
Conditions
Conditions of a quest is a list of Pulse conditions (FPulseConditionList of PulseFoundation, see the page “Conditions, costs and rewards” of the PulseFoundation docs): the conditions of every Pulse plugin work here, for example Has Item of PulseGameplay or the skill conditions of PulseSkill. CanStartQuest (and so StartQuest) fails with Pulse.Quest.Failure.ConditionsNotMet when the list does not pass; the line of the first condition that does not pass is the message of the result. Conditions are not checked
- for quests restored from a save game (their quest data is on the load stack),
- when
bIgnoreConditionsis set inFPulseQuestAddParamsor in the Start Quest StateTree task, - for quests started by the quest director, which decides about the story itself.
The context of the conditions (UPulseQuest::MakeContext): the player of the quest manager as Player (a shared quest host has several players, so its quests name none), the quest as Source, its tag in Tags, and FPulseQuestContextExtra (the quest manager and the quest) as extra data.
PulseQuest brings these conditions (category Quests). They ask the quest manager of the extra data; used elsewhere (a dialog choice, an interactable) they ask the quest manager of the player and the shared quest hosts it belongs to:
| Condition | Parameters | Passes when |
|---|---|---|
Quest Finished (FPulseCondition_QuestFinished) | Quest, Results (mask), MinCount, Text | The quest finished at least MinCount times with one of the results (quest history). Put it in a Not to offer something only once, e.g. a tutorial |
Quest Active (FPulseCondition_QuestActive) | Quest, Text | The quest is active |
Story Flags (FPulseCondition_StoryFlags) | Query, Text | The story flags match the query |
Text is the line a UI shows (“Finish The Smith first”); empty describes the condition. Conditions also run on clients (quest boards): what a client cannot know (the quests of another player) is Unknown, and the authority decides. UPulseQuest::AreConditionsMet(QuestManager, OutReason) checks the conditions alone and gives the line of the first one that does not pass.
Rewards
Rewards of a quest is a list of Pulse rewards (FPulseRewardList). When the quest succeeds, the authority grants them once for every player of the quest manager (IPulseQuestManagerInterface::GetQuestPlayers: the owner of a player’s quest manager, every player of a shared quest host), after the quest is in the history. Failed and stopped quests give nothing. The context is the one of the conditions with that player.
PulseQuest brings these rewards; the rewards of the other Pulse plugins (items, experience, …) work as well:
| Reward | Parameters | Grants |
|---|---|---|
Start Quest (FPulseReward_StartQuest) | Quest, bIgnoreConditions | Starts a quest in the quest manager of the player (a follow-up quest) |
Set Story Flags (FPulseReward_SetStoryFlags) | Flags, bSet | Sets (or clears) story flags in the quest manager of the player |
UPulseQuestSet – Quest Pool
The quests a quest manager may start, as tags. A set holds no quest objects: the quest manager finds the quests through the quest catalog. See the example quest set in Getting Started.
| Property | Description |
|---|---|
Quests | Exact quest tags that can be started |
QuestGroups | Parent tags: every quest below one of them can be started, e.g. Quest.Daily for quests a backend makes at runtime |
QuestSets | Other quest sets whose quests and groups can be started as well |
bPreloadQuests | On (default): the exact quests of this set load when a quest manager starts and stay loaded, so starts never wait. Off: a quest loads on its first start (pending start) |
| Function | What it does |
|---|---|
AllowsQuest(Tag) | Whether the set or an included set allows the quest (exact or below a group) |
GetQuestTags(Context, OutTags) | The exact quests plus every quest of the catalog below a group, sorted |
GetPreloadTags(OutTags) | The exact quests of every set with bPreloadQuests |
GetAllTags(OutQuests, OutGroups) | Exact quests and groups of the set and every included set |
The rules are plain functions in Pulse::Quest::Sets (AllowsQuest, CollectQuestTags), without objects or a world. Quests and QuestGroups are searchable in the asset registry, so the check “quest in no quest set” runs without loading the sets. Loops between quest sets and empty entries are reported by data validation; a listed quest tag without a quest asset is a warning (it may be a quest the game registers at runtime).
FPulseQuestAddParams
| Member | Description |
|---|---|
QuestTag | The quest to start |
QuestFlags | Additional flags (Blueprint: bitmask pin) |
bIgnoreConditions | Start the quest even if its conditions do not pass |
Owner | Manual, Director or Quest. Decides who restarts the quest after loading |
OnAdded | C++ delegate. Only called if StartQuest returned true: true when the quest runs, false if the queued start failed or was discarded (e.g. by a reset) |
FPulseQuestAddParams::FromQuestTag(Tag) creates params for a tag.
UPulseQuestData – Runtime Quest State
Created for every running quest (on the authority, replicated to clients). PulseQuest saves its run state (flags, owner, StateTree state, objectives) as versioned bytes. Subclass it for quest specific data; mark variables with SaveGame to save them next to it.
| Function / property | Description |
|---|---|
GetQuestTag() | Tag of the quest |
Get Quest Display Name / Get Quest Description | Texts of the quest asset |
GetOwner() / GetRunId() | Who started the quest, id of this run (same on server and clients). Blueprint: Get Quest Owner, Get Run Id |
Get Run State / Get Quest Flags / Is Loaded From Save Game | The run state (tag, run id, flags, owner, result); loaded from a save (server only) |
GetQuestObjectives() | Running objectives of the quest |
GetQuest() | The quest asset (C++) |
Is Finished(OutResult) | Whether the quest has ended, and how |
IsObjectiveFinished(SaveID) / GetObjectiveFinishStatus(SaveID) | Result of finished objectives of the current run |
IsClientData() | True on clients |
GetQuestManager() | Owning quest manager |
OnStopped | Event when the quest ended (also the Blueprint override On Quest Finished) |
OnObjectiveStartedDynamic / OnObjectiveFinishedDynamic | Objectives of this quest |
Saved with the quest: flags, owner, the active StateTree state (id and path), the running objectives and the finished objectives.
UPulseQuestInstance – Quest Execution (Authority Only)
Runs the StateTree of a quest. Tick is called by the manager, SendEvent forwards StateTree events, Stop ends the quest. When a quest was loaded, the instance transitions to the saved state right after the StateTree started (by state id, else by path; a missing state is logged and the quest starts from its first state). It exists only on the authority; clients only have the quest data. Subclass it and override CreateQuestInstance of the manager for custom context data.
EPulseQuestFinishResult
Success, Failure, Stopped (no result). None means the quest still runs.
EPulseQuestResultMask (Success, Failure, Stopped as bits) filters results, e.g. in the quest history, the Quest Finished condition (Pulse condition and StateTree condition), and Is Objective Finished.
In the editor
Quests and quest sets open in the config workshop.
- The preview Chain of a quest shows its place in the quest chain: the quests it needs finished or running (Quest Finished and Quest Active in its start conditions, also inside All Of and Any Of, not inside Not), the quests that start it (their Start Quest rewards), the quests it starts and the quests that need it. A click opens the other quest. A tag without a quest asset is red; quests whose needs form a loop can never start and are marked.
- The preview Quests of a quest set lists every quest the set allows (exact quests and quests below a group, also of included sets) with its needs, who starts it, what it starts and its rewards, and the exact quests without an asset. Open in Pulse Tables edits their values side by side.
A difficulty changes quests through the tuning: the reward amounts with the reward tuning, the time limits of timer objectives with Pulse.Tuning.Quest.TimeLimit (the quest tag in the tags). Specs: PulseQuest.Editor.Chains.