π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, whilethe 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:
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
Instance ββ TweenService ββ RunService ββ MaterialService ββ PhysicsService ββ SoundService ββ UserInputService ββ ContextActionService ββ DataStoreService ββ HttpService ββ Players ββ ReplicatedStorage ββ ServerScriptService ββ ServerStorage ββ StarterGui ββ StarterPlayer β ββ StarterPlayerScripts β ββ StarterCharacterScripts ββ MaterialService ββ CollectionService ββ Constraint β ββ AngularVelocity β ββ LinearVelocity β ββ VectorForce ββ JointInstance β ββ Motor β ββ Motor6D ββ PVInstance β ββ BasePart β β ββ Part β β β ββ FormFactorPart β β β β ββ SpawnLocation β β ββ MeshPart β ββ Model β ββ Skeleton ββ Attachment β ββ Bone ββ Animation ββ AnimationTrack ββ TweenBase β ββ Tween ββ Player ββ StarterPack ββ PlayerGui ββ PlayerScripts ββ BindableEvent ββ RemoteEvent ββ Camera ββ InputObject ββ Mouse ββ WrapLayer ββ WrapTarget ββ CharacterMesh ββ Humanoid ββ HumanoidDescription ββ Folder ββ ServiceProvider β ββ DataModel ββ Atmosphere ββ MaterialVariant ββ LuaSourceContainer β ββ BaseScript β β ββ Script β β ββ LocalScript β ββ ModuleScript ββ Sound ββ UIAspectRatioConstraint ββ BlendSpace ββ GlobalDataStore β ββ DataStore β ββ OrderedDataStore ββ Pages β ββ DataStoreKeyPages β ββ DataStoreListingPages ββ DataStoreGetOptions ββ DataStoreSetOptions ββ DataStoreIncrementOptions ββ DataStoreInfo ββ DataStoreKeyInfo ββ ParticleEmitter ββ Beam ββ Trail ββ Explosion ββ Fire ββ Sparkles ββ Backpack β ββ BackpackItem β β ββ Tool ββ Team ββ Lighting ββ Light β ββ PointLight β ββ SpotLight ββ SoundGroup ββ ValueBase β ββBoolValue β ββIntValue β ββNumberValue β ββStringValue ββ GenericSettings β ββUserSettings ββ UserGameSettings ββ CoreGui
GuiBase2d ββ GuiObject β ββ Frame β ββ GuiButton β β ββ ImageButton β β ββ TextButton β ββ ImageLabel β ββ TextLabel β ββ LayerCollector β ββ ScreenGui β ββ SurfaceGuiBase β ββ SurfaceGui ββ
Last updated