Component:AvatarHapticSourceManager: Difference between revisions

From Resonite Wiki
clean and unstub
Automated: update Fields
 
(3 intermediate revisions by 2 users not shown)
Line 2: Line 2:
|Image=AvatarHapticSourceManagerComponent.png
|Image=AvatarHapticSourceManagerComponent.png
|Name=Avatar Haptic Source Manager
|Name=Avatar Haptic Source Manager
}}Avatar Haptic Source Manager allows you to override the injected haptic points that Resonite puts on fullbody avatars and to specify custom [[Component:HapticVolume|Haptic Volumes]] on your body.
}}
The '''AvatarHapticSourceManager''' component allows you to override the injected haptic points that Resonite puts on fullbody avatars and to specify custom [[Component:HapticVolume|Haptic Volumes]] on your body.


Overriding your injected haptic points can be useful in situations where your avatar's proportions exaggerate the automatic haptic points that other users feel is too large or too small.
Overriding your injected haptic points can be useful in situations where your avatar's proportions exaggerate the automatic haptic points that other users feel is too large or too small.
Line 8: Line 9:
Requires the avatar to be equipped again to turn off the injected haptics.
Requires the avatar to be equipped again to turn off the injected haptics.


It is suggested to add the Active states of the custom [[Component:HapticVolume|haptic volumes]] as Avatar Haptic Source Manager controls the state being locally disabled for the active user the component is under and allows locally disabling for others that are far away.
Despite the component asking for the [[Component:HapticVolume|haptic volume]] active state, it is suggested to instead use the active state of the haptic [[collider]], this allows the Avatar Haptic Source Manager to disable the colliders on the active user and allow culling behavior. The reason for this is that disabling haptic volumes does not disable the haptics itself.


== Fields =
This works as part of the game's robust [[Haptics]] system.
 
== Fields ==
{{Table ComponentFields
{{Table ComponentFields
|HapticVolumeActiveStates|{{RootFieldType|SyncList`1|[[Type:FieldDrive`1|FieldDrive`1]]<[[Type:Bool|Bool]]>}}|TypeAdv0=true|Controls the active state of connected haptic volumes in a list.}}
|HapticVolumeActiveStates|{{RootFieldType|SyncList`1|[[Type:FieldDrive`1|FieldDrive`1]]<[[Type:Bool|Bool]]>}}|TypeAdv0=true|Drives the boolean field put in the list to be disabled when noclipping usually
}}


== Usage ==
== Usage ==
Line 20: Line 24:


== See Also ==
== See Also ==
 
While Avatar Haptic Source Manger controls overriding the haptic volumes on your avatar, [[Component:ControllerHapticPointMapper|Controller Haptic Point Mapper]] controls where you receive haptic events on your controllers.
[[Category:Components:Input:Haptics{{#translation:}}|Avatar Haptic Source Manager]]
[[Category:Components:Input:Haptics{{#translation:}}|Avatar Haptic Source Manager]]
[[Category:Components{{#translation:}}|Avatar Haptic Source Manager]]
[[Category:Components{{#translation:}}|Avatar Haptic Source Manager]]

Latest revision as of 22:28, 16 March 2025

Component image 
Avatar Haptic Source Manager component as seen in the Scene Inspector

The AvatarHapticSourceManager component allows you to override the injected haptic points that Resonite puts on fullbody avatars and to specify custom Haptic Volumes on your body.

Overriding your injected haptic points can be useful in situations where your avatar's proportions exaggerate the automatic haptic points that other users feel is too large or too small.

Requires the avatar to be equipped again to turn off the injected haptics.

Despite the component asking for the haptic volume active state, it is suggested to instead use the active state of the haptic collider, this allows the Avatar Haptic Source Manager to disable the colliders on the active user and allow culling behavior. The reason for this is that disabling haptic volumes does not disable the haptics itself.

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.
HapticVolumeActiveStates list of FieldDrive`1<Bool> Drives the boolean field put in the list to be disabled when noclipping usually

Usage

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

Examples

See Also

While Avatar Haptic Source Manger controls overriding the haptic volumes on your avatar, Controller Haptic Point Mapper controls where you receive haptic events on your controllers.