Open Asterune
PlaneConstraint

PlaneConstraint

Restricts motion to a plane defined by an attachment.

Creatable
Instance.new("PlaneConstraint")
Inherits
ConstraintInstance
Replication
Standard

Behavior

PlaneConstraint restricts motion to a plane defined by an attachment.

Summary

Members7
Properties6
Methods1

Properties

Active

PlaneConstraint.Active: boolean = false

Whether the constraint is currently active in the physics simulation.

Attachment0

PlaneConstraint.Attachment0: Attachment? = nil

The first attachment used by the constraint or effect.

Attachment1

PlaneConstraint.Attachment1: Attachment? = nil

The second attachment used by the constraint or effect.

Color

PlaneConstraint.Color: Color3 = Color3.new(1, 0.686, 0)

The color of the constraint visualization.

Enabled

PlaneConstraint.Enabled: boolean = true

Whether the physics solver processes this constraint.

Visible

PlaneConstraint.Visible: boolean = false

Whether the constraint visualization is displayed.

Methods

GetExecutionGroup

PlaneConstraint: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

Inherited47
Instance47
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

Related APIs

Constraint