Component:RecordSyncStatus: Difference between revisions

From Resonite Wiki
imported>Mysticporo
Created page with "<languages></languages> <translate> <!--T:1--> {{stub}} {{Infobox Component |Image=RecordSyncStatusComponent.png |Name=Record Sync Status }} <!--T:2--> == Fields == {{Table C..."
 
add info
 
(2 intermediate revisions by 2 users not shown)
Line 2: Line 2:
<translate>
<translate>
<!--T:1-->
<!--T:1-->
{{stub}}
{{Infobox Component
{{Infobox Component
|Image=RecordSyncStatusComponent.png
|Image=RecordSyncStatusComponent.png
|Name=Record Sync Status
|Name=Record Sync Status
}}
}}
The '''RecordSyncStatus''' component reports the current status of syncing items like worlds, avatars, settings, and user generated content when present in the user space world where the dash is.


<!--T:2-->
<!--T:2-->
== Fields ==
== Fields ==
{{Table ComponentFields
{{Table ComponentFields
|RecordQueueCount|Int|
|RecordQueueCount|{{RootFieldType|RawOutput`1|[[Type:Int|Int]]}}|TypeAdv0=true| How many items are left in the queue of items to Sync from the user's machine to the cloud.
|AssetVariantQueueCount|Int|
|AssetVariantQueueCount|{{RootFieldType|RawOutput`1|[[Type:Int|Int]]}}|TypeAdv1=true| How many asset variants are left to upload for the items being uploaded to the cloud.
|CurrentTaskProgress|Float|
|CurrentTaskProgress|{{RootFieldType|RawOutput`1|[[Type:Float|Float]]}}|TypeAdv2=true| How far along the Asset uploader is to uploading the current item.
|LastError|String|
|LastError|{{RootFieldType|RawOutput`1|[[Type:String|String]]}}|TypeAdv3=true| The last error given by the cloud item uploader process.
|StatusMessage|String|
|StatusMessage|{{RootFieldType|RawOutput`1|[[Type:String|String]]}}|TypeAdv4=true| The status message for the item uploader process.
|FullySyncedColor|Color|
|FullySyncedColor|ColorX| The color the UI should be if it is fully done syncing.
|ErrorColor|Color|
|ErrorColor|ColorX| The color the UI should be if there was an error (UH OH!!! [[Stuck Sync]]!!!)
|SyncingRecordsColor|Color|
|SyncingRecordsColor|ColorX| The color the UI should be when the item uploader task is syncing Record items.
|UploadingAssetVariantsColor|Color|
|UploadingAssetVariantsColor|ColorX| The color the UI should be when the item uploader is uploading Asset variants for things like textures or skyboxes.
}}
}}


<!--T:3-->
<!--T:3-->
== Usage ==
== Usage ==
{{stub}}


<!--T:4-->
<!--T:4-->
== Examples ==
== Examples ==
Used in the user dash to show syncing status at the top.


<!--T:5-->
<!--T:5-->
== Related Components ==
== See Also ==
* [[Stuck Sync]]
</translate>
</translate>
[[Category:ComponentStubs]]
[[Category:Components{{#translation:}}|Record Sync Status]]
[[Category:Components{{#translation:}}|Record Sync Status]]
[[Category:Components:Cloud:Indicators{{#translation:}}|Record Sync Status]]
[[Category:Components:Cloud:Indicators{{#translation:}}|Record Sync Status]]

Latest revision as of 21:07, 31 January 2025

Component image 
Record Sync Status component as seen in the Scene Inspector

The RecordSyncStatus component reports the current status of syncing items like worlds, avatars, settings, and user generated content when present in the user space world where the dash is.

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.
RecordQueueCount raw output of Int How many items are left in the queue of items to Sync from the user's machine to the cloud.
AssetVariantQueueCount raw output of Int How many asset variants are left to upload for the items being uploaded to the cloud.
CurrentTaskProgress raw output of Float How far along the Asset uploader is to uploading the current item.
LastError raw output of String The last error given by the cloud item uploader process.
StatusMessage raw output of String The status message for the item uploader process.
FullySyncedColor ColorX The color the UI should be if it is fully done syncing.
ErrorColor ColorX The color the UI should be if there was an error (UH OH!!! Stuck Sync!!!)
SyncingRecordsColor ColorX The color the UI should be when the item uploader task is syncing Record items.
UploadingAssetVariantsColor ColorX The color the UI should be when the item uploader is uploading Asset variants for things like textures or skyboxes.

Usage

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

Examples

Used in the user dash to show syncing status at the top.

See Also