UOperatingSystemBIOS

#include <OperatingSystemSimulator/Public/Core/OperatingSystemBIOS.h>

class UOperatingSystemBIOS

Defined in OperatingSystemBIOS.h:21

Inherits: UObject, FTickableGameObject

Inheritance diagram

---
config:
  class:
    hideEmptyMembersBox: true
---
classDiagram
  class UOperatingSystemBIOS["UOperatingSystemBIOS"]
  class UObject["UObject"]
  UObject <|-- UOperatingSystemBIOS
  class FTickableGameObject["FTickableGameObject"]
  FTickableGameObject <|-- UOperatingSystemBIOS

Collaboration diagram

---
config:
  class:
    hideEmptyMembersBox: true
---
classDiagram
  class UOperatingSystemBIOS["UOperatingSystemBIOS"]
  class UOperatingSystemBiosWidget["UOperatingSystemBiosWidget"]
  UOperatingSystemBIOS *-- UOperatingSystemBiosWidget
  class FOperatingSystemVersion["FOperatingSystemVersion"]
  UOperatingSystemBIOS *-- FOperatingSystemVersion
  class UOperatingSystemMBB["UOperatingSystemMBB"]
  UOperatingSystemBIOS *-- UOperatingSystemMBB

Class detail

---
config:
  class:
    hideEmptyMembersBox: true
---
classDiagram
  class UOperatingSystemBIOS {
    +UOperatingSystemBIOS()
    +InitBIOS(TWeakObjectPtr< UOperatingSystemMBB > ForMo bool
    +OpenBIOS() const
    +ToggleClock(const bool bTick)
    +GetBiosWidget() const UOperatingSystemBiosWidget() *
    +BiosWidgetClass : TSoftClassPtr< UOperatingSystemBiosWidge
    +Name : FText
    +Version : FOperatingSystemVersion()
    +Copyright : FText
    +ParentMotherboard : TWeakObjectPtr< UOperatingSystemMBB() >
    +bIsTickable : bool
    +BiosWidget : TObjectPtr< UOperatingSystemBiosWidget()
    +TickElapsedTime : float
  }

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.

Public Methods

Return	Name	Description
	`UOperatingSystemBIOS`
`bool`	`InitBIOS`	Initializes the operating system BIOS.
`void`	`OpenBIOS` `const`	Opens the BIOS widget
`void`	`ToggleClock`	Toggles the clock of the operating system BIOS.
`UOperatingSystemBiosWidget *`	`GetBiosWidget` `const`	Retrieves the BIOS widget associated with the operating system BIOS.

UOperatingSystemBIOS

UOperatingSystemBIOS()

Defined in OperatingSystemBIOS.h:86

InitBIOS

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

Defined in OperatingSystemBIOS.h:100 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

ForMotherboard A weak reference to the motherboard that owns the BIOS.
OutError The error message in case of failure to initialize the BIOS.

Returns

True if the BIOS was successfully initialized, false otherwise.

References

BiosWidget
BiosWidgetClass
CreateFromSoftWidget
MAKE_ERROR
ParentMotherboard

OpenBIOS

const

void OpenBIOS() const

Defined in OperatingSystemBIOS.h:103 Opens the BIOS widget

ToggleClock

void ToggleClock(const bool bTick)

Defined in OperatingSystemBIOS.h:113 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

bTick Whether to toggle the clock on (true) or off (false).

References

bIsTickable

GetBiosWidget

const

UOperatingSystemBiosWidget * GetBiosWidget() const

Defined in OperatingSystemBIOS.h:133 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.

Referenced by

CheckHardwareFailed

References

BiosWidget

Protected Attributes

Return	Name	Description
`TSoftClassPtr< UOperatingSystemBiosWidget >`	`BiosWidgetClass`	Represents the class of the BIOS widget that provides the graphical user interface for the BIOS functionality.
`FText`	`Name`	BIOS name
`FOperatingSystemVersion`	`Version`	BIOS version
`FText`	`Copyright`	Copyright text of the operating system BIOS.
`TWeakObjectPtr< UOperatingSystemMBB >`	`ParentMotherboard`	Weak reference to the motherboard that owns this BIOS.
`bool`	`bIsTickable`	Indicates whether the operating system BIOS is tickable.
`TObjectPtr< UOperatingSystemBiosWidget >`	`BiosWidget`	Represents the BIOS widget that provides the graphical user interface for the BIOS functionality.
`float`	`TickElapsedTime`	Represents the elapsed time since the last tick in seconds.

BiosWidgetClass

TSoftClassPtr< UOperatingSystemBiosWidget > BiosWidgetClass

Defined in OperatingSystemBIOS.h:29 Represents the class of the BIOS widget that provides the graphical user interface for the BIOS functionality.

Referenced by

InitBIOS

Name

FText Name

Defined in OperatingSystemBIOS.h:33 BIOS name

Version

FOperatingSystemVersion Version

Defined in OperatingSystemBIOS.h:37 BIOS version

Copyright

FText Copyright

Defined in OperatingSystemBIOS.h:41 Copyright text of the operating system BIOS.

ParentMotherboard

TWeakObjectPtr< UOperatingSystemMBB > ParentMotherboard

Defined in OperatingSystemBIOS.h:45 Weak reference to the motherboard that owns this BIOS.

Referenced by

InitBIOS
OpenBIOS

bIsTickable

bool bIsTickable

Defined in OperatingSystemBIOS.h:59 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.

Referenced by

ToggleClock

BiosWidget

TObjectPtr< UOperatingSystemBiosWidget > BiosWidget

Defined in OperatingSystemBIOS.h:70 Represents the BIOS widget that provides the graphical user interface for the BIOS functionality.

The BIOS widget of type [UOperatingSystemBiosWidget](/api-reference/operating-system-simulator/widgets/uoperatingsystembioswidget/#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

Referenced by

GetBiosWidget
InitBIOS
OpenBIOS

TickElapsedTime

float TickElapsedTime

Defined in OperatingSystemBIOS.h:82 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()