Component:UserRefToSyncRefAdapter: Difference between revisions

Latest revision as of 18:27, 17 February 2025

Component image

The UserRefToSyncRefAdapter component takes a UserRef type and drives a user ref field with what it has inside of it.

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.
`User`	direct UserRef	The ref to get a user from.
`TargetReference`	direct RefDrive`1<User>	The field to drive with what user `User` refers to.
`WriteBack`	Bool	Whether changes to the field `TargetReference` will update the value of `User`. See write backs.

Attach to a slot and provide values for all fields in order for this component to work.

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

@@ Line 3: / Line 3: @@
 |Name=User Ref To Sync Ref Adapter
 }}
-{{stub}}
+The '''UserRefToSyncRefAdapter''' component takes a UserRef type and drives a user ref field with what it has inside of it.
-== Usage ==
+== Fields ==
 {{Table ComponentFields
-|User|{{RootFieldType|UserRef}}|TypeAdv0=true|
+|User|{{RootFieldType|UserRef}}|TypeAdv0=true| The ref to get a user from.
-|TargetReference|{{RootFieldType|RefDrive`1|[[Type:User|User]]}}|TypeAdv1=true|
+|TargetReference|{{RootFieldType|RefDrive`1|[[Type:User|User]]}}|TypeAdv1=true| The field to drive with what user <code>User</code> refers to.
-|WriteBack|Bool|
+|WriteBack|Bool| Whether changes to the field <code>TargetReference</code> will update the value of <code>User</code>. See [[Drives#Write Backs|write backs]].
 }}
-== Behavior ==
+== Usage ==
+Attach to a slot and provide values for all fields in order for this component to work.
 == Examples ==
+{{stub}}
 == See Also ==
@@ Line 20: / Line 22: @@
 [[Category:Components:Transform:Drivers{{#translation:}}|User Ref To Sync Ref Adapter]]
 [[Category:Components{{#translation:}}|User Ref To Sync Ref Adapter]]
-[[Category:ComponentStubs]]