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..." |
Automated: update Fields, Categories |
||
Line 13: | Line 13: | ||
== Fields == | == Fields == | ||
{{Table ComponentFields | {{Table ComponentFields | ||
|Progress| | |ItemName|'''[[Type:IField`1|IField`1]]<[[Type:String|String]]>'''|TypeAdv0=true| | ||
|WorldName| | |SpawningUser|UserRef| | ||
|Stage| | |SpawningUserID|'''[[Type:IField`1|IField`1]]<[[Type:String|String]]>'''|TypeAdv2=true| | ||
|PhaseName| | |IsInstance|Bool| | ||
|SubPhaseName| | |Progress|'''[[Type:IField`1|IField`1]]<[[Type:Float|Float]]>'''|TypeAdv4=true| Float field where 0.0 - 1.0 progress will be written. | ||
|HasCompleted| | |WorldName|'''[[Type:IField`1|IField`1]]<[[Type:String|String]]>'''|TypeAdv5=true| String field where the loading world's name will be written. | ||
|HasFailed| | |Stage|'''[[Type:IField`1|IField`1]]<[[Type:ProgressStage|ProgressStage]]>'''|TypeAdv6=true| SyncRef ProgressStage Field ''(To-Do: Need info on ProgressStage fields and what provides them.)'' | ||
|CompletionMessage| | |PhaseName|'''[[Type:IField`1|IField`1]]<[[Type:String|String]]>'''|TypeAdv7=true| String field where the current loading phase name will be written. | ||
|FailureReason| | |SubPhaseName|'''[[Type:IField`1|IField`1]]<[[Type:String|String]]>'''|TypeAdv8=true| String field where the current loading sub-phase name will be written. | ||
|LoadingAssets| | |HasCompleted|'''[[Type:IField`1|IField`1]]<[[Type:Bool|Bool]]>'''|TypeAdv9=true| Boolean field that will be set to true on loading completion. | ||
|LoadedAssets| | |HasFailed|'''[[Type:IField`1|IField`1]]<[[Type:Bool|Bool]]>'''|TypeAdv10=true| Boolean field that will be set to true on loading failure. | ||
|TotalAssets| | |CompletionMessage|'''[[Type:IField`1|IField`1]]<[[Type:String|String]]>'''|TypeAdv11=true| String field where message indicating completion will be written. | ||
|LoadedTextures2D| | |FailureReason|'''[[Type:IField`1|IField`1]]<[[Type:String|String]]>'''|TypeAdv12=true| String field where message indicating reason for loading failure will be written. | ||
|TotalTextures2D| | |LoadingAssets|'''[[Type:IField`1|IField`1]]<[[Type:Bool|Bool]]>'''|TypeAdv13=true| Boolean field that is set true while loading assets. | ||
|LoadedTextures3D| | |LoadedAssets|'''[[Type:IField`1|IField`1]]<[[Type:Int|Int]]>'''|TypeAdv14=true| Integer field counting loaded assets. | ||
|TotalTextures3D| | |TotalAssets|'''[[Type:IField`1|IField`1]]<[[Type:Int|Int]]>'''|TypeAdv15=true| Integer field counting total assets to be loaded. | ||
|LoadedCubemaps| | |LoadedTextures2D|'''[[Type:IField`1|IField`1]]<[[Type:Int|Int]]>'''|TypeAdv16=true| Integer field counting loaded ITexture2D assets. | ||
|TotalCubemaps| | |TotalTextures2D|'''[[Type:IField`1|IField`1]]<[[Type:Int|Int]]>'''|TypeAdv17=true| Integer field counting total ITexture2D assets to be loaded. | ||
|LoadedVideos| | |LoadedTextures3D|'''[[Type:IField`1|IField`1]]<[[Type:Int|Int]]>'''|TypeAdv18=true| Integer field counting loaded ITexture3D assets. | ||
|TotalVideos| | |TotalTextures3D|'''[[Type:IField`1|IField`1]]<[[Type:Int|Int]]>'''|TypeAdv19=true| Integer field counting total ITexture3D assets to be loaded. | ||
|LoadedMeshes| | |LoadedCubemaps|'''[[Type:IField`1|IField`1]]<[[Type:Int|Int]]>'''|TypeAdv20=true| Integer field counting loaded Cubemap assets. | ||
|TotalMeshes| | |TotalCubemaps|'''[[Type:IField`1|IField`1]]<[[Type:Int|Int]]>'''|TypeAdv21=true| Integer field counting total Cubemap assets to be loaded. | ||
|LoadedAudioClips| | |LoadedVideos|'''[[Type:IField`1|IField`1]]<[[Type:Int|Int]]>'''|TypeAdv22=true| Integer field counting loaded Video assets. | ||
|TotalAudioClips| | |TotalVideos|'''[[Type:IField`1|IField`1]]<[[Type:Int|Int]]>'''|TypeAdv23=true| Integer field counting total Video assets to be loaded. | ||
|LoadedShaders| | |LoadedMeshes|'''[[Type:IField`1|IField`1]]<[[Type:Int|Int]]>'''|TypeAdv24=true| Integer field counting loaded Mesh assets. | ||
|TotalShaders| | |TotalMeshes|'''[[Type:IField`1|IField`1]]<[[Type:Int|Int]]>'''|TypeAdv25=true| Integer field counting total Mesh assets to be loaded. | ||
|LoadedFonts| | |LoadedAudioClips|'''[[Type:IField`1|IField`1]]<[[Type:Int|Int]]>'''|TypeAdv26=true| Integer field counting loaded Audio assets. | ||
|TotalFonts| | |TotalAudioClips|'''[[Type:IField`1|IField`1]]<[[Type:Int|Int]]>'''|TypeAdv27=true| Integer field counting total Audio assets to be loaded. | ||
|BytesDownloaded| | |LoadedShaders|'''[[Type:IField`1|IField`1]]<[[Type:Int|Int]]>'''|TypeAdv28=true| Integer field counting loaded Shader assets. | ||
|TotalBytes| | |TotalShaders|'''[[Type:IField`1|IField`1]]<[[Type:Int|Int]]>'''|TypeAdv29=true| Integer field counting total Shader assets to be loaded. | ||
|BytesPerSecond| | |LoadedFonts|'''[[Type:IField`1|IField`1]]<[[Type:Int|Int]]>'''|TypeAdv30=true| Integer field counting loaded Font assets. | ||
|ProgressBar| | |TotalFonts|'''[[Type:IField`1|IField`1]]<[[Type:Int|Int]]>'''|TypeAdv31=true| Integer field counting total Font assets to be loaded. | ||
|BytesDownloaded|'''[[Type:IField`1|IField`1]]<[[Type:Long|Long]]>'''|TypeAdv32=true| Long field counting total bytes downloaded so far. | |||
|TotalBytes|'''[[Type:IField`1|IField`1]]<[[Type:Long|Long]]>'''|TypeAdv33=true| Long field count of total bytes expected to be downloaded. | |||
|BytesPerSecond|'''[[Type:IField`1|IField`1]]<[[Type:Long|Long]]>'''|TypeAdv34=true| Long field indicating current Bytes-per-Second download rate. | |||
|ProgressBar|'''[[Component:ProgressBarInterface|ProgressBarInterface]]'''|TypeAdv35=true| Reference to a [[ProgressBarInterface]] component. | |||
}} | }} | ||
Line 59: | Line 63: | ||
</translate> | </translate> | ||
[[Category:ComponentStubs]] | [[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]] | ||
Latest revision as of 22:54, 3 March 2024
This article or section is a Stub. You can help the Resonite Wiki by expanding it.
Component image
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.
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. |
ItemName
|
IField`1<String> | |
SpawningUser
|
UserRef | |
SpawningUserID
|
IField`1<String> | |
IsInstance
|
Bool | |
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> | SyncRef ProgressStage Field (To-Do: Need info on ProgressStage fields and what provides them.) |
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 ProgressBarInterface component. |
Usage
Examples
Related Components
- ProgressBarInterface is used for progress indicators on asset importing.