Roblox UtilitiesDevlHub Roblox Documentation

Class

AngularVelocity

Inherits
Constraint › Instance › Object
Memory category
BaseParts

Applies torque on an assembly to maintain a constant angular velocity.

The AngularVelocity constraint applies torque on an assembly to maintain a constant angular velocity. Alternatively:

  • If you want to control the amount of torque applied, use a Torque constraint.
  • If you only need initial angular velocity, set the AssemblyAngularVelocity method directly on the assembly.

When configuring this constraint, it may be helpful to study Roblox Units to understand how Roblox units compare to metric units.

Relativity#

Application of velocity can be controlled through the constraint's RelativeTo property. If set to World, the angular velocity vector is used as is. If set to Attachment1 and the constraint's Attachment1 property is set to another attachment, the angular velocity will be affected by that of the other attachment. Setting RelativeTo to Attachment1 also exposes the ReactionTorqueEnabled property.

Properties 4#

AngularVelocityVector3A Vector3 that gives the desired or target angular velocity.ReadSafe
MaxTorquefloatMagnitude of the maximum torque the constraint can apply.ReadSafe
ReactionTorqueEnabledbooleanCauses the constraint to apply equal and opposite reaction forces.ReadSafe
RelativeToActuatorRelativeToThe ActuatorRelativeTo value specifying the coordinate frame in which the AngularVelocity vector is expressed; defaults to World.ReadSafe

AngularVelocity: Vector3#

ReadSafe

A Vector3 that gives the desired or target angular velocity. This vector is set in the CFrame expressed by the RelativeTo property.

MaxTorque: float#

ReadSafe

Magnitude of the maximum torque the constraint can apply.

ReactionTorqueEnabled: boolean#

ReadSafe

This property, when enabled, causes the constraint to apply equal and opposite reaction forces. This is important if the two attached parts can collide, since without reaction forces collisions can create energy that would otherwise be disregarded.

When enabled, the reaction forces cause the constraint to act like an angular motor between the two attachments.

Only meaningful when RelativeTo is set to Attachment1.

RelativeTo: ActuatorRelativeTo#

ReadSafe

The coordinate frame in which the AngularVelocity vector is expressed, selected by an ActuatorRelativeTo value. If set to World, the angular velocity vector is used as is. If set to Attachment1, the angular velocity is transformed by the CFrame of the assigned attachment.

RelativeTo can also be set to Attachment0, but it makes no physical sense and will lead to unpredictable behaviors.

Inherited members#

Inherited from Constraint 8
Inherited from Instance 58
Inherited from Object 6
Properties (2)

ClassName, className

Events (1)

Changed