Attachment

Defines a local position and orientation for effects, constraints, and rig controls.

Creatable: Instance.new("Attachment")
Inherits: Instance
Replication: Standard

Behavior

Attachment defines a local position and orientation for effects, constraints, and rig controls.

Summary

Members15

Properties12

Axis: Vector3 = Vector3.new(1, 0, 0)parallel read
The attachment's primary local axis.
CFrame: CFrame = CFrame.new(0, 0, 0)parallel readreplicates
The local position and orientation relative to the parent.
CoordinateFrame: CFrameparallel read
Compatibility spelling of CFrame.
Locked: boolean = falseparallel readreplicates
Whether the attachment is locked against editor manipulation.
Position: Vector3 = Vector3.new(0, 0, 0)parallel readreplicates
The local attachment position relative to the parent.
Rotation: Vector3 = Vector3.new(0, 0, 0)parallel readreplicates
The local attachment orientation in degrees.
SecondaryAxis: Vector3 = Vector3.new(0, 1, 0)parallel read
The attachment's secondary local axis.
Visible: boolean = falseparallel readreplicates
Whether the attachment or adornment visualization is displayed.
WorldAxis: Vector3 = Vector3.new(1, 0, 0)parallel readread only
The attachment's primary axis in world space.
WorldPosition: Vector3 = Vector3.new(0, 0, 0)parallel readread only
The attachment position in world space.
WorldRotation: Vector3 = Vector3.new(0, 0, 0)parallel readread only
The attachment orientation in world space, in degrees.
WorldSecondaryAxis: Vector3 = Vector3.new(0, 1, 0)parallel readread only
The attachment's secondary axis in world space.

Methods3

GetExecutionGroup(): ExecutionGroup?parallel read
Returns this instance if it is an ExecutionGroup.
SetAxes(axis: Vector3, secondaryAxis: Vector3): ()serial only
Sets the attachment's primary and secondary local axes.
SetAxis(axis: Vector3): ()serial only
Sets the attachment's primary local axis.

Properties

Axis

Attachment.Axis: Vector3 = Vector3.new(1, 0, 0)

The attachment's primary local axis.

CFrame

Attachment.CFrame: CFrame = CFrame.new(0, 0, 0)

The local position and orientation relative to the parent.

CoordinateFrame

Attachment.CoordinateFrame: CFrame

Compatibility spelling of CFrame. Use CFrame in new code.

Locked

Attachment.Locked: boolean = false

Whether the attachment is locked against editor manipulation.

Position

Attachment.Position: Vector3 = Vector3.new(0, 0, 0)

The local attachment position relative to the parent.

Rotation

Attachment.Rotation: Vector3 = Vector3.new(0, 0, 0)

The local attachment orientation in degrees.

SecondaryAxis

Attachment.SecondaryAxis: Vector3 = Vector3.new(0, 1, 0)

The attachment's secondary local axis.

Visible

Attachment.Visible: boolean = false

Whether the attachment or adornment visualization is displayed.

WorldAxis

Attachment.WorldAxis: Vector3 = Vector3.new(1, 0, 0)

The attachment's primary axis in world space.

WorldPosition

Attachment.WorldPosition: Vector3 = Vector3.new(0, 0, 0)

The attachment position in world space.

WorldRotation

Attachment.WorldRotation: Vector3 = Vector3.new(0, 0, 0)

The attachment orientation in world space, in degrees.

WorldSecondaryAxis

Attachment.WorldSecondaryAxis: Vector3 = Vector3.new(0, 1, 0)

The attachment's secondary axis in world space.

Methods

GetExecutionGroup

Attachment:GetExecutionGroup(): ExecutionGroup?

Returns this instance if it is an ExecutionGroup. Otherwise returns the nearest ancestor ExecutionGroup, or nil when no group contains the instance.

SetAxes

Attachment:SetAxes(axis: Vector3, secondaryAxis: Vector3): ()

Sets the attachment's primary and secondary local axes.

SetAxis

Attachment:SetAxis(axis: Vector3): ()

Sets the attachment's primary local axis.

Inherited members

Instance

Attachment

BehaviorCopy link

SummaryCopy link

PropertiesCopy link

AxisCopy link

CFrameCopy link

CoordinateFrameCopy link

LockedCopy link

PositionCopy link

RotationCopy link

SecondaryAxisCopy link

VisibleCopy link

WorldAxisCopy link

WorldPositionCopy link

WorldRotationCopy link

WorldSecondaryAxisCopy link

MethodsCopy link

GetExecutionGroupCopy link

SetAxesCopy link

SetAxisCopy link

Inherited membersCopy link

Related APIsCopy link