We use cookies on this site to enhance your user experience
Collapse Sidebar

Attachment

Deprecated

Attachment

Deprecated

An Attachment is a special class used by constraint based objects. It represents an offset relative to the object it is parented to, in both its Attachment/Position and Attachment/Orientation properties.

The Position/Orientation properties of this object correspond with the object’s CFrame property, which are then outputted in real time to the WorldPosition and WorldOrientation properties.


Properties

Vector3

Axis

[NotReplicated]

Represents the direction of the X-Axis, relative to the Attachment’s Attachment/Rotation, as a unit Vector3 with a length of 1.

CFrame

CFrame

Represents the CFrame offset of the Attachment.

Vector3

Orientation

[NotReplicated]

A Vector3 that describes the orientation of the Attachment relative to the orientation of its parent, in degrees. Rotations are applied in Z, X, Y order.

Vector3

Position

[NotReplicated]

A Vector3 that describes the positional offset of the Attachment, relative to the position and orientation of its parent.

Vector3

Rotation

[NotReplicated]

A Vector3 that describes the rotation of the Attachment relative to the rotation of its parent, in degrees. Rotations are applied in Z, Y, X order.

Vector3

SecondaryAxis

[NotReplicated]

Represents the direction of the Y-Axis, relative to the Attachment’s Attachment/Rotation, as a unit Vector3 with a length of 1.

bool

Visible

Toggles the visibility of the Attachment in-game.

Vector3

WorldAxis

[ReadOnly] [NotReplicated]

Represents the direction of the Attachment’s X-Axis relative to the world, as a unit Vector3 with a length of 1.

CFrame

WorldCFrame

[ReadOnly] [NotReplicated]

Describes the exact CFrame of the attachment in world-space coordinates.

Vector3

WorldOrientation

[ReadOnly] [NotReplicated]

Describes the orientation (in degrees) of the attachment relative to the world, rather than the parent of the Attachment.

Rotations are described in Z, X, Y order.

Vector3

WorldPosition

[ReadOnly] [NotReplicated]

Describes the position of the attachment relative to the world, rather than the parent of the Attachment.

Vector3

WorldSecondaryAxis

[ReadOnly] [NotReplicated]

Represents the direction of the Y-Axis of the Attachment, relative to the world, as a unit Vector3 with a length of 1.

Inherited from Instance: Show Hide

int

DataCost

[ReadOnly] [NotReplicated]
The cost of saving the instance using data persistence.
Instance

Parent

Determines the hierarchical parent of the `Instance`.
bool

RobloxLocked

If true, the `Instance` and its descendants cannot be indexed or edited by a `Script` or `LocalScript` and will throw an error if it is attempted.
string

ClassName

[ReadOnly] [NotReplicated]
A read-only string representing the class this `Instance` belongs to.
string

Name

A non-unique identifier of the `Instance`.
bool

Archivable

Determines if an `Instance` can be cloned using `/Instance/Clone` or saved to file.

Functions

Vector3

GetAxis ( )

Returns the value of the Attachment’s Attachment/Axis.

Vector3

GetSecondaryAxis ( )

Returns the value of the Attachment’s Attachment/SecondaryAxis.

void

SetAxis ( Vector3 axis )

Sets the value of the Attachment’s Attachment/Axis.

void

SetSecondaryAxis ( Vector3 axis )

Sets the value of the Attachment’s Attachment/SecondaryAxis.

Inherited from Instance: Show Hide

Array

GetDescendants ( )

[CustomLuaState]
Returns an array containing all of the `Instance`'s descendants.
bool

IsAncestorOf ( Instance descendant )

Returns true if an `Instance` is an ancestor of the given descendant.
bool

IsDescendantOf ( Instance ancestor )

Returns true if an `Instance` is a descendant of the given ancestor.
Instance

FindFirstChildWhichIsA ( string className , bool recursive )

Returns the first child of the `Instance` for whom `Instance/IsA` returns true for the given className.
Instance

FindFirstChildOfClass ( string className )

Returns the first child of the `Instance` whose `Instance/ClassName|ClassName` is equal to the given className.
Instance

FindFirstChild ( string name , bool recursive )

Returns the first child of the `Instance` found with the given name.
Instance

FindFirstAncestorWhichIsA ( string className )

Returns the first ancestor of the `Instance` for whom `Instance/IsA` returns true for the given className.
Instance

FindFirstAncestorOfClass ( string className )

Returns the first ancestor of the `Instance` whose `Instance/ClassName` is equal to the given className.
Instance

FindFirstAncestor ( string name )

Returns the first ancestor of the `Instance` whose `Instance/Name` is equal to the given name.
bool

IsA ( string className )

Returns true if an `Instance`'s class matches or inherits from a given class
Instance

WaitForChild ( string childName , double timeOut )

[CustomLuaState] [CanYield]
Returns the child of the `Instance` with the given name. If the child does not exist, it will yield the current thread until it does.
RBXScriptSignal

GetPropertyChangedSignal ( string property )

Get an event that fires when a given property of an object changes.
string

GetFullName ( )

Returns a string showing the `Instance`'s ancestry.
string

GetDebugId ( int scopeLength )

[NotBrowsable]
Returns a coded string of the `Instance`s DebugId used internally by Roblox.
Objects

GetChildren ( )

Returns an array containing all of the `Instance`'s children.
void

Destroy ( )

Sets the `Instance/Parent` property to nil, locks the `Instance/Parent` property, disconnects all connections and calls Destroy on all children.
Instance

Clone ( )

Create a deep copy of a Roblox instance and descendants where `Archivable = true`.
void

ClearAllChildren ( )

This function destroys all of an `Instance`'s children.

Events

Inherited from Instance: Show Hide

RBXScriptSignal

AncestryChanged ( Instance child , Instance parent )

Fires when the `Instance/Parent` property of the object or one of its ancestors is changed.
RBXScriptSignal

ChildAdded ( Instance child )

Fires when an object is parented to this `Instance`.
RBXScriptSignal

ChildRemoved ( Instance child )

Fires when a child is removed from this `Instance`.
RBXScriptSignal

DescendantAdded ( Instance descendant )

Fires when a descendant is added to the `Instance`.
RBXScriptSignal

DescendantRemoving ( Instance descendant )

Fires immediately before a descendant of the `Instance` is removed.
RBXScriptSignal

Changed ( string property )

Fired immediately after a property of an object changes.