rules

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

@@ -0,0 +1,122 @@
+# 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: SwimController
+type: class
+memory_category: Instances
+summary: ''
+description: ''
+code_samples: []
+inherits:
+  - ControllerBase
+descendants: []
+tags: []
+deprecation_message: ''
+properties:
+  - name: SwimController.AccelerationTime
+    summary: ''
+    description: ''
+    code_samples: []
+    type: float
+    tags: []
+    deprecation_message: ''
+    security:
+      read: None
+      write: None
+    thread_safety: ReadSafe
+    category: Movement
+    serialization:
+      can_load: true
+      can_save: true
+    capabilities:
+      - Basic
+  - name: SwimController.PitchMaxTorque
+    summary: |
+      The maximum torque used to rotate to the desired pitch.
+    description: |
+      The maximum torque used to rotate on the local **X** axis to the desired
+      pitch orientation. Has no effect if `Class.ControllerBase.RigidityEnabled`
+      is true.
+    code_samples: []
+    type: float
+    tags: []
+    deprecation_message: ''
+    security:
+      read: None
+      write: None
+    thread_safety: ReadSafe
+    category: Balance
+    serialization:
+      can_load: true
+      can_save: true
+    capabilities:
+      - Basic
+  - name: SwimController.PitchSpeedFactor
+    summary: |
+      Multiplied by `Class.ControllerManager.BaseTurnSpeed` to determine the
+      maximum angular velocity for pitch.
+    description: |
+      Multiplied by `Class.ControllerManager.BaseTurnSpeed` to determine the
+      maximum angular velocity rotating on the local **X** axis. Has no effect
+      if `Class.ControllerBase.RigidityEnabled` is true.
+    code_samples: []
+    type: float
+    tags: []
+    deprecation_message: ''
+    security:
+      read: None
+      write: None
+    thread_safety: ReadSafe
+    category: Balance
+    serialization:
+      can_load: true
+      can_save: true
+    capabilities:
+      - Basic
+  - name: SwimController.RollMaxTorque
+    summary: |
+      The maximum torque applied to rotate to the desired roll.
+    description: |
+      The maximum torque applied to rotate on the local **Z** axis to the
+      desired roll orientation. Has no effect if
+      `Class.ControllerBase.RigidityEnabled` is true.
+    code_samples: []
+    type: float
+    tags: []
+    deprecation_message: ''
+    security:
+      read: None
+      write: None
+    thread_safety: ReadSafe
+    category: Balance
+    serialization:
+      can_load: true
+      can_save: true
+    capabilities:
+      - Basic
+  - name: SwimController.RollSpeedFactor
+    summary: |
+      Multiplied by `Class.ControllerManager.BaseTurnSpeed` to determine the
+      maximum angular velocity for roll.
+    description: |
+      Multiplied by `Class.ControllerManager.BaseTurnSpeed` to determine the
+      maximum angular velocity rotating on the local **Z** axis. Has no effect
+      if `Class.ControllerBase.RigidityEnabled` is true.
+    code_samples: []
+    type: float
+    tags: []
+    deprecation_message: ''
+    security:
+      read: None
+      write: None
+    thread_safety: ReadSafe
+    category: Balance
+    serialization:
+      can_load: true
+      can_save: true
+    capabilities:
+      - Basic
+methods: []
+events: []
+callbacks: []