LoadingScreenManager Class Reference

Manages the GUI for the startup loading screen progress and errors. Not meant to be used directly in code. More...

Public Member Functions
void	UpdateErrorMessage (string heading, string message)
	Updates the title and message on all LoadingProgresses when an error occurs.
void	UpdateProgressMessage (string heading, string details)
	Updates the title and message on all LoadingProgresses.
void	UpdateProgressPercent (int percent)
	Updates the progress bar percentage on all LoadingProgresses.

Private Attributes
LoadingProgress[]	loadingProgresses
	List of progress bars to update when an update function is called.

Detailed Description

Manages the GUI for the startup loading screen progress and errors. Not meant to be used directly in code.

Default functionality is included in the Startup Prefab.

Warning

If you find yourself trying to use FAST.LoadingScreenManager in code, you may want to review the Startup documentation to make sure you are following FAST best practices.

Member Function Documentation

UpdateErrorMessage()

void UpdateErrorMessage	(	string	heading,
		string	message )

Updates the title and message on all LoadingProgresses when an error occurs.

Called by a FAST.StartupLoader when there is an error.

Parameters

heading	The title of the error message.
message	The error message and any additional details.

UpdateProgressMessage()

void UpdateProgressMessage	(	string	heading,
		string	details )

Updates the title and message on all LoadingProgresses.

Called by a FAST.StartupLoader when loading status and feedback is needed.

Parameters

heading	The title of the message.
details	The message and any additional details.

UpdateProgressPercent()

void UpdateProgressPercent

(

int

percent

)

Updates the progress bar percentage on all LoadingProgresses.

Called by FAST.StartupManager every time a FAST.StartupLoader is loaded during startup.

Parameters

percent

The progress bar percentage in the range [0, 100].

Member Data Documentation

loadingProgresses

LoadingProgress [] loadingProgresses

private

List of progress bars to update when an update function is called.

Usually there is one LoadingProgress per display.

---

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

• C:/Users/cgbrown/Development/git/FAST/FAST-SDK/Runtime/Startup/LoadingScreenManager.cs