Home

How to read this documentation?

You should be familiar with JSON syntax to understand this documentation.

Every type has it's respective section in the documentation.
Each section contains a description of the type, and a list of properties (if applicable) that the type has.

Symbols

| basically means "or"; for example, Renderable can be either a Texture or an Item.
[] means that the type is an array; for example, Objective[] is an array of Objective objects.
? means that the property is optional; for example, translatable?: boolean means that the translatable property is optional, and if not provided, the default value will be inferred.

Notice how these types have links. You can click on these links to jump to the respective section of the documentation.