Attachment
Defines a point and orientation relative to an ancestor PVInstance, Bone, or another Attachment.
| Memory category | Instances |
|---|
Member index 18
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.
History 154
- 731 Change PreferredDescriptor of SetSecondaryAxis from to SecondaryAxis
- 731 Change PreferredDescriptor of SetAxis from to Axis
- 731 Change PreferredDescriptor of GetSecondaryAxis from to SecondaryAxis
- 731 Change PreferredDescriptor of GetAxis from to Axis
- 731 Change Default of WorldSecondaryAxis from to Vector3(0, 1, 0)
- 731 Change PreferredDescriptor of from to WorldOrientation
- 731 Change Default of from to Vector3(-0, 0, -0)
- 731 Change Default of from to Vector3(0, 0, 0)
- 731 Change Default of from to Vector3(-0, 0, 0)
- 731 Change Default of WorldCFrame from to CFrame(0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0, 1)
- 731 Change Default of WorldAxis from to Vector3(1, 0, 0)
- 731 Change Default of Visible from to false
- 731 Change Default of SecondaryAxis from to Vector3(0, 1, 0)
- 731 Change PreferredDescriptor of from to Orientation
- 731 Change Default of from to Vector3(-0, 0, -0)
- 731 Change Default of from to Vector3(0, 0, 0)
- 731 Change Default of from to Vector3(-0, 0, 0)
- 731 Change Default of CFrame from to CFrame(0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0, 1)
- 731 Change Default of Axis from to Vector3(1, 0, 0)
- 726 Change PreferredDescriptor of SetSecondaryAxis from SecondaryAxis to
- 726 Change PreferredDescriptor of SetAxis from Axis to
- 726 Change PreferredDescriptor of GetSecondaryAxis from SecondaryAxis to
- 726 Change PreferredDescriptor of GetAxis from Axis to
- 726 Change Default of WorldSecondaryAxis from Vector3(0, 1, 0) to
- 726 Change PreferredDescriptor of from WorldOrientation to
- 726 Change Default of from Vector3(-0, 0, -0) to
- 726 Change Default of from Vector3(0, 0, 0) to
- 726 Change Default of from Vector3(-0, 0, 0) to
- 726 Change Default of WorldCFrame from CFrame(0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0, 1) to
- 726 Change Default of WorldAxis from Vector3(1, 0, 0) to
- 726 Change Default of Visible from false to
- 726 Change Default of SecondaryAxis from Vector3(0, 1, 0) to
- 726 Change PreferredDescriptor of from Orientation to
- 726 Change Default of from Vector3(-0, 0, -0) to
- 726 Change Default of from Vector3(0, 0, 0) to
- 726 Change Default of from Vector3(-0, 0, 0) to
- 726 Change Default of CFrame from CFrame(0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0, 1) to
- 726 Change Default of Axis from Vector3(1, 0, 0) to
- 705 Change Default of WorldCFrame from to CFrame(0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0, 1)
- 705 Change Default of CFrame from to CFrame(0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0, 1)
- 705 Change Default of WorldCFrame from CFrame(0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0, 1) to
- 705 Change Default of CFrame from CFrame(0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0, 1) to
- 702 Change Default of WorldCFrame from to CFrame(0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0, 1)
- 702 Change Default of CFrame from to CFrame(0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0, 1)
- 648 Change ReturnType of GetConstraints from Objects to Instances
- 576 Add GetConstraints
- 573 Change ReturnType of SetSecondaryAxis from void to null
- 573 Change ReturnType of SetAxis from void to null
- 557 Change Tags of from [NotReplicated] to [Hidden, NotReplicated]
- 557 Change CanLoad of from true to false
- 557 Change Tags of from [NotReplicated] to [Hidden, NotReplicated]
- 557 Change CanLoad of from true to false
- 557 Change Tags of from [NotReplicated] to [Hidden, NotReplicated]
- 557 Change CanLoad of from true to false
- 557 Change Tags of from [NotReplicated] to [Hidden, NotReplicated]
- 557 Change CanLoad of from true to false
- 553 Change PreferredDescriptor of SetSecondaryAxis from to SecondaryAxis
- 553 Change PreferredDescriptor of SetAxis from to Axis
- 553 Change PreferredDescriptor of GetSecondaryAxis from to SecondaryAxis
- 553 Change PreferredDescriptor of GetAxis from to Axis
- 553 Change Default of WorldSecondaryAxis from to Vector3(0, 1, 0)
- 553 Change PreferredDescriptor of from to WorldOrientation
- 553 Change Default of from to Vector3(-0, 0, -0)
- 553 Change Default of from to Vector3(0, 0, 0)
- 553 Change Default of from to Vector3(-0, 0, 0)
- 553 Change Default of WorldCFrame from to
- 553 Change Default of WorldAxis from to Vector3(1, 0, 0)
- 553 Change Default of Visible from to false
- 553 Change Default of SecondaryAxis from to Vector3(0, 1, 0)
- 553 Change PreferredDescriptor of from to Orientation
- 553 Change Default of from to Vector3(-0, 0, -0)
- 553 Change Default of from to Vector3(0, 0, 0)
- 553 Change Default of from to Vector3(-0, 0, 0)
- 553 Change Default of CFrame from to
- 553 Change Default of Axis from to Vector3(1, 0, 0)
- 550 Change Category of from Derived Data to Derived World Data
- 550 Change Category of from Data to Transform
- 550 Change Category of from Data to Transform
- 550 Change Category of from Data to Transform
- 550 Change Category of CFrame from Data to Transform
- 486 Change ThreadSafety of WorldSecondaryAxis from ReadOnly to ReadSafe
- 486 Change ThreadSafety of from ReadOnly to ReadSafe
- 486 Change ThreadSafety of from ReadOnly to ReadSafe
- 486 Change ThreadSafety of from ReadOnly to ReadSafe
- 486 Change ThreadSafety of WorldCFrame from ReadOnly to ReadSafe
- 486 Change ThreadSafety of WorldAxis from ReadOnly to ReadSafe
- 486 Change ThreadSafety of Visible from ReadOnly to ReadSafe
- 486 Change ThreadSafety of SecondaryAxis from ReadOnly to ReadSafe
- 486 Change ThreadSafety of from ReadOnly to ReadSafe
- 486 Change ThreadSafety of from ReadOnly to ReadSafe
- 486 Change ThreadSafety of from ReadOnly to ReadSafe
- 486 Change ThreadSafety of CFrame from ReadOnly to ReadSafe
- 486 Change ThreadSafety of Axis from ReadOnly to ReadSafe
- 462 Change ThreadSafety of SetSecondaryAxis from to Unsafe
- 462 Change ThreadSafety of SetAxis from to Unsafe
- 462 Change ThreadSafety of GetSecondaryAxis from to Unsafe
- 462 Change ThreadSafety of GetAxis from to Unsafe
- 462 Change ThreadSafety of WorldSecondaryAxis from to ReadOnly
- 462 Change ThreadSafety of from to ReadOnly
- 462 Change ThreadSafety of from to ReadOnly
- 462 Change ThreadSafety of from to ReadOnly
- 462 Change ThreadSafety of WorldCFrame from to ReadOnly
- 462 Change ThreadSafety of WorldAxis from to ReadOnly
- 462 Change ThreadSafety of Visible from to ReadOnly
- 462 Change ThreadSafety of SecondaryAxis from to ReadOnly
- 462 Change ThreadSafety of from to ReadOnly
- 462 Change ThreadSafety of from to ReadOnly
- 462 Change ThreadSafety of from to ReadOnly
- 462 Change ThreadSafety of CFrame from to ReadOnly
- 462 Change ThreadSafety of Axis from to ReadOnly
- 369 Add
- 369 Add
- 369 Change Tags of SetSecondaryAxis from [] to [Deprecated]
- 369 Change Tags of SetAxis from [] to [Deprecated]
- 369 Change Tags of GetSecondaryAxis from [] to [Deprecated]
- 369 Change Tags of GetAxis from [] to [Deprecated]
- 369 Change Category of WorldSecondaryAxis from Derived Data to Derived World Data
- 369 Change Tags of WorldSecondaryAxis from [ReadOnly, NotReplicated] to [NotReplicated]
- 369 Change CanLoad of WorldSecondaryAxis from false to true
- 369 Remove
- 369 Change CanLoad of from false to true
- 369 Change Tags of from [ReadOnly, NotReplicated] to [NotReplicated]
- 369 Change Category of from Derived Data to Derived World Data
- 369 Change Tags of from [ReadOnly, NotReplicated] to [NotReplicated]
- 369 Change Category of from Derived Data to Derived World Data
- 369 Change CanLoad of from false to true
- 369 Change Tags of WorldCFrame from [ReadOnly, NotReplicated] to [NotReplicated]
- 369 Change CanLoad of WorldCFrame from false to true
- 369 Change Category of WorldCFrame from Derived Data to Derived World Data
- 369 Change Category of WorldAxis from Derived Data to Derived World Data
- 369 Change Tags of WorldAxis from [ReadOnly, NotReplicated] to [NotReplicated]
- 369 Change CanLoad of WorldAxis from false to true
- 369 Remove
- 359 Change CanLoad of SecondaryAxis from false to true
- 359 Change CanLoad of Axis from false to true
- 327 Add WorldCFrame
- 290 Change Tags of from [ReadOnly, NotReplicated] to [ReadOnly, NotReplicated, Deprecated]
- 290 Add
- 290 Add
- 261 Add Visible
- 241 Add SetSecondaryAxis
- 241 Add SetAxis
- 241 Add GetSecondaryAxis
- 241 Add GetAxis
- 241 Add WorldSecondaryAxis
- 241 Add WorldAxis
- 241 Add SecondaryAxis
- 241 Add Axis
- 235 Add
- 235 Add
- 235 Add
- 235 Add
- 235 Add CFrame
- 235 Add Attachment
Members 18
Axis
| Type | Default | |
|---|---|---|
| Vector3 | 1, 0, 0 | |
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).
This property is not replicated. Its interface does not cross the network boundary.
| Thread safety | ReadSafe |
|---|---|
| Category | Derived Data |
| Loaded/Saved | true/false |
History 7
- 731 Change Default of Axis from to Vector3(1, 0, 0)
- 726 Change Default of Axis from Vector3(1, 0, 0) to
- 553 Change Default of Axis from to Vector3(1, 0, 0)
- 486 Change ThreadSafety of Axis from ReadOnly to ReadSafe
- 462 Change ThreadSafety of Axis from to ReadOnly
- 359 Change CanLoad of Axis from false to true
- 241 Add Axis
CFrame
| Type | Default | |
|---|---|---|
| CFrame | 0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0, 1 | |
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.
| Thread safety | ReadSafe |
|---|---|
| Category | Transform |
| Loaded/Saved | true |
History 10
- 731 Change Default of CFrame from to CFrame(0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0, 1)
- 726 Change Default of CFrame from CFrame(0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0, 1) to
- 705 Change Default of CFrame from to CFrame(0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0, 1)
- 705 Change Default of CFrame from CFrame(0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0, 1) to
- 702 Change Default of CFrame from to CFrame(0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0, 1)
- 553 Change Default of CFrame from to
- 550 Change Category of CFrame from Data to Transform
- 486 Change ThreadSafety of CFrame from ReadOnly to ReadSafe
- 462 Change ThreadSafety of CFrame from to ReadOnly
- 235 Add CFrame
GetAxis
| Parameters (0) | ||
|---|---|---|
| No parameters. | ||
| Returns (1) | ||
| Vector3 | ||
Returns the value of the attachment's Axis.
This function is deprecated. It exists only for backward compatibility, and should not be used for new work. Axis should be used instead.
| Thread safety | Unsafe |
|---|
GetConstraints
| Parameters (0) | ||
|---|---|---|
| No parameters. | ||
| Returns (1) | ||
| Instances | ||
Returns a list of Constraints that use this attachment as either Attachment0 or Attachment1. The returned array is a snapshot at the time of the call; subsequent changes to constraint connections are not reflected in a previously returned array.
| Thread safety | Unsafe |
|---|
History 2
- 648 Change ReturnType of GetConstraints from Objects to Instances
- 576 Add GetConstraints
GetSecondaryAxis
| Parameters (0) | ||
|---|---|---|
| No parameters. | ||
| Returns (1) | ||
| Vector3 | ||
Returns the value of the attachment's SecondaryAxis.
This function is deprecated. It exists only for backward compatibility, and should not be used for new work. SecondaryAxis should be used instead.
| Thread safety | Unsafe |
|---|
History 6
- 731 Change PreferredDescriptor of GetSecondaryAxis from to SecondaryAxis
- 726 Change PreferredDescriptor of GetSecondaryAxis from SecondaryAxis to
- 553 Change PreferredDescriptor of GetSecondaryAxis from to SecondaryAxis
- 462 Change ThreadSafety of GetSecondaryAxis from to Unsafe
- 369 Change Tags of GetSecondaryAxis from [] to [Deprecated]
- 241 Add GetSecondaryAxis
SecondaryAxis
| Type | Default | |
|---|---|---|
| Vector3 | 0, 1, 0 | |
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).
This property is not replicated. Its interface does not cross the network boundary.
| Thread safety | ReadSafe |
|---|---|
| Category | Derived Data |
| Loaded/Saved | true/false |
History 7
- 731 Change Default of SecondaryAxis from to Vector3(0, 1, 0)
- 726 Change Default of SecondaryAxis from Vector3(0, 1, 0) to
- 553 Change Default of SecondaryAxis from to Vector3(0, 1, 0)
- 486 Change ThreadSafety of SecondaryAxis from ReadOnly to ReadSafe
- 462 Change ThreadSafety of SecondaryAxis from to ReadOnly
- 359 Change CanLoad of SecondaryAxis from false to true
- 241 Add SecondaryAxis
SetAxis
| Parameters (1) | ||
|---|---|---|
| axis | Vector3 | |
| Returns (1) | ||
| null | ||
Sets the value of the attachment's Axis.
This function is deprecated. It exists only for backward compatibility, and should not be used for new work. Axis should be used instead.
| Thread safety | Unsafe |
|---|
History 7
- 731 Change PreferredDescriptor of SetAxis from to Axis
- 726 Change PreferredDescriptor of SetAxis from Axis to
- 573 Change ReturnType of SetAxis from void to null
- 553 Change PreferredDescriptor of SetAxis from to Axis
- 462 Change ThreadSafety of SetAxis from to Unsafe
- 369 Change Tags of SetAxis from [] to [Deprecated]
- 241 Add SetAxis
SetSecondaryAxis
| Parameters (1) | ||
|---|---|---|
| axis | Vector3 | |
| Returns (1) | ||
| null | ||
Sets the value of the attachment's SecondaryAxis.
This function is deprecated. It exists only for backward compatibility, and should not be used for new work. SecondaryAxis should be used instead.
| Thread safety | Unsafe |
|---|
History 7
- 731 Change PreferredDescriptor of SetSecondaryAxis from to SecondaryAxis
- 726 Change PreferredDescriptor of SetSecondaryAxis from SecondaryAxis to
- 573 Change ReturnType of SetSecondaryAxis from void to null
- 553 Change PreferredDescriptor of SetSecondaryAxis from to SecondaryAxis
- 462 Change ThreadSafety of SetSecondaryAxis from to Unsafe
- 369 Change Tags of SetSecondaryAxis from [] to [Deprecated]
- 241 Add SetSecondaryAxis
Visible
| Type | Default | |
|---|---|---|
| bool | false | |
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.
| Thread safety | ReadSafe |
|---|---|
| Category | Appearance |
| Loaded/Saved | true |
WorldAxis
| Type | Default | |
|---|---|---|
| Vector3 | 1, 0, 0 | |
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.
This property is not replicated. Its interface does not cross the network boundary.
| Thread safety | ReadSafe |
|---|---|
| Category | Derived World Data |
| Loaded/Saved | true/false |
History 9
- 731 Change Default of WorldAxis from to Vector3(1, 0, 0)
- 726 Change Default of WorldAxis from Vector3(1, 0, 0) to
- 553 Change Default of WorldAxis from to Vector3(1, 0, 0)
- 486 Change ThreadSafety of WorldAxis from ReadOnly to ReadSafe
- 462 Change ThreadSafety of WorldAxis from to ReadOnly
- 369 Change Category of WorldAxis from Derived Data to Derived World Data
- 369 Change Tags of WorldAxis from [ReadOnly, NotReplicated] to [NotReplicated]
- 369 Change CanLoad of WorldAxis from false to true
- 241 Add WorldAxis
WorldCFrame
| Type | Default | |
|---|---|---|
| CFrame | 0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0, 1 | |
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.
This property is not replicated. Its interface does not cross the network boundary.
| Thread safety | ReadSafe |
|---|---|
| Category | Derived World Data |
| Loaded/Saved | true/false |
History 12
- 731 Change Default of WorldCFrame from to CFrame(0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0, 1)
- 726 Change Default of WorldCFrame from CFrame(0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0, 1) to
- 705 Change Default of WorldCFrame from to CFrame(0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0, 1)
- 705 Change Default of WorldCFrame from CFrame(0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0, 1) to
- 702 Change Default of WorldCFrame from to CFrame(0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0, 1)
- 553 Change Default of WorldCFrame from to
- 486 Change ThreadSafety of WorldCFrame from ReadOnly to ReadSafe
- 462 Change ThreadSafety of WorldCFrame from to ReadOnly
- 369 Change Tags of WorldCFrame from [ReadOnly, NotReplicated] to [NotReplicated]
- 369 Change CanLoad of WorldCFrame from false to true
- 369 Change Category of WorldCFrame from Derived Data to Derived World Data
- 327 Add WorldCFrame
WorldSecondaryAxis
| Type | Default | |
|---|---|---|
| Vector3 | 0, 1, 0 | |
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.
This property is not replicated. Its interface does not cross the network boundary.
| Thread safety | ReadSafe |
|---|---|
| Category | Derived World Data |
| Loaded/Saved | true/false |
History 9
- 731 Change Default of WorldSecondaryAxis from to Vector3(0, 1, 0)
- 726 Change Default of WorldSecondaryAxis from Vector3(0, 1, 0) to
- 553 Change Default of WorldSecondaryAxis from to Vector3(0, 1, 0)
- 486 Change ThreadSafety of WorldSecondaryAxis from ReadOnly to ReadSafe
- 462 Change ThreadSafety of WorldSecondaryAxis from to ReadOnly
- 369 Change Category of WorldSecondaryAxis from Derived Data to Derived World Data
- 369 Change Tags of WorldSecondaryAxis from [ReadOnly, NotReplicated] to [NotReplicated]
- 369 Change CanLoad of WorldSecondaryAxis from false to true
- 241 Add WorldSecondaryAxis