Console
Everything PulseOnline 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
PulseOnline has no console variables; its options are project settings. The backend can also be picked on the command line: -PulseOnlineBackend=Mock (see Backends).
Commands
Server console commands (on a dedicated server, or in PIE with Pulse.PIE.Exec 0 ...):
| Command | Where | What it does |
|---|---|---|
Pulse.Online.Server.Admin <command> | server | Runs an admin command on this server (help lists them); see Server Browser and Administration. |
Pulse.Online.Server.Parameters | server | Lists the start parameters of the server with their values (secrets masked). |
Cheats
Module PulseOnlineDebug adds cheats. They act on the game instance of the player who typed them (local); some of them say that they only work on the server or with the Mock backend.
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).
Backend and users
See Users and Login and Backends.
| Cheat | Runs on | What it does |
|---|---|---|
PulseOnlineGrant [Mock\|OSS\|OSSv2\|Auto\|Current] | local | Switches to the Mock backend (or the named one; Current keeps the active backend; OSSv2 needs the add-on PulseOnlineOSSv2, without it the cheat says so), logs the local player in and shows the default widgets. Play Example runs it. |
PulseOnlineBackend <Mock\|OSS\|OSSv2\|Auto> | local | Switches the backend of this game instance (Auto: automatic choice; OSSv2 needs the add-on PulseOnlineOSSv2, without it the cheat says so). |
PulseOnlineLogin [Online\|Local] | local | Logs the local player in. |
PulseOnlineLogout | local | Logs the local player out. |
PulseOnlineStatus | local | Prints backend, services with their source (backend, extension, provider, runtime), platforms, users, the game session and the party lobby (with the source of the game session and lobby service), the party transport (Beacon or the backend’s, connected or not) and the matchmaker (service with its source, or the session search). |
PulseOnlineFailNext <Operation> [ErrorId] | local | Mock backend: the next call of an operation fails (see Backends). |
Stats and leaderboards
| Cheat | Runs on | What it does |
|---|---|---|
PulseOnlineStat <Name> <Value> [Sum\|Set\|Largest\|Smallest] | local | Writes a stat of the local user. |
PulseOnlineStats <Name>[,<Name>...] | local | Reads stats of the local user and prints them. |
PulseOnlineLeaderboard <Id> [Top\|AroundUser\|Friends] [Count] | local | Reads a leaderboard and prints it. |
Matchmaking
See Matchmaking.
| Cheat | Runs on | What it does |
|---|---|---|
PulseOnlineMatchmake [Queue] | local | Starts matchmaking (queue tag or asset path; empty: debug queue Pulse.Online.Queue.Debug). |
PulseOnlineMatchmakeCancel | local | Cancels the running matchmaking. |
PulseOnlineRating [Queue] | local | Reads and prints the rating of the local player. |
PulseOnlineReportMatch [Queue] [WinnerTeam] [Force] | local | Server: rates a match of all connected players (team = index modulo team count); Force also on listen servers. |
PulseOnlineSimulateQueue [Queue] [Players] [Matches] | local | Simulates a queue and writes a report to Saved/PulseOnline/Matchmaking. |
Connection and servers
See Connection and Reconnect and Server Browser and Administration.
| Cheat | Runs on | What it does |
|---|---|---|
PulseOnlineConnection | local | Prints the connection status, NAT type and the last session. |
PulseOnlineRejoin | local | Rejoins the last game session. |
PulseOnlineServers [Dedicated\|Lobbies] [NamePart] | local | Refreshes and prints the server list. |
PulseOnlineJoinServer <Index> [Password] | local | Joins a server of the printed list. |
PulseOnlineFavourite <Index> | local | Adds a server of the list to the favourites or removes it. |
PulseOnlineAdmin <command> | local | Admin command: directly on a server, through the server on an admin client (help lists them). |
Chat and safety
See Chat and Safety.
| Cheat | Runs on | What it does |
|---|---|---|
PulseOnlineParty [Create\|Invite <player>\|Accept\|Overlay [player]\|Host [level]\|Leave] | local | The party without the widgets: creates one, invites a friend or a player of the match (name, name start or #index), accepts the first invite, joins the party of a player of another PIE window as through the platform overlay (Mock backend), hosts a game for the party (HostPartyGame, the current level if none is given), leaves; without an action prints the party (state, members, transport). |
PulseOnlineVoice [Talk\|Stop\|PTT <1\|0>\|Mute <player>] | local | Voice of the player: without an action prints the channels, push to talk and every voice route (with the mock voice also what the mock plays); Talk and Stop simulate speech (mock voice), PTT holds or releases push to talk, Mute mutes a player of the match or unmutes it. |
PulseOnlineChat <Session\|Team\|Party> <text> | local | Sends a chat message. |
PulseOnlineWhisper <player> <text> | local | Whispers to a player of the match (name, name start or #index). |
PulseOnlineChatHistory | local | Prints the last chat messages. |
PulseOnlineBlock <player\|list> | local | Blocks or unblocks a player of the match, or lists the block list. |
PulseOnlineReport <player> <message> | local | Reports a player of the match. |
PulseOnlineSanctions [player] | local | Reads and prints active sanctions. |
PulseOnlineMockSanction <player> <action> [minutes] | local | Mock backend: gives a player a sanction. |
PulseOnlineRecentPlayers | local | Prints the recent players. |
Cloud storage
See Cloud Storage.
| Cheat | Runs on | What it does |
|---|---|---|
PulseOnlineFiles [Title\|User] | local | Lists the title or user files with size, time, version and hash. |
PulseOnlineReadFile <Title\|User> <Name> | local | Reads a file and prints its info and start. |
PulseOnlineWriteFile <Name> <Text> [IfMissing\|IfVersion <Version>] | local | Writes a user file, optionally with a condition (Cloud Storage); a condition that does not hold prints the Conflict; IfVersion without a version prints the usage. |
PulseOnlineDeleteFile <Name> | local | Deletes a user file. |
PulseOnlineMockTitleFile <Name> <Text> | local | Mock backend: sets a title file. |
PulseOnlineRemoteConfig | local | Prints the remote config. |
User content
See User Content.
| Cheat | Runs on | What it does |
|---|---|---|
PulseOnlineContent [List\|Subscribe <Id>\|Unsubscribe <Id>\|Download <Id>\|Installed\|Upload <Folder>] | local | Lists items, subscribes, downloads, lists the installed items or uploads a folder (relative to the project) as a new item. |
Anti-cheat
See Anti-Cheat.
| Cheat | Runs on | What it does |
|---|---|---|
PulseOnlineAntiCheat [List\|Violate <Player>] | server | Lists the clients of the anti-cheat, or reports a violation of a player (name, net id or #<handle>), who is kicked with the reason. |
Entitlements and store
| Cheat | Runs on | What it does |
|---|---|---|
PulseOnlineEntitlements | local | Reads and prints the entitlements of the local user. |
PulseOnlineOffers [OfferId,OfferId] | local | Reads and prints store offers (empty: offers of the products, or all). |
PulseOnlinePurchase <OfferId\|ProductTag> [Quantity] | local | Buys an offer or a product. |
PulseOnlineOwns <ProductTag\|ItemId> | local | Prints whether the local user owns a product or item. |
PulseOnlineMockGrant <ItemId> [Quantity] | local | Mock backend: gives the local user an entitlement. |
UI
See UI Widgets.
| Cheat | Runs on | What it does |
|---|---|---|
PulseOnlineShowUI [All\|LoginStatus,Friends,Party,Servers,Invite\|Hide] | local | Shows the default online widgets on the screen of the local player. |
With PulseOnlineHUDBridge
| Cheat | Runs on | What it does |
|---|---|---|
PulseOnlineHUDTest <Invite\|Reconnect\|Reconnected\|ReconnectFailed\|Lost\|Bad\|Removed> | local | HUD bridge: shows one of its messages without a real invite or disconnect. |
With PulseOnlineSaveBridge
The bridge has no cheats of its own. Its cloud is the second storage of a mirror of PulseSave, so the mirror cheats of PulseSave work on it: PulseSaveMirror [Sync|Status] [Game|Profile] and PulseSaveMirrorResolve <Slot> <Primary|Secondary> [Game|Profile] (see Cloud Saves).
State in the console
The snapshot providers of PulseOnline (category Online) also print to the console, through the cheats of PulseFoundation: PulseDebugDump Online 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 |
|---|---|
LogPulseOnline | Requests, users, backend choice. |
LogPulseOnlineOSS | The OSS backend (online subsystem, e.g. EOS). |
LogPulseOnlineMock | The Mock backend. |
LogPulseOnlinePresence | Rich presence. |
LogPulseOnlineVoice | Voice channels and voice users. |
LogPulseOnlineEOS | PulseOnlineEOS: EOS login methods, lobbies, voice, server achievements and stats, reports and sanctions. |
LogPulseOnlineHUD | Bridge PulseOnlineHUDBridge: invites, reconnect and connection messages through the UI host. |
LogPulseOnlineSaveBridge | Bridge PulseOnlineSaveBridge: the cloud storage of the saves (calls the online service did not answer, a cloud index that does not read, an invalid Cloud File Prefix). The rounds of the mirror log in LogPulseSave. |
Change the verbosity at runtime with Log <Category> <Verbosity>, e.g. Log LogPulseOnline Verbose (Log LogPulseOnline Log goes back to the default). For a whole run: -LogCmds="LogPulseOnline Verbose" on the command line, or LogPulseOnline=Verbose in the section [Core.Log] of DefaultEngine.ini.