Reference API Roblox

Engine API

Website

Related

Reference API Roblox

SwimController

The ControllerBase that moves a ControllerManager character while it is swimming.

Memory categoryInstances

Member index 5

HistoryMember
731AccelerationTime: float
731PitchMaxTorque: float
731PitchSpeedFactor: float
731RollMaxTorque: float
731RollSpeedFactor: float
inherited from ControllerBase
731Active: bool
731BalanceRigidityEnabled: bool
731MoveSpeedFactor: float
inherited from Instance
731Archivable: bool
731Capabilities: SecurityCapabilities
731IsInSandbox: bool
731Name: string
731Parent: Instance
731PredictionMode: PredictionMode
731Sandboxed: bool
731UniqueId: UniqueId
576AddTag(tag: string): null
573ClearAllChildren(): null
462Clone(): Instance
573Destroy(): null
486FindFirstAncestor(name: string): Instance
486FindFirstAncestorOfClass(className: string): Instance
486FindFirstAncestorWhichIsA(className: string): Instance
486FindFirstChild(name: string, recursive: bool = false): Instance
486FindFirstChildOfClass(className: string): Instance
486FindFirstChildWhichIsA(className: string, recursive: bool = false): Instance
486FindFirstDescendant(name: string): Instance
563GetActor(): Actor
486GetAttribute(attribute: string): Variant
462GetAttributeChangedSignal(attribute: string): RBXScriptSignal
631GetAttributes(): Dictionary
648GetChildren(): Instances
462GetDebugId(scopeLength: int = 4): string
707GetDescendants(): Instances
486GetFullName(): string
706GetStyled(name: string, selector: string?): Variant
657GetStyledPropertyChangedSignal(property: string): RBXScriptSignal
576GetTags(): Array
576HasTag(tag: string): bool
486IsAncestorOf(descendant: Instance): bool
486IsDescendantOf(ancestor: Instance): bool
664IsPropertyModified(property: string): bool
698QueryDescendants(selector: string): Instances
573Remove(): null
576RemoveTag(tag: string): null
664ResetPropertyToDefault(property: string): null
573SetAttribute(attribute: string, value: Variant): null
462WaitForChild(childName: string, timeOut: double): Instance
731children(): Instances
731clone(): Instance
731destroy(): null
731findFirstChild(name: string, recursive: bool = false): Instance
731getChildren(): Instances
731isDescendantOf(ancestor: Instance): bool
731remove(): null
462AncestryChanged(child: Instance, parent: Instance)
462AttributeChanged(attribute: string)
462ChildAdded(child: Instance)
462ChildRemoved(child: Instance)
462DescendantAdded(descendant: Instance)
462DescendantRemoving(descendant: Instance)
500Destroying()
657StyledPropertiesChanged()
731childAdded(child: Instance)
inherited from Object
731ClassName: string
731className: string
647GetPropertyChangedSignal(property: string): RBXScriptSignal
647IsA(className: string): bool
731isA(className: string): bool
647Changed(property: string)

Removed member index 2

HistoryMember
543OrientationMaxTorque: float
543OrientationSpeed: float

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.

History 37

Members 5

AccelerationTime

TypeDefault
float0
Thread safetyReadSafe
CategoryMovement
Loaded/Savedtrue

History 6

PitchMaxTorque

TypeDefault
float10000

The maximum torque used to rotate on the local X axis to the desired pitch orientation. Has no effect if ControllerBase.RigidityEnabled is true.

Thread safetyReadSafe
CategoryBalance
Loaded/Savedtrue

History 6

PitchSpeedFactor

TypeDefault
float1

Multiplied by ControllerManager.BaseTurnSpeed to determine the maximum angular velocity rotating on the local X axis. Has no effect if ControllerBase.RigidityEnabled is true.

Thread safetyReadSafe
CategoryBalance
Loaded/Savedtrue

History 6

RollMaxTorque

TypeDefault
float10000

The maximum torque applied to rotate on the local Z axis to the desired roll orientation. Has no effect if ControllerBase.RigidityEnabled is true.

Thread safetyReadSafe
CategoryBalance
Loaded/Savedtrue

History 6

RollSpeedFactor

TypeDefault
float1

Multiplied by ControllerManager.BaseTurnSpeed to determine the maximum angular velocity rotating on the local Z axis. Has no effect if ControllerBase.RigidityEnabled is true.

Thread safetyReadSafe
CategoryBalance
Loaded/Savedtrue

History 6

Removed members 2

OrientationMaxTorque

TypeDefault
float
Thread safetyReadSafe
CategoryBalance
Loaded/Savedtrue

History 2

OrientationSpeed

TypeDefault
float
Thread safetyReadSafe
CategoryBalance
Loaded/Savedtrue

History 2

Settings