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
| 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
- Favorites
- Component:WorldLoadingProgressInterface
- Component:AudioPlayerInterface
- Component:AudioStreamInterface
- Component:VideoPlayerInterface
- Component:ProgressBarInterface
- Component:NamePlateInterface
- Component:ColorDialogInterface
- Component:NoticeDisplayInterface
- Component:TextDisplayInterface
- Component:HyperlinkDisplayInterface
- Component:DocumentInterface