roblox-api
Roblox Engine API reference: classes, properties, methods, events. Use when looking up how to use Roblox classes or their members.
When & Why to Use This Skill
The Roblox API Reference skill is a specialized developer tool designed to streamline game creation on the Roblox platform. It provides instant, searchable access to the Roblox Engine API, covering essential classes, properties, methods, and events. By offering real-time documentation for everything from physics and networking to GUI and character management, it helps Luau developers write more accurate code and reduce debugging time.
Use Cases
- Class Reference Lookup: Quickly find specific properties, methods, or events for any Roblox class, such as Humanoids, Parts, or MeshParts, without leaving the coding environment.
- Service Implementation: Access documentation for core engine services like TweenService, RunService, or ReplicatedStorage to manage game logic and state efficiently.
- UI Design & Scripting: Reference GuiObject properties and methods for ScreenGuis, Frames, and Buttons to create interactive and responsive user interfaces.
- Physics & Constraints: Look up the configuration details for WeldConstraints, SpringConstraints, and Motor6Ds to implement complex physical behaviors and mechanical systems.
- Networking & Communication: Verify the usage of RemoteEvents and RemoteFunctions to ensure secure and optimized communication between the client and server.
| name | roblox-api |
|---|---|
| description | Roblox Engine API reference: classes, properties, methods, events. Use when looking up how to use Roblox classes or their members. |
Roblox API Reference
Query the Roblox Engine API. For runtime queries, use roblox.api.getClass and roblox.api.getProperties tools (powered by ReflectionService).
Class Categories
Services
See services.md for: Players, Workspace, ReplicatedStorage, ServerStorage, RunService, +17 more
Gui
See gui.md for: ScreenGui, Frame, TextLabel, TextButton, TextBox, +15 more
Parts
See parts.md for: Part, MeshPart, UnionOperation, Model, Folder, +7 more
Physics
See physics.md for: Weld, WeldConstraint, Motor6D, HingeConstraint, SpringConstraint, +9 more
Effects
See effects.md for: ParticleEmitter, Beam, Trail, Fire, Smoke, +7 more
Animation
See animation.md for: Animation, AnimationController, Animator, AnimationTrack, Keyframe
Sound
See sound.md for: Sound, SoundGroup, SoundEffect, DistortionSoundEffect, ReverbSoundEffect
Characters
See characters.md for: Humanoid, HumanoidDescription, Accessory, Shirt, Pants, +1 more
Networking
See networking.md for: RemoteEvent, RemoteFunction, BindableEvent, BindableFunction, UnreliableRemoteEvent