FieldInfo

There are multiple variants of FieldInfo. The most common is the BlockFieldInfo, which is used to specify a field that is a block. The other variants encode "Simple" fields, such as numbers, strings, booleans, and options.

BlockFieldInfo

Name	Type	Required	Description	Example
id	string	★	The key that is used for storing this data in the block data. Matches the key of the item in properties.	canDance
name	string | SimpleOptionsFieldInfo	★	The name of the field that is shown to the user	Can Dance
accepts	string[]	★	The keys for block types that are allowed to be used in this field	["blockType"]
default	any	★	The default value for the field	-
isList	boolean		Whether the field can accept multiple values	false
fullWidth	boolean		Whether the field should take up the full width of the drawer	false
type	PropertyType.Block	★	Indicator for this field being a block	PropertyType.Block

SimpleBooleanFieldInfo

Name	Type	Required	Description	Example
id	string	★	The key that is used for storing this data in the block data. Matches the key of the item in properties.	canDance
name	string	★	The name of the field that is shown to the user	Can Dance
default	boolean	★	The default value for the field	false
type	PropertyType.Boolean	★	Indicator for this field being a boolean	PropertyType.Boolean

SimpleNumberFieldInfo

Name	Type	Required	Description	Example
id	string	★	The key that is used for storing this data in the block data. Matches the key of the item in properties.	walkingSpeed
name	string	★	The name of the field that is shown to the user	Walking Speed
default	number	★	The default value for the field	10
type	PropertyType.Number	★	Indicator for this field being a number	PropertyType.Number
min	number		Minimum value for field. Defaults to -∞	0
max	number		Maximum value for field. Defaults to ∞	100
step	number		Step value for field. Defaults to 1	1
units	string		The units for the number field. Defaults to none.	m/s

SimpleStringFieldInfo

Name	Type	Required	Description	Example
id	string	★	The key that is used for storing this data in the block data. Matches the key of the item in properties.	greeting
name	string	★	The name of the field that is shown to the user	Greeting
default	string	★	The default value for the field	"Hello World!"
type	PropertyType.String	★	Indicator for this field being a string	PropertyType.String

SimpleOptionsFieldInfo

Name	Type	Required	Description	Example
id	string	★	The key that is used for storing this data in the block data. Matches the key of the item in properties.	time
name	string	★	The name of the field that is shown to the user	Time
default	string	★	The default option selected, based on value.	"am"
type	PropertyType.Options	★	Indicator for this field being a set of options	PropertyType.Options
options	{value: string, label: string}[]	★	Options for the user to select from. Value stored is the value field.	[{value: 'am', label: 'AM'}, {value: 'pm', label: 'PM'}]

SimpleMetadataFieldInfo

Name	Type	Required	Description	Example
id	string	★	The key that is used for storing this data in the block data. Matches the key of the item in properties.	jointData
name	string	★	The name of the field (although metadata isn't displayed to the user).	Joint Data
default	any	★	The default value for the field	{ "jointType": "continuous", "jointAxis": "x"}
type	PropertyType.Metadata	★	Indicator for this field being metadata	PropertyType.Metadata

SimpleVector3FieldInfo

Name	Type	Required	Description	Example
id	string	★	The key that is used for storing this data in the block data. Matches the key of the item in properties.	position
name	string	★	The name of the field that is shown to the user	Position
default	number[]	★	The default value of the vector3 field	[0, 0, 0]
type	PropertyType.Vector3	★	Indicator for this field being a vector-3	PropertyType.Vector3