FOperatingSystemUser

#include <OperatingSystemSimulator/Public/OperatingSystemUser.h>

Class detail

---
config:
  class:
    hideEmptyMembersBox: true
---
classDiagram
  class FOperatingSystemUser {
    +Username : FText
    +Password : FText
    +Email : FText
    +FirstName : FText
    +LastName : FText
    +Icon : TSoftObjectPtr< UObject >
    +OwnedProgramIdentifiers : TSet< FName >
    +UserColor : FLinearColor
    +IsValid() const bool
    +IsRegisteredValid() const bool
    +IsCompleteProfile() const bool
    +GetUserUniqueId() const FOperatingSystemUniqueId()
    +Reset()
    +UpdateColorIfInvalid() bool
    +UpdateDetails(const FOperatingSystemUser &NewDetails)
    +CanReceiveEmails() const bool
    +operator==(const FOperatingSystemUser &Other) const bool
    +operator!=(const FOperatingSystemUser &Other) const bool
    +FOperatingSystemUser()
    +FOperatingSystemUser(const FText &Username)
    +FOperatingSystemUser(const FText &Username, const TSoftObjectPtr
    +FOperatingSystemUser(const FText &Username, const FText &Passwor
    +FOperatingSystemUser(const FText &Username, const FText &Passwor
    +FOperatingSystemUser(const FText &Username, const FText &Passwor
    +FOperatingSystemUser(const FText &Username, const FText &Passwor
    +FOperatingSystemUser(const FString &Username)
    +FOperatingSystemUser(const FString &Username, const FString &Pas
    +FOperatingSystemUser(const FString &Username, const FString &Pas
    +FOperatingSystemUser(const FString &Username, const FString &Pas
    +FOperatingSystemUser(const FString &Username, const FString &Pas
    +bCanReceiveEmails : bool
  }

Caller impact — IsCompleteProfile

Documented call sites inside the plugin (7):

flowchart LR
  FOperatingSystemUser__IsCompleteProfile["FOperatingSystemUser::IsCompleteProfile"]
  UOperatingSystemPluginSettings__GetDefaultUser["UOperatingSystemPluginSettings::GetDefaultUser"]
  UOperatingSystemPluginSettings__GetDefaultUser --> FOperatingSystemUser__IsCompleteProfile
  UOperatingSystemPluginSettings__GetNoReplyDefaultUserForMail["UOperatingSystemPluginSettings::GetNoReplyDefaultUserForMail"]
  UOperatingSystemPluginSettings__GetNoReplyDefaultUserForMail --> FOperatingSystemUser__IsCompleteProfile
  UOperatingSystemMailManager__Internal_SendEmailToUser["UOperatingSystemMailManager::Internal_SendEmailToUser"]
  UOperatingSystemMailManager__Internal_SendEmailToUser --> FOperatingSystemUser__IsCompleteProfile
  UOperatingSystemMailManager__RegisterNewMailAccount["UOperatingSystemMailManager::RegisterNewMailAccount"]
  UOperatingSystemMailManager__RegisterNewMailAccount --> FOperatingSystemUser__IsCompleteProfile
  UOperatingSystemMailManager__ReplyToEmail["UOperatingSystemMailManager::ReplyToEmail"]
  UOperatingSystemMailManager__ReplyToEmail --> FOperatingSystemUser__IsCompleteProfile
  UOperatingSystemMailManager__SendEmailFromDataTable["UOperatingSystemMailManager::SendEmailFromDataTable"]
  UOperatingSystemMailManager__SendEmailFromDataTable --> FOperatingSystemUser__IsCompleteProfile
  UOperatingSystemStatics__UserHasCompleteProfile["UOperatingSystemStatics::UserHasCompleteProfile"]
  UOperatingSystemStatics__UserHasCompleteProfile --> FOperatingSystemUser__IsCompleteProfile

Caller impact — IsValid

Documented call sites inside the plugin (5):

flowchart LR
  FOperatingSystemUser__IsValid["FOperatingSystemUser::IsValid"]
  UOperatingSystemUserManager__CreateNewUser["UOperatingSystemUserManager::CreateNewUser"]
  UOperatingSystemUserManager__CreateNewUser --> FOperatingSystemUser__IsValid
  UOperatingSystemUnix__GetRootUser["UOperatingSystemUnix::GetRootUser"]
  UOperatingSystemUnix__GetRootUser --> FOperatingSystemUser__IsValid
  UOperatingSystemUserManager__Internal_CreateUser["UOperatingSystemUserManager::Internal_CreateUser"]
  UOperatingSystemUserManager__Internal_CreateUser --> FOperatingSystemUser__IsValid
  UOperatingSystemMailManager__Internal_SendEmailToUser["UOperatingSystemMailManager::Internal_SendEmailToUser"]
  UOperatingSystemMailManager__Internal_SendEmailToUser --> FOperatingSystemUser__IsValid
  UOperatingSystemStatics__IsUserValid["UOperatingSystemStatics::IsUserValid"]
  UOperatingSystemStatics__IsUserValid --> FOperatingSystemUser__IsValid

Caller impact — IsRegisteredValid

Documented call sites inside the plugin (4):

flowchart LR
  FOperatingSystemUser__IsRegisteredValid["FOperatingSystemUser::IsRegisteredValid"]
  UOperatingSystemBankManager__FindUserFromAccountNumber["UOperatingSystemBankManager::FindUserFromAccountNumber"]
  UOperatingSystemBankManager__FindUserFromAccountNumber --> FOperatingSystemUser__IsRegisteredValid
  UOperatingSystemStatics__IsRegisteredUserValid["UOperatingSystemStatics::IsRegisteredUserValid"]
  UOperatingSystemStatics__IsRegisteredUserValid --> FOperatingSystemUser__IsRegisteredValid
  UOperatingSystemBankManager__RegisterNewBankAccount["UOperatingSystemBankManager::RegisterNewBankAccount"]
  UOperatingSystemBankManager__RegisterNewBankAccount --> FOperatingSystemUser__IsRegisteredValid
  UOperatingSystemGameSubsystem__RequestFundsFromBank["UOperatingSystemGameSubsystem::RequestFundsFromBank"]
  UOperatingSystemGameSubsystem__RequestFundsFromBank --> FOperatingSystemUser__IsRegisteredValid

struct FOperatingSystemUser

Defined in OperatingSystemUser.h:20 Represents a user in the operating system simulator.

This struct stores information about a user, such as their username, password, email, first name, last name, and icon.

The user can be registered and have a complete profile, which are determined by the presence of the required information. The user can also receive emails if the flag is set to true.

Friends

Name	Description
GetTypeHash inline	Computes the hash value for the specified FOperatingSystemUser object.

---

GetTypeHash

inline

friend inline uint32 GetTypeHash(const FOperatingSystemUser & Other)

Defined in OperatingSystemUser.h:313 Computes the hash value for the specified FOperatingSystemUser object.

This method computes the hash value for the specified FOperatingSystemUser object by combining the hash values of its individual member variables. The hash value is computed by performing a bitwise XOR operation on the hash values of the username, password, email, first name, and last name.

Parameters

• Other The FOperatingSystemUser object for which to compute the hash value.

Returns

The computed hash value for the specified FOperatingSystemUser object.

Public Attributes

Return	Name	Description
FText	Username	Stores the username of the operating system user. The username is a string of characters that uniquely identifies the user and is used for authentication purposes.
FText	Password	Stores the password of the operating system user. The password is used for authentication purposes to verify the identity of the user.
FText	Email	Stores the email of the operating system user. The email is used for communication purposes, such as sending and receiving emails.
FText	FirstName	Stores the first name of the operating system user. The first name is typically a string of characters used to identify a person.
FText	LastName	Stores the last name of the operating system user. The last name is typically a string of characters used to identify a person.
TSoftObjectPtr< UObject >	Icon	Represents an icon associated with the user for visual representation. The icon is a SoftObjectPtr that can refer to either a Texture or a MaterialInterface.
TSet< FName >	OwnedProgramIdentifiers	Set of programs this user owns. These are the program identifiers and not program names.
FLinearColor	UserColor	Stores the color associated with the user. It is expressed as an FLinearColor,.

---

Username

FText Username

Defined in OperatingSystemUser.h:33 Stores the username of the operating system user. The username is a string of characters that uniquely identifies the user and is used for authentication purposes.

Usage:

• The username can be accessed and modified using this variable.

• The username is publicly accessible and can be read or written to.

Referenced by

• CheckUserExist
• CheckUserExistForOperatingSystem
• FindUserByUsername
• Internal_CreateUser
• Internal_SendEmailToUser
• operator!=
• operator=
• operator==
• RegisterNewBankAccount
• RegisterNewMailAccount
• ReplyToEmail
• RequestFundsFromBank
• StartOperatingSystem
• TransferFundsToAnotherAccount

---

Password

FText Password

Defined in OperatingSystemUser.h:44 Stores the password of the operating system user. The password is used for authentication purposes to verify the identity of the user.

Usage:

• The password can be accessed and modified using this variable.

• The password is publicly accessible and can be read or written to.

Referenced by

• AuthorizeUser
• CheckRootPassword
• operator!=
• operator=
• operator==
• RegisterNewMailAccount

---

Email

FText Email

Defined in OperatingSystemUser.h:55 Stores the email of the operating system user. The email is used for communication purposes, such as sending and receiving emails.

Usage:

• The email can be accessed and modified using this variable.

• The email is publicly accessible and can be read or written to.

Referenced by

• FindUserByEmail
• Internal_SendEmailToUser
• operator!=
• operator=
• operator==
• RegisterNewMailAccount
• ReplyToEmail
• UOperatingSystemPluginSettings

---

FirstName

FText FirstName

Defined in OperatingSystemUser.h:67 Stores the first name of the operating system user. The first name is typically a string of characters used to identify a person.

Usage:

• The first name can be accessed and modified using this variable.

• The first name is publicly accessible and can be read or written to.

• This variable is used in conjunction with other variables to form a complete user profile.

Referenced by

• operator!=
• operator=
• operator==
• UOperatingSystemPluginSettings

---

LastName

FText LastName

Defined in OperatingSystemUser.h:79 Stores the last name of the operating system user. The last name is typically a string of characters used to identify a person.

Usage:

• The last name can be accessed and modified using this variable.

• The last name is publicly accessible and can be read or written to.

• This variable is used in conjunction with other variables to form a complete user profile.

Referenced by

• operator!=
• operator=
• operator==
• UOperatingSystemPluginSettings

---

Icon

TSoftObjectPtr< UObject > Icon

Defined in OperatingSystemUser.h:90 Represents an icon associated with the user for visual representation. The icon is a SoftObjectPtr that can refer to either a Texture or a MaterialInterface.

Usage:

• The icon can be accessed and modified using this variable.

• The icon is publicly accessible and can be read or written to.

Referenced by

• operator=
• UpdateDetails

---

OwnedProgramIdentifiers

TSet< FName > OwnedProgramIdentifiers

Defined in OperatingSystemUser.h:96 Set of programs this user owns. These are the program identifiers and not program names.

Referenced by

• operator=
• UpdateDetails

---

UserColor

FLinearColor UserColor

Defined in OperatingSystemUser.h:109 Stores the color associated with the user. It is expressed as an FLinearColor,.

Usage:

• The UserColor can be accessed and modified using this variable.

• The UserColor is publicly accessible and can be read or written to.

• The UserColor can be updated using the UpdateColorIfInvalid() function.

See also: FOperatingSystemUser::UpdateColorIfInvalid()

Referenced by

• operator=

Public Methods

Return	Name	Description
bool	IsValid const inline	The user is considered valid if the username is not empty or consists of only whitespace characters.
bool	IsRegisteredValid const inline	The user is considered valid if their username is not empty and their email and password properties are not empty.
bool	IsCompleteProfile const inline	Checks if the user has a complete profile.
FOperatingSystemUniqueId	GetUserUniqueId const inline	Generates a unique identifier for the user based on their username and email. The email is formatted by replacing ”@” with ”_” before combining it with the username.
void	Reset inline	Resets the user’s information.
bool	UpdateColorIfInvalid inline	Updates the UserColor if it is invalid.
void	UpdateDetails inline	Updates the details of an operating system user.
bool	CanReceiveEmails const inline	Checks if the user can receive emails.
bool	operator== const inline
bool	operator!= const inline
	FOperatingSystemUser inline
	FOperatingSystemUser inline explicit
	FOperatingSystemUser inline
	FOperatingSystemUser inline
	FOperatingSystemUser inline
	FOperatingSystemUser inline
	FOperatingSystemUser inline
	FOperatingSystemUser inline explicit
	FOperatingSystemUser inline
	FOperatingSystemUser inline
	FOperatingSystemUser inline
	FOperatingSystemUser inline

---

IsValid

const inline

inline bool IsValid() const

Defined in OperatingSystemUser.h:135 The user is considered valid if the username is not empty or consists of only whitespace characters.

Returns

True if the user is valid, false otherwise.

Referenced by

• CreateNewUser
• GetRootUser
• Internal_CreateUser
• Internal_SendEmailToUser
• IsUserValid

---

IsRegisteredValid

const inline

inline bool IsRegisteredValid() const

Defined in OperatingSystemUser.h:144 The user is considered valid if their username is not empty and their email and password properties are not empty.

Returns

True if the registered user is valid, false otherwise.

Referenced by

• FindUserFromAccountNumber
• IsRegisteredUserValid
• RegisterNewBankAccount
• RequestFundsFromBank

---

IsCompleteProfile

const inline

inline bool IsCompleteProfile() const

Defined in OperatingSystemUser.h:157 Checks if the user has a complete profile.

Returns true if the user is registered, and if the first name and last name are not empty or whitespace. Otherwise, returns false.

Returns

True if the user has a complete profile, false otherwise.

Referenced by

• GetDefaultUser
• GetNoReplyDefaultUserForMail
• Internal_SendEmailToUser
• RegisterNewMailAccount
• ReplyToEmail
• SendEmailFromDataTable
• UserHasCompleteProfile

---

GetUserUniqueId

const inline

inline FOperatingSystemUniqueId GetUserUniqueId() const

Defined in OperatingSystemUser.h:170 Generates a unique identifier for the user based on their username and email. The email is formatted by replacing ”@” with ”_” before combining it with the username.

Returns

The unique identifier for the user.

See also: FOperatingSystemUniqueId

Referenced by

• Initialize
• RequestFundsFromBank

References

• ToString

---

Reset

inline

inline void Reset()

Defined in OperatingSystemUser.h:186 Resets the user’s information.

This method sets all of the user’s variables to their default values.

The variables that are reset include the username, password, email, first name, last name, and icon. The icon is reset using the Reset() method.

In addition, the list of owned program identifiers is also reset.

Referenced by

• FindUserByEmail
• FindUserByUsername

---

UpdateColorIfInvalid

inline

inline bool UpdateColorIfInvalid()

Defined in OperatingSystemUser.h:203 Updates the UserColor if it is invalid.

This method checks if the UserColor is invalid, i.e., equal to FLinearColor::Transparent, and if the user is valid. If both conditions are met, it generates a random color using FLinearColor::MakeRandomColor() and sets the alpha value to 1.0. It then returns true to indicate that the color was updated. If the conditions are not met, it returns false.

Returns

True if the UserColor was updated, false otherwise.

Referenced by

• UOperatingSystemPluginSettings

---

UpdateDetails

inline

inline void UpdateDetails(const FOperatingSystemUser & NewDetails)

Defined in OperatingSystemUser.h:233 Updates the details of an operating system user.

This method updates the specified user’s details by replacing the existing values with the non-empty values provided in the given NewDetails object. The user’s email, password, username, first name, and last name will be updated if provided. The user’s icon will also be updated if a non-null icon is provided. The user’s owned program identifiers will be updated if the list is not empty.

Parameters

• NewDetails The [FOperatingSystemUser](#foperatingsystemuser) object containing the updated details.

• NewDetails.Email: The new email address for the user (optional).

• NewDetails.Password: The new password for the user (optional).

• NewDetails.Username: The new username for the user (optional).

• NewDetails.FirstName: The new first name for the user (optional).

• NewDetails.LastName: The new last name for the user (optional).

• NewDetails.Icon: The new icon for the user (optional).

• NewDetails.OwnedProgramIdentifiers: The new list of owned program identifiers for the user (optional).

Note

The provided NewDetails object may have empty or null values for some properties. Only non-empty values will be used to update the user’s details.

Referenced by

• UpdateUserDetails

References

• Icon
• OS_UPDATE_USER
• OwnedProgramIdentifiers

---

CanReceiveEmails

const inline

inline bool CanReceiveEmails() const

Defined in OperatingSystemUser.h:267 Checks if the user can receive emails.

This method returns a boolean value indicating whether the user can receive emails or not. If the value is true, it means the user can receive emails. If the value is false, it means the user cannot receive emails.

Returns

True if the user can receive emails, false otherwise.

Referenced by

• Internal_SendEmailToUser
• ReplyToEmail

---

operator==

const inline

inline bool operator==(const FOperatingSystemUser & Other) const

Defined in OperatingSystemUser.h:283

References

• Email
• FirstName
• LastName
• Password
• Username

---

operator!=

const inline

inline bool operator!=(const FOperatingSystemUser & Other) const

Defined in OperatingSystemUser.h:292

References

• Email
• FirstName
• LastName
• Password
• Username

---

FOperatingSystemUser

inline

inline FOperatingSystemUser()

Defined in OperatingSystemUser.h:322

FOperatingSystemUser

inline explicit

inline explicit FOperatingSystemUser(const FText & Username)

Defined in OperatingSystemUser.h:335

FOperatingSystemUser

inline

inline FOperatingSystemUser(const FText & Username, const TSoftObjectPtr< UObject > & Icon)

Defined in OperatingSystemUser.h:348

FOperatingSystemUser

inline

inline FOperatingSystemUser(const FText & Username, const FText & Password)

Defined in OperatingSystemUser.h:361

FOperatingSystemUser

inline

inline FOperatingSystemUser(const FText & Username, const FText & Password, const TSoftObjectPtr< UObject > & Icon)

Defined in OperatingSystemUser.h:374

FOperatingSystemUser

inline

inline FOperatingSystemUser(const FText & Username, const FText & Password, const FText & Email, const FText & FirstName, const FText & LastName)

Defined in OperatingSystemUser.h:387

FOperatingSystemUser

inline

inline FOperatingSystemUser(const FText & Username, const FText & Password, const FText & Email, const FText & FirstName, const FText & LastName, const bool bCanReceiveEmails)

Defined in OperatingSystemUser.h:400

FOperatingSystemUser

inline explicit

inline explicit FOperatingSystemUser(const FString & Username)

Defined in OperatingSystemUser.h:413

FOperatingSystemUser

inline

inline FOperatingSystemUser(const FString & Username, const FString & Password)

Defined in OperatingSystemUser.h:418

FOperatingSystemUser

inline

inline FOperatingSystemUser(const FString & Username, const FString & Password, const TSoftObjectPtr< UObject > & Icon)

Defined in OperatingSystemUser.h:423

FOperatingSystemUser

inline

inline FOperatingSystemUser(const FString & Username, const FString & Password, const FString & Email, const FString & FirstName, const FString & LastName)

Defined in OperatingSystemUser.h:428

FOperatingSystemUser

inline

inline FOperatingSystemUser(const FString & Username, const FString & Password, const FString & Email, const FString & FirstName, const FString & LastName, const bool bCanReceiveEmails)

Defined in OperatingSystemUser.h:433

Protected Attributes

Return	Name	Description
bool	bCanReceiveEmails	Determines whether the operating system user is able to receive emails. If the value is true, the user can receive emails. If the value is false, the user cannot receive emails.

---

bCanReceiveEmails

bool bCanReceiveEmails

Defined in OperatingSystemUser.h:126 Determines whether the operating system user is able to receive emails. If the value is true, the user can receive emails. If the value is false, the user cannot receive emails.

Usage:

• This variable can be accessed and modified using the bCanReceiveEmails property.

• The value can be set to true or false to enable or disable email reception for the user.

• The value can be read to determine if the user can receive emails.

Note

The default value for this variable is true.

Referenced by

• operator=