UOperatingSystemPluginSettings Class Reference

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

#include "OperatingSystemPluginSettings.h"

Inheritance diagram for UOperatingSystemPluginSettings:

Collaboration diagram for UOperatingSystemPluginSettings:

Public Member Functions
	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.
FORCEINLINE TArray< FString >	GetAdditionalTerminalCommandsPath () const
	Returns an array of strings representing the additional terminal commands path. Each string represents a path to a terminal command.

Static Public Member Functions
static const UOperatingSystemPluginSettings *	Get ()
	Retrieves an instance of UOperatingSystemPluginSettings.
static FORCEINLINE TArray< FString >	GetDefaultTerminalCommandPaths ()
	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.

Detailed Description

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.

Constructor & Destructor Documentation

UOperatingSystemPluginSettings()

UOperatingSystemPluginSettings::UOperatingSystemPluginSettings

(

)

Here is the call graph for this function:

Member Function Documentation

Get()

const UOperatingSystemPluginSettings * UOperatingSystemPluginSettings::Get ( )

static

Retrieves an instance of UOperatingSystemPluginSettings.

Returns

A pointer to UOperatingSystemPluginSettings.

Here is the caller graph for this function:

GetAdditionalTerminalCommandsPath()

FORCEINLINE TArray< FString > UOperatingSystemPluginSettings::GetAdditionalTerminalCommandsPath ( ) const

inline

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.

GetBankClass()

TSoftClassPtr< UOperatingSystemBankManager > UOperatingSystemPluginSettings::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.

Returns

The class object of the Operating System Bank Manager.

GetBankSaveSlotName()

FString UOperatingSystemPluginSettings::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.

Returns

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

GetDefaultTerminalCommandPaths()

static FORCEINLINE TArray< FString > UOperatingSystemPluginSettings::GetDefaultTerminalCommandPaths ( )

inlinestatic

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.

Here is the caller graph for this function:

GetDefaultUser()

FOperatingSystemUser UOperatingSystemPluginSettings::GetDefaultUser

(

)

const

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.

Here is the call graph for this function:

Here is the caller graph for this function:

GetMailClass()

TSoftClassPtr< UOperatingSystemMailManager > UOperatingSystemPluginSettings::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().

Returns

The configured mail class as a TSoftClassPtr<UOperatingSystemMailManager>.

GetMailSaveSlotName()

FString UOperatingSystemPluginSettings::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.

Returns

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

GetNoReplyDefaultUserForMail()

FOperatingSystemUser UOperatingSystemPluginSettings::GetNoReplyDefaultUserForMail

(

)

const

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.

Here is the call graph for this function:

GetUserManagerClass()

TSoftClassPtr< UOperatingSystemUserManager > UOperatingSystemPluginSettings::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.

Returns

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

GetUserManagerSaveSlotName()

FString UOperatingSystemPluginSettings::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.

Returns

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

---

The documentation for this class was generated from the following files:

• Source/OperatingSystemSimulator/Private/Global/OperatingSystemPluginSettings.h
• Source/OperatingSystemSimulator/Private/Global/OperatingSystemPluginSettings.cpp