LoadingProgress Class Reference

Loading screen progress and error GUI. Not meant to be used directly in code. More...

Public Member Functions
void	UpdateErrorMessage (string title, string message)
	Updates the error title and message.
void	UpdateProgress (int value, string title, string message)
	Updates the progress title, message, and progress bar percentage.
void	UpdateProgressMessage (string title, string message)
	Updates the progress title and message.
void	UpdateProgressPercent (int value)
	Updates the progress bar percentage.

Private Attributes
GameObject	errorGroup
	Inspector The parent GameObject all error GUI elements are grouped under.
TMP_Text	errorMessage
	Inspector The error message and any additional details.
TMP_Text	errorTitle
	Inspector The error message title.
Image	progressBarFill
	Inspector The progress bar fill image.
int	progressBarValue
	Inspector The progress bar percentage in the range [0, 100].
GameObject	progressGroup
	Inspector The parent GameObject all progress GUI elements are grouped under.
TMP_Text	progressMessage
	Inspector The progress message and any additional details.
TMP_Text	progressTitle
	Inspector The progress message title.

Detailed Description

Loading screen progress and error GUI. 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.LoadingProgress in code, you may want to review the Startup documentation to make sure you are following FAST best practices.

See also

UnityEngine.GameObject

Member Function Documentation

UpdateErrorMessage()

void UpdateErrorMessage	(	string	title,
		string	message )

Updates the error title and message.

Parameters

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

UpdateProgress()

void UpdateProgress	(	int	value,
		string	title,
		string	message )

Updates the progress title, message, and progress bar percentage.

Parameters

value	The progress bar percentage in the range [0, 100].
title	The title of the message.
message	The message and any additional details.

UpdateProgressMessage()

void UpdateProgressMessage	(	string	title,
		string	message )

Updates the progress title and message.

Parameters

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

UpdateProgressPercent()

void UpdateProgressPercent

(

int

value

)

Updates the progress bar percentage.

Parameters

value

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

Member Data Documentation

errorGroup

GameObject errorGroup

private

Inspector
The parent GameObject all error GUI elements are grouped under.

errorMessage

TMP_Text errorMessage

private

Inspector
The error message and any additional details.

errorTitle

TMP_Text errorTitle

private

Inspector
The error message title.

progressBarFill

Image progressBarFill

private

Inspector
The progress bar fill image.

progressBarValue

int progressBarValue

private

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

progressGroup

GameObject progressGroup

private

Inspector
The parent GameObject all progress GUI elements are grouped under.

progressMessage

TMP_Text progressMessage

private

Inspector
The progress message and any additional details.

progressTitle

TMP_Text progressTitle

private

Inspector
The progress message title.

---

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

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