server.form

fn button(text string) Button

fn divider() Element

fn dropdown(text string, options []string, default_index int) Element

fn header(text string) Element

fn image_button(text string, image string) Button

fn input(text string, default_value string, placeholder string) Element

fn label(text string) Element

fn new_custom_form(title string, on_submit fn (Response) !) CustomForm

fn new_modal_form(title string, on_button1 fn () !, on_button2 fn () !) ModalForm

fn new_simple_form(title string) SimpleForm

fn slider(text string, min f64, max f64, step f64, default_value f64) Element

fn step_slider(text string, options []string, default_index int) Element

fn toggle(text string, default_value bool) Element

interface Form {
	// request_body returns the JSON payload sent to the client inside a ModalFormRequestPacket.
	request_body() string
	// submit is called with the raw form_data of the client's response.
	// A `none` value means the player closed the form without submitting it.
	submit(raw ?string) !
	// has_network_image reports whether this form has a button image fetched
	// over the network (type url), as opposed to a bundled resource pack
	// asset (type path). The Bedrock client can get stuck showing a loading
	// spinner on that image well after it has actually finished loading;
	// assending the player an attribute update afterwards clears it. (see https://github.com/muqsit/FormImagesFix)
	has_network_image() bool
}

type Element = Divider | Dropdown | Header | Input | Label | Slider | StepSlider | Toggle

struct Button {
pub:
	typ   string = 'button' @[json: 'type']
	text  string
	image ?ButtonImage
}

fn (b Button) has_network_image() bool

struct ButtonImage {
pub:
	typ  string @[json: 'type']
	data string
}

ButtonImage is the optional icon shown next to a Button on a SimpleForm or ModalForm. typ is path for a builtin game asset or url for a remote image.

struct CustomForm {
mut:
	title     string
	elements  []Element
	on_submit fn (Response) ! = unsafe { nil }
	on_close  ?fn ()
}

fn (mut f CustomForm) element(e Element) CustomForm

fn (mut f CustomForm) closed(on_close fn ()) CustomForm

fn (f &CustomForm) request_body() string

fn (f &CustomForm) has_network_image() bool

has_network_image is always false because custom form elements don't carry images.

fn (f &CustomForm) submit(raw ?string) !

struct Divider {
pub:
	typ  string = 'divider' @[json: 'type']
	text string
}

struct Dropdown {
pub:
	typ           string = 'dropdown' @[json: 'type']
	text          string
	options       []string
	default_index int @[json: 'default']
}

struct Header {
pub:
	typ  string = 'header' @[json: 'type']
	text string
}

struct Input {
pub:
	typ         string = 'input' @[json: 'type']
	text        string
	default     string
	placeholder string
}

struct Label {
pub:
	typ  string = 'label' @[json: 'type']
	text string
}

struct ModalForm {
mut:
	title      string
	content    string
	button1    string  = 'gui.yes'
	button2    string  = 'gui.no'
	on_button1 fn () ! = unsafe { nil }
	on_button2 fn () ! = unsafe { nil }
	on_close   ?fn ()
}

fn (mut f ModalForm) body(content string) ModalForm

fn (mut f ModalForm) buttons(button1 string, button2 string) ModalForm

fn (mut f ModalForm) closed(on_close fn ()) ModalForm

fn (f &ModalForm) request_body() string

fn (f &ModalForm) has_network_image() bool

has_network_image is always false because modal form buttons don't carry images.

fn (f &ModalForm) submit(raw ?string) !

struct Response {
	values []json2.Any
}

fn (r Response) len() int

fn (r Response) string_value(index int) string

fn (r Response) bool_value(index int) bool

fn (r Response) int_value(index int) int

fn (r Response) f64_value(index int) f64

struct SimpleForm {
mut:
	title    string
	content  string
	buttons  []Button
	on_click []fn () !
	on_close ?fn ()
}

fn (mut f SimpleForm) body(content string) SimpleForm

fn (mut f SimpleForm) button(text string, on_click fn () !) SimpleForm

fn (mut f SimpleForm) image_button(text string, image string, on_click fn () !) SimpleForm

fn (mut f SimpleForm) closed(on_close fn ()) SimpleForm

closed sets a callback invoked if the player closes the form without tapping a button.

fn (f &SimpleForm) request_body() string

fn (f &SimpleForm) has_network_image() bool

fn (f &SimpleForm) submit(raw ?string) !

struct Slider {
pub:
	typ     string = 'slider' @[json: 'type']
	text    string
	min     f64
	max     f64
	step    f64
	default f64
}

struct StepSlider {
pub:
	typ           string = 'step_slider' @[json: 'type']
	text          string
	options       []string @[json: 'steps']
	default_index int      @[json: 'default']
}

struct Toggle {
pub:
	typ     string = 'toggle' @[json: 'type']
	text    string
	default bool
}