Reference API Roblox

Engine API

Website

Related

Reference API Roblox

HapticService

Provides haptic feedback to controllers and devices.

This class is not replicated. Its interface does not cross the network boundary.
This class is not creatable. Instances of this class cannot be created with Instance.new.
This class is a service. It is a singleton that may be acquired with GetService.
Memory categoryInstances
Tags: [NotCreatable, Service, NotReplicated]

Member index 4

HistoryMember
462GetMotor(inputType: UserInputType, vibrationMotor: VibrationMotor): Tuple
462IsMotorSupported(inputType: UserInputType, vibrationMotor: VibrationMotor): bool
462IsVibrationSupported(inputType: UserInputType): bool
573SetMotor(inputType: UserInputType, vibrationMotor: VibrationMotor, vibrationValues: Tuple): null
inherited from Instance
731Archivable: bool
731Capabilities: SecurityCapabilities
731IsInSandbox: bool
731Name: string
731Parent: Instance
731PredictionMode: PredictionMode
731Sandboxed: bool
731UniqueId: UniqueId
576AddTag(tag: string): null
573ClearAllChildren(): null
462Clone(): Instance
573Destroy(): null
486FindFirstAncestor(name: string): Instance
486FindFirstAncestorOfClass(className: string): Instance
486FindFirstAncestorWhichIsA(className: string): Instance
486FindFirstChild(name: string, recursive: bool = false): Instance
486FindFirstChildOfClass(className: string): Instance
486FindFirstChildWhichIsA(className: string, recursive: bool = false): Instance
486FindFirstDescendant(name: string): Instance
563GetActor(): Actor
486GetAttribute(attribute: string): Variant
462GetAttributeChangedSignal(attribute: string): RBXScriptSignal
631GetAttributes(): Dictionary
648GetChildren(): Instances
462GetDebugId(scopeLength: int = 4): string
707GetDescendants(): Instances
486GetFullName(): string
706GetStyled(name: string, selector: string?): Variant
657GetStyledPropertyChangedSignal(property: string): RBXScriptSignal
576GetTags(): Array
576HasTag(tag: string): bool
486IsAncestorOf(descendant: Instance): bool
486IsDescendantOf(ancestor: Instance): bool
664IsPropertyModified(property: string): bool
698QueryDescendants(selector: string): Instances
573Remove(): null
576RemoveTag(tag: string): null
664ResetPropertyToDefault(property: string): null
573SetAttribute(attribute: string, value: Variant): null
462WaitForChild(childName: string, timeOut: double): Instance
731children(): Instances
731clone(): Instance
731destroy(): null
731findFirstChild(name: string, recursive: bool = false): Instance
731getChildren(): Instances
731isDescendantOf(ancestor: Instance): bool
731remove(): null
462AncestryChanged(child: Instance, parent: Instance)
462AttributeChanged(attribute: string)
462ChildAdded(child: Instance)
462ChildRemoved(child: Instance)
462DescendantAdded(descendant: Instance)
462DescendantRemoving(descendant: Instance)
500Destroying()
657StyledPropertiesChanged()
731childAdded(child: Instance)
inherited from Object
731ClassName: string
731className: string
647GetPropertyChangedSignal(property: string): RBXScriptSignal
647IsA(className: string): bool
731isA(className: string): bool
647Changed(property: string)

Description

HapticService allows scripts to query vibration support and set motor intensities on gamepad controllers, VR controllers, and mobile devices. Use IsVibrationSupported() and IsMotorSupported() to check device capabilities, then SetMotor() to drive a specific VibrationMotor on a given UserInputType. Motor output is scaled by the user's haptic intensity preference in their Roblox settings.

As this service is client-side only, it can only be used in a LocalScript, a ModuleScript required by a LocalScript, or a Script with RunContext set to RunContext.Client.

This service has been superseded by HapticEffect, which supports waveform-based effects, looping, spatial attenuation, and preset effect types. For new work, use HapticEffect instead.

History 10

Members 4

GetMotor

Parameters (2)
inputTypeUserInputType
vibrationMotorVibrationMotor
Returns (1)
Tuple

Returns the current vibration value set to the specified UserInputType and VibrationMotor. This will not return anything if SetMotor() has not been called prior.

Thread safetyUnsafe

History 2

IsMotorSupported

Parameters (2)
inputTypeUserInputType
vibrationMotorVibrationMotor
Returns (1)
bool

Returns true if the specified motor is available to be used with the specified UserInputType.

Thread safetyUnsafe

History 2

IsVibrationSupported

Parameters (1)
inputTypeUserInputType
Returns (1)
bool

Returns true if the specified UserInputType supports haptic feedback.

Thread safetyUnsafe

History 2

SetMotor

Parameters (3)
inputTypeUserInputType
vibrationMotorVibrationMotor
vibrationValuesTuple
Returns (1)
null

Sets the vibration intensity of the specified inputType and vibrationMotor. Note that almost all usage cases specify UserInputType.Gamepad1 for inputType which is internally mapped to the device's respective hardware.

Thread safetyUnsafe

History 3

Settings