Class CustomForm`Beta`

A customizable form that lets you put buttons, labels, toggles, dropdowns, sliders, and more into a form! Built on top of Observable, the form will update when the Observables' value changes.

Index

Constructors

constructor

Methods

button canShow close closeButton divider dropdown header label show slider spacer textField toggle create

Constructors

constructor

new CustomForm(): CustomForm
Beta
Returns CustomForm

Methods

button

button(
    label:
        | string
        | Observable<string>
        | UIRawMessage
        | Observable<UIRawMessage>,
    onClick: () => void,
    options?: ButtonOptions,
): CustomForm
Beta
Parameters
- label: string | Observable<string> | UIRawMessage | Observable<UIRawMessage>
- onClick: () => void
- Optionaloptions: ButtonOptions
Returns CustomForm
Remarks
Inserts a button into the Custom form. onClick is called when the button is pressed.
- Defined in tmp/package/index.d.ts:255

canShow

canShow(): boolean
Beta
Returns boolean
Remarks
Can this form be shown to the player right now?
- Defined in tmp/package/index.d.ts:265

close

close(): void
Beta
Returns void
Remarks
Closes the form. Throws an error if the form is not open.
- Defined in tmp/package/index.d.ts:271

closeButton

closeButton(): CustomForm
Beta
Returns CustomForm
Remarks
Adds a close "X" button to the form.
- Defined in tmp/package/index.d.ts:277

divider

divider(options?: DividerOptions): CustomForm
Beta
Parameters
- Optionaloptions: DividerOptions
Returns CustomForm
Remarks
Inserts a divider (i.e. a line) into the Custom form.
- Defined in tmp/package/index.d.ts:283

dropdown(
    label:
        | string
        | Observable<string>
        | UIRawMessage
        | Observable<UIRawMessage>,
    value: Observable<number>,
    items: DropdownItem[],
    options?: DropdownOptions,
): CustomForm
Beta
Parameters
- label: string | Observable<string> | UIRawMessage | Observable<UIRawMessage>
- value: Observable<number>
- items: DropdownItem[]
- Optionaloptions: DropdownOptions
Returns CustomForm
Remarks
Inserts a dropdown into the Custom form with the provided items. The value is based on the items value that selected.
- Defined in tmp/package/index.d.ts:290

header(
    text:
        | string
        | Observable<string>
        | UIRawMessage
        | Observable<UIRawMessage>,
    options?: TextOptions,
): CustomForm
Beta
Parameters
- text: string | Observable<string> | UIRawMessage | Observable<UIRawMessage>
- Optionaloptions: TextOptions
Returns CustomForm
Remarks
Inserts a header (i.e. large sized text) into the Custom form.
- Defined in tmp/package/index.d.ts:302

label

label(
    text:
        | string
        | Observable<string>
        | UIRawMessage
        | Observable<UIRawMessage>,
    options?: TextOptions,
): CustomForm
Beta
Parameters
- text: string | Observable<string> | UIRawMessage | Observable<UIRawMessage>
- Optionaloptions: TextOptions
Returns CustomForm
Remarks
Inserts a label (i.e. medium sized text) into the Custom form.
- Defined in tmp/package/index.d.ts:312

show

show(): Promise<void>
Beta
Returns Promise<void>
Remarks
Shows the form to the player. Will throw errors if the form is currently being shown or if another behavior pack is showing a form.
- Defined in tmp/package/index.d.ts:323

slider

slider(
    label:
        | string
        | Observable<string>
        | UIRawMessage
        | Observable<UIRawMessage>,
    value: Observable<number>,
    minValue: number | Observable<number>,
    maxValue: number | Observable<number>,
    options?: SliderOptions,
): CustomForm
Beta
Parameters
- label: string | Observable<string> | UIRawMessage | Observable<UIRawMessage>
- value: Observable<number>
- minValue: number | Observable<number>
- maxValue: number | Observable<number>
- Optionaloptions: SliderOptions
Returns CustomForm
Remarks
Creates a slider that lets players pick a number between minValue and maxValue. value must be client writable.
- Defined in tmp/package/index.d.ts:330

spacer

spacer(options?: SpacingOptions): CustomForm
Beta
Parameters
- Optionaloptions: SpacingOptions
Returns CustomForm
Remarks
Inserts a space into the Custom form.
- Defined in tmp/package/index.d.ts:342

textField

textField(
    label:
        | string
        | Observable<string>
        | UIRawMessage
        | Observable<UIRawMessage>,
    text: Observable<string>,
    options?: TextFieldOptions,
): CustomForm
Beta
Parameters
- label: string | Observable<string> | UIRawMessage | Observable<UIRawMessage>
- text: Observable<string>
- Optionaloptions: TextFieldOptions
Returns CustomForm
Remarks
Inserts a text field into the Custom for that players can enter text into.
- Defined in tmp/package/index.d.ts:349

toggle

toggle(
    label:
        | string
        | Observable<string>
        | UIRawMessage
        | Observable<UIRawMessage>,
    toggled: Observable<boolean>,
    options?: ToggleOptions,
): CustomForm
Beta
Parameters
- label: string | Observable<string> | UIRawMessage | Observable<UIRawMessage>
- toggled: Observable<boolean>
- Optionaloptions: ToggleOptions
Returns CustomForm
Remarks
Inserts an on/off toggle that players can interact with into the Custom form.
- Defined in tmp/package/index.d.ts:360

`Static`create

create(
    player: Player,
    title:
        | string
        | Observable<string>
        | UIRawMessage
        | Observable<UIRawMessage>,
): CustomForm
Beta
Parameters
- player: Player
- title: string | Observable<string> | UIRawMessage | Observable<UIRawMessage>
Returns CustomForm
Remarks
Creates a Custom form to show to the player. Use this instead of a constructor.
- Defined in tmp/package/index.d.ts:371

Class CustomFormBeta

Index

Constructors

Methods

Constructors

constructor

Returns CustomForm

Methods

button

Parameters

Returns CustomForm

Remarks

canShow

Returns boolean

Remarks

close

Returns void

Remarks

closeButton

Returns CustomForm

Remarks

divider

Parameters

Returns CustomForm

Remarks

dropdown

Parameters

Returns CustomForm

Remarks

header

Parameters

Returns CustomForm

Remarks

label

Parameters

Returns CustomForm

Remarks

show

Returns Promise<void>

Remarks

slider

Parameters

Returns CustomForm

Remarks

spacer

Parameters

Returns CustomForm

Remarks

textField

Parameters

Returns CustomForm

Remarks

toggle

Parameters

Returns CustomForm

Remarks

Staticcreate

Parameters

Returns CustomForm

Remarks

Settings

On This Page

Class CustomForm`Beta`

`Static`create