endstone.form

Classes

Name	Description
`ActionForm`	Represents a form with buttons that let the player take action.
`Button`	Represents a button with text and an optional icon.
`Divider`	Represents a divider.
`Dropdown`	Represents a dropdown with a set of predefined options.
`Header`	Represents a header with a label.
`Label`	Represents a text label.
`MessageForm`	Represents a form with two buttons.
`ModalForm`	Represents a modal form with controls.
`Slider`	Represents a slider with a label.
`StepSlider`	Represents a step slider with a set of predefined options.
`TextInput`	Represents a text input field.
`Toggle`	Represents a toggle button with a label.

`class`ActionForm

ActionForm(title: str | Translatable = '', content: str | Translatable = '', buttons: list[Button | Divider | Header | Label] | None = None, on_submit: Callable[[Player, int], None] = None, on_close: Callable[[Player], None] = None)

Represents a form with buttons that let the player take action.

Methods

Name	Description
`add_button`	Adds a button to the form.
`add_divider`	Adds a divider to the form.
`add_header`	Adds a header to the form.
`add_label`	Adds a label to the form.

Attributes

Name	Type	Description
`content`	`str \| Translatable`	Gets or sets the content of the form.
`controls`	`list[Button \| Divider \| Header \| Label]`	Gets or sets the controls of the action form.
`on_close`	`Callable[[Player], None]`	Gets or sets the on close callback.
`on_submit`	`Callable[[Player, int], None]`	Gets or sets the on submit callback.
`title`	`str \| Translatable`	Gets or sets the title of the form.

`attr`contentproperty

content: str | Translatable

Gets or sets the content of the form.

`attr`controlsproperty

controls: list[Button | Divider | Header | Label]

Gets or sets the controls of the action form.

`attr`on_closeproperty

on_close: Callable[[Player], None]

Gets or sets the on close callback.

`attr`on_submitproperty

on_submit: Callable[[Player, int], None]

Gets or sets the on submit callback.

`attr`titleproperty

title: str | Translatable

Gets or sets the title of the form.

`meth`add_button

add_button(text: str | Translatable, icon: str | None = None, on_click: Callable[[Player], None] = None) -> ActionForm

Adds a button to the form.

`meth`add_divider

add_divider() -> ActionForm

Adds a divider to the form.

`meth`add_header

add_header(text: str | Translatable) -> ActionForm

Adds a header to the form.

`meth`add_label

add_label(text: str | Translatable) -> ActionForm

Adds a label to the form.

`class`Button

Button(text: str | Translatable = '', icon: str | None = None, on_click: Callable[[Player], None] = None)

Represents a button with text and an optional icon.

Attributes

Name	Type	Description
`icon`	`str \| None`	Gets or sets the icon path or URL of the button
`on_click`	`Callable[[Player], None]`	Gets or sets the on click callback.
`text`	`str \| Translatable`	Gets or sets the text of the button

`attr`iconproperty

icon: str | None

Gets or sets the icon path or URL of the button

`attr`on_clickproperty

on_click: Callable[[Player], None]

Gets or sets the on click callback.

`attr`textproperty

text: str | Translatable

Gets or sets the text of the button

`class`Divider

Divider()

Represents a divider.

`class`Dropdown

Dropdown(label: str | Translatable = '', options: list[str] | None = None, default_index: int | None = None)

Represents a dropdown with a set of predefined options.

Methods

Name	Description
`add_option`	Adds a new option to the dropdown.

Attributes

Name	Type	Description
`default_index`	`int \| None`	Gets or sets the optional default index of the dropdown.
`label`	`str \| Translatable`	Gets or sets the label of the dropdown.
`options`	`list[str]`	Gets or sets the options of the dropdown.

`attr`default_indexproperty

default_index: int | None

Gets or sets the optional default index of the dropdown.

`attr`labelproperty

label: str | Translatable

Gets or sets the label of the dropdown.

`attr`optionsproperty

options: list[str]

Gets or sets the options of the dropdown.

`meth`add_option

add_option(option: str) -> Dropdown

Adds a new option to the dropdown.

`class`Header

Header(label: str | Translatable = '')

Represents a header with a label.

Attributes

Name	Type	Description
`label`	`str \| Translatable`	Gets or sets the label of the header.

`attr`labelproperty

label: str | Translatable

Gets or sets the label of the header.

`class`Label

Label(text: str | Translatable = '')

Represents a text label.

Attributes

Name	Type	Description
`text`	`str \| Translatable`	Gets or sets the text of the label.

`attr`textproperty

text: str | Translatable

Gets or sets the text of the label.

`class`MessageForm

MessageForm(title: str | Translatable = '', content: str | Translatable = '', button1: str | Translatable = '', button2: str | Translatable = '', on_submit: Callable[[Player, int], None] = None, on_close: Callable[[Player], None] = None)

Represents a form with two buttons.

Attributes

Name	Type	Description
`button1`	`str \| Translatable`	Gets or sets the text of button1.
`button2`	`str \| Translatable`	Gets or sets the text of button2.
`content`	`str \| Translatable`	Gets or sets the content of the form.
`on_close`	`Callable[[Player], None]`	Gets or sets the on close callback.
`on_submit`	`Callable[[Player, int], None]`	Gets or sets the on submit callback.
`title`	`str \| Translatable`	Gets or sets the title of the form.

`attr`button1property

button1: str | Translatable

Gets or sets the text of button1.

`attr`button2property

button2: str | Translatable

Gets or sets the text of button2.

`attr`contentproperty

content: str | Translatable

Gets or sets the content of the form.

`attr`on_closeproperty

on_close: Callable[[Player], None]

Gets or sets the on close callback.

`attr`on_submitproperty

on_submit: Callable[[Player, int], None]

Gets or sets the on submit callback.

`attr`titleproperty

title: str | Translatable

Gets or sets the title of the form.

`class`ModalForm

ModalForm(title: str | Translatable = '', controls: list[Dropdown | Label | Slider | StepSlider | TextInput | Toggle | Divider | Header] | None = None, submit_button: str | Translatable | None = None, icon: str | None = None, on_submit: Callable[[Player, str], None] = None, on_close: Callable[[Player], None] = None)

Represents a modal form with controls.

Methods

Name	Description
`add_control`	Adds a control to the form.

Attributes

Name	Type	Description
`controls`	`list[Dropdown \| Label \| Slider \| StepSlider \| TextInput \| Toggle \| Divider \| Header]`	Gets or sets the controls of the modal form.
`icon`	`str \| None`	Gets or sets the icon of the form.
`on_close`	`Callable[[Player], None]`	Gets or sets the on close callback.
`on_submit`	`Callable[[Player, str], None]`	Gets or sets the on submit callback.
`submit_button`	`str \| Translatable \| None`	Gets or sets the submit button message of the form.
`title`	`str \| Translatable`	Gets or sets the title of the form.

`attr`controlsproperty

controls: list[Dropdown | Label | Slider | StepSlider | TextInput | Toggle | Divider | Header]

Gets or sets the controls of the modal form.

`attr`iconproperty

icon: str | None

Gets or sets the icon of the form.

`attr`on_closeproperty

on_close: Callable[[Player], None]

Gets or sets the on close callback.

`attr`on_submitproperty

on_submit: Callable[[Player, str], None]

Gets or sets the on submit callback.

`attr`submit_buttonproperty

submit_button: str | Translatable | None

Gets or sets the submit button message of the form.

`attr`titleproperty

title: str | Translatable

Gets or sets the title of the form.

`meth`add_control

add_control(control: Dropdown | Label | Slider | StepSlider | TextInput | Toggle | Divider | Header) -> ModalForm

Adds a control to the form.

`class`Slider

Slider(label: str | Translatable = '', min: float = 0, max: float = 100, step: float = 20, default_value: float | None = None)

Represents a slider with a label.

Attributes

Name	Type	Description
`default_value`	`float \| None`	Gets or sets the optional default value of the slider.
`label`	`str \| Translatable`	Gets or sets the label of the slider.
`max`	`float`	Gets or sets the maximum value of the slider.
`min`	`float`	Gets or sets the minimum value of the slider.
`step`	`float`	Gets or sets the step size of the slider.

`attr`default_valueproperty

default_value: float | None

Gets or sets the optional default value of the slider.

`attr`labelproperty

label: str | Translatable

Gets or sets the label of the slider.

`attr`maxproperty

max: float

Gets or sets the maximum value of the slider.

`attr`minproperty

min: float

Gets or sets the minimum value of the slider.

`attr`stepproperty

step: float

Gets or sets the step size of the slider.

`class`StepSlider

StepSlider(label: str | Translatable = '', options: list[str] | None = None, default_index: int | None = None)

Represents a step slider with a set of predefined options.

Methods

Name	Description
`add_option`	Adds a new option to the step slider.

Attributes

Name	Type	Description
`default_index`	`int \| None`	Gets or sets the optional default index of the step slider.
`label`	`str \| Translatable`	Gets or sets the label of the step slider.
`options`	`list[str]`	Gets or sets the options of the step slider.

`attr`default_indexproperty

default_index: int | None

Gets or sets the optional default index of the step slider.

`attr`labelproperty

label: str | Translatable

Gets or sets the label of the step slider.

`attr`optionsproperty

options: list[str]

Gets or sets the options of the step slider.

`meth`add_option

add_option(option: str) -> Dropdown

Adds a new option to the step slider.

`class`TextInput

TextInput(label: str | Translatable = '', placeholder: str | Translatable = '', default_value: str | None = None)

Represents a text input field.

Attributes

Name	Type	Description
`default_value`	`str \| None`	Gets or sets the optional default text of the text input field.
`label`	`str \| Translatable`	Gets or sets the label of the text input field.
`placeholder`	`str \| Translatable`	Gets or sets the placeholder of the text input field.

`attr`default_valueproperty

default_value: str | None

Gets or sets the optional default text of the text input field.

`attr`labelproperty

label: str | Translatable

Gets or sets the label of the text input field.

`attr`placeholderproperty

placeholder: str | Translatable

Gets or sets the placeholder of the text input field.

`class`Toggle

Toggle(label: str | Translatable = '', default_value: bool = False)

Represents a toggle button with a label.

Attributes

Name	Type	Description
`default_value`	`bool`	Gets or sets the value of the toggle.
`label`	`str \| Translatable`	Gets or sets the label of the toggle.

`attr`default_valueproperty

default_value: bool

Gets or sets the value of the toggle.

`attr`labelproperty

label: str | Translatable

Gets or sets the label of the toggle.

classActionForm

attrcontentproperty

attrcontrolsproperty

attron_closeproperty

attron_submitproperty

attrtitleproperty

methadd_button

methadd_divider

methadd_header

methadd_label

classButton

attriconproperty

attron_clickproperty

attrtextproperty

classDivider

classDropdown

attrdefault_indexproperty

attrlabelproperty

attroptionsproperty

methadd_option

classHeader

attrlabelproperty

classLabel

attrtextproperty

classMessageForm

attrbutton1property

attrbutton2property

attrcontentproperty

attron_closeproperty

attron_submitproperty

attrtitleproperty

classModalForm

attrcontrolsproperty

attriconproperty

attron_closeproperty

attron_submitproperty

attrsubmit_buttonproperty

attrtitleproperty

methadd_control

classSlider

attrdefault_valueproperty

attrlabelproperty

attrmaxproperty

attrminproperty

attrstepproperty

classStepSlider

attrdefault_indexproperty

attrlabelproperty

attroptionsproperty

methadd_option

classTextInput

attrdefault_valueproperty

attrlabelproperty

attrplaceholderproperty

classToggle

attrdefault_valueproperty

attrlabelproperty

On this page

`class`ActionForm

`attr`contentproperty

`attr`controlsproperty

`attr`on_closeproperty

`attr`on_submitproperty

`attr`titleproperty

`meth`add_button

`meth`add_divider

`meth`add_header

`meth`add_label

`class`Button

`attr`iconproperty

`attr`on_clickproperty

`attr`textproperty

`class`Divider

`class`Dropdown

`attr`default_indexproperty

`attr`labelproperty

`attr`optionsproperty

`meth`add_option

`class`Header

`attr`labelproperty

`class`Label

`attr`textproperty

`class`MessageForm

`attr`button1property

`attr`button2property

`attr`contentproperty

`attr`on_closeproperty

`attr`on_submitproperty

`attr`titleproperty

`class`ModalForm

`attr`controlsproperty

`attr`iconproperty

`attr`on_closeproperty

`attr`on_submitproperty

`attr`submit_buttonproperty

`attr`titleproperty

`meth`add_control

`class`Slider

`attr`default_valueproperty

`attr`labelproperty

`attr`maxproperty

`attr`minproperty

`attr`stepproperty

`class`StepSlider

`attr`default_indexproperty

`attr`labelproperty

`attr`optionsproperty

`meth`add_option

`class`TextInput

`attr`default_valueproperty

`attr`labelproperty

`attr`placeholderproperty

`class`Toggle

`attr`default_valueproperty

`attr`labelproperty