SwimController¶
The ControllerBase that moves a ControllerManager character while it is swimming.
Not implemented yet
This class exists in the current Roblox API but is not implemented in Nova yet. Scripts that reference it will fail at runtime.
Description¶
SwimController is the ControllerBase that a ControllerManager activates to move a physics-based character while it is swimming. When it is the manager's ControllerManager.ActiveController, it drives the ControllerManager.RootPart toward the manager's target velocity (scaled by ControllerBase.MoveSpeedFactor), pitches the character to face the ControllerManager.FacingDirection, and rolls it to keep it oriented in the water. Pitch rotation is tuned with SwimController.PitchMaxTorque and SwimController.PitchSpeedFactor, and roll with SwimController.RollMaxTorque and SwimController.RollSpeedFactor, with the speed factors scaled by ControllerManager.BaseTurnSpeed. A SwimController only functions when parented to a ControllerManager.
Inheritance¶
Object → Instance → ControllerBase → SwimController
Properties¶
| Member | Signature | Summary |
|---|---|---|
AccelerationTime |
AccelerationTime: float |
— |
PitchMaxTorque |
PitchMaxTorque: float |
The maximum torque used to rotate to the desired pitch. |
PitchSpeedFactor |
PitchSpeedFactor: float |
Multiplied by ControllerManager.BaseTurnSpeed to determine the maximum angular velocity for pitch. |
RollMaxTorque |
RollMaxTorque: float |
The maximum torque applied to rotate to the desired roll. |
RollSpeedFactor |
RollSpeedFactor: float |
Multiplied by ControllerManager.BaseTurnSpeed to determine the maximum angular velocity for roll. |
Roblox reference: SwimController
Generated from Nova's API dump and Roblox creator-docs. Nova-only members come from the engine's reflection metadata.