Skip to main content

App Loader

Shows a loading screen while the app's assets download, and reports progress as it goes.

Point it at the asset types you care about and it tracks them all, reporting a single Progress figure from 0 to 1 plus counts of what has loaded and what failed.

Auto Start begins as soon as the app does, which is the usual case. Otherwise pulse Start Loading yourself — useful when you want a title screen first and the load to begin on a tap.

Auto Hide at 100% fades the loader out when everything is in, and On Fade Out Complete is the signal to start the game on. Use that rather than On Load Complete if you do not want the first frame appearing behind a fading overlay.

Failures do not block the loader: On Asset Failed fires per asset and Failed Count accumulates, so a missing file degrades the experience instead of hanging on a splash screen forever.

Inputs

Appearance

DataDescription
Loading Text (string)Text shown while loading.
Show Percentage (boolean)Show the percentage alongside the text.
Auto Hide at 100% (boolean)Fade the loader out once everything has loaded.

Loading

DataDescription
Max Retries (number)How many times to retry an asset that fails.
Concurrent Loads (number)How many assets to download at once.
Auto Start (boolean)Begin loading as soon as the app starts.

Control

SignalDescription
Start LoadingBegins loading. Use when Auto Start is off.
Show LoaderShows the loader.
Hide LoaderHides the loader immediately.

Asset Types

DataDescription
Include Images (boolean)Track images.
Include Audio (boolean)Track audio.
Include Video (boolean)Track video.
Include Fonts (boolean)Track fonts.
Include Scripts (boolean)Track scripts.

Outputs

Status

DataDescription
Progress (number)Fraction loaded, 0 to 1.
Is Loading (boolean)True while a load is in progress.
Is Complete (boolean)True once every tracked asset has finished or failed.
Total Assets (number)How many assets are being tracked.
Loaded Count (number)How many have loaded.
Failed Count (number)How many failed after their retries.

Events

SignalDescription
On Load StartPulsed when loading begins.
On ProgressPulsed each time progress advances.
On Load CompletePulsed when loading finishes.
On Fade Out CompletePulsed after the fade out. Start the app here.
On Asset FailedPulsed once per asset that could not be loaded.