What a class can do
apiRetrieve properties, methods, and events for any Roblox class from the running engine, ensuring accurate Luau code before you write it.
Instructions
Lists the properties, methods and events of any Roblox class, read from the engine that is running.
Use it before writing Luau against a class you are not certain of. Guessing a method name costs a runtime error and a round trip; this costs one call and is never out of date, because the answer comes from the running binary rather than from a published dump or from training data. That matters most for exactly the classes worth checking — new ones, and ones that changed recently.
Members come back as signatures rather than bare names — AddAccessory(accessory: Instance), HoldDuration: number — because a name tells you something exists and a signature tells you how to call it, which is the actual question.
describe takes a class name and gives the members it declares itself, counting the inherited ones separately. classes searches class names, which is how to find one whose exact spelling you do not have.
Deprecated members are never listed, only counted — Instance has eight, including clone, remove and getChildren. They still run, so picking one from a list gives you working code and a deprecation warning in the user's output. Members no script may use at all are counted with them.
This is not the same as inspect. inspect reads the values on an instance that exists; this reads the shape of a class whether or not anything in the place is one — which is what you need when deciding what to create in the first place.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| op | No | 'describe' details one class, 'classes' searches class names. | describe |
| include | No | describe only: which member kinds to return. Defaults to all three; narrow it when you only need one and the class is large. | |
| contains | No | classes only: substring to match, case-insensitive, e.g. "constraint" or "gui". Omit to list everything. | |
| studioId | No | Target Studio; omit for the active one. | |
| className | No | describe only: the class, e.g. "TweenService", "ProximityPrompt", "Humanoid". Case-sensitive. | |
| inherited | No | describe only: include members inherited from Instance and Object. Off by default because they swamp the answer — ProximityPrompt has 2 methods of its own and 42 inherited, and the two you want are not the ones you already know. The inherited count is reported either way. |