SettingsLoader Class Reference

Loads the activity configuration and settings XML files on startup. More...

Inheritance diagram for SettingsLoader:

Private Attributes
ConfigSettings	configSettings
	Settings, Runtime The configuration settings loaded at runtime.
MonoScript	settingsScript
	Inspector The script that derives from FAST.BaseSettings to define the settings for this activity.

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

Loads the activity configuration and settings XML files on startup.

If the configuration file doesn't exist, it will be written to the FAST.Application.activityDirectory. And if the settings file doesn't exist, it will be written to the FAST.Application.assetsDirectory.

Member Data Documentation

configSettings

ConfigSettings configSettings

private

Settings, Runtime
The configuration settings loaded at runtime.

The skin is specified here and used to load the correct activity settings.

settingsScript

MonoScript settingsScript

private

Inspector
The script that derives from FAST.BaseSettings to define the settings for this activity.

---

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

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