Перейти к основному содержимому

Руководство по формам

В Nukkit-MOT формы делятся на четыре типа: модальные (Modal), простые (Simple), настраиваемые (Custom) и диалоги (Dialog).

примечание

Тип Dialog был добавлен в PR#71 (версия 1.20.30) и требует привязки к сущности для работы.

FormWindowModal используется для простых действий подтверждения или отмены.

form/DemoModalForm.java
package cn.nukkitmot.exampleplugin.form;

import cn.nukkit.Player;
import cn.nukkit.form.handler.FormResponseHandler;
import cn.nukkit.form.window.FormWindowModal;

public class DemoModalForm {
    public static void open(Player player) {
        FormWindowModal form = new FormWindowModal("Title", "Description", "true", "false");
        // Set actions for confirm and cancel
        form.addHandler(FormResponseHandler.withoutPlayer(ignored -> {
            if (form.wasClosed()) return;
            if (form.getResponse().getClickedButtonId() == 0) {
                // User clicked the true button
            } else {
                // User clicked the false button
            }
        }));
        // Show the form to the player
        player.showFormWindow(form);
    }
}

Простая форма​

FormWindowSimple предоставляет более богатый набор кнопок.

Пример использования​

form/DemoSimpleForm.java
package cn.nukkitmot.exampleplugin.form;

import cn.nukkit.Player;
import cn.nukkit.form.element.ElementButton;
import cn.nukkit.form.handler.FormResponseHandler;
import cn.nukkit.form.window.FormWindowSimple;

public class DemoSimpleForm {
    public static void open(Player player) {
        FormWindowSimple form = new FormWindowSimple("Title", "Description");
        // Add buttons
        form.addButton(new ElementButton("Button 1"));
        form.addButton(new ElementButton("Button 2"));
        form.addButton(new ElementButton("Button 3"));
        // Set button click handling
        form.addHandler(FormResponseHandler.withoutPlayer(ignored -> {
            if (form.wasClosed()) return;
            int buttonIndex = form.getResponse().getClickedButtonId(); // Get the clicked button index
            String buttonText = form.getResponse().getClickedButton().getText(); // Get the clicked button text
            switch (buttonIndex) {
                case 0:
                    // Handle button 1 action
                    break;
                case 1:
                    // Handle button 2 action
                    break;
                case 2:
                    // Handle button 3 action
                    break;
                default:
                    // Default handling
                    break;
            }
        }));
        // Show the form to the player
        player.showFormWindow(form);
    }
}

Компоненты​

Название компонентаОписаниеСсылка
КнопкаКнопка для простых действий по нажатию, может содержать изображенияElementButton

Настраиваемая форма​

FormWindowCustom позволяет разработчикам настраивать содержимое и взаимодействие формы, включая поля ввода текста, выпадающие списки и т. д.

Пример использования​

form/DemoCustomForm.java
package cn.nukkitmot.exampleplugin.form;

import cn.nukkit.Player;
import cn.nukkit.form.element.ElementDropdown;
import cn.nukkit.form.element.ElementInput;
import cn.nukkit.form.handler.FormResponseHandler;
import cn.nukkit.form.window.FormWindowCustom;

import java.util.Arrays;

public class DemoCustomForm {
    public static void open(Player player) {
        FormWindowCustom form = new FormWindowCustom("Title");
        // Add elements
        form.addElement(new ElementInput("Text Input", "Default Value"));
        form.addElement(new ElementDropdown("Dropdown", Arrays.asList("Option 1", "Option 2", "Option 3")));
        // Set submission action
        form.addHandler(FormResponseHandler.withoutPlayer(ignored -> {
            if (form.wasClosed()) return;
            String inputText = form.getResponse().getInputResponse(0); // Get the text input value
            int selectedIndex = form.getResponse().getDropdownResponse(1).getElementID(); // Get the dropdown selection index
            String selectedText = form.getResponse().getDropdownResponse(1).getElementContent(); // Get the dropdown selection text
            // Handle user-submitted data
        }));
        // Show the form to the player
        player.showFormWindow(form);
    }
}

Компоненты​

Название компонентаОписаниеСсылка
Выпадающий списокВыпадающий список, отображает перечень вариантов для выбора пользователемElementDropdown
Поле вводаПоле ввода текста, позволяет пользователям вводить строкиElementInput
МеткаМетка, добавляет текстовые надписи в формуElementLabel
ПолзунокГоризонтальный ползунок, позволяет после задания минимального и максимального значений получать числовые значенияElementSlider
Ползунок с шагамиГоризонтальный ползунок с шагами, параметр задаётся строкойElementStepSlider
ПереключательПереключатель, принимает логические значения (boolean)ElementToggle

Диалоговая форма​

FormWindowDialog — особый тип формы, для работы которого требуется привязка к сущности. Сущность не может быть игроком.

ScrollingTextDialog — расширенная версия диалога, предоставляющая возможность прокрутки текста.

Пример использования​

form/DemoDialogForm.java
package cn.nukkitmot.exampleplugin.form;

import cn.nukkit.Player;
import cn.nukkit.entity.Entity;
import cn.nukkit.form.window.FormWindowDialog;

public class DemoDialogForm {
    public static void open(Player player, Entity entity) {
        FormWindowDialog form = new FormWindowDialog("Title", "Description", entity);
        // Add options
        form.addButton("Option 1");
        form.addButton("Option 2");
        // Set submission action
        form.addHandler((player_, response) -> {
            String buttonText = response.getClickedButton().getName(); // Get the clicked button text
            // Handle user-submitted data
        });
        // Show the dialog to the player
        form.send(player);
    }
}