Component:ImpactTimeHapticFilter: Difference between revisions

From Resonite Wiki
Automated: create new component page
 
add info
 
(One intermediate revision by the same user not shown)
Line 3: Line 3:
|Name=Impact Time Haptic Filter
|Name=Impact Time Haptic Filter
}}
}}
{{stub}}
The '''ImpactTimeHapticFilter''' component is a haptics filter mainly for  [[Component:HapticVolume]]s change their intensity based on how long the user's hand has been inside of the affecting area.
 
This works as part of the game's robust [[Haptics]] system.


== Usage ==
== Fields ==
{{Table ComponentFields
{{Table ComponentFields
|UseGlobalTime|Bool|
|UseGlobalTime|Bool| Whether to use global time or local time.
|StartTime|Float|
|StartTime|Float| When the user's hand has been here for this amount of time, use <code>StartIntensity</code>.
|EndTime|Float|
|EndTime|Float| When the user's hand has been here for this amount of time, use <code>EndIntensity</code>.
|StartIntensity|Float|
|StartIntensity|Float| The intensity to use at the start of the time frame.
|EndIntensity|Float|
|EndIntensity|Float| The intensity to use at the end of the time frame.
|Power|Float|
|Power|Float| How much to amplify the overall intensity effect of this component.
}}
}}


== Behavior ==
== Usage ==
Attach to a slot with a valid and working [[Component:HapticVolume]] to add to the list of multiplicative haptic filters.


== Examples ==
== Examples ==
{{stub}}


== See Also ==
== See Also ==
Line 23: Line 27:
[[Category:Components:Input:Haptics:Filters{{#translation:}}|Impact Time Haptic Filter]]
[[Category:Components:Input:Haptics:Filters{{#translation:}}|Impact Time Haptic Filter]]
[[Category:Components{{#translation:}}|Impact Time Haptic Filter]]
[[Category:Components{{#translation:}}|Impact Time Haptic Filter]]
[[Category:ComponentStubs]]

Latest revision as of 19:58, 9 February 2025

Component image 
Impact Time Haptic Filter component as seen in the Scene Inspector

The ImpactTimeHapticFilter component is a haptics filter mainly for Component:HapticVolumes change their intensity based on how long the user's hand has been inside of the affecting area.

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.
UseGlobalTime Bool Whether to use global time or local time.
StartTime Float When the user's hand has been here for this amount of time, use StartIntensity.
EndTime Float When the user's hand has been here for this amount of time, use EndIntensity.
StartIntensity Float The intensity to use at the start of the time frame.
EndIntensity Float The intensity to use at the end of the time frame.
Power Float How much to amplify the overall intensity effect of this component.

Usage

Attach to a slot with a valid and working Component:HapticVolume to add to the list of multiplicative haptic filters.

Examples

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


See Also