Roblox API Reference

Entities

The table lists each entity in the API. Primary entities are highlighted.

Sections

The Summary, Details, and Example columns indicate the status of the corresponding document sections for each entity. They are colored as follows:

• No file: The entity does not have an associated document file.
• No section: The entity has a document file, but there is no section for the corresponding column.
• Empty: There is a section, but it has no content.
• Filled: The section contains at least some content.

Summary

If the summary of a primary entity is within the orphaned section, then * is displayed, indicating that the summary should be within the explicit Summary section. If the summary of a secondary entity is within the Summary section, then ** will be displayed, indicating that the summary should be within the implicit orphaned section.

All entity types require a Summary section.

Details

When filled, the number of direct elements within the section will be displayed, giving a rough estimate of the amount of content.

All entity types except EnumItems require a Details section.

Examples

When filled, the number of direct elements within the section will be displayed, giving a rough estimate of the amount of content.

All entity types except Enums and EnumItems require an Examples section.

Aggregate

The Aggregate column shows the coverage of documentation for the entity overall. For secondary entities, it is the percentage of filled required sections of the entity. For primary entities, it is the percentage of filled required sections of the entity and all of its secondary entities.

Colors in the Aggregate column have the following meaning:

• No file: No associated file.
• None: No items are filled.
• Some: Some items are filled.
• All: All items are filled.