WebRequestLoader Class Reference

Verifies and opens a web server connection on startup. More...

Inheritance diagram for WebRequestLoader:

Private Attributes
string	id
	Settings, Inspector A unique name to identify this FAST.WebRequest.
int	maxAttempts = 3
	Inspector The number of times to try connecting to the web server before failing.
int	settingsIndex
	Inspector The index of the FAST.WebRequestSettings to use in the FAST.BaseSettings.webRequestSettings.
string	uri
	Settings, Inspector The target URI for the FAST.WebRequest to communicate with.

Additional Inherited Members
Public Member Functions inherited from StartupLoader
void	Load ()
	Runs the FAST.StartupLoader.ExecuteLoad() Coroutine
Public Attributes inherited from StartupLoader
StartupErrorMessageEvent	errorEvent
	Inspector, Code Calls the function(s) subscribed to this UnityEvent when there is an error message.
StartupLoadingMessageEvent	loadingEvent
	Inspector, Code Calls the function(s) subscribed to this UnityEvent when there is a loading progress message.
StartupSuccessEvent	successEvent
	Inspector, Code Calls the function(s) subscribed to this UnityEvent when loading is done.
Static Public Attributes inherited from StartupLoader
static int	needToLoadCount = 0
	The number of FAST.StartupLoaders to execute on startup.
Protected Member Functions inherited from StartupLoader
virtual void	Awake ()
	The default behavior is to increment the FAST.StartupLoader.needToLoadCount.
IEnumerator	ExecuteLoad ()
	The Coroutine function that executes the loading of a resource or dependency, including progress and error messages.
Protected Attributes inherited from StartupLoader
string	errorMessage
	A variable to compose an error message and details before invoking the FAST.StartupLoader.errorEvent.
string	errorTitle
	A variable to compose an error message title before invoking the FAST.StartupLoader.errorEvent.
string	loadingMessage
	A variable to compose a loading progress message and details before invoking the FAST.StartupLoader.loadingEvent.
float	loadingMessageDuration = 0f
	Inspector The amount of time in seconds to show a FAST.LoadingProgress message.
string	loadingTitle
	A variable to compose a loading progress message title before invoking the FAST.StartupLoader.loadingEvent.

Detailed Description

Verifies and opens a web server connection on startup.

Member Data Documentation

id

string id

private

Settings, Inspector
A unique name to identify this FAST.WebRequest.

maxAttempts

int maxAttempts = 3

private

Inspector
The number of times to try connecting to the web server before failing.

settingsIndex

int settingsIndex

private

Inspector
The index of the FAST.WebRequestSettings to use in the FAST.BaseSettings.webRequestSettings.

Set to -1 if you aren't loading settings from FAST.BaseSettings.webRequestSettings and are just using Inspector values.

uri

string uri

private

Settings, Inspector
The target URI for the FAST.WebRequest to communicate with.

---

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

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