Component:ProgressBarInterface: Difference between revisions

From Resonite Wiki
← Older edit
VisualWikitext
add template
add info
 
Line 3: Line 3:
|Name=Progress Bar Interface
|Name=Progress Bar Interface
}}
}}
{{stub}}
The '''ProgressBarInterface''' component is a [[Favorites|favoritable]] item that appears when the user imports a file into Resonite.


== Fields ==
== Fields ==
{{Table ComponentFields
{{Table ComponentFields
|ItemName|'''[[Type:IField`1|IField`1]]<[[Type:String|String]]>'''|TypeAdv0=true|
|ItemName|'''[[Type:IField`1|IField`1]]<[[Type:String|String]]>'''|TypeAdv0=true| The name of this favoritable interface.
|SpawningUser|UserRef|
|SpawningUser|UserRef| The user that spawned this favoritable interface.
|SpawningUserID|'''[[Type:IField`1|IField`1]]<[[Type:String|String]]>'''|TypeAdv2=true|
|SpawningUserID|'''[[Type:IField`1|IField`1]]<[[Type:String|String]]>'''|TypeAdv2=true| The field containing the ID of the user that spawned this favoritable interface.
|IsInstance|Bool|
|IsInstance|Bool| Whether this interface is an instance.
|ProgressKnown|'''[[Type:IField`1|IField`1]]<[[Type:Bool|Bool]]>'''|TypeAdv4=true|
|ProgressKnown|'''[[Type:IField`1|IField`1]]<[[Type:Bool|Bool]]>'''|TypeAdv4=true| The field to drive with whether or not the progress is known of the importing item.
|Progress|'''[[Type:IField`1|IField`1]]<[[Type:Float|Float]]>'''|TypeAdv5=true|
|Progress|'''[[Type:IField`1|IField`1]]<[[Type:Float|Float]]>'''|TypeAdv5=true| The field to drive with the current progress import percentage from 0 to 1 of the importing item.
|ProcessedCountKnown|'''[[Type:IField`1|IField`1]]<[[Type:Bool|Bool]]>'''|TypeAdv6=true|
|ProcessedCountKnown|'''[[Type:IField`1|IField`1]]<[[Type:Bool|Bool]]>'''|TypeAdv6=true| The field to drive with whether or not the amount of processed items is known for the importing item.
|ProcessedItemCount|'''[[Type:IField`1|IField`1]]<[[Type:Int|Int]]>'''|TypeAdv7=true|
|ProcessedItemCount|'''[[Type:IField`1|IField`1]]<[[Type:Int|Int]]>'''|TypeAdv7=true| The field to drive with the number of processed items for the importing item.
|TotalItemCountKnown|'''[[Type:IField`1|IField`1]]<[[Type:Bool|Bool]]>'''|TypeAdv8=true|
|TotalItemCountKnown|'''[[Type:IField`1|IField`1]]<[[Type:Bool|Bool]]>'''|TypeAdv8=true| The field to drive with whether the total number of items that need to be processed for the importing item is known.
|TotalItemCount|'''[[Type:IField`1|IField`1]]<[[Type:Int|Int]]>'''|TypeAdv9=true|
|TotalItemCount|'''[[Type:IField`1|IField`1]]<[[Type:Int|Int]]>'''|TypeAdv9=true| The field to drive with the total number of items that need to be processed for the importing item.
|PhaseName|'''[[Type:IField`1|IField`1]]<[[Type:String|String]]>'''|TypeAdv10=true|
|PhaseName|'''[[Type:IField`1|IField`1]]<[[Type:String|String]]>'''|TypeAdv10=true| The field to drive with the current phase name of the importing item being imported is.
|SubPhaseName|'''[[Type:IField`1|IField`1]]<[[Type:String|String]]>'''|TypeAdv11=true|
|SubPhaseName|'''[[Type:IField`1|IField`1]]<[[Type:String|String]]>'''|TypeAdv11=true| The field to drive with the current sub phase name of the item being imported.
|Stage|'''[[Type:IField`1|IField`1]]<[[Type:ProgressStage|ProgressStage]]>'''|TypeAdv12=true|
|Stage|'''[[Type:IField`1|IField`1]]<[[Type:ProgressStage|ProgressStage]]>'''|TypeAdv12=true| The field to drive with the progress stage for the importing item.
|HasCompleted|'''[[Type:IField`1|IField`1]]<[[Type:Bool|Bool]]>'''|TypeAdv13=true|
|HasCompleted|'''[[Type:IField`1|IField`1]]<[[Type:Bool|Bool]]>'''|TypeAdv13=true| The field to drive with whether the item has finished importing.
|HasFailed|'''[[Type:IField`1|IField`1]]<[[Type:Bool|Bool]]>'''|TypeAdv14=true|
|HasFailed|'''[[Type:IField`1|IField`1]]<[[Type:Bool|Bool]]>'''|TypeAdv14=true| The field to drive with whether the item has failed to import.
|CompletionMessage|'''[[Type:IField`1|IField`1]]<[[Type:String|String]]>'''|TypeAdv15=true|
|CompletionMessage|'''[[Type:IField`1|IField`1]]<[[Type:String|String]]>'''|TypeAdv15=true| The field to drive with the message for when the item has finished importing.
|FailureReason|'''[[Type:IField`1|IField`1]]<[[Type:String|String]]>'''|TypeAdv16=true|
|FailureReason|'''[[Type:IField`1|IField`1]]<[[Type:String|String]]>'''|TypeAdv16=true| The field to drive with the failure reason for something to import.
|CanBeHidden|'''[[Type:IField`1|IField`1]]<[[Type:Bool|Bool]]>'''|TypeAdv17=true|
|CanBeHidden|'''[[Type:IField`1|IField`1]]<[[Type:Bool|Bool]]>'''|TypeAdv17=true| The field to drive with whether this import dialogue can be hidden by the user.
}}
}}


== Usage ==
== Usage ==
Used to make custom import dialogue visuals for a user by saving a custom UI with this component to inventory and setting as custom loading indicator.


== Examples ==
== Examples ==
The default loading indicator visual in the resonite essentials example UI.


== See Also ==
== See Also ==
Line 36: Line 38:
[[Category:Components:Utility:Entity Interfaces{{#translation:}}|Progress Bar Interface]]
[[Category:Components:Utility:Entity Interfaces{{#translation:}}|Progress Bar Interface]]
[[Category:Components{{#translation:}}|Progress Bar Interface]]
[[Category:Components{{#translation:}}|Progress Bar Interface]]
[[Category:ComponentStubs]]

Latest revision as of 18:49, 31 January 2025

Component image 
Progress Bar Interface component as seen in the Scene Inspector

The ProgressBarInterface component is a favoritable item that appears when the user imports a file into Resonite.

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 interface.
SpawningUser UserRef The user that spawned this favoritable interface.
SpawningUserID IField`1<String> The field containing the ID of the user that spawned this favoritable interface.
IsInstance Bool Whether this interface is an instance.
ProgressKnown IField`1<Bool> The field to drive with whether or not the progress is known of the importing item.
Progress IField`1<Float> The field to drive with the current progress import percentage from 0 to 1 of the importing item.
ProcessedCountKnown IField`1<Bool> The field to drive with whether or not the amount of processed items is known for the importing item.
ProcessedItemCount IField`1<Int> The field to drive with the number of processed items for the importing item.
TotalItemCountKnown IField`1<Bool> The field to drive with whether the total number of items that need to be processed for the importing item is known.
TotalItemCount IField`1<Int> The field to drive with the total number of items that need to be processed for the importing item.
PhaseName IField`1<String> The field to drive with the current phase name of the importing item being imported is.
SubPhaseName IField`1<String> The field to drive with the current sub phase name of the item being imported.
Stage IField`1<ProgressStage> The field to drive with the progress stage for the importing item.
HasCompleted IField`1<Bool> The field to drive with whether the item has finished importing.
HasFailed IField`1<Bool> The field to drive with whether the item has failed to import.
CompletionMessage IField`1<String> The field to drive with the message for when the item has finished importing.
FailureReason IField`1<String> The field to drive with the failure reason for something to import.
CanBeHidden IField`1<Bool> The field to drive with whether this import dialogue can be hidden by the user.

Usage

Used to make custom import dialogue visuals for a user by saving a custom UI with this component to inventory and setting as custom loading indicator.

Examples

The default loading indicator visual in the resonite essentials example UI.

See Also

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