rules

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

@@ -0,0 +1,75 @@
+# 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: FlagStand
+type: class
+memory_category: BaseParts
+summary: |
+  The FlagStand object helps you make 'capture the flag' style games.
+description: |
+  The `Class.Flag` and `Class.FlagStand` objects allow you to make 'Capture the
+  Flag' style games quickly.
+code_samples: []
+inherits:
+  - Part
+descendants: []
+tags:
+  - Deprecated
+deprecation_message: |
+  The FlagStand and Flag are deprecated objects that were used to make 'capture
+  the flag' style games. Developers are advised to design their own systems
+  which will be more flexible and reliable.
+properties:
+  - name: FlagStand.TeamColor
+    summary: |
+      The Team that owns the `Class.FlagStand`. Corresponds with the TeamColors
+      in the `Class.Teams` service.
+    description: |
+      The Team that owns the `Class.FlagStand`. Corresponds with the TeamColors
+      in the `Class.Teams` service.
+
+      The `Class.Flag` and `Class.FlagStand` objects were created to allow
+      developers to make 'capture the flag' style games quickly.
+    code_samples: []
+    type: BrickColor
+    tags: []
+    deprecation_message: |
+      This property was a part of the now deprecated `Class.Flag` service. It
+      should not be used in new work.
+    security:
+      read: None
+      write: None
+    thread_safety: ReadSafe
+    category: Data
+    serialization:
+      can_load: true
+      can_save: true
+    capabilities:
+      - Basic
+methods: []
+events:
+  - name: FlagStand.FlagCaptured
+    summary: |
+      Fires when a player bearing an opposing flag, and having the same
+      `Class.Player.TeamColor` as the stand, touches the `Class.FlagStand`.
+    description: |
+      This event fires when a player bearing an opposing flag, and having the
+      same `Class.Player.TeamColor` as the stand, touches the `Class.FlagStand`.
+
+      The `Class.Flag` and `Class.FlagStand` objects were created to allow
+      developers to make 'capture the flag' style games quickly.
+    code_samples: []
+    parameters:
+      - name: player
+        type: Instance
+        default:
+        summary: ''
+    tags: []
+    deprecation_message: |
+      This event was a part of the now deprecated `Class.Flag` service. It
+      should not be used in new work.
+    security: None
+    capabilities:
+      - Basic
+callbacks: []