# API Reference

## Overview

This API Reference is a key document that provides precise usage details for properties, functions, and events used in scripts. When designing or implementing game features, the API Reference helps developers quickly and accurately integrate the necessary functionalities.

If you liken the process of writing a script to cooking, **the script represents the cooking process**, while**the API Reference serves as the cookbook**. Just as knowing the right ingredients and tools makes cooking easier, using the API Reference simplifies and streamlines script development. It helps implement desired features accurately while reducing development time.

## How to Use

For example, if you want to display a message when a player joins the game, refer to the API Reference for the `PlayerAdded` event and the `Connect` method. Based on this, you can write a script like the following:

```lua
local Players = game:GetService("Players")

local function EnterPlayer(player)
    print(player.Name .. " has joined the game!")
end
Players.PlayerAdded:Connect(EnterPlayer)
```

Whenever you have questions during development or feel unsure about how to implement a specific feature, **always refer to the API Reference as your first point of reference**. It will not only help with writing code but also significantly enhance the overall productivity and quality of game development.

## Class Inheritance Hierarchy

* InstanceBase
  * [Instance](/development/api-reference/classes/instance.md)
    * [ActionRunner](/development/api-reference/classes/actionrunner.md)
    * [ActionSequence](/development/api-reference/classes/actionsequence.md)
    * [ActionSequenceService](/development/api-reference/classes/actionsequenceservice.md)
    * [Animation](/development/api-reference/classes/animation.md)
    * [AnimationTrack](/development/api-reference/classes/animationtrack.md)
    * [Animator](/development/api-reference/classes/animator.md)
    * [Atmosphere](/development/api-reference/classes/atmosphere.md)
    * [Attachment](/development/api-reference/classes/attachment.md)
      * [Bone](/development/api-reference/classes/bone.md)
    * [Backpack](/development/api-reference/classes/backpack.md)
    * [BackpackItem](/development/api-reference/classes/backpackitem.md)
      * [Tool](/development/api-reference/classes/tool.md)
    * [Beam](/development/api-reference/classes/beam.md)
    * [BindableEvent](/development/api-reference/classes/bindableevent.md)
    * [BlendSpace](/development/api-reference/classes/blendspace.md)
    * [Camera](/development/api-reference/classes/camera.md)
    * [CharacterMesh](/development/api-reference/classes/charactermesh.md)
    * [CollectionService](/development/api-reference/classes/collectionservice.md)
    * [Constraint](/development/api-reference/classes/constraint.md)
      * [AngularVelocity](/development/api-reference/classes/angularvelocity.md)
      * [LinearVelocity](/development/api-reference/classes/linearvelocity.md)
      * [VectorForce](/development/api-reference/classes/vectorforce.md)
    * [ContextActionService](/development/api-reference/classes/contextactionservice.md)
    * [CoreGui](/development/api-reference/classes/coregui.md)
    * [DataStoreGetOptions](/development/api-reference/classes/datastoregetoptions.md)
    * [DataStoreIncrementOptions](/development/api-reference/classes/datastoreincrementoptions.md)
    * [DataStoreInfo](/development/api-reference/classes/datastoreinfo.md)
    * [DataStoreKeyInfo](/development/api-reference/classes/datastorekeyinfo.md)
    * [DataStoreService](/development/api-reference/classes/datastoreservice.md)
    * [DataStoreSetOptions](/development/api-reference/classes/datastoresetoptions.md)
    * [Folder](/development/api-reference/classes/folder.md)
    * [GlobalDataStore](/development/api-reference/classes/globaldatastore.md)
      * [DataStore](/development/api-reference/classes/datastore.md)
      * [OrderedDataStore](/development/api-reference/classes/ordereddatastore.md)
    * [GuiBase2d](/development/api-reference/classes/guibase2d.md)
      * [GuiObject](/development/api-reference/classes/guiobject.md)
        * [Frame](/development/api-reference/classes/frame.md)
        * [GuiButton](/development/api-reference/classes/guibutton.md)
          * [ImageButton](/development/api-reference/classes/imagebutton.md)
          * [TextButton](/development/api-reference/classes/textbutton.md)
        * [ImageLabel](/development/api-reference/classes/imagelabel.md)
        * [ScrollingFrame](/development/api-reference/classes/scrollingframe.md)
        * [TextLabel](/development/api-reference/classes/textlabel.md)
      * [LayerCollector](/development/api-reference/classes/layercollector.md)
        * [ScreenGui](/development/api-reference/classes/screengui.md)
        * [SurfaceGuiBase](/development/api-reference/classes/surfaceguibase.md)
          * [BillboardGui](/development/api-reference/classes/billboardgui.md)
          * [SurfaceGui](/development/api-reference/classes/surfacegui.md)
    * [HttpService](/development/api-reference/classes/httpservice.md)
    * [Humanoid](/development/api-reference/classes/humanoid.md)
    * [HumanoidDescription](/development/api-reference/classes/humanoiddescription.md)
    * [InputObject](/development/api-reference/classes/inputobject.md)
    * [Light](/development/api-reference/classes/light.md)
      * [PointLight](/development/api-reference/classes/pointlight.md)
      * [SpotLight](/development/api-reference/classes/spotlight.md)
    * [Lighting](/development/api-reference/classes/lighting.md)
    * [LuaSourceContainer](/development/api-reference/classes/luasourcecontainer.md)
      * [BaseScript](/development/api-reference/classes/basescript.md)
        * [LocalScript](/development/api-reference/classes/localscript.md)
        * [Script](/development/api-reference/classes/script.md)
      * [ModuleScript](/development/api-reference/classes/modulescript.md)
    * [MarketplaceService](/development/api-reference/classes/marketplaceservice.md)
    * [MaterialService](/development/api-reference/classes/materialservice.md)
    * [MaterialVariant](/development/api-reference/classes/materialvariant.md)
    * [Mouse](/development/api-reference/classes/mouse.md)
    * [OverlayBase](/development/api-reference/classes/overlaybase.md)
      * [Fill](/development/api-reference/classes/fill.md)
      * [Outline](/development/api-reference/classes/outline.md)
    * [Pages](/development/api-reference/classes/pages.md)
      * [DataStoreKeyPages](/development/api-reference/classes/datastorekeypages.md)
      * [DataStoreListingPages](/development/api-reference/classes/datastorelistingpages.md)
    * [ParticleEmitter](/development/api-reference/classes/particleemitter.md)
    * [PhysicsService](/development/api-reference/classes/physicsservice.md)
    * [Player](/development/api-reference/classes/player.md)
    * [PlayerGui](/development/api-reference/classes/playergui.md)
    * [Players](/development/api-reference/classes/players.md)
    * [PlayerScripts](/development/api-reference/classes/playerscripts.md)
    * [ProximityPrompt](/development/api-reference/classes/proximityprompt.md)
    * [ProximityPromptService](/development/api-reference/classes/proximitypromptservice.md)
    * [PVInstance](/development/api-reference/classes/pvinstance.md)
      * [BasePart](/development/api-reference/classes/basepart.md)
        * [FormFactorPart](/development/api-reference/classes/formfactorpart.md)
        * [MeshPart](/development/api-reference/classes/meshpart.md)
        * [Part](/development/api-reference/classes/part.md)
          * [SpawnLocation](/development/api-reference/classes/spawnlocation.md)
      * [Model](/development/api-reference/classes/model.md)
      * [SimulationBall](/development/api-reference/classes/simulationball.md)
      * [Skeleton](/development/api-reference/classes/skeleton.md)
    * [RemoteEvent](/development/api-reference/classes/remoteevent.md)
    * [ReplicatedStorage](/development/api-reference/classes/replicatedstorage.md)
    * [RunService](/development/api-reference/classes/runservice.md)
    * [ServerScriptService](/development/api-reference/classes/serverscriptservice.md)
    * [ServerStorage](/development/api-reference/classes/serverstorage.md)
    * [ServiceProvider](/development/api-reference/classes/serviceprovider.md)
      * [DataModel](/development/api-reference/classes/datamodel.md)
      * [GenericSettings](/development/api-reference/classes/genericsettings.md)
        * [UserSettings](/development/api-reference/classes/usersettings.md)
    * [Sound](/development/api-reference/classes/sound.md)
    * [SoundGroup](/development/api-reference/classes/soundgroup.md)
    * [SoundService](/development/api-reference/classes/soundservice.md)
    * [StarterCharacterScripts](/development/api-reference/classes/startercharacterscripts.md)
    * [StarterGui](/development/api-reference/classes/startergui.md)
    * [StarterPack](/development/api-reference/classes/starterpack.md)
    * [StarterPlayer](/development/api-reference/classes/starterplayer.md)
    * [StarterPlayerScripts](/development/api-reference/classes/starterplayerscripts.md)
    * [Team](/development/api-reference/classes/team.md)
    * [Teams](/development/api-reference/classes/teams.md)
    * [TeleportService](/development/api-reference/classes/teleportservice.md)
    * [Trail](/development/api-reference/classes/trail.md)
    * [TweenBase](/development/api-reference/classes/tweenbase.md)
      * [Tween](/development/api-reference/classes/tween.md)
    * [TweenService](/development/api-reference/classes/tweenservice.md)
    * [UIAspectRatioConstraint](/development/api-reference/classes/uiaspectratioconstraint.md)
    * [UIGridStyleLayout](/development/api-reference/classes/uigridstylelayout.md)
      * [UIGridLayout](/development/api-reference/classes/uigridlayout.md)
      * [UIListLayout](/development/api-reference/classes/uilistlayout.md)
    * [UserGameSettings](/development/api-reference/classes/usergamesettings.md)
    * [UserInputService](/development/api-reference/classes/userinputservice.md)
    * [ValueBase](/development/api-reference/classes/valuebase.md)
      * [BoolValue](/development/api-reference/classes/boolvalue.md)
      * [IntValue](/development/api-reference/classes/intvalue.md)
      * [NumberValue](/development/api-reference/classes/numbervalue.md)
      * [StringValue](/development/api-reference/classes/stringvalue.md)
    * [VFXPreset](/development/api-reference/classes/vfxpreset.md)
    * [WorldRankService](/development/api-reference/classes/worldrankservice.md)
    * [WorldRoot](/development/api-reference/classes/worldroot.md)
      * [Workspace](/development/api-reference/classes/workspace.md)
    * [WrapLayer](/development/api-reference/classes/wraplayer.md)
    * [WrapTarget](/development/api-reference/classes/wraptarget.md)


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.overdare.com/development/api-reference.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.