forms
Modern version of pocketmine forms API, ported to PHP 8.0+ with high quality code and phpstan integration
Code samples
ModalForm
Using ModalForm to represent "yes" / "no" button clicks as bool in closure
sendMessage($choice ? "Thank you" : "We will try to become better");
}
));
">
$player->sendForm(new ModalForm("A small question", "Is our server cool?", //result of pressing the "yes" / "no" button is written to a variable $choice function(Player $player, bool $choice) : void{ $player->sendMessage($choice ? "Thank you" : "We will try to become better"); } ));
Short version of ModalForm to confirm any action
sendMessage("*teleporting*");
}
));
">
$player->sendForm(ModalForm::confirm("Teleport request", "Do you want to accept it?", //called only when the player selects the "yes" button function(Player $player) : void{ $player->sendMessage("*teleporting*"); } ));
MenuForm
Using MenuForm to display buttons with icons from URL and path
sendMessage("You selected: " . $selected->text);
$player->sendMessage("Index of button: " . $selected->getValue());
}));
">
$player->sendForm(new MenuForm("Select server", "Choose server", [ //buttons without icon new Button("SkyWars #1"), new Button("SkyWars #2"), //URL and path are supported for image new Button("SkyWars #3", Image::url("https://static.wikia.nocookie.net/minecraft_gamepedia/images/f/f0/Melon_JE2_BE2.png")), new Button("SkyWars #4", Image::path("textures/items/apple.png")), ], function(Player $player, Button $selected) : void{ $player->sendMessage("You selected: " . $selected->text); $player->sendMessage("Index of button: " . $selected->getValue()); }));
Creating MenuForm from array of strings (i.e. from string[]) with modern syntax of matching button clicks
match ($selected->getValue()) {
0 => $player->sendMessage("message #1"), //opt1
1 => $player->sendMessage("message #2"), //opt2
2 => $player->sendMessage("message #3"), //opt3
default => $player->sendMessage("You selected: " . $selected->text),
}));
">
//MenuForm::withOptions is useful when you have a string[] //syntax TIP: fn() added since PHP 7.4, match since PHP 8.0 $player->sendForm(MenuForm::withOptions("Select option", "List of options:", [ "opt1", "opt2", "opt3", "default branch #1", "default branch #2", ], fn(Player $player, Button $selected) => match ($selected->getValue()) { 0 => $player->sendMessage("message #1"), //opt1 1 => $player->sendMessage("message #2"), //opt2 2 => $player->sendMessage("message #3"), //opt3 default => $player->sendMessage("You selected: " . $selected->text), }));
Appending MenuForm with new options to handle different permissions
getName(), [
"view statistics", //accessible for all
], fn(Player $player, Button $selected) => match ($selected->getValue()) {
0 => $player->sendMessage("*statistics*"),
1 => $player->kick("kick message"),
2 => $player->sendMessage("*logs*"),
default => throw new \AssertionError("unreachable code"), //shut phpstan
});
$isOp = $player->hasPermission(DefaultPermissions::ROOT_OPERATOR); //since PM 4.0
if($isOp){ //accessible for ops
$form->appendOptions("kick player", "view logs");
}
$player->sendForm($form);
">
//appending form data if Player has enough permissions $form = MenuForm::withOptions("Player info", "Username: " . $player->getName(), [ "view statistics", //accessible for all ], fn(Player $player, Button $selected) => match ($selected->getValue()) { 0 => $player->sendMessage("*statistics*"), 1 => $player->kick("kick message"), 2 => $player->sendMessage("*logs*"), default => throw new \AssertionError("unreachable code"), //shut phpstan }); $isOp = $player->hasPermission(DefaultPermissions::ROOT_OPERATOR); //since PM 4.0 if($isOp){ //accessible for ops $form->appendOptions("kick player", "view logs"); } $player->sendForm($form);
CustomForm
Using CustomForm with strict-typed API
() does not work with label
new Slider("Select count", 0.0, 100.0, 1.0, 50.0),
new StepSlider("Select product", ["beer", "cheese", "cola"]),
new Toggle("Creative", $player->isCreative()),
], function(Player $player, CustomFormResponse $response) : void{
$dropdown = $response->getDropdown();
$player->sendMessage("You selected: " . $dropdown->getSelectedOption());
$input = $response->getInput();
$player->sendMessage("Your name is " . $input->getValue());
$slider = $response->getSlider();
$player->sendMessage("Count: " . $slider->getValue());
$stepSlider = $response->getStepSlider();
$player->sendMessage("You selected: " . $stepSlider->getSelectedOption());
$toggle = $response->getToggle();
$player->setGamemode($toggle->getValue() ? GameMode::CREATIVE() : GameMode::SURVIVAL());
}));
">
$player->sendForm(new CustomForm("Enter data", [ new Dropdown("Select product", ["beer", "cheese", "cola"]), new Input("Enter your name", "Bob"), new Label("I am label!"), //Note: get() does not work with label new Slider("Select count", 0.0, 100.0, 1.0, 50.0), new StepSlider("Select product", ["beer", "cheese", "cola"]), new Toggle("Creative", $player->isCreative()), ], function(Player $player, CustomFormResponse $response) : void{ $dropdown = $response->getDropdown(); $player->sendMessage("You selected: " . $dropdown->getSelectedOption()); $input = $response->getInput(); $player->sendMessage("Your name is " . $input->getValue()); $slider = $response->getSlider(); $player->sendMessage("Count: " . $slider->getValue()); $stepSlider = $response->getStepSlider(); $player->sendMessage("You selected: " . $stepSlider->getSelectedOption()); $toggle = $response->getToggle(); $player->setGamemode($toggle->getValue() ? GameMode::CREATIVE() : GameMode::SURVIVAL()); }));
Using CustomForm with less strict-typed API
() does not work with label
new Slider("Select count", 0.0, 100.0, 1.0, 50.0),
new StepSlider("Select product", ["beer", "cheese", "cola"]),
new Toggle("Creative", $player->isCreative()),
], function(Player $player, CustomFormResponse $response) : void{
/** @var bool $enableCreative */ //type-hint for phpstan
[$product1, $username, $count, $product2, $enableCreative] = $response->getValues();
$player->sendMessage("You selected: $product1");
$player->sendMessage("Your name is $username");
$player->sendMessage("Count: $count");
$player->sendMessage("You selected: $product2");
$player->setGamemode($enableCreative ? GameMode::CREATIVE() : GameMode::SURVIVAL());
}));
">
$player->sendForm(new CustomForm("Enter data", [ new Dropdown("Select product", ["beer", "cheese", "cola"]), new Input("Enter your name", "Bob"), new Label("I am label!"), //Note: get() does not work with label new Slider("Select count", 0.0, 100.0, 1.0, 50.0), new StepSlider("Select product", ["beer", "cheese", "cola"]), new Toggle("Creative", $player->isCreative()), ], function(Player $player, CustomFormResponse $response) : void{ /** @var bool $enableCreative */ //type-hint for phpstan [$product1, $username, $count, $product2, $enableCreative] = $response->getValues(); $player->sendMessage("You selected: $product1"); $player->sendMessage("Your name is $username"); $player->sendMessage("Count: $count"); $player->sendMessage("You selected: $product2"); $player->setGamemode($enableCreative ? GameMode::CREATIVE() : GameMode::SURVIVAL()); }));
10 Dec 6, 2022
33 Dec 19, 2022
93 Oct 28, 2022
9 Aug 20, 2022
1 Dec 12, 2022
3 Oct 21, 2022
8 May 6, 2022
1.4k Dec 14, 2022
762 Dec 30, 2022
1 Jan 7, 2022
7 Feb 17, 2022
135 Dec 29, 2022
6 Jul 5, 2022
84 Dec 21, 2022
697 Nov 6, 2022
0 Oct 29, 2021
2 Sep 20, 2021
6 Oct 13, 2022
5 Aug 20, 2022