Getting started

Like every Pulse plugin, PulseGameplay 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 the building blocks working before you set anything up, start with Test: the plugin brings an example map with a player pawn that has every component.

Set Up

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

  • Set “Enable HUD” to True (Project Settings > Pulse > Gameplay > HUD) Every local player gets the Pulse HUD: stacks for menus and modals, toasts, compass and markers, the interaction prompt, the hotbar and the combat HUD.
  • Optional: Set “Enable Player Input Manager” to True (Project Settings > Pulse > Foundation > UI) Menus and modals of the HUD show the cursor and switch the input mode through input contexts. Leave it off when the game sets cursor and input mode itself.
  • Optional: Show toasts for the other Pulse plugins. Notification rules turn messages into toasts: a quest that starts, completes or fails, an achievement that unlocks. The step offers the rules of the Pulse plugins in the project; change or add rules in the HUD settings.
  • Optional: Start the game on a main menu. The frontend shows a title, the main menu (New Game, Settings, Credits, Quit), a loading screen between levels and the pause menu on Escape. Leave it off when the game has a menu of its own.
  • Optional: Give the player an ability system. Interaction is a gameplay ability and combat uses gameplay attributes: an Ability System Component on the pawn or the player state. The combat component adds the health set itself (Default Attribute Sets); the game gives the interact ability (Pulse Rep Interact Ability, or a child with Activate On Give).
  • Optional: Add the Pulse Inventory Component to the Player Pawn. The items of the player: a grid or slots with weight and other traits; pickups, drops, crafting and the hotbar use it.
  • Give every item, recipe and recipe book its own asset name. Saves find items and recipes by their id (PulseItem:, PulseRecipe:), so a moved asset still loads. Two assets of one type with the same asset name share one id: the editor shows a warning, packaged game and server builds report an ensure, and a save may load the other asset. A copy of a plugin example under /Game (Add Starter Content) may keep its name: the project asset wins. Renaming changes the id; add a Primary Asset Id Redirect for assets that are already in saves.
  • Optional: Add the Pulse Equipment component to the Player Pawn. Equipment slots and the hotbar; equipped items show on the pawn.
  • Optional: Add the Pulse Item User component to the Player Pawn. Uses consumables (potions, food) with use time and cooldowns, through the ability system.
  • Optional: Add the Pulse Equipment Effects component to the Player Pawn. Stats of equipped items (maximum health, regeneration) become gameplay effects.
  • Optional: Add the Pulse Crafting component to the Player Pawn. Known recipes and the crafting queue of the player; ingredients come from the inventory.
  • Optional: Add the Pulse Combat component to the Player Pawn. Life, death and team of the pawn; damage, healing and hit reactions go through it.
  • Optional: Add the Pulse Combat Equipment component to the Player Pawn. Weapons give their attacks, armor its damage modifiers; items wear and break.
  • Optional: Add the Pulse Respawn component to the Player Controller. Death screen, respawn at a point the player chooses (Pulse Respawn Point actors, else a player start) and a death bag with the inventory; needs the combat component on the pawn.
  • Optional: Let players go down before they die. A player whose health runs out goes down: a teammate revives it by holding the interaction on it, else it bleeds out and dies. The downed rules decide who goes down (players only, not alone, at most two downs between respawns); needs the respawn component.
  • Optional: Let the Asset Manager scan PulseLootTable assets. An entry in Project Settings > Game > Asset Manager > Primary Asset Types to Scan gives the assets their primary asset id (lookups by id, async loading) and lets the cook find them.
  • Optional: Let the Asset Manager scan PulseMerchantDefinition assets. An entry in Project Settings > Game > Asset Manager > Primary Asset Types to Scan gives the assets their primary asset id (lookups by id, async loading) and lets the cook find them.
  • Optional: Let the Asset Manager scan PulseAttack assets. An entry in Project Settings > Game > Asset Manager > Primary Asset Types to Scan gives the assets their primary asset id (lookups by id, async loading) and lets the cook find them.
  • Optional: Let the Asset Manager scan PulseProjectile assets. An entry in Project Settings > Game > Asset Manager > Primary Asset Types to Scan gives the assets their primary asset id (lookups by id, async loading) and lets the cook find them.
  • Optional: Let the Asset Manager scan PulseHitFeedback assets. An entry in Project Settings > Game > Asset Manager > Primary Asset Types to Scan gives the assets their primary asset id (lookups by id, async loading) and lets the cook find them.
  • Optional: Let the Asset Manager scan PulseResourceNode assets. An entry in Project Settings > Game > Asset Manager > Primary Asset Types to Scan gives the assets their primary asset id (lookups by id, async loading) and lets the cook find them.
  • Optional: Let the Asset Manager scan PulseMap assets. An entry in Project Settings > Game > Asset Manager > Primary Asset Types to Scan gives the assets their primary asset id (lookups by id, async loading) and lets the cook find them.
  • Optional: Let the Asset Manager scan PulseStatusEffectUIData assets. An entry in Project Settings > Game > Asset Manager > Primary Asset Types to Scan gives the assets their primary asset id (lookups by id, async loading) and lets the cook find them.
  • Optional: Connect with PulseSave: PulseGameplaySaveBridge. Saves inventories, equipment and crafting queues with PulseSave; Continue, Load and Save in the menus of the frontend.
  • Optional: Connect with PulseSkill: PulseSkillInventoryBridge. Lent items that never pay costs, inventory upgrades as skill grants.
  • Optional: Connect with PulseQuest: PulseQuestGameplayBridge. Quest objectives that gather and deliver items, defeat enemies and count interactions.
  • Optional: Connect with PulseSkill: PulseSkillHUDBridge. Toasts on the HUD for level ups, skill points and skills, the skill menu on a key.
  • Optional: Connect with PulseDialog: PulseDialogHUDBridge. The dialog box on the HUD, the cursor for choices, the HUD hidden in cutscenes.
  • Optional: Connect with PulseDialog: PulseDialogGameplayBridge. Talk to NPCs by interaction; dialog tasks that give and take items.
  • Optional: Connect with PulseOnline: PulseOnlineHUDBridge. Invites, reconnects and connection messages on the HUD.
  • Optional: Connect with PulseAI: PulseAICombatBridge. AI agents fight with Pulse combat: teams, attack sets, attack tokens, bosses and encounters.
  • Optional: Connect with PulseAI: PulseAIHUDBridge. Awareness markers above AI agents and attack warnings on the HUD.
  • Optional: Connect with PulseBuild: PulseBuildGameplayBridge. Build kits, chests, damage on pieces, build menus on the HUD.
  • Optional: Connect with PulseWorld: PulseWorldGameplayBridge. Trees and rocks of Pulse World become resource nodes; felling and regrowing are saved with the world.
  • Optional: Connect with PulseWater: PulseWaterGameplayBridge. Shipyards that build boats through crafting, boat items, patching leaks and repairing boats with items.
  • Optional: Connect with PulseNav: PulseNavGameplayBridge. The route of the guide on the minimap and the world map, the next waypoint as a HUD marker, destinations picked on the world map, and Move Goods between stashes at the stops of travellers.

Plugin modules and dependencies

PulseGameplay is declared in PulseGameplay.uplugin and includes runtime modules for gameplay (PulseAbility, PulseHUD, PulseInventory) plus editor-side modules. It depends on the free plugin PulseFoundation, which provides the helper module PulseGameCore and the shared base of all Pulse plugins; enabling PulseGameplay enables it.

Important plugin dependencies declared in the .uplugin:

  • GameplayAbilities
  • CommonUI
  • EnhancedInput
  • ModelViewViewModel

Enable the HUD

  1. Enable bEnableHUD in UPulseHUDSettings (Set Up does it; it works after the editor restarts).
  2. Set HUDLayoutClass to a widget derived from UPulseHUDLayout that contains a stack container named Pulse.HUD.Stack.Main (the plugin’s W_DefaultHUDWidget does).
  3. Use the HUD through UPulseHUDSubsystem (local player subsystem) or the Blueprint functions of UPulseHUDLibrary.

The HUD is created per local player and rebuilt whenever the player controller changes. See HUD system.

bEnablePlayerInputManager of Pulse Foundation (Project Settings > Pulse > Foundation > UI, optional step of Set Up) lets menus and modals of the HUD show the cursor and switch the input mode through input contexts. Leave it off when the game sets cursor and input mode itself.

The HUD module registers project settings under:

  • Project Settings → Pulse → Core → HUD

Settings object:

  • UPulseHUDSettings (Source/PulseHUD/Public/PulseHUDSettings.h)

Main settings groups:

  1. HUD (enable, layout, z-order)
  2. Style (default classes)
  3. Notifications
  4. Input

Coming from PulseCore 1.x: see Coming from PulseCore 1.x.

The player: ability system and components

PulseGameplay brings no pawn or player state of its own; the game puts its components on its own classes.

  • Ability system. Interaction is a gameplay ability and combat uses gameplay attributes, so the pawn or the player state needs an Ability System Component. The combat component adds the health set to it on the authority (Default Attribute Sets: add UPulseStaminaAttributeSet for stamina costs, empty the list when the game gives its own sets). Default Starting Data of the ability system component is no alternative without a data table: it only creates sets that have one.
  • Components. Every component step of Set Up has Add Automatically: it turns on the entry in the category Automatic Components of the plugin settings, and every player pawn gets the component when it spawns, without Blueprint changes. Actor Class limits an entry to one pawn class; a Blueprint child of the component gives it other defaults (e.g. another inventory layout). The entries are off by default. **Add to ** puts the component into the pawn Blueprint instead.
Component Settings with its entry What it does
Pulse Inventory Pulse > Inventory The items of the player: grid or slots, weight and other traits (Inventory system)
Pulse Equipment Pulse > Inventory Equipment slots and the hotbar (Equipment)
Pulse Item User Pulse > Inventory Effects Consumables with use time and cooldowns (Item effects)
Pulse Equipment Effects Pulse > Inventory Effects Stats of equipped items as gameplay effects (Item effects)
Pulse Crafting Pulse > Crafting Known recipes and the crafting queue (Crafting)
Pulse Combat Pulse > Combat Life, death and team (Damage and life)
Pulse Combat Equipment Pulse > Combat Inventory Weapons, armor, ammunition and durability (Combat and inventory)

Interaction

The interaction feature is driven by a gameplay ability:

  • UPulseInteractAbility

Minimal practical setup:

  1. Grant an interact ability to the owning ability system component.
  2. Ensure interactable targets implement IPulseInteractableInterface (actor or component).
  3. Call StartInteraction() / EndInteraction() from input flow (directly or via gameplay event trigger tags).
  4. Optionally bind a UI ViewModel (UMVVMPulseInteract) to present focused/selected/interacting state.

The plugin does not bind input. In Blueprints, Find Interact Ability (Pulse|Ability|Interact) returns the interact ability of a pawn for Start Interaction and End Interaction. A child of UPulseRepInteractAbility with Activate On Give activates itself when it is given to a locally controlled pawn; the example pawn gives it in Event Possessed and activates it in Event Receive Restarted as well, for clients that learn their controller after the ability arrived. See Interaction system.

Create

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

  • Item (UPulseItemDefinition, the main asset): An item type: size in the grid, stack size, icon, world mesh and traits (weight, equippable, weapon, consumable, durability).
  • Inventory Preset (UPulseInventoryLayoutPreset): A layout (grid or slots) with default traits such as a weight limit, for Initial Preset of inventories.
  • Loot Table (UPulseLootTable): Weighted entries with counts, conditions and nested tables, rolled for chests, enemies and rewards.
  • Recipe (UPulseRecipe): Ingredients, tools, outputs and crafting time; stations it needs and requirements.
  • Recipe Book (UPulseRecipeBook): Recipes that crafters learn together, from the component, the settings or at runtime.
  • Resource Node (UPulseResourceNodeDefinition): A tree, rock or bush players harvest by holding the interaction or with tool hits: tool, yield (a loot table), meshes of its stages, regrow time. Place Pulse Resource Node actors with it.
  • Map (UPulseMapDefinition): The map of a level for the minimap and the world map: picture, world area, zoom. Easiest: place a Pulse Map Actor, scale its box over the level and press Render Map; that makes the picture and this asset.
  • Status Effect UI Data (UPulseStatusEffectUIData): Icon, name and text per effect tag for the effect bar of the HUD; only gameplay effects with an entry show. List it in Project Settings > Pulse > Gameplay > Status HUD.
  • Merchant (UPulseMerchantDefinition): What a merchant sells and buys: currency, offers with price and stock that refills on the game clock, price rules. Put a Pulse Merchant component with it on an NPC or a shop.
  • Door (Blueprint of APulseDoor): A door that opens, closes, closes by itself and locks: frame, hinge and panel, the motion (turn or slide) and the key (conditions and costs). Place it in a level.
  • Melee Attack (UPulseAttackDefinition): A combo of steps: montage or timed hit windows, hit shapes or weapon sockets, damage and costs.
  • Projectile (UPulseProjectileDefinition): Speed, gravity, lifetime, piercing, area damage and look of a projectile for ranged attacks.
  • Hit Feedback (UPulseHitFeedbackDefinition): Camera shake, hit stop, screen vignette and vibration of hits, per damage type or strength.
  • HUD Layout (Blueprint of UPulseHUDLayout): A HUD of your own: stack containers and optional slots for compass, markers and notifications (see W_DefaultHUDWidget); set it as HUD Layout Class.
  • Frontend Menu (Blueprint of UPulseFrontendMenu): A main or pause menu of your own look, derived from the default main menu: entry list, screen stack and question; set it as Main Menu Class or Pause Menu Class in the frontend settings.
  • Starter content: A player pawn with every component and its keys, a training dummy that drops loot, a lever, a chest that fills its inventory, and the example items (sword, bow, arrows, bombs, potion, armor, ring, loot table). Add Starter Content copies it to /Game/Pulse/PulseGameplay.

Every asset has a page with the details:

Asset Page
Item Item definitions
Inventory Preset Presets
Loot Table Loot and random stats
Recipe, Recipe Book Crafting
Melee Attack Melee
Projectile Ranged
Hit Feedback Combat HUD
HUD Layout HUD system

Add > Pulse > Gameplay > Add Starter Content copies the content of the example map to /Game/Pulse/PulseGameplay: the player pawn with its interact ability, the training dummy, the lever, the chest with its items and the example items of /PulseGameplay/Combat/Examples (sword, bow, arrows, bombs, potion, fire armor, ring, loot table).

Examples on the docs pages

The pages Inventory system and Interaction system have examples (items, a preset, a chest, a lever). In the Pulse Docs tab of the editor, Create in project… creates them as assets; examples that use other examples create those as well.

Test

  • Play Example in the Pulse window opens /PulseGameplay/Examples/LV_PulseGameplay_Example and starts Play in Editor.
  • Then the cheat PulseGameplayGrant gives the player what the plugin needs.
  • The Pulse Debugger opens on its page Pulse.Live.
  • WASD and the mouse fly the pawn. E pulls the lever, the left mouse button attacks with the sword, the right one shoots the bow, 1 to 8 select the hotbar, Q uses the item of the active slot. The training dummy shows its health bar and drops loot. Trees and rocks stand left and right: the axe (4) chops trees, the pickaxe (5) mines rocks, by holding E or by hits. The minimap is in the top right corner, M opens the world map (drag, wheel, Space centers); PulseMapMarker adds a marker only maps show. E opens the doors behind the player start; the locked one needs the key that PulseGameplayGrant gives (PulseLocksGrant). PulseGameplayGrant gives the kit again, PulseHUDShowcase shows every HUD element, the Live page of the Pulse Debugger shows the components. The frontend has its own map (/PulseGameplay/Examples/Frontend/LV_PulseFrontend_Example, Standalone Game shows the loading screen); PulseFrontendPause opens the pause menu in PIE, where Escape ends the session.

The example map

The plugin brings an example map, /PulseGameplay/Examples/LV_PulseGameplay_Example (enable Show Plugin Content in the content browser). Its game mode uses BP_PulseGameplayExample_Pawn: a flying pawn (Default Pawn) with an ability system and every component of the table above, and these keys in its event graph:

Key Calls
E Start Interaction when pressed, End Interaction when released
Left mouse button Press Attack with the melee ability of the weapon in hand (press again for combos)
Right mouse button Press Attack / Release Attack with the ranged ability (hold to charge)
1 to 8 Request Select Hotbar Slot
Q Request Use Active Hotbar Item

In front of the player stand a lever (E pulls it and pushes it back), a chest that fills its inventory in Begin Play (the result is in the log) and a training dummy, BP_PulseGameplayExample_Dummy: an actor with an ability system, a combat component with the team Enemy, a health bar, hit reactions and a loot drop (DA_PulseExample_Loot); it gets back up 3 seconds after it died. Three trees stand to the left and two rocks to the right: hold E or hit them with the axe (slot 4) or the pickaxe (slot 5), see Gathering. A Pulse Map Actor covers the level: the minimap is in the top right corner and M opens the world map, see Map.

Play Example for Core in the Pulse window opens the map, starts Play in Editor and runs PulseGameplayGrant: the pawn gets a sword, a bow with arrows and potions on the hotbar slots 1 to 3, an axe on 4, a pickaxe on 5 and a crafter that knows every recipe. The cheat works with any pawn: it adds what is missing (ability system with health and stamina, combat, inventory, equipment, item effects, combat equipment, the interact ability). PulseHUDShowcase shows every element of the HUD (see Console); the Live page of the Pulse Debugger shows the components.

Check

  • Check in the Pulse window, Check All there (console Pulse.Check) or the commandlet -run=PulseCheck -Plugins=PulseGameplay checks the setup and validates every Item, Inventory Preset, Loot Table, Recipe, Recipe Book, Resource Node, Map, Status Effect UI Data, Merchant, Door, Melee Attack, Projectile, Hit Feedback, HUD Layout and Frontend Menu in the project.

Items, presets, loot tables (no cycles of nested tables), recipes, attacks and the other assets validate themselves when they are saved; Check does it for every asset of the project, together with the setup. Log categories, stats and cheats are listed in Console.


PulseGameplay plugin documentation.

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