Getting Started

Like every Pulse plugin, PulseQuest is used in four steps: Set Up, Create, Test and Check. The Pulse window (Tools > Pulse > Pulse) walks through them, and its Guide shows each step in the editor. The list at the start of each section comes from the plugin itself; the text after it goes into the details.

To see quests working before you set anything up, start with Test: the plugin brings an example map.

Table of Contents

  1. Set Up
    1. Enable the plugin
    2. Add a quest manager
    3. Give it a quest set
    4. Save
  2. Create
    1. Create a quest
    2. Create a quest set
    3. Save quests once
    4. Write the quest logic
    5. Write an objective
  3. Test
    1. The example map
    2. Start a quest
  4. Check
    1. Diagnostics

Set Up

The Pulse window (Tools > Pulse > Pulse, tab Workflow, step Set Up) checks each of these and fixes it with a click:

  • Add the Pulse Quest Manager component to the Player Controller. Runs the quests of a player and replicates them to its client. On the player controller only the owning client gets them; on the player state every client does.
  • Give the quest managers a quest set. A quest manager starts only quests its quest set allows (quest tags, quest groups): Quest Set on the component, or Default Quest Set in Project Settings > Pulse > Quest for every manager without one.
  • Save quests once, so they are known by their tag. A quest is found by its id PulseQuest: (the definitions of Pulse Foundation, the asset manager). The asset registry keeps the id a quest had when it was saved, so a quest saved before its tag was its id, or whose tag changed, is found only after it is saved again.
  • Optional: Connect with PulseDialog: PulseDialogQuestBridge. Dialogs and cutscenes as quest objectives, quest nodes in dialogs, dialog events as quest events.
  • Optional: Connect with PulseOnline: PulseQuestOnlineBridge. Party quests: the players of one party share a quest host on the server.
  • Optional: Connect with PulseGameplay: PulseQuestGameplayBridge. Objectives for items, enemies and interactables: gather and deliver items, defeat enemies, interact with things.
  • Optional: Connect with PulseAI: PulseAIQuestBridge. AI agents in quests: tasks that spawn agents, set their profile, send AI events and raise alarms; objectives to defeat an AI group or escort an agent.
  • Optional: Connect with PulseWorld: PulseWorldQuestBridge. Objectives that lead to the nearest place the generator of Pulse World made.

Enable the plugin

PulseQuest needs Unreal Engine 5.8 or newer.

  1. Copy the plugin into Plugins/PulseQuest of your project.
  2. Enable Pulse Quest in the plugin browser. PulseFoundation (the free Pulse base plugin, 1.0 or newer), StateTree, GameplayStateTree, ModelViewViewModel, EnhancedInput and DataValidation are enabled with it.
  3. For C++ add the module to your Build.cs:
PublicDependencyModuleNames.AddRange(new string[] { "PulseQuest", "GameplayTags", "StateTreeModule" });
// UI with view models:
PublicDependencyModuleNames.Add("PulseQuestMVVM");

Add a quest manager

The quest manager (UPulseQuestManager) runs the quests of a player. Add Automatically in the Pulse window turns on Quest Manager in Project Settings > Pulse > Quest, which adds it to every player controller when it spawns. Or add a Pulse Quest Manager component to your player controller or player state yourself and set:

  • Quest Set – the quests it can start (see Create); empty for the default quest set of the settings.
  • Quest Manager Data Class – PulseQuestManagerData or a subclass.
  • Allow Multiple Quests – whether more than one quest can run at a time.
  • Optional Quest Director Class (story, see Quest Director).

The component replicates by default, to the owning connection only. On the player controller only the owning client gets the quests; on the player state every client can see them. See Quest Manager and Multiplayer.

Give it a quest set

A quest manager can only start quests its quest set allows. Default Quest Set in Project Settings > Pulse > Quest is used by every quest manager (and shared quest host) without a quest set of its own; Use in the Pulse window sets it to a quest set of the project.

Save

The quest manager saves itself as bytes: PulseSave keeps it without a bridge (PulseSave integration). With your own save system, save the quest manager into a FPulseQuestSaveGame. See Save & Load.


Create

New assets come from Add > Pulse > Quest in the content browser or New in the Pulse window:

  • Quest (UPulseQuest, the main asset): One quest: tag, texts, conditions, rewards and the StateTree that runs it.
  • Quest Set (UPulseQuestSet): The quests a quest manager can start, as quest tags and quest groups (parent tags); can include other quest sets.
  • Quest StateTree (UStateTree, schema UPulseQuestStateTreeSchema): The logic of a quest: a StateTree with the Pulse Quest schema, objectives as tasks.
  • Quest Objective (Blueprint of UPulseQuestObjective): A Blueprint objective with rules of its own; Complete Objective finishes it.
  • Quest Director (Blueprint of UPulseQuestStateTreeDirector): Starts quests by story rules (a StateTree with the Pulse Quest Director schema); set it as Quest Director Class of the quest manager.
  • Quest Director StateTree (UStateTree, schema UPulseQuestDirectorStateTreeSchema): The story logic of a quest director: a StateTree with the Pulse Quest Director schema.
  • Starter content: The example quests (one objective, a sequence, a branch and a follow-up quest) with their StateTrees, two Blueprint objectives and a quest set. Add Starter Content copies it to /Game/Pulse/PulseQuest.

Create a quest

Add > Pulse > Quest > Quest in the content browser creates a UPulseQuest:

Property What to set
Tag A unique gameplay tag, e.g. Quest.Main.FindTheKey
DisplayName / Description Text for UI
DefaultFlags Optional EPulseQuestFlags (e.g. No Save)
QuestDataClass PulseQuestData or your subclass
MetaData Optional object for UI (icon, category, …)
StateTree A StateTree with the Pulse Quest schema (Add > Pulse > Quest > Quest StateTree)

Create a quest set

Add > Pulse > Quest > Quest Set creates a UPulseQuestSet; add the tag of the quest to Quests. QuestGroups allows every quest below a parent tag (quests made at runtime, see Quest Catalog), and quest sets can include other quest sets (QuestSets).

Save quests once

A quest is found by its id PulseQuest:<tag>. The asset registry keeps the id a quest had when it was saved, so a quest saved before its tag was its id (or whose tag changed) is known by its tag only after it is saved again. The setup step Save quests once, so they are known by their tag lists these quests and saves them with Save.

Write the quest logic

Open the StateTree of the quest. Use the built-in task Quest Objective to run an objective in a state, and transition on its result (“On State Succeeded” → next state or Tree Succeeded). Ready-made objectives like Gameplay Event Objective (“kill 5 wolves”), Reach Location Objective and Timer Objective need no Blueprint. The Wait for tasks wait for other quests or objectives, Start Quest starts a follow-up quest. See StateTree Integration.

Write an objective

For own rules create a Quest Objective Blueprint (Add > Pulse > Quest > Quest Objective, a Blueprint of PulseQuestObjective) or a C++ class and complete it with Complete Objective (authority). A save id is optional: the Quest Objective task generates one. See Objectives.

Gameplay code reports what happened with Send Quest Event (e.g. Event.Enemy.Killed.Wolf when an enemy dies); Gameplay Event objectives and Wait for Quest Event tasks count these events. See Gameplay Events & Story Flags.

Blueprint: A Blueprint objective

  1. Create a Blueprint class of Pulse Quest Objective, set Save ID (unique within the quest).
  2. Add a variable Collected (Integer), in its details enable SaveGame, so it is saved with the quest.
  3. Override Objective Started → bind to your gameplay (e.g. an item pickup event on Get Avatar Actor).
  4. On pickup: Collected + 1 → if Collected >= 5 → Complete Objective (Mode = Success).
  5. Override Cleanup → unbind what Objective Started bound.

Test

  • Play Example in the Pulse window opens /PulseQuest/Examples/LV_PulseQuest_Example and starts Play in Editor.
  • Then the cheat PulseQuestGrant gives the player what the plugin needs, and Pulse.Quest.ShowEvents 1 and PulseQuestStart Pulse.Quest.Example.Sequence run.
  • The example quest Sequence starts: a timer objective, then “Collect 0/5 herbs” (PulseQuestProgress adds progress, PulseQuestComplete completes running objectives). PulseQuestStart starts the other examples (Pulse.Quest.Example.Simple, Branch, FollowUp), PulseQuestInfo prints quests and objectives, Pulse.Quest.ShowEvents 1 prints quest events on the screen, the Live page of the Pulse Debugger shows the quest manager.

The example map

The plugin brings an example map, /PulseQuest/Examples/LV_PulseQuest_Example (enable Show Plugin Content in the content browser). Its game mode uses a player controller with a quest manager and the example quest set in /PulseQuest/Examples/Quests: Simple (one timer objective), Sequence (a timer objective, a delay, then “Collect 0/5 herbs”), Branch (branches on the objective result, can be skipped with the StateTree event Pulse.Quest.Example.Event.Skip and starts FollowUp).

Play Example for Quest in the Pulse window opens the map, starts Play in Editor, runs PulseQuestGrant, turns on Pulse.Quest.ShowEvents and starts the Sequence quest. PulseQuestProgress and PulseQuestComplete move the objectives on, PulseQuestInfo prints the quests (see Console); the Live page of the Pulse Debugger shows the quest manager. To build on the example quests, Add > Pulse > Quest > Add Starter Content copies them to /Game/Pulse/PulseQuest/Quests and sets the copied quest set as default quest set if the settings have none. The copies keep the tags of the examples. A tag is the id of a quest, and when a copy under /Game and the example share it, quest managers take the copy (project content wins over plugin content), so you can change the copies right away. The Check reports every tag that two quests of the project, or two quests of plugins, use.

Start a quest

Quests are started on the authority:

const FPulseResult Result = QuestManager->StartQuest(FPulseQuestAddParams::FromQuestTag(QuestTag));
if (Result.IsFailure())
{
	// Result.Reason is a Pulse.Quest.Failure.* tag, Result.GetDisplayText() the text for the player
}

Blueprint: Start a quest

  1. Get Component by Class (Pulse Quest Manager) on the player controller or player state. Only the authority starts quests.
  2. Make PulseQuestAddParams → Quest Tag = the tag of the quest (it must be in the quest set of the manager). Optional Quest Flags.
  3. Start Quest (Target = quest manager, Quest = the params) → Return Value is a Pulse Result: Is Success = the start was queued; otherwise its Reason is a Pulse.Quest.Failure.* tag and Get Display Text the text for the player.
  4. The quest runs from the next tick on. Bind On Quest Started on the quest manager to react when it is running.

StartQuest only queues the start; the quest runs from the next tick of the quest manager.


Check

  • Check in the Pulse window, Check All there (console Pulse.Check) or the commandlet -run=PulseCheck -Plugins=PulseQuest checks the setup and validates every Quest, Quest Set, Quest StateTree, Quest Objective, Quest Director and Quest Director StateTree in the project.

Quests (unique tags, schema), quest sets, quest managers, objectives and quest StateTrees validate themselves when they are saved; Check does it for every quest asset of the project, together with the setup.

Diagnostics

  • Log category LogPulseQuest (quest manager messages are also written to the Visual Logger).
  • stat Quest shows the tick times of quest managers, quests, objectives and directors.
  • Pulse.Quest.ShowEvents 1 prints quest and objective events of local players on the screen.

Back to top

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

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