UOperatingSystemSaveGame
#include <OperatingSystemSimulator/Public/Global/OperatingSystemSaveGame.h>class UOperatingSystemSaveGameDefined in OperatingSystemSaveGame.h:18
Inherits:
USaveGame
Inheritance diagram
Section titled “Inheritance diagram”---
config:
class:
hideEmptyMembersBox: true
---
classDiagram
class UOperatingSystemSaveGame["UOperatingSystemSaveGame"]
class USaveGame["USaveGame"]
USaveGame <|-- UOperatingSystemSaveGame
Collaboration diagram
Section titled “Collaboration diagram”---
config:
class:
hideEmptyMembersBox: true
---
classDiagram
class UOperatingSystemSaveGame["UOperatingSystemSaveGame"]
class FOperatingSystemDeviceSaveLoad["FOperatingSystemDeviceSaveLoad"]
UOperatingSystemSaveGame *-- FOperatingSystemDeviceSaveLoad
Class detail
Section titled “Class detail”---
config:
class:
hideEmptyMembersBox: true
---
classDiagram
class UOperatingSystemSaveGame {
+UOperatingSystemSaveGame()
+GetDeviceDataRef() const const FOperatingSystemDeviceSaveLoad() &
+SaveGame(AOperatingSystemDeviceActor *SaveDeviceActo bool
+LoadGame(const AOperatingSystemDeviceActor *TargetDe UOperatingSystemSaveGame() *
+UserIndex : uint8
+SaveVersion : float
+DeviceData : FOperatingSystemDeviceSaveLoad()
}
Caller impact — SaveGame
Section titled “Caller impact — SaveGame”Documented call sites inside the plugin (10):
flowchart LR UOperatingSystemSaveGame__SaveGame["UOperatingSystemSaveGame::SaveGame"] AOperatingSystemPortableDeviceActor__Internal_ChargeBattery["AOperatingSystemPortableDeviceActor::Internal_ChargeBattery"] AOperatingSystemPortableDeviceActor__Internal_ChargeBattery --> UOperatingSystemSaveGame__SaveGame AOperatingSystemPortableDeviceActor__Internal_ConsumeBattery["AOperatingSystemPortableDeviceActor::Internal_ConsumeBattery"] AOperatingSystemPortableDeviceActor__Internal_ConsumeBattery --> UOperatingSystemSaveGame__SaveGame UOperatingSystem__Internal_InstallProgram["UOperatingSystem::Internal_InstallProgram"] UOperatingSystem__Internal_InstallProgram --> UOperatingSystemSaveGame__SaveGame UOperatingSystemBaseDevice__Internal_OnDeviceSessionEnd["UOperatingSystemBaseDevice::Internal_OnDeviceSessionEnd"] UOperatingSystemBaseDevice__Internal_OnDeviceSessionEnd --> UOperatingSystemSaveGame__SaveGame UOperatingSystemBaseDevice__OnFinishSettingUpOperatingSystemPostInstallation["UOperatingSystemBaseDevice::OnFinishSettingUpOperatingSystemPostInstallation"] UOperatingSystemBaseDevice__OnFinishSettingUpOperatingSystemPostInstallation --> UOperatingSystemSaveGame__SaveGame UOperatingSystemSettingModule_Wallpaper__SaveBundledWallpaper["UOperatingSystemSettingModule_Wallpaper::SaveBundledWallpaper"] UOperatingSystemSettingModule_Wallpaper__SaveBundledWallpaper --> UOperatingSystemSaveGame__SaveGame UOperatingSystemSettingModule_Wallpaper__SaveCustomWallpaper["UOperatingSystemSettingModule_Wallpaper::SaveCustomWallpaper"] UOperatingSystemSettingModule_Wallpaper__SaveCustomWallpaper --> UOperatingSystemSaveGame__SaveGame AOperatingSystemPortableDeviceActor__SetBattery["AOperatingSystemPortableDeviceActor::SetBattery"] AOperatingSystemPortableDeviceActor__SetBattery --> UOperatingSystemSaveGame__SaveGame AOperatingSystemPortableDeviceActor__StopChargingBattery["AOperatingSystemPortableDeviceActor::StopChargingBattery"] AOperatingSystemPortableDeviceActor__StopChargingBattery --> UOperatingSystemSaveGame__SaveGame UOperatingSystem__UninstallProgram["UOperatingSystem::UninstallProgram"] UOperatingSystem__UninstallProgram --> UOperatingSystemSaveGame__SaveGame
This class represents a save game for the operating system simulator. It is derived from the USaveGame base class.
Public Methods
Section titled “Public Methods”| Return | Name | Description |
|---|---|---|
UOperatingSystemSaveGame | ||
const FOperatingSystemDeviceSaveLoad & | GetDeviceDataRef const inline | Returns a reference to the device data. |
UOperatingSystemSaveGame
Section titled “UOperatingSystemSaveGame”UOperatingSystemSaveGame()Defined in OperatingSystemSaveGame.h:36
Section titled “Defined in OperatingSystemSaveGame.h:36”GetDeviceDataRef
Section titled “GetDeviceDataRef”const inline
inline const FOperatingSystemDeviceSaveLoad & GetDeviceDataRef() constDefined in OperatingSystemSaveGame.h:70 Returns a reference to the device data.
This method retrieves a constant reference to the device data from the save game.
Returns
Section titled “Returns”Constant reference to the device data.
Public Static Methods
Section titled “Public Static Methods”| Return | Name | Description |
|---|---|---|
bool | SaveGame static | Saves the game data to the specified save device. |
UOperatingSystemSaveGame * | LoadGame static | Loads the save game from the specified target device. |
SaveGame
Section titled “SaveGame”static
static bool SaveGame(AOperatingSystemDeviceActor * SaveDeviceActor)Defined in OperatingSystemSaveGame.h:44 Saves the game data to the specified save device.
Parameters
Section titled “Parameters”SaveDeviceActorThe save device to save the data to.
Returns
Section titled “Returns”True if the game data was successfully saved, false otherwise.
Referenced by
Section titled “Referenced by”Internal_ChargeBatteryInternal_ConsumeBatteryInternal_InstallProgramInternal_OnDeviceSessionEndOnFinishSettingUpOperatingSystemPostInstallationSaveBundledWallpaperSaveCustomWallpaperSetBatteryStopChargingBatteryUninstallProgram
References
Section titled “References”bSaveLoad_OperatingSystemInstalledDeviceDataGetOperatingSystemUniqueIDGetPartitionsOnSaveGameOS_LOGOS_LOG_ERRORSaveLoad_OperatingSystemSaveLoad_PartitionsSaveLoad_VersionSaveVersionToStringUserIndex
LoadGame
Section titled “LoadGame”static
static UOperatingSystemSaveGame * LoadGame(const AOperatingSystemDeviceActor * TargetDevice)Defined in OperatingSystemSaveGame.h:52 Loads the save game from the specified target device.
Parameters
Section titled “Parameters”TargetDeviceThe target device from which to load the save game.
Returns
Section titled “Returns”The loaded save game instance. Returns nullptr if the load operation fails.
Referenced by
Section titled “Referenced by”References
Section titled “References”OS_CLOGOS_LOG_ERROR
Protected Attributes
Section titled “Protected Attributes”| Return | Name | Description |
|---|---|---|
uint8 | UserIndex | |
float | SaveVersion | Static save version. DO NOT CHANGE if not required. Newer save versions are NOT compatible with previous ones. |
FOperatingSystemDeviceSaveLoad | DeviceData |
UserIndex
Section titled “UserIndex”uint8 UserIndexDefined in OperatingSystemSaveGame.h:25
Referenced by
Section titled “Referenced by”SaveVersion
Section titled “SaveVersion”float SaveVersionDefined in OperatingSystemSaveGame.h:29 Static save version. DO NOT CHANGE if not required. Newer save versions are NOT compatible with previous ones.
Referenced by
Section titled “Referenced by”DeviceData
Section titled “DeviceData”FOperatingSystemDeviceSaveLoad DeviceDataDefined in OperatingSystemSaveGame.h:32