UOperatingSystemSettingsData Class Reference

This class represents the settings data for the operating system. It contains information about the modules and their settings. More...

#include "OperatingSystemSettingsData.h"

Inheritance diagram for UOperatingSystemSettingsData:

Collaboration diagram for UOperatingSystemSettingsData:

Public Member Functions
UOperatingSystemSettingModule *	FindSettingModuleFromName (const FText SettingName) const
UOperatingSystemSettingModule *	FindSettingModuleFromClass (const TSoftClassPtr< UOperatingSystemSettingModule > TestClass) const
template<class T >
FORCEINLINE T *	FindSettingModuleFromClass ()
	Template method that finds and returns the setting module instance for the given class.
FORCEINLINE const TMap< FOperatingSystemSettingModuleInfo, TSoftClassPtr< UOperatingSystemSettingModule > > &	GetModuleClasses () const
	Returns the map of module classes and their corresponding info.
Public Member Functions inherited from UOperatingSystemDataObject
template<class T >
T *	GetParentObject () const
OPERATINGSYSTEMSIMULATOR_API void	SetTickEnabled (const bool bEnable)
OPERATINGSYSTEMSIMULATOR_API bool	IsTickEnabled () const

Public Attributes
bool	bIsUsingCustomWallpaper
	Boolean flag indicating whether the user is using a custom wallpaper.
FString	WallpaperPath
	String variable representing the path to the wallpaper.

Protected Member Functions
virtual void	OnValidate (FGenericError &OutError) override
	Validates the settings data for the operating system.
Protected Member Functions inherited from UOperatingSystemDataObject
virtual OPERATINGSYSTEMSIMULATOR_API bool	ShouldCreate () const
virtual OPERATINGSYSTEMSIMULATOR_API void	Tick (const float &DeltaSeconds)
	The Tick method receives the time elapsed since the last frame update and performs any necessary updates or computations.
virtual OPERATINGSYSTEMSIMULATOR_API void	OnCreate ()
	This method is called when a new instance of UOperatingSystemDataObject is created.
void	K2_OnCreate ()
	K2_OnCreate.
void	K2_Tick (const float &DeltaSeconds)
	K2_Tick method is an event meant to be overridden in Blueprint subclasses of OperatingSystemDataObject. It allows subclasses to define custom behavior that should be executed every tick.
bool	K2_ShouldCreate () const
	Indicates whether the operating system data object should be created.

Additional Inherited Members
Static Public Member Functions inherited from UOperatingSystemDataObject
static OPERATINGSYSTEMSIMULATOR_API UOperatingSystemDataObject *	CreateDataObj (UObject *OwningObject, const TSoftClassPtr< UOperatingSystemDataObject > &DataClassPtr)
template<class T >
static OPERATINGSYSTEMSIMULATOR_API T *	CreateDataObj (UObject *OwningObject, TSoftClassPtr< UOperatingSystemDataObject > DataClassPtr)
	This method creates a new instance of a data object of type T.
Protected Attributes inherited from UOperatingSystemDataObject
TWeakObjectPtr< UObject >	ParentObject
uint8	bStartWithTickEnabled: 1

Detailed Description

This class represents the settings data for the operating system. It contains information about the modules and their settings.

Member Function Documentation

FindSettingModuleFromClass() [1/2]

template<class T >

FORCEINLINE T * UOperatingSystemSettingsData::FindSettingModuleFromClass ( )

inline

Template method that finds and returns the setting module instance for the given class.

This method finds and returns the instance of the setting module for the specified class. It is a template method that takes the class type as the template parameter.

Warning

Compile will fail if T is not derived from UOperatingSystemSettingModule.

Precondition

The template parameter T must be derived from UOperatingSystemSettingModule.

Template Parameters

T	The class type of the setting module.

Returns

A pointer to the instance of the setting module if found, or nullptr if not found.

FindSettingModuleFromClass() [2/2]

UOperatingSystemSettingModule * UOperatingSystemSettingsData::FindSettingModuleFromClass

(

const TSoftClassPtr< UOperatingSystemSettingModule >

TestClass

)

const

Returns the setting module if it exists for the given class.

Parameters

TestClass

Class to search for.

Returns

Valid setting module if it exists or nullptr.

Here is the call graph for this function:

FindSettingModuleFromName()

UOperatingSystemSettingModule * UOperatingSystemSettingsData::FindSettingModuleFromName

(

const FText

SettingName

)

const

Returns the setting module if it exists for the given name.

Parameters

SettingName

Name of the setting module you want to get.

Returns

Valid setting module if it exists or nullptr.

Here is the call graph for this function:

GetModuleClasses()

FORCEINLINE const TMap< FOperatingSystemSettingModuleInfo, TSoftClassPtr< UOperatingSystemSettingModule > > & UOperatingSystemSettingsData::GetModuleClasses ( ) const

inline

Returns the map of module classes and their corresponding info.

This method returns the map of module classes and their corresponding info. The map is represented by a constant reference to a TMap, where the key is FOperatingSystemSettingModuleInfo and the value is TSoftClassPtr<UOperatingSystemSettingModule>.

Returns

The map of module classes and their corresponding info.

OnValidate()

void UOperatingSystemSettingsData::OnValidate ( FGenericError & OutError )

overrideprotectedvirtual

Validates the settings data for the operating system.

This method is responsible for validating the settings data for the operating system. It checks if all the required information for each module is provided and if the module classes are valid. If any validation fails, an error is set in the OutError object.

Parameters

OutError

Reference to the FGenericError object which holds any error information if validation fails.

Reimplemented from UOperatingSystemDataObject.

Here is the call graph for this function:

Member Data Documentation

bIsUsingCustomWallpaper

bool UOperatingSystemSettingsData::bIsUsingCustomWallpaper

Boolean flag indicating whether the user is using a custom wallpaper.

This variable represents whether the user has set a custom wallpaper for the operating system. If the value is true, the operating system will use the wallpaper specified in the 'WallpaperPath' variable. If the value is false, the operating system will use the default wallpaper.

WallpaperPath

FString UOperatingSystemSettingsData::WallpaperPath

String variable representing the path to the wallpaper.

This variable holds the file path of the wallpaper that the user has set for the operating system. It is used when the user chooses to use a custom wallpaper instead of the default wallpaper. The operating system will use this path to locate and display the custom wallpaper.

---

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

• Source/OperatingSystemSimulator/Public/Core/OperatingSystemSettingsData.h
• Source/OperatingSystemSimulator/Private/Core/OperatingSystemSettingsData.cpp