Property

Property types

properties_bool_type

default

boolean?

Optional. The default value of the property.

description

string?

Optional. The description of the property.

id

string

The id of the property.

name

string

The name of the property.

type

"bool"

properties_button_type

callback

function

The function called when the button is pressed.

default

any

Optional. The default value of the property.

description

string?

Optional. The description of the property.

id

string

The id of the property.

name

string

The name of the property.

type

"button"

---

properties_editable_list_type

default

any

Optional. The default value of the property.

description

string?

Optional. The description of the property.

editable_list_type

EditableListType?

The type of the editable list. Defaults to "strings".

filter

string?

The filter for the list.

id

string

The id of the property.

name

string

The name of the property.

type

"editable_list"

---

properties_float_type

default

number?

Optional. The default value of the property.

description

string?

Optional. The description of the property.

id

string

The id of the property.

max

integer

The maximum value of the property.

min

integer

The minimum value of the property.

name

string

The name of the property.

step

integer

With which step the property can be changed.

type

"float"|"float_slider"

---

properties_font_type

default

integer?

Optional. The default value of the property.

description

string?

Optional. The description of the property.

id

string

The id of the property.

name

string

The name of the property.

type

"font"

---

properties_int_type

default

integer?

Optional. The default value of the property.

description

string?

Optional. The description of the property.

id

string

The id of the property.

max

integer

The maximum value of the property.

min

integer

The minimum value of the property.

name

string

The name of the property.

step

integer

With which step the property can be changed.

type

"int"|"int_slider"

---

properties_list_type

combo_format

ComboFormat?

The format of the combo. Defaults to "string".

combo_type

ComboType?

The type of the combo. Defaults to "editable".

default

any

Optional. The default value of the property.

description

string?

Optional. The description of the property.

id

string

The id of the property.

name

string

The name of the property.

options

any

The options that the list has.

source_options

table<SourceType, boolean>?

Add existing sources to the list. Filter for a specific source type using true and falls. Use all to add all sources.

type

"list"

---

properties_number_type

default

integer?

Optional. The default value of the property.

description

string?

Optional. The description of the property.

id

string

The id of the property.

name

string

The name of the property.

type

"color"|"framerate"

---

properties_path_type

default

string?

Optional. The default value of the property.

description

string?

Optional. The description of the property.

filter

string?

The filter for the path.

id

string

The id of the property.

name

string

The name of the property.

path_type

PathType?

The type of the path. Defaults to "file".

type

"path"

---

properties_text_type

default

string?

Optional. The default value of the property.

description

string?

Optional. The description of the property.

id

string

The id of the property.

name

string

The name of the property.

text_type

TextType?

The type of the text. Defaults to "default".

type

"text"