Setting Values
FPulseOnlineSetting
One value of type String, Int64, Double or Bool — exactly the types OSSv1 (FVariantData) and OSSv2 (FSchemaVariant) both support. Used for session settings, search filters, party / member data and party message payloads.
- C++:
FPulseOnlineSetting::Make(TEXT("Knight")),Make(42),Make(1.5),Make(true);GetType(),TryGet<T>(),GetAsString/GetAsInt64/GetAsDouble/GetAsBool. - Blueprint (
UPulseOnlineSettingLibrary):Make Online Setting (String/Integer/Float/Bool),Get As ...,Find String/Int/Float/Boolon a settings map,Make Setting Advertisement,Make Search Filter. - Editor: in the details panel you pick the type in a combo box and edit the value with a matching widget (text, integer, float, check box). Undo, multi-edit and defaults work.
- Text format (defaults, config, copy/paste):
(Type=Int64,Value="42"). A plain"text"imports as string. - The value is binary and net serializable (party messages use it).
FPulseOnlineSettingAdvertisement adds how a session setting is advertised, FPulseOnlineSearchFilter adds a comparison (Equals, NotEquals, GreaterThan, GreaterThanEquals, LessThan, LessThanEquals, Near).
Well known session keys
UPulseOnlineSessionSettingsLibrary writes the keys of Online/OnlineSessionNames.h with the right type:
- Host request (
ExtraSettings):SetMapName,SetGameMode,SetRegion,SetSubRegion,SetNumBots,SetBeaconPort,SetMaxSpectators,SetHostMigration,SetAllowBroadcasting,SetSessionKey,SetSessionTemplateName,SetMatchingHopper,SetMatchingTimeout,SetCustomSearchInt(1..8). - Search request (
ExtraFilters):FilterDedicatedOnly,FilterEmptyServersOnly,FilterNonEmptyServersOnly,FilterSecureServersOnly,FilterMinSlotsAvailable,FilterKeywords,FilterSearchUser,FilterMatchmakingQueue,FilterMapName,FilterGameMode,FilterCustomSearchInt. - Key getters (
GetHostMigrationKey, …) for own map entries and for reading search results.
The keys follow OSSv1 semantics (e.g. SETTING_HOST_MIGRATION disables EOS lobby host migration). Under OSSv2 they are plain attributes and must be part of the attribute schema.
Reserved keys
Keys starting with PULSE_ are written by Pulse Online itself (Online/PulseOnlineSessionNames.h) and ignored when game code sets them: PULSE_SESSION_TYPE, PULSE_SESSION_KEY, the party state / match / beacon keys and the member status / match / name keys.