VectorForce
Applies a constant force in a selected coordinate frame.
- Creatable
Instance.new("VectorForce")- Inherits
- ConstraintInstance
- Replication
- Standard
Behavior
VectorForce applies a constant force in a selected coordinate frame.
Summary
Whether the constraint is currently active in the physics simulation.
Whether force is applied at the assembly's center of mass to avoid additional torque.
The first attachment used by the constraint or effect.
The second attachment used by the constraint or effect.
The color of the constraint visualization.
Whether the physics solver processes this constraint.
The force vector applied by the actuator.
The coordinate frame used to interpret the actuator's force or velocity.
Whether the constraint visualization is displayed.
Returns this instance if it is an ExecutionGroup.
Properties
Active
VectorForce.Active: boolean = falseWhether the constraint is currently active in the physics simulation.
ApplyAtCenterOfMass
VectorForce.ApplyAtCenterOfMass: boolean = falseWhether force is applied at the assembly's center of mass to avoid additional torque.
Attachment0
VectorForce.Attachment0: Attachment? = nilThe first attachment used by the constraint or effect.
Attachment1
VectorForce.Attachment1: Attachment? = nilThe second attachment used by the constraint or effect.
Color
VectorForce.Color: Color3 = Color3.new(1, 0.686, 0)The color of the constraint visualization.
Enabled
VectorForce.Enabled: boolean = trueWhether the physics solver processes this constraint.
Force
VectorForce.Force: Vector3 = Vector3.new(0, 0, 0)The force vector applied by the actuator.
RelativeTo
VectorForce.RelativeTo: Enum.ActuatorRelativeTo = Enum.ActuatorRelativeTo.WorldThe coordinate frame used to interpret the actuator's force or velocity.
Visible
VectorForce.Visible: boolean = falseWhether the constraint visualization is displayed.
Methods
GetExecutionGroup
VectorForce:GetExecutionGroup(): ExecutionGroup?Returns this instance if it is an ExecutionGroup. Otherwise returns the nearest ancestor ExecutionGroup, or nil when no group contains the instance.
Inherited members
- Properties
- ArchivableClassNameNameParent
- Methods
- AddComponent()AddTag()ClearAllChildren()ClearTags()Clone()Destroy()FindFirstAncestor()FindFirstAncestorOfClass()FindFirstAncestorWhichIsA()FindFirstChild()FindFirstChildOfClass()FindFirstChildWhichIsA()FindFirstDescendant()GetAttribute()GetAttributeChangedSignal()GetAttributes()GetChildren()GetComponent()GetComponentChangedSignal()GetComponents()GetDebugId()GetDescendants()GetFullName()GetPropertyChangedSignal()GetReferencing()GetTags()HasComponent()HasTag()IsA()IsAncestorOf()IsDescendantOf()RemoveComponent()RemoveTag()SetAttribute()WaitForChild()
- Events
- AncestryChangedAttributeChangedChangedChildAddedChildRemovedDescendantAddedDescendantRemovingDestroying