Component:AccountMigrationsList: Difference between revisions

From Resonite Wiki
Automated: create new component page
 
add info based on decompile.
 
Line 3: Line 3:
|Name=Account Migrations List
|Name=Account Migrations List
}}
}}
{{stub}}
Account Migrations List is a component that only works in user space. It checks the current Migrations being ran by the cloud and gives a running count every game update. It shows how many there are total including counts of different statuses the different migrations have.


== Usage ==
== Usage ==
{{Table ComponentFields
{{Table ComponentFields
|TotalMigrations|Int|
|TotalMigrations|Int| How many total migrations are currently happening on the cloud right now for the current user.
|WaitingMigrations|Int|
|WaitingMigrations|Int| How many migrations are currently waiting to start on the cloud right now for the current user.
|RunningMigrations|Int|
|RunningMigrations|Int| How many migrations are currently happening on the cloud right now for the current user.
|CompletedMigrations|Int|
|CompletedMigrations|Int| How many completed migrations have happened on the cloud before for the current user.
|MigrationTaskIds|{{RootFieldType|SyncFieldList`1|[[Type:String|String]]}}|TypeAdv4=true|
|MigrationTaskIds|{{RootFieldType|SyncFieldList`1|[[Type:String|String]]}}|TypeAdv4=true| The task ID's of all the migrations for the current user.
}}
}}


== Behavior ==
== Behavior ==
Only works in user space. Updates with migrations automatically.


== Examples ==
== Examples ==
Possibly used in the migrations tab to show the user what migrations they have done or are doing (CONFIRM?)


== See Also ==
== See Also ==
Line 22: Line 24:
[[Category:Components:Cloud:Indicators{{#translation:}}|Account Migrations List]]
[[Category:Components:Cloud:Indicators{{#translation:}}|Account Migrations List]]
[[Category:Components{{#translation:}}|Account Migrations List]]
[[Category:Components{{#translation:}}|Account Migrations List]]
[[Category:ComponentStubs]]

Latest revision as of 15:46, 13 October 2024

Component image 
Account Migrations List component as seen in the Scene Inspector

Account Migrations List is a component that only works in user space. It checks the current Migrations being ran by the cloud and gives a running count every game update. It shows how many there are total including counts of different statuses the different migrations have.

Usage

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.
TotalMigrations Int How many total migrations are currently happening on the cloud right now for the current user.
WaitingMigrations Int How many migrations are currently waiting to start on the cloud right now for the current user.
RunningMigrations Int How many migrations are currently happening on the cloud right now for the current user.
CompletedMigrations Int How many completed migrations have happened on the cloud before for the current user.
MigrationTaskIds direct SyncFieldList`1<String> The task ID's of all the migrations for the current user.

Behavior

Only works in user space. Updates with migrations automatically.

Examples

Possibly used in the migrations tab to show the user what migrations they have done or are doing (CONFIRM?)

See Also