Access using Airship.LoadingScreen. Manage the player's loading
screen when joining your game. This can be useful if your game requires
some work on the client before the game is ready to be played, such as
spawning a map.
Once loading is complete call FinishLoading to remove the loading screen.
Call when loading complete. This will remove the loading screen.
Returns void
HideSkipButton
HideSkipButton(): void
Hides skip button.
Returns void
IsSkipRequested
IsSkipRequested(): boolean
Returns true one time if the client requests a skip. Won't return true again until the client next
requests a skip.
Returns boolean
SetProgress
SetProgress(step, progress?): void
Sets the current fill of the progress bar.
Parameters
step: string
A short description of what's being loaded. This is shown on the loading screen.
progress: number = 0
Value from 0-1. This is currently not used but may in the future.
Returns void
ShowSkipButton
ShowSkipButton(): void
Shows skip button on the loading screen in case a loading step is optional (for example: warming shaders).
When clicked IsSkipRequested will return true once.
[Client only]
Access using Airship.LoadingScreen. Manage the player's loading screen when joining your game. This can be useful if your game requires some work on the client before the game is ready to be played, such as spawning a map.
Once loading is complete call FinishLoading to remove the loading screen.