#Instances and parts

Everything in a place is an instance: parts, models, lights, sounds, scripts, GUI elements. This page covers making and finding instances, then the properties of each class.

#Creating and destroying

local coin = Instance.Create("Part", {
    Name = "Coin",
    Position = Vector3.new(0, 5, 0),
    Size = Vector3.new(1.5, 0.4, 1.5),
    Color = "gold",
    Anchored = true,
    Parent = workspace,
})

#Available classes

A class name Studz does not know, and that is not a typo, makes a plain Part with a warning.

#Finding instances

#Children and descendants

#Ancestors and identity

#Tags and attributes

Tags and attributes let you mark objects without extra instances.

Tags and attributes live on the side that set them. They are not replicated to other machines, and they are forgotten when the object is destroyed.

#Parts

A Part is a physical block, ball, cylinder or wedge.

#Appearance and shape

#Position and orientation

Setting CFrame or Position on a player's character or its HumanoidRootPart teleports the character.

#Physics

#Part methods

#Welds

A weld keeps one part in place relative to another. WeldConstraint and Weld are objects you make with Instance.new (or Instance.Create). Parent them anywhere, usually inside Part1.

-- Hold a flag on top of a crate. It stays 3 studs above it however the crate moves.
local crate, flag = workspace.Crate, workspace.Flag
local weld = Instance.new("WeldConstraint")
weld.Part0 = crate
weld.Part1 = flag
weld.Parent = flag

-- The same in one call:
flag:WeldTo(crate)

-- A Weld places Part1 by C0 and C1 instead:
local hinge = Instance.new("Weld")
hinge.Part0 = crate
hinge.Part1 = flag
hinge.C0 = CFrame.new(0, 3, 0) * CFrame.Angles(0, math.rad(45), 0)

How welds behave:

• They are held every step, after physics, on the server. A part welded to a rolling ball, to a platform a script moves, or to another welded part keeps its place. Chains work; welds that form a circle are ignored.
• A held part is anchored while the weld holds it, so physics does not fight the weld (a part that was unanchored falls again when the weld goes). It stays solid: its collision moves with it.
• A part is held by one weld at a time. If two welds hold it, the first one in the place wins.
• A WeldConstraint made between parts already in place moves nothing. A Weld moves Part1 to where its C0 and C1 say on the next step.
• A LocalScript cannot weld. Welds are made and held by the server, and the result is replicated.
• A weld to a player's limb follows the player's position, the way they face and any pose a script gave the limb. It does not follow the built-in walk animation or a clip a script plays, which each client draws by itself.
• Welds made by a script exist while the game runs. They are not saved with the place. Weld parts in Polycarbonate with the Weld tool or the Weld to property: those parts also follow now when a script moves what they are welded to.
• Clone copies the welds inside a model and joins the copies to each other.

#Models

#Other classes

#PointLight

#Value objects

IntValue, NumberValue, StringValue, BoolValue and Vector3Value hold one value.

#ClickDetector

For most scripts part.Clicked is simpler, because it creates the detector for you.

#Decal

#Sound

For one-off effects use Sound.play instead of a Sound object: see World, tweens and effects.

A sound inside a part is positional: it gets quieter with distance. A sound in the Workspace plays everywhere.

#GUI objects

TextLabel, TextButton and Frame make on-screen elements. Created in a server script they appear for everyone. Created in a LocalScript they appear for that player only.

A button's click signal is Clicked. It is a normal signal, so On returns a connection. Destroy() removes an element. GuiService:ClearAll() removes every script-made element. At most 500 GUI elements can exist at once.

local label = Instance.Create("TextLabel", {
    Text = "Welcome!",
    Position = UDim2.new(0.5, 0, 0.1, 0),
    AnchorPoint = Vector2.new(0.5, 0),
    TextSize = 28,
})

For quick messages, the ui helper is shorter: see Globals and services.