UOperatingSystem

#include <OperatingSystemSimulator/Public/Core/OperatingSystem.h>

class UOperatingSystem

Defined in OperatingSystem.h:90

Inherits: UObject Subclassed by: UOperatingSystemNonUnix, UOperatingSystemUnix

Inheritance diagram

---
config:
  class:
    hideEmptyMembersBox: true
---
classDiagram
  class UOperatingSystem["UOperatingSystem"]
  class UObject["UObject"]
  UObject <|-- UOperatingSystem
  class UOperatingSystemNonUnix["UOperatingSystemNonUnix"]
  UOperatingSystem <|-- UOperatingSystemNonUnix
  class UOperatingSystemUnix["UOperatingSystemUnix"]
  UOperatingSystem <|-- UOperatingSystemUnix

Collaboration diagram

---
config:
  class:
    hideEmptyMembersBox: true
---
classDiagram
  class UOperatingSystem["UOperatingSystem"]
  class FOperatingSystemVersion["FOperatingSystemVersion"]
  UOperatingSystem *-- FOperatingSystemVersion
  class UOperatingSystemProgramsCollection["UOperatingSystemProgramsCollection"]
  UOperatingSystem *-- UOperatingSystemProgramsCollection
  class UOperatingSystemDirectoriesCollection["UOperatingSystemDirectoriesCollection"]
  UOperatingSystem *-- UOperatingSystemDirectoriesCollection
  class UOperatingSystemSettingsData["UOperatingSystemSettingsData"]
  UOperatingSystem *-- UOperatingSystemSettingsData
  class UOperatingSystemWidget["UOperatingSystemWidget"]
  UOperatingSystem *-- UOperatingSystemWidget
  class UOperatingSystemBsodWidget["UOperatingSystemBsodWidget"]
  UOperatingSystem *-- UOperatingSystemBsodWidget
  class FOperatingSystemNotificationSettings["FOperatingSystemNotificationSettings"]
  UOperatingSystem *-- FOperatingSystemNotificationSettings
  class FOperatingSystemRangeTime["FOperatingSystemRangeTime"]
  UOperatingSystem *-- FOperatingSystemRangeTime
  class UOperatingSystemBaseDevice["UOperatingSystemBaseDevice"]
  UOperatingSystem *-- UOperatingSystemBaseDevice
  class UOperatingSystemBaseProgram["UOperatingSystemBaseProgram"]
  UOperatingSystem *-- UOperatingSystemBaseProgram
  class UOperatingSystemProgramData["UOperatingSystemProgramData"]
  UOperatingSystem o-- UOperatingSystemProgramData
  class FOperatingSystemUser["FOperatingSystemUser"]
  UOperatingSystem *-- FOperatingSystemUser
  class UOperatingSystemTaskbarButton["UOperatingSystemTaskbarButton"]
  UOperatingSystem *-- UOperatingSystemTaskbarButton
  class FOperatingSystemUniqueId["FOperatingSystemUniqueId"]
  UOperatingSystem *-- FOperatingSystemUniqueId
  class UDraggableWindow["UDraggableWindow"]
  UOperatingSystem *-- UDraggableWindow
  class FOperatingSystemProgramDelegate["FOperatingSystemProgramDelegate"]
  UOperatingSystem *-- FOperatingSystemProgramDelegate

Class detail

---
config:
  class:
    hideEmptyMembersBox: true
---
classDiagram
  class UOperatingSystem {
    +OnOperatingSystemWindowBroughtToFront : FOnOperatingSystemWindowBroughtToFront()
    +OnProgramStarted : FOperatingSystemProgramDelegate()
    +OnProgramClosed : FOperatingSystemProgramDelegate()
    +OnProgramInstalled : FOperatingSystemProgramDelegate()
    +OnProgramUninstalled : FOperatingSystemProgramDelegate()
    +GetAs() const T() *
    +GetAsConst() const const()T() *
    +AddNotification(const FOperatingSystemNotification &NewNoti bool()
    +AddNotification(const FGenericError &GenericError, const EO bool()
    +StartOperatingSystem(const TWeakObjectPtr< const UOperatingSyste void()
    +PostLoadOperatingSystem() void()
    +OnShowDesktop() void()
    +FinishInstallation() void()
    +InstallStartupPrograms() void()
    +ShutdownOS() void()
    +RestartOS() void()
    +DestroyOS() void()
    +AddRunningProgram(UOperatingSystemBaseProgram *NewProgram, FG int32()
    +ProgramStarted(UOperatingSystemBaseProgram *StartedProgram void()
    +IsProgramRunning(const TWeakObjectPtr< const UOperatingSyste bool()
    +IsProgramRunning(const TSubclassOf< UOperatingSystemBaseProg bool()
    +CreateNewWindow(TWeakObjectPtr< UOperatingSystemBaseProgram UDraggableWindow() *
    +BringWindowToFront(UDraggableWindow *TargetWindow) void()
    +CreateDirectoryInPath(const FString &TargetPath, const FString &D UOperatingSystemDirectory() *
    +CreateProgramsFromRepository(const TSoftObjectPtr< UOperatingSystemProgr bool()
    +SetToInstallStartupPrograms(const bool bInstall) void()
    +ShouldInstallStartupPrograms() const bool()
    +SetDeviceName(const FText &NewName) void()
    +GetDeviceName() const FText()
    +SetAutoLogin(const bool bEnableAutoLogin) void()
    +CanAutoLogin() const bool()
    +GetInstallationTime() const float()
    +GetLoadingTime() const float()
    +GetInitialLoadingTime() const float()
    +GetNotifications() const const()TArray()< FOperatingSystemNotific
    +ClearAllNotifications() void()
    +ConsumeSpaceInMB(const float &NewSizeInMB, UOperatingSystemP void()
    +ConsumeSpaceInGB(const float &NewSizeInGB, UOperatingSystemP void()
    +GetSizeAsText(const EOperatingSystemSizeMethod SizeMethod FText()
    +GetStoragePercentage(const UOperatingSystemPartition *Partition, float()
    +GetHardDiskSize(FGenericError &OutError, const EOperatingSy double()
    +UninstallProgram(const FName &ProgramIdentifier, FGenericErr void()
    +UninstallProgramByClass(const TSoftClassPtr< UOperatingSystemBasePr void()
    +InstallProgramFromPackage(const FName &ProgramIdentifier, FGenericErr UOperatingSystemBaseProgram() *
    +InstallProgramFromClass(FGenericError &OutErrorIfAny, const TSoftCl UOperatingSystemBaseProgram() *
    +SetProgramAtStartup(UOperatingSystemBaseProgram *TargetProgram, bool()
    +BeginInstallation(UOperatingSystemPartition *TargetPartition, void()
    +AllocatePartition(const double SizeInBytes, FGenericError &Ou UOperatingSystemPartition() *
    +RemovePartition(UOperatingSystemPartition *PartitionToDelet void()
    +RefreshPartitions() void()
    +InstallationCompleted(const bool bSwitchToDesktop=true) void()
    +CreateNewUser(const FOperatingSystemUser &NewUser, const  bool()
    +LoginUser(const FText &Username, const FText &Passwor bool()
    +UpdateCurrentUserDetails(const FOperatingSystemUser &UpdatedDetails) bool()
    +HasEnoughSpace(const double &TestSizeInBytes, const UOpera bool()
    +GetDiskPartitions() const TArray()< UOperatingSystemPartition() * 
    +GetOperatingSystemPartition() const UOperatingSystemPartition() *
    +CloseProgram(UOperatingSystemBaseProgram *TargetProgram, void()
    +BringBackgroundProgramToFront(UOperatingSystemBaseProgram *TargetProgram) bool()
    +IsProgramInBackground(UOperatingSystemBaseProgram *TestProgram) c bool()
    +MinimizeProgram(UOperatingSystemBaseProgram *TargetProgram) void()
    +CloseAllRunningPrograms() void()
    +RestoreMinimizedProgram(const UOperatingSystemBaseProgram *TargetPr void()
    +GetDirectoryIconObject(const FGameplayTag &TestTag) const UObject *
    +IsUnix() const bool()
    +GetBsodOnScreenTime() const float()
    +GetToastNotificationDisplayTime() const float()
    +GetInstalledPrograms() const TArray()< UOperatingSystemBaseProgram() 
    +GetInstalledProgramsMap(TMap< FName, UOperatingSystemBaseProgram *  void()
    +GetStartupPrograms(TMap< FName, UOperatingSystemBaseProgram *  void()
    +FindProgramData(const UOperatingSystemBaseProgram *TargetPr UOperatingSystemProgramData() *
    +AddProgramData(const UOperatingSystemBaseProgram *TargetPr void()
    +GetInstalledProgram(const TSoftClassPtr< UOperatingSystemBasePr UOperatingSystemBaseProgram() *
    +IsProgramInstalled(const TSoftClassPtr< UOperatingSystemBasePr bool()
    +GetRunningProgram(const TSoftClassPtr< UOperatingSystemBasePr UOperatingSystemBaseProgram() *
    +IsPreInstalledOperatingSystem() const bool()
    +GetSettings() const UOperatingSystemSettingsData() *
    +IsRunningOnPortableDevice() const bool()
    +FindPartitionFromLetter(const FName &TargetDiskLetter) const UOperatingSystemPartition() *
    +GetRootCommand() const TOptional()< FText() >
    +GetRootUser() const TOptional()< FOperatingSystemUser() >
    +HasValidRootCommandAndUser() const bool()
    +IsShuttingDown() const bool()
    +IsRestarting() const bool()
    +GetAllUsers() const TArray()< FOperatingSystemUser() >
    +GetOperatingSystemProgramRestoredEventName() FName()
    +CreateOperatingSystem(UOperatingSystemBaseDevice *OwningDevice, F UOperatingSystem() *
    +GetOperatingSystemUniqueID(const UOperatingSystem *TestOperatingSystem FString()
    +TimerHandle_OperatingSystemInstallation : FTimerHandle()
    +TimerHandle_LoadingTime : FTimerHandle()
    +Name : FText()
    +CompanyName : FText()
    +Version : FOperatingSystemVersion()
    +Icon : TSoftObjectPtr()< UObject >
    +DirectoryIcons : TMap()< FGameplayTag(), TSoftObjectPtr()
    +InstallationSpace : float()
    +SupportedDevices : FGameplayTagContainer()
    +MustHavePrograms : TSoftObjectPtr()< UOperatingSystemProgra
    +PostInstallStartupPrograms : TSoftObjectPtr()< UOperatingSystemProgra
    +DefaultDirectories : TSoftObjectPtr()< UOperatingSystemDirect
    +SettingsDataClass : TSoftClassPtr()< UOperatingSystemSetting
    +WidgetClass : TSoftClassPtr()< UOperatingSystemWidget(
    +BsodWidgetClass : TSoftClassPtr()< UOperatingSystemBsodWid
    +NotificationSettings : FOperatingSystemNotificationSettings()
    +InstallationTime : FOperatingSystemRangeTime()
    +LoadingTime : FOperatingSystemRangeTime()
    +LoadingTimeInitial : FOperatingSystemRangeTime()
    +LogonToDesktopTime : FOperatingSystemRangeTime()
    +BsodOnScreenTime : FOperatingSystemRangeTime()
    +OperatingSystemTag : FGameplayTag()
    +ParentDevice : TWeakObjectPtr()< UOperatingSystemBaseDe
    +OperatingSystemSettingsData : TObjectPtr()< UOperatingSystemSettingsDa
    +OperatingSystemWidget : TObjectPtr()< UOperatingSystemWidget() >
    +RunningPrograms : TMap()< int32(), TObjectPtr()< UOperatin
    +BackgroundRunningPrograms : TMap()< int32(), TObjectPtr()< UOperatin
    +InstalledPrograms : TMap()< FName(), UOperatingSystemBasePro
    +ProgramDataObjs : TMap()< FName(), UOperatingSystemProgram
    +CurrentUser : FOperatingSystemUser()
    +bIsStartingForTheFirstTime : uint8()
    +TotalNotifications : int32()
    +TotalErrorNotifications : int32()
    +TotalWarningNotifications : int32()
    +BSODWidget : TObjectPtr()< UOperatingSystemBsodWidget
    +TaskbarButtons : TMap()< int32(), TWeakObjectPtr()< UOper
    +PreviousFocusedTaskbarButton : TWeakObjectPtr()< UOperatingSystemTaskba
    +LastFocusedTaskbarButton : TWeakObjectPtr()< UOperatingSystemTaskba
    +StartupPrograms : TMap()< FName(), TWeakObjectPtr()< UOper
    +PendingStartupPrograms : TArray()< TWeakObjectPtr()< UOperatingSy
    +TargetPartitionID : FOperatingSystemUniqueId()
    +LastBroughtToFrontWindow : TWeakObjectPtr()< UDraggableWindow() >
    +bAutoLogin : uint8()
    +bInstallStartupPrograms : uint8()
    +DeviceName : FText()
    +OnShowNotification(const FOperatingSystemNotification &NewNoti void()
    +OnAllOnNotificationsCleared() void()
    +OnValidate(FGenericError &OutError) const void()
    +FinalizePreInstallation(FGenericError &OutError) void()
    +PrepareOperatingSystemInstallImpl(FGenericError &OutError) void()
    +StartOperatingSystemImpl(FGenericError &OutError) bool()
    +PostLoadOperatingSystemImpl(FGenericError &OutError) void()
    +FinishInstallationImpl() void()
    +InstallStartupProgramsImpl() void()
    +OnPartitionLoaded(UOperatingSystemPartition &LoadedPartition, void()
    +FindProgramFromPackage(const FName &ProgramIdentifier) TSoftClassPtr()< UOperatingSystemBasePro
    +K2_CanStartOperatingSystem(FGenericError &ReturnError) bool()
    +Internal_CreateDefaultDirectories(FGenericError &OutError) void()
    +Internal_PrepareInstall(FGenericError &OutError) void()
    +Internal_FinalizePreInstallation(FGenericError &OutError) void()
    +Internal_Validate(FGenericError &OutError) const void()
    +Internal_CreateNotificationManager() void()
    +Internal_LoadSettings(const TWeakObjectPtr< const UOperatingSyste const()FOperatingSystemDeviceSaveLoad() 
    +Internal_RunPendingStartupProgram() void()
    +Internal_InstallProgram(const TSoftClassPtr< UOperatingSystemBasePr UOperatingSystemBaseProgram() *
    +Internal_LoadSavedProgram(const TSoftClassPtr< UOperatingSystemBasePr void()
    +Internal_SetTaskbarButtonStateToUnfocused() void()
    +Internal_BringWindowToFront(UDraggableWindow *TargetWindow) void()
  }

Caller impact — GetSettings

Documented call sites inside the plugin (92):

flowchart LR
  UOperatingSystem__GetSettings["UOperatingSystem::GetSettings"]
  UOperatingSystem__AddNotification["UOperatingSystem::AddNotification"]
  UOperatingSystem__AddNotification --> UOperatingSystem__GetSettings
  UOperatingSystem__AddNotification --> UOperatingSystem__GetSettings
  UOperatingSystem__AddProgramData["UOperatingSystem::AddProgramData"]
  UOperatingSystem__AddProgramData --> UOperatingSystem__GetSettings
  UOperatingSystem__AddRunningProgram["UOperatingSystem::AddRunningProgram"]
  UOperatingSystem__AddRunningProgram --> UOperatingSystem__GetSettings
  UOperatingSystem__AllocatePartition["UOperatingSystem::AllocatePartition"]
  UOperatingSystem__AllocatePartition --> UOperatingSystem__GetSettings
  UOperatingSystem__BeginInstallation["UOperatingSystem::BeginInstallation"]
  UOperatingSystem__BeginInstallation --> UOperatingSystem__GetSettings
  UOperatingSystem__BringBackgroundProgramToFront["UOperatingSystem::BringBackgroundProgramToFront"]
  UOperatingSystem__BringBackgroundProgramToFront --> UOperatingSystem__GetSettings
  UOperatingSystem__BringWindowToFront["UOperatingSystem::BringWindowToFront"]
  UOperatingSystem__BringWindowToFront --> UOperatingSystem__GetSettings
  UOperatingSystem__ClearAllNotifications["UOperatingSystem::ClearAllNotifications"]
  UOperatingSystem__ClearAllNotifications --> UOperatingSystem__GetSettings
  UOperatingSystem__CloseAllRunningPrograms["UOperatingSystem::CloseAllRunningPrograms"]
  UOperatingSystem__CloseAllRunningPrograms --> UOperatingSystem__GetSettings
  UOperatingSystem__CloseProgram["UOperatingSystem::CloseProgram"]
  UOperatingSystem__CloseProgram --> UOperatingSystem__GetSettings
  UOperatingSystem__ConsumeSpaceInGB["UOperatingSystem::ConsumeSpaceInGB"]
  UOperatingSystem__ConsumeSpaceInGB --> UOperatingSystem__GetSettings
  UOperatingSystem__ConsumeSpaceInMB["UOperatingSystem::ConsumeSpaceInMB"]
  UOperatingSystem__ConsumeSpaceInMB --> UOperatingSystem__GetSettings
  UOperatingSystem__CreateDirectoryInPath["UOperatingSystem::CreateDirectoryInPath"]
  UOperatingSystem__CreateDirectoryInPath --> UOperatingSystem__GetSettings
  UOperatingSystemNonUnix__CreateDirectoryInPath["UOperatingSystemNonUnix::CreateDirectoryInPath"]
  UOperatingSystemNonUnix__CreateDirectoryInPath --> UOperatingSystem__GetSettings
  UOperatingSystemUnix__CreateDirectoryInPath["UOperatingSystemUnix::CreateDirectoryInPath"]
  UOperatingSystemUnix__CreateDirectoryInPath --> UOperatingSystem__GetSettings
  UOperatingSystem__CreateNewUser["UOperatingSystem::CreateNewUser"]
  UOperatingSystem__CreateNewUser --> UOperatingSystem__GetSettings
  UOperatingSystem__CreateNewWindow["UOperatingSystem::CreateNewWindow"]
  UOperatingSystem__CreateNewWindow --> UOperatingSystem__GetSettings
  UOperatingSystem__CreateOperatingSystem["UOperatingSystem::CreateOperatingSystem"]
  UOperatingSystem__CreateOperatingSystem --> UOperatingSystem__GetSettings
  UOperatingSystem__CreateProgramsFromRepository["UOperatingSystem::CreateProgramsFromRepository"]
  UOperatingSystem__CreateProgramsFromRepository --> UOperatingSystem__GetSettings
  UOperatingSystemUnix__CreateRootDirectory["UOperatingSystemUnix::CreateRootDirectory"]
  UOperatingSystemUnix__CreateRootDirectory --> UOperatingSystem__GetSettings
  UOperatingSystem__DestroyOS["UOperatingSystem::DestroyOS"]
  UOperatingSystem__DestroyOS --> UOperatingSystem__GetSettings
  UOperatingSystemNonUnix__FinalizePreInstallation["UOperatingSystemNonUnix::FinalizePreInstallation"]
  UOperatingSystemNonUnix__FinalizePreInstallation --> UOperatingSystem__GetSettings
  UOperatingSystemUnix__FinalizePreInstallation["UOperatingSystemUnix::FinalizePreInstallation"]
  UOperatingSystemUnix__FinalizePreInstallation --> UOperatingSystem__GetSettings
  UOperatingSystemNonUnix__FindDiskLetterAtIndex["UOperatingSystemNonUnix::FindDiskLetterAtIndex"]
  UOperatingSystemNonUnix__FindDiskLetterAtIndex --> UOperatingSystem__GetSettings
  UOperatingSystemNonUnix__FindPartitionFromLetter["UOperatingSystemNonUnix::FindPartitionFromLetter"]
  UOperatingSystemNonUnix__FindPartitionFromLetter --> UOperatingSystem__GetSettings
  UOperatingSystem__FindProgramData["UOperatingSystem::FindProgramData"]
  UOperatingSystem__FindProgramData --> UOperatingSystem__GetSettings
  UOperatingSystemUnix__FindProgramFromPackage["UOperatingSystemUnix::FindProgramFromPackage"]
  UOperatingSystemUnix__FindProgramFromPackage --> UOperatingSystem__GetSettings
  UOperatingSystem__FinishInstallation["UOperatingSystem::FinishInstallation"]
  UOperatingSystem__FinishInstallation --> UOperatingSystem__GetSettings
  UOperatingSystem__GetDirectoryIconObject["UOperatingSystem::GetDirectoryIconObject"]
  UOperatingSystem__GetDirectoryIconObject --> UOperatingSystem__GetSettings
  UOperatingSystem__GetDiskPartitions["UOperatingSystem::GetDiskPartitions"]
  UOperatingSystem__GetDiskPartitions --> UOperatingSystem__GetSettings
  UOperatingSystem__GetHardDiskSize["UOperatingSystem::GetHardDiskSize"]
  UOperatingSystem__GetHardDiskSize --> UOperatingSystem__GetSettings
  UOperatingSystem__GetInitialLoadingTime["UOperatingSystem::GetInitialLoadingTime"]
  UOperatingSystem__GetInitialLoadingTime --> UOperatingSystem__GetSettings
  UOperatingSystem__GetInstallationTime["UOperatingSystem::GetInstallationTime"]
  UOperatingSystem__GetInstallationTime --> UOperatingSystem__GetSettings
  UOperatingSystem__GetInstalledProgram["UOperatingSystem::GetInstalledProgram"]
  UOperatingSystem__GetInstalledProgram --> UOperatingSystem__GetSettings
  UOperatingSystem__GetInstalledPrograms["UOperatingSystem::GetInstalledPrograms"]
  UOperatingSystem__GetInstalledPrograms --> UOperatingSystem__GetSettings
  UOperatingSystem__GetInstalledProgramsMap["UOperatingSystem::GetInstalledProgramsMap"]
  UOperatingSystem__GetInstalledProgramsMap --> UOperatingSystem__GetSettings
  UOperatingSystem__GetLoadingTime["UOperatingSystem::GetLoadingTime"]
  UOperatingSystem__GetLoadingTime --> UOperatingSystem__GetSettings
  UOperatingSystem__GetOperatingSystemPartition["UOperatingSystem::GetOperatingSystemPartition"]
  UOperatingSystem__GetOperatingSystemPartition --> UOperatingSystem__GetSettings
  UOperatingSystem__GetOperatingSystemUniqueID["UOperatingSystem::GetOperatingSystemUniqueID"]
  UOperatingSystem__GetOperatingSystemUniqueID --> UOperatingSystem__GetSettings
  UOperatingSystemUnix__GetRootCommand["UOperatingSystemUnix::GetRootCommand"]
  UOperatingSystemUnix__GetRootCommand --> UOperatingSystem__GetSettings
  UOperatingSystem__GetRunningProgram["UOperatingSystem::GetRunningProgram"]
  UOperatingSystem__GetRunningProgram --> UOperatingSystem__GetSettings
  UOperatingSystem__GetSizeAsText["UOperatingSystem::GetSizeAsText"]
  UOperatingSystem__GetSizeAsText --> UOperatingSystem__GetSettings
  UOperatingSystem__GetStartupPrograms["UOperatingSystem::GetStartupPrograms"]
  UOperatingSystem__GetStartupPrograms --> UOperatingSystem__GetSettings
  UOperatingSystem__GetStoragePercentage["UOperatingSystem::GetStoragePercentage"]
  UOperatingSystem__GetStoragePercentage --> UOperatingSystem__GetSettings
  UOperatingSystem__HasEnoughSpace["UOperatingSystem::HasEnoughSpace"]
  UOperatingSystem__HasEnoughSpace --> UOperatingSystem__GetSettings
  UOperatingSystem__InstallationCompleted["UOperatingSystem::InstallationCompleted"]
  UOperatingSystem__InstallationCompleted --> UOperatingSystem__GetSettings
  UOperatingSystem__InstallProgramFromClass["UOperatingSystem::InstallProgramFromClass"]
  UOperatingSystem__InstallProgramFromClass --> UOperatingSystem__GetSettings
  UOperatingSystem__InstallProgramFromPackage["UOperatingSystem::InstallProgramFromPackage"]
  UOperatingSystem__InstallProgramFromPackage --> UOperatingSystem__GetSettings
  UOperatingSystem__Internal_BringWindowToFront["UOperatingSystem::Internal_BringWindowToFront"]
  UOperatingSystem__Internal_BringWindowToFront --> UOperatingSystem__GetSettings
  UOperatingSystem__Internal_CreateDefaultDirectories["UOperatingSystem::Internal_CreateDefaultDirectories"]
  UOperatingSystem__Internal_CreateDefaultDirectories --> UOperatingSystem__GetSettings
  UOperatingSystem__Internal_CreateNotificationManager["UOperatingSystem::Internal_CreateNotificationManager"]
  UOperatingSystem__Internal_CreateNotificationManager --> UOperatingSystem__GetSettings
  UOperatingSystem__Internal_FinalizePreInstallation["UOperatingSystem::Internal_FinalizePreInstallation"]
  UOperatingSystem__Internal_FinalizePreInstallation --> UOperatingSystem__GetSettings
  UOperatingSystem__Internal_InstallProgram["UOperatingSystem::Internal_InstallProgram"]
  UOperatingSystem__Internal_InstallProgram --> UOperatingSystem__GetSettings
  UOperatingSystem__Internal_LoadSavedProgram["UOperatingSystem::Internal_LoadSavedProgram"]
  UOperatingSystem__Internal_LoadSavedProgram --> UOperatingSystem__GetSettings
  UOperatingSystem__Internal_LoadSettings["UOperatingSystem::Internal_LoadSettings"]
  UOperatingSystem__Internal_LoadSettings --> UOperatingSystem__GetSettings
  UOperatingSystem__Internal_PrepareInstall["UOperatingSystem::Internal_PrepareInstall"]
  UOperatingSystem__Internal_PrepareInstall --> UOperatingSystem__GetSettings
  UOperatingSystem__Internal_RunPendingStartupProgram["UOperatingSystem::Internal_RunPendingStartupProgram"]
  UOperatingSystem__Internal_RunPendingStartupProgram --> UOperatingSystem__GetSettings
  UOperatingSystem__Internal_SetTaskbarButtonStateToUnfocused["UOperatingSystem::Internal_SetTaskbarButtonStateToUnfocused"]
  UOperatingSystem__Internal_SetTaskbarButtonStateToUnfocused --> UOperatingSystem__GetSettings
  UOperatingSystem__Internal_Validate["UOperatingSystem::Internal_Validate"]
  UOperatingSystem__Internal_Validate --> UOperatingSystem__GetSettings
  UOperatingSystem__IsProgramInBackground["UOperatingSystem::IsProgramInBackground"]
  UOperatingSystem__IsProgramInBackground --> UOperatingSystem__GetSettings
  UOperatingSystem__IsProgramInstalled["UOperatingSystem::IsProgramInstalled"]
  UOperatingSystem__IsProgramInstalled --> UOperatingSystem__GetSettings
  UOperatingSystem__IsProgramRunning["UOperatingSystem::IsProgramRunning"]
  UOperatingSystem__IsProgramRunning --> UOperatingSystem__GetSettings
  UOperatingSystem__IsProgramRunning --> UOperatingSystem__GetSettings
  UOperatingSystem__LoginUser["UOperatingSystem::LoginUser"]
  UOperatingSystem__LoginUser --> UOperatingSystem__GetSettings
  UOperatingSystem__MinimizeProgram["UOperatingSystem::MinimizeProgram"]
  UOperatingSystem__MinimizeProgram --> UOperatingSystem__GetSettings
  UOperatingSystemNonUnix__OnPartitionLoaded["UOperatingSystemNonUnix::OnPartitionLoaded"]
  UOperatingSystemNonUnix__OnPartitionLoaded --> UOperatingSystem__GetSettings
  UOperatingSystem__OnShowDesktop["UOperatingSystem::OnShowDesktop"]
  UOperatingSystem__OnShowDesktop --> UOperatingSystem__GetSettings
  UOperatingSystem__OnShowNotification["UOperatingSystem::OnShowNotification"]
  UOperatingSystem__OnShowNotification --> UOperatingSystem__GetSettings
  UOperatingSystemUnix__OnValidate["UOperatingSystemUnix::OnValidate"]
  UOperatingSystemUnix__OnValidate --> UOperatingSystem__GetSettings
  UOperatingSystem__PostLoadOperatingSystem["UOperatingSystem::PostLoadOperatingSystem"]
  UOperatingSystem__PostLoadOperatingSystem --> UOperatingSystem__GetSettings
  UOperatingSystemNonUnix__PostLoadOperatingSystemImpl["UOperatingSystemNonUnix::PostLoadOperatingSystemImpl"]
  UOperatingSystemNonUnix__PostLoadOperatingSystemImpl --> UOperatingSystem__GetSettings
  UOperatingSystemUnix__PostLoadOperatingSystemImpl["UOperatingSystemUnix::PostLoadOperatingSystemImpl"]
  UOperatingSystemUnix__PostLoadOperatingSystemImpl --> UOperatingSystem__GetSettings
  UOperatingSystem__ProgramStarted["UOperatingSystem::ProgramStarted"]
  UOperatingSystem__ProgramStarted --> UOperatingSystem__GetSettings
  UOperatingSystem__RefreshPartitions["UOperatingSystem::RefreshPartitions"]
  UOperatingSystem__RefreshPartitions --> UOperatingSystem__GetSettings
  UOperatingSystem__RemovePartition["UOperatingSystem::RemovePartition"]
  UOperatingSystem__RemovePartition --> UOperatingSystem__GetSettings
  UOperatingSystem__RestartOS["UOperatingSystem::RestartOS"]
  UOperatingSystem__RestartOS --> UOperatingSystem__GetSettings
  UOperatingSystem__RestoreMinimizedProgram["UOperatingSystem::RestoreMinimizedProgram"]
  UOperatingSystem__RestoreMinimizedProgram --> UOperatingSystem__GetSettings
  UOperatingSystemSettingModule_Wallpaper__SaveBundledWallpaper["UOperatingSystemSettingModule_Wallpaper::SaveBundledWallpaper"]
  UOperatingSystemSettingModule_Wallpaper__SaveBundledWallpaper --> UOperatingSystem__GetSettings
  UOperatingSystemSettingModule_Wallpaper__SaveCustomWallpaper["UOperatingSystemSettingModule_Wallpaper::SaveCustomWallpaper"]
  UOperatingSystemSettingModule_Wallpaper__SaveCustomWallpaper --> UOperatingSystem__GetSettings
  UOperatingSystem__SetAutoLogin["UOperatingSystem::SetAutoLogin"]
  UOperatingSystem__SetAutoLogin --> UOperatingSystem__GetSettings
  UOperatingSystem__SetDeviceName["UOperatingSystem::SetDeviceName"]
  UOperatingSystem__SetDeviceName --> UOperatingSystem__GetSettings
  UOperatingSystem__SetProgramAtStartup["UOperatingSystem::SetProgramAtStartup"]
  UOperatingSystem__SetProgramAtStartup --> UOperatingSystem__GetSettings
  UOperatingSystem__SetToInstallStartupPrograms["UOperatingSystem::SetToInstallStartupPrograms"]
  UOperatingSystem__SetToInstallStartupPrograms --> UOperatingSystem__GetSettings
  UOperatingSystem__ShutdownOS["UOperatingSystem::ShutdownOS"]
  UOperatingSystem__ShutdownOS --> UOperatingSystem__GetSettings
  UOperatingSystem__StartOperatingSystem["UOperatingSystem::StartOperatingSystem"]
  UOperatingSystem__StartOperatingSystem --> UOperatingSystem__GetSettings
  UOperatingSystemNonUnix__StartOperatingSystemImpl["UOperatingSystemNonUnix::StartOperatingSystemImpl"]
  UOperatingSystemNonUnix__StartOperatingSystemImpl --> UOperatingSystem__GetSettings
  UOperatingSystemUnix__StartOperatingSystemImpl["UOperatingSystemUnix::StartOperatingSystemImpl"]
  UOperatingSystemUnix__StartOperatingSystemImpl --> UOperatingSystem__GetSettings
  UOperatingSystem__UninstallProgram["UOperatingSystem::UninstallProgram"]
  UOperatingSystem__UninstallProgram --> UOperatingSystem__GetSettings
  UOperatingSystem__UninstallProgramByClass["UOperatingSystem::UninstallProgramByClass"]
  UOperatingSystem__UninstallProgramByClass --> UOperatingSystem__GetSettings
  UOperatingSystemUnixPhone__UOperatingSystemUnixPhone["UOperatingSystemUnixPhone::UOperatingSystemUnixPhone"]
  UOperatingSystemUnixPhone__UOperatingSystemUnixPhone --> UOperatingSystem__GetSettings
  UOperatingSystem__UpdateCurrentUserDetails["UOperatingSystem::UpdateCurrentUserDetails"]
  UOperatingSystem__UpdateCurrentUserDetails --> UOperatingSystem__GetSettings

Caller impact — AddNotification

Documented call sites inside the plugin (17):

flowchart LR
  UOperatingSystem__AddNotification["UOperatingSystem::AddNotification"]
  UOperatingSystemStatics__AddNotification["UOperatingSystemStatics::AddNotification"]
  UOperatingSystemStatics__AddNotification --> UOperatingSystem__AddNotification
  UOperatingSystemStatics__AddNotificationFromError["UOperatingSystemStatics::AddNotificationFromError"]
  UOperatingSystemStatics__AddNotificationFromError --> UOperatingSystem__AddNotification
  UOperatingSystem__AddRunningProgram["UOperatingSystem::AddRunningProgram"]
  UOperatingSystem__AddRunningProgram --> UOperatingSystem__AddNotification
  UOperatingSystem__CloseProgram["UOperatingSystem::CloseProgram"]
  UOperatingSystem__CloseProgram --> UOperatingSystem__AddNotification
  UOperatingSystem__ConsumeSpaceInGB["UOperatingSystem::ConsumeSpaceInGB"]
  UOperatingSystem__ConsumeSpaceInGB --> UOperatingSystem__AddNotification
  UOperatingSystem__ConsumeSpaceInMB["UOperatingSystem::ConsumeSpaceInMB"]
  UOperatingSystem__ConsumeSpaceInMB --> UOperatingSystem__AddNotification
  UOperatingSystemUserManager__CreateNewUser["UOperatingSystemUserManager::CreateNewUser"]
  UOperatingSystemUserManager__CreateNewUser --> UOperatingSystem__AddNotification
  UOperatingSystem__CreateProgramsFromRepository["UOperatingSystem::CreateProgramsFromRepository"]
  UOperatingSystem__CreateProgramsFromRepository --> UOperatingSystem__AddNotification
  UOperatingSystem__FinishInstallation["UOperatingSystem::FinishInstallation"]
  UOperatingSystem__FinishInstallation --> UOperatingSystem__AddNotification
  UOperatingSystem__InstallProgramFromClass["UOperatingSystem::InstallProgramFromClass"]
  UOperatingSystem__InstallProgramFromClass --> UOperatingSystem__AddNotification
  UOperatingSystem__InstallProgramFromPackage["UOperatingSystem::InstallProgramFromPackage"]
  UOperatingSystem__InstallProgramFromPackage --> UOperatingSystem__AddNotification
  UOperatingSystem__Internal_InstallProgram["UOperatingSystem::Internal_InstallProgram"]
  UOperatingSystem__Internal_InstallProgram --> UOperatingSystem__AddNotification
  UOperatingSystemNonUnix__PrepareOperatingSystemInstallImpl["UOperatingSystemNonUnix::PrepareOperatingSystemInstallImpl"]
  UOperatingSystemNonUnix__PrepareOperatingSystemInstallImpl --> UOperatingSystem__AddNotification
  UOperatingSystemUnix__PrepareOperatingSystemInstallImpl["UOperatingSystemUnix::PrepareOperatingSystemInstallImpl"]
  UOperatingSystemUnix__PrepareOperatingSystemInstallImpl --> UOperatingSystem__AddNotification
  UOperatingSystem__StartOperatingSystem["UOperatingSystem::StartOperatingSystem"]
  UOperatingSystem__StartOperatingSystem --> UOperatingSystem__AddNotification
  UOperatingSystemStore__SubmitRating["UOperatingSystemStore::SubmitRating"]
  UOperatingSystemStore__SubmitRating --> UOperatingSystem__AddNotification
  UOperatingSystem__UninstallProgram["UOperatingSystem::UninstallProgram"]
  UOperatingSystem__UninstallProgram --> UOperatingSystem__AddNotification

Caller impact — GetOperatingSystemPartition

Documented call sites inside the plugin (5):

flowchart LR
  UOperatingSystem__GetOperatingSystemPartition["UOperatingSystem::GetOperatingSystemPartition"]
  UOperatingSystem__CreateProgramsFromRepository["UOperatingSystem::CreateProgramsFromRepository"]
  UOperatingSystem__CreateProgramsFromRepository --> UOperatingSystem__GetOperatingSystemPartition
  UOperatingSystemUnix__CreateRootDirectory["UOperatingSystemUnix::CreateRootDirectory"]
  UOperatingSystemUnix__CreateRootDirectory --> UOperatingSystem__GetOperatingSystemPartition
  UOperatingSystem__InstallProgramFromClass["UOperatingSystem::InstallProgramFromClass"]
  UOperatingSystem__InstallProgramFromClass --> UOperatingSystem__GetOperatingSystemPartition
  UOperatingSystem__Internal_CreateDefaultDirectories["UOperatingSystem::Internal_CreateDefaultDirectories"]
  UOperatingSystem__Internal_CreateDefaultDirectories --> UOperatingSystem__GetOperatingSystemPartition
  UOperatingSystemTerminal__OnStart["UOperatingSystemTerminal::OnStart"]
  UOperatingSystemTerminal__OnStart --> UOperatingSystem__GetOperatingSystemPartition

Caller impact — IsProgramRunning

Documented call sites inside the plugin (2):

flowchart LR
  UOperatingSystem__IsProgramRunning["UOperatingSystem::IsProgramRunning"]
  UOperatingSystem__AddRunningProgram["UOperatingSystem::AddRunningProgram"]
  UOperatingSystem__AddRunningProgram --> UOperatingSystem__IsProgramRunning
  UOperatingSystem__UninstallProgram["UOperatingSystem::UninstallProgram"]
  UOperatingSystem__UninstallProgram --> UOperatingSystem__IsProgramRunning

Caller impact — GetDiskPartitions

Documented call sites inside the plugin (3):

flowchart LR
  UOperatingSystem__GetDiskPartitions["UOperatingSystem::GetDiskPartitions"]
  UOperatingSystemNonUnix__FindPartitionFromLetter["UOperatingSystemNonUnix::FindPartitionFromLetter"]
  UOperatingSystemNonUnix__FindPartitionFromLetter --> UOperatingSystem__GetDiskPartitions
  UOperatingSystemNonUnix__StartOperatingSystemImpl["UOperatingSystemNonUnix::StartOperatingSystemImpl"]
  UOperatingSystemNonUnix__StartOperatingSystemImpl --> UOperatingSystem__GetDiskPartitions
  UOperatingSystemUnix__StartOperatingSystemImpl["UOperatingSystemUnix::StartOperatingSystemImpl"]
  UOperatingSystemUnix__StartOperatingSystemImpl --> UOperatingSystem__GetDiskPartitions

Caller impact — GetOperatingSystemUniqueID

Documented call sites inside the plugin (3):

flowchart LR
  UOperatingSystem__GetOperatingSystemUniqueID["UOperatingSystem::GetOperatingSystemUniqueID"]
  UOperatingSystemUserManager__GetUserKey["UOperatingSystemUserManager::GetUserKey"]
  UOperatingSystemUserManager__GetUserKey --> UOperatingSystem__GetOperatingSystemUniqueID
  UOperatingSystemSaveGame__SaveGame["UOperatingSystemSaveGame::SaveGame"]
  UOperatingSystemSaveGame__SaveGame --> UOperatingSystem__GetOperatingSystemUniqueID
  UOperatingSystemBaseDevice__StartOperatingSystem["UOperatingSystemBaseDevice::StartOperatingSystem"]
  UOperatingSystemBaseDevice__StartOperatingSystem --> UOperatingSystem__GetOperatingSystemUniqueID

Represents an operating system in the simulation.

UOperatingSystem is a subclass of UObject and it contains various properties and methods related to an operating system, such as its name, version, supported devices, installed programs, etc. DO NOT inherit from this class directly. @See UOperatingSystemUnix @See UOperatingSystemNonUnix

Public Attributes

Return	Name	Description
FOnOperatingSystemWindowBroughtToFront	OnOperatingSystemWindowBroughtToFront
FOperatingSystemProgramDelegate	OnProgramStarted	Delegate representing the event when a program starts in the operating system.
FOperatingSystemProgramDelegate	OnProgramClosed	Delegate for handling the program closed event.
FOperatingSystemProgramDelegate	OnProgramInstalled	Delegate representing the event when a program is installed in the operating system.
FOperatingSystemProgramDelegate	OnProgramUninstalled

---

OnOperatingSystemWindowBroughtToFront

FOnOperatingSystemWindowBroughtToFront OnOperatingSystemWindowBroughtToFront

Defined in OperatingSystem.h:302

Referenced by

• Internal_BringWindowToFront

---

OnProgramStarted

FOperatingSystemProgramDelegate OnProgramStarted

Defined in OperatingSystem.h:327 Delegate representing the event when a program starts in the operating system.

This delegate is used to handle the event when a program starts in the operating system. It can be bound to functions or methods that need to be executed when a program is started.

Usage example:

UFUNCTION()
void HandleProgramStarted(UOperatingSystemBaseProgram* Program)
{
    // Code to handle program started event.
}

// Bind the delegate to the handler function.
OnProgramStarted.AddDynamic(this, &ThisClass::HandleProgramStarted);

See also: FOperatingSystemProgramDelegate

See also: UOperatingSystemBaseProgram

Referenced by

• ProgramStarted

---

OnProgramClosed

FOperatingSystemProgramDelegate OnProgramClosed

Defined in OperatingSystem.h:354 Delegate for handling the program closed event.

This delegate can be assigned a blueprint callable function to handle the event when the program is closed.

Example usage:

UFUNCTION()
void HandleProgramClosed(UOperatingSystemBaseProgram* Program)
{
    // Code to handle program closed event
}

void SomeFunction()
{
    // Assigning the blueprint callable function to the delegate
    OnProgramClosed.AddDynamic(this, &ThisClass::HandleProgramClosed);
}

See also: FOperatingSystemProgramDelegate

See also: UOperatingSystemBaseProgram

---

OnProgramInstalled

FOperatingSystemProgramDelegate OnProgramInstalled

Defined in OperatingSystem.h:381 Delegate representing the event when a program is installed in the operating system.

This delegate is used to handle the event when a program is installed in the operating system. It can be assigned a function or method with the appropriate signature to handle the event.

Example usage:

UFUNCTION()
void HandleProgramInstalled(UOperatingSystemBaseProgram* Program)
{
    // Code to handle program closed event
}

void SomeFunction()
{
    // Assigning the blueprint callable function to the delegate
    OnProgramInstalled.AddDynamic(this, &ThisClass::HandleProgramInstalled);
}

See also: FOperatingSystemProgramDelegate

See also: UOperatingSystemBaseProgram

Referenced by

• Internal_InstallProgram

---

OnProgramUninstalled

FOperatingSystemProgramDelegate OnProgramUninstalled

Defined in OperatingSystem.h:408

Referenced by

• UninstallProgram

Public Methods

Return	Name	Description
T *	GetAs const inline	Get a pointer to the object casted as type T.
constT *	GetAsConst const inline	Get a pointer to the object casted as type T.
bool	AddNotification	Adds a notification to the operating system.
bool	AddNotification	Adds a notification to the operating system. This method allows adding a notification to the operating system with the specified error, category, and verbosity.
void	StartOperatingSystem	Start the operating system. This method starts the operating system. It performs the necessary initialization and loads the settings and programs.
void	PostLoadOperatingSystem	Calls the PostLoadOperatingSystemImpl method and handles any error that occurs.
void	OnShowDesktop	Called from the widget after switching to the desktop view.
void	FinishInstallation	Finish the installation of the operating system.
void	InstallStartupPrograms	Install the startup programs for the operating system.
void	ShutdownOS	Shuts down the operating system.
void	RestartOS	Restarts the operating system.
void	DestroyOS	Destroys the operating system instance.
int32	AddRunningProgram	Adds a running program to the operating system.
void	ProgramStarted	Notifies the operating system that a program has started.
bool	IsProgramRunning const	Check if a program is running.
bool	IsProgramRunning const	Checks if a program of the specified class is currently running.
UDraggableWindow *	CreateNewWindow const	Creates a new window for the target program.
void	BringWindowToFront	Bring the specified window to the front.
UOperatingSystemDirectory *	CreateDirectoryInPath virtual	Creates a directory in the given target path.
bool	CreateProgramsFromRepository	Create programs from a given repository.
void	SetToInstallStartupPrograms	Sets whether to install startup programs.
bool	ShouldInstallStartupPrograms const	Determines whether the startup programs should be installed.
void	SetDeviceName	Sets the name of the device.
FText	GetDeviceName const	Returns the device name.
void	SetAutoLogin	Sets the auto login flag for the operating system.
bool	CanAutoLogin const	Checks if auto-login is enabled.
float	GetInstallationTime const	Retrieves the installation time of the operating system.
float	GetLoadingTime const	Get the loading time.
float	GetInitialLoadingTime const	Gets the initial loading time.
constTArray< FOperatingSystemNotification > &	GetNotifications const inline	Retrieves the notifications.
void	ClearAllNotifications	Clears all notifications on the operating system.
void	ConsumeSpaceInMB	Consume the given amount of space in megabytes (MB) from a specific operating system partition.
void	ConsumeSpaceInGB	Consume space on the operating system partition in gigabytes.
FText	GetSizeAsText const	Returns the size of the given partition.
float	GetStoragePercentage const	Returns the percentage of storage available. For example: 75%, 40% etc.
double	GetHardDiskSize const	Returns the Hard Disk total size in given method.
void	UninstallProgram	Uninstalls the given program identifier from this Operating System.
void	UninstallProgramByClass	Uninstalls the given program class from this Operating System.
UOperatingSystemBaseProgram *	InstallProgramFromPackage	Installs a program from a package.
UOperatingSystemBaseProgram *	InstallProgramFromClass	Installs the given program class. If target partition is null, system partition is automatically used.
bool	SetProgramAtStartup	Configures the application to run at system startup.
void	BeginInstallation	Begin installation of this Operating System. This is a simple timer which will call UOperatingSystem::FinishInstallation after the time returned by UOperatingSystem::GetInstallationTime()
UOperatingSystemPartition *	AllocatePartition	AllocatePartition is a method used to allocate a new partition on a specific device.
void	RemovePartition	Removes a partition from the operating system.
void	RefreshPartitions	Refreshes the partitions of the operating system.
void	InstallationCompleted	Marks the completion of the installation process.
bool	CreateNewUser	Creates a new user in the operating system.
bool	LoginUser	Logs the user in with the given username and password.
bool	UpdateCurrentUserDetails	Updates the details for the current user. If you don’t want specific settings to change simply leave them empty or null.
bool	HasEnoughSpace const	Check if a given partition has enough space for a given size.
TArray< UOperatingSystemPartition * >	GetDiskPartitions const	Retrieves the disk partitions associated with the operating system.
UOperatingSystemPartition *	GetOperatingSystemPartition const	Retrieves the operating system partition.
void	CloseProgram	Closes the given program.
bool	BringBackgroundProgramToFront	Brings a background program to the foreground and activates it. The program must be currently running in the background, otherwise an error will be returned.
bool	IsProgramInBackground const	Determines if the specified program is currently running in the background or not.
void	MinimizeProgram	Minimizes the specified program.
void	CloseAllRunningPrograms	Closes all running programs in the operating system.
void	RestoreMinimizedProgram	Restores a minimized program to the foreground on the operating system’s taskbar.
UObject *	GetDirectoryIconObject const	Retrieves the directory icon object associated with the specified tag.
bool	IsUnix const inline	Checks if the operating system is Unix.
float	GetBsodOnScreenTime const inline	Returns the duration, in seconds, that the blue screen of death has been visible on the screen.
float	GetToastNotificationDisplayTime const inline	Retrieves the display time for toast notifications.
TArray< UOperatingSystemBaseProgram * >	GetInstalledPrograms const	[DEPRECATED] Get the list of installed programs.
void	GetInstalledProgramsMap const	Gets the TMap of installed programs.
void	GetStartupPrograms	Gets the TMap of currently set startup programs.
UOperatingSystemProgramData *	FindProgramData const
void	AddProgramData
UOperatingSystemBaseProgram *	GetInstalledProgram const	Retrieves the installed program of the specified class.
bool	IsProgramInstalled const	Checks if a program is installed. This method checks if a program, represented by the provided UOperatingSystemBaseProgram subclass, is installed on the system.
UOperatingSystemBaseProgram *	GetRunningProgram const	Retrieves the running program that matches the given class.
bool	IsPreInstalledOperatingSystem const	Check if the operating system is pre-installed on the parent device.
UOperatingSystemSettingsData *	GetSettings const	Retrieves the settings data object for this Operating System.
bool	IsRunningOnPortableDevice const	Checks to see if this Operating System is running on a portable device actor.
UOperatingSystemPartition *	FindPartitionFromLetter virtual const inline	Find a partition in the operating system from a given disk letter.
TOptional< FText >	GetRootCommand virtual const inline	Retrieves the root command associated with the operating system.
TOptional< FOperatingSystemUser >	GetRootUser virtual const inline	Returns the root user of the operating system. This method retrieves the root user of the operating system and returns it as an optional object. If the root user cannot be determined or is not available, an empty optional object is returned.
bool	HasValidRootCommandAndUser const inline	Determines whether the root command and user are valid.
bool	IsShuttingDown const	Check if the operating system is in the process of shutting down.
bool	IsRestarting const	Checks if the operating system is currently restarting.
TArray< FOperatingSystemUser >	GetAllUsers const	Returns an array of all users registered in the operating system. This function retrieves information about all users registered in the operating system.

---

GetAs

const inline

template<classT> inline T * GetAs() const

Defined in OperatingSystem.h:417 Get a pointer to the object casted as type T.

Returns

A pointer to the object casted as type T.

method assumes that T is derived from UOperatingSystem. If not, a static_assert will be triggered.

---

GetAsConst

const inline

template<classT> inline constT * GetAsConst() const

Defined in OperatingSystem.h:427 Get a pointer to the object casted as type T.

Returns

A pointer to the object casted as type T.

method assumes that T is derived from UOperatingSystem. If not, a static_assert will be triggered. This returns a const object.

Referenced by

• HasRepository

---

AddNotification

bool AddNotification(constFOperatingSystemNotification & NewNotification)

Defined in OperatingSystem.h:481 Adds a notification to the operating system.

This method adds a notification to the operating system. It checks if notifications are enabled in the notification settings before adding the notification. If notifications are not enabled, this method returns false. If notifications are enabled, it creates a notification manager and logs the new notification.

If the new notification is an error, it increments the total error notifications count and plays an error notification sound if enabled. If the new notification is a warning, it increments the total warning notifications count and plays a warning notification sound if enabled. If the new notification is neither an error nor a warning, it plays the default notification sound if enabled.

Parameters

• NewNotification The notification to be added to the operating system.

Returns

Returns true if the notification is successfully added, false otherwise.

Referenced by

• AddNotification
• AddNotification
• AddNotificationFromError
• AddRunningProgram
• CloseProgram
• ConsumeSpaceInGB
• ConsumeSpaceInMB
• CreateNewUser
• CreateProgramsFromRepository
• FinishInstallation
• InstallProgramFromClass
• InstallProgramFromPackage
• Internal_InstallProgram
• PrepareOperatingSystemInstallImpl
• PrepareOperatingSystemInstallImpl
• StartOperatingSystem
• SubmitRating
• UninstallProgram

References

• bEnableNotifications
• bPlayNotificationSound
• GetSettings
• Internal_CreateNotificationManager
• NotificationSettings
• NotificationSoundDefault
• NotificationSoundError
• NotificationSoundWarning
• TotalErrorNotifications
• TotalNotifications
• TotalWarningNotifications

---

AddNotification

bool AddNotification(constFGenericError & GenericError, constEOperatingSystemNotificationCategory & Category, constEOperatingSystemNotificationType Verbosity = EOperatingSystemNotificationType::Error)

Defined in OperatingSystem.h:491 Adds a notification to the operating system. This method allows adding a notification to the operating system with the specified error, category, and verbosity.

Parameters

• GenericError The error information for the notification.

• Category The category of the notification.

• Verbosity Verbosity level.

References

• AddNotification
• GetSettings

---

StartOperatingSystem

void StartOperatingSystem(constTWeakObjectPtr< constUOperatingSystemSaveGame > LoadGameInstance, FGenericError & OutError)

Defined in OperatingSystem.h:502 Start the operating system. This method starts the operating system. It performs the necessary initialization and loads the settings and programs.

Parameters

• LoadGameInstance A weak pointer to an instance of UOperatingSystemSaveGame containing the saved game data to load. This parameter is optional and can be nullptr if no saved game is available.

• OutError A reference to an FGenericError object that will store any error that occurs during the startup process. Any error message will be stored in the OutError object.

References

• AddNotification
• BSODWidget
• CreateProgramsFromRepository
• CurrentUser
• FullBoot
• Get
• GetAnalyticsManager
• GetDefaultUser
• GetInstalledProgram
• GetLoadingTime
• GetSettings
• GetUserManager
• Info
• Internal_LoadSavedProgram
• Internal_LoadSettings
• Internal_PrepareInstall
• K2_CanStartOperatingSystem
• LOG_VV
• LOG_WITH_NAME
• MAKE_ERROR
• MustHavePrograms
• Name
• NOTIFICATION_OS
• OperatingSystemSettingsData
• OperatingSystemWidget
• ParentDevice
• PostInstallStartupPrograms
• SettingsDataClass
• StartOperatingSystemImpl
• StartupPrograms
• TimerHandle_LoadingTime
• Username
• WARN_WITH_NAME

---

PostLoadOperatingSystem

void PostLoadOperatingSystem()

Defined in OperatingSystem.h:515 Calls the PostLoadOperatingSystemImpl method and handles any error that occurs.

This method is responsible for initializing the operating system after it has been loaded. It calls the PostLoadOperatingSystemImpl method to perform the necessary initialization steps. If an error occurs during the initialization process, it sets the error in the BSODWidget and shows the Blue Screen of Death (BSOD) on the ParentDevice.

Note

This method should be called after the operating system has been loaded.

See also: PostLoadOperatingSystemImpl

References

• BSODWidget
• GetSettings
• ParentDevice
• PostLoadOperatingSystemImpl

---

OnShowDesktop

void OnShowDesktop()

Defined in OperatingSystem.h:520 Called from the widget after switching to the desktop view.

References

• GetSettings
• PendingStartupPrograms
• StartupPrograms

---

FinishInstallation

void FinishInstallation()

Defined in OperatingSystem.h:536 Finish the installation of the operating system.

This method is responsible for completing the installation process of the operating system. It performs several tasks such as creating default directories, installing startup programs, finishing the installation implementation, and notifying the user about the completion. After installation, it checks if this is the first start of the operating system and starts it if required.

Note

This method assumes that ParentDevice has been assigned properly before calling this method.

See also: UOperatingSystem::Internal_CreateDefaultDirectories()

See also: UOperatingSystem::InstallStartupPrograms()

See also: UOperatingSystem::FinishInstallationImpl()

Referenced by

• FinalizePreInstallation
• FinalizePreInstallation

References

• AddNotification
• bIsStartingForTheFirstTime
• Default
• FinishInstallationImpl
• GetSettings
• Info
• InstallStartupPrograms
• Internal_CreateDefaultDirectories
• LOG_WITH_NAME
• NOTIFICATION_OS
• OperatingSystemWidget
• ParentDevice

---

InstallStartupPrograms

void InstallStartupPrograms()

Defined in OperatingSystem.h:547 Install the startup programs for the operating system.

This method checks if the startup programs should be installed and then calls the InstallStartupProgramsImpl() method to perform the actual installation.

See also: ShouldInstallStartupPrograms()

See also: InstallStartupProgramsImpl()

Referenced by

• FinishInstallation

References

• InstallStartupProgramsImpl
• ShouldInstallStartupPrograms

---

ShutdownOS

void ShutdownOS()

Defined in OperatingSystem.h:555 Shuts down the operating system.

This method initiates the shutdown process for the operating system. It closes all running programs and triggers the shutdown procedure handled by the operating system widget.

References

• CloseAllRunningPrograms
• GetAnalyticsManager
• GetSettings
• Name
• OperatingSystemWidget
• ParentDevice

---

RestartOS

void RestartOS()

Defined in OperatingSystem.h:564 Restarts the operating system.

This method is used to restart the operating system. It first closes all the running programs and then initiates the restart process.

See also: CloseAllRunningPrograms(), OperatingSystemWidget

References

• CloseAllRunningPrograms
• GetAnalyticsManager
• GetSettings
• Name
• OperatingSystemWidget
• ParentDevice

---

DestroyOS

void DestroyOS()

Defined in OperatingSystem.h:578 Destroys the operating system instance.

This method is responsible for completely destroying the operating system instance and freeing up any resources it may have used. It performs the following actions:

• Resets the shared pointer to the notification manager.

• Resets the weak pointer to the last brought to front window.

• Removes the BSOD widget from its parent.

• Clears the list of installed programs.

• Clears the list of running programs.

• Removes the operating system widget from its parent.

• Resets the weak pointer to the parent device.

References

• BSODWidget
• GetSettings
• InstalledPrograms
• LastBroughtToFrontWindow
• OperatingSystemWidget
• ParentDevice
• RunningPrograms

---

AddRunningProgram

int32 AddRunningProgram(UOperatingSystemBaseProgram * NewProgram, FGenericError & OutError)

Defined in OperatingSystem.h:590 Adds a running program to the operating system.

This method adds a running program to the operating system. The program must be installed and the operating system must be in a running state. If the program is a single instance program, it checks if it is already running.

Parameters

• NewProgram The program to add to the operating system.

• OutError The error message if the program cannot be added.

Returns

The process ID of the added program, or INVALID_PROCESS_ID if the program cannot be added.

References

• AddNotification
• GetSettings
• INVALID_PROCESS_ID
• IsProgramRunning
• MAKE_ERROR
• NOTIFICATION_OS
• OS_LOG_VERY_VERBOSE
• ParentDevice
• RunningPrograms
• Verbose

---

ProgramStarted

void ProgramStarted(UOperatingSystemBaseProgram * StartedProgram, constbool bIsRestored)

Defined in OperatingSystem.h:607 Notifies the operating system that a program has started.

This method is used to inform the operating system that a program has started. It takes a pointer to the UOperatingSystemBaseProgram object representing the started program, and a boolean indicating whether the program is being restored from a minimized state.

If the started program has a valid taskbar button, this method adds it to the list of taskbar buttons. The taskbar button is identified by the process ID of the started program.

If the program is not being restored, the “OnProgramStarted” event is broadcasted, indicating that the program has started.

Parameters

• StartedProgram Pointer to the UOperatingSystemBaseProgram object representing the started program.

• bIsRestored Boolean indicating whether the program is being restored from a minimized state.

Referenced by

• BringBackgroundProgramToFront

References

• GetSettings
• OnProgramStarted
• TaskbarButtons

---

IsProgramRunning

const

bool IsProgramRunning(constTWeakObjectPtr< constUOperatingSystemBaseProgram > TestProgram) const

Defined in OperatingSystem.h:618 Check if a program is running.

This method checks if a program is currently running based on the provided TestProgram.

Parameters

• TestProgram A weak pointer to the UOperatingSystemBaseProgram object representing the program to be checked.

Returns

A boolean value indicating whether the program is running or not. Returns true if the TestProgram is valid and running, false otherwise.

Referenced by

• AddRunningProgram
• IsProgramRunning
• UninstallProgram

References

• GetSettings
• IsProgramRunning

---

IsProgramRunning

const

bool IsProgramRunning(constTSubclassOf< UOperatingSystemBaseProgram > TestProgramClass) const

Defined in OperatingSystem.h:626 Checks if a program of the specified class is currently running.

Parameters

• TestProgramClass The class of the program to check.

Returns

True if a program of the specified class is running, false otherwise.

References

• BackgroundRunningPrograms
• GetSettings
• RunningPrograms

---

CreateNewWindow

const

UDraggableWindow * CreateNewWindow(TWeakObjectPtr< UOperatingSystemBaseProgram > TargetProgram) const

Defined in OperatingSystem.h:636 Creates a new window for the target program.

This method creates a new window for the target program specified.

Parameters

• TargetProgram The target program for which the new window is to be created.

Returns

The newly created window object.

References

• GetSettings
• OperatingSystemWidget

---

BringWindowToFront

void BringWindowToFront(UDraggableWindow * TargetWindow)

Defined in OperatingSystem.h:647 Bring the specified window to the front.

This method is used to bring a draggable window to the front of all other windows in the operating system.

Parameters

• TargetWindow The window to bring to the front. Must be a valid draggable window.

Note

If the TargetWindow is already in front or invalid, this method has no effect.

Note

This method also updates the taskbar buttons to reflect the change in window focus.

References

• GetSettings
• Internal_BringWindowToFront
• Internal_SetTaskbarButtonStateToUnfocused
• LastBroughtToFrontWindow
• OperatingSystemWidget

---

CreateDirectoryInPath

virtual

virtual UOperatingSystemDirectory * CreateDirectoryInPath(constFString & TargetPath, constFString & DirectoryName, TSoftClassPtr< UOperatingSystemDirectory > DirectoryClass, UOperatingSystemPartition * TargetPartition, constbool bIsFromSaveGame, FGenericError & OutError)

Defined in OperatingSystem.h:661 Creates a directory in the given target path.

Parameters

• TargetPath The target path where the directory will be created.

• DirectoryName The name of the directory to be created.

• DirectoryClass The class of the directory to be created.

• TargetPartition The target partition where the directory will be created.

• bIsFromSaveGame Specifies whether the directory is created from a save game.

• OutError A reference to a FGenericError structure that will hold any error information.

Returns

A pointer to the created directory, or nullptr if the directory could not be created.

Referenced by

• Internal_LoadSettings

References

• GetSettings

Reimplemented by

• CreateDirectoryInPath
• CreateDirectoryInPath

---

CreateProgramsFromRepository

bool CreateProgramsFromRepository(constTSoftObjectPtr< UOperatingSystemProgramsCollection > & TargetRepository, constbool bIsInstalledWithOS)

Defined in OperatingSystem.h:841 Create programs from a given repository.

Parameters

• TargetRepository The repository from which to create the programs. Must not be null.

• bIsInstalledWithOS Determines whether the programs are installed with the operating system.

Returns

True if the program creation is successful, false otherwise.

Referenced by

• StartOperatingSystem

References

• AddNotification
• Error
• GetOperatingSystemPartition
• GetSettings
• Internal_InstallProgram
• NOTIFICATION_OS
• OS_LOG
• OS_LOG_VERBOSE

---

SetToInstallStartupPrograms

void SetToInstallStartupPrograms(constbool bInstall)

Defined in OperatingSystem.h:852 Sets whether to install startup programs.

This method allows you to specify whether the operating system should install startup programs.

Parameters

• bInstall A boolean value indicating whether startup programs should be installed. Set to true if startup programs should be installed, false otherwise.

References

• bInstallStartupPrograms
• GetSettings

---

ShouldInstallStartupPrograms

const

bool ShouldInstallStartupPrograms() const

Defined in OperatingSystem.h:866 Determines whether the startup programs should be installed.

Returns

• true if the startup programs should be installed.

• false otherwise.

This method checks if the PostInstallStartupPrograms is null or empty. It also checks if the flag bInstallStartupPrograms is set to true. If both conditions are satisfied, the method returns true; otherwise, it returns false.

Referenced by

• InstallStartupPrograms

References

• bInstallStartupPrograms
• PostInstallStartupPrograms

---

SetDeviceName

void SetDeviceName(constFText & NewName)

Defined in OperatingSystem.h:875 Sets the name of the device.

This method allows the user to set the name of the device.

Parameters

• NewName The new name of the device.

References

• DeviceName
• GetSettings

---

GetDeviceName

const

FText GetDeviceName() const

Defined in OperatingSystem.h:883 Returns the device name.

Returns

The device name as a FText object.

References

• DeviceName

---

SetAutoLogin

void SetAutoLogin(constbool bEnableAutoLogin)

Defined in OperatingSystem.h:894 Sets the auto login flag for the operating system.

This method allows the user to enable or disable auto login for the operating system.

Parameters

• bEnableAutoLogin - The value indicating whether auto login should be enabled or disabled.

• true: Auto login is enabled.

• false: Auto login is disabled.

References

• bAutoLogin
• GetSettings

---

CanAutoLogin

const

bool CanAutoLogin() const

Defined in OperatingSystem.h:904 Checks if auto-login is enabled.

This method returns a boolean value indicating whether the auto-login feature is enabled or not.

Returns

true if auto-login is enabled, false otherwise.

See also: SetAutoLoginEnabled()

References

• bAutoLogin

---

GetInstallationTime

const

float GetInstallationTime() const

Defined in OperatingSystem.h:915 Retrieves the installation time of the operating system.

Returns

The installation time of the operating system in seconds.

Note

This method returns the cached installation time if it has been previously set. If the cached installation time has not been set, it retrieves the installation time from the system and caches it for future use.

Referenced by

• BeginInstallation

References

• GetSettings
• GetTime
• InstallationTime
• LOG_VV

---

GetLoadingTime

const

float GetLoadingTime() const

Defined in OperatingSystem.h:927 Get the loading time.

This method returns the loading time. If the loading time has not been previously set, it will calculate the loading time and store it in a cached variable for future retrieval. The loading time is obtained from the LoadingTime object.

Returns

The loading time in seconds.

Referenced by

• StartOperatingSystem

References

• GetSettings
• GetTime
• LoadingTime
• LOG_VV

---

GetInitialLoadingTime

const

float GetInitialLoadingTime() const

Defined in OperatingSystem.h:938 Gets the initial loading time.

This method returns the initial loading time of the operating system. If the initial loading time has not been cached yet, it will retrieve the value from the LoadingTimeInitial object and cache it for future requests.

Returns

The initial loading time in seconds.

References

• GetSettings
• GetTime
• LoadingTimeInitial
• LOG_VV

---

GetNotifications

const inline

inline constTArray< FOperatingSystemNotification > & GetNotifications() const

Defined in OperatingSystem.h:946 Retrieves the notifications.

Returns

The array of operating system notifications.

---

ClearAllNotifications

void ClearAllNotifications()

Defined in OperatingSystem.h:952 Clears all notifications on the operating system.

References

• GetSettings

---

ConsumeSpaceInMB

void ConsumeSpaceInMB(constfloat & NewSizeInMB, UOperatingSystemPartition * Partition, FGenericError & OutError)

Defined in OperatingSystem.h:969 Consume the given amount of space in megabytes (MB) from a specific operating system partition.

This method consumes space from the specified partition of the operating system by delegating the task to the associated hard disk object. If the hard disk is not valid, an error is thrown and returned through the OutError parameter. If consuming space from the partition fails, an error notification is added.

Parameters

• NewSizeInMB The amount of space to consume in megabytes (MB).

• Partition The operating system partition from which to consume the space.

• OutError An FGenericError object used to return any errors that occur during the operation.

See also: UOperatingSystemHDD

See also: FGenericError

See also: AddNotification

Referenced by

• Internal_InstallProgram

References

• AddNotification
• Error
• GetSettings
• MAKE_ERROR
• NOTIFICATION_OS
• ParentDevice

---

ConsumeSpaceInGB

void ConsumeSpaceInGB(constfloat & NewSizeInGB, UOperatingSystemPartition * Partition, FGenericError & OutError)

Defined in OperatingSystem.h:983 Consume space on the operating system partition in gigabytes.

Parameters

• NewSizeInGB The amount of space to consume in gigabytes.

• Partition The operating system partition on which to consume the space.

• OutError (out) The error message if the operation fails.

Note

This method retrieves the hard disk associated with the operating system and calls the ConsumeSpaceInGB method on the hard disk to perform the actual space consumption. If the operation fails, a notification is added to the operating system.

Referenced by

• BeginInstallation

References

• AddNotification
• Error
• GetSettings
• MAKE_ERROR
• NOTIFICATION_OS
• ParentDevice

---

GetSizeAsText

const

FText GetSizeAsText(constEOperatingSystemSizeMethod SizeMethod, constUOperatingSystemPartition * Partition, FGenericError & OutError) const

Defined in OperatingSystem.h:994 Returns the size of the given partition.

Parameters

• SizeMethod Your preferred method. Bytes, Megabytes or Gigabytes.

• Partition Target partition to check size.

• OutError Outputs error (if any).

Returns

[FText] Return text in the format {Size} {SizeString}. For example: 256 GB.

References

• GetSettings
• MAKE_ERROR
• ParentDevice

---

GetStoragePercentage

const

float GetStoragePercentage(constUOperatingSystemPartition * Partition, FGenericError & OutError) const

Defined in OperatingSystem.h:1002 Returns the percentage of storage available. For example: 75%, 40% etc.

Returns

[float] Percentage of storage remaining in 0 - 100 range.

References

• GetSettings
• MAKE_ERROR
• ParentDevice

---

GetHardDiskSize

const

double GetHardDiskSize(FGenericError & OutError, constEOperatingSystemSizeMethod SizeMethod = EOperatingSystemSizeMethod::GB) const

Defined in OperatingSystem.h:1012 Returns the Hard Disk total size in given method.

Parameters

• OutError [FGenericError&] If any error this will be valid.

• SizeMethod [const EOperatingSystemSizeMethod] How you want to represent the return size to be.

Returns

[double] Size in given method.

References

• GetSettings
• MAKE_ERROR
• ParentDevice

---

UninstallProgram

void UninstallProgram(constFName & ProgramIdentifier, FGenericError & OutErrorIfAny)

Defined in OperatingSystem.h:1021 Uninstalls the given program identifier from this Operating System.

Parameters

• ProgramIdentifier Identifier of the program to uninstall.

• OutErrorIfAny Outputs uninstall error (if any).

Referenced by

• UninstallProgramByClass

References

• AddNotification
• ConvertMB_ToBytes
• GetSettings
• InstalledPrograms
• IsProgramRunning
• MAKE_ERROR
• OnProgramUninstalled
• OperatingSystem
• ParentDevice
• SaveGame
• SetProgramAtStartup

---

UninstallProgramByClass

void UninstallProgramByClass(constTSoftClassPtr< UOperatingSystemBaseProgram > ProgramClass, FGenericError & OutErrorIfAny)

Defined in OperatingSystem.h:1030 Uninstalls the given program class from this Operating System.

Parameters

• ProgramClass Target program class to uninstall.

• OutErrorIfAny Outputs uninstall error (if any).

References

• GetSettings
• MAKE_ERROR
• UninstallProgram

---

InstallProgramFromPackage

UOperatingSystemBaseProgram * InstallProgramFromPackage(constFName & ProgramIdentifier, FGenericError & OutErrorIfAny)

Defined in OperatingSystem.h:1045 Installs a program from a package.

This method installs a program from a package specified by the ProgramIdentifier parameter. If the program is found in the package repository, it will be installed and a pointer to the installed program will be returned. If the program is not found, an error message will be assigned to the OutErrorIfAny parameter and a nullptr will be returned.

Parameters

• ProgramIdentifier The identifier of the program to install.

• OutErrorIfAny [out] The error message if program installation fails.

Returns

A pointer to the installed program, or nullptr if program installation fails.

References

• AddNotification
• FindProgramFromPackage
• GetSettings
• InstallProgramFromClass
• MAKE_ERROR
• OperatingSystem

---

InstallProgramFromClass

UOperatingSystemBaseProgram * InstallProgramFromClass(FGenericError & OutErrorIfAny, constTSoftClassPtr< UOperatingSystemBaseProgram > ProgramClass, UOperatingSystemPartition * TargetPartition = nullptr)

Defined in OperatingSystem.h:1056 Installs the given program class. If target partition is null, system partition is automatically used.

Parameters

• OutErrorIfAny Outputs any error. Use the IsValid from this struct to check if there are any errors.

• ProgramClass Target program class to install

• TargetPartition Target partition to install. If null, then system partition is automatically used.

Returns

Valid program if installed. Null otherwise.

Referenced by

• InstallProgramFromPackage

References

• AddNotification
• GetOperatingSystemPartition
• GetSettings
• Internal_InstallProgram
• MAKE_ERROR
• OperatingSystem

---

SetProgramAtStartup

bool SetProgramAtStartup(UOperatingSystemBaseProgram * TargetProgram, constbool bRunAtStartup)

Defined in OperatingSystem.h:1071 Configures the application to run at system startup.

This function enables or disables the ability for the program to automatically start when the operating system boots.

Parameters

• TargetProgram A pointer to the UOperatingSystemBaseProgram object representing the program to configure.

• bRunAtStartup A boolean indicating whether to enable (true) or disable (false) the application’s startup at system boot.

Returns

A boolean indicating the success of the operation. Returns true if the operation succeeds, false otherwise.

Referenced by

• Internal_InstallProgram
• UninstallProgram

References

• GetSettings
• OS_CLOG_VERBOSE
• OS_LOG_VERBOSE
• StartupPrograms

---

BeginInstallation

void BeginInstallation(UOperatingSystemPartition * TargetPartition, FGenericError & OutError)

Defined in OperatingSystem.h:1081 Begin installation of this Operating System. This is a simple timer which will call UOperatingSystem::FinishInstallation after the time returned by UOperatingSystem::GetInstallationTime()

Parameters

• TargetPartition Which partition to install to? Must not be null.

• OutError [FGenericError&] Outputs error (if any). Use the IsValid in this struct to check if there was any error.

Referenced by

• FinalizePreInstallation
• FinalizePreInstallation

References

• ConsumeSpaceInGB
• GetInstallationTime
• GetSettings
• InstallationSpace
• LOG_WITH_NAME
• MAKE_ERROR
• OS_LOG_ERROR
• ParentDevice
• TargetPartitionID
• TimerHandle_OperatingSystemInstallation

---

AllocatePartition

UOperatingSystemPartition * AllocatePartition(constdouble SizeInBytes, FGenericError & OutError)

Defined in OperatingSystem.h:1091 AllocatePartition is a method used to allocate a new partition on a specific device.

Parameters

• SizeInBytes - The size of the partition to allocate in bytes.

• OutError - Reference to an FGenericError object that will hold any error that occurs during partition allocation.

Returns

A pointer to the allocated UOperatingSystemPartition object, or nullptr if an error occurred during allocation.

Referenced by

• FinalizePreInstallation
• FinalizePreInstallation

References

• CreateNewPartition
• GetSettings
• MAKE_ERROR
• OS_LOG_ERROR
• ParentDevice

---

RemovePartition

void RemovePartition(UOperatingSystemPartition * PartitionToDelete, FGenericError & OutError)

Defined in OperatingSystem.h:1100 Removes a partition from the operating system.

Parameters

• PartitionToDelete The partition to be removed.

• OutError The error message if any error occurs.

References

• GetSettings
• MAKE_ERROR
• ParentDevice

---

RefreshPartitions

void RefreshPartitions()

Defined in OperatingSystem.h:1109 Refreshes the partitions of the operating system.

This method updates the partitions of the operating system based on the current state of the underlying hardware device.

References

• GetSettings
• ParentDevice

---

InstallationCompleted

void InstallationCompleted(constbool bSwitchToDesktop = true)

Defined in OperatingSystem.h:1122 Marks the completion of the installation process.

This method sets the ‘bIsStartingForTheTime’ flag to false in order to indicate that the operating system has finished its initial setup. It also triggers the ‘OnFinishSettingUpOperatingSystemPostInstallation’ event on the parent device.

Optionally, this method switches the current tab of the operating system widget to the desktop tab.

Parameters

• bSwitchToDesktop Whether to switch the current tab to the desktop tab (default: true)

References

• bIsStartingForTheFirstTime
• GetSettings
• OperatingSystemWidget
• ParentDevice

---

CreateNewUser

bool CreateNewUser(constFOperatingSystemUser & NewUser, constbool bSetAsActive = false)

Defined in OperatingSystem.h:1132 Creates a new user in the operating system.

Parameters

• NewUser The information of the new user to be created.

• bSetAsActive Determines if the new user should be set as the active user.

Returns

True if the new user was successfully created, false otherwise.

References

• CurrentUser
• GetSettings
• GetUserManager

---

LoginUser

bool LoginUser(constFText & Username, constFText & Password)

Defined in OperatingSystem.h:1142 Logs the user in with the given username and password.

Parameters

• Username The username of the user.

• Password The password of the user.

Returns

True if the user was successfully logged in, false otherwise.

References

• CurrentUser
• GetSettings
• GetUserManager

---

UpdateCurrentUserDetails

bool UpdateCurrentUserDetails(constFOperatingSystemUser & UpdatedDetails)

Defined in OperatingSystem.h:1151 Updates the details for the current user. If you don’t want specific settings to change simply leave them empty or null.

Parameters

• UpdatedDetails Settings to update. If a setting is left null or empty, that is not updated.

Returns

True if the details were updated. False otherwise.

References

• CurrentUser
• GetSettings
• GetUserManager

---

HasEnoughSpace

const

bool HasEnoughSpace(constdouble & TestSizeInBytes, constUOperatingSystemPartition * InPartition) const

Defined in OperatingSystem.h:1161 Check if a given partition has enough space for a given size.

Parameters

• TestSizeInBytes The size to test in bytes.

• InPartition The partition to check the space on.

Returns

True if the partition has enough space, false otherwise.

Referenced by

• Internal_InstallProgram

References

• GetSettings
• ParentDevice

---

GetDiskPartitions

const

TArray< UOperatingSystemPartition * > GetDiskPartitions() const

Defined in OperatingSystem.h:1169 Retrieves the disk partitions associated with the operating system.

Returns

An array of UOperatingSystemPartition pointers representing the disk partitions.

Referenced by

• FindPartitionFromLetter
• StartOperatingSystemImpl
• StartOperatingSystemImpl

References

• GetSettings
• ParentDevice

---

GetOperatingSystemPartition

const

UOperatingSystemPartition * GetOperatingSystemPartition() const

Defined in OperatingSystem.h:1178 Retrieves the operating system partition.

Returns

A pointer to the operating system partition.

Note

The returned pointer may be null if the operating system partition is not found.

Referenced by

• CreateProgramsFromRepository
• CreateRootDirectory
• InstallProgramFromClass
• Internal_CreateDefaultDirectories
• OnStart

References

• GetSettings
• ParentDevice
• TargetPartitionID

---

CloseProgram

void CloseProgram(UOperatingSystemBaseProgram * TargetProgram, FGenericError & OutError)

Defined in OperatingSystem.h:1187 Closes the given program.

Parameters

• TargetProgram The program to close.

• OutError The error encountered during the process.

Referenced by

• CloseAllRunningPrograms

References

• AddNotification
• BackgroundRunningPrograms
• Error
• Focused
• FullClose
• GetSettings
• IsRestarting
• IsShuttingDown
• LastFocusedTaskbarButton
• MAKE_ERROR
• NotFocused
• NOTIFICATION_OS
• PreviousFocusedTaskbarButton
• RunningPrograms
• TaskbarButtons

---

BringBackgroundProgramToFront

bool BringBackgroundProgramToFront(UOperatingSystemBaseProgram * TargetProgram)

Defined in OperatingSystem.h:1198 Brings a background program to the foreground and activates it. The program must be currently running in the background, otherwise an error will be returned.

Parameters

• TargetProgram The program to bring to the front.

Returns

True if the program was successfully brought to the front, false otherwise. If false is returned, the specific error will be logged.

References

• BackgroundRunningPrograms
• GetOperatingSystemProgramRestoredEventName
• GetSettings
• MAKE_ERROR
• OS_LOG_ERROR
• OS_LOG_VERBOSE
• ProgramStarted

---

IsProgramInBackground

const

bool IsProgramInBackground(UOperatingSystemBaseProgram * TestProgram) const

Defined in OperatingSystem.h:1207 Determines if the specified program is currently running in the background or not.

Parameters

• TestProgram A pointer to the UOperatingSystemBaseProgram object to be tested.

Returns

true if the program is running in the background, false otherwise.

References

• BackgroundRunningPrograms
• GetRunningProgram
• GetSettings
• INVALID_PROCESS_ID

---

MinimizeProgram

void MinimizeProgram(UOperatingSystemBaseProgram * TargetProgram)

Defined in OperatingSystem.h:1215 Minimizes the specified program.

Parameters

• TargetProgram The program to minimize.

References

• GetSettings
• Internal_BringWindowToFront
• Internal_SetTaskbarButtonStateToUnfocused
• Minimized
• NotFocused
• PreviousFocusedTaskbarButton
• TaskbarButtons

---

CloseAllRunningPrograms

void CloseAllRunningPrograms()

Defined in OperatingSystem.h:1225 Closes all running programs in the operating system.

This method iterates over all the running programs in the operating system and calls the CloseProgram method to close each program. If an error occurs while closing a program, an error is generated and stored in OutError.

Referenced by

• RestartOS
• ShutdownOS

References

• BackgroundRunningPrograms
• CloseProgram
• GetSettings
• RunningPrograms

---

RestoreMinimizedProgram

void RestoreMinimizedProgram(constUOperatingSystemBaseProgram * TargetProgram)

Defined in OperatingSystem.h:1241 Restores a minimized program to the foreground on the operating system’s taskbar.

This method attempts to restore the specified program identified by the given TargetProgram. If the program is currently minimized, it will be brought back to the foreground on the taskbar.

Parameters

• TargetProgram The target program to restore. It must be a valid pointer to an instance of the UOperatingSystemBaseProgram class.

Note

If the TargetProgram is not a valid pointer, this method will do nothing. The specified TargetProgram must be a previously registered taskbar button on the operating system.

See also: UOperatingSystemBaseProgram, ChangeTaskbarState()

References

• Focused
• GetSettings
• LastFocusedTaskbarButton
• PreviousFocusedTaskbarButton
• TaskbarButtons

---

GetDirectoryIconObject

const

UObject * GetDirectoryIconObject(constFGameplayTag & TestTag) const

Defined in OperatingSystem.h:1259 Retrieves the directory icon object associated with the specified tag.

Parameters

• TestTag The tag used to determine the directory icon object.

Returns

The directory icon object.

Note

The returned object is loaded synchronously.

References

• DirectoryIcons
• GetSettings

---

IsUnix

const inline

inline bool IsUnix() const

Defined in OperatingSystem.h:1267 Checks if the operating system is Unix.

Returns

True if the operating system is Unix, false otherwise.

Referenced by

• GetPathDelimiter

---

GetBsodOnScreenTime

const inline

inline float GetBsodOnScreenTime() const

Defined in OperatingSystem.h:1275 Returns the duration, in seconds, that the blue screen of death has been visible on the screen.

Returns

The time, in seconds, that the blue screen of death has been on screen.

---

GetToastNotificationDisplayTime

const inline

inline float GetToastNotificationDisplayTime() const

Defined in OperatingSystem.h:1283 Retrieves the display time for toast notifications.

Returns

The display time for toast notifications in seconds.

---

GetInstalledPrograms

const

TArray< UOperatingSystemBaseProgram * > GetInstalledPrograms() const

Defined in OperatingSystem.h:1292 [DEPRECATED] Get the list of installed programs.

Returns

An array of UOperatingSystemBaseProgram objects representing the installed programs.

References

• GetSettings
• InstalledPrograms

---

GetInstalledProgramsMap

const

void GetInstalledProgramsMap(TMap< FName, UOperatingSystemBaseProgram * > & OutInstalledPrograms) const

Defined in OperatingSystem.h:1300 Gets the TMap of installed programs.

Parameters

• OutInstalledPrograms TMap of all installed programs with key set to their identifier.

References

• GetSettings
• InstalledPrograms

---

GetStartupPrograms

void GetStartupPrograms(TMap< FName, UOperatingSystemBaseProgram * > & OutStartupPrograms)

Defined in OperatingSystem.h:1306 Gets the TMap of currently set startup programs.

References

• GetSettings
• InstalledPrograms
• StartupPrograms

---

FindProgramData

const

UOperatingSystemProgramData * FindProgramData(constUOperatingSystemBaseProgram * TargetProgram) const

Defined in OperatingSystem.h:1308

References

• GetSettings
• ProgramDataObjs

---

AddProgramData

void AddProgramData(constUOperatingSystemBaseProgram * TargetProgram, UOperatingSystemProgramData * DataToAdd)

Defined in OperatingSystem.h:1309

References

• GetSettings
• ProgramDataObjs

---

GetInstalledProgram

const

UOperatingSystemBaseProgram * GetInstalledProgram(constTSoftClassPtr< UOperatingSystemBaseProgram > TestClass) const

Defined in OperatingSystem.h:1322 Retrieves the installed program of the specified class.

This method searches for an installed program in the list of installed programs that matches the specified class. If a matching program is found, it is returned; otherwise nullptr is returned.

Parameters

• TestClass The pointer to the class of the program to retrieve.

Returns

The installed program of the specified class, or nullptr if not found.

Referenced by

• IsProgramInstalled
• StartOperatingSystem

References

• GetIdentifier
• GetSettings
• InstalledPrograms

---

IsProgramInstalled

const

bool IsProgramInstalled(constTSoftClassPtr< UOperatingSystemBaseProgram > TestClass) const

Defined in OperatingSystem.h:1332 Checks if a program is installed. This method checks if a program, represented by the provided UOperatingSystemBaseProgram subclass, is installed on the system.

Parameters

• TestClass The TSoftClassPtr<UOperatingSystemBaseProgram> representing the program to be checked.

Returns

true if the program is installed, false otherwise.

References

• GetInstalledProgram
• GetSettings

---

GetRunningProgram

const

UOperatingSystemBaseProgram * GetRunningProgram(constTSoftClassPtr< UOperatingSystemBaseProgram > TestClass) const

Defined in OperatingSystem.h:1341 Retrieves the running program that matches the given class.

Parameters

• TestClass A soft class pointer to the program class.

Returns

A pointer to the running program that matches the given class, or nullptr if not found or TestClass is null.

Referenced by

• IsProgramInBackground

References

• GetSettings
• RunningPrograms

---

IsPreInstalledOperatingSystem

const

bool IsPreInstalledOperatingSystem() const

Defined in OperatingSystem.h:1350 Check if the operating system is pre-installed on the parent device.

Returns

True if the operating system is pre-installed, false otherwise.

Note

This method is a wrapper around the IsOperatingSystemPreInstalled method of the parent device.

References

• Default
• ParentDevice

---

GetSettings

const

UOperatingSystemSettingsData * GetSettings() const

Defined in OperatingSystem.h:1358 Retrieves the settings data object for this Operating System.

Returns

Settings data if one was created.

Referenced by

• AddNotification
• AddNotification
• AddProgramData
• AddRunningProgram
• AllocatePartition
• BeginInstallation
• BringBackgroundProgramToFront
• BringWindowToFront
• ClearAllNotifications
• CloseAllRunningPrograms
• CloseProgram
• ConsumeSpaceInGB
• ConsumeSpaceInMB
• CreateDirectoryInPath
• CreateDirectoryInPath
• CreateDirectoryInPath
• CreateNewUser
• CreateNewWindow
• CreateOperatingSystem
• CreateProgramsFromRepository
• CreateRootDirectory
• DestroyOS
• FinalizePreInstallation
• FinalizePreInstallation
• FindDiskLetterAtIndex
• FindPartitionFromLetter
• FindProgramData
• FindProgramFromPackage
• FinishInstallation
• GetDirectoryIconObject
• GetDiskPartitions
• GetHardDiskSize
• GetInitialLoadingTime
• GetInstallationTime
• GetInstalledProgram
• GetInstalledPrograms
• GetInstalledProgramsMap
• GetLoadingTime
• GetOperatingSystemPartition
• GetOperatingSystemUniqueID
• GetRootCommand
• GetRunningProgram
• GetSizeAsText
• GetStartupPrograms
• GetStoragePercentage
• HasEnoughSpace
• InstallationCompleted
• InstallProgramFromClass
• InstallProgramFromPackage
• Internal_BringWindowToFront
• Internal_CreateDefaultDirectories
• Internal_CreateNotificationManager
• Internal_FinalizePreInstallation
• Internal_InstallProgram
• Internal_LoadSavedProgram
• Internal_LoadSettings
• Internal_PrepareInstall
• Internal_RunPendingStartupProgram
• Internal_SetTaskbarButtonStateToUnfocused
• Internal_Validate
• IsProgramInBackground
• IsProgramInstalled
• IsProgramRunning
• IsProgramRunning
• LoginUser
• MinimizeProgram
• OnPartitionLoaded
• OnShowDesktop
• OnShowNotification
• OnValidate
• PostLoadOperatingSystem
• PostLoadOperatingSystemImpl
• PostLoadOperatingSystemImpl
• ProgramStarted
• RefreshPartitions
• RemovePartition
• RestartOS
• RestoreMinimizedProgram
• SaveBundledWallpaper
• SaveCustomWallpaper
• SetAutoLogin
• SetDeviceName
• SetProgramAtStartup
• SetToInstallStartupPrograms
• ShutdownOS
• StartOperatingSystem
• StartOperatingSystemImpl
• StartOperatingSystemImpl
• UninstallProgram
• UninstallProgramByClass
• UOperatingSystemUnixPhone
• UpdateCurrentUserDetails

References

• OperatingSystemSettingsData

---

IsRunningOnPortableDevice

const

bool IsRunningOnPortableDevice() const

Defined in OperatingSystem.h:1366 Checks to see if this Operating System is running on a portable device actor.

Returns

True if this Operating System is running on a portable device actor.

References

• ParentDevice

---

FindPartitionFromLetter

virtual const inline

virtual inline UOperatingSystemPartition * FindPartitionFromLetter(constFName & TargetDiskLetter) const

Defined in OperatingSystem.h:1378 Find a partition in the operating system from a given disk letter.

This method searches for an operating system partition that corresponds to the provided disk letter.

Parameters

• TargetDiskLetter The disk letter to search for. It should be of type FName.

Returns

A pointer to the found operating system partition. If no partition is found, nullptr is returned.

Note

By default, this function always return nullptr.

Reimplemented by

• FindPartitionFromLetter

---

GetRootCommand

virtual const inline

virtual inline TOptional< FText > GetRootCommand() const

Defined in OperatingSystem.h:1388 Retrieves the root command associated with the operating system.

Returns

The root command as an optional text. If no root command is set, an empty optional is returned.

Note

By default, this function returns unset optional parameter.

See also: UOperatingSystemUnix::GetRootCommand

Referenced by

• ProcessCommand

Reimplemented by

• GetRootCommand

---

GetRootUser

virtual const inline

virtual inline TOptional< FOperatingSystemUser > GetRootUser() const

Defined in OperatingSystem.h:1404 Returns the root user of the operating system. This method retrieves the root user of the operating system and returns it as an optional object. If the root user cannot be determined or is not available, an empty optional object is returned.

Returns

An optional object of type FOperatingSystemUser that represents the root user of the operating system. An empty optional object is returned if the root user cannot be determined.

Note

The root user is a special user account in Unix-like operating systems that has administrative privileges and unrestricted access to all files and commands on the system.

Note

By default, this function returns unset optional paramter.

See also: UOperatingSystemUnix::GetRootUser.

Referenced by

• ChangeCurrentUser
• ProcessCommand

Reimplemented by

• GetRootUser

---

HasValidRootCommandAndUser

const inline

inline bool HasValidRootCommandAndUser() const

Defined in OperatingSystem.h:1416 Determines whether the root command and user are valid.

This method checks if the root command and user are both set, indicating that a valid root command and user have been provided.

Returns

True if both the root command and user are set, otherwise false.

Note

This function should be true in UOperatingSystemUnix.

Referenced by

• ProcessCommand

---

IsShuttingDown

const

bool IsShuttingDown() const

Defined in OperatingSystem.h:1442 Check if the operating system is in the process of shutting down.

This method determines whether the operating system is currently in the process of shutting down. It does this by calling the IsShuttingDown() method of the ParentDevice object.

Returns

True if the operating system is in the process of shutting down, false otherwise.

Referenced by

• CloseProgram

References

• ParentDevice

---

IsRestarting

const

bool IsRestarting() const

Defined in OperatingSystem.h:1449 Checks if the operating system is currently restarting.

Returns

True if the operating system is restarting, false otherwise.

Referenced by

• CloseProgram

References

• ParentDevice

---

GetAllUsers

const

TArray< FOperatingSystemUser > GetAllUsers() const

Defined in OperatingSystem.h:1459 Returns an array of all users registered in the operating system. This function retrieves information about all users registered in the operating system.

Returns

An array of FOperatingSystemUser objects representing the registered users.

See also: FOperatingSystemUser, UOperatingSystemStatics::GetUserManager()

References

• GetUserManager

Public Static Methods

Return	Name	Description
FName	GetOperatingSystemProgramRestoredEventName static inline	Helper function that returns the name of the event that is triggered when a program is restored in the Operating System.
UOperatingSystem *	CreateOperatingSystem static	Creates a new instance of the operating system associated with the specified device.
FString	GetOperatingSystemUniqueID static	Gets the unique ID of the operating system. This method retrieves the unique ID of the operating system represented by the given TestOperatingSystem object.

---

GetOperatingSystemProgramRestoredEventName

static inline

static inline FName GetOperatingSystemProgramRestoredEventName()

Defined in OperatingSystem.h:443 Helper function that returns the name of the event that is triggered when a program is restored in the Operating System.

Returns

The event name for program restored event.

Referenced by

• BringBackgroundProgramToFront

---

CreateOperatingSystem

static

static UOperatingSystem * CreateOperatingSystem(UOperatingSystemBaseDevice * OwningDevice, FGenericError & OutError)

Defined in OperatingSystem.h:456 Creates a new instance of the operating system associated with the specified device.

This method creates a new instance of the operating system associated with the specified device. If the operating system class is null, an error will be returned indicating that the operating system is missing. Otherwise, a new instance of the operating system will be created and initialized.

Parameters

• OwningDevice The device that the operating system belongs to.

• OutError The error object that will be populated if an error occurs during the creation process.

Returns

A pointer to the newly created operating system instance, or nullptr if an error occurred.

Referenced by

• OnDeviceStartRunning

References

• CreateBsodWidget
• CreateOperatingSystemWidget
• FullBoot
• GetAnalyticsManager
• GetOperatingSystemClass
• GetSettings
• Internal_Validate
• MAKE_ERROR
• NEW_SOFT_OBJ
• OperatingSystemPreInstalled
• OS_LOG
• OS_LOG_ERROR

---

GetOperatingSystemUniqueID

static

static FString GetOperatingSystemUniqueID(constUOperatingSystem * TestOperatingSystem)

Defined in OperatingSystem.h:465 Gets the unique ID of the operating system. This method retrieves the unique ID of the operating system represented by the given TestOperatingSystem object.

Parameters

• TestOperatingSystem The operating system object to get the unique ID from.

Returns

A string representing the unique ID of the operating system.

Referenced by

• GetUserKey
• SaveGame
• StartOperatingSystem

References

• GetSettings

Protected Attributes

Return	Name	Description
FTimerHandle	TimerHandle_OperatingSystemInstallation	Timer handle for operating system installation.
FTimerHandle	TimerHandle_LoadingTime	Timer handle for loading time.
FText	Name	Name of this operating system. Think of this as just Windows or MacOS or Ubuntu etc.
FText	CompanyName	Company that made this operating system. Think of this as just Microsoft or Apple or Canonical etc.
FOperatingSystemVersion	Version	Current version of this Operating System.
TSoftObjectPtr< UObject >	Icon	An icon (either texture or user interface material) for this Operating System.
TMap< FGameplayTag, TSoftObjectPtr< UObject > >	DirectoryIcons	Icons for each type of directory.
float	InstallationSpace	Space required by this OS for installation. Remember, this is all simulated so don’t worry about anything related to your PC.
FGameplayTagContainer	SupportedDevices	List of devices this Operating System supports. If empty, it is assumed all devices are supported.
TSoftObjectPtr< UOperatingSystemProgramsCollection >	MustHavePrograms	These are programs that must be installed with Operating System. For example: File explorer, terminal, web browser etc.
TSoftObjectPtr< UOperatingSystemProgramsCollection >	PostInstallStartupPrograms	List of programs that can be optionally installed after installing the Operating System.
TSoftObjectPtr< UOperatingSystemDirectoriesCollection >	DefaultDirectories	Default directories to automatically create when installing this Operating System.
TSoftClassPtr< UOperatingSystemSettingsData >	SettingsDataClass	A data class that holds all settings (like theme, wallpapers etc) for this Operating System.
TSoftClassPtr< UOperatingSystemWidget >	WidgetClass	Operating System Widget class.
TSoftClassPtr< UOperatingSystemBsodWidget >	BsodWidgetClass	Operating System Widget class.
FOperatingSystemNotificationSettings	NotificationSettings	Notification settings.
FOperatingSystemRangeTime	InstallationTime	Installation time for installing this Operating System.
FOperatingSystemRangeTime	LoadingTime	Time it takes for the Operating System to show loading screen and then change to logon screen.
FOperatingSystemRangeTime	LoadingTimeInitial	Time it takes for the Operating System to load for the first time after installation. Typically this will be set higher than Loading Time.
FOperatingSystemRangeTime	LogonToDesktopTime	Time it takes to transition from Logon screen to Desktop.
FOperatingSystemRangeTime	BsodOnScreenTime	Time it takes for BSOD to stay on screen
FGameplayTag	OperatingSystemTag	Tag to identify this Operating System.
TWeakObjectPtr< UOperatingSystemBaseDevice >	ParentDevice	The device this Operating System is running on.
TObjectPtr< UOperatingSystemSettingsData >	OperatingSystemSettingsData	Settings data for this operating system.
TObjectPtr< UOperatingSystemWidget >	OperatingSystemWidget	Reference to the Operating System widget.
TMap< int32, TObjectPtr< UOperatingSystemBaseProgram > >	RunningPrograms	All running programs in this Operating System. The key is the Process ID and value is the program.
TMap< int32, TObjectPtr< UOperatingSystemBaseProgram > >	BackgroundRunningPrograms	All running programs in background. The key is the Process ID and value is the program.
TMap< FName, UOperatingSystemBaseProgram * >	InstalledPrograms	All the programs that are currently installed.
TMap< FName, UOperatingSystemProgramData * >	ProgramDataObjs
FOperatingSystemUser	CurrentUser	Active user.
uint8	bIsStartingForTheFirstTime	True if the Operating System is starting for the first time after installation.
int32	TotalNotifications	Total notifications received.
int32	TotalErrorNotifications	Total error notifications received.
int32	TotalWarningNotifications	Total warning notifications received.
TObjectPtr< UOperatingSystemBsodWidget >	BSODWidget	Current BSOD widget.
TMap< int32, TWeakObjectPtr< UOperatingSystemTaskbarButton > >	TaskbarButtons	Transient variable representing the taskbar buttons. It is a TMap that associates integer keys with weak object pointers to UOperatingSystemTaskbarButton objects. Key will be the process ID. Value will be the program.
TWeakObjectPtr< UOperatingSystemTaskbarButton >	PreviousFocusedTaskbarButton
TWeakObjectPtr< UOperatingSystemTaskbarButton >	LastFocusedTaskbarButton
TMap< FName, TWeakObjectPtr< UOperatingSystemBaseProgram > >	StartupPrograms	Programs that are set to automatically run when Operating System starts.
TArray< TWeakObjectPtr< UOperatingSystemBaseProgram > >	PendingStartupPrograms
FOperatingSystemUniqueId	TargetPartitionID	Structure representing a unique identifier for a target partition in the operating system.
TWeakObjectPtr< UDraggableWindow >	LastBroughtToFrontWindow	Transient variable representing the last draggable window brought to the front.
uint8	bAutoLogin	Specifies whether the application should automatically login the user.
uint8	bInstallStartupPrograms	Specifies whether to install startup programs on the operating system.
FText	DeviceName	Can be computer name also like JohnDoes-PC.

---

TimerHandle_OperatingSystemInstallation

FTimerHandle TimerHandle_OperatingSystemInstallation

Defined in OperatingSystem.h:96 Timer handle for operating system installation.

Referenced by

• BeginInstallation
• FinalizePreInstallation
• FinalizePreInstallation

---

TimerHandle_LoadingTime

FTimerHandle TimerHandle_LoadingTime

Defined in OperatingSystem.h:99 Timer handle for loading time.

Referenced by

• StartOperatingSystem

---

Name

FText Name

Defined in OperatingSystem.h:103 Name of this operating system. Think of this as just Windows or MacOS or Ubuntu etc.

Referenced by

• Internal_LoadSettings
• Internal_Validate
• OnValidate
• RestartOS
• ShutdownOS
• StartOperatingSystem

---

CompanyName

FText CompanyName

Defined in OperatingSystem.h:107 Company that made this operating system. Think of this as just Microsoft or Apple or Canonical etc.

---

Version

FOperatingSystemVersion Version

Defined in OperatingSystem.h:111 Current version of this Operating System.

---

Icon

TSoftObjectPtr< UObject > Icon

Defined in OperatingSystem.h:115 An icon (either texture or user interface material) for this Operating System.

---

DirectoryIcons

TMap< FGameplayTag, TSoftObjectPtr< UObject > > DirectoryIcons

Defined in OperatingSystem.h:119 Icons for each type of directory.

Referenced by

• GetDirectoryIconObject
• Internal_Validate

---

InstallationSpace

float InstallationSpace

Defined in OperatingSystem.h:123 Space required by this OS for installation. Remember, this is all simulated so don’t worry about anything related to your PC.

Referenced by

• BeginInstallation
• Internal_Validate

---

SupportedDevices

FGameplayTagContainer SupportedDevices

Defined in OperatingSystem.h:127 List of devices this Operating System supports. If empty, it is assumed all devices are supported.

Referenced by

• Internal_Validate

---

MustHavePrograms

TSoftObjectPtr< UOperatingSystemProgramsCollection > MustHavePrograms

Defined in OperatingSystem.h:131 These are programs that must be installed with Operating System. For example: File explorer, terminal, web browser etc.

Referenced by

• Internal_Validate
• StartOperatingSystem

---

PostInstallStartupPrograms

TSoftObjectPtr< UOperatingSystemProgramsCollection > PostInstallStartupPrograms

Defined in OperatingSystem.h:135 List of programs that can be optionally installed after installing the Operating System.

Referenced by

• ShouldInstallStartupPrograms
• StartOperatingSystem

---

DefaultDirectories

TSoftObjectPtr< UOperatingSystemDirectoriesCollection > DefaultDirectories

Defined in OperatingSystem.h:139 Default directories to automatically create when installing this Operating System.

Referenced by

• CreateRootDirectory
• Internal_CreateDefaultDirectories
• Internal_Validate
• OnValidate

---

SettingsDataClass

TSoftClassPtr< UOperatingSystemSettingsData > SettingsDataClass

Defined in OperatingSystem.h:143 A data class that holds all settings (like theme, wallpapers etc) for this Operating System.

Referenced by

• StartOperatingSystem

---

WidgetClass

TSoftClassPtr< UOperatingSystemWidget > WidgetClass

Defined in OperatingSystem.h:147 Operating System Widget class.

Referenced by

• Internal_Validate
• UOperatingSystemUnixPhone

---

BsodWidgetClass

TSoftClassPtr< UOperatingSystemBsodWidget > BsodWidgetClass

Defined in OperatingSystem.h:151 Operating System Widget class.

---

NotificationSettings

FOperatingSystemNotificationSettings NotificationSettings

Defined in OperatingSystem.h:155 Notification settings.

Referenced by

• AddNotification
• Internal_CreateNotificationManager

---

InstallationTime

FOperatingSystemRangeTime InstallationTime

Defined in OperatingSystem.h:159 Installation time for installing this Operating System.

Referenced by

• GetInstallationTime

---

LoadingTime

FOperatingSystemRangeTime LoadingTime

Defined in OperatingSystem.h:163 Time it takes for the Operating System to show loading screen and then change to logon screen.

Referenced by

• GetLoadingTime

---

LoadingTimeInitial

FOperatingSystemRangeTime LoadingTimeInitial

Defined in OperatingSystem.h:167 Time it takes for the Operating System to load for the first time after installation. Typically this will be set higher than Loading Time.

Referenced by

• GetInitialLoadingTime

---

LogonToDesktopTime

FOperatingSystemRangeTime LogonToDesktopTime

Defined in OperatingSystem.h:171 Time it takes to transition from Logon screen to Desktop.

---

BsodOnScreenTime

FOperatingSystemRangeTime BsodOnScreenTime

Defined in OperatingSystem.h:175 Time it takes for BSOD to stay on screen

---

OperatingSystemTag

FGameplayTag OperatingSystemTag

Defined in OperatingSystem.h:179 Tag to identify this Operating System.

Referenced by

• Internal_Validate
• UOperatingSystemUnixPhone

---

ParentDevice

TWeakObjectPtr< UOperatingSystemBaseDevice > ParentDevice

Defined in OperatingSystem.h:183 The device this Operating System is running on.

Referenced by

• AddRunningProgram
• AllocatePartition
• BeginInstallation
• ConsumeSpaceInGB
• ConsumeSpaceInMB
• DestroyOS
• FinalizePreInstallation
• FinalizePreInstallation
• FinishInstallation
• GetDiskPartitions
• GetHardDiskSize
• GetOperatingSystemPartition
• GetSizeAsText
• GetStoragePercentage
• HasEnoughSpace
• InstallationCompleted
• Internal_InstallProgram
• Internal_LoadSettings
• Internal_PrepareInstall
• Internal_Validate
• IsPreInstalledOperatingSystem
• IsRestarting
• IsRunningOnPortableDevice
• IsShuttingDown
• PostLoadOperatingSystem
• PostLoadOperatingSystemImpl
• PostLoadOperatingSystemImpl
• RefreshPartitions
• RemovePartition
• RestartOS
• ShutdownOS
• StartOperatingSystem
• UninstallProgram

---

OperatingSystemSettingsData

TObjectPtr< UOperatingSystemSettingsData > OperatingSystemSettingsData

Defined in OperatingSystem.h:187 Settings data for this operating system.

Referenced by

• GetSettings
• Internal_LoadSettings
• StartOperatingSystem

---

OperatingSystemWidget

TObjectPtr< UOperatingSystemWidget > OperatingSystemWidget

Defined in OperatingSystem.h:191 Reference to the Operating System widget.

Referenced by

• BringWindowToFront
• CreateNewWindow
• DestroyOS
• FinishInstallation
• InstallationCompleted
• Internal_BringWindowToFront
• OnAllOnNotificationsCleared
• OnShowNotification
• PostLoadOperatingSystemImpl
• PostLoadOperatingSystemImpl
• PrepareOperatingSystemInstallImpl
• PrepareOperatingSystemInstallImpl
• RestartOS
• ShutdownOS
• StartOperatingSystem

---

RunningPrograms

TMap< int32, TObjectPtr< UOperatingSystemBaseProgram > > RunningPrograms

Defined in OperatingSystem.h:195 All running programs in this Operating System. The key is the Process ID and value is the program.

Referenced by

• AddRunningProgram
• CloseAllRunningPrograms
• CloseProgram
• DestroyOS
• GetRunningProgram
• IsProgramRunning

---

BackgroundRunningPrograms

TMap< int32, TObjectPtr< UOperatingSystemBaseProgram > > BackgroundRunningPrograms

Defined in OperatingSystem.h:199 All running programs in background. The key is the Process ID and value is the program.

Referenced by

• BringBackgroundProgramToFront
• CloseAllRunningPrograms
• CloseProgram
• IsProgramInBackground
• IsProgramRunning

---

InstalledPrograms

TMap< FName, UOperatingSystemBaseProgram * > InstalledPrograms

Defined in OperatingSystem.h:203 All the programs that are currently installed.

Referenced by

• DestroyOS
• GetInstalledProgram
• GetInstalledPrograms
• GetInstalledProgramsMap
• GetStartupPrograms
• Internal_InstallProgram
• Internal_LoadSavedProgram
• UninstallProgram

---

ProgramDataObjs

TMap< FName, UOperatingSystemProgramData * > ProgramDataObjs

Defined in OperatingSystem.h:206

Referenced by

• AddProgramData
• FindProgramData

---

CurrentUser

FOperatingSystemUser CurrentUser

Defined in OperatingSystem.h:210 Active user.

Referenced by

• CreateNewUser
• LoginUser
• StartOperatingSystem
• UpdateCurrentUserDetails

---

bIsStartingForTheFirstTime

uint8 bIsStartingForTheFirstTime

Defined in OperatingSystem.h:214 True if the Operating System is starting for the first time after installation.

Referenced by

• FinishInstallation
• InstallationCompleted
• Internal_LoadSettings

---

TotalNotifications

int32 TotalNotifications

Defined in OperatingSystem.h:218 Total notifications received.

Referenced by

• AddNotification
• OnAllOnNotificationsCleared

---

TotalErrorNotifications

int32 TotalErrorNotifications

Defined in OperatingSystem.h:222 Total error notifications received.

Referenced by

• AddNotification
• OnAllOnNotificationsCleared

---

TotalWarningNotifications

int32 TotalWarningNotifications

Defined in OperatingSystem.h:226 Total warning notifications received.

Referenced by

• AddNotification
• OnAllOnNotificationsCleared

---

BSODWidget

TObjectPtr< UOperatingSystemBsodWidget > BSODWidget

Defined in OperatingSystem.h:230 Current BSOD widget.

Referenced by

• DestroyOS
• PostLoadOperatingSystem
• StartOperatingSystem

---

TaskbarButtons

TMap< int32, TWeakObjectPtr< UOperatingSystemTaskbarButton > > TaskbarButtons

Defined in OperatingSystem.h:239 Transient variable representing the taskbar buttons. It is a TMap that associates integer keys with weak object pointers to UOperatingSystemTaskbarButton objects. Key will be the process ID. Value will be the program.

Referenced by

• CloseProgram
• Internal_SetTaskbarButtonStateToUnfocused
• MinimizeProgram
• ProgramStarted
• RestoreMinimizedProgram

---

PreviousFocusedTaskbarButton

TWeakObjectPtr< UOperatingSystemTaskbarButton > PreviousFocusedTaskbarButton

Defined in OperatingSystem.h:242

Referenced by

• CloseProgram
• MinimizeProgram
• RestoreMinimizedProgram

---

LastFocusedTaskbarButton

TWeakObjectPtr< UOperatingSystemTaskbarButton > LastFocusedTaskbarButton

Defined in OperatingSystem.h:245

Referenced by

• CloseProgram
• RestoreMinimizedProgram

---

StartupPrograms

TMap< FName, TWeakObjectPtr< UOperatingSystemBaseProgram > > StartupPrograms

Defined in OperatingSystem.h:249 Programs that are set to automatically run when Operating System starts.

Referenced by

• GetStartupPrograms
• OnShowDesktop
• SetProgramAtStartup
• StartOperatingSystem

---

PendingStartupPrograms

TArray< TWeakObjectPtr< UOperatingSystemBaseProgram > > PendingStartupPrograms

Defined in OperatingSystem.h:252

Referenced by

• Internal_RunPendingStartupProgram
• OnShowDesktop

---

TargetPartitionID

FOperatingSystemUniqueId TargetPartitionID

Defined in OperatingSystem.h:260 Structure representing a unique identifier for a target partition in the operating system.

This identifier is transient, meaning it is not meant to be stored or persisted. It is used for temporary identification purposes only.

Referenced by

• BeginInstallation
• GetOperatingSystemPartition
• Internal_LoadSettings

---

LastBroughtToFrontWindow

TWeakObjectPtr< UDraggableWindow > LastBroughtToFrontWindow

Defined in OperatingSystem.h:271 Transient variable representing the last draggable window brought to the front.

It is a weak pointer to an instance of UDraggableWindow class. This variable is transient, meaning that it is not serialized and doesn’t persist across sessions.

See also: UDraggableWindow

Referenced by

• BringWindowToFront
• DestroyOS

---

bAutoLogin

uint8 bAutoLogin

Defined in OperatingSystem.h:275 Specifies whether the application should automatically login the user.

Referenced by

• CanAutoLogin
• Internal_LoadSettings
• SetAutoLogin

---

bInstallStartupPrograms

uint8 bInstallStartupPrograms

Defined in OperatingSystem.h:283 Specifies whether to install startup programs on the operating system.

See also: SetToInstallStartupPrograms

See also: ShouldInstallStartupPrograms

Referenced by

• SetToInstallStartupPrograms
• ShouldInstallStartupPrograms

---

DeviceName

FText DeviceName

Defined in OperatingSystem.h:298 Can be computer name also like JohnDoes-PC.

Referenced by

• GetDeviceName
• Internal_LoadSettings
• SetDeviceName

Protected Methods

Return	Name	Description
void	OnShowNotification virtual	This method is called when a new notification should be shown on the operating system.
void	OnAllOnNotificationsCleared virtual	Callback triggered when all notifications are cleared.
void	OnValidate virtual const inline	This method is called to validate the object’s state. This method should be overridden by derived classes to provide specific validation logic for the object. The validation result should be stored in the OutError parameter. If there are any validation errors, they should be added to the OutError object using its MAKE_ERROR macro.
void	FinalizePreInstallation virtual inline	Finalizes the pre-installation process.
void	PrepareOperatingSystemInstallImpl virtual inline	Prepares the operating system for installation.
bool	StartOperatingSystemImpl virtual inline	Starts the implementation of the operating system.
void	PostLoadOperatingSystemImpl virtual inline	This method is responsible for performing additional actions after the operating system is loaded.
void	FinishInstallationImpl virtual inline	Performs the finishing steps of the installation process.
void	InstallStartupProgramsImpl virtual inline	Allows the derived classes to implement their own logic for installing startup programs. This method should be overridden in derived classes to define the actual logic for installing startup programs.
void	OnPartitionLoaded virtual inline	Callback method called when a partition is loaded.
TSoftClassPtr< UOperatingSystemBaseProgram >	FindProgramFromPackage virtual inline	Finds the program corresponding to the given package identifier. This method searches for a program based on the provided package identifier.
bool	K2_CanStartOperatingSystem	Determines if the operating system can start.

---

OnShowNotification

virtual

virtual void OnShowNotification(constFOperatingSystemNotification & NewNotification)

Defined in OperatingSystem.h:683 This method is called when a new notification should be shown on the operating system.

Parameters

• NewNotification The new notification to be shown.

Note

This method is responsible for displaying the notification on the operating system.

References

• GetSettings
• OperatingSystemWidget

---

OnAllOnNotificationsCleared

virtual

virtual void OnAllOnNotificationsCleared()

Defined in OperatingSystem.h:692 Callback triggered when all notifications are cleared.

This function is called when all notifications are cleared in the operating system. It resets the total number of notifications, error notifications, and warning notifications. Then it calls the AllNotificationsCleared() function of the OperatingSystemWidget.

References

• OperatingSystemWidget
• TotalErrorNotifications
• TotalNotifications
• TotalWarningNotifications

---

OnValidate

virtual const inline

virtual inline void OnValidate(FGenericError & OutError) const

Defined in OperatingSystem.h:705 This method is called to validate the object’s state. This method should be overridden by derived classes to provide specific validation logic for the object. The validation result should be stored in the OutError parameter. If there are any validation errors, they should be added to the OutError object using its MAKE_ERROR macro.

Note

By default, this function does nothing.

Parameters

• OutError Reference to an FGenericError object that will be populated with any validation errors.

See also: FGenericError

Referenced by

• Internal_Validate

Reimplemented by

• OnValidate

---

FinalizePreInstallation

virtual inline

virtual inline void FinalizePreInstallation(FGenericError & OutError)

Defined in OperatingSystem.h:719 Finalizes the pre-installation process.

This method is used to perform any necessary finalization steps before installation. It is called during the pre-installation phase.

Parameters

• OutError Reference to a FGenericError object that will be used to store any error information that occurs during the finalization process.

Note

By default, this function does nothing.

See also: FGenericError

Referenced by

• Internal_FinalizePreInstallation

Reimplemented by

• FinalizePreInstallation
• FinalizePreInstallation

---

PrepareOperatingSystemInstallImpl

virtual inline

virtual inline void PrepareOperatingSystemInstallImpl(FGenericError & OutError)

Defined in OperatingSystem.h:731 Prepares the operating system for installation.

This method is virtual and can be overridden in derived classes to implement the specific logic for preparing the operating system for installation. The implementation should set the error message in the provided FGenericError object if any error occurs during the preparation process.

Parameters

• OutError A reference to the FGenericError object to store any error message generated during the preparation process.

Note

By default, this function does nothing.

See also: FGenericError

Referenced by

• Internal_PrepareInstall

Reimplemented by

• PrepareOperatingSystemInstallImpl
• PrepareOperatingSystemInstallImpl

---

StartOperatingSystemImpl

virtual inline

virtual inline bool StartOperatingSystemImpl(FGenericError & OutError)

Defined in OperatingSystem.h:745 Starts the implementation of the operating system.

This method starts the implementation of the operating system. It performs the necessary steps to initiate the operating system functionality.

Parameters

• OutError Reference to a FGenericError object that will store any errors that occur during the operation.

Note

By default, this function always return false. Child class must override this function and do the logic.

Returns

False by default.

See also: FGenericError

Referenced by

• StartOperatingSystem

Reimplemented by

• StartOperatingSystemImpl
• StartOperatingSystemImpl

---

PostLoadOperatingSystemImpl

virtual inline

virtual inline void PostLoadOperatingSystemImpl(FGenericError & OutError)

Defined in OperatingSystem.h:753 This method is responsible for performing additional actions after the operating system is loaded.

Parameters

• OutError A reference to the FGenericError object that can be used to report any errors that occur during the post-load process.

See also: FGenericError

Referenced by

• PostLoadOperatingSystem

Reimplemented by

• PostLoadOperatingSystemImpl
• PostLoadOperatingSystemImpl

---

FinishInstallationImpl

virtual inline

virtual inline void FinishInstallationImpl()

Defined in OperatingSystem.h:763 Performs the finishing steps of the installation process.

This method should be implemented by derived classes to perform any necessary operations to finalize the installation process. It is called after all the installation steps have been completed.

Note

By default, this function does nothing.

Referenced by

• FinishInstallation

---

InstallStartupProgramsImpl

virtual inline

virtual inline void InstallStartupProgramsImpl()

Defined in OperatingSystem.h:771 Allows the derived classes to implement their own logic for installing startup programs. This method should be overridden in derived classes to define the actual logic for installing startup programs.

Note

By default, this function does nothing.

Referenced by

• InstallStartupPrograms

---

OnPartitionLoaded

virtual inline

virtual inline void OnPartitionLoaded(UOperatingSystemPartition & LoadedPartition, constFOperatingSystemPartitionSaveLoad & SaveLoadData)

Defined in OperatingSystem.h:781 Callback method called when a partition is loaded.

Parameters

• LoadedPartition The reference to the loaded partition.

• SaveLoadData The save/load data for the partition.

Note

By default, this function does nothing.

Referenced by

• Internal_LoadSettings

Reimplemented by

• OnPartitionLoaded

---

FindProgramFromPackage

virtual inline

virtual inline TSoftClassPtr< UOperatingSystemBaseProgram > FindProgramFromPackage(constFName & ProgramIdentifier)

Defined in OperatingSystem.h:792 Finds the program corresponding to the given package identifier. This method searches for a program based on the provided package identifier.

Parameters

• ProgramIdentifier The package identifier of the program to be found.

Returns

A pointer to the soft class representing the found program. Returns nullptr if no program is found.

Note

By default, this function returns nullptr.

Referenced by

• InstallProgramFromPackage

Reimplemented by

• FindProgramFromPackage

---

K2_CanStartOperatingSystem

bool K2_CanStartOperatingSystem(FGenericError & ReturnError)

Defined in OperatingSystem.h:1431 Determines if the operating system can start.

This method checks if the operating system can start successfully. It is a BlueprintImplementableEvent, which means that it can be implemented in Blueprint classes.

Parameters

• ReturnError [out] A reference to a FGenericError structure that will hold the error message if the operating system cannot start.

Returns

True if the operating system can start, false otherwise.

Referenced by

• StartOperatingSystem

Private Methods

Return	Name	Description
void	Internal_CreateDefaultDirectories
void	Internal_PrepareInstall
void	Internal_FinalizePreInstallation
void	Internal_Validate const	Perform internal validation of the operating system. This method performs internal validation of the operating system. It checks various criteria to ensure that the operating system is valid.
void	Internal_CreateNotificationManager	Internal method called to create the notification manager for the operating system.
constFOperatingSystemDeviceSaveLoad *	Internal_LoadSettings	Internal method to load the settings for the operating system.
void	Internal_RunPendingStartupProgram
UOperatingSystemBaseProgram *	Internal_InstallProgram	Installs a program in the operating system.
void	Internal_LoadSavedProgram	Loads a saved program into the operating system.
void	Internal_SetTaskbarButtonStateToUnfocused
void	Internal_BringWindowToFront

---

Internal_CreateDefaultDirectories

void Internal_CreateDefaultDirectories(FGenericError & OutError)

Defined in OperatingSystem.h:669

Referenced by

• FinishInstallation

References

• CreateDirectory
• DefaultDirectories
• GetOperatingSystemPartition
• GetSettings
• OS_LOG_VERBOSE

---

Internal_PrepareInstall

void Internal_PrepareInstall(FGenericError & OutError)

Defined in OperatingSystem.h:670

Referenced by

• StartOperatingSystem

References

• Default
• GetSettings
• Internal_FinalizePreInstallation
• LOG_WITH_NAME
• ParentDevice
• PrepareOperatingSystemInstallImpl

---

Internal_FinalizePreInstallation

void Internal_FinalizePreInstallation(FGenericError & OutError)

Defined in OperatingSystem.h:672

Referenced by

• Internal_PrepareInstall

References

• FinalizePreInstallation
• GetSettings

---

Internal_Validate

const

void Internal_Validate(FGenericError & OutError) const

Defined in OperatingSystem.h:802 Perform internal validation of the operating system. This method performs internal validation of the operating system. It checks various criteria to ensure that the operating system is valid.

Parameters

• OutError The reference to FGenericError object that will be populated with error information if any validation errors occur.

References

• DefaultDirectories
• DirectoryIcons
• GetSettings
• InstallationSpace
• MAKE_ERROR
• MustHavePrograms
• Name
• OnValidate
• OperatingSystemTag
• ParentDevice
• SupportedDevices
• WidgetClass

---

Internal_CreateNotificationManager

void Internal_CreateNotificationManager()

Defined in OperatingSystem.h:814 Internal method called to create the notification manager for the operating system.

This method creates an instance of the notification manager only if it doesn’t already exist. The notification manager is responsible for handling the display and management of operating system notifications.

The notification manager is created using the current world and the toast notification time defined in the notification settings. The OnShowNotification event is bound to the OnShowNotification method of the class, and the OnClearAllNotifications event is bound to the OnAllNotificationsCleared method of the class.

Referenced by

• AddNotification

References

• CreateNotificationManager
• GetSettings
• LOG_VV
• NotificationSettings
• ToastNotificationTime

---

Internal_LoadSettings

constFOperatingSystemDeviceSaveLoad * Internal_LoadSettings(constTWeakObjectPtr< constUOperatingSystemSaveGame > LoadGameInstance, FGenericError & OutError)

Defined in OperatingSystem.h:831 Internal method to load the settings for the operating system.

This method is used to load the settings for the operating system. It is an internal method and is not intended to be called directly from outside the class. This method loads the settings from the provided save game instance and applies them to the operating system. It also checks if the necessary modules and partitions are present and handles the error accordingly.

Note

The LoadGameInstance parameter should not be null or invalid.

Note

This method assumes that the OperatingSystemSettingsData member variable has been properly initialized.

Note

This method assumes that the ParentDevice and HardDisk members have been properly initialized.

Note

This method assumes that the HddTag member has been properly set.

Parameters

• LoadGameInstance The instance of the save game to load the settings from.

• OutError The error to be filled in case of any failure.

Referenced by

• StartOperatingSystem

References

• bAutoLogin
• bIsStartingForTheFirstTime
• CreateDirectoryInPath
• DeviceName
• FindSettingModuleFromClass
• GetSettings
• MAKE_ERROR
• Name
• OnPartitionLoaded
• OperatingSystemSettingsData
• ParentDevice
• TargetPartitionID
• ToString
• WARN_WITH_NAME

---

Internal_RunPendingStartupProgram

void Internal_RunPendingStartupProgram()

Defined in OperatingSystem.h:1473

References

• GetSettings
• PendingStartupPrograms

---

Internal_InstallProgram

UOperatingSystemBaseProgram * Internal_InstallProgram(constTSoftClassPtr< UOperatingSystemBaseProgram > & TargetProgram, UOperatingSystemPartition * TargetPartition, FGenericError & OutError, constbool bIsSystemInstalled = false)

Defined in OperatingSystem.h:1485 Installs a program in the operating system.

Parameters

• TargetProgram The program to be installed.

• TargetPartition The partition where the program will be installed.

• OutError The error that occurred during installation, if any.

• bIsSystemInstalled Flag indicating whether the program is a system program.

Returns

A pointer to the installed program, or nullptr if installation failed.

Referenced by

• CreateProgramsFromRepository
• InstallProgramFromClass

References

• AddNotification
• ConsumeSpaceInMB
• ConvertMB_ToBytes
• CreateProgram
• GetSettings
• HasEnoughSpace
• InstalledPrograms
• MAKE_ERROR
• OnProgramInstalled
• OperatingSystem
• ParentDevice
• SaveGame
• SetProgramAtStartup

---

Internal_LoadSavedProgram

void Internal_LoadSavedProgram(constTSoftClassPtr< UOperatingSystemBaseProgram > & TargetProgram, UOperatingSystemPartition * TargetPartition)

Defined in OperatingSystem.h:1508 Loads a saved program into the operating system.

This method loads a saved program into the operating system and adds it to the list of installed programs. The program is associated with the specified target partition.

Parameters

• TargetProgram The reference to the soft class pointer of the target program to be loaded.

• TargetPartition The pointer to the target partition where the program will be associated with.

Preconditions

• The TargetProgram must not be null.

• The TargetPartition must be a valid pointer.

Postconditions

• The program is loaded into the operating system.

• The program is added to the list of installed programs.

• The program is associated with the specified target partition.

See also: UOperatingSystemBaseProgram::CreateProgram

See also: InstalledPrograms

See also: UOperatingSystemBaseProgram::SetParentPartition

Referenced by

• StartOperatingSystem

References

• CreateProgram
• GetSettings
• InstalledPrograms

---

Internal_SetTaskbarButtonStateToUnfocused

void Internal_SetTaskbarButtonStateToUnfocused()

Defined in OperatingSystem.h:1510

Referenced by

• BringWindowToFront
• MinimizeProgram

References

• Focused
• GetSettings
• NotFocused
• TaskbarButtons

---

Internal_BringWindowToFront

void Internal_BringWindowToFront(UDraggableWindow * TargetWindow)

Defined in OperatingSystem.h:1511

Referenced by

• BringWindowToFront
• MinimizeProgram

References

• GetSettings
• OnOperatingSystemWindowBroughtToFront
• OperatingSystemWidget