API Reference

Table of Contents

  1. Interfaces
  2. Core Classes
  3. Structs
  4. Pure functions
  5. Enumerations
  6. View Models
  7. StateTree
  8. Function Libraries
  9. Gameplay Tags (Built-in)
  10. Saving with PulseSave
  11. PulseDialogQuestBridge

The headers are the full reference; this page lists what exists and where it is described.

Interfaces

Interface Header Description
IPulseQuestManagerInterface Interfaces/PulseQuestManagerInterface.h Quest manager API, forwards to the runtime. Quest Manager
IPulseQuestSaveInterface Interfaces/PulseQuestSaveInterface.h Objects saved by a quest manager. Save & Load
IPulseSharedQuestPlayerInterface Interfaces/PulseSharedQuestPlayerInterface.h Players of a shared quest host. Multiplayer

Core Classes

Class Header Description
UPulseQuestManager Components/PulseQuestManager.h Quest manager component
UPulseQuestRuntime Quest/PulseQuestRuntime.h State and logic of a quest manager; FindQuest, IsQuestAllowed, IsQuestPending, GetPendingQuestStarts. Architecture
Pulse::Quest::SendQuestEvent, TAG_GameplayEvent PulseQuestMessages.h Gameplay events for quests on the message bus. Gameplay Events & Story Flags
UPulseQuestObjective_QuestEvent Quest/Objectives/PulseQuestObjective_GameplayEvent.h Base of objectives that react to gameplay events (On Quest Event)
APulseSharedQuestHost Quest/PulseSharedQuestHost.h Shared quest manager actor
UPulseQuest Quest/PulseQuest.h Quest data asset; PrimaryAssetType (PulseQuest), id PulseQuest:<tag>
Pulse::Quest::Catalog, UPulseQuestCatalogLibrary Quest/PulseQuestCatalog.h Quests by tag, quests made at runtime and from templates. Quest Catalog
UPulseQuestSet Quest/PulseQuestSet.h Quest pool: quest tags, quest groups, included sets
UPulseQuestData Quest/PulseQuestData.h Runtime data of a quest
UPulseQuestInstance Quest/PulseQuestInstance.h Runs the quest StateTree (authority)
UPulseQuestObjective Quest/PulseQuestObjective.h Objective base class (display text, progress)
UPulseQuestObjective_WaitForInput Quest/PulseQuestObjective_WaitForInput.h Objective that waits for player input (tutorials)
UPulseQuestObjective_GameplayEvent / _ReachLocation / _Timer / _Message Quest/Objectives/ Ready-made objectives. Objectives
UPulseQuestObjective_AttributeValue / _AttributeDepleted, Pulse::Quest::Attributes Quest/Objectives/ Objectives on attributes through the attribute contract of PulseFoundation and their rules. Attribute objectives
FPulseCondition_QuestFinished, _QuestActive, _StoryFlags; FPulseReward_StartQuest, _SetStoryFlags Conditions/PulseQuestConditions.h Conditions and rewards of PulseQuest for every Pulse list. Quests
FPulseQuestContextExtra Conditions/PulseQuestConditions.h Extra data of the context the quest system gives conditions and rewards (quest manager, quest)
Pulse::Quest::GetContextQuestManagers, GetContextRewardQuestManager Conditions/PulseQuestConditions.h The quest managers own conditions and rewards ask
UPulseObjectiveTask Quest/PulseObjectiveTask.h Gameplay task base for objectives
UGameplayTask_WaitForInput Tasks/GameplayTask_WaitForInput.h Waits for an Enhanced Input action
UPulseQuestManagerData / UPulseSharedQuestManagerData Quest/PulseQuestManagerData.h, Quest/PulseSharedQuestManagerData.h Manager wide data: quest history, story flags, tracked quest
UPulseQuestDirector / UPulseQuestStateTreeDirector Quest/PulseQuestDirector.h, Quest/PulseQuestStateTreeDirector.h Quest Director
UPulseQuestSettings PulseQuestSettings.h Settings

Structs

Struct Description
FPulseQuestAddParams Quest start parameters
FPulseQuestTemplateParams What a quest made from a template changes (tag, texts, StateTree parameters, rewards)
FPulseQuestObjectiveAddParams / FPulseQuestObjectiveAddParamsBase Objective start parameters
FPulseObjectiveHandle Identifies an active objective
FPulseQuestManagerParams / FPulseSharedQuestManagerParams Manager configuration
FPulseQuestManagerLoadParams Load options
FPulseQuestManagerLoadResult Load result (C++)
FPulseQuestSaveGame / FPulseQuestSaveGameView Save data and weak view
FPulseQuestSaveRecord / FPulseQuestObjectSave Saved object (C++)
FPulseQuestDirectorContext Director tick context
FPulseSharedQuestPlayer Player of a shared quest host
FPulseQuestHistoryEntry Quest history entry (finish counts per result, last result)
FPulseQuestGameplayEvent Gameplay event for quests
FPulseQuestObjectiveTarget Marker target of an objective
FPulseQuestManagerLoadResultInfo Load result for Blueprint
FPulseObjectiveProgress Current and target progress of an objective (Quest/State/PulseObjectiveState.h)
FPulseQuestStoryState History, story flags and tracked quest of the manager data (Quest/State/PulseQuestStoryState.h)
FPulseObjectiveState / FPulseObjectiveSave State of a running objective and its saved part (Quest/State/PulseObjectiveState.h)
FPulseQuestRunState / FPulseQuestRunServerState / FPulseQuestRunSave Run state of a quest, its server part and its saved part (Quest/State/PulseQuestRunState.h)

Pure functions

State rules without objects, so they can be tested and reused without a world. The objects call them and apply the result in one step.

Namespace Header Rules
Pulse::Quest::Progress Quest/State/PulseObjectiveState.h SetCurrent, AddCurrent (saturating), SetTarget, IsTargetReached, ShouldCompleteOnTarget, GetRatio, FormatText, AccumulateCounted (message objective), StepTimer / GetTimerTarget (timer objective)
Pulse::Quest::Objective Quest/State/PulseObjectiveState.h PlanCompletion, ShouldStartAgain, ShouldSave, MakeStartState, Diff, MergeReplicated, ToSave / ApplySave, SaveToBytes / LoadFromBytes
Pulse::Quest::Run Quest/State/PulseQuestRunState.h MakeStartState, Finish, RecordObjectiveFinished, RemoveFinishedObjective, GetObjectiveFinishStatus, ShouldSave, ToSave / FromSave, MergeReplicated, Diff, PlanRestartAfterLoad, SaveToBytes / LoadFromBytes
Pulse::Quest::Story Quest/State/PulseQuestStoryState.h AddHistory, UntrackFinished, RecordFinished, RemoveHistory, ClearHistory, SetFlag, SetFlags, ClearFlags, SetTrackedQuest, Reset, MergeLoaded, Diff, queries, SaveToBytes / LoadFromBytes
Pulse::Quest::Sets Quest/PulseQuestSet.h AllowsQuest (exact quest or below a group), CollectQuestTags (exact quests plus known quests below the groups)
Pulse::Quest::Save Quest/Save/PulseQuestSaveState.h HasSaveGameProperties, FindRecordStateStruct, ReadRecordState
Pulse::Quest::ClientSync Private/Quest/State/PulseQuestClientSync.h (module internal) PlanSync, PlanQuestStopped, PlanObjectiveStopped: how a client follows the replicated quests by run id and handle (a run whose quest still loads waits, bQuestPending); the ledger (FPulseQuestClientLedger, Quest/State/PulseQuestClientLedger.h) is what it remembers

Enumerations

Enum Values
EPulseQuestFlags PQF_NoSave, PQF_NoStartOnLoad, PQF_NoHistory
EPulseQuestResultMask Success, Failure, Stopped (bit flags)
EPulseQuestFinishResult Success, Failure, Stopped (None = running)
EPulseObjectiveCompletionStatus InProgress, Success, Failure, Stopped
EPulseQuestObjectiveCompletionMode Success, Failure, Stopped
EPulseObjectiveStartCompletionStatus Stopped, Failure, Success, StoppedOrFailure, All
EPulseObjectiveNetMode ServerAndClient, ServerOnly
EPulseQuestSaveLoadType None, CreateNew, LoadExisting
EPulseQuestDirectorState Active, Failed, Succeeded, Stopped
EPulseQuestStateTreeDirectorLoadBehavior LoadSavedState, Restart
EPulseStartQuestTaskFinishType None, Success, Failure, Stopped
EPulseStartQuestDuplicateBehaviorType Fail, Succeed, TreatAsStarted
EPulseQuestBool Default, True, False
EPulseQuestOwner Manual, Director, Quest
EPulseQuestStoppedResultHandling Failed, Succeeded

View Models

UMVVMPulseQuestManager, UMVVMPulseQuestManagerData, UMVVMPulseQuest, UMVVMPulseObjective (module PulseQuestMVVM, ViewModels/), settings UPulseQuestMVVMSettings. See MVVM & UI.


StateTree

Type Description
UPulseQuestStateTreeSchema Schema Pulse Quest
UPulseQuestDirectorStateTreeSchema Schema Pulse Quest Director
FStateTreeStartObjective Task Quest Objective
FStateTreeStartQuestTask Task Start Quest
FStateTreeWaitForQuestStarted / ...QuestStopped / ...ObjectiveStarted / ...ObjectiveStopped Wait for tasks
FPulseQuestTask_FinishQuest Task Finish Quest
FPulseQuestTask_WaitForQuestEvent / FPulseQuestTask_BroadcastQuestEvent Tasks Wait for Quest Event, Broadcast Quest Event
FPulseQuestTask_SetStoryFlag Task Set Story Flag
FPulseQuestCondition_IsObjectiveActive / FPulseQuestCondition_HasStoryFlag Conditions Is Objective Active, Has Story Flag
FPulseQuestDirectorTask_SetQuestState Director task Set Quest State
FGameplayTagCompareCondition Condition Compare Tag
FStateTreeIsQuestActiveCondition / FStateTreeCanStartQuestCondition / FStateTreeQuestFinishedCondition Conditions Is Quest Active, Can Start Quest, Quest Finished (quest and director)
FStateTreeIsObjectiveFinishedCondition Condition Is Objective Finished (quest)
FStateTreeGameplayTagInputConsideration Consideration Gameplay Tag Input

See StateTree Integration.


Function Libraries

Library Functions
UPulseQuestCatalogLibrary Get Quest Id, Find Quest, Get All Quest Tags, Register Quest, Unregister Quest, Make Quest From Template
UPulseQuestLibrary Find Quest Manager, Find Shared Quest Hosts, Start Quest For Actor, Send Quest State Tree Event, Complete Objectives Of Class, Has Story Flag, Set Story Flag
UPulseQuestUtils Is Local Quest Manager, Is Authority Quest Manager, Serialize Object to Bytes, Deserialize Object from Bytes
UPulseQuestLibrary (events) Send Quest Event, Broadcast Quest Event
UPulseQuestSaveUtils Make Quest Save Game View (VIEW), Make Quest Save Game (PIN), Is Valid Quest Save, Quest Save Game to Bytes, Quest Save Game from Bytes

Async nodes: Save Quest Manager Async, Load Quest Manager Async.


Gameplay Tags (Built-in)

Tag Use
Pulse.Quest.Failure.QuestNotFound Start failed: the quest set does not allow the quest or no catalog knows it (“This quest does not exist.”)
Pulse.Quest.Failure.InvalidQuest Start failed: invalid StateTree (“This quest cannot run.”)
Pulse.Quest.Failure.DuplicateQuest Start failed: already active or queued (“This quest is already running.”)
Pulse.Quest.Failure.AlreadyActive Start failed: another quest runs and multiple quests are not allowed (“Finish your current quest first.”)
Pulse.Quest.Failure.ConditionsNotMet Start failed: the conditions of the quest do not pass (“You cannot start this quest yet.”, the line of the condition as message)
Pulse.Quest.Failure.NoAuthority Start failed: called on a client (“Quests can only be started on the server.”)
Pulse.Quest.Failure.NotReady Start failed: manager not initialized or cleaning up, or CanStartQuest of a quest that still loads (“Quests are not ready yet.”)

The texts are the reasons’ texts of the result text register of Pulse Foundation (Project Settings > Pulse > Foundation

Result Texts replaces them). | Pulse.Quest.Save.ManagerData | Save id of the manager data | | Pulse.Quest.Save.Director | Save id of the director |


Saving with PulseSave

UPulseQuestManager and APulseSharedQuestHost implement IPulseByteSaveable (SaveIdentity, SaveLoadParams, asynchronous) – see PulseSave Integration.

PulseDialogQuestBridge

Dialog and cutscene tasks and objectives for quests, quest nodes for dialogs – see the PulseDialog documentation (Quest Integration).


Back to top

Copyright © 2026 LuQ Studios. Distributed under the MIT License.

This site uses Just the Docs, a documentation theme for Jekyll.