← All native models

Model fields

prop

One prop. Object props describe their fields with nested props, array props their elements with items.

object
defaultOptional

The value used when the caller does not pass the prop.

string
descriptionOptional

What the prop is for, shown to authors.

string
enumOptional

The allowed values, separated by spaces.

string
itemsOptional
nameRequired

The prop's name, as the caller writes it and as props. in the template and Lua.

string
Minimum length
1
nullableOptional

Whether the prop also accepts null.

boolean
propsOptional

An object prop's fields.

array
Minimum items
0
Maximum items
9223372036854776000
List items
requiredOptional

Whether every caller must pass the prop.

boolean
typeRequired

The prop's value type.

string
Allowed values
["any","array","boolean","integer","number","object","string"]

Only the fields listed here are accepted.