HapticEffect

Not yet Class Other

An object that provides waveform-based haptic feedback (vibrations and rumbles) on supported controllers and mobile devices.

Not implemented yet

This class exists in the current Roblox API but is not implemented in Nova yet. Scripts that reference it will fail at runtime.

0 Nova members · 14 modern Roblox members not implemented yet

Description

Modern controllers and devices have motors built‑in to provide haptic feedback. Adding rumbles and vibrations can provide subtle feedback that is hard to convey through visuals or audio.

Roblox supports haptics for the following devices:

• Android and iOS phones supporting haptics including most iPhone, Pixel, and Samsung Galaxy devices
• PlayStation gamepads
• Xbox gamepads
• Quest Touch controller

Inheritance

Object → Instance → HapticEffect

Properties

Member	Signature	Summary
Looped	Looped: bool	Whether the haptic effect loops continuously.
Position	Position: Vector3	Along with Radius, specifies the impact position relative to the input device and, effectively, how broadly that impact effects nearby motors.
Radius	Radius: float	Along with Position, specifies the impact radius relative to the input device and, effectively, how broadly that impact effects nearby motors.
Type	Type: HapticEffectType	HapticEffectType describing the haptic type.
WaveformData	WaveformData: BinaryString	—

Methods

Member	Signature	Summary
Play	HapticEffect:Play(): null	Plays the haptic effect.
SetWaveformKeys	HapticEffect:SetWaveformKeys(keys: Array): null	Defines a custom waveform as a table and applies it to the haptic. This method takes in an array of FloatCurveKey objects.
Stop	HapticEffect:Stop(): null	Stops the haptic effect.

Events

Member	Signature	Summary
Ended	Ended()	Fires when the HapticEffect has completed playback and stopped.

Roblox reference: HapticEffect

Generated from Nova's API dump and Roblox creator-docs. Nova-only members come from the engine's reflection metadata.