API:Class reference

(Redirected from Class Reference)
Object Icon.pngInstance
Accoutrement icon.pngAccoutrement
  Accoutrement icon.pngAccessory
  Hat icon.pngHat
Animation icon.pngAnimation
Animation icon.pngAnimationController
Animation icon.pngAnimationTrack
Animation icon.pngAnimator
Cloud.pngAssetService
ExplorerImageIndex81.pngAttachment
BadgeService.pngBadgeService
Object Icon.pngBasePlayerGui
  StarterGui icon.pngCoreGui
  StarterGui icon.pngPlayerGui
  StarterGui icon.pngStarterGui
ExplorerImageIndex67.pngBindableEvent
Function Icon.pngBindableFunction
Object Icon.pngBodyMover
  BodyForce icon.pngBodyAngularVelocity
  BodyForce icon.pngBodyForce
  BodyForce icon.pngBodyGyro
  BodyForce icon.pngBodyPosition
  BodyForce icon.pngBodyThrust
  BodyForce icon.pngBodyVelocity
  BodyForce icon.pngRocketPropulsion
Value icon.pngBoolValue
Value icon.pngBrickColorValue
Imagelabel icon.pngButton
Value icon.pngCFrameValue
Camera icon.pngCamera
ExplorerImageIndex69.pngChangeHistoryService
Object Icon.pngCharacterAppearance
  Object blank Icon.pngBodyColors
  Animation icon.pngCharacterMesh
  Object Icon.pngClothing
   Pants icon.pngPants
   Shirt icon.pngShirt
  Shirtgraphic icon.pngShirtGraphic
  Object blank Icon.pngSkin
Message icon.pngChat
Clickdetector icon.pngClickDetector
CollectionService.pngCollectionService
Value icon.pngColor3Value
Configuration icon.pngConfiguration
Object Icon.pngConstraint
  AlignOrientation.pngAlignOrientation
  AlignPosition.pngAlignPosition
  ExplorerImageIndex86.pngBallSocketConstraint
  ExplorerImageIndex87.pngHingeConstraint
  LineForce.pngLineForce
  ExplorerImageIndex90.pngRodConstraint
  ExplorerImageIndex89.pngRopeConstraint
  ExplorerImageIndex82.pngSlidingBallConstraint
   ExplorerImageIndex82.pngCylindricalConstraint
   ExplorerImageIndex88.pngPrismaticConstraint
  ExplorerImageIndex91.pngSpringConstraint
  Torque.pngTorque
  VectorForce.pngVectorForce
Cloud.pngContentProvider
Clickdetector icon.pngContextActionService
Object Icon.pngController
  UserInputService.pngHumanoidController
  UserInputService.pngSkateboardController
  UserInputService.pngVehicleController
Value icon.pngCustomEvent
Value icon.pngCustomEventReceiver
Object Icon.pngDataModelMesh
  Object Icon.pngBevelMesh
   Mesh icon.pngBlockMesh
   Mesh icon.pngCylinderMesh
  Mesh icon.pngFileMesh
   Mesh icon.pngSpecialMesh
ExplorerImageIndex69.pngDataStoreService
Debris icon.pngDebris
Configuration icon.pngDebugSettings
BreakpointIcon.pngDebuggerBreakpoint
DebuggerManager.pngDebuggerManager
DebuggerWatch.pngDebuggerWatch
Dialog icon.pngDialog
DialogChoice icon.pngDialogChoice
Value icon.pngDoubleConstrainedValue
Clickdetector icon.pngDragger
Explosion icon.pngExplosion
Object Icon.pngFaceInstance
  Decal icon.pngDecal
   Texture icon.pngTexture
Object Icon.pngFeature
  Hole.pngHole
  MotorFeature.pngMotorFeature
Fire icon.pngFire
ExplorerImageIndex77.pngFolder
Forcefield icon.pngForceField
Workspace icon.pngGamePassService
Configuration icon.pngGameSettings
ExplorerImageIndex69.pngGlobalDataStore
  ExplorerImageIndex69.pngOrderedDataStore
Players icon.pngGroupService
Object Icon.pngGuiBase
  Object Icon.pngGuiBase2d
   Object Icon.pngGuiObject
    Frame icon.pngFrame
    Object Icon.pngGuiButton
     Imagebutton icon.pngImageButton
     Textbutton icon.pngTextButton
    Object Icon.pngGuiLabel
     Imagelabel icon.pngImageLabel
     Textlabel icon.pngTextLabel
    Frame icon.pngScrollingFrame
    Textbutton icon.pngTextBox
   Object Icon.pngLayerCollector
    BillboardGui icon.pngBillboardGui
    Screengui icon.pngScreenGui
    BillboardGui icon.pngSurfaceGui
  Object Icon.pngGuiBase3d
   Value icon.pngFloorWire
   Object Icon.pngPVAdornment
    Object Icon.pngHandleAdornment
     Slectionbox icon.pngBoxHandleAdornment
     Slectionbox icon.pngConeHandleAdornment
     Slectionbox icon.pngCylinderHandleAdornment
     Slectionbox icon.pngImageHandleAdornment
     Slectionbox icon.pngLineHandleAdornment
     Slectionbox icon.pngSphereHandleAdornment
    Slectionbox icon.pngSelectionBox
    Slectionbox icon.pngSelectionSphere
   Object Icon.pngPartAdornment
    Object Icon.pngHandlesBase
     Archandles icon.pngArcHandles
     Handles icon.pngHandles
    Surfaceselection icon.pngSurfaceSelection
   Object Icon.pngSelectionLasso
    Selectionlasso icon.pngSelectionPartLasso
    Selectionlasso icon.pngSelectionPointLasso
Object Icon.pngGuiItem
  Starterpack icon.pngBackpack
  Object Icon.pngBackpackItem
   HopperBin icon.pngHopperBin
   Tool icon.pngTool
    Flag icon.pngFlag
  Starterpack icon.pngStarterPack
ExplorerImageIndex27.pngGuiService
UserInputService.pngHapticService
HttpService.pngHttpService
Humanoid icon.pngHumanoid
Clickdetector icon.pngInputObject
Cloud.pngInsertService
Value icon.pngIntConstrainedValue
Value icon.pngIntValue
Object Icon.pngJointInstance
  Object Icon.pngDynamicRotate
   Weld icon.pngRotateP
   Weld icon.pngRotateV
  Weld icon.pngGlue
  Object Icon.pngManualSurfaceJointInstance
   Weld icon.pngManualGlue
   Weld icon.pngManualWeld
  Weld icon.pngMotor
   Weld icon.pngMotor6D
  Weld icon.pngRotate
  Weld icon.pngSnap
  Weld icon.pngVelocityMotor
  Weld icon.pngWeld
Weld icon.pngJointsService
Animation icon.pngKeyframe
Animation icon.pngKeyframeSequence
Animation icon.pngKeyframeSequenceProvider
Object Icon.pngLight
  Lighting icon.pngPointLight
  Lighting icon.pngSpotLight
  Lighting icon.pngSurfaceLight
Lighting icon.pngLighting
ExplorerImageIndex92.pngLocalizationService
ExplorerImageIndex76.pngLocalizationTable
LogService.pngLogService
Configuration icon.pngLuaSettings
Object Icon.pngLuaSourceContainer
  Object Icon.pngBaseScript
   CoreScript.pngCoreScript
   Script icon.pngScript
    Localscript icon.pngLocalScript
  ExplorerImageIndex76.pngModuleScript
MarketplaceService.pngMarketplaceService
Message icon.pngMessage
  Message icon.pngHint
Mouse.pngMouse
  Mouse.pngPlayerMouse
  Mouse.pngPluginMouse
NetworkReplicator icon.pngNetworkMarker
Object Icon.pngNetworkPeer
  Networkclient icon.pngNetworkClient
  ExplorerImageIndex15.pngNetworkServer
Object Icon.pngNetworkReplicator
  NetworkReplicator icon.pngClientReplicator
  NetworkReplicator icon.pngServerReplicator
Configuration icon.pngNetworkSettings
Value icon.pngNumberValue
Value icon.pngObjectValue
Object Icon.pngPVInstance
  Object Icon.pngBasePart
   Part icon.pngCornerWedgePart
   ExplorerImageIndex73.pngMeshPart
   Part icon.pngPart
    Flagstand icon.pngFlagStand
    Seat icon.pngSeat
    Seat icon.pngSkateboardPlatform
    Spawnlocation icon.pngSpawnLocation
   Object Icon.pngPartOperation
    ExplorerImageIndex72.pngNegateOperation
    ExplorerImageIndex73.pngUnionOperation
   Terrain icon.pngTerrain
   Part icon.pngTrussPart
   Seat icon.pngVehicleSeat
   Part icon.pngWedgePart
  Model icon.pngModel
   Workspace icon.pngWorkspace
Object Icon.pngPages
  Pages.pngDataStorePages
  Pages.pngFriendPages
  Pages.pngInventoryPages
  Pages.pngStandardPages
ExplorerImageIndex80.pngParticleEmitter
NavPath.pngPath
Object blank Icon.pngPathWaypoint
Forcefield icon.pngPathfindingService
Debris icon.pngPhysicsService
Configuration icon.pngPhysicsSettings
Player icon.pngPlayer
ExplorerImageIndex78.pngPlayerScripts
Players icon.pngPlayers
Plugin.pngPlugin
Plugin.pngPluginManager
PointsIcon.pngPointsService
Animation icon.pngPose
Object Icon.pngPostEffect
  ExplorerImageIndex83.pngBloomEffect
  ExplorerImageIndex83.pngBlurEffect
  ExplorerImageIndex83.pngColorCorrectionEffect
  ExplorerImageIndex83.pngSunRaysEffect
Value icon.pngRayValue
Pages.pngReflectionMetadata
ExplorerImageIndex75.pngRemoteEvent
ExplorerImageIndex74.pngRemoteFunction
Configuration icon.pngRenderSettings
ExplorerImageIndex70.pngReplicatedFirst
ExplorerImageIndex70.pngReplicatedStorage
RunService.pngRunService
ExplorerImageIndex78.pngScriptContext
ExplorerImageIndex76.pngScriptDebugger
Slectionbox icon.pngSelection
ExplorerImageIndex71.pngServerScriptService
ExplorerImageIndex69.pngServerStorage
Object Icon.pngServiceProvider
  DataModel.pngDataModel
  Object Icon.pngGenericSettings
   Configuration icon.pngAnalysticsSettings
   Configuration icon.pngGlobalSettings
   Configuration icon.pngUserSettings
Sky icon.pngSky
Smoke icon.pngSmoke
Sound icon.pngSound
Object Icon.pngSoundEffect
  ExplorerImageIndex84.pngChorusSoundEffect
  ExplorerImageIndex84.pngCompressorSoundEffect
  ExplorerImageIndex84.pngDistortionSoundEffect
  ExplorerImageIndex84.pngEchoSoundEffect
  ExplorerImageIndex84.pngEqualizerSoundEffect
  ExplorerImageIndex84.pngFlangeSoundEffect
  ExplorerImageIndex84.pngPitchShiftSoundEffect
  ExplorerImageIndex84.pngReverbSoundEffect
  ExplorerImageIndex84.pngTremoloSoundEffect
ExplorerImageIndex85.pngSoundGroup
Soundservice icon.pngSoundService
Sparkles icon.pngSparkles
Starterpack icon.pngStarterGear
ExplorerImageIndex79.pngStarterPlayer
ExplorerImageIndex78.pngStarterPlayerScripts
  ExplorerImageIndex78.pngStarterCharacterScripts
Stats.pngStats
Value icon.pngStringValue
Configuration icon.pngStudio
Configuration icon.pngTaskScheduler
Team icon.pngTeam
Teams icon.pngTeams
ExplorerImageIndex70.pngTeleportService
Terrain icon.pngTerrainRegion
TestService icon.pngTestService
Textlabel icon.pngTextFilterResult
Textlabel icon.pngTextService
ToolbarIcon.pngToolbar
ExplorerImageIndex93.pngTrail
Object Icon.pngTweenBase
  Tween.pngTween
Tween.pngTweenService
Object Icon.pngUIBase
  Object Icon.pngUIComponent
   Object Icon.pngUIConstraint
    ExplorerImageIndex26.pngUIAspectRatioConstraint
    ExplorerImageIndex26.pngUISizeConstraint
    ExplorerImageIndex26.pngUITextSizeConstraint
   Object Icon.pngUILayout
    Object Icon.pngUIGridStyleLayout
     ExplorerImageIndex26.pngUIGridLayout
     ExplorerImageIndex26.pngUIListLayout
     ExplorerImageIndex26.pngUIPageLayout
     ExplorerImageIndex26.pngUITableLayout
   ExplorerImageIndex26.pngUIPadding
   ExplorerImageIndex26.pngUIScale
Configuration icon.pngUserGameSettings
UserInputService.pngUserInputService
VRService.pngVRService
Value icon.pngVector3Value
ExplorerImageIndex94.pngWeldConstraint

The following is documentation for specific Roblox Lua classes.

Classes that are listed here can be created using the Instance.new constructor.
(However, there are several exceptions, which you might want to be aware of)

Roblox's API also has several built-in data types, which can be viewed on this page. Almost all of the classes here make use of these data types, such as the Position property of a Part icon.pngPart, which uses the Vector3 data type.

If you are looking for information on undocumented classes, one of your best resources is the Object Browser pane (under the Help menu in Roblox Studio). Alternatively, you could look through the API dump itself.

All Game objects are based on Instance and have the "global" methods, properties, and events defined there. Additionally, some classes derive from others, in a hierarchical tree-like structure, shown on the left.

All properties, methods, events and their arguments, in both this reference and the Object Browser are described using C syntax - their type is written before their name.
For example, in this definition of a method:

Instance LoadAsset(int assetId)

Instance is the type of value returned by the method
LoadAsset is the name of the method
int is the type of the first parameter
assetId is the name of the first parameter

In addition to the functions and members listed here, Roblox exposes many standard and custom Lua functions. Please see the Global Namespace for a complete list of all global functions and members.

Class Categories

The following is a list of officially declared class categories, and the classes that are under them.

3D Interfaces

Objects that can be applied to Parts, that are intended to be viewed or interacted with by users.

Texture icon.pngTexture Decal icon.pngDecal DialogChoice icon.pngDialogChoice
Dialog icon.pngDialog Clickdetector icon.pngClickDetector

Adornments

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

Handles icon.pngHandles Slectionbox icon.pngSelectionBox Surfaceselection icon.pngSurfaceSelection
Archandles icon.pngArcHandles Slectionbox icon.pngSelectionSphere

Animations

Objects that are designed to work with Animations.

Animation icon.pngAnimationController Animation icon.pngAnimation

Avatar

Objects that are associated with the appearance and functionality of a character.

Shirtgraphic icon.pngShirtGraphic Shirt icon.pngShirt Object blank Icon.pngBodyColors
Humanoid icon.pngHumanoid Accoutrement icon.pngAccessory Forcefield icon.pngForceField
Pants icon.pngPants

Effects

Objects that are used to make effects in the game world.

Smoke icon.pngSmoke Explosion icon.pngExplosion Sound icon.pngSound
Sparkles icon.pngSparkles ExplorerImageIndex80.pngParticleEmitter ExplorerImageIndex93.pngTrail
Fire icon.pngFire

GUI

Objects that are used in the creation of user interfaces.

Imagelabel icon.pngImageLabel Textbutton icon.pngTextBox BillboardGui icon.pngBillboardGui
Textlabel icon.pngTextLabel Frame icon.pngScrollingFrame Imagebutton icon.pngImageButton
Textbutton icon.pngTextButton Screengui icon.pngScreenGui BillboardGui icon.pngSurfaceGui
Frame icon.pngFrame

Interaction

Objects that revolve around user interactions.

Tool icon.pngTool Team icon.pngTeam Seat icon.pngVehicleSeat
Spawnlocation icon.pngSpawnLocation Seat icon.pngSeat

Lights

Objects that alter the lighting of a scene.

Lighting icon.pngPointLight Lighting icon.pngSpotLight Lighting icon.pngSurfaceLight

Meshes

Objects that can be used to alter the visual appearance of Parts.

Mesh icon.pngSpecialMesh Mesh icon.pngBlockMesh Animation icon.pngCharacterMesh
Mesh icon.pngCylinderMesh

Parts

The essential building blocks of Roblox, that interact with each other physically. All classes here inherit from the BasePart abstract class. These parts are all rendered in 3D if placed in the Workspace icon.pngWorkspace.

ExplorerImageIndex73.pngMeshPart Part icon.pngWedgePart Model icon.pngModel
Part icon.pngPart Part icon.pngTrussPart Part icon.pngCornerWedgePart

Physics

Objects that are used to manipulate the physics of 3D objects in Roblox.

VectorForce.pngVectorForce Torque.pngTorque BodyForce icon.pngRocketPropulsion
BodyForce icon.pngBodyGyro ExplorerImageIndex89.pngRopeConstraint AlignPosition.pngAlignPosition
ExplorerImageIndex87.pngHingeConstraint ExplorerImageIndex81.pngAttachment ExplorerImageIndex94.pngWeldConstraint
BodyForce icon.pngBodyAngularVelocity BodyForce icon.pngBodyForce BodyForce icon.pngBodyPosition
AlignOrientation.pngAlignOrientation ExplorerImageIndex86.pngBallSocketConstraint LineForce.pngLineForce
ExplorerImageIndex88.pngPrismaticConstraint BodyForce icon.pngBodyThrust ExplorerImageIndex91.pngSpringConstraint
ExplorerImageIndex90.pngRodConstraint BodyForce icon.pngBodyVelocity

Scripts

Objects that are essential to controlling game logic, and developing games.

ExplorerImageIndex75.pngRemoteEvent Script icon.pngScript ExplorerImageIndex77.pngFolder
ExplorerImageIndex76.pngModuleScript ExplorerImageIndex74.pngRemoteFunction ExplorerImageIndex67.pngBindableEvent
Localscript icon.pngLocalScript Function Icon.pngBindableFunction

Values

Objects that hold specific value types. They allow for basic communication of data between Scripts, and the simple replication of data from the server to the client.

Value icon.pngBrickColorValue Value icon.pngCFrameValue Value icon.pngObjectValue
Value icon.pngIntValue Value icon.pngNumberValue Value icon.pngVector3Value
Value icon.pngRayValue Value icon.pngStringValue Value icon.pngColor3Value
Value icon.pngBoolValue