UOperatingSystemPluginSettings

#include <OperatingSystemSimulator/Private/Global/OperatingSystemPluginSettings.h>

class UOperatingSystemPluginSettings

Defined in OperatingSystemPluginSettings.h:23

Inherits: USettingsBase

Inheritance diagram

---
config:
  class:
    hideEmptyMembersBox: true
---
classDiagram
  class UOperatingSystemPluginSettings["UOperatingSystemPluginSettings"]
  class USettingsBase["USettingsBase"]
  USettingsBase <|-- UOperatingSystemPluginSettings

Collaboration diagram

---
config:
  class:
    hideEmptyMembersBox: true
---
classDiagram
  class UOperatingSystemPluginSettings["UOperatingSystemPluginSettings"]
  class USettingsBase["USettingsBase"]
  UOperatingSystemPluginSettings *-- USettingsBase
  class FOperatingSystemUser["FOperatingSystemUser"]
  UOperatingSystemPluginSettings *-- FOperatingSystemUser
  class UOperatingSystemProgramIconWidget["UOperatingSystemProgramIconWidget"]
  UOperatingSystemPluginSettings *-- UOperatingSystemProgramIconWidget
  class UOperatingSystemTaskbarButton["UOperatingSystemTaskbarButton"]
  UOperatingSystemPluginSettings *-- UOperatingSystemTaskbarButton
  class UOperatingSystemUserManager["UOperatingSystemUserManager"]
  UOperatingSystemPluginSettings *-- UOperatingSystemUserManager
  class UOperatingSystemBankManager["UOperatingSystemBankManager"]
  UOperatingSystemPluginSettings *-- UOperatingSystemBankManager
  class UOperatingSystemMailManager["UOperatingSystemMailManager"]
  UOperatingSystemPluginSettings *-- UOperatingSystemMailManager

Class detail

---
config:
  class:
    hideEmptyMembersBox: true
---
classDiagram
  class UOperatingSystemPluginSettings {
    +UOperatingSystemPluginSettings()
    +GetUserManagerClass() const TSoftClassPtr()< UOperatingSystemUserMan
    +GetBankClass() const TSoftClassPtr()< UOperatingSystemBankMan
    +GetMailClass() const TSoftClassPtr()< UOperatingSystemMailMan
    +GetUserManagerSaveSlotName() const FString()
    +GetBankSaveSlotName() const FString()
    +GetMailSaveSlotName() const FString()
    +GetNoReplyDefaultUserForMail() const FOperatingSystemUser()
    +GetDefaultUser() const FOperatingSystemUser()
    +GetDefaultProgramIconWidget() const TSoftClassPtr()< UOperatingSystemProgram
    +GetDefaultTaskbarButtonClass() const TSoftClassPtr()< UOperatingSystemTaskbar
    +GetAdditionalTerminalCommandsPath() const TArray()< FString() >
    +Get() const()UOperatingSystemPluginSettings() 
    +GetDefaultTerminalCommandPaths() TArray()< FString() >
    +AdditionalTerminalCommandsPath : TArray()< FDirectoryPath() >
    +DefaultUser : FOperatingSystemUser()
    +DefaultIconWidgetClass : TSoftClassPtr()< UOperatingSystemProgram
    +DefaultTaskbarButtonClass : TSoftClassPtr()< UOperatingSystemTaskbar
    +UserManagerClass : TSoftClassPtr()< UOperatingSystemUserMan
    +BankClass : TSoftClassPtr()< UOperatingSystemBankMan
    +MailClass : TSoftClassPtr()< UOperatingSystemMailMan
    +UserManagerSaveSlotName : FName()
    +BankSaveSlotName : FName()
    +MailSaveSlotName : FName()
    +NoReplyDefaultUserForMail : FOperatingSystemUser()
  }

Caller impact — Get

Documented call sites inside the plugin (14):

flowchart LR
  UOperatingSystemPluginSettings__Get["UOperatingSystemPluginSettings::Get"]
  UOperatingSystemBankManager__CreateBankSingleton["UOperatingSystemBankManager::CreateBankSingleton"]
  UOperatingSystemBankManager__CreateBankSingleton --> UOperatingSystemPluginSettings__Get
  UOperatingSystemMailManager__CreateMailSingleton["UOperatingSystemMailManager::CreateMailSingleton"]
  UOperatingSystemMailManager__CreateMailSingleton --> UOperatingSystemPluginSettings__Get
  UOperatingSystemUserManager__CreateUserManager["UOperatingSystemUserManager::CreateUserManager"]
  UOperatingSystemUserManager__CreateUserManager --> UOperatingSystemPluginSettings__Get
  UOperatingSystemUserManager__FindUserByEmail["UOperatingSystemUserManager::FindUserByEmail"]
  UOperatingSystemUserManager__FindUserByEmail --> UOperatingSystemPluginSettings__Get
  UOperatingSystemUserManager__FindUserByUsername["UOperatingSystemUserManager::FindUserByUsername"]
  UOperatingSystemUserManager__FindUserByUsername --> UOperatingSystemPluginSettings__Get
  UOperatingSystemBaseProgram__GetIconWidgetClass["UOperatingSystemBaseProgram::GetIconWidgetClass"]
  UOperatingSystemBaseProgram__GetIconWidgetClass --> UOperatingSystemPluginSettings__Get
  UOperatingSystemBaseProgram__GetTaskbarButtonClass["UOperatingSystemBaseProgram::GetTaskbarButtonClass"]
  UOperatingSystemBaseProgram__GetTaskbarButtonClass --> UOperatingSystemPluginSettings__Get
  UOperatingSystemTerminal__Internal_FindAdditionalCommands["UOperatingSystemTerminal::Internal_FindAdditionalCommands"]
  UOperatingSystemTerminal__Internal_FindAdditionalCommands --> UOperatingSystemPluginSettings__Get
  UOperatingSystemUserManager__Internal_Save["UOperatingSystemUserManager::Internal_Save"]
  UOperatingSystemUserManager__Internal_Save --> UOperatingSystemPluginSettings__Get
  UOperatingSystemBankManager__Internal_Save["UOperatingSystemBankManager::Internal_Save"]
  UOperatingSystemBankManager__Internal_Save --> UOperatingSystemPluginSettings__Get
  UOperatingSystemMailManager__Save["UOperatingSystemMailManager::Save"]
  UOperatingSystemMailManager__Save --> UOperatingSystemPluginSettings__Get
  UOperatingSystemMailManager__SendEmailFromDataTable["UOperatingSystemMailManager::SendEmailFromDataTable"]
  UOperatingSystemMailManager__SendEmailFromDataTable --> UOperatingSystemPluginSettings__Get
  UOperatingSystem__StartOperatingSystem["UOperatingSystem::StartOperatingSystem"]
  UOperatingSystem__StartOperatingSystem --> UOperatingSystemPluginSettings__Get
  FOperatingSystemSimulatorModule__StartupModule["FOperatingSystemSimulatorModule::StartupModule"]
  FOperatingSystemSimulatorModule__StartupModule --> UOperatingSystemPluginSettings__Get

The UOperatingSystemPluginSettings class holds the settings for the Operating System plugin.

The UOperatingSystemPluginSettings class is a subclass of UDeveloperSettings. It contains various properties to configure the behavior of the Operating System plugin.

Public Methods

Return	Name	Description
	UOperatingSystemPluginSettings
TSoftClassPtr< UOperatingSystemUserManager >	GetUserManagerClass const	Retrieves the class pointer to the user manager specified in the settings. If the user manager class is not set, it returns the default class pointer for UOperatingSystemUserManager.
TSoftClassPtr< UOperatingSystemBankManager >	GetBankClass const	Returns the class object of the Operating System Bank Manager. This method returns the class object of the Operating System Bank Manager. If the BankClass is null, it returns the StaticClass of UOperatingSystemBankManager.
TSoftClassPtr< UOperatingSystemMailManager >	GetMailClass const	Returns the mail class configured in the operating system plugin settings. This method returns the mail class configured in the operating system plugin settings. If no mail class is configured, then it returns the default mail class, UOperatingSystemMailManager::StaticClass().
FString	GetUserManagerSaveSlotName const	Retrieves the name of the save game slot to use for the User Manager class. If the UserManagerSaveSlotName property is not set, it returns the fallback save slot name specified in UserManagerFallbackSaveSlotName.
FString	GetBankSaveSlotName const	Retrieves the name of the save game slot to use for the Bank class. If the BankSaveSlotName property is not set, it returns the fallback save slot name specified in BankFallbackSaveSlotName.
FString	GetMailSaveSlotName const	Retrieves the name of the save game slot to use for the Mail class. This method returns the name of the save game slot to use for the Mail class. If the MailSaveSlotName property is not set, it returns the fallback save slot name specified in Mail FallbackSaveSlotName.
FOperatingSystemUser	GetNoReplyDefaultUserForMail const	Retrieves the default user for sending “no reply” emails.
FOperatingSystemUser	GetDefaultUser const	Retrieve the default user for the Operating System plugin.
TSoftClassPtr< UOperatingSystemProgramIconWidget >	GetDefaultProgramIconWidget const	Retrieve the default program icon widget.
TSoftClassPtr< UOperatingSystemTaskbarButton >	GetDefaultTaskbarButtonClass const	Retrieve the default task bar button widget.
TArray< FString >	GetAdditionalTerminalCommandsPath const inline	Returns an array of strings representing the additional terminal commands path. Each string represents a path to a terminal command.

---

UOperatingSystemPluginSettings

UOperatingSystemPluginSettings()

Defined in OperatingSystemPluginSettings.h:91

References

• AdditionalTerminalCommandsPath
• DefaultIconWidgetClass
• DefaultTaskbarButtonClass
• DefaultUser
• Email
• FirstName
• GetDefaultTerminalCommandPaths
• GetSettings
• LastName
• NoReplyDefaultUserForMail
• UpdateColorIfInvalid

---

GetUserManagerClass

const

TSoftClassPtr< UOperatingSystemUserManager > GetUserManagerClass() const

Defined in OperatingSystemPluginSettings.h:117 Retrieves the class pointer to the user manager specified in the settings. If the user manager class is not set, it returns the default class pointer for UOperatingSystemUserManager.

Returns

TSoftClassPtr<UOperatingSystemUserManager> - The class pointer to the user manager.

References

• UserManagerClass

---

GetBankClass

const

TSoftClassPtr< UOperatingSystemBankManager > GetBankClass() const

Defined in OperatingSystemPluginSettings.h:125 Returns the class object of the Operating System Bank Manager. This method returns the class object of the Operating System Bank Manager. If the BankClass is null, it returns the StaticClass of UOperatingSystemBankManager.

Returns

The class object of the Operating System Bank Manager.

References

• BankClass

---

GetMailClass

const

TSoftClassPtr< UOperatingSystemMailManager > GetMailClass() const

Defined in OperatingSystemPluginSettings.h:134 Returns the mail class configured in the operating system plugin settings. This method returns the mail class configured in the operating system plugin settings. If no mail class is configured, then it returns the default mail class, UOperatingSystemMailManager::StaticClass().

Returns

The configured mail class as a TSoftClassPtr<UOperatingSystemMailManager>.

References

• MailClass

---

GetUserManagerSaveSlotName

const

FString GetUserManagerSaveSlotName() const

Defined in OperatingSystemPluginSettings.h:142 Retrieves the name of the save game slot to use for the User Manager class. If the UserManagerSaveSlotName property is not set, it returns the fallback save slot name specified in UserManagerFallbackSaveSlotName.

Returns

The name of the save game slot to use for the User Manager class.

References

• UserManagerSaveSlotName

---

GetBankSaveSlotName

const

FString GetBankSaveSlotName() const

Defined in OperatingSystemPluginSettings.h:150 Retrieves the name of the save game slot to use for the Bank class. If the BankSaveSlotName property is not set, it returns the fallback save slot name specified in BankFallbackSaveSlotName.

Returns

The name of the save game slot to use for the Bank class as a FString.

References

• BankSaveSlotName

---

GetMailSaveSlotName

const

FString GetMailSaveSlotName() const

Defined in OperatingSystemPluginSettings.h:159 Retrieves the name of the save game slot to use for the Mail class. This method returns the name of the save game slot to use for the Mail class. If the MailSaveSlotName property is not set, it returns the fallback save slot name specified in Mail FallbackSaveSlotName.

Returns

The name of the save game slot to use for the Mail class as a FString.

References

• MailSaveSlotName

---

GetNoReplyDefaultUserForMail

const

FOperatingSystemUser GetNoReplyDefaultUserForMail() const

Defined in OperatingSystemPluginSettings.h:170 Retrieves the default user for sending “no reply” emails.

This function returns the default user to be used for sending “no reply” emails. If the NoReplyDefaultUserForMail has a complete profile, that user is returned. Otherwise, the function returns the DefaultMailUser.

Returns

FOperatingSystemUser The default user for sending “no reply” emails.

References

• IsCompleteProfile
• NoReplyDefaultUserForMail

---

GetDefaultUser

const

FOperatingSystemUser GetDefaultUser() const

Defined in OperatingSystemPluginSettings.h:180 Retrieve the default user for the Operating System plugin.

This function returns the default user for the Operating System plugin. If the user’s profile is complete, the function will return the complete profile. Otherwise, it will return the default user.

Returns

The default user for the Operating System plugin.

Referenced by

• StartOperatingSystem

References

• DefaultUser
• IsCompleteProfile

---

GetDefaultProgramIconWidget

const

TSoftClassPtr< UOperatingSystemProgramIconWidget > GetDefaultProgramIconWidget() const

Defined in OperatingSystemPluginSettings.h:189 Retrieve the default program icon widget.

Default icon widget for all programs. You can also set Icon Widget Class property within each program to have their own unique icons.

Returns

TSoftClassPtr<UOperatingSystemProgramIconWidget>.

Referenced by

• GetIconWidgetClass

References

• DefaultIconWidgetClass

---

GetDefaultTaskbarButtonClass

const

TSoftClassPtr< UOperatingSystemTaskbarButton > GetDefaultTaskbarButtonClass() const

Defined in OperatingSystemPluginSettings.h:198 Retrieve the default task bar button widget.

Default taskbar button widget for all programs. You can also set Taskbar Button Class property within each program to have their own unique taskbar buttons.

Returns

TSoftClassPtr<UOperatingSystemTaskbarButton>.

Referenced by

• GetTaskbarButtonClass

References

• DefaultTaskbarButtonClass

---

GetAdditionalTerminalCommandsPath

const inline

inline TArray< FString > GetAdditionalTerminalCommandsPath() const

Defined in OperatingSystemPluginSettings.h:205 Returns an array of strings representing the additional terminal commands path. Each string represents a path to a terminal command.

Returns

An array of strings representing the additional terminal commands path.

Referenced by

• Internal_FindAdditionalCommands

Public Static Methods

Return	Name	Description
constUOperatingSystemPluginSettings *	Get static	Retrieves an instance of UOperatingSystemPluginSettings.
TArray< FString >	GetDefaultTerminalCommandPaths static inline	Returns the default terminal command paths. The GetDefaultTerminalCommandPaths method returns an array of default terminal command paths. These paths are used to locate terminal command assets in the game.

---

Get

static

static constUOperatingSystemPluginSettings * Get()

Defined in OperatingSystemPluginSettings.h:98 Retrieves an instance of UOperatingSystemPluginSettings.

Returns

A pointer to UOperatingSystemPluginSettings.

Referenced by

• CreateBankSingleton
• CreateMailSingleton
• CreateUserManager
• FindUserByEmail
• FindUserByUsername
• GetIconWidgetClass
• GetTaskbarButtonClass
• Internal_FindAdditionalCommands
• Internal_Save
• Internal_Save
• Save
• SendEmailFromDataTable
• StartOperatingSystem
• StartupModule

References

• GetSettings

---

GetDefaultTerminalCommandPaths

static inline

static inline TArray< FString > GetDefaultTerminalCommandPaths()

Defined in OperatingSystemPluginSettings.h:223 Returns the default terminal command paths. The GetDefaultTerminalCommandPaths method returns an array of default terminal command paths. These paths are used to locate terminal command assets in the game.

Returns

An array of default terminal command paths.

Referenced by

• UOperatingSystemPluginSettings

Private Attributes

Return	Name	Description
TArray< FDirectoryPath >	AdditionalTerminalCommandsPath	Scans these paths to find additional commands that should be added to Operating System Terminal.
FOperatingSystemUser	DefaultUser	A dummy user that will be created when OS is set to Full Boot and no user are available.
TSoftClassPtr< UOperatingSystemProgramIconWidget >	DefaultIconWidgetClass	Default icon that should be applied to all programs if not overriden inside the program itself.
TSoftClassPtr< UOperatingSystemTaskbarButton >	DefaultTaskbarButtonClass	Default taskbar button class that should be applied to all programs if not overriden inside the program itself.
TSoftClassPtr< UOperatingSystemUserManager >	UserManagerClass	Holds a soft reference to the class of the user manager.
TSoftClassPtr< UOperatingSystemBankManager >	BankClass	Holds a soft reference to the class of the bank manager.
TSoftClassPtr< UOperatingSystemMailManager >	MailClass	Holds a soft reference to the class of the mail manager.
FName	UserManagerSaveSlotName	Name for the save game slot to use for User Manager class. If empty, automatically falls back to using ‘__users_db’
FName	BankSaveSlotName	Name for the save game slot to use for Bank class. If empty, automatically falls back to using ‘__bank_db’
FName	MailSaveSlotName	Name for the save game slot to use for Bank class. If empty, automatically falls back to using ‘__mail_db’
FOperatingSystemUser	NoReplyDefaultUserForMail	A dummy user that will be used when calling UOperatingSystemMailManager::SendEmailFromDataTable function.

---

AdditionalTerminalCommandsPath

TArray< FDirectoryPath > AdditionalTerminalCommandsPath

Defined in OperatingSystemPluginSettings.h:29 Scans these paths to find additional commands that should be added to Operating System Terminal.

Referenced by

• UOperatingSystemPluginSettings

---

DefaultUser

FOperatingSystemUser DefaultUser

Defined in OperatingSystemPluginSettings.h:33 A dummy user that will be created when OS is set to Full Boot and no user are available.

Referenced by

• GetDefaultUser
• UOperatingSystemPluginSettings

---

DefaultIconWidgetClass

TSoftClassPtr< UOperatingSystemProgramIconWidget > DefaultIconWidgetClass

Defined in OperatingSystemPluginSettings.h:37 Default icon that should be applied to all programs if not overriden inside the program itself.

Referenced by

• GetDefaultProgramIconWidget
• UOperatingSystemPluginSettings

---

DefaultTaskbarButtonClass

TSoftClassPtr< UOperatingSystemTaskbarButton > DefaultTaskbarButtonClass

Defined in OperatingSystemPluginSettings.h:41 Default taskbar button class that should be applied to all programs if not overriden inside the program itself.

Referenced by

• GetDefaultTaskbarButtonClass
• UOperatingSystemPluginSettings

---

UserManagerClass

TSoftClassPtr< UOperatingSystemUserManager > UserManagerClass

Defined in OperatingSystemPluginSettings.h:51 Holds a soft reference to the class of the user manager.

The class is referenced using a TSoftClassPtr, which is a soft reference that allows the class to be loaded and accessed at runtime.

See also: UOperatingSystemUserManager

Referenced by

• GetUserManagerClass

---

BankClass

TSoftClassPtr< UOperatingSystemBankManager > BankClass

Defined in OperatingSystemPluginSettings.h:61 Holds a soft reference to the class of the bank manager.

The class is referenced using a TSoftClassPtr, which is a soft reference that allows the class to be loaded and accessed at runtime.

See also: UOperatingSystemBankManager

Referenced by

• GetBankClass

---

MailClass

TSoftClassPtr< UOperatingSystemMailManager > MailClass

Defined in OperatingSystemPluginSettings.h:71 Holds a soft reference to the class of the mail manager.

The MailClass is a soft reference that allows the class of the mail manager to be loaded and accessed at runtime.

See also: UOperatingSystemMailManager

Referenced by

• GetMailClass

---

UserManagerSaveSlotName

FName UserManagerSaveSlotName

Defined in OperatingSystemPluginSettings.h:75 Name for the save game slot to use for User Manager class. If empty, automatically falls back to using ‘__users_db’

Referenced by

• GetUserManagerSaveSlotName

---

BankSaveSlotName

FName BankSaveSlotName

Defined in OperatingSystemPluginSettings.h:79 Name for the save game slot to use for Bank class. If empty, automatically falls back to using ‘__bank_db’

Referenced by

• GetBankSaveSlotName

---

MailSaveSlotName

FName MailSaveSlotName

Defined in OperatingSystemPluginSettings.h:83 Name for the save game slot to use for Bank class. If empty, automatically falls back to using ‘__mail_db’

Referenced by

• GetMailSaveSlotName

---

NoReplyDefaultUserForMail

FOperatingSystemUser NoReplyDefaultUserForMail

Defined in OperatingSystemPluginSettings.h:87 A dummy user that will be used when calling UOperatingSystemMailManager::SendEmailFromDataTable function.

Referenced by

• GetNoReplyDefaultUserForMail
• UOperatingSystemPluginSettings