rules

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

@@ -0,0 +1,119 @@
+# 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: BodyThrust
+type: class
+memory_category: Instances
+summary: |
+  Applies a constant force to an object at a specific point.
+description: |
+  The `BodyThrust` object applies a force relative to the assembly to which it
+  is parented at a specific location. It behaves similar to a `Class.BodyForce`
+  except that this object's force applies at a specific point
+  (`Class.BodyThrust.Location|Location`), allowing you to exert a torque
+  (rotational force). To apply a force dynamically so that an assembly maintains
+  a constant angular velocity, use a `Class.BodyAngularVelocity` instead. To
+  apply a force dynamically so that an assembly maintains a constant orientation
+  (angular position), use a `Class.BodyGyro`.
+code_samples: []
+inherits:
+  - BodyMover
+descendants: []
+tags:
+  - Deprecated
+deprecation_message: |
+  This object is deprecated and should not be used for new work. Use
+  `Class.VectorForce` instead, and see the
+  [legacy conversion notes](../../../physics/mover-constraints.md#legacy-mover-conversion).
+properties:
+  - name: BodyThrust.Force
+    summary: |
+      Determines the amount of force exerted on each axis relative to the
+      assembly.
+    description: |
+      This property determines the amount of force exerted on each axis relative
+      to the assembly. The force is exerted at the
+      `Class.BodyThrust.Location|Location` which is also relative to the
+      assembly.
+    code_samples: []
+    type: Vector3
+    tags: []
+    deprecation_message: ''
+    security:
+      read: None
+      write: None
+    thread_safety: ReadSafe
+    category: Goals
+    serialization:
+      can_load: true
+      can_save: true
+    capabilities:
+      - Physics
+  - name: BodyThrust.force
+    summary: ''
+    description: ''
+    code_samples: []
+    type: Vector3
+    tags:
+      - NotReplicated
+      - Deprecated
+    deprecation_message: |
+      This property is a deprecated variant of `Class.BodyThrust.Force|Force`
+      which should be used instead.
+    security:
+      read: None
+      write: None
+    thread_safety: ReadSafe
+    category: Goals
+    serialization:
+      can_load: true
+      can_save: false
+    capabilities:
+      - Physics
+  - name: BodyThrust.Location
+    summary: |
+      Determines the relative position where the `Class.BodyThrust.Force|Force`
+      is exerted.
+    description: |
+      This property determines the relative position where the
+      `Class.BodyThrust.Force|Force` is exerted. This is the primary means for
+      turning force into torque.
+    code_samples: []
+    type: Vector3
+    tags: []
+    deprecation_message: ''
+    security:
+      read: None
+      write: None
+    thread_safety: ReadSafe
+    category: Goals
+    serialization:
+      can_load: true
+      can_save: true
+    capabilities:
+      - Physics
+  - name: BodyThrust.location
+    summary: ''
+    description: ''
+    code_samples: []
+    type: Vector3
+    tags:
+      - NotReplicated
+      - Deprecated
+    deprecation_message: |
+      This property is a deprecated variant of `Class.BodyThrust.Location` which
+      should be used instead.
+    security:
+      read: None
+      write: None
+    thread_safety: ReadSafe
+    category: Goals
+    serialization:
+      can_load: true
+      can_save: false
+    capabilities:
+      - Physics
+methods: []
+events: []
+callbacks: []