Instance

An object in your place, such as a part, group, model, spawn, light or NPC, which your scripts find, change and spawn.

Fields

Events

Gives the instances that sit directly inside this one, but not the ones deeper down.

for _, child in door:children() do print(child.display_name) end

Use it forgoing through every light in a group, or every part of a door.

Says whether the instance has the tag you ask about.

if part:has_tag("Lava") then print("hot") end

Use it forchecking if a touched part is lava or a checkpoint before reacting to it.

Puts a tag on the instance while the game runs.

part:add_tag("Coin")

Use it forturning a part into a token or a kill brick during play, without placing a new one.

Takes one tag off the instance and leaves its other tags alone.

part:remove_tag("Coin")

Use it formaking a trap safe once it has been switched off.

Gives a list of every tag the instance has.

for _, tag in part:tags() do print(tag) end

Use it forlisting every tag on a part, for example to print them while debugging.

Smoothly changes a part's position, rotation, color, size or transparency over a set time.

local tween = door:tween({ position = door.position + math3d.vector3.new(0, 10, 0), duration = 2 })

Use it forsliding doors, moving platforms, or walls that fade away.

Makes a copy of the instance and returns it, placed where you choose.

local copy = door:clone({ position = math3d.vector3.new(10, 0, 0) })

Use it forcopying a token, enemy or obstacle to put more of them around the map.

Removes the instance, and everything inside it, from the world for good.

part:destroy()

Use it forremoving collected tokens, broken walls or spent projectiles.

Says whether the instance is still in the world or has been destroyed.

if part:exists() then part:destroy() end

Use it forchecking a part was not already destroyed before your script uses it.

Gives a physics part a sudden push, like a kick or a blast.

part:apply_impulse(math3d.vector3.new(0, 500, 0))

Use it forkicking a ball, launch pads, or blasting crates across the room.

Keeps pushing a physics part, and does not stop until clear_forces is called.

part:apply_force(math3d.vector3.new(0, 100, 0))

Use it forrockets, hover cars, or wind that keeps pushing objects along.

Removes the forces and torques that scripts added to the part.

part:clear_forces()

Use it forturning off a rocket's thrust, or making the wind stop.

Keeps turning a physics part, and does not stop until clear_forces is called.

part:apply_torque(math3d.vector3.new(0, 50, 0))

Use it forspinning wheels, fans, or platforms that keep turning.

Gives a physics part a sudden spin, like a flick.

part:apply_angular_impulse(math3d.vector3.new(0, 200, 0))

Use it forspinning a thrown object, or knocking a crate into a tumble.

Gives every instance inside this one, at every level, not only the first.

for _, child in door:descendants() do child.transparency = 0.5 end

Use it forfading or recoloring a whole model at once.

Finds a child directly inside by its Explorer name or its Script Name.

local handle = door:find_child("Handle")

Use it forgrabbing the handle of a door, or the light inside a lamp.

Finds anything inside, however deep, by its Explorer name or Script Name.

local knob = door:find_descendant("Knob")

Use it forfinding a part buried deep inside a big model without going through every level.

Gives the center and size of the box around the instance and everything inside it.

local box = door:bounds()

Use it forplacing things on top of a model or measuring its size.

Grows or shrinks the instance, and the spacing of what is inside it along with it.

door:scale_by(2)

Use it forpower-ups that make things grow, shrinking puzzles, or giant bosses.

Puts text on one face of a part or model, in the color and font you choose.

door:set_text("front", "Exit", { color = math3d.color.rgb(255, 255, 255) })

Use it forsigns, scoreboards on walls, or labels on buttons.

Gives the text on one face of the part, or nil if there is none.

local sign = door:get_text("front")

Use it forreading a sign's current text, such as a counter you add one to.