Component:HierarchyHapticsSource: Difference between revisions

From Resonite Wiki
Automated: create new component page
 
that isn't the correct usage!
 
(One intermediate revision by the same user not shown)
Line 3: Line 3:
|Name=Hierarchy Haptics Source
|Name=Hierarchy Haptics Source
}}
}}
{{stub}}
The '''HiearchyHapticsSource''' component every <code>Interval</code> seconds triggers a relative intensity haptics signal (Additive) of <code>RelativeIntensity</code>.
 
This works as part of the game's robust [[Haptics]] system.


== Usage ==
== Fields ==
{{Table ComponentFields
{{Table ComponentFields
|TargetHierarchy|Slot|
|TargetHierarchy|Slot| The hiearchy of haptics to trigger. If targeting an arm slot on an avatar, triggers all haptics under the arm and hand. For a VR user this would get their controller.
|Interval|Float|
|Interval|Float| The amount of seconds to wait per trigger. Fires automatically every this many seconds.
|RelativeIntensity|Float|
|RelativeIntensity|Float| The relative haptics intensity amount to send each trigger.
}}
}}


== Behavior ==
== Usage ==
Attach to a slot and provide a slot to <code>TargetHiearchy</code> that is under a user to trigger haptics on. Then provide some values to adjust to the desired effect.


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


== See Also ==
== See Also ==
Line 20: Line 24:
[[Category:Components:Input:Haptics{{#translation:}}|Hierarchy Haptics Source]]
[[Category:Components:Input:Haptics{{#translation:}}|Hierarchy Haptics Source]]
[[Category:Components{{#translation:}}|Hierarchy Haptics Source]]
[[Category:Components{{#translation:}}|Hierarchy Haptics Source]]
[[Category:ComponentStubs]]

Latest revision as of 20:08, 9 February 2025

Component image 
Hierarchy Haptics Source component as seen in the Scene Inspector

The HiearchyHapticsSource component every Interval seconds triggers a relative intensity haptics signal (Additive) of RelativeIntensity.

This works as part of the game's robust Haptics system.

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.
TargetHierarchy Slot The hiearchy of haptics to trigger. If targeting an arm slot on an avatar, triggers all haptics under the arm and hand. For a VR user this would get their controller.
Interval Float The amount of seconds to wait per trigger. Fires automatically every this many seconds.
RelativeIntensity Float The relative haptics intensity amount to send each trigger.

Usage

Attach to a slot and provide a slot to TargetHiearchy that is under a user to trigger haptics on. Then provide some values to adjust to the desired effect.

Examples

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

See Also