Component:WorldGrabMover: Difference between revisions

From Resonite Wiki
Automated: create new component page
 
add info
 
Line 3: Line 3:
|Name=World Grab Mover
|Name=World Grab Mover
}}
}}
{{stub}}
The '''WorldGrabMover''' component is used as a visual for the [[Component:GrabWorldLocomotion|grab world locomotion]].


== Usage ==
== Fields ==
{{Table ComponentFields
{{Table ComponentFields
|ShowLerp|Float|
|ShowLerp|Float| The lerp value for showing the visual.
|_activatingUser|User|
|_activatingUser|User| The user making this visual for grabbing onto the world.
|_crossMesh|{{RootFieldType|DriveRef`1|[[Component:CrossMesh|CrossMesh]]}}|TypeAdv2=true|
|_crossMesh|{{RootFieldType|DriveRef`1|[[Component:CrossMesh|CrossMesh]]}}|TypeAdv2=true| The cross mesh being used for the anchor visual.
|_visualVisible|{{RootFieldType|FieldDrive`1|[[Type:Bool|Bool]]}}|TypeAdv3=true|
|_visualVisible|{{RootFieldType|FieldDrive`1|[[Type:Bool|Bool]]}}|TypeAdv3=true| Whether the visual should be visible.
|_visualRotation|{{RootFieldType|FieldDrive`1|[[Type:FloatQ|FloatQ]]}}|TypeAdv4=true|
|_visualRotation|{{RootFieldType|FieldDrive`1|[[Type:FloatQ|FloatQ]]}}|TypeAdv4=true| The field to drive with the rotation for the visual.
|_material|{{RootFieldType|DriveRef`1|[[PBS_RimMetallic|PBS_RimMetallic]]}}|TypeAdv5=true|
|_material|{{RootFieldType|DriveRef`1|[[PBS_RimMetallic|PBS_RimMetallic]]}}|TypeAdv5=true| The material that the visual is using.
|_referencePosition|Float3|
|_referencePosition|Float3| the position this visual is trying to stay and anchor at.
}}
}}


== Behavior ==
== Usage ==
Not used directly by the user.


== Examples ==
== Examples ==
The cross that appears on the user's hand when moving with [[Component:GrabWorldLocomotion|grab world locomotion]].


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


[[Category:Components:Uncategorized{{#translation:}}|World Grab Mover]]
[[Category:Components:Uncategorized{{#translation:}}|World Grab Mover]]
[[Category:Components{{#translation:}}|World Grab Mover]]
[[Category:Components{{#translation:}}|World Grab Mover]]
[[Category:ComponentStubs]]

Latest revision as of 01:00, 4 May 2025

Component image 
World Grab Mover component as seen in the Scene Inspector

The WorldGrabMover component is used as a visual for the grab world locomotion.

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.
ShowLerp Float The lerp value for showing the visual.
_activatingUser User The user making this visual for grabbing onto the world.
_crossMesh reference drive of CrossMesh The cross mesh being used for the anchor visual.
_visualVisible field drive of Bool Whether the visual should be visible.
_visualRotation field drive of FloatQ The field to drive with the rotation for the visual.
_material reference drive of PBS_RimMetallic The material that the visual is using.
_referencePosition Float3 the position this visual is trying to stay and anchor at.

Usage

Not used directly by the user.

Examples

The cross that appears on the user's hand when moving with grab world locomotion.

See Also