rules

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

@@ -0,0 +1,185 @@
+# 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: BodyVelocity
+type: class
+memory_category: Instances
+summary: |
+  Applies a force to maintain a constant velocity.
+description: |
+  The `BodyVelocity` object applies a force on an assembly such that it will
+  maintain a constant velocity. The `Class.BodyVelocity.Velocity|Velocity`
+  property, not to be confused with `Class.BasePart.AssemblyLinearVelocity`,
+  controls the goal velocity.
+
+  `Class.BodyVelocity` is the linear counterpart to `Class.BodyAngularVelocity`.
+  If you need the assembly to move toward a goal position, use
+  `Class.BodyPosition` instead. If you need further control on a force applied
+  to an object, consider using a `Class.BodyForce` or `Class.BodyThrust`
+  instead.
+
+  The strength of the force applied by this object is controlled by several
+  factors, namely the difference between the assembly's current velocity and the
+  goal velocity. This is multiplied by `Class.BodyVelocity.P|P` (power) to
+  either amplify or diminish it. The resulting force is then capped by
+  `Class.BodyVelocity.MaxForce|MaxForce`.
+code_samples: []
+inherits:
+  - BodyMover
+descendants: []
+tags:
+  - Deprecated
+deprecation_message: |
+  This object is deprecated and should not be used for new work. Use
+  `Class.LinearVelocity` instead, and see the
+  [legacy conversion notes](../../../physics/mover-constraints.md#legacy-mover-conversion).
+properties:
+  - name: BodyVelocity.MaxForce
+    summary: |
+      Determines the limit on how much force that may be applied to each axis.
+    description: |
+      This property determines the limit on the amount of force that may be
+      applied on each axis in reaching the goal
+      `Class.BodyVelocity.Velocity|Velocity`. If an assembly isn't moving,
+      consider increasing this value and also check that it is not
+      `Class.BasePart.Anchored|Anchored` or attached to any anchored assemblies.
+    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: BodyVelocity.maxForce
+    summary: ''
+    description: ''
+    code_samples: []
+    type: Vector3
+    tags:
+      - NotReplicated
+      - Deprecated
+    deprecation_message: |
+      This property is a deprecated variant of `Class.BodyVelocity.MaxForce`
+      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: BodyVelocity.P
+    summary: |
+      Determines how aggressive of a force is applied in reaching the goal
+      velocity.
+    description: |
+      This property determines how much power is used while applying force in
+      order to reach the goal `Class.BodyVelocity.Velocity|Velocity`. The higher
+      this value, the more power will be used and the faster it will be used.
+      The force the `Class.BodyVelocity` exerts increases as the difference
+      between the assembly's current velocity and the goal velocity increases.
+      This property is multiplied to this force to either amplify or diminish
+      it.
+    code_samples: []
+    type: float
+    tags: []
+    deprecation_message: ''
+    security:
+      read: None
+      write: None
+    thread_safety: ReadSafe
+    category: Goals
+    serialization:
+      can_load: true
+      can_save: true
+    capabilities:
+      - Physics
+  - name: BodyVelocity.Velocity
+    summary: |
+      Determines the goal velocity.
+    description: |
+      This property (not to be confused with `Class.BasePart.Velocity`)
+      determines the target velocity towards which force will be exerted. It is
+      specified relative to the world, not 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: BodyVelocity.velocity
+    summary: ''
+    description: ''
+    code_samples: []
+    type: Vector3
+    tags:
+      - NotReplicated
+      - Deprecated
+    deprecation_message: |
+      This property is a deprecated variant of `Class.BodyVelocity.Velocity`
+      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:
+  - name: BodyVelocity:GetLastForce
+    summary: |
+      Not implemented and will always return the `0` vector.
+    description: |
+      This method is not implemented and it will always return the `0` vector.
+      You are advised to use `Class.AlignPosition` instead.
+    code_samples: []
+    parameters: []
+    returns:
+      - type: Vector3
+        summary: ''
+    tags: []
+    deprecation_message: ''
+    security: None
+    thread_safety: Unsafe
+    capabilities:
+      - Physics
+  - name: BodyVelocity:lastForce
+    summary: |
+      Returns the last force in the object.
+    description: |
+      Returns the last force in the object.
+    code_samples: []
+    parameters: []
+    returns:
+      - type: Vector3
+        summary: ''
+    tags: []
+    deprecation_message: ''
+    security: None
+    thread_safety: Unsafe
+    capabilities:
+      - Physics
+events: []
+callbacks: []