Component:AssetLoadStatus: Difference between revisions

Revision as of 12:55, 14 February 2024

Component image

This is a component that tracks the load status of a list of assets locally.

Fields
Name	Type	Description
`persistent`	Bool	Determines whether or not this item will be saved to the server.
`UpdateOrder`	Int	Controls the order in which this component is updated.
`Enabled`	Bool	Controls whether or not this component is enabled.
`Assets`	IAsset`1	List of assets that the component should listen to for loading status
`IsLoaded`	Bool	Are all the assets in Assets list loaded?
`LoadProgress`	Float	The ratio of "how many assets are loaded" to the total asset count.
`ProgressWeight`	Float	The total count of assets in `Assets`.

This component returns a ratio of how many of the given assets are actually loaded.

@@ Line 2: / Line 2: @@
 <translate>
 <!--T:1-->
-{{stub}}
 {{Infobox Component
 |Image=AssetLoadStatusComponent.png
@@ Line 17: / Line 16: @@
 |Assets|IAsset`1| List of assets that the component should listen to for loading status
 |IsLoaded|Bool| Are all the assets in Assets list loaded?
-|LoadProgress|Float| The load progress of all the assets together
+|LoadProgress|Float| The ratio of "how many assets are loaded" to the total asset count.
-|ProgressWeight|Float|
+|ProgressWeight|Float| The total count of assets in <code>Assets</code>.
 }}
 <!--T:4-->
 == Behavior ==
-this component reads the loading progress of all the assets in it's list and returns their load progresses and progress weight averaged.
+This component returns a ratio of how many of the given assets are actually loaded.
 <!--T:5-->