Component:TransferGrabbable: Difference between revisions

From Resonite Wiki
Add some precursor knowledge
add info
 
Line 3: Line 3:
|Name=Transfer Grabbable
|Name=Transfer Grabbable
}}
}}
{{stub}}
Transfer Grabbable is a component that is used to mark objects that undergo [[Transcient Grabbing]], but only while in [[Userspace]]. The grabber during this process saves the object into memory including materials, then simulates a paste as it puts the object into the target world.
Transfer Grabbable is a component that is used to mark objects that undergo [[Transcient Grabbing]], but only while in [[Userspace]].
 
If the world does not allow transferring to it, the <code>_indicatorMaterial</code> material will replace materials on the object and light up red. Will restore the materials back if transferring is allowed to the target world.


== Usage ==
== Fields ==
{{Table ComponentFields
{{Table ComponentFields
|PasteOnGrab|Bool|
|PasteOnGrab|Bool| Whether to trigger a paste event in userspace when transfering the object to user space. does not affect when releasing.
|_indicatorMaterial|'''[[FresnelMaterial|FresnelMaterial]]'''|TypeAdv1=true|  
|_indicatorMaterial|'''[[Component:FresnelMaterial|FresnelMaterial]]'''|TypeAdv1=true| The indicator material to use when transfering to worlds.
}}
}}


== Behavior ==
== Usage ==
Not intended to be used directly


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


== See Also ==
== See Also ==
* [[Components:TranscientGrabbable]]


[[Category:Components:Uncategorized{{#translation:}}|Transfer Grabbable]]
[[Category:Components:Uncategorized{{#translation:}}|Transfer Grabbable]]
[[Category:Components{{#translation:}}|Transfer Grabbable]]
[[Category:Components{{#translation:}}|Transfer Grabbable]]
[[Category:ComponentStubs]]

Latest revision as of 01:46, 16 December 2024

Component image 
Transfer Grabbable component as seen in the Scene Inspector

Transfer Grabbable is a component that is used to mark objects that undergo Transcient Grabbing, but only while in Userspace. The grabber during this process saves the object into memory including materials, then simulates a paste as it puts the object into the target world.

If the world does not allow transferring to it, the _indicatorMaterial material will replace materials on the object and light up red. Will restore the materials back if transferring is allowed to the target world.

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.
PasteOnGrab Bool Whether to trigger a paste event in userspace when transfering the object to user space. does not affect when releasing.
_indicatorMaterial FresnelMaterial The indicator material to use when transfering to worlds.

Usage

Not intended to be used directly

Examples

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


See Also