Reference API Roblox

Engine API

Website

Related

Reference API Roblox

ControllerManager

Manages simulated motion control for its assigned ControllerManager.RootPart .

Memory categoryInstances

Member index 9

HistoryMember
574ActiveController: ControllerBase
574BaseMoveSpeed: float
574BaseTurnSpeed: float
574ClimbSensor: ControllerSensor
574FacingDirection: Vector3
574GroundSensor: ControllerSensor
574MovingDirection: Vector3
580RootPart: BasePart
612UpDirection: Vector3
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 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 42

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.

Thread safetyReadSafe
CategoryBehavior
Loaded/Savedtrue

History 6

BaseMoveSpeed

TypeDefault
float16

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

Thread safetyReadSafe
CategoryBehavior
Loaded/Savedtrue

History 4

BaseTurnSpeed

TypeDefault
float8

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

Thread safetyReadSafe
CategoryBehavior
Loaded/Savedtrue

History 4

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.

Thread safetyReadSafe
CategoryBehavior
Loaded/Savedtrue

History 3

FacingDirection

TypeDefault
Vector30, 0, 1

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.

Thread safetyReadSafe
CategoryInput
Loaded/Savedtrue

History 4

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.

Thread safetyReadSafe
CategoryBehavior
Loaded/Savedtrue

History 3

MovingDirection

TypeDefault
Vector30, 0, 0

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.

Thread safetyReadSafe
CategoryInput
Loaded/Savedtrue

History 4

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.

Thread safetyReadSafe
CategoryBehavior
Loaded/Savedtrue

History 1

UpDirection

TypeDefault
Vector30, 1, 0
Thread safetyReadSafe
CategoryInput
Loaded/Savedtrue

History 1

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.
Thread safetyUnsafe

History 4

Tags: [Deprecated]

Settings