BodyGyro
Applies a torque to maintain a constant orientation.
| Memory category | Instances |
|---|
Member index 6
Description
The BodyGyro object applies a torque (rotational force) on an assembly such
that it maintains a constant angular displacement, or orientation. This allows
for the creation of assemblies that point in a certain direction, as if a real
gyroscope were acting upon it. Essentially, it's the rotational counterpart to
a BodyPosition.
If you would like to maintain a constant angular velocity, use a BodyAngularVelocity instead.
The CFrame property controls the goal orientation. Only the angular components of the CFrame are used; position will make no difference. MaxTorque limits the amount of angular force that may be applied, P controls the power used in achieving the goal orientation, and D controls dampening behavior.
History 31
- 553 Change PreferredDescriptor of maxTorque from to MaxTorque
- 553 Change Default of maxTorque from to Vector3(400000, 0, 400000)
- 553 Change PreferredDescriptor of cframe from to CFrame
- 553 Change Default of cframe from to
- 553 Change Default of P from to 3000
- 553 Change Default of MaxTorque from to Vector3(400000, 0, 400000)
- 553 Change Default of D from to 500
- 553 Change Default of CFrame from to
- 553 Change PreferredDescriptor of BodyGyro from to AlignOrientation
- 516 Change Tags of BodyGyro from [] to [Deprecated]
- 486 Change ThreadSafety of maxTorque from ReadOnly to ReadSafe
- 486 Change ThreadSafety of cframe from ReadOnly to ReadSafe
- 486 Change ThreadSafety of P from ReadOnly to ReadSafe
- 486 Change ThreadSafety of MaxTorque from ReadOnly to ReadSafe
- 486 Change ThreadSafety of D from ReadOnly to ReadSafe
- 486 Change ThreadSafety of CFrame from ReadOnly to ReadSafe
- 462 Change ThreadSafety of maxTorque from to ReadOnly
- 462 Change ThreadSafety of cframe from to ReadOnly
- 462 Change ThreadSafety of P from to ReadOnly
- 462 Change ThreadSafety of MaxTorque from to ReadOnly
- 462 Change ThreadSafety of D from to ReadOnly
- 462 Change ThreadSafety of CFrame from to ReadOnly
- 210 Change Tags of maxTorque from [NotReplicated] to [NotReplicated, Deprecated]
- 210 Change Tags of cframe from [NotReplicated] to [NotReplicated, Deprecated]
- 210 Add MaxTorque
- 210 Add CFrame
- 47 Add maxTorque
- 47 Add cframe
- 47 Add P
- 47 Add D
- 47 Add BodyGyro
Members 6
CFrame
| Type | Default | |
|---|---|---|
| CFrame | ||
This property (not to be confused with BasePart.CFrame) determines the target orientation towards which torque will be exerted. Since BodyGyro does not apply translational force, the translational/positional component of the CFrame is ignored. Consider using one of the following CFrame constructors in setting this property: CFrame.fromAxisAngle(), CFrame.fromEulerAnglesXYZ(), or CFrame.fromEulerAnglesYXZ().
| Thread safety | ReadSafe |
|---|---|
| Category | Goals |
| Loaded/Saved | true |
D
| Type | Default | |
|---|---|---|
| float | 500 | |
This property defines how much dampening will be applied to the torque used to reach the goal CFrame. When the assembly approaches the goal orientation, it needs to decelerate, otherwise it will rotate past the goal and have to stop and re-accelerate back toward the goal. This often creates an undesirable "rubber‑banding" effect, avoided by applying dampening. The higher this value is set, the greater the dampening curve becomes, or the slower the assembly will approach the goal orientation.
| Thread safety | ReadSafe |
|---|---|
| Category | Goals |
| Loaded/Saved | true |
MaxTorque
| Type | Default | |
|---|---|---|
| Vector3 | 400000, 0, 400000 | |
This property determines the limit on the amount of torque that may be applied on each axis in reaching the goal orientation (CFrame). If an assembly isn't moving, consider increasing this value and also check that it is not Anchored or attached to any anchored assemblies.
| Thread safety | ReadSafe |
|---|---|
| Category | Goals |
| Loaded/Saved | true |
P
| Type | Default | |
|---|---|---|
| float | 3000 | |
This property determines how much power is used while applying torque in order to reach the goal CFrame. The higher this value, the more power will be used and the faster it will be used.
| Thread safety | ReadSafe |
|---|---|
| Category | Goals |
| Loaded/Saved | true |
cframe
| Type | Default | |
|---|---|---|
| CFrame | ||
| Thread safety | ReadSafe |
|---|---|
| Category | Goals |
| Loaded/Saved | true/false |
History 6
maxTorque
| Type | Default | |
|---|---|---|
| Vector3 | 400000, 0, 400000 | |
| Thread safety | ReadSafe |
|---|---|
| Category | Goals |
| Loaded/Saved | true/false |
History 6
- 553 Change PreferredDescriptor of maxTorque from to MaxTorque
- 553 Change Default of maxTorque from to Vector3(400000, 0, 400000)
- 486 Change ThreadSafety of maxTorque from ReadOnly to ReadSafe
- 462 Change ThreadSafety of maxTorque from to ReadOnly
- 210 Change Tags of maxTorque from [NotReplicated] to [NotReplicated, Deprecated]
- 47 Add maxTorque