rules

.cursor/rules/roblox/reference/engine/classes/HapticService.yaml

@@ -0,0 +1,154 @@
+# This file is automatically generated. Please don't edit it manually.
+# To submit a bug report on the content, see
+# https://devforum.roblox.com/c/bug-reports/documentation-issues/72
+
+name: HapticService
+type: class
+memory_category: Instances
+summary: |
+  Provides haptic feedback to controllers and devices.
+description: ''
+code_samples: []
+inherits:
+  - Instance
+descendants: []
+tags:
+  - NotCreatable
+  - Service
+  - NotReplicated
+deprecation_message: |
+  This service has been superseded by `Class.HapticEffect`, a newer instance
+  that supports multiple haptic effect types, looped effects, and customizable
+  haptics.
+properties: []
+methods:
+  - name: HapticService:GetMotor
+    summary: |
+      Returns the current vibration value set to the specified
+      `Class.InputObject.UserInputType|UserInputType` and `Enum.VibrationMotor`.
+    description: |
+      Returns the current vibration value set to the specified
+      `Class.InputObject.UserInputType|UserInputType` and `Enum.VibrationMotor`.
+      This will not return anything if
+      `Class.HapticService:SetMotor()|SetMotor()` has not been called prior.
+    code_samples: []
+    parameters:
+      - name: inputType
+        type: UserInputType
+        default:
+        summary: |
+          The specified `Enum.UserInputType`.
+      - name: vibrationMotor
+        type: VibrationMotor
+        default:
+        summary: |
+          The specified `Enum.VibrationMotor`.
+    returns:
+      - type: Tuple
+        summary: |
+          The current vibration value set to the specified `Enum.UserInputType`
+          and `Enum.VibrationMotor` or `nil` if
+          `Class.HapticService:SetMotor()|SetMotor()` has not been called prior.
+    tags: []
+    deprecation_message: ''
+    security: None
+    thread_safety: Unsafe
+    capabilities:
+      - Input
+  - name: HapticService:IsMotorSupported
+    summary: |
+      Returns `true` if the specified motor is available to be used with the
+      specified `Enum.UserInputType`.
+    description: |
+      Returns `true` if the specified motor is available to be used with the
+      specified `Enum.UserInputType`.
+    code_samples: []
+    parameters:
+      - name: inputType
+        type: UserInputType
+        default:
+        summary: |
+          The specific `Enum.UserInputType` being checked for
+          `Enum.VibrationMotor` support.
+      - name: vibrationMotor
+        type: VibrationMotor
+        default:
+        summary: |
+          The specified `Enum.VibrationMotor` checked to see if it supports the
+          specified `Enum.UserInputType`.
+    returns:
+      - type: boolean
+        summary: |
+          Boolean of `true` if the specified motor is available to be used with
+          the specified `Enum.UserInputType`, `false` if not.
+    tags: []
+    deprecation_message: ''
+    security: None
+    thread_safety: Unsafe
+    capabilities:
+      - Input
+  - name: HapticService:IsVibrationSupported
+    summary: |
+      Returns `true` if the specified `Enum.UserInputType` supports haptic
+      feedback.
+    description: |
+      Returns `true` if the specified `Enum.UserInputType` supports haptic
+      feedback.
+    code_samples: []
+    parameters:
+      - name: inputType
+        type: UserInputType
+        default:
+        summary: |
+          The specified `Enum.UserInputType` checked to see if it supports
+          haptic feedback.
+    returns:
+      - type: boolean
+        summary: |
+          Boolean of `true` if the specified `Enum.UserInputType` supports
+          haptic feedback.
+    tags: []
+    deprecation_message: ''
+    security: None
+    thread_safety: Unsafe
+    capabilities:
+      - Input
+  - name: HapticService:SetMotor
+    summary: |
+      Sets the vibration intensity of the specified
+      `Class.InputObject.UserInputType|UserInputType` and `Enum.VibrationMotor`.
+    description: |
+      Sets the vibration intensity of the specified `inputType` and
+      `vibrationMotor`. Note that almost all usage cases specify
+      `Enum.UserInputType.Gamepad1` for `inputType` which is internally mapped
+      to the device's respective hardware.
+    code_samples:
+      - HapticService-SetMotor1
+    parameters:
+      - name: inputType
+        type: UserInputType
+        default:
+        summary: |
+          The specified `Enum.UserInputType`.
+      - name: vibrationMotor
+        type: VibrationMotor
+        default:
+        summary: |
+          The specified `Enum.VibrationMotor`.
+      - name: vibrationValues
+        type: Tuple
+        default:
+        summary: |
+          How intensely the motor should vibrate. Only uses the first value in
+          the tuple, which should be a number.
+    returns:
+      - type: ()
+        summary: ''
+    tags: []
+    deprecation_message: ''
+    security: None
+    thread_safety: Unsafe
+    capabilities:
+      - Input
+events: []
+callbacks: []