Attachment

Supported Class Physics

Defines a point and orientation relative to an ancestor PVInstance, Bone, or another Attachment.

17 Nova members · 1 modern Roblox members not implemented yet

Description

An Attachment defines a point and orientation relative to an ancestor PVInstance, Bone, or another Attachment. The offset is stored in the CFrame property. The offset can also be set through other properties, such as WorldCFrame.

If no ancestral PVInstance or Attachment exists, then CFrame and WorldCFrame are the same.

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.

• AudioEmitter which will use the attachment's position as the audio's point of emission.

Inheritance

Object → Instance → Attachment

Nova inheritance: Instance → Attachment

Known subclasses: Bone

Properties

Axis Supported Property Direction of the X axis of the attachment, represented as a unit Vector3.

Axis: Vector3

Direction of the X axis of the attachment, represented as a unit Vector3. Together with SecondaryAxis, this property defines the orientation of the attachment. Setting Axis automatically re-projects SecondaryAxis onto the plane perpendicular to the new axis so the two always remain orthogonal.

The default value is (1, 0, 0).

Roblox documentation

CFrame Supported Property CFrame offset of the attachment.

CFrame: CoordinateFrame

The CFrame offset of the attachment. Changes to this property will reflect onto the Position and Rotation properties of this object. Similarly, a change to either of those properties will reflect onto this property.

Roblox reference signature

CFrame: CFrame

Roblox documentation

Orientation Supported Property Orientation of the attachment relative to the orientation of its parent.

Orientation: Vector3

Orientation of the attachment relative to the orientation of its parent. Rotations are in Z, X, Y order.

Roblox documentation

Position Supported Property Positional offset of the attachment, relative to the position and orientation of its parent.

Position: Vector3

Positional offset of the attachment, relative to the position and orientation of its parent. This value corresponds to the translational component of CFrame; changing either property updates the other. The offset is expressed in the local coordinate space of the parent BasePart, Bone, or Attachment.

The default value is (0, 0, 0).

Roblox documentation

Rotation Supported Property Deprecated Rotation of the attachment relative to the rotation of its parent.

Rotation: Vector3

Rotation of the attachment relative to the rotation of its parent. Rotations are in Z, Y, X order.

Roblox documentation

SecondaryAxis Supported Property Direction of the Y axis of the attachment, represented as a unit Vector3.

SecondaryAxis: Vector3

Direction of the Y axis of the attachment, represented as a unit Vector3. Together with Axis, this property defines the orientation of the attachment. When set, the value is projected onto the plane perpendicular to Axis so the two axes always remain orthogonal; the resulting stored value may therefore differ from the value you assign.

The default value is (0, 1, 0).

Roblox documentation

Visible Supported Property Toggles the in-experience visibility of the attachment.

Visible: bool

Toggles the in-experience visibility of the attachment. When set to true, the attachment renders as a small green sphere at its world position during gameplay. This is useful for debugging constraint setups or verifying attachment placement without needing Studio's constraint detail overlays.

The default value is false.

Roblox documentation

WorldAxis Supported Property Direction of the X axis of the attachment relative to the world, represented as a unit Vector3 with a length of 1.

WorldAxis: Vector3

Direction of the X axis of the attachment relative to the world, represented as a unit Vector3 with a length of 1. This is the world-space equivalent of Axis, computed by transforming the local axis through the parent's CFrame. Setting this property converts the supplied direction into the parent's local space and updates Axis accordingly.

Roblox documentation

WorldCFrame Supported Property The exact CFrame of the attachment in world space coordinates.

WorldCFrame: CoordinateFrame

The exact CFrame of the attachment in world space coordinates, independent of its parent. The value of this property is equivalent to multiplying the CFrame of the attachment's parent by its own CFrame.

Roblox reference signature

WorldCFrame: CFrame

Roblox documentation

WorldOrientation Supported Property Orientation of the attachment relative to the world rather than its own parent.

WorldOrientation: Vector3

Orientation of the attachment relative to the world rather than its own parent. Rotations are in Z, X, Y order.

Roblox documentation

WorldPosition Supported Property Position of the attachment relative to the world rather than its own parent.

WorldPosition: Vector3

Position of the attachment relative to the world rather than its own parent. This is the world-space equivalent of Position, computed by transforming the local offset through the parent's CFrame. Setting this property converts the supplied position into the parent's local space and updates Position accordingly.

Roblox documentation

WorldRotation Supported Property Deprecated Rotation of the attachment relative to the world rather than its own parent.

WorldRotation: Vector3

Rotation of the attachment relative to the world rather than its own parent.

Roblox documentation

WorldSecondaryAxis Supported Property Direction of the Y axis of the attachment relative to the world, represented as a unit Vector3 with a length of 1.

WorldSecondaryAxis: Vector3

Direction of the Y axis of the attachment relative to the world, represented as a unit Vector3 with a length of 1. This is the world-space equivalent of SecondaryAxis, computed by transforming the local secondary axis through the parent's CFrame. Setting this property converts the supplied direction into the parent's local space and updates SecondaryAxis accordingly.

Roblox documentation

Methods

GetAxis Supported Function Deprecated Returns the value of the attachment's Axis.

Attachment:GetAxis(): Vector3

Returns the value of the attachment's Axis.

Nova behaviour: Nova keeps this legacy member for compatibility. Roblox's modern deprecation wording may describe later Roblox behaviour; verify it against Nova before relying on the copied text.

Roblox documentation

GetSecondaryAxis Supported Function Deprecated Returns the value of the attachment's SecondaryAxis.

Attachment:GetSecondaryAxis(): Vector3

Returns the value of the attachment's SecondaryAxis.

Nova behaviour: Nova keeps this legacy member for compatibility. Roblox's modern deprecation wording may describe later Roblox behaviour; verify it against Nova before relying on the copied text.

Roblox documentation

SetAxis Supported Function Deprecated Sets the value of the attachment's Axis.

Attachment:SetAxis(Vector3 axis)

Sets the value of the attachment's Axis.

Roblox reference signature

Attachment:SetAxis(axis: Vector3): null

Nova behaviour: Nova keeps this legacy member for compatibility. Roblox's modern deprecation wording may describe later Roblox behaviour; verify it against Nova before relying on the copied text.

Roblox documentation

SetSecondaryAxis Supported Function Deprecated Sets the value of the attachment's SecondaryAxis.

Attachment:SetSecondaryAxis(Vector3 axis)

Sets the value of the attachment's SecondaryAxis.

Roblox reference signature

Attachment:SetSecondaryAxis(axis: Vector3): null

Nova behaviour: Nova keeps this legacy member for compatibility. Roblox's modern deprecation wording may describe later Roblox behaviour; verify it against Nova before relying on the copied text.

Roblox documentation

Inherited members

Inherited from Instance: 8 properties, 36 methods, 7 events. They are documented on the base class page.

1 modern Roblox member(s) are not implemented yet — expand to inspect

Members declared by Roblox's Attachment class (or by a missing base class) that Nova does not expose. Use this list to scope a migration; the compatibility guide has the recommended workaround.

Methods

Member	Signature	Status	Notes	Flags
GetConstraints	Attachment:GetConstraints(): Instances	Not yet	Returns a list of Constraints connected to the attachment.	—

Roblox reference: Attachment

Generated from Nova's API dump and Roblox creator-docs. Nova-only members come from the engine's reflection metadata.