imported>Art0007i add small note about unnetworked valuecopy |
Add component visual box. Explain, no longer stub |
||
| (3 intermediate revisions by 3 users not shown) | |||
| Line 2: | Line 2: | ||
<translate> | <translate> | ||
<!--T:1--> | <!--T:1--> | ||
{{Infobox Component | {{Infobox Component | ||
|Image=ValueCopy`1Component.png | |Image=ValueCopy`1Component.png | ||
|Name=Value Copy | |Name=Value Copy | ||
}} | }} | ||
The '''ValueCopy''' component is used to copy one value to another place, driving the target with an write back option. | |||
<!--T:2--> | <!--T:2--> | ||
== Fields == | == Fields == | ||
{{Table ComponentFields | {{Table ComponentFields | ||
|Source|IField`1| | |Source|{{RootFieldType|RelayRef`1|[[Type:IField`1|IField`1]]<T>}}|TypeAdv0=true| The source to copy the value from. | ||
|Target| | |Target|{{RootFieldType|FieldDrive`1|T}}|TypeAdv1=true| The target to copy the value to. | ||
|WriteBack|Bool| Allow Target to write back to Source. | |WriteBack|Bool| Allow Target to write back to Source. | ||
}} | }} | ||
| Line 32: | Line 33: | ||
<!--T:5--> | <!--T:5--> | ||
== | == See Also == | ||
</translate> | </translate> | ||
[[Category:Generics{{#translation:}}]] | [[Category:Generics{{#translation:}}]] | ||
[[Category:Components{{#translation:}}|Value Copy`1]] | [[Category:Components{{#translation:}}|Value Copy`1]] | ||
[[Category:Generic Components{{#translation:}}|Value Copy`1]] | |||
[[Category:Components:Transform:Drivers{{#translation:}}|Value Copy`1]] | [[Category:Components:Transform:Drivers{{#translation:}}|Value Copy`1]] | ||
Latest revision as of 03:09, 12 November 2024
The ValueCopy component is used to copy one value to another place, driving the target with an write back option.
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. |
Source
|
direct RelayRef`1<IField`1<T>> | The source to copy the value from. |
Target
|
field drive of T | The target to copy the value to. |
WriteBack
|
Bool | Allow Target to write back to Source. |
Usage
Drives the target's value with the source's value. When using WriteBack, changes made to the Target are local while editing it. When the user is done setting it, it writes via a network sync to change the Source value. If the Source and Target are the same, the value will be completely local, and no network sync happens when changing the value. When using the ValueCopy to make fields local like this, joining users will have the host's value by default.
Examples
A ValueField<bool>'s Value is being self driven with a WriteBack - making the Value local, and still changeable. Changes to this value will be local.
A ValueField<int>'s Value is being driven to be 7 from another ValueField<int>'s Value. The one in pink is the one being driven.
The Target field is being edited to 4, to write back to the Source field.