Component:GrabValueSet: Difference between revisions

From Resonite Wiki
Automated: create new component page
 
add info
 
Line 3: Line 3:
|Name=Grab Value Set`1
|Name=Grab Value Set`1
}}
}}
{{stub}}
The '''GrabValueSet''' component has options to set the value within a value field upon release and/or grabbing of a grabbable Component on the same slot.


== Usage ==
== Fields ==
{{Table ComponentFields
{{Table ComponentFields
|Target|'''[[Type:IField`1|IField`1]]<T>'''|TypeAdv0=true|
|Target|'''[[Type:IField`1|IField`1]]<T>'''|TypeAdv0=true| The field to set the contained value of during grabbing events.
|GrabbedValue|'''T'''|TypeAdv1=true|
|GrabbedValue|'''T'''|TypeAdv1=true| The value to set the contained data of the Field referenced in <code>Target</code> when the item is grabbed.
|ReleasedValue|'''T'''|TypeAdv2=true|
|ReleasedValue|'''T'''|TypeAdv2=true| The value to set the contained data of the Field referenced in <code>Target</code> when the item is let go of.
|SetOnGrabbed|Bool|
|SetOnGrabbed|Bool| Whether to set the contained value of the field referenced by <code>Target</code> on grabbed.
|SetOnReleased|Bool|
|SetOnReleased|Bool| Whether to set the contained value of the field referenced by <code>Target</code> on letting go.
}}
}}


== Behavior ==
== Usage ==
Can be used to change the color of an item on grab or release, or any other value type.


== Examples ==
== Examples ==
{{stub}}


== See Also ==
== See Also ==
* [[Component:GrabReferenceSet]]


[[Category:Components:Transform:Interaction{{#translation:}}|Grab Value Set`1]]
[[Category:Components:Transform:Interaction{{#translation:}}|Grab Value Set`1]]
[[Category:Components{{#translation:}}|Grab Value Set`1]]
[[Category:Components{{#translation:}}|Grab Value Set`1]]
[[Category:Generic Components{{#translation:}}|Grab Value Set`1]]
[[Category:Generic Components{{#translation:}}|Grab Value Set`1]]
[[Category:ComponentStubs]]

Latest revision as of 20:40, 19 January 2025

Component image 
Grab Value Set`1 component as seen in the Scene Inspector

The GrabValueSet component has options to set the value within a value field upon release and/or grabbing of a grabbable Component on the same slot.

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.
Target IField`1<T> The field to set the contained value of during grabbing events.
GrabbedValue T The value to set the contained data of the Field referenced in Target when the item is grabbed.
ReleasedValue T The value to set the contained data of the Field referenced in Target when the item is let go of.
SetOnGrabbed Bool Whether to set the contained value of the field referenced by Target on grabbed.
SetOnReleased Bool Whether to set the contained value of the field referenced by Target on letting go.

Usage

Can be used to change the color of an item on grab or release, or any other value type.

Examples

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

See Also