Skip to main content

ConfigurableData


DefaultValue

The default value of the configurable, if it has one. It is of the type any. It may also be nil. It is read-only, it cannot be assigned to.


Description

A description of the configurable. It is of the type string. It is read-only, it cannot be assigned to.


Name

The name of the configurable. It is of the type string. It is read-only, it cannot be assigned to.


Options

The options that the configurable can take. It is one (not all) of the following types:


Subtype A

It is an array whose values are of the type string.


Subtype B

It is an array whose values are of the type number.

It may also be nil. It is read-only, it cannot be assigned to.


Type

The type of the configurable. It is of the type string. It is read-only, it cannot be assigned to.

Luau Type

This is the luau type for ConfigurableData. It may help clear up mistranslations from the raw data to the wiki page (as it is an automatic process).

export type ConfigurableData = {
read Type: string,
read Description: string,
read Options: ({ string } | { number })?,
read DefaultValue: any?,
read Name: string,
}