ControllerBase
Abstract base class for the controllers that a ControllerManager uses to move its character.
| Memory category | Instances |
|---|
Member index 3
Removed member index 1
| History | Member | |
|---|---|---|
| 581 | RigidityEnabled: bool |
Description
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.
History 18
- 731 Change Default of MoveSpeedFactor from to
- 731 Change Default of BalanceRigidityEnabled from to
- 731 Change Default of Active from to
- 726 Change Default of MoveSpeedFactor from to
- 726 Change Default of BalanceRigidityEnabled from to
- 726 Change Default of Active from to
- 583 Add Active
- 581 Remove RigidityEnabled
- 581 Add BalanceRigidityEnabled
- 574 Change ThreadSafety of RigidityEnabled from LocalSafe to ReadSafe
- 574 Change ThreadSafety of MoveSpeedFactor from LocalSafe to ReadSafe
- 572 Change ThreadSafety of RigidityEnabled from ReadSafe to LocalSafe
- 572 Change ThreadSafety of MoveSpeedFactor from ReadSafe to LocalSafe
- 553 Change Default of RigidityEnabled from to
- 553 Change Default of MoveSpeedFactor from to
- 539 Add RigidityEnabled
- 539 Add MoveSpeedFactor
- 539 Add ControllerBase
Members 3
Active
| Type | Default | |
|---|---|---|
| bool | ||
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.
| Thread safety | ReadSafe |
|---|---|
| Category | Data |
| Loaded/Saved | false |
BalanceRigidityEnabled
| Type | Default | |
|---|---|---|
| bool | ||
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.
| Thread safety | ReadSafe |
|---|---|
| Category | Balance |
| Loaded/Saved | true |
History 3
- 731 Change Default of BalanceRigidityEnabled from to
- 726 Change Default of BalanceRigidityEnabled from to
- 581 Add BalanceRigidityEnabled
MoveSpeedFactor
| Type | Default | |
|---|---|---|
| float | ||
The value multiplied by the ControllerManager.BaseMoveSpeed to determine the final desired linear velocity while this controller is active.
| Thread safety | ReadSafe |
|---|---|
| Category | Movement |
| Loaded/Saved | true |
History 6
- 731 Change Default of MoveSpeedFactor from to
- 726 Change Default of MoveSpeedFactor from to
- 574 Change ThreadSafety of MoveSpeedFactor from LocalSafe to ReadSafe
- 572 Change ThreadSafety of MoveSpeedFactor from ReadSafe to LocalSafe
- 553 Change Default of MoveSpeedFactor from to
- 539 Add MoveSpeedFactor
Removed members 1
RigidityEnabled
| Type | Default | |
|---|---|---|
| bool | ||
| Thread safety | ReadSafe |
|---|---|
| Category | Balance |
| Loaded/Saved | true |
History 5
- 581 Remove RigidityEnabled
- 574 Change ThreadSafety of RigidityEnabled from LocalSafe to ReadSafe
- 572 Change ThreadSafety of RigidityEnabled from ReadSafe to LocalSafe
- 553 Change Default of RigidityEnabled from to
- 539 Add RigidityEnabled