Component:WorldLoadingProgressInterface: Difference between revisions

From Resonite Wiki
Visual
Created page with "<languages></languages> <translate> <!--T:1--> {{stub}} {{Infobox Component |Image=WorldLoadingProgressInterface.png |Name=World Loading Progress Interface }} '''WorldLoadingProgressInterface''' is the key component in the creation of a user-definable world loading progress bar. When attached to a slot it allows that slot to be set as a user's custom world loading progress indicator from their inventory. When used it will appear in-place of the default Resonite world lo..."
 
add info
 
(2 intermediate revisions by 2 users not shown)
Line 7: Line 7:
|Name=World Loading Progress Interface
|Name=World Loading Progress Interface
}}
}}
 
The '''WorldLoadingProgressInterface''' component is the key component in the creation of a user-definable world loading progress bar. See [[Favorites]] for favoritable items like this one.
'''WorldLoadingProgressInterface''' is the key component in the creation of a user-definable world loading progress bar. When attached to a slot it allows that slot to be set as a user's custom world loading progress indicator from their inventory. When used it will appear in-place of the default Resonite world loading progress indicator.


<!--T:2-->
<!--T:2-->
== Fields ==
== Fields ==
{{Table ComponentFields
{{Table ComponentFields
|Progress|SyncRef`1|TypeString0=SyncRef<IField<float>>| Float field where 0.0 - 1.0 progress will be written.
|ItemName|'''[[Type:IField`1|IField`1]]&lt;[[Type:String|String]]&gt;'''|TypeAdv0=true| The name of this favoritable item.
|WorldName|SyncRef`1|TypeString1=SyncRef<IField<string>>| String field where the loading world's name will be written.
|SpawningUser|UserRef| The user that spawned this favoritable item.
|Stage|SyncRef`1|TypeString2=SyncRef<IField<ProgressStage>>| SyncRef ProgressStage Field ''(To-Do: Need info on ProgressStage fields and what provides them.)''
|SpawningUserID|'''[[Type:IField`1|IField`1]]&lt;[[Type:String|String]]&gt;'''|TypeAdv2=true| The field containing the ID of the user that spawned this favoritable item.
|PhaseName|SyncRef`1|TypeString3=SyncRef<IField<string>>| String field where the current loading phase name will be written.
|IsInstance|Bool| Whether this item is an instance.
|SubPhaseName|SyncRef`1|TypeString4=SyncRef<IField<string>>| String field where the current loading sub-phase name will be written.
|Progress|'''[[Type:IField`1|IField`1]]&lt;[[Type:Float|Float]]&gt;'''|TypeAdv4=true| Float field where 0.0 - 1.0 progress will be written.
|HasCompleted|SyncRef`1|TypeString5=SyncRef<IField<bool>>| Boolean field that will be set to true on loading completion.
|WorldName|'''[[Type:IField`1|IField`1]]&lt;[[Type:String|String]]&gt;'''|TypeAdv5=true| String field where the loading world's name will be written.
|HasFailed|SyncRef`1|TypeString6=SyncRef<IField<bool>>| Boolean field that will be set to true on loading failure.
|Stage|'''[[Type:IField`1|IField`1]]&lt;[[Type:ProgressStage|ProgressStage]]&gt;'''|TypeAdv6=true| The field to write with the current progress stage of the currently loading world. This is written by the world loading main process.
|CompletionMessage|SyncRef`1|TypeString7=SyncRef<IField<string>>| String field where message indicating completion will be written.
|PhaseName|'''[[Type:IField`1|IField`1]]&lt;[[Type:String|String]]&gt;'''|TypeAdv7=true| String field where the current loading phase name will be written.
|FailureReason|SyncRef`1|TypeString8=SyncRef<IField<string>>| String field where message indicating reason for loading failure will be written.
|SubPhaseName|'''[[Type:IField`1|IField`1]]&lt;[[Type:String|String]]&gt;'''|TypeAdv8=true| String field where the current loading sub-phase name will be written.
|LoadingAssets|SyncRef`1|TypeString9=SyncRef<IField<bool>>| Boolean field that is set true while loading assets.
|HasCompleted|'''[[Type:IField`1|IField`1]]&lt;[[Type:Bool|Bool]]&gt;'''|TypeAdv9=true| Boolean field that will be set to true on loading completion.
|LoadedAssets|SyncRef`1|TypeString10=SyncRef<IField<int>>| Integer field counting loaded assets.
|HasFailed|'''[[Type:IField`1|IField`1]]&lt;[[Type:Bool|Bool]]&gt;'''|TypeAdv10=true| Boolean field that will be set to true on loading failure.
|TotalAssets|SyncRef`1|TypeString11=SyncRef<IField<int>>| Integer field counting total assets to be loaded.
|CompletionMessage|'''[[Type:IField`1|IField`1]]&lt;[[Type:String|String]]&gt;'''|TypeAdv11=true| String field where message indicating completion will be written.
|LoadedTextures2D|SyncRef`1|TypeString12=SyncRef<IField<int>>| Integer field counting loaded ITexture2D assets.
|FailureReason|'''[[Type:IField`1|IField`1]]&lt;[[Type:String|String]]&gt;'''|TypeAdv12=true| String field where message indicating reason for loading failure will be written.
|TotalTextures2D|SyncRef`1|TypeString13=SyncRef<IField<int>>| Integer field counting total ITexture2D assets to be loaded.
|LoadingAssets|'''[[Type:IField`1|IField`1]]&lt;[[Type:Bool|Bool]]&gt;'''|TypeAdv13=true| Boolean field that is set true while loading assets.
|LoadedTextures3D|SyncRef`1|TypeString14=SyncRef<IField<int>>| Integer field counting loaded ITexture3D assets.
|LoadedAssets|'''[[Type:IField`1|IField`1]]&lt;[[Type:Int|Int]]&gt;'''|TypeAdv14=true| Integer field counting loaded assets.
|TotalTextures3D|SyncRef`1|TypeString15=SyncRef<IField<int>>| Integer field counting total ITexture3D assets to be loaded.
|TotalAssets|'''[[Type:IField`1|IField`1]]&lt;[[Type:Int|Int]]&gt;'''|TypeAdv15=true| Integer field counting total assets to be loaded.
|LoadedCubemaps|SyncRef`1|TypeString16=SyncRef<IField<int>>| Integer field counting loaded Cubemap assets.
|LoadedTextures2D|'''[[Type:IField`1|IField`1]]&lt;[[Type:Int|Int]]&gt;'''|TypeAdv16=true| Integer field counting loaded ITexture2D assets.
|TotalCubemaps|SyncRef`1|TypeString17=SyncRef<IField<int>>| Integer field counting total Cubemap assets to be loaded.
|TotalTextures2D|'''[[Type:IField`1|IField`1]]&lt;[[Type:Int|Int]]&gt;'''|TypeAdv17=true| Integer field counting total ITexture2D assets to be loaded.
|LoadedVideos|SyncRef`1|TypeString18=SyncRef<IField<int>>| Integer field counting loaded Video assets.
|LoadedTextures3D|'''[[Type:IField`1|IField`1]]&lt;[[Type:Int|Int]]&gt;'''|TypeAdv18=true| Integer field counting loaded ITexture3D assets.
|TotalVideos|SyncRef`1|TypeString19=SyncRef<IField<int>>| Integer field counting total Video assets to be loaded.
|TotalTextures3D|'''[[Type:IField`1|IField`1]]&lt;[[Type:Int|Int]]&gt;'''|TypeAdv19=true| Integer field counting total ITexture3D assets to be loaded.
|LoadedMeshes|SyncRef`1|TypeString20=SyncRef<IField<int>>| Integer field counting loaded Mesh assets.
|LoadedCubemaps|'''[[Type:IField`1|IField`1]]&lt;[[Type:Int|Int]]&gt;'''|TypeAdv20=true| Integer field counting loaded Cubemap assets.
|TotalMeshes|SyncRef`1|TypeString21=SyncRef<IField<int>>| Integer field counting total Mesh assets to be loaded.
|TotalCubemaps|'''[[Type:IField`1|IField`1]]&lt;[[Type:Int|Int]]&gt;'''|TypeAdv21=true| Integer field counting total Cubemap assets to be loaded.
|LoadedAudioClips|SyncRef`1|TypeString22=SyncRef<IField<int>>| Integer field counting loaded Audio assets.
|LoadedVideos|'''[[Type:IField`1|IField`1]]&lt;[[Type:Int|Int]]&gt;'''|TypeAdv22=true| Integer field counting loaded Video assets.
|TotalAudioClips|SyncRef`1|TypeString23=SyncRef<IField<int>>| Integer field counting total Audio assets to be loaded.
|TotalVideos|'''[[Type:IField`1|IField`1]]&lt;[[Type:Int|Int]]&gt;'''|TypeAdv23=true| Integer field counting total Video assets to be loaded.
|LoadedShaders|SyncRef`1|TypeString24=SyncRef<IField<int>>| Integer field counting loaded Shader assets.
|LoadedMeshes|'''[[Type:IField`1|IField`1]]&lt;[[Type:Int|Int]]&gt;'''|TypeAdv24=true| Integer field counting loaded Mesh assets.
|TotalShaders|SyncRef`1|TypeString25=SyncRef<IField<int>>| Integer field counting total Shader assets to be loaded.
|TotalMeshes|'''[[Type:IField`1|IField`1]]&lt;[[Type:Int|Int]]&gt;'''|TypeAdv25=true| Integer field counting total Mesh assets to be loaded.
|LoadedFonts|SyncRef`1|TypeString26=SyncRef<IField<int>>| Integer field counting loaded Font assets.
|LoadedAudioClips|'''[[Type:IField`1|IField`1]]&lt;[[Type:Int|Int]]&gt;'''|TypeAdv26=true| Integer field counting loaded Audio assets.
|TotalFonts|SyncRef`1|TypeString27=SyncRef<IField<int>>| Integer field counting total Font assets to be loaded.
|TotalAudioClips|'''[[Type:IField`1|IField`1]]&lt;[[Type:Int|Int]]&gt;'''|TypeAdv27=true| Integer field counting total Audio assets to be loaded.
|BytesDownloaded|SyncRef`1|TypeString28=SyncRef<IField<long>>| Long field counting total bytes downloaded so far.
|LoadedShaders|'''[[Type:IField`1|IField`1]]&lt;[[Type:Int|Int]]&gt;'''|TypeAdv28=true| Integer field counting loaded Shader assets.
|TotalBytes|SyncRef`1|TypeString29=SyncRef<IField<long>>| Long field count of total bytes expected to be downloaded.
|TotalShaders|'''[[Type:IField`1|IField`1]]&lt;[[Type:Int|Int]]&gt;'''|TypeAdv29=true| Integer field counting total Shader assets to be loaded.
|BytesPerSecond|SyncRef`1|TypeString30=SyncRef<IField<long>>| Long field indicating current Bytes-per-Second download rate.
|LoadedFonts|'''[[Type:IField`1|IField`1]]&lt;[[Type:Int|Int]]&gt;'''|TypeAdv30=true| Integer field counting loaded Font assets.
|ProgressBar|SyncRef`1|TypeString31=SyncRef<ProgressBarInterface>| Reference to a [[ProgressBarInterface]] component.
|TotalFonts|'''[[Type:IField`1|IField`1]]&lt;[[Type:Int|Int]]&gt;'''|TypeAdv31=true| Integer field counting total Font assets to be loaded.
|BytesDownloaded|'''[[Type:IField`1|IField`1]]&lt;[[Type:Long|Long]]&gt;'''|TypeAdv32=true| Long field counting total bytes downloaded so far.
|TotalBytes|'''[[Type:IField`1|IField`1]]&lt;[[Type:Long|Long]]&gt;'''|TypeAdv33=true| Long field count of total bytes expected to be downloaded.
|BytesPerSecond|'''[[Type:IField`1|IField`1]]&lt;[[Type:Long|Long]]&gt;'''|TypeAdv34=true| Long field indicating current Bytes-per-Second download rate.
|ProgressBar|'''[[Component:ProgressBarInterface|ProgressBarInterface]]'''|TypeAdv35=true| Reference to a [[Component:ProgressBarInterface]] component to use as the progress Bae visual.
}}
}}


<!--T:3-->
<!--T:3-->
== Usage ==
== Usage ==
Use either the existing Resonite world loading bar under [[Resonite Essentials]] or make a UI by attaching the component and making one from scratch. Then save the item with this component to the inventory and [[Favorites|favorite]] it so it becomes the default world load indicator upon restarting.


<!--T:4-->
<!--T:4-->
== Examples ==
== Examples ==
The default Resonite world loading bar that is part of the user's default [[Favorites]]


<!--T:5-->
<!--T:5-->
== Related Components ==
== See Also ==
 
{{Template:EntityInterface SeeAlso}}
* [[ProgressBarInterface]] is used for progress indicators on asset importing.
</translate>
</translate>
[[Category:ComponentStubs]]
[[Category:Components:Utility:Entity Interfaces{{#translation:}}|World Loading Progress Interface]]
[[Category:Components{{#translation:}}|World Loading Progress Interface]]
[[Category:Components{{#translation:}}|World Loading Progress Interface]]
[[Category:Components:Utility{{#translation:}}|World Loading Progress Interface]]

Latest revision as of 22:18, 6 February 2025


This article or section is a Stub. You can help the Resonite Wiki by expanding it.

Component image 
World Loading Progress Interface component as seen in the Scene Inspector

The WorldLoadingProgressInterface component is the key component in the creation of a user-definable world loading progress bar. See Favorites for favoritable items like this one.

Fields

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. Some components stop their functionality when this field is disabled, but some don't.
ItemName IField`1<String> The name of this favoritable item.
SpawningUser UserRef The user that spawned this favoritable item.
SpawningUserID IField`1<String> The field containing the ID of the user that spawned this favoritable item.
IsInstance Bool Whether this item is an instance.
Progress IField`1<Float> Float field where 0.0 - 1.0 progress will be written.
WorldName IField`1<String> String field where the loading world's name will be written.
Stage IField`1<ProgressStage> The field to write with the current progress stage of the currently loading world. This is written by the world loading main process.
PhaseName IField`1<String> String field where the current loading phase name will be written.
SubPhaseName IField`1<String> String field where the current loading sub-phase name will be written.
HasCompleted IField`1<Bool> Boolean field that will be set to true on loading completion.
HasFailed IField`1<Bool> Boolean field that will be set to true on loading failure.
CompletionMessage IField`1<String> String field where message indicating completion will be written.
FailureReason IField`1<String> String field where message indicating reason for loading failure will be written.
LoadingAssets IField`1<Bool> Boolean field that is set true while loading assets.
LoadedAssets IField`1<Int> Integer field counting loaded assets.
TotalAssets IField`1<Int> Integer field counting total assets to be loaded.
LoadedTextures2D IField`1<Int> Integer field counting loaded ITexture2D assets.
TotalTextures2D IField`1<Int> Integer field counting total ITexture2D assets to be loaded.
LoadedTextures3D IField`1<Int> Integer field counting loaded ITexture3D assets.
TotalTextures3D IField`1<Int> Integer field counting total ITexture3D assets to be loaded.
LoadedCubemaps IField`1<Int> Integer field counting loaded Cubemap assets.
TotalCubemaps IField`1<Int> Integer field counting total Cubemap assets to be loaded.
LoadedVideos IField`1<Int> Integer field counting loaded Video assets.
TotalVideos IField`1<Int> Integer field counting total Video assets to be loaded.
LoadedMeshes IField`1<Int> Integer field counting loaded Mesh assets.
TotalMeshes IField`1<Int> Integer field counting total Mesh assets to be loaded.
LoadedAudioClips IField`1<Int> Integer field counting loaded Audio assets.
TotalAudioClips IField`1<Int> Integer field counting total Audio assets to be loaded.
LoadedShaders IField`1<Int> Integer field counting loaded Shader assets.
TotalShaders IField`1<Int> Integer field counting total Shader assets to be loaded.
LoadedFonts IField`1<Int> Integer field counting loaded Font assets.
TotalFonts IField`1<Int> Integer field counting total Font assets to be loaded.
BytesDownloaded IField`1<Long> Long field counting total bytes downloaded so far.
TotalBytes IField`1<Long> Long field count of total bytes expected to be downloaded.
BytesPerSecond IField`1<Long> Long field indicating current Bytes-per-Second download rate.
ProgressBar ProgressBarInterface Reference to a Component:ProgressBarInterface component to use as the progress Bae visual.

Usage

Use either the existing Resonite world loading bar under Resonite Essentials or make a UI by attaching the component and making one from scratch. Then save the item with this component to the inventory and favorite it so it becomes the default world load indicator upon restarting.

Examples

The default Resonite world loading bar that is part of the user's default Favorites

See Also

Retrieved from "https://wiki.resonite.com/index.php?title=Component:WorldLoadingProgressInterface&oldid=95856"