Component:LocalVariableSync: Difference between revisions

From Resonite Wiki
Automated: create new component page
 
add info
 
(One intermediate revision by one other user not shown)
Line 1: Line 1:
{{UserspaceComponent}}
{{Infobox Component
{{Infobox Component
|Image=LocalVariableSync`1Component.png
|Image=LocalVariableSync`1Component.png
|Name=Local Variable Sync`1
|Name=Local Variable Sync`1
}}
}}
{{stub}}
The '''LocalVariableSync''' component is used to store a value to the local dB for the user space and load it up again.


== Usage ==
== Fields ==
{{Table ComponentFields
{{Table ComponentFields
|OwnerUser|{{RootFieldType|UserRef}}|TypeAdv0=true|
|OwnerUser|{{RootFieldType|UserRef}}|TypeAdv0=true| The user that this variable is associated with in the world.
|Value|{{RootFieldType|RelayRef`1|[[Type:IField`1|IField`1]]<T>}}|TypeAdv1=true|
|Value|{{RootFieldType|RelayRef`1|[[Type:IField`1|IField`1]]<T>}}|TypeAdv1=true| The value to Sync with the local DB variable.
|Variable|String|
|Variable|String| The name of the local DB variable.
}}
}}


== Behavior ==
== Usage ==
{{stub}}


== Examples ==
== Examples ==
Line 21: Line 23:
[[Category:Components{{#translation:}}|Local Variable Sync`1]]
[[Category:Components{{#translation:}}|Local Variable Sync`1]]
[[Category:Generic Components{{#translation:}}|Local Variable Sync`1]]
[[Category:Generic Components{{#translation:}}|Local Variable Sync`1]]
[[Category:ComponentStubs]]

Latest revision as of 16:37, 18 June 2025

This is a userspace component — you cannot attach it anywhere but the userspace. Messing with the userspace can be fun, but it is not recommended as you risk messing your dash up if you don't know what you're doing.
Component image 
File:LocalVariableSync`1Component.png
Local Variable Sync`1 component as seen in the Scene Inspector

The LocalVariableSync component is used to store a value to the local dB for the user space and load it up again.

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.
OwnerUser direct UserRef The user that this variable is associated with in the world.
Value direct RelayRef`1<IField`1<T>> The value to Sync with the local DB variable.
Variable String The name of the local DB variable.

Usage

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

Examples

See Also