Component:TagHapticPointMapper: Difference between revisions

From Resonite Wiki
Automated: create new component page
 
Added link.
 
(3 intermediate revisions by 2 users not shown)
Line 3: Line 3:
|Name=Tag Haptic Point Mapper
|Name=Tag Haptic Point Mapper
}}
}}
{{stub}}
The '''TagHapticPointMapper''' allows for defining custom mapping on avatars.


== Usage ==
This works as part of the game's robust [[Haptics]] system.
 
== Fields ==
{{Table ComponentFields
{{Table ComponentFields
|Priority|Int|
|Priority|Int| The priority of this Mapper over other mappers.
|ShowDebugVisuals|Bool|
|ShowDebugVisuals|Bool| Whether to show the haptic points for this haptic mapper.
|HapticPoints|{{RootFieldType|SyncList`1|[[#TaggedHapticPoint|TaggedHapticPoint]]}}|TypeAdv2=true|
|HapticPoints|{{RootFieldType|SyncList`1|[[#TaggedHapticPoint|TagHapticPointMapper.TaggedHapticPoint]]}}|TypeAdv2=true| A list of haptic points with tags and where they go.
}}
 
== TaggedHapticPoint ==
{{Table TypeFields
|HapticTag|String| The tag the haptic device needs to be put here.
|HapticPointRoot|Slot| Where to put the haptic sampler for the device.
}}
}}


== Behavior ==
== Usage ==
By frooxius:
 
* Full body avatars are automatically instrumented with this component
* You can define list of Slots with associated HapticTag on this component, which determine where will haptic points be mapped to
* You can specify that haptic devices (e.g. GigglePuck) can be mapped to a specific tag in the settings


== Examples ==
== Examples ==
* This gives you flexibility to customize the mapping when it doesn't fit the standard body parametrization, but it requires manual setup on the avatar to configure locations for each [[Tag]].


== See Also ==
== See Also ==
Line 21: Line 35:
[[Category:Components{{#translation:}}|Tag Haptic Point Mapper]]
[[Category:Components{{#translation:}}|Tag Haptic Point Mapper]]
[[Category:Components With Nested Types{{#translation:}}|Tag Haptic Point Mapper]]
[[Category:Components With Nested Types{{#translation:}}|Tag Haptic Point Mapper]]
[[Category:ComponentStubs]]

Latest revision as of 21:52, 20 March 2025

Component image 
Tag Haptic Point Mapper component as seen in the Scene Inspector

The TagHapticPointMapper allows for defining custom mapping on avatars.

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.
Priority Int The priority of this Mapper over other mappers.
ShowDebugVisuals Bool Whether to show the haptic points for this haptic mapper.
HapticPoints list of TagHapticPointMapper.TaggedHapticPoint A list of haptic points with tags and where they go.

TaggedHapticPoint

Fields
Name Type Description
HapticTag String The tag the haptic device needs to be put here.
HapticPointRoot Slot Where to put the haptic sampler for the device.

Usage

By frooxius:

  • Full body avatars are automatically instrumented with this component
  • You can define list of Slots with associated HapticTag on this component, which determine where will haptic points be mapped to
  • You can specify that haptic devices (e.g. GigglePuck) can be mapped to a specific tag in the settings

Examples

  • This gives you flexibility to customize the mapping when it doesn't fit the standard body parametrization, but it requires manual setup on the avatar to configure locations for each Tag.

See Also