url stringlengths 41 103 | title stringlengths 0 53 | type stringclasses 4
values | content stringlengths 53 398k | code_blocks listlengths 0 33 | tokens int64 13 87.9k | content_hash stringlengths 64 64 | crawled_at stringlengths 32 32 |
|---|---|---|---|---|---|---|---|
https://create.roblox.com/docs/en-us/cloud | Cloud API reference | markdown | # Cloud API reference
With Open Cloud, you can access Roblox resources through standard [REST](https://en.wikipedia.org/wiki/REST) APIs, which lets you build everything from command line automation tools to complex web apps. You can update games, restart servers, work with your data stores and memory stores, manage us... | [] | 507 | f17b859c471a0bb88dd18bf25c5a18afc2a80506229f6668a86664132d79bca8 | 2026-08-22T06:55:06.141397+00:00 |
https://create.roblox.com/docs/en-us/production/analytics | Analytics | markdown | # Analytics
Roblox offers a variety of analytics features to help you chart your game's growth, technical performance, track user behavior and retention, and find opportunities for optimization. You can use analytics to understand what actions you can take to grow your game.
If this is your first time engaging with a... | [] | 1,658 | 832e742bbbc413bfd56e0b751bed1b3b0426127bb24f54da2358fc44e99f87a5 | 2026-08-22T06:55:06.398852+00:00 |
https://create.roblox.com/docs/en-us/reference/engine/classes/Accessory | Accessory | engineapi | # Accessory
**Type:** CLASS
**Inherits:** Accoutrement
## Summary
An item that a Character can wear.
## Description
The Accessory Instance is the parent Instance of all accessories (regardless
of their specific accessory type). It typically has a child Handle with a
child Attachment and a WrapLayer in the case of... | [] | 348 | d3394acedcc98fe50ec3c46ab73f32a8b7a8c8984ac2d5e30414c0744f558ac7 | 2026-08-22T06:55:06.419518+00:00 |
https://create.roblox.com/docs/en-us/reference/engine/classes/Actor | Actor | engineapi | # Actor
**Type:** CLASS
**Inherits:** Model
## Summary
An `Class.Actor` is a container for code that can be safely split into its own
thread.
## Description
An `Class.Actor` is a container for code that can be safely split into its own
thread using `Library.task.desynchronize()`. It should also contain the
instan... | [] | 775 | dc89148c5df0bbaecf14452b341d0099a0592bedd69c79b4ca5b8d9ee4a67154 | 2026-08-22T06:55:06.503749+00:00 |
https://create.roblox.com/docs/en-us/reference/engine/classes/AdGui | AdGui | engineapi | # AdGui
**Type:** CLASS
**Inherits:** SurfaceGuiBase
## Summary
A surface-based GUI that displays immersive ads on a face of a `Class.Part` in
the 3D world.
## Description
`Class.AdGui` is a `Class.SurfaceGuiBase` that renders immersive display ads
onto a face of the `Class.Part` it's adorned to. When no ad is av... | [] | 741 | 5cfe7f67dde4eca951d969d40de0357ef38d83e14c17b659076de3b4e110d55a | 2026-08-22T06:55:06.548379+00:00 |
https://create.roblox.com/docs/en-us/reference/engine/classes/AdvancedDragger | AdvancedDragger | engineapi | # AdvancedDragger
**Type:** CLASS
**Inherits:** Instance
## Summary
An unfinished advanced variant of the `Class.Dragger` class.
## Description
An unfinished advanced variant of the `Class.Dragger` class. Internally, this
object is an identical implementation of the Dragger class. | [] | 66 | 155408703cf76d987099a84f92d008a2df8524d1e238f76477158b0853c0d35f | 2026-08-22T06:55:06.591665+00:00 |
https://create.roblox.com/docs/en-us/reference/engine/classes/AccessoryDescription | AccessoryDescription | engineapi | # AccessoryDescription
**Type:** CLASS
**Inherits:** Instance
## Summary
Describes the appearance of an `Class.Accessory` for the
`Class.HumanoidDescription`.
## Description
**AccessoryDescription** is an object that stores the description for an
`Class.Accessory`. It is meant to be placed underneath a
`Class.Hum... | [] | 739 | 187397bd9bbf8653405d7befb9f2d7675f358b406e5d350180628b73d9d38772 | 2026-08-22T06:55:06.615359+00:00 |
https://create.roblox.com/docs/en-us/reference/engine/classes/Accoutrement | Accoutrement | engineapi | # Accoutrement
**Type:** CLASS
**Inherits:** Instance
## Summary
An object that can attach to a player's character.
## Description
An Accoutrement welds its child `Class.Part|part` called "Handle" to the
player's character. You can change the position and rotation of the Handle
part using the `Class.Accoutrement.... | [] | 443 | c259e56d199c1dccbc3398f0f6841e7318a8c0c8ceef9085b05c1c817441da48 | 2026-08-22T06:55:06.662671+00:00 |
https://create.roblox.com/docs/en-us/reference/engine/classes/AirController | AirController | engineapi | # AirController
**Type:** CLASS
**Inherits:** ControllerBase
## Summary
A physics character controller that governs movement while a character is
airborne.
## Description
An `Class.AirController` is a `Class.ControllerBase` that a
`Class.ControllerManager` uses to drive a character's physics-based movement
while ... | [] | 946 | f065603fa77483c9a41ff40efa7eaa340c85ee656998eb43cdc43d74fc7e8be3 | 2026-08-22T06:55:06.680486+00:00 |
https://create.roblox.com/docs/en-us/reference/engine/classes/AdPortal | AdPortal | engineapi | # AdPortal
**Type:** CLASS
**Inherits:** Instance
## Summary
A portal that teleports players to a sponsored experience as part of immersive
ads.
## Description
An `AdPortal` is a developer-created instance that must be parented to a
`Class.Part` — attempting to parent it elsewhere throws an error. When added
to t... | [] | 487 | 88caf79d8ecb566e8e43ded0a617277c7e939de03053de548918c2ba09af800d | 2026-08-22T06:55:06.732245+00:00 |
https://create.roblox.com/docs/en-us/reference/engine/classes/AdService | AdService | engineapi | # AdService
**Type:** CLASS
**Tags:** NotCreatable, Service
**Inherits:** Instance
## Summary
The service responsible for in-experience advertising.
## Description
`Class.AdService` is responsible for in-experience advertising. This includes
[rewarded video](/production/promotion/rewarded-video-ads) and
[ad inte... | [] | 1,810 | b12fff3a9f3ba85d8b900b5b4cb389acbc46ddf80e6aaa0e21230eec3cb3be0a | 2026-08-22T06:55:06.853867+00:00 |
https://create.roblox.com/docs/en-us/reference/engine/classes/AngularVelocity | AngularVelocity | engineapi | # AngularVelocity
**Type:** CLASS
**Inherits:** Constraint
## Summary
Applies torque on an assembly to maintain a constant angular velocity.
## Description
The `AngularVelocity` constraint applies torque on an assembly to maintain a
**constant** angular velocity. Alternatively:
- If you want to control the amoun... | [] | 725 | 22c894188887a73babf7f4fdef32b5f45e8ac08536078a5a15b09a66b731777c | 2026-08-22T06:55:06.876651+00:00 |
https://create.roblox.com/docs/en-us/reference/engine/classes/AnalyticsService | AnalyticsService | engineapi | # AnalyticsService
**Type:** CLASS
**Tags:** NotCreatable, Service, NotReplicated
**Inherits:** Instance
## Summary
Collection of methods that allows you to track how users interact with your
experiences.
## Description
`AnalyticsService` is a collection of methods that allows you to track how
users interact wit... | [] | 2,557 | ac0b721679d4c4e87fe20ab009dfe091d08c6809ca1d8f2e0240e7b8eb524e0f | 2026-08-22T06:55:06.953061+00:00 |
https://create.roblox.com/docs/en-us/reference/engine/classes/AlignOrientation | AlignOrientation | engineapi | # AlignOrientation
**Type:** CLASS
**Inherits:** Constraint
## Summary
Constraint which applies torque to align two attachments, or to align one
attachment with a goal orientation.
## Description
The `AlignOrientation` constraint applies torque to align two attachments, or
to align one attachment with a goal orie... | [] | 2,005 | c602e64667c2b594221b612eba137f4abde88dd3a1701080fa1b215e722d92d5 | 2026-08-22T06:55:06.974010+00:00 |
https://create.roblox.com/docs/en-us/reference/engine/classes/AlignPosition | AlignPosition | engineapi | # AlignPosition
**Type:** CLASS
**Inherits:** Constraint
## Summary
Constraint which applies force to move two attachments together, or to move
one attachment to a goal position.
## Description
The `AlignPosition` constraint applies force to move two attachments together,
or to move one attachment to a goal posit... | [] | 1,966 | 991b6d6e57b667f34bc294f127424aff4624e7a93987090f547cec33e9b421a4 | 2026-08-22T06:55:06.988679+00:00 |
https://create.roblox.com/docs/en-us/reference/engine/classes/Animation | Animation | engineapi | # Animation
**Type:** CLASS
**Inherits:** Instance
## Summary
References an animation asset which can be loaded by an
`Class.AnimationController`.
## Description
An object that references an animation asset
(`Class.Animation.AnimationId|AnimationId`) which can be loaded by an
`Class.AnimationController`.
#### Lo... | [] | 417 | 55e52db2e897ada47cd96711171f016b02ca9f7c4765a1baab26cf5474924832 | 2026-08-22T06:55:07.034801+00:00 |
https://create.roblox.com/docs/en-us/reference/engine/classes/AnimationClipProvider | AnimationClipProvider | engineapi | # AnimationClipProvider
**Type:** CLASS
**Tags:** NotCreatable, Service, NotReplicated
**Inherits:** Instance
## Summary
Provides functions to load and preview `Class.AnimationClip|AnimationClips`.
## Description
Provides functions to load and preview `Class.AnimationClip|AnimationClips`.
It includes a number of... | [] | 1,135 | df7d1c2420cc1fa4cfa3ba44aac41ef8d95b98b9205dcddd81d42128439594fb | 2026-08-22T06:55:07.054221+00:00 |
https://create.roblox.com/docs/en-us/reference/engine/classes/AnimationConstraint | AnimationConstraint | engineapi | # AnimationConstraint
**Type:** CLASS
**Inherits:** Constraint
## Summary
Aligns two `Class.BasePart|BaseParts` with an animate-able kinematic or
force-based joint that supports physical simulation (ragdoll, arm strength).
The default joint type for R15 avatar rigs.
## Description
#### Replaces Motor6D for Avatar... | [] | 2,229 | 681947cc4d42c9e6aa0f3f3e3dfeb9f4cff6f43c548c760f9489f1a7e82823cb | 2026-08-22T06:55:07.100645+00:00 |
https://create.roblox.com/docs/en-us/reference/engine/classes/AnimationClip | AnimationClip | engineapi | # AnimationClip
**Type:** CLASS
**Tags:** NotCreatable
**Inherits:** Instance
## Summary
Represents all types of animation data that the Roblox animation system can
consume.
## Description
The non-creatable `Class.AnimationClip` instance type represents abstract
animation data that can be fed to the Roblox anima... | [] | 521 | 0d808bd160d64ae22e477ed181aba114c9b591896afea3c3950ac935eee21085 | 2026-08-22T06:55:07.121653+00:00 |
https://create.roblox.com/docs/en-us/reference/engine/classes/AnimationFromVideoCreatorService | AnimationFromVideoCreatorService | engineapi | # AnimationFromVideoCreatorService
**Type:** CLASS
**Tags:** NotCreatable, Service
**Inherits:** Instance | [] | 26 | 4b2cb229e5b848b1d83c3d02c6e5ae8b041c8c428a98171573013c32fbb42c29 | 2026-08-22T06:55:07.194959+00:00 |
https://create.roblox.com/docs/en-us/reference/engine/classes/AnimationRigData | AnimationRigData | engineapi | # AnimationRigData
**Type:** CLASS
**Inherits:** Instance
## Summary
Used to store information regarding the model an animation was authored for.
## Description
An AnimationRigData instance commonly appears in the Data Model as a child of
an AnimationClip. It is used to store information regarding the source rig ... | [] | 91 | d60056973773d30dce0f3aa59e886c39c8d34d292e3b3f8f22a168bdf004ba99 | 2026-08-22T06:55:07.210363+00:00 |
https://create.roblox.com/docs/en-us/reference/engine/classes/AnimationController | AnimationController | engineapi | # AnimationController
**Type:** CLASS
**Inherits:** Instance
## Summary
Allows animations to be loaded and applied to a character or model in place of
a `Class.Humanoid`.
## Description
An object which allows animations to be loaded and applied to a character or
model in place of a `Class.Humanoid`. Creates an `C... | [] | 703 | 94741fc4049da78cc9bf15b96e9e9695f36420e40463f005990f737e4ea432e4 | 2026-08-22T06:55:07.229733+00:00 |
https://create.roblox.com/docs/en-us/reference/engine/classes/AnimationNodeDefinition | AnimationNodeDefinition | engineapi | # AnimationNodeDefinition
**Type:** CLASS
**Inherits:** Instance
## Properties
### Property: `AnimationNodeDefinition.NodeId`
*Tags: RobloxScriptSecurity, ReadSafe*
### Property: `AnimationNodeDefinition.NodeType`
*Tags: None, ReadSafe*
## Methods
### Method: `AnimationNodeDefinition:AddInputPin`
*Tags: None, ... | [] | 359 | 5f75c3d0d7f98b4687aa3f0e70eee19b976e4621b634d219346112dc24d2fc15 | 2026-08-22T06:55:07.245258+00:00 |
https://create.roblox.com/docs/en-us/reference/engine/classes/Annotation | Annotation | engineapi | # Annotation
**Type:** CLASS
**Inherits:** Instance | [] | 13 | 760a9974075a7ef833a79ec92eea4113f54eba26182a6007462e430473cda62c | 2026-08-22T06:55:07.396817+00:00 |
https://create.roblox.com/docs/en-us/reference/engine/classes/AnimationTrack | AnimationTrack | engineapi | # AnimationTrack
**Type:** CLASS
**Tags:** NotCreatable
**Inherits:** Instance
## Summary
Controls the playback of an animation on an `Class.Animator`.
## Description
Controls the playback of an animation on an `Class.Animator`. This object
cannot be created, instead it is returned by the
`Class.Animator:LoadAni... | [] | 4,255 | 459a49033bcabad80e3e115e71620fca4f0a13423b59a6476b4bfc04d10ac8fb | 2026-08-22T06:55:07.484303+00:00 |
https://create.roblox.com/docs/en-us/reference/engine/classes/ArcHandles | ArcHandles | engineapi | # ArcHandles
**Type:** CLASS
**Inherits:** HandlesBase
## Summary
The `Class.ArcHandles` object places 3D arc handles around any 3D object that
its `Class.PartAdornment.Adornee|Adornee` is set to.
## Description
The **ArcHandles** object places 3D arc handles around any 3D object that its
`Class.PartAdornment.Ado... | [] | 415 | 0ddedc29ab4b96db86677ebe3994bd32f7e09ba0049d9d42a73651c9da4e2870 | 2026-08-22T06:55:07.499122+00:00 |
https://create.roblox.com/docs/en-us/reference/engine/classes/Animator | Animator | engineapi | # Animator
**Type:** CLASS
**Inherits:** Instance
## Summary
Responsible for the playback and replication of `Class.Animation|Animations`.
## Description
`Animator` is the main class responsible for the playback and replication of
`Class.Animation|Animations`. All replication of playing
`Class.AnimationTrack|Anim... | [] | 1,796 | 89ed4867c83c4422da211089bc10c64ae2cd5b2b4710413a485ad4a905475390 | 2026-08-22T06:55:07.518599+00:00 |
https://create.roblox.com/docs/en-us/reference/engine/classes/AssetDeliveryProxy | AssetDeliveryProxy | engineapi | # AssetDeliveryProxy
**Type:** CLASS
**Tags:** NotCreatable, Service, NotReplicated
**Inherits:** Instance
## Summary
Runs a local HTTP server that serves assets to real devices.
## Description
Internal service for remote asset delivery; not intended for game scripts. It
backs the remote hot-reload workflow: `Cl... | [] | 484 | 3354ca30d8e368f38aea6d52c52aa34f0445d91681cfa138c96ec41ca089ace8 | 2026-08-22T06:55:07.624148+00:00 |
https://create.roblox.com/docs/en-us/reference/engine/classes/AssetPatchSettings | AssetPatchSettings | engineapi | # AssetPatchSettings
**Type:** CLASS
**Tags:** NotCreatable, NotReplicated
**Inherits:** Instance
## Summary
Configures a single patch asset built by `Class.IncrementalPatchBuilder` and
served through `Class.AssetDeliveryProxy`.
## Description
Defines the settings for an asset produced by `Class.IncrementalPatch... | [] | 465 | 824a617715546967dcb47dca2217ffd07a10d2043ff5ee1b153623fe3eaaff93 | 2026-08-22T06:55:07.713151+00:00 |
https://create.roblox.com/docs/en-us/reference/engine/classes/Atmosphere | Atmosphere | engineapi | # Atmosphere
**Type:** CLASS
**Inherits:** Instance
## Summary
The `Class.Atmosphere` object pushes Roblox closer toward realistic
environments where sunlight scatters in different ways depending on density
and other air particle properties.
## Description
Fog properties are hidden when Lighting contains an Atmos... | [] | 971 | 8e93885db535b99818139252e85dcaceccb66a332f83d0fe9d606375fe9f3008 | 2026-08-22T06:55:07.732306+00:00 |
https://create.roblox.com/docs/en-us/reference/engine/classes/AtmosphereSensor | AtmosphereSensor | engineapi | # AtmosphereSensor
**Type:** CLASS
**Inherits:** SensorBase
## Summary
A `Class.SensorBase` that outputs data about the
`Class.AtmosphereSensor.AirDensity|AirDensity` and
`Class.AtmosphereSensor.RelativeWindVelocity|RelativeWindVelocity` at the
sensor's position.
## Properties
### Property: `AtmosphereSensor.Air... | [] | 146 | c97f2f9ab9b6029bf60400b0b2a4ad39173119e501b1d48b64e15e48c0595f98 | 2026-08-22T06:55:07.794608+00:00 |
https://create.roblox.com/docs/en-us/reference/engine/classes/AudioAnalyzer | AudioAnalyzer | engineapi | # AudioAnalyzer
**Type:** CLASS
**Inherits:** Instance
## Summary
Takes measurements from audio streams that are connected to it via one or more
`Class.Wire|Wires`.
## Description
`Class.AudioAnalyzer` takes measurements from audio streams that are wired to
it through `Class.Wire`. It provides a single **Input** ... | [] | 1,067 | f1a002bee86b17d4c5c912f96fed9a3ef6a8b3ef04bb04604e97d6d82fdb66a6 | 2026-08-22T06:55:07.930756+00:00 |
https://create.roblox.com/docs/en-us/reference/engine/classes/Attachment | Attachment | engineapi | # Attachment
**Type:** CLASS
**Inherits:** Instance
## Summary
Defines a point and orientation relative to an ancestor `Class.PVInstance`,
`Class.Bone`, or another `Class.Attachment`.
## Description
An `Attachment` defines a point and orientation relative to an ancestor
`Class.PVInstance`, `Class.Bone`, or anothe... | [] | 2,042 | 71c11fd167c05665bc111b4ad0ab6c7a8493b0f7537850e44b0151ba515d560b | 2026-08-22T06:55:07.966007+00:00 |
https://create.roblox.com/docs/en-us/reference/engine/classes/AudioChannelMixer | AudioChannelMixer | engineapi | # AudioChannelMixer
**Type:** CLASS
**Inherits:** Instance
## Summary
Combines multiple audio streams into a single, multichannel audio stream.
## Description
`Class.AudioChannelMixer` mixes multiple audio streams into a single,
multichannel stream. It provides one combined **Input** pin, one **Output**
pin, as w... | [] | 1,073 | b97efd3afa827aab481fdb7e2db368a442577ec1956228a3974dd59b086f890b | 2026-08-22T06:55:08.075007+00:00 |
https://create.roblox.com/docs/en-us/reference/engine/classes/AssetService | AssetService | engineapi | # AssetService
**Type:** CLASS
**Tags:** NotCreatable, Service
**Inherits:** Instance
## Summary
A non-replicated service that handles asset-related queries to the Roblox web
API.
## Description
**AssetService** is a non-replicated service that handles asset-related
queries to the Roblox web API.
## Properties... | [] | 4,218 | fb53b11edf6decd63a9fbfe61742d606491c4ce4bfaa9ea469d9d1dec62b39aa | 2026-08-22T06:55:08.167056+00:00 |
https://create.roblox.com/docs/en-us/reference/engine/classes/AudioChorus | AudioChorus | engineapi | # AudioChorus
**Type:** CLASS
**Inherits:** Instance
## Summary
Makes an audio stream sound more voluminous. If applied to a single voice, it
may sound like multiple voices.
## Description
`Class.AudioChorus` makes an audio stream sound more voluminous. It provides
one **Input** pin and one **Output** pin which c... | [] | 824 | 3afa48630caa7d18499e7e21596e0a151c720c623ffae176d186ea9e91491c00 | 2026-08-22T06:55:08.188494+00:00 |
https://create.roblox.com/docs/en-us/reference/engine/classes/AudioChannelSplitter | AudioChannelSplitter | engineapi | # AudioChannelSplitter
**Type:** CLASS
**Inherits:** Instance
## Summary
Splits an audio stream into component channels so that each can be processed
independently.
## Description
`Class.AudioChannelSplitter` splits an audio stream into component channels so
that each can be processed independently. It provides o... | [] | 1,115 | fc809eb8f488f99f5e9fe460ff9423ed241521f81fcbd78fac97e0e5d183d3c8 | 2026-08-22T06:55:08.211536+00:00 |
https://create.roblox.com/docs/en-us/reference/engine/classes/AudioCompressor | AudioCompressor | engineapi | # AudioCompressor
**Type:** CLASS
**Inherits:** Instance
## Summary
Adjusts the dynamic range of input streams.
## Description
`Class.AudioCompressor` adjusts the dynamic range of audio streams. Any
momentary bursts of loudness will be clamped down according to the
compressor's properties.
`Class.AudioCompressor... | [] | 1,193 | b764cfe25fbe34667f6846f328433700323b27a854293f71eff99314527addad | 2026-08-22T06:55:08.256090+00:00 |
End of preview. Expand in Data Studio
Last collected: 2026-08-22 14:00
Contains 1462 contents
- Downloads last month
- 44