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:
- The Interaction System (
PulseAbilitymodule), with prompts, holding, conditions and costs (PulseInteractUI) - The HUD System (
PulseHUDmodule), with world markers, tooltips and overlays - The Inventory System (
PulseInventorymodule), with crafting (PulseCrafting) - The Settings menu (
PulseSettingsmodule) - The Combat system (
PulseCombatmodule, on the Gameplay Ability System), with melee (PulseCombatMelee), ranged attacks (PulseCombatRanged) and the combat HUD (PulseCombatHUD) - The Frontend (
PulseFrontendmodule): title, main menu, loading screen and pause menu - Gathering (
PulseGatheringmodule): trees, rocks and bushes harvested by interaction or tool hits - Map (
PulseMapandPulseMapUImodules): map pictures rendered from levels, minimap and world map with the HUD markers - Death and respawn (
PulseRespawnandPulseRespawnUImodules): death screen, respawn points with teams and rules, death bags - Status effects and attribute bars (
PulseStatusHUDmodule): the active gameplay effects with icon, remaining time and stacks, bars for any attribute - Radial menu (in
PulseHUD): a radial menu for mouse and stick; pings for the team come with the add-on Pulse Ping - Doors and locks (
PulseLocksmodule): 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
- Getting started
- Interaction system
- HUD system
- Markers, tooltips and overlays
- Inventory system: equipment, loot and random stats, item effects, hotbar and item tooltips, crafting
- Gathering: resource nodes, tools, yield, regrowing
- Map: map image tool, map assets and sources, minimap, world map, markers on maps
- Death and respawn: death screen, respawn points, rules, death bags
- Status effects and attribute bars: effect bar, status effect UI data, view model, attribute bars
- Doors and locks: door component, motion, keys, auto close, saving
- Attributes: health, shield, stamina without combat; attributes on the game clock through Pulse Foundation
- Combat: damage and life, melee, ranged, combat HUD, combat and inventory
- Conditions, costs and rewards: items, equipment, loot, attributes, combat and interactions in the lists of every Pulse plugin
- HUD API reference
- Inventory and crafting API reference: item and recipe catalog, ids on the network
- Settings menu
- Frontend: title, main menu, loading screen, pause menu
- Console: cheats, stats and log categories
- Coming from PulseCore 1.x: what moved where
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:
- Set Up: turn on the HUD, give the player an ability system, add the components the game uses (or let them be added automatically).
- Create: items, inventory presets, loot tables, recipes, attacks, projectiles and hit feedback as data assets.
- Test: the example map with a ready player pawn, a lever, a chest and a training dummy;
PulseGameplayGrantgives any pawn what the plugin needs. - 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.