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

The UOperatingSystemBIOS class represents the BIOS of an operating system. It provides functionalities for initializing the BIOS, opening the BIOS widget, and toggling the clock. More...

#include "OperatingSystemBIOS.h"

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

Public Member Functions

 UOperatingSystemBIOS ()
 
bool InitBIOS (TWeakObjectPtr< UOperatingSystemMBB > ForMotherboard, FGenericError &OutError)
 Initializes the operating system BIOS.
 
void OpenBIOS () const
 
void ToggleClock (const bool bTick)
 Toggles the clock of the operating system BIOS.
 
UOperatingSystemBiosWidgetGetBiosWidget () const
 Retrieves the BIOS widget associated with the operating system BIOS.
 

Protected Attributes

TSoftClassPtr< UOperatingSystemBiosWidgetBiosWidgetClass
 
FText Name
 
FOperatingSystemVersion Version
 
FText Copyright
 
TWeakObjectPtr< UOperatingSystemMBBParentMotherboard
 
bool bIsTickable
 
TObjectPtr< UOperatingSystemBiosWidgetBiosWidget
 Represents the BIOS widget that provides the graphical user interface for the BIOS functionality.
 
float TickElapsedTime
 

Detailed Description

The UOperatingSystemBIOS class represents the BIOS of an operating system. It provides functionalities for initializing the BIOS, opening the BIOS widget, and toggling the clock.

Constructor & Destructor Documentation

◆ UOperatingSystemBIOS()

UOperatingSystemBIOS::UOperatingSystemBIOS ( )

Member Function Documentation

◆ GetBiosWidget()

UOperatingSystemBiosWidget * UOperatingSystemBIOS::GetBiosWidget ( ) const

Retrieves the BIOS widget associated with the operating system BIOS.

This method returns the BIOS widget associated with the operating system BIOS. The BIOS widget is used for interacting with the BIOS functionalities.

Returns
The BIOS widget associated with the operating system BIOS.
Here is the caller graph for this function:

◆ InitBIOS()

bool UOperatingSystemBIOS::InitBIOS ( TWeakObjectPtr< UOperatingSystemMBB > ForMotherboard,
FGenericError & OutError )

Initializes the operating system BIOS.

This method initializes the operating system BIOS by creating the BIOS widget and setting the parent motherboard. If the BIOS widget class is null, it returns false and sets the error message in the OutError parameter. If the BIOS widget is not valid, it creates the BIOS widget using the CreateFromSoftWidget method.

Parameters
ForMotherboardA weak reference to the motherboard that owns the BIOS.
OutErrorThe error message in case of failure to initialize the BIOS.
Returns
True if the BIOS was successfully initialized, false otherwise.
Here is the call graph for this function:

◆ OpenBIOS()

void UOperatingSystemBIOS::OpenBIOS ( ) const

Opens the BIOS widget

◆ ToggleClock()

void UOperatingSystemBIOS::ToggleClock ( const bool bTick)

Toggles the clock of the operating system BIOS.

This method toggles the clock of the operating system BIOS. When the clock is toggled on, the BIOS will be updated every frame and can perform actions based on the elapsed time. When the clock is toggled off, the BIOS will not be updated and will not perform any actions based on the elapsed time.

Parameters
bTickWhether to toggle the clock on (true) or off (false).

Member Data Documentation

◆ BiosWidget

TObjectPtr<UOperatingSystemBiosWidget> UOperatingSystemBIOS::BiosWidget
protected

Represents the BIOS widget that provides the graphical user interface for the BIOS functionality.

The BIOS widget of type UOperatingSystemBiosWidget is used for displaying and interacting with the BIOS functionality in the graphical user interface. This variable holds an instance of the BIOS widget.

See also
UOperatingSystemBiosWidget

◆ BiosWidgetClass

TSoftClassPtr<UOperatingSystemBiosWidget> UOperatingSystemBIOS::BiosWidgetClass
protected

Represents the class of the BIOS widget that provides the graphical user interface for the BIOS functionality.

◆ bIsTickable

bool UOperatingSystemBIOS::bIsTickable
protected

Indicates whether the operating system BIOS is tickable.

This variable determines whether the operating system BIOS object can tick or not. Tickable objects are updated every frame and can perform actions based on the elapsed time. Setting this to true will enable the BIOS object to tick, and setting it to false will disable ticking.

The default value is false.

See also
UOperatingSystemBIOS::ToggleClock()

◆ Copyright

FText UOperatingSystemBIOS::Copyright
protected

Copyright text of the operating system BIOS.

◆ Name

FText UOperatingSystemBIOS::Name
protected

BIOS name

◆ ParentMotherboard

TWeakObjectPtr<UOperatingSystemMBB> UOperatingSystemBIOS::ParentMotherboard
protected

Weak reference to the motherboard that owns this BIOS.

◆ TickElapsedTime

float UOperatingSystemBIOS::TickElapsedTime
protected

Represents the elapsed time since the last tick in seconds.

The TickElapsedTime variable is used to keep track of the time elapsed since the last tick. It is a float value that represents the time in seconds. This variable is updated during each tick of the operating system BIOS and is used for performing actions based on the elapsed time, such as triggering events or updating the state of the BIOS.

See also
UOperatingSystemBIOS::Tick()

◆ Version

FOperatingSystemVersion UOperatingSystemBIOS::Version
protected

BIOS version


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