Operating System Simulator Plugin  3.5.1
Unreal Engine plugin that simulates an Operating System Environment
Loading...
Searching...
No Matches
UOperatingSystemWorldSubsystem Class Reference

#include "OperatingSystemWorldSubsystem.h"

Inheritance diagram for UOperatingSystemWorldSubsystem:
[legend]
Collaboration diagram for UOperatingSystemWorldSubsystem:
[legend]

Public Member Functions

 UOperatingSystemWorldSubsystem ()
 
virtual void Initialize (FSubsystemCollectionBase &Collection) override
 
virtual void Deinitialize () override
 
void RegisterDeviceActor (AOperatingSystemDeviceActor *DeviceActor)
 This method adds the specified device actor to the RegisteredDeviceActors array of the operating system world subsystem.
 
void UnregisterDeviceActor (AOperatingSystemDeviceActor *DeviceActor)
 This method removes the specified device actor from the RegisteredDeviceActors array of the operating system world subsystem. The array consists of weak pointers to AOperatingSystemDeviceActor instances that are registered with the subsystem.
 
AOperatingSystemDeviceActorFindDeviceActorByTag (const FGameplayTag TestTag)
 
void FindDeviceActorsByTag (const FGameplayTag TestTag, TArray< AOperatingSystemDeviceActor * > &OutDeviceActors)
 
UOperatingSystemUserManagerGetUserManager () const
 
FORCEINLINE void SetTargetTexture (UTextureRenderTarget2D *TargetTexture) const
 
FORCEINLINE bool DrawWidget (UUserWidget *Widget, const bool bDeferUpdate, const float DeltaTime) const
 

Static Public Member Functions

static UOperatingSystemWorldSubsystemGet (const UObject *WorldContextObject)
 

Detailed Description

UOperatingSystemWorldSubsystem class is a subsystem of the game world that manages the operating system functionality.

Constructor & Destructor Documentation

◆ UOperatingSystemWorldSubsystem()

UOperatingSystemWorldSubsystem::UOperatingSystemWorldSubsystem ( )

Member Function Documentation

◆ Deinitialize()

void UOperatingSystemWorldSubsystem::Deinitialize ( )
overridevirtual

◆ DrawWidget()

FORCEINLINE bool UOperatingSystemWorldSubsystem::DrawWidget ( UUserWidget * Widget,
const bool bDeferUpdate,
const float DeltaTime ) const
inline

Draws the specified widget using the operating system widget drawer.

Parameters
WidgetThe UUserWidget instance to be drawn.
bDeferUpdateWhether to defer the widget update.
DeltaTimeThe time since the last frame.
Returns
true if the widget was successfully drawn, false otherwise.

◆ FindDeviceActorByTag()

AOperatingSystemDeviceActor * UOperatingSystemWorldSubsystem::FindDeviceActorByTag ( const FGameplayTag TestTag)

Searches for a device actor in the registered device actors based on the provided tag. If a matching device actor is found, it is returned. If the provided tag is not valid, an error message is logged and null is returned. If no device actor is found with the provided tag, a warning message is logged and null is returned.

Parameters
TestTagThe tag used to identify the device actor.
Returns
The device actor with the provided tag, or null if not found or if the tag is not valid.
Here is the call graph for this function:
Here is the caller graph for this function:

◆ FindDeviceActorsByTag()

void UOperatingSystemWorldSubsystem::FindDeviceActorsByTag ( const FGameplayTag TestTag,
TArray< AOperatingSystemDeviceActor * > & OutDeviceActors )

Searches for device actors in the registered device actors based on the provided tag. If matching device actors are found, they are added to the OutDeviceActors array. If the provided tag is not valid, an error message is logged and the array remains empty. If no device actors are found with the provided tag, a warning message is logged and the array remains empty.

Parameters
TestTagThe tag used to identify the device actors.
OutDeviceActorsThe array to which the found device actors should be added.
Here is the call graph for this function:
Here is the caller graph for this function:

◆ Get()

UOperatingSystemWorldSubsystem * UOperatingSystemWorldSubsystem::Get ( const UObject * WorldContextObject)
static

Retrieves the instance of the UOperatingSystemWorldSubsystem class that is associated with the specified WorldContextObject.

Parameters
WorldContextObjectThe UObject instance representing the context of the world.
Returns
The UOperatingSystemWorldSubsystem instance associated with the WorldContextObject.
Here is the caller graph for this function:

◆ GetUserManager()

UOperatingSystemUserManager * UOperatingSystemWorldSubsystem::GetUserManager ( ) const

Get the user manager instance.

Returns
The user manager instance.
Here is the caller graph for this function:

◆ Initialize()

void UOperatingSystemWorldSubsystem::Initialize ( FSubsystemCollectionBase & Collection)
overridevirtual
Here is the call graph for this function:

◆ RegisterDeviceActor()

void UOperatingSystemWorldSubsystem::RegisterDeviceActor ( AOperatingSystemDeviceActor * DeviceActor)

This method adds the specified device actor to the RegisteredDeviceActors array of the operating system world subsystem.

Parameters
DeviceActorA pointer to an instance of the AOperatingSystemDeviceActor class to be registered.

◆ SetTargetTexture()

FORCEINLINE void UOperatingSystemWorldSubsystem::SetTargetTexture ( UTextureRenderTarget2D * TargetTexture) const
inline

Sets the target texture for the operating system widget drawer.

Parameters
TargetTextureThe UTextureRenderTarget2D instance representing the target texture.

◆ UnregisterDeviceActor()

void UOperatingSystemWorldSubsystem::UnregisterDeviceActor ( AOperatingSystemDeviceActor * DeviceActor)

This method removes the specified device actor from the RegisteredDeviceActors array of the operating system world subsystem. The array consists of weak pointers to AOperatingSystemDeviceActor instances that are registered with the subsystem.

Parameters
DeviceActorA pointer to an instance of the AOperatingSystemDeviceActor class to be unregistered.

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