Skip to main content

Functions Reference

Reference of the functions inside BPC_PlayerData and its BPI_PlayerDataInterface implementation.

Internal Functions

FunctionWhat it does
Check Save Game For Default DataOn first launch (or missing save), creates SG_PlayerData and fills it with the Default Player Data Values from DA_PM_Settings.
Check for cloud data availabilityVerifies Steam Cloud is enabled and reachable (respects the Use Cloud Storage? toggle in the settings data asset). Triggers the cloud-storage notification when unavailable.
Player Saved Data ValidationCompares saved data against current values (e.g. graphics settings) and prompts the "Keep Current / Load Saved" dialog you see on first standalone launch.

Interface Functions (BPI_PlayerDataInterface)

Call these through the interface on the player state (or use Get Player Data from BP_SPM_Library to get the component directly).

Character

FunctionWhat it does
PDATA_GetSavedPlayerCharacterDataReturns the saved skin type + skin variation keys.
PDATA_SavePlayerCharacterDataSaves selected skin type + variation (locally and to Steam Cloud when enabled).

Settings

FunctionWhat it does
PDATA_GetSavedGraphicSettings / PDATA_SaveGraphicsSettingGet/save S_GraphicsSettings (resolution, quality, window mode...).
PDATA_GetAudioSettings / PDATA_SaveAudioSettingsGet/save S_AudioSettings (volume per sound class).
PDATA_GetAccountSettings / PDATA_SaveAccountSettingsGet/save S_AccountSettings.

Preferences & State

FunctionWhat it does
PDATA_GetGamePreference / PDATA_SetGamePreferenceGet/set game preferences (reserved for the Looking for Party feature, which is work in progress).
PDATA_SavaDataInitialized?Returns whether the save data finished initializing. Check this before reading data on Begin Play.

Variables

VariableTypePurpose
Component TypeE_ComponentTypeMenu initializes save game data; other values skip initialization.
Slot NamestringSave game file name.
SG_PlayerDataSG_PlayerDataThe loaded save game object.
SaveDataInitialized?boolSet true once loading/validation completes.

Storage Layout

SG_PlayerData (found at Content/SteamPartyMenu/SaveGame/SG_PlayerData) holds:

  • Graphics Settings (S_GraphicsSettings struct)
  • Account Settings (S_AccountSettings struct)
  • Audio Volume Settings (string map: sound class → volume)
  • GamePreferences (string map)
  • PlayerDataMap (string map: mirror of the Steam Cloud key/value data such as player rank, level, skin type, skin color)

Cloud keys are defined in PM_SettingsData. Local save and cloud use the same keys, so keep them in sync.