Reference API Roblox

Engine API

Website

Related

Reference API Roblox

GroundController

Member index 11

HistoryMember
574AccelerationLean: float
574AccelerationTime: float
574BalanceMaxTorque: float
574BalanceSpeed: float
574DecelerationTime: float
574Friction: float
574FrictionWeight: float
574GroundOffset: float
574StandForce: float
574StandSpeed: float
574TurnSpeedFactor: float
inherited from ControllerBase
583Active: bool
581BalanceRigidityEnabled: bool
574MoveSpeedFactor: float
inherited from Instance
553Archivable: bool
635Capabilities: SecurityCapabilities
553Name: string
553Parent: Instance
635Sandboxed: bool
616UniqueId: 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
486GetDescendants(): Array
486GetFullName(): string
641GetStyled(name: string): Variant
576GetTags(): Array
576HasTag(tag: string): bool
486IsAncestorOf(descendant: Instance): bool
486IsDescendantOf(ancestor: Instance): bool
580IsPropertyModified(name: string): bool
573Remove(): null
576RemoveTag(tag: string): null
580ResetPropertyToDefault(name: string): null
573SetAttribute(attribute: string, value: Variant): null
462WaitForChild(childName: string, timeOut: double): Instance
648children(): Instances
553clone(): Instance
573destroy(): null
553findFirstChild(name: string, recursive: bool = false): Instance
648getChildren(): Instances
553isDescendantOf(ancestor: Instance): bool
573remove(): null
462AncestryChanged(child: Instance, parent: Instance)
462AttributeChanged(attribute: string)
462ChildAdded(child: Instance)
462ChildRemoved(child: Instance)
462DescendantAdded(descendant: Instance)
462DescendantRemoving(descendant: Instance)
500Destroying()
553childAdded(child: Instance)
inherited from Object
647ClassName: string
647className: string
647GetPropertyChangedSignal(property: string): RBXScriptSignal
647IsA(className: string): bool
650isA(className: string): bool
647Changed(property: string)

Removed member index 5

HistoryMember
581AlignSpeed: float
581AlignTorque: float
581BalanceRigidityEnabled: bool
581TurningFactor: float

Description

History 67

Members 11

AccelerationLean

TypeDefault
float1

History 4

AccelerationTime

TypeDefault
float0

Estimated time (in seconds) taken to reach the desired speed after walking input begins. The character will accelerate linearly at the computed rate, impacted by friction, so a given time may be less accurate with lower friction.

History 4

BalanceMaxTorque

TypeDefault
float10000

The maximum torque used to keep the ControllerManager.RootPart aligned upright. When misaligned, this amount of torque is applied to reach the BalanceSpeed and realign the root part. A higher torque means more force is required to cause the root part to tilt. A lower torque means it's easer for the root part to get knocked over when running into things. This property is hidden and has no effect when ControllerBase.BalanceRigidityEnabled is true.

History 3

BalanceSpeed

TypeDefault
float100

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

History 3

DecelerationTime

TypeDefault
float0

Estimated time (in seconds) taken to reach a complete stop from full speed after walking input ends. The character will decelerate linearly at the computed rate, impacted by friction, so a given time may be less accurate with lower friction.

History 4

Friction

TypeDefault
float2

The coefficient of friction for the character at the point between it and the ground. Determines how much force is available for locomotion or to keep the character stationary on slopes.

History 4

FrictionWeight

TypeDefault
float1

Amount the character's friction is weighed against the ground friction, equal in behavior to the FrictionWeight data type of BasePart.CustomPhysicalProperties. Higher values mean more of a part's Friction will be used.

History 4

GroundOffset

TypeDefault
float1

The target distance above the ControllerManager.GroundSensor.HitPosition to keep the ControllerManager.RootPart at. If the root part is below this offset from the ground, a force is applied to raise up to this height. If it's above, nothing happens.

History 4

StandForce

TypeDefault
float10000

History 4

StandSpeed

TypeDefault
float100

History 4

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.

History 2

Removed members 5

AlignSpeed

TypeDefault
float100

History 5

AlignTorque

TypeDefault
float10000

History 5

BalanceRigidityEnabled

TypeDefault
boolfalse

History 4

TurningFactor

TypeDefault
float1

History 5

Settings