PulseGameplay Unreal Engine Plugin

This documentation describes the current codebase implementation of the PulseGameplay plugin (VersionName: 1.0.0 in PulseGameplay.uplugin), with a focus on:

  1. The Interaction System (PulseAbility module), with prompts, holding, conditions and costs (PulseInteractUI)
  2. The HUD System (PulseHUD module), with world markers, tooltips and overlays
  3. The Inventory System (PulseInventory module), with crafting (PulseCrafting)
  4. The Settings menu (PulseSettings module)
  5. The Combat system (PulseCombat module, on the Gameplay Ability System), with melee (PulseCombatMelee), ranged attacks (PulseCombatRanged) and the combat HUD (PulseCombatHUD)
  6. The Frontend (PulseFrontend module): title, main menu, loading screen and pause menu
  7. Gathering (PulseGathering module): trees, rocks and bushes harvested by interaction or tool hits
  8. Map (PulseMap and PulseMapUI modules): map pictures rendered from levels, minimap and world map with the HUD markers
  9. Death and respawn (PulseRespawn and PulseRespawnUI modules): death screen, respawn points with teams and rules, death bags
  10. Status effects and attribute bars (PulseStatusHUD module): the active gameplay effects with icon, remaining time and stacks, bars for any attribute
  11. Radial menu (in PulseHUD): a radial menu for mouse and stick; pings for the team come with the add-on Pulse Ping
  12. Doors and locks (PulseLocks module): doors that open, close, close by itself and lock, keys as Pulse conditions and costs

The plugin is split into these modules:

  • PulseAbility (runtime)
  • PulseHUD (runtime)
  • PulseInventory (runtime)
  • PulseInventoryInteract (runtime)
  • PulseInventoryEffects (runtime)
  • PulseCrafting (runtime)
  • PulseInteractUI (runtime)
  • PulseAttributes (runtime)
  • PulseCombat (runtime)
  • PulseCombatMelee (runtime)
  • PulseCombatRanged (runtime)
  • PulseCombatInventory (runtime)
  • PulseCombatHUD (runtime)
  • PulseInventoryUI (runtime)
  • PulseSettings (runtime)
  • PulseFrontend (runtime)
  • PulseGathering (runtime)
  • PulseMap (runtime)
  • PulseMapUI (runtime)
  • PulseRespawn (runtime)
  • PulseRespawnUI (runtime)
  • PulseStatusHUD (runtime)
  • PulseLocks (runtime)
  • PulseEditor (editor)

Documentation structure

At a glance

Step In this plugin
Set Up 2 required (Set “Enable HUD” to True (Project Settings > Pulse > Gameplay > HUD); Give every item, recipe and recipe book its own asset name), 34 optional
Create Item, Inventory Preset, Loot Table, Recipe, Recipe Book, Resource Node, Map, Status Effect UI Data, Merchant, Door, Melee Attack, Projectile, Hit Feedback, HUD Layout, Frontend Menu; starter content
Test Example map LV_PulseGameplay_Example, cheat PulseGameplayGrant
Check Pulse window, Check All, -run=PulseCheck

In more detail:

  1. Set Up: turn on the HUD, give the player an ability system, add the components the game uses (or let them be added automatically).
  2. Create: items, inventory presets, loot tables, recipes, attacks, projectiles and hit feedback as data assets.
  3. Test: the example map with a ready player pawn, a lever, a chest and a training dummy; PulseGameplayGrant gives any pawn what the plugin needs.
  4. Check: every asset validates itself; Pulse Check runs them all with the setup.

PulseGameplay needs the free plugin PulseFoundation (1.0 or newer). The helper module PulseGameCore lives there now: see the PulseFoundation documentation and its Pulse helpers API reference.

Scope and accuracy

This documentation is based on the current classes, interfaces, enums, tags, settings, and runtime flow found in the plugin source under Source/.
No undocumented or speculative features are introduced here.


PulseGameplay plugin documentation.

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