BodyGyro¶
Applies a torque to maintain a constant orientation.
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.
Inheritance¶
Object → Instance → BodyMover → BodyGyro
Nova inheritance: Instance → BodyMover → BodyGyro
Properties¶
CFrame Supported Property Determines the target orientation (translational component ignored).
Determines the target orientation (translational component ignored).
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().
cframe Supported Property Deprecated Use CFrame instead
Use CFrame instead
D Supported Property Determines the amount of dampening to use in reaching the goal CFrame.
Determines the amount of dampening to use in reaching the goal CFrame.
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.
MaxTorque Supported Property Determines the limit on how much torque that may be applied to each axis.
Determines the limit on how much torque that may be applied to each axis.
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.
maxTorque Supported Property Deprecated Use MaxTorque instead
Use MaxTorque instead
P Supported Property Determines how aggressive of a torque is applied in reaching the goal orientation.
Determines how aggressive of a torque is applied in reaching the goal orientation.
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.
Inherited members¶
Inherited from BodyMover: 8 properties, 36 methods, 7 events. They are documented on the base class page.
Roblox reference: BodyGyro
Generated from Nova's API dump and Roblox creator-docs. Nova-only members come from the engine's reflection metadata.