| FazBrowse GitHub Viewer | Trending | | Home |
| Tools: [Download Repo ZIP] [View Raw Code] [Original HTTPS Page] |
| title | Loading Screen |
|---|---|
| order | 62 |
| description | The screen showing the asset preloading progress |
<loading-screen></loading-screen>
This is the first screen that will be shown if Asset Preloading is enabled on the game's configuration.
Component tag: loading-screen
The following code is this component's initial HTML structure. Remember you can change this structure any time by using the template() component built-in function.
<loading-screen data-component="loading-screen" data-screen="loading">
<div data-content="wrapper">
<h2 data-string="Loading" data-content="title">Loading</h2>
<progress value="0" max="100" data-content="progress"></progress>
<small data-string="LoadingMessage" data-content="message">Wait while the assets are loaded.</small>
</div>
</loading-screen>
| Property | Type | Default | Description |
|---|---|---|---|
| progress | number | 0 | How many assets have finished loading so far. Each assetLoaded event increments it, and the new value is written to the <progress> element's value. |
Note
Being a screen component, the loading-screen also inherits the base open state, which is set to true when preloading starts and back to false when it finishes.
| Name | Type | Default | Description |
|---|---|---|---|
| max | number | 0 | The total number of assets queued for preloading. Each assetQueued event increments it, and the new value becomes the <progress> element's max. |
The loading screen is driven entirely by the preload events the engine emits while it loads the assets declared in your game's Asset Preloading configuration:
| Event | Effect on the loading screen |
|---|---|
| willPreloadAssets | Opens the screen (open → true). |
| assetQueued | Increments max (one more asset to load). |
| assetLoaded | Increments progress (one more asset finished). |
| didPreloadAssets | Closes the screen (open → false). |
For the full list of engine events and how to listen for them yourself, see Events.
| Back | FazBrowse Home | New Git URL |