rules

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

@@ -0,0 +1,101 @@
+# 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: CustomEvent
+type: class
+memory_category: Instances
+summary: ''
+description: ''
+code_samples: []
+inherits:
+  - Instance
+descendants: []
+tags:
+  - Deprecated
+deprecation_message: |
+  `Class.CustomEvent|CustomEvents` have been superseded by
+  `Class.BindableEvent|BindableEvents` and should not be used in new work.
+properties: []
+methods:
+  - name: CustomEvent:GetAttachedReceivers
+    summary: |
+      Returns the `Class.CustomEventReceiver|CustomEventReceivers` that are
+      connected to the `Class.CustomEvent`.
+    description: |
+      This function returns the `Class.CustomEventReceiver|CustomEventReceivers`
+      that are connected to the `Class.CustomEvent`.
+    code_samples: []
+    parameters: []
+    returns:
+      - type: Instances
+        summary: ''
+    tags: []
+    deprecation_message: |
+      CustomEvents have been superseded by `Class.BindableEvent|BindableEvents`
+      and should not be used in new work.
+    security: None
+    thread_safety: Unsafe
+    capabilities: []
+  - name: CustomEvent:SetValue
+    summary: |
+      Sets the value of the `Class.CustomEvent` and fires the
+      `Class.CustomEventReceiver.SourceValueChanged` event for all connected
+      `CustomEventReceiver|receivers`.
+    description: |
+      This function sets the value of the `Class.CustomEvent` and fires the
+      `Class.CustomEventReceiver.SourceValueChanged` event for all connected
+      `CustomEventReceiver|receivers`.
+    code_samples: []
+    parameters:
+      - name: newValue
+        type: float
+        default:
+        summary: ''
+    returns:
+      - type: ()
+        summary: ''
+    tags: []
+    deprecation_message: |
+      `Class.CustomEvent|CustomEvents` have been superseded by
+      `Class.BindableEvent|BindableEvents` and should not be used in new work.
+    security: None
+    thread_safety: Unsafe
+    capabilities: []
+events:
+  - name: CustomEvent.ReceiverConnected
+    summary: |
+      Fires when a receiver is connected to the `Class.CustomEvent`.
+    description: |
+      This event fires when a receiver is connected to the `Class.CustomEvent`
+    code_samples: []
+    parameters:
+      - name: receiver
+        type: Instance
+        default:
+        summary: ''
+    tags: []
+    deprecation_message: |
+      `Class.CustomEvent|CustomEvents` have been superseded by
+      `Class.BindableEvent|BindableEvents` and should not be used in new work.
+    security: None
+    capabilities: []
+  - name: CustomEvent.ReceiverDisconnected
+    summary: |
+      Fires when a receiver is disconnected from the `Class.CustomEvent`.
+    description: |
+      This event fires when a receiver is disconnected from the
+      `Class.CustomEvent`.
+    code_samples: []
+    parameters:
+      - name: receiver
+        type: Instance
+        default:
+        summary: ''
+    tags: []
+    deprecation_message: |
+      `Class.CustomEvent|CustomEvents` have been superseded by
+      `Class.BindableEvent|BindableEvents` and should not be used in new work.
+    security: None
+    capabilities: []
+callbacks: []