Automated: create new component page |
add info |
||
| Line 3: | Line 3: | ||
|Name=Haptic Point Data | |Name=Haptic Point Data | ||
}} | }} | ||
The '''HapticPointData''' component gets data about a haptics device on a particular user. | |||
== | This works as part of the game's robust [[Haptics]] system. | ||
== Fields == | |||
{{Table ComponentFields | {{Table ComponentFields | ||
|Index|Int| | |Index|Int| The device index to get info on. | ||
|User|{{RootFieldType|UserRef}}|TypeAdv1=true| | |User|{{RootFieldType|UserRef}}|TypeAdv1=true| The user to get a device of <code>Index</code> from. | ||
|Force|Float| | |Force|Float| The device's perceived force. | ||
|Temperature|Float| | |Temperature|Float| The device's perceived temperature. | ||
|Pain|Float| | |Pain|Float| The device's perceived pain. | ||
|Vibration|Float| | |Vibration|Float| The device's perceived Vibration. | ||
|TotalActivationIntensity|Float| | |TotalActivationIntensity|Float| The total activation intensity of the haptic's device. | ||
}} | }} | ||
== | == Usage == | ||
Attach to a slot and provide a <code>User</code> for this component to start giving values. | |||
== Examples == | == Examples == | ||
Can be used to create a custom indicator for haptics, or to drive protoflux for haptics. | |||
== See Also == | == See Also == | ||
| Line 24: | Line 28: | ||
[[Category:Components:Input:Haptics{{#translation:}}|Haptic Point Data]] | [[Category:Components:Input:Haptics{{#translation:}}|Haptic Point Data]] | ||
[[Category:Components{{#translation:}}|Haptic Point Data]] | [[Category:Components{{#translation:}}|Haptic Point Data]] | ||
Latest revision as of 20:26, 7 February 2025
Component image File:HapticPointDataComponent.pngHaptic Point Data component as seen in the Scene Inspector
The HapticPointData component gets data about a haptics device on a particular user.
This works as part of the game's robust Haptics system.
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. |
Index
|
Int | The device index to get info on. |
User
|
direct UserRef | The user to get a device of Index from.
|
Force
|
Float | The device's perceived force. |
Temperature
|
Float | The device's perceived temperature. |
Pain
|
Float | The device's perceived pain. |
Vibration
|
Float | The device's perceived Vibration. |
TotalActivationIntensity
|
Float | The total activation intensity of the haptic's device. |
Usage
Attach to a slot and provide a User for this component to start giving values.
Examples
Can be used to create a custom indicator for haptics, or to drive protoflux for haptics.