Class
ClimbController
A physics character controller that moves its
ControllerManager.RootPart along a climbable surface, such as a
ladder.
ClimbController is a ControllerBase that produces climbing
movement for a physics-based character. When it is assigned as the
ControllerManager.ActiveController of a ControllerManager, the
manager applies constraints each simulation step that move the
ControllerManager.RootPart across the climbed surface while keeping it
upright and aligned to that surface. Movement follows the surface reported by
the manager's climb sensor (ControllerManager.ClimbSensor); if the
manager has no climb sensor detecting a surface, the controller has no effect.
The direction and target speed come from the requested move velocity scaled by
ControllerBase.MoveSpeedFactor, while the
ClimbController.MoveMaxForce, ClimbController.BalanceSpeed,
and ClimbController.BalanceMaxTorque properties tune how forcefully
and how quickly the root part moves and re-aligns.
Properties 4#
AccelerationTimefloat | Currently unused; reserved for future climb acceleration ramp timing.ReadSafe |
BalanceMaxTorquefloat | The maximum torque used to keep the ControllerManager.RootPart
aligned upright and aligned to the climbed surface.ReadSafe |
BalanceSpeedfloat | The maximum angular speed used to align the
ControllerManager.RootPart upright and with the climbed surface.ReadSafe |
MoveMaxForcefloat | The maximum force used by the climbing "motor" to move the
ControllerManager.RootPart or keep it stationary.ReadSafe |
AccelerationTime: float#
ReadSafe
This property currently has no runtime effect. ClimbController
derives target speed from the requested move velocity and
ControllerBase.MoveSpeedFactor and does not read
AccelerationTime.
BalanceMaxTorque: float#
ReadSafe
The maximum torque used to keep the ControllerManager.RootPart
aligned upright and aligned to the
ControllerManager.ClimbSensor.HitNormal. 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. This property is hidden and has no effect when
ControllerBase.BalanceRigidityEnabled is true.
BalanceSpeed: float#
ReadSafe
The maximum angular speed used to align the
ControllerManager.RootPart upright and aligned to the
ControllerManager.ClimbSensor.HitNormal. A lower value means it
takes longer for the root part to recover to the align position when
misaligned. A higher value results in a quicker recovery.
MoveMaxForce: float#
ReadSafe
The maximum force used by the climbing "motor" to move the
ControllerManager.RootPart or keep it stationary.
Inherited members#
Inherited from ControllerBase 3
Properties (3)
Inherited from Instance 58
Properties (10)
Archivable, archivable, Capabilities, IsInSandbox, Name, Parent, PredictionMode, RobloxLocked, Sandboxed, UniqueId
Methods (39)
AddTag, children, ClearAllChildren, Clone, clone, Destroy, destroy, FindFirstAncestor, FindFirstAncestorOfClass, FindFirstAncestorWhichIsA, FindFirstChild, findFirstChild, FindFirstChildOfClass, FindFirstChildWhichIsA, FindFirstDescendant, GetActor, GetAttribute, GetAttributeChangedSignal, GetAttributes, GetChildren, getChildren, GetDebugId, GetDescendants, GetFullName, GetStyled, GetStyledPropertyChangedSignal, GetTags, HasTag, IsAncestorOf, IsDescendantOf, isDescendantOf, IsPropertyModified, QueryDescendants, Remove, remove, RemoveTag, ResetPropertyToDefault, SetAttribute, WaitForChild