{{Note|This component works in [[Userspace]] only, so a lot of it's features and potential is locked behind this. This is only used for saving the dash at the moment. It is planned for this to become non userspace in the future|information}}
Workspace is a component that allows for doing work inside of a containerized slot, where the user can add or remove items which gets saved every interval specified. These workspaces can be public or private, and work similarly in concept to [[Cloud Variables]] except greatly simplified and store an entire hierarchy instead of a single value. Workspaces have a path to them, which allow for having multiple different workspaces per user. Workspaces take up storage as a saved item would, and automatically synchronize in real time. Multiple users working on workspaces at the same time can cause issues however, since workspaces save their changes before loading from the cloud unless <code>ReadOnly</code> is enabled.
== Usage ==
== Usage ==
{{Table ComponentFields
{{Table ComponentFields
|User|{{RootFieldType|UserRef}}|TypeAdv0=true|
|User|{{RootFieldType|UserRef}}|TypeAdv0=true| The user to manage reading and writing the contents of this workspace to the cloud for.
|OverrideOwnerId|String|
|OverrideOwnerId|String| The override for the owner of this workspace to read and write the data for, which allows for reading public workspaces from others.
|WorkspacePath|String|
|WorkspacePath|String| The path of the workspace on the Cloud. Adding "public/" (case ignored) to the start of the path allows for public workspaces anyone can edit. Public workspaces must exist first before another user than the owner can save to them.
|InitializeWorkspace|{{RootFieldType|SyncDelegate`1|[[Type:Action`1|Action`1]]<[[Type:Slot|Slot]]>}}|TypeAdv3=true| A [[Sync Delegate]] to call that takes a slot for when this component generates the work space. the slot is the slot this component is on.
|ReadOnly|Bool|
|ReadOnly|Bool| Whether to only read the contents of this workspace from the cloud and not save it.
|AutosaveDelay|Float|
|AutosaveDelay|Float| How long to wait between save attempts before trying to save again. saves only happen if there have been changes.
|SuspendUpdates|Bool|
|SuspendUpdates|Bool| Whether to pause the loading and saving of this workspace to the cloud.
|_unsavedChanges|Bool|
|_unsavedChanges|Bool| Whether this workspace has changes that should be saved to the cloud upon the next save.
|_lastModification|{{RootFieldType|SyncTime}}|TypeAdv8=true| The last time the workspace was changed.
}}
}}
Line 21:
Line 23:
== Examples ==
== Examples ==
* This can be useful for users who want to work on the same thing, at different times.
* This can also be useful for keeping an object syncronized across multiple areas in a game, since it will load the same object into multiple different locations automatically.
This article or section is a Stub. You can help the Resonite Wiki by expanding it.
This component works in Userspace only, so a lot of it's features and potential is locked behind this. This is only used for saving the dash at the moment. It is planned for this to become non userspace in the future
Workspace is a component that allows for doing work inside of a containerized slot, where the user can add or remove items which gets saved every interval specified. These workspaces can be public or private, and work similarly in concept to Cloud Variables except greatly simplified and store an entire hierarchy instead of a single value. Workspaces have a path to them, which allow for having multiple different workspaces per user. Workspaces take up storage as a saved item would, and automatically synchronize in real time. Multiple users working on workspaces at the same time can cause issues however, since workspaces save their changes before loading from the cloud unless ReadOnly is enabled.
The path of the workspace on the Cloud. Adding "public/" (case ignored) to the start of the path allows for public workspaces anyone can edit. Public workspaces must exist first before another user than the owner can save to them.
This can be useful for users who want to work on the same thing, at different times.
This can also be useful for keeping an object syncronized across multiple areas in a game, since it will load the same object into multiple different locations automatically.
