PulseCore Unreal Engine Plugin

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

  1. The Interaction System (PulseAbility module), with prompts, holding and requirements (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)

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)
  • PulseEditor (editor)

Documentation structure

At a glance

Step In this plugin
Set Up 1 required (Set “Enable HUD” to True (Project Settings > Pulse > HUD)), 19 optional
Create Item, Inventory Preset, Loot Table, Recipe, Recipe Book, Melee Attack, Projectile, Hit Feedback, HUD Layout; starter content
Test Example map LV_PulseCore_Example, cheat PulseCoreGrant
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; PulseCoreGrant gives any pawn what the plugin needs.
  4. Check: every asset validates itself; Pulse Check runs them all with the setup.

PulseCore 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.


PulseCore plugin documentation.

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