FAST SDK Coding Reference 1.0.3
Loading...
Searching...
No Matches
InstallationLoader Class Reference

Verifies the file and folder structure where this activity is installed. More...

Inheritance diagram for InstallationLoader:
StartupLoader

Static Public Attributes

const string kApplicationFolder = "Application"
 The name of the folder where the activity executable is installed.
 
const string kAssetsFolder = "Assets"
 The name of the folder where the activity assets are installed.
 
const string kLogsFolder = "Logs"
 The name of the folder where Unity Player logs are saved.
 
- Static Public Attributes inherited from StartupLoader
static int needToLoadCount = 0
 The number of FAST.StartupLoaders to execute on startup.
 

Private Attributes

string editorInstallDirectory = "Build"
 Inspector
The directory with the installation file structure to use while developing in the Unity Editor.
 

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.
 
- 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 the file and folder structure where this activity is installed.

Member Data Documentation

◆ editorInstallDirectory

string editorInstallDirectory = "Build"
private

Inspector
The directory with the installation file structure to use while developing in the Unity Editor.

The path can be absolute or relative to the Unity project folder and can include Environment variables.

◆ kApplicationFolder

const string kApplicationFolder = "Application"
static

The name of the folder where the activity executable is installed.

◆ kAssetsFolder

const string kAssetsFolder = "Assets"
static

The name of the folder where the activity assets are installed.

◆ kLogsFolder

const string kLogsFolder = "Logs"
static

The name of the folder where Unity Player logs are saved.


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