Camera.InterpolationFinished

Camera:GetLargestCutoffDistance

ignoreList

Camera:GetPanSpeed

This function will make any `BasePart|BaseParts`, `Decal|Decals` or
`Texture|Textures` coming between the `Class.Workspace.CurrentCamera` and the
given cast points translucent.


Camera:GetPartsObscuringTarget

castPoints

Camera:GetRenderCFrame

This example, when used in a `Class.LocalScript`, will retrieve the current
roll of the camera in degrees. Then, if the camera roll angle is not 20
degrees, the camera roll angle is set to 20 degrees.


Camera:GetRoll

Camera:GetTiltSpeed

Camera:Interpolate

endPos

endFocus

duration

Camera:PanUnits

units

This example creates a cube facing centered at the origin of the Ray returned
and facing in the same direction. The center of the cube will be one stud in
front of the camera.


Camera:ScreenPointToRay

depth

Camera:SetCameraPanMode

mode

Camera:SetRoll

rollAngle

Camera:TiltUnits

Camera:ViewportPointToRay

Camera:WorldToScreenPoint

worldPoint

The following function returns true if a `Datatype.Vector3` is visible on
screen and unobscured by `BasePart|BaseParts` and `Terrain`.


Camera:WorldToViewportPoint

Camera:ZoomToExtents

boundingBoxCFrame

boundingBoxSize

Camera

In this code sample a simple `Camera` animation is played after the
`Class.Players.LocalPlayer` spawns using `TweenService`. The
`Class.Camera.CameraType` of the `Camera` is set to _'Scriptable'_ so the
default camera scripts do not interfere.


Camera.CFrame

Camera.CameraSubject

Camera.CameraType

Camera.CoordinateFrame

Camera.DiagonalFieldOfView

Camera.FieldOfView

Camera.FieldOfViewMode

When the following code is placed inside a `LocalScript` named
_'CameraScript'_ parented to
`StarterPlayerScripts|StarterPlayer.StarterPlayerScripts` the default Roblox
camera scripts are overwritten and replaced with a custom following camera.


Camera.Focus

Camera.HeadLocked

Camera.HeadScale

Camera.MaxAxisFieldOfView

Camera.NearPlaneZ

Camera.VRTiltAndRollEnabled

Camera.ViewportSize

Camera.focus

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

A class which defines a view of the 3D game world.


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


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


The CameraPanMode Enum represents the available pan modes for
`Class.Camera:SetCameraPanMode()`.


Describes the camera behavior mode if using the default PlayerScripts.


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


An object that runs connected functions upon a specific occurrence.


Represents a line with a starting point that casts infinitely in a specific
direction.


Represents a 2D value with direction and magnitude.


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.

This allows viewing information about your assets.

This allows uploading and updating assets to Roblox.

This allows viewing information about your groups.

This allows you to manage group join requests for your account.

This allows viewing information about your inventory.

This grants the ability to publish messages on behalf of users.

This allows listing secrets associated with your experience.

This allows creating and updating secrets associated with your experience.

Grants the ability to read place information.

Grants the ability to edit place information.

This operation grants access to publish new versions of experiences to Roblox.

Grants the ability to read experience information.

Grants the ability to edit experience information.

Grants the ability to read user's premium and verified status.

This allows you to view a user's social accounts.

This enables Single Sign-On functionality

This grants access to read your profile information

Default Value: {defaultValueStart}{defaultValueEnd}

This function returns immediately if possible, but can yield the thread that called it until it can return a value.

This member doesn’t appear in the object browser and is not intended for widespread use.

This member is only accessible only through the command bar. Attempting to access this member from scripts causes an error.

This function can’t pause the Lua thread that called it.

Attempting to access this member in scripts causes an error. You might be able to access this member from Roblox Studio's property window.

This member doesn’t appear in Roblox Studio’s Object Browser.

You can’t create an instance of this class with the Instance.new constructor.

Roblox does not replicate this member across its server-client boundary.

Lua code can’t access this member. You might be able to change its value from the property window in Roblox Studio.

This object’s replication behavior is dependent on the player who owns it.

This member is accessible only through the command bar and plugins only. Attempting to access this member from scripts causes an error.

This property is read-only and is safe to read in unsynchronized threads. Attempting to write to it causes an error.

This member is read only. Attempting to write to this member causes an error.

This member is accessible only in CoreScripts.

Only Roblox CoreScripts can access this member, and it isn’t usable by Players.

You can read and write to this property safely from multiple threads.

This class is a top-level singleton. Retrieve an instance of this class with the GetService function.

Multiple threads can potentially write to this property, so it’s unsafe to read from unsynchronized threads.

This function pauses the Lua thread that called it until it returns a result. This doesn’t interrupt other scripts.

Learn how to create successful content on Roblox with comprehensive guides, code samples, reference, and tutorials.
