rules

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

@@ -0,0 +1,152 @@
+# 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: Controller
+type: class
+memory_category: Instances
+summary: |
+  The base class for controller objects, such as the `Class.HumanoidController`
+  object.
+description: |
+  The base class for controller objects, such as the `Class.HumanoidController`
+  object.
+code_samples: []
+inherits:
+  - Instance
+descendants:
+  - HumanoidController
+  - SkateboardController
+  - VehicleController
+tags:
+  - NotCreatable
+deprecation_message: ''
+properties: []
+methods:
+  - name: Controller:BindButton
+    summary: |
+      Activates an overriding bind on the specified button.
+    description: |
+      Activates an overriding bind on the specified button.
+    code_samples:
+      - Controller-BindButton1
+    parameters:
+      - name: button
+        type: Button
+        default:
+        summary: ''
+      - name: caption
+        type: string
+        default:
+        summary: ''
+    returns:
+      - type: ()
+        summary: ''
+    tags: []
+    deprecation_message: ''
+    security: None
+    thread_safety: Unsafe
+    capabilities: []
+  - name: Controller:bindButton
+    summary: ''
+    description: ''
+    code_samples: []
+    parameters:
+      - name: button
+        type: Button
+        default:
+        summary: ''
+      - name: caption
+        type: string
+        default:
+        summary: ''
+    returns:
+      - type: ()
+        summary: ''
+    tags:
+      - Deprecated
+    deprecation_message: |
+      This function is a deprecated variant of `Class.Controller:BindButton()`
+      which should be used instead.
+    security: None
+    thread_safety: Unsafe
+    capabilities: []
+  - name: Controller:GetButton
+    summary: |
+      Returns whether or not Button is being pressed.
+    description: |
+      Returns whether or not Button is being pressed.
+    code_samples: []
+    parameters:
+      - name: button
+        type: Button
+        default:
+        summary: ''
+    returns:
+      - type: boolean
+        summary: ''
+    tags: []
+    deprecation_message: ''
+    security: None
+    thread_safety: Unsafe
+    capabilities: []
+  - name: Controller:getButton
+    summary: ''
+    description: ''
+    code_samples: []
+    parameters:
+      - name: button
+        type: Button
+        default:
+        summary: ''
+    returns:
+      - type: boolean
+        summary: ''
+    tags:
+      - Deprecated
+    deprecation_message: |
+      This function is a deprecated variant of `Class.Controller:GetButton()`
+      which should be used instead.
+    security: None
+    thread_safety: Unsafe
+    capabilities: []
+  - name: Controller:UnbindButton
+    summary: |
+      Removes the bind on button.
+    description: |
+      Removes the bind on button.
+    code_samples: []
+    parameters:
+      - name: button
+        type: Button
+        default:
+        summary: ''
+    returns:
+      - type: ()
+        summary: ''
+    tags: []
+    deprecation_message: ''
+    security: None
+    thread_safety: Unsafe
+    capabilities: []
+events:
+  - name: Controller.ButtonChanged
+    summary: |
+      Fired when the pressed state of a bound button is changed. This event can
+      be used in conjunction with `Class.Controller:GetButton()` to see whether
+      a bound button is being pressed down or not.
+    description: |
+      Fired when the pressed state of a bound button is changed. This event can
+      be used in conjunction with `Class.Controller:GetButton()` to see whether
+      a bound button is being pressed down or not.
+    code_samples: []
+    parameters:
+      - name: button
+        type: Button
+        default:
+        summary: ''
+    tags: []
+    deprecation_message: ''
+    security: None
+    capabilities: []
+callbacks: []