Automated: create new component page |
Add some more info |
||
(One intermediate revision by the same user not shown) | |||
Line 3: | Line 3: | ||
|Name=Virtual Haptic Point Sampler | |Name=Virtual Haptic Point Sampler | ||
}} | }} | ||
Virtual Haptic Point sampler is a component that is used as a way of picking up haptic sensations from the virtual environment inside [[Resonite]], without needing a haptic device. This can be used as a way of making a device that beeps as it detects vibrations, temperature, pain, and force. It can also be used as a way of relaying vibration sensations via API to vibration devices not supported by Resonite, like speakers with base. | |||
== Usage == | == Usage == | ||
{{Table ComponentFields | {{Table ComponentFields | ||
|Radius|Float| | |Radius|Float| The radius of the sphere for this. | ||
|ShowDebugVisual|Bool| | |ShowDebugVisual|Bool| Whether to show the debug visual for this sampler. | ||
|_debugVisual|{{RootFieldType|SlotCleanupRef`1|[[OverlayFresnelMaterial|OverlayFresnelMaterial]]}}|TypeAdv2=true| | |_debugVisual|{{RootFieldType|SlotCleanupRef`1|[[OverlayFresnelMaterial|OverlayFresnelMaterial]]}}|TypeAdv2=true| the material on the sphere of the current generated debug visual. Is null when <code>ShowDebugVisual</code> is false. | ||
|Force|{{RootFieldType|RawOutput`1|[[Type:Float|Float]]}}|TypeAdv3=true| | |Force|{{RootFieldType|RawOutput`1|[[Type:Float|Float]]}}|TypeAdv3=true| The force sensations picked up by this haptic point sampler. | ||
|Pain|{{RootFieldType|RawOutput`1|[[Type:Float|Float]]}}|TypeAdv4=true| | |Pain|{{RootFieldType|RawOutput`1|[[Type:Float|Float]]}}|TypeAdv4=true| The pain sensations picked up by this haptic point sampler. | ||
|Temperature|{{RootFieldType|RawOutput`1|[[Type:Float|Float]]}}|TypeAdv5=true| | |Temperature|{{RootFieldType|RawOutput`1|[[Type:Float|Float]]}}|TypeAdv5=true| The temperature sensations picked up by this haptic point sampler. | ||
|Vibration|{{RootFieldType|RawOutput`1|[[Type:Float|Float]]}}|TypeAdv6=true| | |Vibration|{{RootFieldType|RawOutput`1|[[Type:Float|Float]]}}|TypeAdv6=true| the vibration sensations picked up by this haptic point sampler. | ||
}} | }} | ||
== Behavior == | == Behavior == | ||
{{Note|This component will do nothing locally unless the user has haptic feedback enabled in their settings!|warning}} | |||
== Examples == | == Examples == | ||
Line 24: | Line 25: | ||
[[Category:Components:Input:Haptics{{#translation:}}|Virtual Haptic Point Sampler]] | [[Category:Components:Input:Haptics{{#translation:}}|Virtual Haptic Point Sampler]] | ||
[[Category:Components{{#translation:}}|Virtual Haptic Point Sampler]] | [[Category:Components{{#translation:}}|Virtual Haptic Point Sampler]] | ||
Latest revision as of 12:39, 17 October 2024
Component image
Virtual Haptic Point sampler is a component that is used as a way of picking up haptic sensations from the virtual environment inside Resonite, without needing a haptic device. This can be used as a way of making a device that beeps as it detects vibrations, temperature, pain, and force. It can also be used as a way of relaying vibration sensations via API to vibration devices not supported by Resonite, like speakers with base.
Usage
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. |
Radius
|
Float | The radius of the sphere for this. |
ShowDebugVisual
|
Bool | Whether to show the debug visual for this sampler. |
_debugVisual
|
direct SlotCleanupRef`1<OverlayFresnelMaterial> | the material on the sphere of the current generated debug visual. Is null when ShowDebugVisual is false.
|
Force
|
raw output of Float | The force sensations picked up by this haptic point sampler. |
Pain
|
raw output of Float | The pain sensations picked up by this haptic point sampler. |
Temperature
|
raw output of Float | The temperature sensations picked up by this haptic point sampler. |
Vibration
|
raw output of Float | the vibration sensations picked up by this haptic point sampler. |