ClimbController

Inherits from: ControllerBase → Instance → Object

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.

Inherits from: ControllerBase

Memory category: Instances

Properties

Name	Type / Returns	Description
ClimbController.AccelerationTime	float	Currently unused; reserved for future climb acceleration ramp timing.
ClimbController.BalanceMaxTorque	float	The maximum torque used to keep the `ControllerManager.RootPart` aligned upright and aligned to the climbed surface.
ClimbController.BalanceSpeed	float	The maximum angular speed used to align the `ControllerManager.RootPart` upright and with the climbed surface.
ClimbController.MoveMaxForce	float	The maximum force used by the climbing "motor" to move the `ControllerManager.RootPart` or keep it stationary.

Inherited from ControllerBase

Name	Type / Returns	Description
ControllerBase.Active	boolean	Whether this controller is currently the active controller of its `ControllerManager`.
ControllerBase.BalanceRigidityEnabled	boolean	Whether the controller holds its balance orientation rigidly instead of with a spring response.
ControllerBase.MoveSpeedFactor	float	The value multiplied by the `ControllerManager.BaseMoveSpeed`.

Inherited from Instance

Name	Type / Returns	Description
Instance.Archivable	boolean	Determines if an `Instance` and its descendants can be cloned using `Instance:Clone()`, and can be saved/published.
Instance.archivable	boolean
Instance.Capabilities	SecurityCapabilities	The set of capabilities allowed to be used for scripts inside this container.
Instance.IsInSandbox	boolean	Indicates whether the instance is inside a sandboxed container.
Instance.Name	string	A non-unique identifier of the `Instance`.
Instance.Parent	Instance	Determines the hierarchical parent of the `Instance`.
Instance.PredictionMode	PredictionMode	Reflects the client-side prediction mode applied to the instance under server-authoritative physics.
Instance.RobloxLocked	boolean	A deprecated property that used to protect `CoreGui` objects.
Instance.Sandboxed	boolean	When enabled, the instance can only access abilities in its `Capabilities` list.
Instance.UniqueId	UniqueId	A unique identifier for the instance.

Inherited from Object

Name	Type / Returns	Description
Object.ClassName	string	A read-only string representing the class this `Object` belongs to.
Object.className	string

ClimbController.AccelerationTime

This property currently has no runtime effect. ClimbController derives target speed from the requested move velocity and ControllerBase.MoveSpeedFactor and does not read AccelerationTime.

Field	Value
type	float
security	{"read":"None","write":"None"}
thread safety	ReadSafe
category	Movement
serialization	{"can_load":true,"can_save":true}
capabilities	["Basic"]
simulationAccess	true

ClimbController.BalanceMaxTorque

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.

Field	Value
type	float
security	{"read":"None","write":"None"}
thread safety	ReadSafe
category	Balance
serialization	{"can_load":true,"can_save":true}
capabilities	["Basic"]
simulationAccess	true

ClimbController.BalanceSpeed

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.

Field	Value
type	float
security	{"read":"None","write":"None"}
thread safety	ReadSafe
category	Balance
serialization	{"can_load":true,"can_save":true}
capabilities	["Basic"]
simulationAccess	true

ClimbController.MoveMaxForce

The maximum force used by the climbing "motor" to move the ControllerManager.RootPart or keep it stationary.

Field	Value
type	float
security	{"read":"None","write":"None"}
thread safety	ReadSafe
category	Movement
serialization	{"can_load":true,"can_save":true}
capabilities	["Basic"]
simulationAccess	true

Methods

Inherited from Instance

Name	Type / Returns	Description
Instance:AddTag	()	Applies a tag to the instance.
Instance:children	Instances	Returns an array of the object's children.
Instance:ClearAllChildren	()	This method destroys all of an instance's children.
Instance:Clone	Instance	Create a copy of an instance and all its descendants, ignoring instances that are not `Archivable`.
Instance:clone	Instance
Instance:Destroy	()	Sets the `Instance.Parent` property to `nil`, locks the `Instance.Parent` property, disconnects all connections, and calls `Destroy()` on all children.
Instance:destroy	()
Instance:FindFirstAncestor	Instance?	Returns the first ancestor of the `Instance` whose `Instance.Name` is equal to the given name.
Instance:FindFirstAncestorOfClass	Instance?	Returns the first ancestor of the `Instance` whose `Object.ClassName` is equal to the given className.
Instance:FindFirstAncestorWhichIsA	Instance?	Returns the first ancestor of the `Instance` for whom `Object:IsA()` returns true for the given className.
Instance:FindFirstChild	Instance?	Returns the first child of the `Instance` found with the given name.
Instance:findFirstChild	Instance
Instance:FindFirstChildOfClass	Instance?	Returns the first child of the `Instance` whose `ClassName` is equal to the given class name.
Instance:FindFirstChildWhichIsA	Instance?	Returns the first child of the `Instance` for whom `Object:IsA()` returns true for the given className.
Instance:FindFirstDescendant	Instance?	Returns the first descendant found with the given `Instance.Name`.
Instance:GetActor	Actor?	Returns the `Actor` associated with the Instance, if any.
Instance:GetAttribute	Variant	Returns the value which has been assigned to the given attribute name.
Instance:GetAttributeChangedSignal	RBXScriptSignal	Returns an event that fires when the given attribute changes.
Instance:GetAttributes	Dictionary	Returns a dictionary of the instance's attributes.
Instance:GetChildren	Instances	Returns an array containing all of the instance's children.
Instance:getChildren	Instances
Instance:GetDebugId	string	Returns a coded string of the debug ID used internally by Roblox.
Instance:GetDescendants	Instances	Returns an array containing all of the descendants of the instance.
Instance:GetFullName	string	Returns a string describing the instance's ancestry.
Instance:GetStyled	Variant	Returns the styled or explicitly modified value of the specified property, or else the default property value if it hasn't been styled/modified.
Instance:GetStyledPropertyChangedSignal	RBXScriptSignal	Returns an event that fires when the given style property changes on the instance.
Instance:GetTags	Array	Gets an array of all tags applied to the instance.
Instance:HasTag	boolean	Check whether the instance has a given tag.
Instance:IsAncestorOf	boolean	Returns true if an `Instance` is an ancestor of the given descendant.
Instance:IsDescendantOf	boolean	Returns `true` if an `Instance` is a descendant of the given ancestor.
Instance:isDescendantOf	boolean
Instance:IsPropertyModified	boolean	Returns `true` if the value stored in the specified property is not equal to the code-instantiated default.
Instance:QueryDescendants	Instances	Returns an array containing all descendants of the instance that match the `selector` string.
Instance:Remove	()	Sets the object's `Parent` to `nil`, and does the same for all its descendants.
Instance:remove	()
Instance:RemoveTag	()	Removes a tag from the instance.
Instance:ResetPropertyToDefault	()	Resets a property to its default value.
Instance:SetAttribute	()	Sets the attribute with the given name to the given value.
Instance:WaitForChild	Instance	Returns the child of the `Instance` with the given name. If the child does not exist, it will yield the current thread until it does.

Inherited from Object

Name	Type / Returns	Description
Object:GetPropertyChangedSignal	RBXScriptSignal	Get an event that fires when a given property of the object changes.
Object:IsA	boolean	Returns true if an object's class matches or inherits from a given class.
Object:isA	boolean

Events

Inherited from Instance

Name	Type / Returns	Description
Instance.AncestryChanged		Fires when the `Instance.Parent` property of this object or one of its ancestors is changed.
Instance.AttributeChanged		Fires whenever an attribute is changed on the `Instance`.
Instance.ChildAdded		Fires after an object is parented to this `Instance`.
Instance.childAdded
Instance.ChildRemoved		Fires after a child is removed from this `Instance`.
Instance.DescendantAdded		Fires after a descendant is added to the `Instance`.
Instance.DescendantRemoving		Fires immediately before a descendant of the `Instance` is removed.
Instance.Destroying		Fires immediately before (or is deferred until after) the instance is destroyed via `Instance:Destroy()`.
Instance.StyledPropertiesChanged		Fires whenever any style property is changed on the instance, including when a property is set to `nil`.

Inherited from Object

Name	Type / Returns	Description
Object.Changed		Fires immediately after a property of the object changes, with some limitations.