Engine

Attachment

Show Deprecated

An Attachment defines a point and orientation relative to a parent BasePart, Bone, 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.
  • Sound which will use the attachment's position as the sound's focal point, instead of the BasePart center.

Summary

Properties

  • not replicated
    read parallel

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

  • read parallel

    CFrame offset of the attachment.

  • hidden
    not replicated
    read parallel

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

  • hidden
    not replicated
    read parallel

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

  • not replicated
    read parallel

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

  • read parallel

    Toggles the in-experience visibility of the attachment.

  • not replicated
    read parallel

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

  • not replicated
    read parallel

    The exact CFrame of the attachment in world space coordinates.

  • hidden
    not replicated
    read parallel

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

  • hidden
    not replicated
    read parallel

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

  • not replicated
    read parallel

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

Methods

Properties

not replicated
read parallel

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

CFrame

read parallel

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

hidden
not replicated
read parallel

Orientation of the attachment relative to the orientation of its parent. Rotations are in ZXY order.

Position

hidden
not replicated
read parallel

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

SecondaryAxis

not replicated
read parallel

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

Visible

read parallel

Toggles the in-experience visibility of the attachment.

WorldAxis

not replicated
read parallel

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

WorldCFrame

not replicated
read parallel

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.

WorldOrientation

hidden
not replicated
read parallel

Orientation of the attachment relative to the world rather than its own parent. Rotations are in ZXY order.

WorldPosition

hidden
not replicated
read parallel

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

WorldSecondaryAxis

not replicated
read parallel

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

Methods

GetConstraints

Returns a list of Constraints connected to the attachment.


Returns

Events