Class reference

Up one category:
Lua Help

The Legacy Roblox Wiki features an API Reference that documents all of the classes, data types, enumerations, functions, events, callbacks, and properties that can be used to create games on classic Roblox.

• This page, the Class Reference, documents classes. Classes are core objects and services in Roblox's engine. Classes contain properties, methods, events and callbacks.
• Data Types are types unique to the Roblox engine, They can contain constructors, properties, and methods.
• Enums are groups of constants that define preset values that you can use with other APIs. Documentation for the generic Enumeration data type is here.
• Globals are functions or properties that you can use in any script. Most globals are native to the Lua programming language while some are exclusive to Roblox's implementation.

If you are looking for more information on undocumented API features, one of your best resources is the Object Browser pane (under the Help menu in Roblox Studio). There are also so many more objects used internally by the game engine which has not yet been added to the list here. If it has documentation on the wiki, it can be found at the Category:ROBLOX_Lua_Objects category.

Parts

As the essential building blocks of Roblox, these objects interact with each other physically. All classes here inherit from the BasePart abstract class.There parts all all rendered in 3D if placed in workspace.

• Part

• CornerWedgePart

• SkateboardPlatform

• TrussPart

• FlagStand

• File:Platform icon.pngPlatform

• Seat

• VehicleSeat

• SkateboardPlatform

• SpawnLocation
• Terrain

Part modifiers

These objects, when parented to a part, will change the appearance or behavior of the part.

• BlockMesh

• ClickDetector

• CylinderMesh

• Decal

• FileMesh

• Fire

• Hole

• Smoke

• Sparkles

• SpecialMesh

• Texture

Body movers

Similar to part modifiers, these objects work on the part they are parented to. These objects alter the position, orientation, or movement of a part. All classes here inherit from the BodyMover abstract class.

• BodyAngularVelocity

• BodyForce

• BodyGyro

• BodyPosition

• BodyThrust

• BodyVelocity

• RocketPropulsion

Gameplay

These objects are used in general gameplay of a place.

• Camera

• File:Controller icon.pngController

• Dialog

• DialogChoice

• Explosion

• Flag

• Hint

• HopperBin

• Message

• Player

• Sky

• Sound

• StockSound

• Tool

Humanoids

These objects are usually found in Humanoids. An example is a Player's Character.

• Humanoid

• Accoutrement

• Animation

• AnimationTrack

• BodyColors

• ForceField

• Hat

• File:Keyframe icon.pngKeyframe

• Pants

• File:Pose icon.pngPose

• Shirt

• ShirtGraphic

• Skin

GUI

These objects display graphical elements in 2-dimensional space on the player's screen, in front of the 3D world.

• ScreenGui

• Frame

• ImageButton

• ImageLabel

• File:NotificationBox icon.pngNotificationBox

• TextBox

• TextButton

• TextLabel

• GuiMain

3D GUI

These objects display graphical elements in 3-dimensional space. While they don't interact physically with parts, they are usually attached to parts in some way.

• ArcHandles

• BillboardGui

• Handles

• SelectionBox

• SelectionPartLasso

• SelectionPointLasso

• SurfaceSelection

Scripting

These objects are involved in adding scripted functionality to a game.

• Script

• LocalScript

• File:BindableEvent icon.pngBindableEvent

• File:BindableFunction icon.pngBindableFunction

• File:Plugin icon.pngPlugin

• File:PluginManager icon.pngPluginManager

• File:PluginMouse icon.pngPluginMouse

Values

These objects exist to hold specific value types. They are essential for communicating data between Scripts.

• BoolValue

• BrickColorValue

• Color3Value

• CFrameValue

• NumberValue

• ObjectValue

• RayValue

• StringValue

• Vector3Value

Joints

These objects bind parts together, sometimes with an extra effect such as a hinge or motor. All classes here inherit from the JointInstance abstract class.

• Glue

• Motor

• MotorFeature

• Motor6D

• Rotate

• RotateP

• RotateV

• Snap

• VelocityMotor

• Weld

Containers

These objects are designed to contain other objects as children. For example, the Workspace holds objects that are simulated as the game runs.

• Backpack

• Configuration

• DataModel

• File:PlayerGui icon.pngPlayerGui

• StarterGear

• File:StarterGui icon.pngStarterGui

• Teams

Services

These objects generally operate in the background, and may be helpful with place development. They're unique in that they may only have one instance of themselves, and can be acquired with the GetService method.

• BadgeService

• Debris

• File:HtmlService icon.pngHtmlService

• InsertService

• Lighting

• StarterPack

• Players

• ScriptContext

• SoundService

• Teams

• TeleportService

• File:Timer icon.pngTimer

• Workspace

Internal

These objects are used internally by the game engine. Generally, trying to use them in Scripts or LocalScripts will result in an error. However, Plugins and the Command Bar in Studio may use them. They might come in handy for making Plugins to enhance your Studio workflow.

Structural Classes

Structural Classes, or "superclasses", are objects which can't be created or used with Instance.new in game, but are the basis for other objects to inherit properties, events, and methods. For example, Part , TrussPart , and WedgePart , all inherit from the structural class BasePart .

Essentially, they're used for creating objects that are mostly similar, but slightly diverge, such as a Part and TrussPart. They both require the same properties and methods but their physical appearance and functionality diverge.

• Instance

• Accoutrement

• File:BackpackItem icon.pngBackpackItem

• BasePart

• File:BasePlayerGui icon.pngBasePlayerGui

• File:Clothing icon.pngClothing

• ControllerService

• File:Feature icon.pngFeature

• File:FormFactorPart icon.pngFormFactorPart

• File:GuiBase icon.pngGuiBase

• File:GuiButton icon.pngGuiButton

• File:GuiLabel icon.pngGuiLabel

• File:GuiObject icon.pngGuiObject

• JointInstance

• File:NetworkPeer icon.pngNetworkPeer

• File:PVAdornment icon.pngPVAdornment

• File:PVInstance icon.pngPVInstance

• File:ReflectionMetadataItem icon.pngReflectionMetadataItem

• File:ROOT icon.pngROOT

• File:StatsItem icon.pngStatsItem

Objects

• File:AnimationTrackState icon.pngAnimationTrackState

• File:AutoJoint icon.pngAutoJoint

• File:HumanoidController icon.pngHumanoidController

• File:LocalBackpack icon.pngLocalBackpack

• File:LocalBackpackItem icon.pngLocalBackpackItem

• File:Mouse icon.pngMouse

• NetworkClient

• File:NetworkMarker icon.pngNetworkMarker

• NetworkReplicator

• File:NetworkServer icon.pngNetworkServer

• NetworkSettings

• PrismPart

• File:PyramidPart icon.pngPyramidPart

• File:RightAngleRampPart icon.pngRightAngleRampPart

• File:ReflectionMetadataMember icon.pngReflectionMetadataMember

• File:RunningAverageItemDouble icon.pngRunningAverageItemDouble

• File:Stats icon.pngStats

• TextureTrail

• File:TouchTransmitter icon.pngTouchTransmitter

• File:VirtualUser icon.pngVirtualUser

Services

• File:ChangeHistoryService icon.pngChangeHistoryService

• CollectionService

• ContentProvider

• CoreGui

• File:FlagStandService icon.pngFlagStandService

• File:FriendService icon.pngFriendService

• File:Geometry icon.pngGeometry

• File:GuidRegistryService icon.pngGuidRegistryService

• GuiService

• File:KeyframeSequenceProvider icon.pngKeyframeSequenceProvider

• File:MeshService icon.pngMeshService

• PhysicsService

• File:RenderHooksService icon.pngRenderHooksService

• RunService

• Selection

• File:SocialService icon.pngSocialService

• File:SpawnerService icon.pngSpawnerService

• File:TestService icon.pngTestService

• File:TextService icon.pngTextService

• File:TextureContentProvider icon.pngTextureContentProvider

• File:TweenService icon.pngTweenService

Studio

Some classes are used directly by Studio, but others can be used by Studio plugins to analyze properties of the game engine, hardware, and more.

• DebugSettings

• FastLogSettings

• File:FunctionalTest icon.pngFunctionalTest

• GlobalSettings

• File:StudioSettings icon.pngStudioSettings

• LuaSettings

• File:ProfilingItem icon.pngProfilingItem

• File:PseudoPlayer icon.pngPseudoPlayer

• RenderSettings

• File:StudioTool icon.pngStudioTool