Console

Everything PulseWater adds to the Unreal console: console variables, commands, cheats, stats and log categories.

Console variables

Variable Default What it does
Pulse.Water.Quality -1 Quality level of Pulse Water: index into the quality levels of the project settings (0 = lowest); -1 follows the effects quality of the engine (sg.EffectsQuality). Scalability variable.
Pulse.Water.Ocean.MaxLevels 16 Maximum number of clipmap levels of the ocean. Changes apply when the ocean is rebuilt. Scalability variable.
Pulse.Water.Ripples.Enable 1 0 turns the simulation of ripples and wakes off.

Scalability variables can also be set per quality level in the scalability config of the project. How the quality levels work is on Getting started.

Commands

Command Where What it does
Pulse.Mode PulseWater [Ocean\|Probe\|Fluid] editor Opens the Pulse Water mode on a tool (a command of Pulse Foundation).
Pulse.Debugger PulseWater.Water editor Opens the Water page of the Pulse Debugger: server and clients side by side (a command of Pulse Foundation).
Pulse.Views PulseWater.Probes [on\|off] PIE window Shows or hides the pinned probes in this PIE window (on in every new one; a command of Pulse Foundation).
Pulse.Views PulseWater.Depth\|Source\|Flow\|BakeDiff\|TerrainCover\|Network [on\|off] editor, PIE window Shows or hides a view of the water in the active level viewport or in this PIE window (a command of Pulse Foundation).
Pulse.Water.Dev.ExportNiagaraGraph <Script> <File>, Pulse.Water.Dev.ImportNiagaraGraph <Script> <File> editor For the development of the plugin: write the graph of a Niagara script to a text file and back. Tools/build_water_niagara.py builds the Niagara modules with them.
stat PulseWater game Shows the time of boat movement, hulls, ripples, splashes, floating instances, water audio and water queries, and how many boat moves and query points there were (not in shipping builds). Boat Corrections counts the corrections the server sends to driving clients per frame; it should stay at 0.

Cheats

Cheats run in the game console of a player (in Play In Editor in a player window, or with Pulse.PIE.Exec <instance> <cheat> in the editor console). On a client most of them are sent to the server, which acts on the boat nearest to the view of that player. A network client types EnableCheats first; Pulse.PIE.Exec does that itself.

Cheat What it does
PulseWaterWave [distance] [lifetime] Starts a ring wave in front of the view (default 1000 cm ahead, 8 s) on the server, which sends it to the clients near it.
PulseWaterWaves Prints the ring waves this machine knows (runs where it is typed, also on a client): id, origin, age.
PulseWaterBoatDamage [damage] [all] Damages the boat below its waterline on the left side (default 200), or every boat with all.
PulseWaterBoatInfo Prints the hull: health, water inside, inflow and leaks.
PulseWaterBoatRepair Repairs the boat completely and pumps it dry.
PulseWaterGrant [boat] Puts a boat on the water in front of the view: ten meters ahead, or, seen from a bank, in the middle of the water farther (up to 40 m) or nearer (a river, a pond). The sail boat of the plugin (empty or sail), the test boat (test) or the boat Blueprint at a path. The grant cheat of the Pulse workflow.

See Boats for leaks and repairs.

Cheats of the bridges:

Cheat Bridge What it does
PulseWaterGameplayGrant [count] PulseWaterGameplayBridge Gives the player wood of the PulseGameplay example (default 30) for the boat of the shipyard example and its repairs (server). See Shipyard and repairs.

State in the console

The snapshot providers of PulseWater (category Water) also print to the console, through the cheats of PulseFoundation: PulseDebugDump Water 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):

  • the water subsystem: water time, render origin, quality level, the ocean (sea level, wave set, terrain cover), the environment and terrain providers and how many water bodies, zones, exclusion volumes, ring waves, wave event cells and query points of the last frame there are;
  • every boat: role, driver, speed, controls, unconfirmed moves, the corrections sent (server) or received (driving client), the moves replayed and the last correction;
  • every hull: health, water inside, inflow, leaks (shown as red spheres), wrecked, sunk, capsized;
  • every floating object (buoyancy): in the water, submerged, pontoons.

The timeline of the Pulse Debugger shows when ring waves start, when hulls take damage, are wrecked or sink, and when the server corrects the driver of a boat (source Water). The Water page of the debugger puts the server and the clients side by side. Messages of the message bus are on the Messages page.

Log categories

Category What it logs
LogPulseWater Ocean, water bodies, waves and time, quality levels; with Verbose every ring wave that arrives on a client.
LogPulseWaterPhysics Buoyancy and water queries of physics objects.
LogPulseWaterBoat Boats: movement, hull, leaks, repairs.
LogPulseWaterCharacter Swimming characters.
LogPulseWaterLandscape Terrain shaping on a Landscape: patch layer, patches per water body, commits (editor only).

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


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