Console

Everything PulseGameplay adds to the Unreal console: console variables, commands, cheats, stats and log categories, including those of its bridges. The console completes the commands and cheats of this page (Config/Input.ini of the plugin).

Console variables

Most options of PulseGameplay are project settings (Project Settings > Pulse) and player settings (Settings menu).

Variable Default What it does
Pulse.Crafting.Instant 0 1: crafting rounds finish at once (testing, cheat). Rounds that already run keep their time.

Commands

Command Where What it does
stat Interact game Shows the time of the interaction queries and traces (not in shipping builds).
Pulse.Map.Render [Resolution] [Unlit] [/Game/Folder] editor Renders the open level from above into its map (area of the Pulse Map Actor, see Map).

Cheats

Cheats work in builds with cheats (not in shipping builds). In PIE the server can use them right away, a client types EnableCheats first. Runs on: server cheats change server state; typed on a client, they are sent to the server. Local cheats act on the game of the player who typed them. In the editor, Pulse.PIE.Exec <instance> <cheat> runs a cheat as the player of a PIE instance (0 = server, 1 = first client).

Everything at once

Cheat Runs on What it does
PulseGameplayGrant server Gives the pawn what PulseGameplay needs (ability system with health and stamina, combat, inventory, equipment, item effects, combat equipment, the interact ability, a crafter that knows every recipe) and a test kit from /PulseGameplay/Combat/Examples: sword, bow with arrows and potions on the hotbar slots 1 to 3, an axe on 4 and a pickaxe on 5 (PulseGatheringGrant). Play Example runs it.

Interaction

See Interaction system.

Cheat Runs on What it does
PulseInteractGrant [ability class name or path] server Gives the pawn an interact ability.
PulseInteractSpawnTest [hold seconds] [cooldown seconds] server Spawns a test interactable in front of the player.
PulseInteractStart local Presses the interaction like its key: starts interacting with the selected interactable; with “Toggle instead of hold” a press during a hold cancels it.
PulseInteractEnd local Releases the interaction like its key: ends it or cancels a hold; with “Toggle instead of hold” the hold goes on.
PulseInteractInfo local Prints the selected interactable, its interaction info and the hold progress.
PulseInteractSendStart far\|pawn\|mesh\|any [class] local Testing only: sends the server a start with the nearest test interactable wherever it is (far), with the own pawn as its actor (pawn: a component of another actor), with its mesh (mesh: no interactable interface) or with the nearest interactable of any kind (any: a door, a pickup; class is a part of the class name, such as PulseDoor); the server log (LogPulseInteract Verbose) says why it was ignored.

HUD

See HUD system and Markers, tooltips and overlays.

Cheat Runs on What it does
PulseHUDToast <text> local Shows a Pulse HUD notification.
PulseHUDModal <title> local Opens a Pulse HUD confirm modal and prints its result.
PulseHUDToggle local Hides or shows the Pulse HUD.
PulseHUDProgress <percent> local Opens or updates a cancellable progress overlay; below 0 shows unknown progress.
PulseHUDProgressClose local Closes the progress overlay of PulseHUDProgress.
PulseHUDSubtitle <text> local Shows a subtitle.
PulseHUDHint <text> local Shows a tutorial hint that highlights the compass.
PulseHUDContextMenu local Opens a context menu at the mouse and prints the result.
PulseHUDTooltip [text] local Shows a tooltip at the mouse or hides it.
PulseHUDRadial local Opens a radial menu with two levels (mouse or stick, click to choose) and prints the chosen entry.
PulseHUDShowcase [1] local Shows the HUD scene of the default theme at once: notifications, hint, subtitle and markers of the marker registry; with 1 also a progress overlay and a tooltip. Test markers: PulseUIMarker of PulseFoundation.

Settings menu

See Settings menu.

Cheat Runs on What it does
PulseSettingsOpen local Opens the Pulse settings screen.
PulseSettingsList local Prints all Pulse player settings with their values.
PulseSettingsSet <setting id> <value> local Changes a Pulse player setting.

Frontend

See Frontend. Needs the frontend turned on.

Cheat Runs on What it does
PulseFrontendPhase local Prints the phase, the open menu with its entries and screen, the loading screen and whether the game is paused.
PulseFrontendPause local Opens or closes the pause menu (also in PIE, where Escape ends the session).
PulseFrontendEntry <id> local Picks an entry of the open main or pause menu as if it was clicked, e.g. PulseFrontendEntry Settings.
PulseFrontendBack local Goes one step back in the open menu: the question, the screen, the pause menu.
PulseFrontendLoading [seconds] local Shows the loading screen for a while (default 3) without loading.
PulseFrontendMainMenu local Goes back to the frontend map.

Map

See Map.

Cheat Runs on What it does
PulseMapInfo local Prints the map of the world, where it comes from (Set Map, map actor, settings, provided) and where the player is on it; for maps in tiles also the tiles (known, with picture, old, running).
PulseMapSet [map] local Sets the map of this machine (name or path of a map asset); without a name back to the map actor and the settings.
PulseMapOpen local Opens or closes the world map.
PulseMapMarker [north m] [east m] local Adds a marker of the marker registry only maps show (channel Map), relative to the player (default 20 m north).
PulseMapMarkersClear local Removes the markers added with PulseMapMarker.
PulseMapPath [north m] [east m] local Adds a dashed path of the path register from the player to a point relative to it (default 40 m north), on the minimap and the world map; the path before it fades out.
PulseMapPathClear local Removes the path of PulseMapPath (it fades out).
PulseNavGameplayInfo local With PulseNavGameplayBridge: the guide of the player, the route on the maps (points, opacity), the waypoint marker and the destinations from the world map.
PulseNavGameplayClick [north m] [east m] local With PulseNavGameplayBridge: clicks the world map relative to the player (default 30 m north) with the first destination key, so the guide gets that destination.

Inventory, equipment and loot

See Inventory system, Equipment and Loot.

Cheat Runs on What it does
PulseInventoryGive <item id or path> [count] server Gives items to the player’s inventory. The item is an id of the item catalog (Sword, PulseItem:Sword, also items made at runtime) or a path; an unknown item prints the known ids.
PulseInventoryItems [filter] local Prints the ids of every item of the catalog and of the items registered at runtime.
PulseInventoryMakeItem <name> <template> local Makes an item at runtime on this machine: a copy of the template item named <name>, registered as PulseItem:<name>. Run it on every machine that needs the item (Pulse.PIE.Exec on each PIE instance).
PulseInventoryClear server Removes all items from the player’s inventory.
PulseInventoryRequest <move\|remove\|use\|drop> <item or stack id> [x or count] [y] local Asks for a change like the UI does: on a client a request with an id to the server; prints the result and its text when the answer comes.
PulseMerchantSpawn <currency> <Item:Price:Stock[:Count],...> server Spawns a test merchant 3 m in front of the player with the given offers (stock -1 unlimited, Count items per purchase, 1 if left out, restock after 1 hour, an hour of the day with Hour Unit Day Hour); it buys items with a value.
PulseInventoryBuy <offer> [purchases] server Buys from the nearest merchant (20 m) into the player’s inventory and prints the price and the result.
PulseInventorySell <item id> [count] server Sells items of the player’s inventory to the nearest merchant.
PulseInventoryUndoTest <item id> [count] server Test: gives the player one worn stack of the item (durability 40 of 100), takes count of the item (all if left out) from the player’s inventory in an exchange that then fails on purpose, and prints the stacks of the item before and after the undo (id@x,y:count:worn\|unworn).
PulseMerchantInfo the machine of the player Prints the offers of the nearest merchant with price and stock.
PulseInventoryAge <hours> server Lets the perishable items of the player’s inventory age by hours of the shelf life (hours of the day with Hour Unit Day Hour), spoils what is due and prints the freshness of each stack.
PulseInventoryGrant [size] server Gives the pawn an inventory and equipment.
PulseInventoryEquip [item id\|any] [slot] server Equips an item of the inventory.
PulseInventoryUnequip <slot> server Puts an equipped item back.
PulseInventoryHotbar <1-8\|next\|prev> local Selects a hotbar slot.
PulseInventoryEquipment local Prints the equipment of the player.
PulseEquipmentRequest <equip\|equipnear\|unequip\|select> <item, stack or slot> [slot] local Asks for an equipment change like the UI does: on a client a request with an id to the server; prints the result and its text. equipnear equips a stack (stack id or item id) out of the nearest other inventory within 10 m, such as a death bag.
PulseLootRoll <table> [seed] [drop] server Rolls a loot table into the inventory or in front of the player.

Inventory UI and item effects

See Inventory UI and Item effects.

Cheat Runs on What it does
PulseInventoryUse <item\|hotbar> server Uses a consumable.
PulseInventoryCancelUse server Cancels the current use of an item.
PulseItemUseRequest <item\|hotbar\|cancel> local Asks for a use like the UI does: on a client a request with an id to the server; prints the result and its text.
PulseInventoryStats local Prints the stats of the equipped items and the health of the pawn.
PulseInventoryUITooltip <item> [seed] local Shows the item tooltip of an item at the mouse, or hides it when it is shown.

Crafting

See Crafting.

Cheat Runs on What it does
PulseCraft <recipe> [count] server Crafts a recipe (id of the recipe catalog, R_Axe or PulseRecipe:R_Axe, or a path) at the nearest suitable station in range, or by hand (adds Pulse Crafting to the pawn if missing).
PulseCraftingUnlock <recipe\|book\|all> server Unlocks a recipe or the recipes of a book by id, or every recipe of the recipe catalog.
PulseCraftingSpawnStation [tags] [speed] server Spawns a test station in front of the player (tags comma separated, default Pulse.Crafting.Station).
PulseCraftingCancel server Cancels every job of the player; the ingredients come back.
PulseCraftingInfo server Prints the known recipes, whether they can be crafted (and why not) and the queue.
PulseCraftRequest <recipe\|cancel> [count] local Asks to craft like the UI does: on a client a request with an id to the server (the recipe goes as its id); prints the result and its text.

Gathering

See Gathering.

Cheat Runs on What it does
PulseGatheringGrant server Puts the example tools into the equipment: an axe on hotbar slot 4, a pickaxe on slot 5 (needs an inventory and equipment, e.g. after PulseGameplayGrant).
PulseGatheringHarvest server Harvests the nearest resource node within 5 m for the player (tool rules apply).
PulseGatheringRegrow server Every resource node grows back at once.
PulseGatheringSpawn <definition> server Spawns a resource node 3 m in front of the player (name or path of a definition).
PulseGatheringInfo local Prints the nearest resource node: harvests left, stage, and whether the player can harvest it (or why not).

Respawn

See Death and respawn.

Cheat Runs on What it does
PulseRespawnGrant server A respawn component on the player controller and a respawn point at the pawn when the level has none (PulseGameplayGrant calls it).
PulseRespawnSetup server Adds a respawn component to the player controller and a revive component (downed mode) to its pawn.
PulseRespawnSpawnPoint <team, none, mine or minedeferred> server Spawns a respawn point where the pawn stands, for a team (Player, Enemy, a tag), every player, or as a bed of the player (mine: owner set after the spawn; minedeferred: before FinishSpawning).
PulseRespawnDie [cause] server Sets the player dead without damage through HandlePlayerDied (also for the death source Manual); the cause is a tag or a name below Pulse.Respawn.Cause (default Cheat), shown on the death screen.
PulseRespawnForce [point id] server Respawns the player now through ForceRespawn: no delay, no checks of the choice, no respawn conditions, also a living player; prints the result (refused after a permanent death: “Your death is permanent.”).
PulseRespawnNow [point id] local, request to the server Respawns the dead player like the death screen: at the point, or where the rule picks; prints the result (refused after a permanent death).
PulseRespawnTeam <team or none> server Sets the team of the player (adds a team component to the player state when there is no team source).
PulseRespawnTravel <point id> server Brings the living player to a respawn point (needs Allow Travel in the settings); prints the result.
PulseRespawnTakeBag server Empties the nearest death bag within 10 m into the player’s inventory, if the player is its owner or in its team.
PulseRespawnBagRequest local Testing only: asks the server through the inventory access component to move the first stack of the player’s own death bag into its inventory, at any distance (the server refuses it beyond Death Bag Reach or out of sight). Without an access component the server adds one first; run it again.
PulseRespawnDown [Force] server Damage that empties the player’s health: it goes down when the downed rules allow it (else it dies); Force skips the rules and the switch (ForceDown).
PulseRespawnRevive server Gets the downed player up at once (CompleteRevive without a reviver).
PulseRespawnReviveNearest server The player’s pawn starts to revive the nearest downed teammate (as holding the interaction; range and team are checked).
PulseRespawnGiveUp server The downed player gives up and dies (GiveUp).
PulseRespawnInfo local Prints the respawn state (with killer and cause while dead, “dead for good” after a permanent death, bleed-out and reviver while down), the downs, whether permadeath is on, the team, the points and the death bags (and whether they are the player’s).

Log categories LogPulseRespawn and LogPulseRespawnUI; the respawn component, the point subsystem and the death screen subsystem are snapshot providers (category Respawn, also the down: bleed-out, who downed and who revives), deaths, respawns, bags, downs, revives (started, stopped, done) and refused downs are timeline events.

Locks

See Doors and locks.

Cheat Runs on What it does
PulseLocksGrant server The example key DA_PulseExample_Key in the inventory (PulseGameplayGrant calls it).
PulseLocksSpawnDoor [Locked] server Spawns a Pulse Door 2 m in front of the player; Locked locks it (any key with a Pulse.Locks.Key tag opens it).
PulseLocksInteract [door] server Interacts with a door as this player, like the interaction: unlocks with the key and opens, closes or opens. Door by actor name or label, else the nearest within 10 m.
PulseLocksAction <Open\|Close\|Lock\|Unlock\|Pick> [door] server Does an action without a key, like a script.
PulseLocksInfo local Prints every door of this machine: open or closed, lock, how far it is open.

Log category LogPulseLocks; every door component is a snapshot provider (category Locks), door actions are timeline events.

Status HUD

See Status effects and attribute bars.

Cheat Runs on What it does
PulseStatusHUDApply <tag> [seconds] [stacks] server Applies an example status effect (short names below Pulse.StatusHUD.Example: Burning, Poisoned, Regeneration, or a full tag); 0 seconds = 10 s, negative = until cleared.
PulseStatusHUDClear server Removes the example status effects of the pawn.
PulseStatusHUDBar <attribute> [name] local Adds an attribute bar to the HUD of this player: an attribute tag (Pulse.Stat.Stamina) or a short name below Pulse.Stat (Stamina); without a name the name of the stat register.
PulseStatusHUDBarRemove <id> local Removes an attribute bar added at runtime (id = the attribute tag unless the bar has its own).
PulseStatusHUDInfo local Prints the shown status effects with their time left and the attribute bars.

Log category LogPulseStatusHUD; the status HUD subsystem is a snapshot provider (category StatusHUD).

Combat

See Combat and Damage and life.

Cheat Runs on What it does
PulseCombatGrant [max health] [stamina] server Makes the pawn a combatant (ability system, health set, combat component); a player without team gets a team component with Pulse.Team.Player.
PulseCombatDamage <amount> [type] [target] server Damages the player or the soft target.
PulseCombatHit <amount> [type] server The player hits the combatant in front.
PulseCombatHeal <amount> [target] server Heals the player or the soft target.
PulseCombatKill [target] server Kills the player or the soft target.
PulseCombatRevive [target\|all] server Revives the player, the soft target or all.
PulseCombatGod server Toggles invulnerability of the player.
PulseCombatTag <Blocking\|Invulnerable\|tag> [target] server Toggles a combat state tag.
PulseCombatSpawnDummy [max health] [shield] [team\|none] [distance] server Spawns a training dummy in front of the player; team is a tag under Pulse.Team (Enemy, Player) or a full tag.
PulseCombatInfo [target] local Prints health, state and last damage.
PulseCombatLockOn local Toggles the lock-on of the local player.

Melee and ranged attacks

See Melee and Ranged.

Cheat Runs on What it does
PulseCombatGiveMelee [attack definition path] server Gives the pawn the melee attack.
PulseCombatAttack [combo\|server] server Presses the melee attack (again for combos).
PulseCombatGiveRanged [charge\|hitscan\|grenade\|definition path] server Gives the pawn a ranged attack.
PulseCombatFire [release] local Presses the ranged attack.
PulseCombatFireOffset <x> <y> <z> local Testing: the shots this client sends carry their origin moved by the offset (cm), then fires; the server refuses or clamps it (log LogPulseCombatRanged). 0 0 0 ends it.
PulseCombatSpawnTurret server Spawns a turret that shoots at the nearest enemy.

Combat HUD

See Combat HUD.

Cheat Runs on What it does
PulseCombatShowcase local + server Shows the combat HUD: spawns a dummy on the server, hits it with every damage type, a critical hit and a heal, lets it hit you and shows its boss bar.
PulseCombatBossBar [remove] local Shows the boss bar of the nearest combatant.
PulseCombatHurtFrom [amount] server The nearest combatant hits you.

Combat with items

See Combat and inventory.

Cheat Runs on What it does
PulseCombatInventorySetup [max health] server Makes the pawn ready for combat with items.
PulseCombatWear <slot> [amount] server Wears an equipped item.
PulseCombatRepair <slot> server Repairs an equipped item.
PulseCombatLootOnDeath <table> server The nearest combatant drops a loot table when it dies.
PulseCombatEquipmentInfo local Prints weapons, ammunition, durability and combat modifiers of the player.

State in the console

The snapshot providers of PulseGameplay (categories HUD, Inventory, Equipment, Combat, Frontend) also print to the console, through the cheats of PulseFoundation: PulseDebugDump HUD writes their state to the log, PulseDebugProviders lists all providers of the world. The same state is on the Live page of the Pulse Debugger (Pulse.Debugger Live).

Log categories

Category What it logs
LogPulseHUD HUD layout, stacks, modals, notifications, markers (the input manager logs to LogPulseUI of PulseFoundation).
LogPulseSettings Settings screen and its entries.
LogPulseFrontend Frontend phases, menu entries, the loading screen, the pause menu.
LogPulseAbility Abilities of the module PulseAbility; interactions that complete with failed conditions or costs.
LogPulseInteract Interaction: queries, focus, holding.
LogPulseInteractUI Interaction prompt widget.
LogPulseInventory Inventory, equipment, pickups, loot tables.
LogPulseInventoryInteract Pickups that are picked up by interaction.
LogPulseInventoryUI Hotbar and item tooltip widgets.
LogPulseInventoryEffects Consumables and effects of equipped items.
LogPulseAttributes Health, shield and stamina sets and their mappings.
LogPulseCombat Damage, death and revive, teams, targeting.
LogPulseCombatMelee Melee attacks and hit detection.
LogPulseCombatRanged Projectiles, hitscan, ranged attacks.
LogPulseCombatHUD Health bars, damage numbers, boss bar, hit feedback.
LogPulseCombatInventory Weapons, ammunition, durability, loot on death.
LogPulseMap Which map a world uses (Verbose), more than one map actor, maps of the settings that do not load.
LogPulseMapUI Minimap that cannot be added to the HUD, world map that cannot open.
LogPulseStatusHUD Effect bar or attribute bars that cannot be added to the HUD, attribute bars without attribute.
LogPulseGathering Harvests (items, harvests left, tool durability), broken tools, regrowing (Verbose), refused harvests (Verbose).
LogPulseGameplaySaveBridge Bridge PulseGameplaySaveBridge: saving inventories and equipment with PulseSave, Continue and loads that open the level of the save (level, slot, result).

Change the verbosity at runtime with Log <Category> <Verbosity>, e.g. Log LogPulseHUD Verbose (Log LogPulseHUD Log goes back to the default). For a whole run: -LogCmds="LogPulseHUD Verbose" on the command line, or LogPulseHUD=Verbose in the section [Core.Log] of DefaultEngine.ini.


PulseGameplay plugin documentation.

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