Reference API Roblox

Engine API

Website

Related

Reference API Roblox

ControllerManager

Manages simulated motion control for its assigned ControllerManager.RootPart .

Member index 9

HistoryMember
726ActiveController: ControllerBase
726BaseMoveSpeed: float
726BaseTurnSpeed: float
726ClimbSensor: ControllerSensor
726FacingDirection: Vector3
726GroundSensor: ControllerSensor
726MovingDirection: Vector3
726RootPart: BasePart
726UpDirection: Vector3
inherited from Instance
726Archivable: bool
726Capabilities: SecurityCapabilities
726IsInSandbox: bool
726Name: string
726Parent: Instance
726PredictionMode: PredictionMode
726Sandboxed: bool
726UniqueId: 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
726children(): Instances
726clone(): Instance
726destroy(): null
726findFirstChild(name: string, recursive: bool = false): Instance
726getChildren(): Instances
726isDescendantOf(ancestor: Instance): bool
726remove(): null
462AncestryChanged(child: Instance, parent: Instance)
462AttributeChanged(attribute: string)
462ChildAdded(child: Instance)
462ChildRemoved(child: Instance)
462DescendantAdded(descendant: Instance)
462DescendantRemoving(descendant: Instance)
500Destroying()
657StyledPropertiesChanged()
726childAdded(child: Instance)
inherited from Object
726ClassName: string
726className: string
647GetPropertyChangedSignal(property: string): RBXScriptSignal
647IsA(className: string): bool
726isA(className: string): bool
647Changed(property: string)

Removed member index 2

HistoryMember
574GetControllers(): Objects

Description

The ControllerManager instance manages simulated motion control for its assigned ControllerManager.RootPart. It can be used to build a physics-based character controller.

History 51

Members 9

ActiveController

TypeDefault
ControllerBase

The ControllerBase that is set to be activated on the character. It does not guarantee that the specified ControllerBase is, in fact, active. If the ControllerBase cannot be activated for whatever reason, such as being outside of the character's WorldRoot or no Part being found to use as the floor for a GroundController, it will remain set and the ControllerManager will attempt to activate it in the next frame. This property can be set to nil to disable the physics controller.

History 7

BaseMoveSpeed

TypeDefault
float

The base linear movement speed used by all controllers. Controllers individually customize speed by setting the ControllerBase.MoveSpeedFactor property.

History 5

BaseTurnSpeed

TypeDefault
float

The base angular turning speed used by all controllers to align the character to face the desired direction.

History 5

ClimbSensor

TypeDefault
ControllerSensor

A reference to the sensor data used while a ClimbController is active. A ClimbController will use the ControllerPartSensor.HitPart, ControllerPartSensor.HitFrame, and ControllerPartSensor.HitNormal for climb movement computations. Typically a ControllerPartSensor set to SensorMode.Ladder is used here. Otherwise, you can override the sensor's outputs to direct what sensor data you want the ClimbController to use.

History 4

FacingDirection

TypeDefault
Vector3

The unit vector describing the desired direction to face. Aligns the LookVector of the ControllerManager.RootPart to this. Any Vector3 assigned will be automatically unitized.

History 5

GroundSensor

TypeDefault
ControllerSensor

A reference to the sensor data used while a GroundController is active. A GroundController will use the ControllerPartSensor.HitPart, ControllerPartSensor.HitFrame, and ControllerPartSensor.HitNormal for ground movement computations. Typically a ControllerPartSensor set to SensorMode.Floor is used here. Otherwise, you can override the sensor's outputs to direct what sensor data you want the GroundController to use.

History 4

MovingDirection

TypeDefault
Vector3

The vector describing the desired direction to move in, with a magnitude between 0 and 1. This is multiplied by BaseMoveSpeed to determine a final target move velocity. The RootPart will attempt to move in this direction based on the rules defined by the ActiveController.

History 5

RootPart

TypeDefault
BasePart

The BasePart where the controller's forces and torques are applied. With a typical Humanoid-based character, the Humanoid.RootPart is assigned as the ControllerManager.RootPart.

History 2

UpDirection

TypeDefault
Vector3

History 2

Removed members 2

GetControllers

Parameters (0)
No parameters.
Returns (1)
Objects
This function is deprecated. It exists only for backward compatibility, and should not be used for new work.

History 4

Tags: [Deprecated]

Settings