Component:SettingSync: Difference between revisions

From Resonite Wiki
Automated: create new component page
 
add info
 
Line 3: Line 3:
|Name=Setting Sync`1
|Name=Setting Sync`1
}}
}}
{{stub}}
Is an alternative version of [[Component:SettingValueSync`2|SettingValueSync`2]].


== Usage ==
== Fields ==
{{Table ComponentFields
{{Table ComponentFields
|SyncingUser|User|
|SyncingUser|User| The user to get the setting from.
|SettingPath|String|
|SettingPath|String| The setting or setting group to get a value for. This is a path separated by ".".
|LocalChangeAction|LocalChange|
|LocalChangeAction|LocalChange| How to handle changes to the value of <code>TargetField</code> and whether to update the setting value for the local value or not if they trigger it to change in the world.
|TargetField|{{RootFieldType|RelayRef`1|[[Type:IField`1|IField`1]]&lt;T&gt;}}|TypeAdv3=true|
|TargetField|{{RootFieldType|RelayRef`1|[[Type:IField`1|IField`1]]&lt;T&gt;}}|TypeAdv3=true| The field to put the setting value into, can also write back to the setting if the world is unsafe or the setting allows for the world to write it and <code>LocalChangeAction</code> is set for it.
}}
}}


== Behavior ==
== Usage ==


== Examples ==
== Examples ==
Line 22: Line 22:
[[Category:Components{{#translation:}}|Setting Sync`1]]
[[Category:Components{{#translation:}}|Setting Sync`1]]
[[Category:Generic Components{{#translation:}}|Setting Sync`1]]
[[Category:Generic Components{{#translation:}}|Setting Sync`1]]
[[Category:ComponentStubs]]

Latest revision as of 23:23, 2 August 2025

Component image 
File:SettingSync`1Component.png
Setting Sync`1 component as seen in the Scene Inspector

Is an alternative version of SettingValueSync`2.

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.
SyncingUser User The user to get the setting from.
SettingPath String The setting or setting group to get a value for. This is a path separated by ".".
LocalChangeAction LocalChange How to handle changes to the value of TargetField and whether to update the setting value for the local value or not if they trigger it to change in the world.
TargetField direct RelayRef`1<IField`1<T>> The field to put the setting value into, can also write back to the setting if the world is unsafe or the setting allows for the world to write it and LocalChangeAction is set for it.

Usage

Examples

See Also