Settings
Pulse Online has one settings page per module under Project Settings > Pulse (Config=Game, saved to DefaultGame.ini). Each page exists only if its module is enabled.
Online
UPulseOnlineSettings (module PulseOnline): Backend choice, service providers, disabled extensions, login, requests.
| Setting | Default | Meaning |
|---|---|---|
BackendClass | - | Backend that connects Pulse Online to an online service. Empty: the available backend with the highest priority (OSS, then add-on backends such as OSSv2, then Mock). The command line -PulseOnlineBackend= |
bWarnWithoutOnlineService | True | Logs a warning at start when no online service runs: no or a failed DefaultPlatformService, the Null subsystem, or the Mock backend standing in. The warning says what to set. Turn it off for games that only play locally or in a LAN. |
ServiceOverrides | – | Services served by a provider instead of the backend: service name to provider class (a Blueprint or C++ class derived from the adapter of that service, e.g. Online Stats Provider for IPulseOnlineStatsService). Made when the backend starts, after the backend and its extensions, so they replace their services. A provider that serves another service than its key is skipped (logged and reported by the Pulse Check). |
DisabledExtensions | – | Backend extensions that do not run (empty: every extension runs, e.g. to keep Steam from adding its services). |
DefaultLoginMethod | - | Login method of login requests without an own method. Empty: Auto Login. |
LoginTimeoutSeconds | 180.000000 | Seconds until a login request times out. Logins can wait for the player (account portal in the browser). |
bWaitForStartInput | False | True if the start screen should wait for a key press (“Press any key”) before the first login, so the platform user of that input device is logged in. Usual on consoles; set it per platform in the platform’s Game.ini. Read it with UPulseOnlineUserSubsystem::ShouldWaitForStartInput. |
DefaultRequestTimeoutSeconds | 60.000000 | Seconds until an in-progress request times out. <= 0 disables the timeout. Requests can override this. |
RequestClasses | – | Request classes of the project: base class to the class made instead (must be a child of the base). Every request Pulse Online makes goes through this table (Create Request of the subsystems, sub-requests of Quick Play, matchmaking and the party), so a project changes the host request once and every feature hosts with it. Only a class named here as a base is replaced, not its children. |
Online Sessions
UPulseOnlineSessionSettings (module PulseOnlineSession): Session defaults, the reservation beacon, reconnect and connection status.
| Setting | Default | Meaning |
|---|---|---|
bUseLobbiesDefault | True | Default of bUseLobbies for host and search requests. |
bUseLobbiesVoiceChatDefault | False | Default of bUseLobbiesVoiceChat for host requests (lobby matches). |
DefaultMaxSearchResults | 10 | Default maximum number of results of a session search. |
bUseReservationBeacons | True | Whether hosts create a reservation beacon and joining clients reserve their slot (for their whole party) before they travel. The beacon uses the BeaconNetDriver definition of the project. Only backends that support it use it (OSS). |
BeaconTeamCount | 2 | Number of teams of the reservation beacon. |
BeaconTeamSize | 8 | Size of a team of the reservation beacon. |
BeaconMaxReservations | 16 | Maximum number of reservations of the reservation beacon. |
bRememberLastSession | True | Whether the last joined game session is remembered (per local user, also across restarts) so it can be rejoined. |
RejoinWindowSeconds | 1800.000000 | Seconds after the join in which the last session may be rejoined. 0: always. |
bAutoRejoinOnConnectionLost | True | Whether a client rejoins its game session on its own after the connection was lost. |
AutoRejoinAttempts | 3 | Rejoin attempts after a lost connection. |
AutoRejoinDelaySeconds | 5.000000 | Seconds between rejoin attempts. |
ConnectionCheckIntervalSeconds | 1.000000 | Seconds between two connection checks (ping, packet loss) while connected to a server. |
DegradedPingMs | 150 | Ping from which the connection counts as degraded. |
BadPingMs | 300 | Ping from which the connection counts as bad. |
DegradedPacketLoss | 0.030000 | Incoming packet loss (0..1) from which the connection counts as degraded. |
BadPacketLoss | 0.100000 | Incoming packet loss (0..1) from which the connection counts as bad. |
bQueryNatType | True | Whether the NAT type is queried once the backend is ready (needs a network service, e.g. PulseOnlineEOS). |
Online Party
UPulseOnlinePartySettings (module PulseOnlineParty): Party size, following the leader, the party on game servers, the party beacon.
| Setting | Default | Meaning |
|---|---|---|
MaxPartySize | 4 | Default maximum number of party members. |
bPartyVoiceChatDefault | True | Default of bVoiceChat for new parties: the party lobby gets a voice room (party voice of PulseOnlineVoice). |
bAutoFollowPartyLeader | True | Whether members automatically follow the leader into a match the leader found. If false, call FollowPartyMatch yourself. |
bFollowRunningMatchOnJoin | True | Whether a player who joins the party while the leader plays follows the leader into that match (co-op: a friend accepts the invite and lands in the running game). Off: only matches the leader starts later are followed. Needs bAutoFollowPartyLeader. |
PartyReturnPolicy | Individual | What members do when the leader returns from a match to the lobby. |
bRequireAllMembersInLobbyToMatchmake | True | Whether the leader can only start matchmaking while every member is in the lobby. |
PartyGameAccess | PartyAndInvited | Who may join a game the leader hosts for the party (HostPartyGame, Play Together of the main menu): party members and invited players (default; not advertised, the host refuses other players at the login) or everybody. A host request may choose otherwise (bOverrideAccess of UPulseOnlineHostPartyGameRequest). |
PartyLobbyMap | - | The map ReturnToPartyLobby travels to. If unset, the game default map is used. |
bSharePlayerParties | True | Whether game servers learn the party of each player: clients send the party id and the leader flag when they join a session and when the party changes, the server keeps them on the player states (Get Player Party Id). The id is not checked: use it to group players, never for rights. |
bUsePartyBeacon | True | Whether the party leader hosts a beacon so members can exchange party messages (SendPartyMessage), when the online backend registers no party transport of its own (IPulseOnlinePartyMessageTransport). |
BeaconHostObjectClass | - | Host object class of the party beacon on the leader. Empty: APulseOnlinePartyBeaconHostObject. |
BeaconClientClass | - | Client class of the party beacon (the connection of a member). Empty: APulseOnlinePartyBeaconClient. |
PartyBeaconMessageBufferSize | 32 | Party messages kept while the party transport (the beacon or a transport of the backend) is not connected or refuses them. Further messages are rejected. |
PartyBeaconReconnectTimeoutSeconds | 30.000000 | Seconds a kept party message waits for the transport before it is dropped; the beacon transport also stops reconnecting to the leader after this time until the next change. |
Online Social
UPulseOnlineSocialSettings (module PulseOnlineSocial): Friends, invites, presence and recent players.
| Setting | Default | Meaning |
|---|---|---|
InviteAutoDeclineTimeoutSeconds | 60.000000 | Seconds a received session invite waits before it is automatically declined if the game never calls AcceptInvite/DeclineInvite on it. -1 disables the timeout. |
RecentPlayersSize | 50 | Players kept in the list of recent players (players of the same game sessions); 0 turns it off. |
MaxPendingInvitesPerPlayer | 10 | Maximum number of pending (unresolved) invites kept per local player. When a new invite would exceed this, the oldest pending invite is auto-declined to make room. 0 disables the limit. |
bAutoJoinOverlayRequestedSessions | True | Whether a join the user already accepted in the platform overlay (invite or “join game” of a friend) is executed automatically: parties are joined as party, everything else as game session. |
bEnablePresence | True | Whether UPulseOnlinePresenceSubsystem pushes rich presence (session state, custom status, properties). |
PresenceStatusOutOfGame | MainMenu | Status while not in a game (the game phase is Boot, Menu or Loading; also in a party lobby). Supports placeholders like {GameMode}, {MapName}, {Phase} or any presence property. |
PresenceStatusMatchmaking | Matchmaking | Status while matchmaking. |
PresenceStatusInGame | InGame | Status while in a game (the game phase is InGame). |
PresenceStatusPerPhase | empty | Status per game phase of PulseFoundation (Pulse.Phase.*), in addition to the statuses of the session states: the text of the phase now or of its closest parent with a text wins over the session state (not while matchmaking); custom statuses still win over both. Placeholders as above, plus {Phase}. |
PresenceKeyGameMode | GameMode | Presence property that receives the game mode of the session. Empty = not sent. |
PresenceKeyMapName | MapName | Presence property that receives the map name of the session. Empty = not sent. |
PresenceKeyPhase | empty | Presence property that receives the game phase (“Menu.Title”, “InGame”), so friend lists can read it. Empty = not sent. |
PresenceMinUpdateInterval | 1.000000 | Minimum seconds between two presence pushes; changes in between are sent together afterwards. |
Online Avatars
UPulseOnlineAvatarSettings (module PulseOnlineAvatar): Avatar pictures and their fallback, see Avatars.
| Setting | Default | Meaning |
|---|---|---|
bLoadAvatars | True | Whether avatar pictures are loaded. False: every avatar shows its fallback (initials on a color). |
MaxCachedAvatars | 200 | Pictures kept in memory, one per user and size; the ones not used for the longest time go first. |
RetryFailedSeconds | 300.000000 | Seconds until the avatar of a user without picture (or after a failed download) is asked for again. |
DownloadTimeoutSeconds | 15.000000 | Seconds a download of an avatar URL may take. |
MaxImageSize | 512 | Largest width or height of an avatar picture in pixels; larger pictures are refused. |
FallbackColors | 8 colors | Colors of the fallback behind the initials. A display name always gets the same color. |
Online Achievements
UPulseOnlineAchievementSettings (module PulseOnlineAchievements): Local and server achievements, batching of writes.
| Setting | Default | Meaning |
|---|---|---|
bEnableLocalAchievements | False | Whether UPulseOnlineLocalAchievementSubsystem exists: local users unlock their own achievements (not on dedicated servers). |
bQueryLocalAchievementsOnLogin | True | Whether definitions and states of a local user are queried as soon as the user is logged in. |
ServerAchievementMode | Disabled | When UPulseOnlineServerAchievementSubsystem exists: a trusted server unlocks achievements of connected players. Needs a backend with a server achievement service (e.g. PulseOnlineEOS) and a server client that the service trusts. |
bQueryServerAchievementsOnPostLogin | True | Whether the server queries the states of a player right after the player logged in. |
bRequeryAchievementsAfterStatUpdate | True | Whether the states are queried again after stats were written, so stat based progress and unlocks become visible. |
AchievementFlushIntervalSeconds | 5.000000 | Seconds between two sends of queued writes (QueueStatIncrement). 0 sends them on the next tick. |
bFlushUnlocksImmediately | True | Whether queued unlocks are sent right away instead of waiting for the flush interval. |
Online Stats
UPulseOnlineStatsSettings (module PulseOnlineStats): Stats, batching of stat writes, leaderboards.
| Setting | Default | Meaning |
|---|---|---|
bEnableStats | True | Whether UPulseOnlineStatsSubsystem exists. |
StatsFlushIntervalSeconds | 5.000000 | Seconds between two sends of queued stat updates (QueueStatUpdate). 0 sends them on the next tick. |
bFlushOnLogout | True | Whether a server sends the queued updates of a player when the player leaves the game. |
DefaultLeaderboardCount | 10 | Rows read by a leaderboard query when the query has no count. |
Online Matchmaking
UPulseOnlineMatchmakingSettings (module PulseOnlineMatchmaking): Queues, region, rated results, rating store, served queue.
| Setting | Default | Meaning |
|---|---|---|
bEnableMatchmaking | True | Whether UPulseOnlineMatchmakingSubsystem exists. |
Queues | – | Queues found by tag (FindQueue). Queues can also be registered at runtime (RegisterQueue). |
Region | – | Region of this player, advertised and compared by the Region rule. The command line -PulseRegion= wins. |
bRatedResultsOnlyOnDedicatedServer | True | Whether only dedicated servers may report rated results. Listen server matches are then unrated. |
RatingStore | Online Stats | Where ratings are kept unless the queue has an own store. |
ServerQueue | – | Queue a dedicated server serves: it advertises the queue and the average rating of its players. The command line -PulseQueue= wins. |
Online Server
UPulseOnlineServerSettings (module PulseOnlineServer): Server browser and server administration.
| Setting | Default | Meaning |
|---|---|---|
BrowserMaxResults | 50 | Maximum sessions one server list refresh asks for. |
StaleServerSeconds | 300 | Servers whose last heartbeat is older are hidden; 0 shows all. Servers without heartbeat are always shown. |
HistorySize | 20 | Servers kept in the history of played servers. |
bEnableServerAdministration | True | Whether servers (dedicated and listen) run the administration: access checks, admin commands, messages, heartbeat. |
AdminIds | – | Admins (net id strings). -PulseAdmins=id1,id2 adds more; the host of a listen server is always an admin. |
bRefuseInvalidNetIds | True | Refuse players without a valid net id while bans or the whitelist are in use (else such a player passes both). Net ids are reported by the client; only the connection auth of the online service verifies them. |
AccessFile | PulseOnline/Server/Access.json | File with bans, whitelist and admins added at runtime, relative to Saved. |
HeartbeatIntervalSeconds | 60.000000 | Seconds between two heartbeats (session settings name, password flag, region, heartbeat time). 0: only when the session is created. |
ParameterValues | – | Values of start parameters when the command line does not set them (e.g. PulseServerName). Prefer the command line for secrets. |
Online Safety
UPulseOnlineSafetySettings (module PulseOnlineSafety): Block list, text filters and sanctions.
| Setting | Default | Meaning |
|---|---|---|
bEnableSafety | True | Whether UPulseOnlineSafetySubsystem exists. |
bUsePlatformBlockList | True | Whether the block list of the platform is read and changed too (if the backend has one). |
TextFilters | – | Text filters for chat and names, in order (Word List, Links, Max Length, own). |
bCheckSanctionsOnLogin | False | Whether servers read the sanctions of joining players and kick those with a blocking sanction (PulseOnlineServer). |
BlockingSanctionActions | { TEXT("BAN"), TEXT("RESTRICT_GAME_ACCESS") } | Sanction actions that keep a player out of servers. |
ChatSanctionActions | { TEXT("RESTRICT_CHAT"), TEXT("MUTE") } | Sanction actions that take away the text chat. |
Online Chat
UPulseOnlineChatSettings (module PulseOnlineChat): Text chat channels, rate limit, filters and team resolver.
| Setting | Default | Meaning |
|---|---|---|
bEnableChat | True | Whether UPulseOnlineChatSubsystem exists. |
MaxMessageLength | 256 | Longest message; longer ones are cut. |
HistorySize | 100 | Messages kept per channel. |
RateLimitMessages | 5 | Messages a player may send within RateLimitSeconds; more are dropped. |
RateLimitSeconds | 5.000000 | Window of the rate limit. |
bFilterOnServer | True | Whether the server runs the text filters of Online Safety before it forwards messages. |
TeamResolver | – | How the server finds the team of a player for the team channel. |
bRegisterPlayerSettings | True | Whether the chat player settings (profanity filter) appear in the settings menu. |
Online Storage
UPulseOnlineStorageSettings (module PulseOnlineStorage): Title storage (news, remote config), user storage and the disk cache of title files.
| Setting | Default | Meaning |
|---|---|---|
bEnableStorage | True | Whether UPulseOnlineStorageSubsystem exists. |
TitleFilesToReadOnLogin | – | Title files read right after the first local user logged in (e.g. news.json, remote_config.json). |
RemoteConfigFile | remote_config.json | Title file with the remote config: a flat JSON object of keys and values (GetRemoteConfig…). Empty: none. |
bCacheTitleFilesOnDisk | True | Whether read title files are kept on disk (Saved/PulseOnline/TitleFiles) and used while offline. |
MaxUserFileSizeBytes | 16777216 | Largest user file that may be written; bigger writes fail. 0: no limit. |
Online Commerce
UPulseOnlineCommerceSettings (module PulseOnlineCommerce): Entitlements, store offers, purchases and the products of the game.
| Setting | Default | Meaning |
|---|---|---|
bEnableCommerce | True | Whether UPulseOnlineCommerceSubsystem exists. |
Products | – | Products of the game: tag, item ids per platform, offers. Ownership checks and purchases by tag use them. |
bQueryEntitlementsOnLogin | True | Whether the entitlements are read after the first local user logged in online. |
bQueryOffersOnLogin | False | Whether the offers of the products are read after login (prices for the store menu). |
bRefreshEntitlementsAfterPurchase | True | Whether a finished purchase reads the entitlements again (the receipt alone is not always complete). |
Online UI
UPulseOnlineUISettings (module PulseOnlineUI): Default widget classes; other modules and bridges create the widgets from here.
| Setting | Default | Meaning |
|---|---|---|
LoginStatusClass | W_PulseOnlineLoginStatus | Login status panel. |
FriendsListClass | W_PulseOnlineFriendsList | Friends list. |
PartyPanelClass | W_PulseOnlinePartyPanel | Party panel. |
ServerBrowserClass | W_PulseOnlineServerBrowser | Server browser. |
InviteDialogClass | W_PulseOnlineInviteDialog | Dialog for a received invite (activatable widget). |
Online Voice
UPulseOnlineVoiceSettings (module PulseOnlineVoice): Voice chat, match voice and proximity.
| Setting | Default | Meaning |
|---|---|---|
bEnableVoice | True | Master switch of the voice chat. |
DefaultTransmitMode | Both | Channels the local player talks into by default. |
bPushToTalk | True | Default of the player setting Push To Talk: only transmit while the push to talk key is held (or UPulseOnlineVoiceSubsystem::SetPushToTalkPressed). Off: voice activation (open mic). |
PushToTalkKey | V | Default of the player setting Push To Talk Key. The voice subsystem reads the key itself (no input action needed) while the game window of the player is active and no text box has focus. None: the game calls SetPushToTalkPressed from its own input. |
bRegisterPlayerSettings | True | Whether the voice player settings (push to talk, key, volumes) appear in the settings menu. |
bMockVoice | True | Mock backend: a simulated voice service (rooms in memory, shared by all game instances of the process) for specs and PIE. |
bEnableGameVoice | True | Whether servers hand out a voice channel for the match. |
GameVoiceChannelPrefix | Game | Prefix of the match voice channel; the PULSE_SESSION_KEY of the match is appended. |
bUseInsecureDevTokens | False | Development only: join channels with IVoiceChat::InsecureGetJoinToken when the server provides no credentials. Never ship with this. |
ProximityMode | VolumeOnly | How the match voice channel is rendered. |
ProximityMinDistance | 300.000000 | Speakers closer than this are heard at full volume (cm). |
ProximityMaxDistance | 3000.000000 | Speakers farther away than this are silent (cm). |
ProximityFalloff | - | Optional falloff between min and max distance: x = 0..1 (min..max), y = volume. Linear if unset. VolumeOnly only. |
ProximityAttenuation | - | Attenuation of the speaker sound components (Spatialized3D). If unset, min/max distance are used as linear attenuation. |
ProximityUpdateRate | 10.000000 | Proximity updates per second. |
PartyVoiceInMatch | Proximity | How party members in the same match are heard: Proximity (over the game channel with distance, the default for co-op with friends) or Party Channel (full volume over the party channel, wherever they are). Either way nobody is heard twice. |
bSilenceSpeakersWithoutPawn | True | Speakers without a pawn (dead, spectating) are silent instead of full volume. |
SpatializedBufferSeconds | 0.200000 | Audio buffered per speaker for Spatialized3D (seconds). |
Online View Models
UPulseOnlineMVVMSettings (module PulseOnlineMVVM): Party view models.
| Setting | Default | Meaning |
|---|---|---|
PartyViewModelClass | - | View model class created per local player. |
PartyMemberViewModelClass | - | Member view model class used by the party view model. |
bUseFixedPartySlots | True | Whether the party view model always holds MaxPartySize member entries (empty slots are invalid), with the local player in slot 0. |
bRegisterPartyViewModelGlobally | False | Whether the party view model is also added to the global MVVM view model collection under the context name “PulseParty”. |
Replacing and switching off subsystems
Many subsystems of Pulse Online can be switched off in Project Settings > Pulse > Foundation > Subsystems > Disabled Subsystems, for a project that does not need them. How the list works: Replacing and switching off subsystems of Pulse Foundation. Most of them also have a switch of their own in the settings above; either one turns the subsystem off.
| Subsystem | Module | Own switch |
|---|---|---|
UPulseOnlineLocalAchievementSubsystem | PulseOnlineAchievements | Enable Local Achievements |
UPulseOnlineServerAchievementSubsystem | PulseOnlineAchievements | Server Achievement Mode |
UPulseOnlineAvatarSubsystem | PulseOnlineAvatar | none; avatar widgets then show the fallback |
UPulseOnlineChatSubsystem | PulseOnlineChat | Enable Chat |
UPulseOnlineCommerceSubsystem | PulseOnlineCommerce | Enable Commerce |
UPulseOnlineMatchmakingSubsystem | PulseOnlineMatchmaking | Enable Matchmaking |
UPulseOnlineSafetySubsystem | PulseOnlineSafety | Enable Safety |
UPulseOnlineServerBrowserSubsystem | PulseOnlineServer | none |
UPulseOnlinePresenceSubsystem | PulseOnlineSocial | Enable Presence |
UPulseOnlineStatsSubsystem | PulseOnlineStats | Enable Stats |
UPulseOnlineStorageSubsystem | PulseOnlineStorage | Enable Storage |
UPulseOnlineUserContentSubsystem | PulseOnlineStorage | Enable Storage; also off while the storage subsystem is in the list |
UPulseOnlineGameVoiceServerSubsystem | PulseOnlineVoice | Enable Game Voice |
UPulseOnlineVoiceSubsystem | PulseOnlineVoice | Enable Voice |
Every caller of these handles their absence: the Get functions and Blueprint getters give None, requests fail with a reason, view models and widgets stay empty, the cheats say so.
Safety. Without UPulseOnlineSafetySubsystem there is no block list, no player reports, no sanctions and no text filter: chat, voice and invites then let every player through. Switch it off only when the platform or your own code covers this (Chat and Safety).
The other subsystems stay on, because the rest of Pulse Online builds on them: backend, users and login, sessions, connection, server login, party, friends and invites, the request queue of each local player and the party view models. Their behaviour is exchangeable through the backend, service providers and classes in the settings instead.
Specs: PulseOnline.Subsystems. The test instances of the Pulse Online specs use an empty list, so the list of a project does not change what they check.