Class
ControllerBase
NotCreatable
Abstract base class for the controllers that a ControllerManager uses
to move its character.
ControllerBase is the abstract base class for the controllers that a
ControllerManager uses to move its assigned character:
GroundController, AirController, SwimController, and
ClimbController. Each controller is parented to a
ControllerManager and supplies the movement and balance behavior for
one locomotion state, and the manager activates one controller at a time. This
class isn't created directly; instead create one of its derived controllers.
It defines the balance and movement properties shared by all of them.
Properties 3#
Activeboolean | Whether this controller is currently the active controller of its
ControllerManager.ReadSafeReadOnlyNotReplicated |
BalanceRigidityEnabledboolean | Whether the controller holds its balance orientation rigidly instead of with a spring response.ReadSafe |
MoveSpeedFactorfloat | The value multiplied by the ControllerManager.BaseMoveSpeed.ReadSafe |
Active: boolean#
ReadOnlyNotReplicatedReadSafe
Indicates whether this controller is the one currently driving its parent
ControllerManager. The manager activates the controller referenced
by its ControllerManager.ActiveController property and sets that
controller's Active to true; when the controller is no longer the
active one, it is deactivated and Active returns to false. This
property is read-only and defaults to false.
BalanceRigidityEnabled: boolean#
ReadSafe
Controls how the controller keeps its character oriented while active.
When false (the default), the balance constraint is compliant and
corrects orientation with a spring-damper response tuned by the
controller's balance properties, such as its balance torque and balance
speed. When true, the constraint instead holds the target orientation
rigidly, and those balance-tuning properties no longer apply. Defaults to
false.
MoveSpeedFactor: float#
ReadSafe
The value multiplied by the ControllerManager.BaseMoveSpeed to
determine the final desired linear velocity while this controller is
active.
Inherited members#
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
Subclasses 4#
AirController, ClimbController, GroundController, SwimController