A **CylindricalConstraint** allows its attachments to slide along one axis and
rotate about another axis. It can be thought of like a combination of a
`Class.PrismaticConstraint` and a `Class.HingeConstraint`. The sliding axis is
determined by the **X** axis of the constraint's
`Class.Constraint.Attachment0|Attachment0`. The rotation axis is centered at
the constraint's `Class.Constraint.Attachment1|Attachment1` and is angled off
of the sliding constraint by the constraint's
`Class.CylindricalConstraint.InclinationAngle|InclinationAngle`.

This constraint, along with a `Class.SpringConstraint`, is ideal for building
vehicle suspension.

Note that if this constraint attaches one part (**A**) to another part (**B**)
that is anchored or connected to an anchored part (**Z**), part **A** will not
be locally simulated when interacting with a player.

When configuring this constraint, it may be helpful to study
[Roblox Units](/physics/units) to understand how Roblox units
compare to metric units.

#### Angular Power

If a cylindrical's
`Class.CylindricalConstraint.AngularActuatorType|AngularActuatorType` is set
to `Enum.ActuatorType|Motor`, it attempts to rotate the attachments with the
goal of reaching its
`Class.CylindricalConstraint.AngularVelocity|AngularVelocity`. You can further
control this rotation through both
`Class.CylindricalConstraint.MotorMaxAngularAcceleration|MotorMaxAngularAcceleration`
and `Class.CylindricalConstraint.MotorMaxTorque|MotorMaxTorque`. If a
cylindrical's
`Class.CylindricalConstraint.AngularActuatorType|AngularActuatorType` is set
to `Enum.ActuatorType|Servo`, it attempts to rotate to an angle specified by
`Class.CylindricalConstraint.TargetAngle|TargetAngle`. This rotation is
controlled by `Class.CylindricalConstraint.AngularSpeed|AngularSpeed`,
`Class.CylindricalConstraint.AngularResponsiveness|AngularResponsiveness`, and
`Class.CylindricalConstraint.ServoMaxTorque|ServoMaxTorque`.

#### Linear Power

If a cylindrical's `Class.CylindricalConstraint|ActuatorType` is set to
`Enum.ActuatorType|Motor`, it attempts to translate the attachments with the
goal of reaching `Class.CylindricalConstraint|Velocity`. You can further
control this translation through both
`Class.CylindricalConstraint|MotorMaxAcceleration` and
`Class.CylindricalConstraint|MotorMaxForce`. If a cylindrical's
`Class.CylindricalConstraint|ActuatorType` is set to
`Enum.ActuatorType|Servo`, it attempts to translate the attachments to a set
separation specified by `Class.CylindricalConstraint|TargetPosition`. This
translation is controlled by `Class.CylindricalConstraint|Speed`,
`Class.CylindricalConstraint|LinearResponsiveness`, and
`Class.CylindricalConstraint|ServoMaxForce`.

#### Limits

You can set limits to restrict both the **sliding range** and **rotation** of
a cylindrical constraint. Enabling the
`Class.CylindricalConstraint|LimitsEnabled` property exposes the
`Class.CylindricalConstraint|LowerLimit` and
`Class.CylindricalConstraint|UpperLimit` values, as well as
`Class.CylindricalConstraint|Restitution` which defines the elasticity of the
attachments when they reach either limit. Enabling the
`Class.CylindricalConstraint.AngularLimitsEnabled|AngularLimitsEnabled`
property exposes the `Class.CylindricalConstraint.LowerAngle|LowerAngle` and
`Class.CylindricalConstraint.UpperAngle|UpperAngle` limits, as well as
`Class.CylindricalConstraint.AngularRestitution|AngularRestitution` which
defines the elasticity of the attachments when they reach either limit.

#### Inclination Angle

`Class.CylindricalConstraint.InclinationAngle|InclinationAngle` defines the
direction of the rotation axis as an angle from the **X** axis in the **XY**
plane of `Class.Constraint.Attachment0|Attachment0`, from
-180&nbsp;to&nbsp;180. This lets you tilt the rotating element without
changing the sliding axis.


CylindricalConstraint

If a cylindrical's
`Class.CylindricalConstraint.AngularActuatorType|AngularActuatorType` is
set to `Enum.ActuatorType|Motor`, it attempts to rotate the attachments
with the goal of reaching its
`Class.CylindricalConstraint.AngularVelocity|AngularVelocity`. You can
further control this rotation through both
`Class.CylindricalConstraint.MotorMaxAngularAcceleration|MotorMaxAngularAcceleration`
and `Class.CylindricalConstraint.MotorMaxTorque|MotorMaxTorque`.

If a cylindrical's
`Class.CylindricalConstraint.AngularActuatorType|AngularActuatorType` is
set to `Enum.ActuatorType|Servo`, it attempts to rotate to an angle
specified by `Class.CylindricalConstraint.TargetAngle|TargetAngle`. This
rotation is controlled by
`Class.CylindricalConstraint.AngularSpeed|AngularSpeed`,
`Class.CylindricalConstraint.AngularResponsiveness|AngularResponsiveness`,
and `Class.CylindricalConstraint.ServoMaxTorque|ServoMaxTorque`.


CylindricalConstraint.AngularActuatorType

Enables the angular limits around the rotation axis.


CylindricalConstraint.AngularLimitsEnabled

This property specifies the sharpness of the angular servo motor in
reaching the `Class.CylindricalConstraint.TargetAngle|TargetAngle`, when
`Class.CylindricalConstraint.AngularActuatorType|AngularActuatorType` is
set to `Enum.ActuatorType|Servo`. Larger values correspond to a faster
response and smaller values results in more damping and a slower response.


CylindricalConstraint.AngularResponsiveness

Specifies the sharpness of the angular servo motor in reaching the
`Class.CylindricalConstraint.TargetAngle|TargetAngle`.


Restitution of the two limits, or how elastic they are. Constrained
between 0 and 1.


CylindricalConstraint.AngularRestitution

Restitution of the two limits, or how elastic they are.


Target angular speed. This value is unsigned as the servo will always move
toward its target. In radians per second.


CylindricalConstraint.AngularSpeed

The target angular velocity of the motor in radians per second around the
rotation axis.


CylindricalConstraint.AngularVelocity

Signed angle (in degrees) between the reference axis and the secondary
axis of `Class.Constraint.Attachment1|Attachment1` around the rotation
axis. Valid range between -180 and 180.


CylindricalConstraint.CurrentAngle

Signed angle (in degrees) between the reference axis and the secondary
axis of `Class.Constraint.Attachment1|Attachment1` around the rotation
axis.


Direction of the rotation axis as an angle from the **X** axis in the
**XY** plane of `Class.Constraint.Attachment0|Attachment0`. Valid range
between -180 and 180.


CylindricalConstraint.InclinationAngle

Direction of the rotation axis as an angle from the **X** axis in the
**XY** plane of `Class.Constraint.Attachment0|Attachment0`.


Lower limit for the angle (in degrees) between the reference axis and the
SecondaryAxis of `Class.Constraint.Attachment1|Attachment1` around the
rotation axis. Valid range between -180 and 180.


CylindricalConstraint.LowerAngle

Lower limit for the angle (in degrees) between the reference axis and the
SecondaryAxis of `Class.Constraint.Attachment1|Attachment1` around the
rotation axis.


The maximum angular acceleration of the motor in radians per second
squared.


CylindricalConstraint.MotorMaxAngularAcceleration

The maximum torque the motor can apply to achieve the target angular
velocity. Units are mass&nbsp;&times;&nbsp;studs&sup2;/second&sup2;.


CylindricalConstraint.MotorMaxTorque

The maximum torque the motor can apply to achieve the target angular
velocity.


Enable the visibility of the rotation axis.


CylindricalConstraint.RotationAxisVisible

Maximum torque the servo motor can apply. Units are
mass&nbsp;&times;&nbsp;studs&sup2;/second&sup2;.


CylindricalConstraint.ServoMaxTorque

Maximum torque the servo motor can apply.


CylindricalConstraint.SoftlockAngularServoUponReachingTarget

Target angle (in degrees) between the reference axis and the secondary
axis of `Class.Constraint.Attachment1|Attachment1` around the rotation
axis. Valid range between -180 and 180.


CylindricalConstraint.TargetAngle

Target angle (in degrees) between the reference axis and the secondary
axis of `Class.Constraint.Attachment1|Attachment1` around the rotation
axis.


Upper limit for the angle (in degrees) between the reference axis and the
secondary axis of `Class.Constraint.Attachment1|Attachment1` around the
rotation axis. Valid range between -180 and 180.


CylindricalConstraint.UpperAngle

Upper limit for the angle (in degrees) between the reference axis and the
secondary axis of `Class.Constraint.Attachment1|Attachment1` around the
rotation axis.


The unit vector direction of the rotation axis in world coordinates.


CylindricalConstraint.WorldRotationAxis

Constrains two attachments on two parts to have a relative linear and
rotational motion.


**SlidingBallConstraint** is the base class for constraints that allow their
attachments to slide along an axis but not rotate, including
`Class.PrismaticConstraint` and `Class.CylindricalConstraint`. This constrains
the attachments so that their **X** axes are collinear but pointing in
opposite directions. It also constrains the attachments so that their **Y**
axes are parallel.

When configuring this constraint, it may be helpful to study
[Roblox Units](/physics/units) to understand how Roblox units
compare to metric units.

#### Linear Power

If this constraint's `Class.SlidingBallConstraint|ActuatorType` is set to
`Enum.ActuatorType|Motor`, it attempts to translate the attachments with the
goal of reaching `Class.SlidingBallConstraint|Velocity`. You can further
control this translation through both
`Class.SlidingBallConstraint|MotorMaxAcceleration` and
`Class.SlidingBallConstraint|MotorMaxForce`.

If this constraint's `Class.SlidingBallConstraint|ActuatorType` is set to
`Enum.ActuatorType|Servo`, it attempts to translate the attachments to a set
separation specified by `Class.SlidingBallConstraint|TargetPosition`. This
translation is controlled by `Class.SlidingBallConstraint|Speed`,
`Class.SlidingBallConstraint|LinearResponsiveness`, and
`Class.SlidingBallConstraint|ServoMaxForce`.

#### Limits

You can set **limits** to restrict this constraint's sliding range. Enabling
the `Class.SlidingBallConstraint|LimitsEnabled` property exposes the
`Class.SlidingBallConstraint|LowerLimit` and
`Class.SlidingBallConstraint|UpperLimit` values, as well as
`Class.SlidingBallConstraint|Restitution` which defines the elasticity of the
attachments when they reach either limit.


SlidingBallConstraint

Sets whether the translation of the `Class.SlidingBallConstraint` is
actuated and, if so, what kind of actuation.

- If `Class.SlidingBallConstraint|ActuatorType` is set to
  `Enum.ActuatorType|None`, the joint can slide freely.

- If `Class.SlidingBallConstraint|ActuatorType` is set to
  `Enum.ActuatorType|Motor`, it attempts to translate the attachments with
  the goal of reaching `Class.SlidingBallConstraint|Velocity`. You can
  further control this translation through both
  `Class.SlidingBallConstraint|MotorMaxAcceleration` and
  `Class.SlidingBallConstraint|MotorMaxForce`.

- If this constraint's `Class.SlidingBallConstraint|ActuatorType` is set
  to `Enum.ActuatorType|Servo`, it attempts to translate the attachments
  to a set separation specified by
  `Class.SlidingBallConstraint|TargetPosition`. This translation is
  controlled by `Class.SlidingBallConstraint|Speed`,
  `Class.SlidingBallConstraint|LinearResponsiveness`, and
  `Class.SlidingBallConstraint|ServoMaxForce`.


SlidingBallConstraint.ActuatorType

Sets whether the translation of the `Class.SlidingBallConstraint` is
actuated and, if so, what kind of actuation.


The current offset between the constraint's
`Class.Attachment|Attachments`.


SlidingBallConstraint.CurrentPosition

Sets whether the `Class.SlidingBallConstraint` will limit the range of
translation. If true, this property exposes the
`Class.SlidingBallConstraint|LowerLimit` and
`Class.SlidingBallConstraint|UpperLimit` values, as well as
`Class.SlidingBallConstraint|Restitution` which defines the elasticity of
the attachments when they reach either limit.


SlidingBallConstraint.LimitsEnabled

Sets whether the `Class.SlidingBallConstraint` will limit the range of
translation.


Specifies the "sharpness" of the linear servo motor in reaching the
`Class.SlidingBallConstraint.TargetPosition|TargetPosition` when the
derived classes' actuator type is set to `Enum.ActuatorType|Servo`. Larger
values correspond to faster a response and smaller values results in more
damping and a slower response.


SlidingBallConstraint.LinearResponsiveness

Specifies the "sharpness" of the linear servo motor in reaching the
`Class.SlidingBallConstraint.TargetPosition|TargetPosition`.


The lower positional limit along the **X** axis of
`Class.Constraint.Attachment0|Attachment0` if
`Class.SlidingBallConstraint.LimitsEnabled|LimitsEnabled` is true.


SlidingBallConstraint.LowerLimit

The constraint's maximum acceleration when
`Class.SlidingBallConstraint.ActuatorType|ActuatorType` is set to
`Enum.ActuatorType|Motor`, as the constraint attempts to reach its desired
`Class.SlidingBallConstraint.Velocity|Velocity`.


SlidingBallConstraint.MotorMaxAcceleration

The constraint's maximum acceleration when
`Class.SlidingBallConstraint.ActuatorType|ActuatorType` is set to
`Enum.ActuatorType|Motor` as the constraint attempts to reach its desired
`Class.SlidingBallConstraint.Velocity|Velocity`.


The constraint's maximum force when
`Class.SlidingBallConstraint.ActuatorType|ActuatorType` is set to
`Enum.ActuatorType|Motor`, as the constraint attempts to reach its desired
`Class.SlidingBallConstraint.Velocity|Velocity`.


SlidingBallConstraint.MotorMaxForce

The elasticity of the constraint's `Class.Attachment|Attachments` when
they reach the end of the range specified by
`Class.SlidingBallConstraint.UpperLimit|UpperLimit` and
`Class.SlidingBallConstraint.LowerLimit|LowerLimit`, assuming
`Class.SlidingBallConstraint.LimitsEnabled|LimitsEnabled` is set to true.
The valid range is between 0&ndash;1.


SlidingBallConstraint.Restitution

The elasticity of the constraint's `Class.Attachment|Attachments` when
they reach the end of the range specified by
`Class.SlidingBallConstraint.UpperLimit|UpperLimit` and
`Class.SlidingBallConstraint.LowerLimit|LowerLimit`, assuming
`Class.SlidingBallConstraint.LimitsEnabled|LimitsEnabled` is set to true.


The constraint's maximum force when
`Class.SlidingBallConstraint.ActuatorType|ActuatorType` is set to
`Enum.ActuatorType|Servo`, as the constraint attempts to reach its desired
`Class.SlidingBallConstraint.Speed|Speed`.


SlidingBallConstraint.ServoMaxForce

SlidingBallConstraint.Size

SlidingBallConstraint.SoftlockServoUponReachingTarget

The constraint's desired speed when
`Class.SlidingBallConstraint.ActuatorType|ActuatorType` is set to
`Enum.ActuatorType|Servo`, as the constraint translates towards its
`Class.SlidingBallConstraint.TargetPosition|TargetPosition`. Measured in
studs per second.


SlidingBallConstraint.Speed

The constraint's attempted target position when
`Class.SlidingBallConstraint.ActuatorType|ActuatorType` is set to
`Enum.ActuatorType|Servo` Measured in studs.


SlidingBallConstraint.TargetPosition

The constraint's attempted target position when
`Class.SlidingBallConstraint.ActuatorType|ActuatorType` is set to
`Enum.ActuatorType|Servo`. Measured in studs.


The upper positional limit along the **X** axis of
`Class.Constraint.Attachment0|Attachment0` if
`Class.SlidingBallConstraint.LimitsEnabled|LimitsEnabled` is true.


SlidingBallConstraint.UpperLimit

The constraint's attempted velocity when
`Class.SlidingBallConstraint.ActuatorType|ActuatorType` is set to
`Enum.ActuatorType|Motor`. Measured in studs per second.


SlidingBallConstraint.Velocity

The base class for constraints that allow their attachments to slide along an
axis but not rotate.


The base class for constraint-based objects. See
[mover constraints](/physics/mover-constraints) and
[mechanical constraints](/physics/mechanical-constraints) for more
details.


Constraint:GetDebugAppliedForce

bodyId

Constraint:GetDebugAppliedTorque

Constraint

This property is `true` if the constraint and both of its parts are in the
`Class.Workspace` and the constraint's `Class.Constraint.Enabled` property
is `true`.


Constraint.Active

Indicates if the constraint is currently active in the world.


The `Class.Attachment` that is connected to `Class.Constraint.Attachment1`


Constraint.Attachment0

The `Class.Attachment` that is connected to
`Class.Constraint.Attachment1`.


The `Class.Attachment` that is connected to `Class.Constraint.Attachment0`


Constraint.Attachment1

The `Class.Attachment` that is connected to
`Class.Constraint.Attachment0`.


Constraint.Color

Toggles whether or not the constraint is enabled.


Constraint.Enabled

Constraint.Visible

The base class for constraint-based objects.


`Instance` is the base class for all classes in the Roblox class hierarchy
which can be part of the `Class.DataModel` tree.

It is not possible to directly create root `Instance` objects, but the special
`Datatype.Instance.new()` constructor creates objects via code, taking the
name of the class as a parameter and returning the created object.


Demonstrates detecting changes to an instance's ancestry by connecting to the
`Class.Instance.AncestryChanged` event.

The ChangingPart's Parent is set to different values overtime. The parent of
the part is the part's ancestor, so the `Class.Instance.AncestryChanged` event
will fire whenever it changes.


Fires when this instance is reparented or when any of its ancestors is
reparented.

You can use this event to track the deletion of an instance in Studio,
such as manual deletion in the Explorer or through a plugin. If you need
to detect when an instance is destroyed using `Class.Instance:Destroy()`,
use the `Class.Instance.Destroying` event instead.


Instance.AncestryChanged

child

The instance whose `Class.Instance.Parent|Parent` property changed,
which can be this instance or a more distant ancestor, **not**
necessarily the instance the handler is connected to.


parent

The new parent of the `child` parameter.


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


This event fires whenever any attribute is changed on the instance,
including when an attribute is set to `nil`. The name of the changed
attribute is passed to the connected function.

For example, the following code snippet connects the `attributeChanged()`
function to fire whenever one of the part's attributes changes:

```lua
local Workspace = game:GetService("Workspace")

local part = Workspace.Part

local function attributeChanged(attributeName)
	print(attributeName, "changed")
end

part.AttributeChanged:Connect(attributeChanged)
```

See also `Class.Instance:GetAttributeChangedSignal()` which returns an
event that fires when a specific given attribute changes.


Instance.AttributeChanged

attribute

The name of the attribute that has been changed.


Fires whenever an attribute is changed on the `Class.Instance`.


This snippet prints the names of objects as they are added to the Workspace:


Fires after an object is parented to this `Class.Instance`.

Note, when using this method on a client to detect objects created by the
server it is necessary to use `Class.Instance:WaitForChild()` when
indexing these object's descendants. This is because the object and its
descendants are not guaranteed to replicate from the server to the client
simultaneously. For example:

```
local Workspace = game:GetService("Workspace")

Workspace.ChildAdded:Connect(function(child)
	-- Use WaitForChild() since descendants may not have replicated yet
	local head = child:WaitForChild("Head")
end)
```

Note, this event only operates for immediate children of the
`Class.Instance`. For an event that captures all descendants, use
`Class.Instance.DescendantAdded`.

See also `Class.Instance.ChildRemoved`.


Instance.ChildAdded

The `Class.Instance` that has been added.


Fires after an object is parented to this `Class.Instance`.


Instance.childAdded

This snippet prints the names of objects as they are removed from the
Workspace:


Fires after a child is removed from this `Class.Instance`.

Removed refers to when an object's parent is changed from this
`Class.Instance` to something other than this `Class.Instance`. Note, this
event will also fire when a child is destroyed (using
`Class.Instance:Destroy()`) as the destroy function sets an object's
parent to `nil`.

This event only operates for immediate children of the `Class.Instance`.
For an event that captures all descendants, use
`Class.Instance.DescendantRemoving`.

See also `Class.Instance.ChildAdded`.


Instance.ChildRemoved

The `Class.Instance` that has been removed.


Fires after a child is removed from this `Class.Instance`.


This following example will print the name of any object that is added to the
Workspace:


This event fires after a descendant is added to the `Class.Instance`.

As it fires for every descendant, parenting an object to the
`Class.Instance` will fire the event for this object and all of its
descendants individually.

If you're only concerned with the **direct children** of the
`Class.Instance`, use `Class.Instance.ChildAdded` instead.

See also `Class.Instance.DescendantRemoving`.


Instance.DescendantAdded

descendant

Fires after a descendant is added to the `Class.Instance`.


The following example prints the name of any descendant as it is being removed
from the Workspace:


This event fires **immediately before** the parent `Class.Instance`
changes such that a **descendant** instance will no longer be a
descendant. `Class.Instance:Destroy()|Destroy()` changes an instance's
`Class.Instance.Parent|Parent` to `nil`, so calling that method on a
descendant of the parent will cause this event to fire.

Since this event fires **before** the descendant's removal, the parent of
the descendant will be unchanged at the time of this event firing. If the
descendant is also a **direct child** of the parent, this event will fire
before `Class.Instance.ChildRemoved`.

If a descendant has children, this event fires with the descendant first,
followed by its descendants.

#### Warning

This event fires with the descendant object that is being removed.
Attempting to set the `Class.Instance.Parent|Parent` of the descendant to
something else will fail. Below is an example that demonstrates this:

```
local Workspace = game:GetService("Workspace")

Workspace.DescendantRemoving:Connect(function(descendant)
	-- Do not manipulate the parent of the descendant in this function!
	-- This event fires BECAUSE the parent was manipulated, and the change hasn't happened yet
	-- Therefore, it is problematic to change the parent like this:
	descendant.Parent = game
end)

local part = Instance.new("Part")
part.Parent = Workspace
part.Parent = nil
```

See also `Class.Instance.DescendantAdded|DescendantAdded`.


Instance.DescendantRemoving

The `Class.Instance` that is being removed.


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


This sample demonstrates how, when using Immediate signal behavior, an
Instance being destroyed remains in place until the connected function yields.


This sample demonstrates how, when using Deferred signal behavior, an Instance
is destroyed before the signal fires.


The `Class.Instance` will never be deleted from memory while a connected
function is still using it. However, if the function yields at any point,
the `Class.Instance` and its descendants will be parented to `nil`.

If the `Class.Workspace.SignalBehavior` property is set to
`Enum.SignalBehavior.Immediate`, this event fires immediately before the
`Class.Instance` or one of its ancestors is destroyed with
`Class.Instance:Destroy()`.

If the `Class.Workspace.SignalBehavior` property is set to
`Enum.SignalBehavior.Deferred`, this event fires at the next resumption
point, which will be after the `Class.Instance` or one of its ancestors is
destroyed with `Class.Instance:Destroy()`.

With `Enum.SignalBehavior.Deferred|Deferred` behavior, connecting a script
to its own `Class.Instance.Destroying` event is problematic, as the script
will be destroyed before the callback can be called (meaning it will not
execute).

When deleting an `Class.Instance` in Studio, such as manually deleting
through the [Explorer](/studio/explorer) or through a plugin,
the `Class.Instance` isn't destroyed. Instead, the parent is set to `nil`
which you can track with `Class.Instance.AncestryChanged`.


Instance.Destroying

Fires immediately before (or is deferred until after) the instance is
destroyed via `Class.Instance:Destroy()`.


Demonstrates `Class.Instance.StyledPropertiesChanged`.


This event fires whenever any style property is changed on the instance,
including when a property is set to `nil`.


Instance.StyledPropertiesChanged

Fires whenever any style property is changed on the instance, including
when a property is set to `nil`.


This method applies a tag to the instance, with no effect if the tag is
already applied. Successfully adding a tag will fire a signal created by
`Class.CollectionService:GetInstanceAddedSignal()` with the given tag.

#### Warnings

- An instance's tags that were added client-side will be dropped if the
  server later adds or removes a tag on that instance because the server
  replicates all tags together and overwrites previous tags.

- When tagging an instance, it is common that some resources are used to
  give the tag its functionality, for example event connections or tables.
  To prevent memory leaks, it's a good idea to clean these up (disconnect,
  set to `nil`, etc.) when no longer needed for a tag. Do this when
  calling `Class.Instance:RemoveTag()`, calling
  `Class.Instance:Destroy()`, or in a function connected to a signal
  returned by `Class.CollectionService:GetInstanceRemovedSignal()`.


Instance:AddTag

The children function returns an array of the object's children.


Instance:children

Returns an array of the object's children.


This method destroys all of an instance's children and descendants.

```
local part = Instance.new("Part")

-- Add some sparkles
for i = 1, 3 do
	local sparkles = Instance.new("Sparkles")
	sparkles.Parent = part

  local sc = Instance.new("Sparkles")
  sc.Parent = sparkles
end

print("Children:", #part:GetChildren())  --> Children: 3

part:ClearAllChildren()

print("Children:", #part:GetChildren())  --> Children: 0
```

If you do not wish to destroy **all** children and descendants, use either
`Class.Instance:GetChildren()` or `Class.Instance:GetDescendants()` to
loop through those children/descendants and select what to destroy. For
example, the following code sample will destroy all
`Class.BasePart|BaseParts` descending from a `Class.Model`:

```
local Workspace = game:GetService("Workspace")

local model = Workspace:FindFirstChild("TestModel")

for _, descendant in model:GetDescendants() do
	if descendant:IsA("BasePart") then
		descendant:Destroy()
	end
end
```


Instance:ClearAllChildren

This method destroys all of an instance's children.


Demonstrates cloning a model using `Class.Instance:Clone()`.


`Clone()` creates a copy of an instance and all of its descendants,
ignoring all instances that are not
`Class.Instance.Archivable|Archivable`. The copy of the root instance is
returned by this method and its `Class.Instance.Parent|Parent` is set to
`nil`. Note that if the instance itself has
`Class.Instance.Archivable|Archivable` set to `false`, this method will
return `nil`.

If a reference property such as `Class.ObjectValue.Value` is set in a
cloned instance, the value of the copy's property depends on the
original's value:

- If a reference property refers to an instance that was **also** cloned,
  the copy will refer to the copy.
- If a reference property refers to an instance that was **not** cloned,
  the same value is maintained in the copy.


Instance:Clone

Create a copy of an instance and all its descendants, ignoring instances
that are not `Class.Instance.Archivable|Archivable`.


Instance:clone

Demonstrates destroying a Part using the `Class.Instance:Destroy()` function.

This function is the correct way to dispose of objects that are no longer
required.


Sets the `Class.Instance.Parent` property to `nil`, locks the
`Class.Instance.Parent` property, disconnects all connections, and calls
`Destroy()` on all children. This method is the correct way to dispose of
objects that are no longer required.

Disposing of unneeded objects is important, since unnecessary objects and
connections in a place use up memory which can lead to serious performance
issues over time.

As a best practice after calling `Destroy()` on an object, set any
variables referencing the object (or its descendants) to `nil`. This
prevents your code from accessing anything to do with the object.

```lua
local part = Instance.new("Part")
part.Name = "Hello, world"
part:Destroy()
-- Don't do this:
print(part.Name)  --> "Hello, world"
-- Do this to prevent the above line from working:
part = nil
```

Once an `Class.Instance` has been destroyed by this method, it cannot be
reused because the `Class.Instance.Parent` property is locked. To
**temporarily** remove an object instead of destroying it, set
`Class.Instance.Parent|Parent` to `nil`. For example:

```
local Workspace = game:GetService("Workspace")

object.Parent = nil
task.wait(2)
object.Parent = Workspace
```

To destroy an object after a set amount of time, use
`Class.Debris:AddItem()`.


Instance:Destroy

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


Instance:destroy

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

This method works upwards, meaning it starts at the instance's immediate
`Class.Instance.Parent` and works up towards the `Class.DataModel`. If no
matching ancestor is found, it returns `nil`.

The following code snippet would find the first ancestor of the object
named `Car`.

```
local car = object:FindFirstAncestor("Car")
```

For variants of this method that find ancestors of a specific class,
please see `Class.Instance:FindFirstAncestorOfClass()` and
`Class.Instance:FindFirstAncestorWhichIsA()`.


Instance:FindFirstAncestor

name

The `Class.Instance.Name` to be looked for.


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


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

This method works upwards, meaning it starts at the instance's immediate
`Class.Instance.Parent` and works up towards the `Class.DataModel`. If no
matching ancestor is found, it returns `nil`.

A common use of this method is finding the `Class.Model` a
`Class.BasePart` belongs to. For example:

```
local model = part:FindFirstAncestorOfClass("Model")
```

This method is a variant of `Class.Instance:FindFirstAncestor()` which
checks the `Class.Object.ClassName` property rather than
`Class.Instance.Name`. `Class.Instance:FindFirstAncestorWhichIsA()` also
exists, using the `Class.Object:IsA()` method instead to respect class
inheritance.


Instance:FindFirstAncestorOfClass

className

The `Class.Object.ClassName` to be looked for.


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


Returns the first ancestor of the `Class.Instance` for whom
`Class.Object:IsA()` returns true for the given className.

This method works upwards, meaning it starts at the instance's immediate
`Class.Instance.Parent` and works up towards the `Class.DataModel`. If no
matching ancestor is found, it returns `nil`.

Unlike `Class.Instance:FindFirstAncestorOfClass()`, this method uses
`Class.Object:IsA()` which respects class inheritance. For example:

```
print(part:IsA("Part"))  --> true
print(part:IsA("BasePart"))  --> true
print(part:IsA("Instance"))  --> true
```

Therefore, the following code sample will return the first
`Class.BasePart` ancestor, regardless of if it is a `Class.WedgePart`,
`Class.MeshPart` or `Class.Part`.

```
local part = object:FindFirstAncestorWhichIsA("BasePart")
```

See also `Class.Instance:FindFirstAncestor()`.


Instance:FindFirstAncestorWhichIsA

Returns the first ancestor of the `Class.Instance` for whom
`Class.Object:IsA()` returns true for the given className.


The below would look in Workspace for an object name "Brick". If found, it
will change the name of the object to "Foo".


Returns the first child of the `Class.Instance` with the given name, or
`nil` if no such child exists. If the optional `recursive` argument is
`true`, this method searches all descendants rather than only the
immediate children of the `Class.Instance`.

#### Checking the Existence of an Object

`FindFirstChild()` is necessary if you need to verify an object exists
before continuing. Attempting to index a child by name using the dot
operator throws an error if the child doesn't exist.

```lua
local Workspace = game:GetService("Workspace")

-- The following line errors if the part doesn't exist in the workspace
Workspace.Part.Transparency = 0.5
```

A better approach is to use `FindFirstChild()` to first check for `Part`,
then use an `if` statement to run code that needs it.

```lua
local Workspace = game:GetService("Workspace")

local part = Workspace:FindFirstChild("Part")
if part then
	part.Transparency = 0.5
end
```

#### Finding a Child Whose Name Matches a Property

Sometimes the `Class.Instance.Name|Name` of an object is the same as that
of a property of its `Class.Instance.Parent|Parent`. When using the dot
operator, properties take precedence over children if they share a name.

In the following example, a `Class.Folder` called `Color` is added to a
`Class.Part`, which also has the `Class.Part.Color` property. Notice that
`part.Color` refers to the `Datatype.Color3` property value, not the child
`Class.Folder` instance. A benefit of using
`Class.Instance:FindFirstChild()|FindFirstChild()` is that the
introduction of new properties does not impose a risk on your code.

```lua
local part = Instance.new("Part")
local folder = Instance.new("Folder")
folder.Name = "Color"
folder.Parent = part
local c1 = part.Color  -- The property
local c2 = part:FindFirstChild("Color")  -- The child folder
```

#### Performance Notes

`Class.Instance:FindFirstChild()|FindFirstChild()` takes about 20% longer
than using the dot operator and almost 8 times longer than simply storing
a reference to an object. Therefore, you should avoid calling it in
performance-dependent code such as in tight loops or functions connected
to `Class.RunService.Heartbeat` and `Class.RunService.PreRender`. Instead,
store the result in a variable, or consider using
`Class.Instance.ChildAdded|ChildAdded` or
`Class.Instance:WaitForChild()|WaitForChild()` to detect when a child of a
given name becomes available.


Instance:FindFirstChild

The `Class.Instance.Name` to be searched for.


recursive

Whether or not the search should be conducted recursively.


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


Instance:findFirstChild

Returns the first child of the `Class.Instance` whose
`Class.Object.ClassName|ClassName` is equal to the given `className`.
Unlike `Class.Instance:FindFirstChildWhichIsA()`, this method only returns
objects whose class matches `className`, ignoring class inheritance. If no
matching child is found, this method returns `nil`.


Instance:FindFirstChildOfClass

Returns the first child of the `Class.Instance` whose
`Class.Object.ClassName|ClassName` is equal to the given class name.


Returns the first child of the `Class.Instance` for whom
`Class.Object:IsA()` returns true for the given className.

If no matching child is found, this method returns `nil`. If the optional
recursive argument is true, this method searches all descendants rather
than only the immediate children of the `Class.Instance`.

Unlike `Class.Instance:FindFirstChildOfClass()`, this method uses
`Class.Object:IsA()` which respects class inheritance. For example:

```lua
print(part:IsA("Part")) --> true
print(part:IsA("BasePart")) --> true
print(part:IsA("Instance")) --> true
```

Therefore, the following code sample will return the first
`Class.BasePart` child, regardless of if it is a `Class.WedgePart`,
`Class.MeshPart` or `Class.Part`.

```
local part = object:FindFirstChildWhichIsA("BasePart")
```

Developers looking for a child by name, should use
`Class.Instance:FindFirstChild()` instead.


Instance:FindFirstChildWhichIsA

The `Class.Object.ClassName` to be searched for.


Returns the first child of the `Class.Instance` for whom
`Class.Object:IsA()` returns true for the given className.


Returns the first descendant found with the given `Class.Instance.Name`.

This method is disabled and cannot be used. To find the first descendant
of an instance, consider using the `recursive` parameter on
`Class.Instance:FindFirstChild()` instead.


Instance:FindFirstDescendant

The `Class.Instance.Name` to search for.


Returns the first descendant found with the given `Class.Instance.Name`.


If the `Class.Instance` is an `Class.Actor`, the `Class.Actor` itself is
returned. Otherwise, its closest ancestor `Class.Actor` is returned. If no
ancestor is an `Class.Actor`, the result is `nil`.


Instance:GetActor

Returns the `Class.Actor` associated with the Instance, if any.


This method returns the value which has been assigned to the given
attribute name. If no attribute has been assigned, `nil` is returned.

For example, the following code snippet sets and then gets the value of
the instance's `InitialPosition` attribute:

```lua
local Workspace = game:GetService("Workspace")

local part = Workspace.Part
part:SetAttribute("InitialPosition", part.Position)

local initialPosition = instance:GetAttribute("InitialPosition")
print(initialPosition)
```

#### See Also

- `Class.Instance:SetAttribute()` which sets the attribute with the given
  name to the given value.
- `Class.Instance:GetAttributes()` which returns a dictionary of key‑value
  pairs for each of the instance's attributes.


Instance:GetAttribute

The name of the attribute being retrieved.


Returns the value which has been assigned to the given attribute name.


Instance

`Instance` is the base class for all classes in the Roblox class hierarchy
which can be part of the `Class.DataModel` tree.


/reference/engine/classes/CylindricalConstraint.yaml