AOperatingSystemDeviceActor

#include <OperatingSystemSimulator/Public/Devices/OperatingSystemDeviceActor.h>

class AOperatingSystemDeviceActor

Defined in OperatingSystemDeviceActor.h:33

Inherits: AActor Subclassed by: AOperatingSystemPortableDeviceActor

Inheritance diagram

---
config:
  class:
    hideEmptyMembersBox: true
---
classDiagram
  class AOperatingSystemDeviceActor["AOperatingSystemDeviceActor"]
  class AActor["AActor"]
  AActor <|-- AOperatingSystemDeviceActor
  class AOperatingSystemPortableDeviceActor["AOperatingSystemPortableDeviceActor"]
  AOperatingSystemDeviceActor <|-- AOperatingSystemPortableDeviceActor

Collaboration diagram

---
config:
  class:
    hideEmptyMembersBox: true
---
classDiagram
  class AOperatingSystemDeviceActor["AOperatingSystemDeviceActor"]
  class UOperatingSystemBaseDevice["UOperatingSystemBaseDevice"]
  AOperatingSystemDeviceActor *-- UOperatingSystemBaseDevice
  class UOperatingSystemSaveGame["UOperatingSystemSaveGame"]
  AOperatingSystemDeviceActor *-- UOperatingSystemSaveGame
  class UOperatingSystemDeviceMessenger["UOperatingSystemDeviceMessenger"]
  AOperatingSystemDeviceActor *-- UOperatingSystemDeviceMessenger

Class detail

---
config:
  class:
    hideEmptyMembersBox: true
---
classDiagram
  class AOperatingSystemDeviceActor {
    +OnDeviceCreated : FOperatingSystemSimpleDelegate
    +OnOperatingSystemStarted : FOperatingSystemSimpleDelegate
    +OnValidate(FGenericError &OutError)
    +CreateDevice(FGenericError &OutError)
    +CurrentDeviceDestroyed()
    +RestartDevice()
    +WidgetChanged(UUserWidget *ChangedWidget)
    +OnShowBlueScreen(const float &OnScreenTime)
    +StopMediaAudio() const
    +GetHardwareByTag(const FGameplayTag &TestTag) const UOperatingSystemBaseHardware() *
    +SetAddWidgetsToScreen(const EOperatingSystemWidgetSet Method)
    +ClearWidgetFromScreen() const
    +RefreshWidget() const
    +IsPortableDevice() const bool
    +BeginDestroyMessenger()
    +FinishDestroyMessenger()
    +BeginOperatingSystemSessionEnd(const bool bRestart)
    +FinishOperatingSystemSessionEnd(const bool bRestart)
    +OnSaveGame(FOperatingSystemDeviceSaveLoad &SaveData)
    +OnLoadGame(const FOperatingSystemDeviceSaveLoad &LoadD
    +MainComponent : TObjectPtr< USceneComponent >
    +MediaSoundComponent : TObjectPtr< UMediaSoundComponent >
    +DeviceTag : FGameplayTag
    +DeviceClass : TSoftClassPtr< UOperatingSystemBaseDevic
    +bCreateDeviceOnBeginPlay : uint8
    +bAddWidgetsToScreen : uint8
    +bExitWhenDeviceIsDestroyed : uint8
    +bCanSaveGame : uint8
    +SaveGameClass : TSoftClassPtr< UOperatingSystemSaveGame(
    +MessengerClass : TSoftClassPtr< UOperatingSystemDeviceMes
    +LoadGameInstance : TObjectPtr< UOperatingSystemSaveGame() >
    +PlayerController : TWeakObjectPtr< APlayerController >
    +OnNewDeviceCreated(FGenericError &OutError)
    +OnBeginOperatingSystemSessionEnd(const bool bIsRestarting)
    +OnFinishOperatingSystemSessionEnd(const bool bWasRestart)
    +IsPortableDeviceImpl() const bool
    +K2_CreateDevice(FGenericError &OutError) bool
    +K2_OnCurrentDeviceDestroyed()
    +K2_OnWidgetChanged(UUserWidget *ChangedWidget)
    +K2_OnBlueScreenShow(const float &OnScreenTime)
    +K2_OnBeginOperatingSystemShutdown()
    +K2_OnFinishOperatingSystemShutdown()
    +K2_OnBeginOperatingSystemRestart()
    +K2_OnFinishOperatingSystemRestart()
    +DeviceMessenger : TObjectPtr< UOperatingSystemDeviceMessen
    +CurrentDevice : TObjectPtr< UOperatingSystemBaseDevice()
    +UniqueID : FGuid
    +Internal_OnValidate(FGenericError &OutError)
    +Internal_CreateDeviceManager()
  }

An operating system device actor that user can place in world.

Note

This is where everything begins

Public Attributes

Return	Name	Description
FOperatingSystemSimpleDelegate	OnDeviceCreated	Event raised when a new device is created.
FOperatingSystemSimpleDelegate	OnOperatingSystemStarted	An event that is raised when Operating System starts in this device.

---

OnDeviceCreated

FOperatingSystemSimpleDelegate OnDeviceCreated

Defined in OperatingSystemDeviceActor.h:127 Event raised when a new device is created.

This event is dispatched when a new device is created and associated with the operating system device actor. Subscribers can listen to this event to perform any necessary actions when a new device is created.

Example usage:

void OnNewDeviceCreated()
{
    // Perform actions when a new device is created
}

// Subscribe to the OnDeviceCreated event
MyOperatingSystemDeviceActorInstance->OnDeviceCreated.AddDynamic(this, &AActorClass::OnNewDeviceCreated);

Referenced by

• CreateDevice

---

OnOperatingSystemStarted

FOperatingSystemSimpleDelegate OnOperatingSystemStarted

Defined in OperatingSystemDeviceActor.h:131 An event that is raised when Operating System starts in this device.

Referenced by

• CreateDevice

Public Methods

Return	Name	Description
void	OnValidate virtual inline	This method is called to validate the object’s state.
void	CreateDevice	Creates a new device.
void	CurrentDeviceDestroyed	Method to handle the destruction of the current device.
void	RestartDevice	Restarts the device.
void	WidgetChanged	Handles the event when a widget is changed.
void	OnShowBlueScreen	Called when the blue screen should be shown on the operating system device.
void	StopMediaAudio const	Stops the media audio playback.
UOperatingSystemBaseHardware *	GetHardwareByTag const	Retrieves the hardware by the specified tag.
void	SetAddWidgetsToScreen	Sets the method for adding widgets to the screen.
void	ClearWidgetFromScreen const	Clears the widget from the screen.
void	RefreshWidget const	Checks if the current device is valid and then calls the ReApplyWidget() method on the current device.
bool	IsPortableDevice const inline	Determines whether the operating system device actor is a portable device.
void	BeginDestroyMessenger	Begins the destruction process for the messenger associated with the operating system device actor.
void	FinishDestroyMessenger	A method to finish the destruction of the operating system device actor.
void	BeginOperatingSystemSessionEnd
void	FinishOperatingSystemSessionEnd
void	OnSaveGame virtual inline	Saves the state of the operating system device in the provided save data.
void	OnLoadGame virtual inline	Callback method called when loading a game.

---

OnValidate

virtual inline

virtual inline void OnValidate(FGenericError & OutError)

Defined in OperatingSystemDeviceActor.h:156 This method is called to validate the object’s state.

This method should be implemented by derived classes to validate the state of the object. If any errors are found during the validation, they should be added to the provided OutError parameter.

Parameters

• OutError A reference to a FGenericError object, which is used to store any errors found during validation.

Note

The derived class must provide an implementation for this method.

Referenced by

• Internal_OnValidate

Reimplemented by

• OnValidate

---

CreateDevice

void CreateDevice(FGenericError & OutError)

Defined in OperatingSystemDeviceActor.h:185 Creates a new device.

This method creates a new device based on the specified class and instance. If the ‘CurrentDevice’ member variable is already set, an error will be returned and no device will be created. The ‘DeviceClass’ argument should not be null, otherwise an error will be returned. The ‘DeviceTag’ argument should have a valid tag, otherwise an error will be returned.

If the device creation is successful, the ‘CurrentDevice’ member variable will be set to the created device.

Parameters

• OutError A reference to a FGenericError object that will hold any error information if an error occurs during device creation.

Referenced by

• K2_CreateDevice
• RestartDevice

References

• CurrentDevice
• Device
• DeviceClass
• ErrorExceptionDescription
• Internal_CreateDeviceManager
• Internal_OnValidate
• IsValid
• LoadGame
• LoadGameInstance
• MAKE_ERROR
• NEW_SOFT_OBJ
• OnDeviceCreated
• OnLoadGame
• OnNewDeviceCreated
• OnOperatingSystemStarted
• OS_LOG
• OS_LOG_ERROR
• OS_LOG_VERBOSE
• OS_LOG_WARN
• PlayerController
• Reset

---

CurrentDeviceDestroyed

void CurrentDeviceDestroyed()

Defined in OperatingSystemDeviceActor.h:197 Method to handle the destruction of the current device.

This method is called when the current device is being destroyed. It performs various cleanup operations and handles any necessary actions. If the current device is valid, it checks if there is a blueprint assigned to the “CurrentDeviceDestroyed” event and calls it if available. It then unbinds the “OnOperatingSystemStartedDelegate” event from the current device, marks it as garbage, and sets the current device to nullptr.

If the “bExitWhenDeviceIsDestroyed” flag is set to true, the method executes additional actions. In the editor mode, it retrieves the player controller and executes the “exit” console command, which will exit the game. Otherwise, it requests the exit of the application.

References

• bExitWhenDeviceIsDestroyed
• CurrentDevice
• K2_OnCurrentDeviceDestroyed

---

RestartDevice

void RestartDevice()

Defined in OperatingSystemDeviceActor.h:213 Restarts the device.

This method restarts the operating system device. If the device has a blueprint on it that is destroyed, this method triggers the K2_OnCurrentDeviceDestroyed event.

If there is a current device, this method unbinds the OnOperatingSystemStartedDelegate and marks the current device as garbage. It then sets the CurrentDevice pointer to nullptr.

After that, it creates a timer delegate for the CreateDevice function and binds it to this actor. The delegate is then set to be executed after 1 second.

Note

This method assumes that the CurrentDevice pointer is already set to a valid device.

References

• CreateDevice
• CurrentDevice
• K2_OnCurrentDeviceDestroyed

---

WidgetChanged

void WidgetChanged(UUserWidget * ChangedWidget)

Defined in OperatingSystemDeviceActor.h:222 Handles the event when a widget is changed.

This method is called when a user widget is changed in the operating system device actor.

Parameters

• ChangedWidget The pointer to the user widget that has been changed.

References

• K2_OnWidgetChanged

---

OnShowBlueScreen

void OnShowBlueScreen(const float & OnScreenTime)

Defined in OperatingSystemDeviceActor.h:233 Called when the blue screen should be shown on the operating system device.

Parameters

• OnScreenTime The time in seconds the blue screen should be shown on the screen.

Note

This method is called when the operating system device actor is requested to show the blue screen. If the ‘bHasBlueprintOnBlueScreenShow’ flag is true, the K2_OnBlueScreenShow method in the blueprint will be called with the specified “OnScreenTime”.

See also: K2_OnBlueScreenShow

References

• K2_OnBlueScreenShow

---

StopMediaAudio

const

void StopMediaAudio() const

Defined in OperatingSystemDeviceActor.h:244 Stops the media audio playback.

This method stops the media audio playback by calling the Stop() function of the MediaSoundComponent.

Note

The MediaSoundComponent must be valid and initialized before calling this method.

See also: MediaSoundComponent

References

• MediaSoundComponent

---

GetHardwareByTag

const

UOperatingSystemBaseHardware * GetHardwareByTag(const FGameplayTag & TestTag) const

Defined in OperatingSystemDeviceActor.h:252 Retrieves the hardware by the specified tag.

Parameters

• TestTag The gameplay tag used for filtering hardware.

Returns

The instance of UOperatingSystemBaseHardware that matches the specified tag.

Referenced by

• FindHardwareByTag

References

• CurrentDevice

---

SetAddWidgetsToScreen

void SetAddWidgetsToScreen(const EOperatingSystemWidgetSet Method)

Defined in OperatingSystemDeviceActor.h:261 Sets the method for adding widgets to the screen.

Depending on the specified method, widgets may be added to the screen or not.

Parameters

• Method The method for adding widgets to the screen.

References

• bAddWidgetsToScreen
• CurrentDevice
• Disable
• SetAndApply

---

ClearWidgetFromScreen

const

void ClearWidgetFromScreen() const

Defined in OperatingSystemDeviceActor.h:270 Clears the widget from the screen.

This method clears the currently displayed widget from the screen. It checks if the current device is valid. If valid, it calls the “ClearOnScreenWidget()” method of the current device to clear the widget from the screen.

References

• CurrentDevice

---

RefreshWidget

const

void RefreshWidget() const

Defined in OperatingSystemDeviceActor.h:276 Checks if the current device is valid and then calls the ReApplyWidget() method on the current device.

References

• CurrentDevice

---

IsPortableDevice

const inline

inline bool IsPortableDevice() const

Defined in OperatingSystemDeviceActor.h:284 Determines whether the operating system device actor is a portable device.

Returns

True if the operating system device actor is a portable device, false otherwise.

---

BeginDestroyMessenger

void BeginDestroyMessenger()

Defined in OperatingSystemDeviceActor.h:296 Begins the destruction process for the messenger associated with the operating system device actor.

This method is responsible for initiating the destruction process for the messenger. It calls the BeginDestroyMessenger method of the DeviceMessenger associated with the operating system device actor.

Note

This method should only be called when the operating system device actor is being destroyed.

See also: DeviceMessenger, AOperatingSystemDeviceActor

Referenced by

• Internal_DestroyDevice

References

• DeviceMessenger

---

FinishDestroyMessenger

void FinishDestroyMessenger()

Defined in OperatingSystemDeviceActor.h:312 A method to finish the destruction of the operating system device actor.

This method marks the device messenger as garbage and sets it to nullptr.

Note

This method should be called to properly destroy the operating system device actor.

Preconditions:

• The device messenger must be initialized and assigned.

Postconditions:

• The device messenger will be marked as garbage.

• The device messenger will be set to nullptr.

Referenced by

• Internal_DestroyDevice

References

• DeviceMessenger

---

BeginOperatingSystemSessionEnd

void BeginOperatingSystemSessionEnd(const bool bRestart)

Defined in OperatingSystemDeviceActor.h:314

References

• K2_OnBeginOperatingSystemRestart
• K2_OnBeginOperatingSystemShutdown
• OnBeginOperatingSystemSessionEnd

---

FinishOperatingSystemSessionEnd

void FinishOperatingSystemSessionEnd(const bool bRestart)

Defined in OperatingSystemDeviceActor.h:315

Referenced by

• DestroyDeviceAndRestart
• Internal_SessionEnd

References

• K2_OnFinishOperatingSystemRestart
• K2_OnFinishOperatingSystemShutdown
• OnFinishOperatingSystemSessionEnd

---

OnSaveGame

virtual inline

virtual inline void OnSaveGame(FOperatingSystemDeviceSaveLoad & SaveData)

Defined in OperatingSystemDeviceActor.h:324 Saves the state of the operating system device in the provided save data.

Parameters

• SaveData The reference to the save data object where the state will be saved.

Note

This method should be overridden in derived classes to save additional state data.

Referenced by

• SaveGame

Reimplemented by

• OnSaveGame

---

OnLoadGame

virtual inline

virtual inline void OnLoadGame(const FOperatingSystemDeviceSaveLoad & LoadData)

Defined in OperatingSystemDeviceActor.h:337 Callback method called when loading a game.

This method is called when a game is being loaded. It is a virtual method that can be overridden by derived classes to provide custom logic for loading a game.

Parameters

• LoadData The save/load data for the operating system device.

Note

This method should be overridden in derived classes to load additional state data.

See also: FOperatingSystemDeviceSaveLoad

Referenced by

• CreateDevice

Reimplemented by

• OnLoadGame

Protected Attributes

Return	Name	Description
TObjectPtr< USceneComponent >	MainComponent
TObjectPtr< UMediaSoundComponent >	MediaSoundComponent
FGameplayTag	DeviceTag	A unique tag to identify this device.
TSoftClassPtr< UOperatingSystemBaseDevice >	DeviceClass	Target device class to create.
uint8	bCreateDeviceOnBeginPlay	If true, create the device on begin play. If false, you can manually call Create Device whenever you need.
uint8	bAddWidgetsToScreen	If true, add widgets directly to viewport screen.
uint8	bExitWhenDeviceIsDestroyed	Set to exit game when the device is destroyed. Device is destroyed when the OS shuts down.
uint8	bCanSaveGame	Determines if this device support save game.
TSoftClassPtr< UOperatingSystemSaveGame >	SaveGameClass	Target save game class.
TSoftClassPtr< UOperatingSystemDeviceMessenger >	MessengerClass	Target messenger class.
TObjectPtr< UOperatingSystemSaveGame >	LoadGameInstance
TWeakObjectPtr< APlayerController >	PlayerController

---

MainComponent

TObjectPtr< USceneComponent > MainComponent

Defined in OperatingSystemDeviceActor.h:40

MediaSoundComponent

TObjectPtr< UMediaSoundComponent > MediaSoundComponent

Defined in OperatingSystemDeviceActor.h:43

Referenced by

• StopMediaAudio

---

DeviceTag

FGameplayTag DeviceTag

Defined in OperatingSystemDeviceActor.h:47 A unique tag to identify this device.

Referenced by

• Internal_OnValidate

---

DeviceClass

TSoftClassPtr< UOperatingSystemBaseDevice > DeviceClass

Defined in OperatingSystemDeviceActor.h:51 Target device class to create.

Referenced by

• CreateDevice
• Internal_OnValidate

---

bCreateDeviceOnBeginPlay

uint8 bCreateDeviceOnBeginPlay

Defined in OperatingSystemDeviceActor.h:55 If true, create the device on begin play. If false, you can manually call Create Device whenever you need.

---

bAddWidgetsToScreen

uint8 bAddWidgetsToScreen

Defined in OperatingSystemDeviceActor.h:59 If true, add widgets directly to viewport screen.

Referenced by

• SetAddWidgetsToScreen

---

bExitWhenDeviceIsDestroyed

uint8 bExitWhenDeviceIsDestroyed

Defined in OperatingSystemDeviceActor.h:63 Set to exit game when the device is destroyed. Device is destroyed when the OS shuts down.

Referenced by

• CurrentDeviceDestroyed

---

bCanSaveGame

uint8 bCanSaveGame

Defined in OperatingSystemDeviceActor.h:67 Determines if this device support save game.

---

SaveGameClass

TSoftClassPtr< UOperatingSystemSaveGame > SaveGameClass

Defined in OperatingSystemDeviceActor.h:71 Target save game class.

---

MessengerClass

TSoftClassPtr< UOperatingSystemDeviceMessenger > MessengerClass

Defined in OperatingSystemDeviceActor.h:75 Target messenger class.

---

LoadGameInstance

TObjectPtr< UOperatingSystemSaveGame > LoadGameInstance

Defined in OperatingSystemDeviceActor.h:78

Referenced by

• CreateDevice

---

PlayerController

TWeakObjectPtr< APlayerController > PlayerController

Defined in OperatingSystemDeviceActor.h:81

Referenced by

• CreateDevice

Protected Methods

Return	Name	Description
void	OnNewDeviceCreated virtual inline	This method is called when a new device has been created. This method is intended to be overridden in subclasses of OperatingSystemDeviceActor to handle the event of a new device being created. It provides a way for the subclass to perform any necessary actions or processing related to the new device.
void	OnBeginOperatingSystemSessionEnd virtual inline	Called when the operating system session is about to end.
void	OnFinishOperatingSystemSessionEnd virtual inline	Called when the operating system session has ended.
bool	IsPortableDeviceImpl virtual const inline	Determines if the device is portable or not. By default, the method returns false.
bool	K2_CreateDevice	Creates a device in the operating system.
void	K2_OnCurrentDeviceDestroyed	Notifies the actor that the current device has been destroyed.
void	K2_OnWidgetChanged	Notifies the actor when the widget has changed.
void	K2_OnBlueScreenShow	Event that is triggered when the blue screen is shown on the operating system device actor.
void	K2_OnBeginOperatingSystemShutdown	Event that is triggered when the operating system begins the shutdown process. This event is called before closing running applications.
void	K2_OnFinishOperatingSystemShutdown	Event that is triggered when the operating system finishes the shutdown process.
void	K2_OnBeginOperatingSystemRestart	Event that is triggered when the operating system begins the restart process.
void	K2_OnFinishOperatingSystemRestart	Event that is triggered when the operating system finishes the restart process.

---

OnNewDeviceCreated

virtual inline

virtual inline void OnNewDeviceCreated(FGenericError & OutError)

Defined in OperatingSystemDeviceActor.h:368 This method is called when a new device has been created. This method is intended to be overridden in subclasses of OperatingSystemDeviceActor to handle the event of a new device being created. It provides a way for the subclass to perform any necessary actions or processing related to the new device.

Note

It is important to handle any errors that may occur during the processing of the new device creation. The OutError parameter can be used to return any error messages or information.

Parameters

• OutError A reference to a FGenericError object that can be used to return error messages if necessary.

Referenced by

• CreateDevice

Reimplemented by

• OnNewDeviceCreated

---

OnBeginOperatingSystemSessionEnd

virtual inline

virtual inline void OnBeginOperatingSystemSessionEnd(const bool bIsRestarting)

Defined in OperatingSystemDeviceActor.h:378 Called when the operating system session is about to end.

This method is called when the operating system session is about to end. It provides an opportunity for derived classes to perform any necessary actions before the session ends.

Parameters

• bIsRestarting A boolean indicating whether the session is ending due to a restart (true) or a shutdown (false).

Referenced by

• BeginOperatingSystemSessionEnd

---

OnFinishOperatingSystemSessionEnd

virtual inline

virtual inline void OnFinishOperatingSystemSessionEnd(const bool bWasRestart)

Defined in OperatingSystemDeviceActor.h:388 Called when the operating system session has ended.

This method is called when the operating system session has ended. It provides an opportunity for derived classes to perform any necessary actions after the session ends.

Parameters

• bWasRestart A boolean indicating whether the session ended due to a restart (true) or a shutdown (false).

Referenced by

• FinishOperatingSystemSessionEnd

---

IsPortableDeviceImpl

virtual const inline

virtual inline bool IsPortableDeviceImpl() const

Defined in OperatingSystemDeviceActor.h:395 Determines if the device is portable or not. By default, the method returns false.

Returns

True if the device is portable, false otherwise.

Reimplemented by

• IsPortableDeviceImpl

---

K2_CreateDevice

bool K2_CreateDevice(FGenericError & OutError)

Defined in OperatingSystemDeviceActor.h:406 Creates a device in the operating system.

Note

The device creation is the first step in the process.

Parameters

• OutError A reference to a FGenericError object that will hold any error encountered during device creation.

Returns

True if the device creation was successful, false otherwise.

References

• CreateDevice
• IsValid

---

K2_OnCurrentDeviceDestroyed

void K2_OnCurrentDeviceDestroyed()

Defined in OperatingSystemDeviceActor.h:416 Notifies the actor that the current device has been destroyed.

This event is blueprint implementable, allowing the user to define their own behavior when the current device is destroyed.

Note

This event will only be called when the current device associated with the actor is destroyed.

Referenced by

• CurrentDeviceDestroyed
• RestartDevice

---

K2_OnWidgetChanged

void K2_OnWidgetChanged(UUserWidget * ChangedWidget)

Defined in OperatingSystemDeviceActor.h:428 Notifies the actor when the widget has changed.

This event is called when the user widget associated with the operating system device actor has been changed.

Parameters

• ChangedWidget The new user widget that has been assigned to the operating system device actor. This parameter can be nullptr if the widget is being cleared. The ownership of the widget remains with the caller and it’s the caller responsibility to properly manage the widget’s lifetime.

Referenced by

• WidgetChanged

---

K2_OnBlueScreenShow

void K2_OnBlueScreenShow(const float & OnScreenTime)

Defined in OperatingSystemDeviceActor.h:440 Event that is triggered when the blue screen is shown on the operating system device actor.

Parameters

• OnScreenTime The amount of time the blue screen will be displayed on the screen.

Note

This event can be implemented in Blueprint to perform additional logic when the blue screen is shown. The implementation should be placed in the blueprint graph associated with the operating system device actor. The OnScreenTime parameter specifies the duration the blue screen will remain visible on the screen.

Referenced by

• OnShowBlueScreen

---

K2_OnBeginOperatingSystemShutdown

void K2_OnBeginOperatingSystemShutdown()

Defined in OperatingSystemDeviceActor.h:446 Event that is triggered when the operating system begins the shutdown process. This event is called before closing running applications.

Referenced by

• BeginOperatingSystemSessionEnd

---

K2_OnFinishOperatingSystemShutdown

void K2_OnFinishOperatingSystemShutdown()

Defined in OperatingSystemDeviceActor.h:450 Event that is triggered when the operating system finishes the shutdown process.

Referenced by

• FinishOperatingSystemSessionEnd

---

K2_OnBeginOperatingSystemRestart

void K2_OnBeginOperatingSystemRestart()

Defined in OperatingSystemDeviceActor.h:454 Event that is triggered when the operating system begins the restart process.

Referenced by

• BeginOperatingSystemSessionEnd

---

K2_OnFinishOperatingSystemRestart

void K2_OnFinishOperatingSystemRestart()

Defined in OperatingSystemDeviceActor.h:458 Event that is triggered when the operating system finishes the restart process.

Referenced by

• FinishOperatingSystemSessionEnd

Private Attributes

Return	Name	Description
TObjectPtr< UOperatingSystemDeviceMessenger >	DeviceMessenger	Messenger object that communicates with anything within this device.
TObjectPtr< UOperatingSystemBaseDevice >	CurrentDevice	Device that is spawned and currently associated with this actor.
FGuid	UniqueID	An auto generated unique ID associated with this device. Primarily used for save games.

---

DeviceMessenger

TObjectPtr< UOperatingSystemDeviceMessenger > DeviceMessenger

Defined in OperatingSystemDeviceActor.h:87 Messenger object that communicates with anything within this device.

Referenced by

• BeginDestroyMessenger
• FinishDestroyMessenger
• Internal_CreateDeviceManager

---

CurrentDevice

TObjectPtr< UOperatingSystemBaseDevice > CurrentDevice

Defined in OperatingSystemDeviceActor.h:91 Device that is spawned and currently associated with this actor.

Referenced by

• ClearWidgetFromScreen
• CreateDevice
• CurrentDeviceDestroyed
• GetHardwareByTag
• RefreshWidget
• RestartDevice
• SetAddWidgetsToScreen

---

UniqueID

FGuid UniqueID

Defined in OperatingSystemDeviceActor.h:95 An auto generated unique ID associated with this device. Primarily used for save games.

Private Methods

Return	Name	Description
void	Internal_OnValidate	Validates the operating system device actor.
void	Internal_CreateDeviceManager	Internal method to create the device manager for the operating system device actor.

---

Internal_OnValidate

void Internal_OnValidate(FGenericError & OutError)

Defined in OperatingSystemDeviceActor.h:168 Validates the operating system device actor.

This method is called to validate the operating system device actor. It checks if the device tag is valid and if the device class is not null If any validation fails, an error message is assigned to the OutError parameter.

Parameters

• OutError [out] The error message assigned if validation fails.

Referenced by

• CreateDevice

References

• DeviceClass
• DeviceTag
• IsOperatingSystemTagValid
• MAKE_ERROR
• OnValidate

---

Internal_CreateDeviceManager

void Internal_CreateDeviceManager()

Defined in OperatingSystemDeviceActor.h:354 Internal method to create the device manager for the operating system device actor.

This method is called internally to create the device manager for the operating system device actor. The device manager is responsible for managing the devices associated with the actor.

Note

If the device messenger is already created (IsValid(DeviceMessenger) returns true), this method does nothing.

See also: DeviceMessenger

See also: UOperatingSystemDeviceMessenger

See also: CreateMessenger

See also: IsValid

Referenced by

• CreateDevice

References

• CreateMessenger
• DeviceMessenger