Flag

Flag.TeamColor

This code is meant to be placed in a Script within a Tool. It allows a player
to spawn explosions by equipping the tool and clicking on the ground. It does
so by defining a function, `explode`, which creates a non-deadly explosion at
a given point. Then, it defines a function, `onActivated`, that runs when the
tool is activated. Finally, it connects the Activated event of the tool to the
`onActivated` function.

To test this code out, try creating a Tool and put a Part inside it. Name the
Part "Handle". Put a Script inside the Tool next, and paste the code into it.
Finally, put the Tool in the StarterPack.


This code sample is for a Tool object with a Part named Handle. It detects
when Humanoids other than the current holder hit the handle, and deals some
damage to them. In addition, when the Tool is activated, it triggers a slash
animation in the default character animation scripts. Try out this script by
creating a Tool object in the StarterPack. Put a Part inside it, and name it
Handle. Paste this code into a Script inside the Tool, then try slashing at
another Humanoid!


The code below creates a new tool and places into the
`Class.Players.LocalPlayer|LocalPlayer's` `Backpack`. Then, the code equips
the tool for the player user `Class.Humanoid:EquipTool()`.

When the tool is equipped and the player uses it (e.g. pressed their mouse
button in-game), the code spawns a new `BasePart|part` at the position of the
click using the `Class.Humanoid.TargetPoint` position. The code also sets
several of the part's properties, such as giving it a random
`Class.BasePart.BrickColor`.


The code below demonstrates the functionality of several `Tool` events,
including `Class.Tool.Activated`, `Class.Tool.Deactivated`, and
`Class.Tool.Unequipped`.

The code, when placed in a `LocalScript` in the
`StarterPlayer`.`StarterCharacterScripts` folder inserts and controls a tool
in the `Class.Players.LocalPlayer|LocalPlayer's` `Class.Backpack` that allows
the player to fly through the sky when used.

In order to ensure that the player stops flying when the player unequips the
tool, the code uses the tool's Unequipped event to turn set the `fly` boolean
to true and turn stop flying until the tool is reequipped and activated again.


Tool.Activated

Tool.Deactivated

The example shown below will print "A tool was equipped" each time the tool is
equipped by the player. Please note that the below example assumes that you've
already defined what "Tool" is.


Tool.Equipped

mouse

Tool.Unequipped

The code below creates a tool in the `Class.Players.LocalPlayer|LocalPlayer's`
`Backpack` that turns the player invisible when activated and visible when
deactivated.

When equipped, the script simulates the tool being activated and turns the
player invisible for 3 seconds and then simulates the tool being deactivated.
Holding the left mouse button down turns the player invisible for up to 3
seconds, with a cooldown period of 1 second, or until the player releases
their left mouse button.


Tool:Activate

The below code is intended to be inserted into a script within a Tool. The
script will deactivate the tool when the user presses the x key, while the
tool is equipped. The script also changes the handle's color when the tool is
deactivated.


Tool:Deactivate

Tool

The code below inserts a `Tool` into the
`Class.Players.LocalPlayer|LocalPlayer's` `Backpack` that cannot be dropped
because it's `Class.Tool.CanBeDropped` property is set to `false`.

When the user clicks their left mouse button, the tool is activated and the
script prints "Meow".


Tool.CanBeDropped

The code sample below creates `Tool` in the
`Class.Players.LocalPlayer|LocalPlayer's` `Class.Backpack` that increases the
player's `Class.Humanoid.JumpPower|JumpPower()` from `50` to `150` for 5
seconds.

This example uses the tool's `Class.Tool.Enabled` property as a debounce by
setting the property to true when the player begins sprinting and to false
when the player stops sprinting. As a result, the tool cannot be activated to
extend the duration of the SuperJump buff until after the 5 second duration
ends.

Unequipping the tool also stops the player from super jumping by changing the
JumpPower back to `50`.


Tool.Enabled

The code below insert's a `Tool` named "Stick" into the
`Class.Players.LocalPlayer|LocalPlayer's` `BackPack`. When the player pressed
their left mouse button and activates the tool, the code prints the values of
the tool's grip properties.


Tool.Grip

Tool.GripForward

Tool.GripPos

Tool.GripRight

Tool.GripUp

The code sample below creates `Tool` in the
`Class.Players.LocalPlayer|LocalPlayer's` `Class.Backpack` that increases the
player's `Class.Humanoid.Walkspeed|WalkSpeed` from `16` to `30` for 5 seconds.

This example uses the tool's `Class.Tool.ManualActivationOnly` property as a
debounce by setting the property to true when the player begins sprinting and
to false when the player stops sprinting. As a result, when the player is
sprinting the tool cannot be activated by pressing the left mouse button.

Unequipping the tool also stops the player from sprinting by changing the
WalkSpeed to `16`.


Tool.ManualActivationOnly

The code sample below prints "This tool requires a handle!' when the tool
requires a handle to function, and "This tool does not require a handle!' when
the tool does not require a handle to function.

In order for code to function as expected, the `tool` variable must be set to
a `Tool` instance in the game or in a `Player|Player's` `Backpack`.

Although this example demonstrates how to determine the value of the
`Class.Tool.RequiresHandle` property, the property is usually set manually
within Studio mode when you create a tool, rather than via a script.


Tool.RequiresHandle

Tool.ToolTip

BackpackItem

BackpackItem.TextureId

The following sample includes a basic function that takes a table of objects
and parents them into a new Model, returning that Model.


Model:AddPersistentPlayer

playerInstance

In this sample the joints in every Player character Model added will be broken
3 seconds after spawning. Breaking these joints will cause the Humanoid to
die.


This code sample demonstrates manual creation of joints on two parts that are
siblings of the script (PartA and PartB). It creates a joints on two touching
parts with compatible surface types (Studs and Inlet).


Model:BreakJoints

Model:GetBoundingBox

The code sample below demonstrates how Model.GetExtentsSize can be used to get
the size of the bounding box containing the parts.


Model:GetExtentsSize

Model:GetModelCFrame

This code would create a model, put some parts in it, position them randomly,
and then print its size:


Model:GetModelSize

Model:GetPersistentPlayers

The following code demonstrates how GetPrimaryPartCFrame and
SetPrimaryPartCFrame can be used to rotate a model.

A simple model is created in the Workspace and a loop is started that will
rotate the model 10 degrees around the Y axis every 0.2 seconds.


Model:GetPrimaryPartCFrame

This code sample demonstrates substituting in a replacement for all the copies of a tree model using PivotTo and ScaleTo. The pivot and scale of the models are used as a reference ensuring that the relative sizes and locations of the replacement models match those of the originals.


Model:GetScale

This code sample demonstrates how joints can be made using the
Model:MakeJoints function.

A model is instanced, with two parts on top of each other. The top part is
anchored and the bottom part is not. Normally, when parented to the Workspace
the bottom part would fall to the Baseplate.

However, as TopSurface property of the bottom part is set to
Enum.SurfaceType.Weld, this means that when Model:MakeJoints is ran a
connection is made between them.

Therefore the bottom part does not drop until the joints in the model are
broken. This is often done using Model:BreakJoints, but in this example the
connection is broken using an explosion.


This code sample demonstrates creation of joints on two parts that are
siblings of the script (PartA and PartB). It uses MakeJoints on two touching
parts with compatible surface types (Studs and Inlet).


Model:MakeJoints

This sample demonstrates how Model:MoveTo avoids collisions.

A simple two part Model is created, and its PrimaryPart is set. An large
obstruction part is placed next to it.

After 5 seconds Model:MoveTo is used to direct the model to move inside the
obstruction part. However, as MoveTo will not move a model inside of an
obstruction the Model is moved up on the Y axis and placed above the
obstruction.


Model:MoveTo

position

Model:RemovePersistentPlayer

Model:ResetOrientationToIdentity

Model:ScaleTo

newScaleFactor

Model:SetIdentityOrientation

Model:SetPrimaryPartCFrame

cframe

This sample demonstrates how Model:TranslateBy ignores collisions and respects
the orientation of the model.

A simple two part Model is created, rotated 45 degrees on the Y axis, and its
PrimaryPart is set. An large obstruction part is placed next to it.

After 5 seconds Model:TranslateBy is used to direct the model to move inside
the obstruction part. The model will move inside of the obstruction and
maintain it's current orientation.


Model:TranslateBy

delta

Model:breakJoints

Model:makeJoints

Model:move

location

Model:moveTo

Model

Model.LevelOfDetail

Model.ModelStreamingMode

This code sample creates and throws a dice model, then outputs whether it
landed with the blue side facing up. If `Class.Model.PrimaryPart` was not set,
the pivot / bounding box of the dice would rotate, as the parts inside of it
are physically simulated during the roll.


Model.PrimaryPart

Model.Scale

This code sample shows a custom function for resetting the pivot of a model
back to the center of that model's bounding box.


Model.WorldPivot

This code sample is a simple teleport script that moves your character
10&nbsp;studs forwards in the direction you're currently facing when you press
the <kbd>F</kbd> key. It does so by getting the current pivot with
`Class.PVInstance:GetPivot()` and calling `PVInstance|PivotTo` to move the
character forwards.


PVInstance:GetPivot

PVInstance:PivotTo

targetCFrame

PVInstance

PVInstance.Origin

PVInstance.Pivot Offset

The below example would print "Part is now a child of Model".


Instance.AncestryChanged

child

parent

Instance.AttributeChanged

attribute

This sample demonstrates the subtleties of the Changed event on normal objects
and "-Value" objects.


This code sample demonstrates the Changed event firing within a parent object.


Instance.Changed

property

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


Instance.ChildAdded

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


Instance.ChildRemoved

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


Instance.DescendantAdded

descendant

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


Instance.DescendantRemoving

This sample demonstrates how an Instance being destroyed remains in place
until the connected function yields.


Instance.Destroying

Instance.childAdded

Instance:AddTag

This example creates a Part and adds a few sparkle objects to the part. Then
it calls Part:ClearAllChildren() to remove all of the children.


Instance:ClearAllChildren

This code first references an existing object in the `original` variable.
Then, it makes a copy of the object, sets the parent to that of the original,
and finally moves the copy to (0, 50, 0).


Instance:Clone

Instance:Destroy

Instance:FindFirstAncestor

name

Instance:FindFirstAncestorOfClass

className

Instance:FindFirstAncestorWhichIsA

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


Instance:FindFirstChild

recursive

Instance:FindFirstChildOfClass

Instance:FindFirstChildWhichIsA

Instance:FindFirstDescendant

Instance:GetActor

Instance:GetAttribute

Instance:GetAttributeChangedSignal

Instance:GetAttributes

The below would print the name of all objects currently in Workspace when ran.


Instance:GetChildren

Instance:GetDebugId

scopeLength

GetDescendants is often used to do something to all the descendants that are a
particular type of object. The code in this example uses GetDescendants and
`Class.Instance:IsA()` to find all of the parts in the workspace and turns
them green.


Instance:GetDescendants

This code sample demonstrates the behavior of `Class.Instance:GetFullName()`.
It shows how the function behaves when called on an object not in the
`DataModel` hierarchy, and it also shows how the return value does not escape
special characters.


This code sample re-implements the `Class.Instance:GetFullName()` function in
Lua.


Instance:GetFullName

This code sample demonstrates how to save a value before a changed event fires
on it in order to get more information about a change.


This code sample demonstrates the equivalence of the `Changed` event and event
returned by `GetPropertyChangedSignal`.


Instance:GetPropertyChangedSignal

Instance:GetTags

Instance:HasTag

Instance:IsA

Instance:IsAncestorOf

Instance:IsDescendantOf

ancestor

The following code demonstrates how a part can be re-added to the DataModel
after being removed:


Instance:Remove

Instance:RemoveTag

Instance:SetAttribute

value

The following code waits for an instance named "Part" to be added to
Workspace.


Instance:WaitForChild

childName

timeOut

Instance:children

Instance:clone

Instance:destroy

Instance:findFirstChild

Instance:getChildren

Instance:isA

Instance:isDescendantOf

Instance:remove

Instance

Instance.Archivable

Instance.ClassName

Instance.Name

Instance.Parent

Instance.RobloxLocked

Instance.archivable

Instance.className

The Flag object is a deprecated object that was used to make capture the flag
games.


An `Class.Actor` is a container for code that can be safely split into its own
thread.


The abstract base class for in-world objects that physically interact.


A data type that provides a predefined list of named colors.


A data type that represents both a 3D position and orientation.


A formatted string with a specific structure to reference some form of
content.


Instance is the base class for all classes in the Roblox class hierarchy.


Controls the level of detail for `Class.Model|Models` in experiences with
instance streaming enabled.


Controls stream in and out behavior of a model.


Legacy object that contains members useful for pointer input.


An object that represents a presently connected client to the game.


An object that runs connected functions upon a specific occurrence.


Represents a 3D value with a direction and magnitude.


Overview

Guides

Tutorials

Reference

Resources

Design

Engine

Avatar

Cloud

Per API Key: {maxInPeriod} requests every {periodInSeconds} seconds per IP Address

The following API key permissions are required to call this endpoint. For more
information on generating proper keys, see [Managing API Keys]({apiKeyReferenceDocLink}).

The following endpoints are available at paths relative to the base URL.

A JSON value can be `null`, `boolean`, `string`, `number`, `array`, or `object`.

The following scopes are required for your OAuth 2.0 application to use this endpoint. For more information on how to register an OAuth 2.0 application, see [App Registration and Review]({oauth2ReferenceDocLink}).

The following objects describe payloads that are accepted or returned. See each individual endpoint for more information on when these objects are used.

Flag

Summary

Properties

Methods

Events

Properties

TeamColor

Methods

Events