Reference API Roblox

Engine API

Website

Related

Reference API Roblox

AirController

A physics character controller that governs movement while a character is airborne.

Memory categoryInstances

Member index 8

HistoryMember
731BalanceMaxTorque: float
731BalanceSpeed: float
731MaintainAngularMomentum: bool
731MaintainLinearMomentum: bool
731MoveMaxForce: float
731TurnMaxTorque: float
731TurnSpeedFactor: 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 8

HistoryMember
581BalanceRigidityEnabled: bool
564CancelAirMomentum: bool
581OrientationMaxTorque: float
543OrientationSpeed: float
581OrientationSpeedFactor: float
574TurningMaxTorque: float
574TurningSpeedFactor: float

Description

An AirController is a ControllerBase that a ControllerManager uses to drive a character's physics-based movement while it is airborne, such as while jumping or falling. While it is the manager's ActiveController, it keeps the character balanced upright, turns it toward the ControllerManager.FacingDirection, and moves it horizontally toward the ControllerManager.MovingDirection. Uprighting is tuned with BalanceMaxTorque and BalanceSpeed, turning with TurnMaxTorque and TurnSpeedFactor, and horizontal movement with MoveMaxForce. An AirController only functions when parented to a ControllerManager.

History 71

Members 8

BalanceMaxTorque

TypeDefault
float10000

The maximum torque the character can use to remain balanced upright. When misaligned, this amount of torque is applied to reach the BalanceSpeed and realign the character. A higher torque means more force is required to cause the character to tilt. A lower torque means it's easer for the character to flip in the air. This property is hidden and has no effect when ControllerBase.BalanceRigidityEnabled is true.

Thread safetyReadSafe
CategoryBalance
Loaded/Savedtrue

History 5

BalanceSpeed

TypeDefault
float100

The maximum angular speed used to align the character upright. A lower value means it takes longer for the character to recover to the upright position when misaligned. A higher value results in a quicker recovery.

Thread safetyReadSafe
CategoryBalance
Loaded/Savedtrue

History 5

MaintainAngularMomentum

TypeDefault
booltrue

Determines whether angular momentum is preserved when input has stopped. If false, the character will apply TurningMaxTorque to bring the angular velocity toward 0 when there is no input.

Thread safetyReadSafe
CategoryTurn
Loaded/Savedtrue

History 6

MaintainLinearMomentum

TypeDefault
booltrue

Determines whether linear momentum is preserved when input has stopped. If false, the character will apply MoveMaxForce to bring the linear velocity towards 0 when there is no input.

Thread safetyReadSafe
CategoryMovement
Loaded/Savedtrue

History 5

MoveMaxForce

TypeDefault
float1000

The maximum force that can be applied on the ControllerManager.RootPart for moving in the ControllerManager.MovingDirection. This affects how quickly different target linear velocities are reached and how quick the linear acceleration is if MaintainLinearMomentum is off.

Thread safetyReadSafe
CategoryMovement
Loaded/Savedtrue

History 6

TurnMaxTorque

TypeDefault
float10000

The maximum torque that can be applied on the ControllerManager.RootPart for turning towards the ControllerManager.FacingDirection. This effects how quickly different target angular velocities are reached and how quick angular deceleration is if MaintainAngularMomentum is off.

Thread safetyReadSafe
CategoryTurn
Loaded/Savedtrue

History 3

TurnSpeedFactor

TypeDefault
float1

The value multiplied by the ControllerManager.BaseTurnSpeed to determine the final target angular velocity while this controller is active. The angular velocity is applied when turning towards the ControllerManager.FacingDirection.

Thread safetyReadSafe
CategoryTurn
Loaded/Savedtrue

History 3

Removed members 8

BalanceRigidityEnabled

TypeDefault
boolfalse
Thread safetyReadSafe
CategoryBalance
Loaded/Savedtrue

History 2

CancelAirMomentum

TypeDefault
booltrue
Thread safetyReadSafe
CategoryMovement
Loaded/Savedtrue

History 3

OrientationMaxTorque

TypeDefault
float10000
Thread safetyReadSafe
CategoryOrientation
Loaded/Savedtrue

History 4

OrientationSpeed

TypeDefault
float
Thread safetyReadSafe
CategoryBalance
Loaded/Savedtrue

History 2

OrientationSpeedFactor

TypeDefault
float1
Thread safetyReadSafe
CategoryOrientation
Loaded/Savedtrue

History 4

TurningMaxTorque

TypeDefault
float10000
Thread safetyLocalSafe
CategoryTurn
Loaded/Savedtrue

History 3

TurningSpeedFactor

TypeDefault
float1
Thread safetyLocalSafe
CategoryTurn
Loaded/Savedtrue

History 3

Settings