Attachment
An Attachment defines a point and orientation relative to a parent BasePart or another Attachment. The offset is stored in the CFrame property. The offset can also be set through other properties, such as WorldCFrame.
Attachments are used by several kinds of Constraints and are also valid alternatives to BasePart as a parent for objects such as:
- ParticleEmitters which will emit particles from the attachment's specific position/orientation instead of the BasePart bounds.
- Light-emitting objects like PointLight and SpotLight which will shine from the attachment's position/orientation instead of the BasePart center.
Summary
Properties
Direction of the X axis of the attachment, represented as a unit Vector3.
Orientation of the attachment relative to the orientation of its parent.
Positional offset of the attachment, relative to the position and orientation of its parent.
Direction of the Y axis of the attachment, represented as a unit Vector3.
Direction of the X axis of the attachment relative to the world, represented as a unit Vector3 with a length of 1.
The exact CFrame of the attachment in world space coordinates.
Orientation of the attachment relative to the world rather than its own parent.
Position of the attachment relative to the world rather than its own parent.
Direction of the Y axis of the attachment relative to the world, represented as a unit Vector3 with a length of 1.
Methods
Events
Properties
Axis
Direction of the X axis of the attachment, represented as a unit Vector3.
CFrame
The CFrame offset of the attachment. Changes to this property will reflect onto the Attachment.Position and Attachment.Rotation properties of this object. Similarly, a change to either of those properties will reflect onto this property.
Orientation
Orientation of the attachment relative to the orientation of its parent. Rotations are in Z, X, Y order.
Position
Positional offset of the attachment, relative to the position and orientation of its parent.
SecondaryAxis
Direction of the Y axis of the attachment, represented as a unit Vector3.
Visible
Toggles the in-experience visibility of the attachment.
WorldAxis
Direction of the X axis of the attachment relative to the world, represented as a unit Vector3 with a length of 1.
WorldCFrame
WorldOrientation
Orientation of the attachment relative to the world rather than its own parent. Rotations are in Z, X, Y order.
WorldPosition
Position of the attachment relative to the world rather than its own parent.
WorldSecondaryAxis
Direction of the Y axis of the attachment relative to the world, represented as a unit Vector3 with a length of 1.