Component:HapticVolume: Difference between revisions

From Resonite Wiki
m Removed stub
not a stub, clean formatting
Line 2: Line 2:
|Image=HapticVolumeComponent.png
|Image=HapticVolumeComponent.png
|Name=Haptic Volume
|Name=Haptic Volume
}}Haptic Volumes allows a user to feel haptics through a [[collider]] set to Haptic Trigger shared on the same slot.
}}
Haptic Volumes allows a user to feel haptics through a [[collider]] set to Haptic Trigger shared on the same slot.


Haptic Volumes can be paired with [[:Category:Components:Input:Haptics:Filters|Haptic Filters]] placed on the same slot to give more precise control over a user's haptics.
Haptic Volumes can be paired with [[:Category:Components:Input:Haptics:Filters|Haptic Filters]] placed on the same slot to give more precise control over a user's haptics.


== Usage ==
== Fields ==
{{Table ComponentFields
{{Table ComponentFields
|Sensation|SensationClass|The type of haptic you want to do, for controllers the haptic types are subtly different variations. Specifying this is useful for haptic suits that have more advanced haptic motors.|Intensity|Float|The haptic intensity ranging from zero to one, zero being none one being max that the device allows.
|Sensation|SensationClass|The type of haptic you want to do, for controllers the haptic types are subtly different variations. Specifying this is useful for haptic suits that have more advanced haptic motors.
|Intensity|Float|The haptic intensity ranging from zero to one, zero being none one being max that the device allows.
|SensationHints|{{RootFieldType|SyncFieldList`1|[[Type:String|String]]}}|TypeAdv2=true|Allows triggering specific predefined sensations with certain haptic devices. Only useful for OWO haptic vests currently.
|SensationHints|{{RootFieldType|SyncFieldList`1|[[Type:String|String]]}}|TypeAdv2=true|Allows triggering specific predefined sensations with certain haptic devices. Only useful for OWO haptic vests currently.
}}
}}


== Behavior ==
== Usage ==
When placed on a slot with a [[collider]] component, the collider's type automatically switches to haptic trigger.
When placed on a slot with a [[collider]] component, the collider's type automatically switches to haptic trigger.


Line 18: Line 20:


== See Also ==
== See Also ==
[[Component:AvatarHapticSourceManager|Avatar Haptic Source Manager]] that directly controls haptic volumes for custom avatar defined haptics.
* [[Component:AvatarHapticSourceManager|Avatar Haptic Source Manager]] that directly controls haptic volumes for custom avatar defined haptics.
[[Category:Components:Input:Haptics{{#translation:}}|Haptic Volume]]
[[Category:Components:Input:Haptics{{#translation:}}|Haptic Volume]]
[[Category:Components{{#translation:}}|Haptic Volume]]
[[Category:Components{{#translation:}}|Haptic Volume]]
[[Category:ComponentStubs]]

Revision as of 17:22, 2 February 2025

Component image 
Haptic Volume component as seen in the Scene Inspector

Haptic Volumes allows a user to feel haptics through a collider set to Haptic Trigger shared on the same slot.

Haptic Volumes can be paired with Haptic Filters placed on the same slot to give more precise control over a user's haptics.

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.
Sensation SensationClass The type of haptic you want to do, for controllers the haptic types are subtly different variations. Specifying this is useful for haptic suits that have more advanced haptic motors.
Intensity Float The haptic intensity ranging from zero to one, zero being none one being max that the device allows.
SensationHints direct SyncFieldList`1<String> Allows triggering specific predefined sensations with certain haptic devices. Only useful for OWO haptic vests currently.

Usage

When placed on a slot with a collider component, the collider's type automatically switches to haptic trigger.

Examples

See Also