Tutorial Temporary: MCPE Command Syntax checking

jasonwynn10 · Aug 21, 2017

SOFe said: ↑

FYI: Last time I checked the packet isn't even completed on PocketMine.
Click to expand...

Mind finishing it?

Levi · Mar 3, 2019

Sandertv said: ↑

Hello everyone,

Due to the lacking API in the PocketMine core I've decided to make this quick tutorial for developers to see how they can make use of the command syntax checking from MCPE with what the current API offers. This will get rendundant when a proper API gets implemented for this, but for now, this tutorial shows you exactly how to do it.

This tutorial aims to show how to add command syntax checking for classes inside of a class that extends Command. (or PluginCommand) Using this in any other class will not have any effect.

The method that can currently be used, or actually overwritten from the Command class is the 'generateCustomCommandData' method, which looks like this:

PHP:

public function generateCustomCommandData(pocketmine\Player $player) { }

First off, we're making sure to call the parent function, or the function that we are overwriting, by adding:

PHP:

$commandData = parent::generateCustomCommandData($player);

In order to add our custom syntax checking instead of string:args, we'll have go through the following array 'structure':

PHP:

$commandData["overloads"]["default"]["input"]["parameters"] = [];

There we go! We can now change the array to whatever we want our argument structure to look like. Say we want one integer type argument and one player argument and an argument with the autocompletion options called hi and hello. This is what we would do:

PHP:

$commandData["overloads"]["default"]["input"]["parameters"] = [       [          "type" => "int",          "name" => "amount",          "optional" => false,       ],       [          "type" => "rawtext",          "name" => "player",          "optional" => false       ],       [          "type" => "stringenum",          "name" => "parameter",          "optional" => true          "enum_values" => ["hi", "hello"]       ]   ] ];

There we go. We have our argument structure finished. If we put this inside of our command class, it will have the desired effect. A useful list of available argument types and more can be found on this gist by @gurun:

But can't we do this easier? I don't want to have this method in everyone of my command classes, it's too much duplicated code! Yes, there are some ways to make it semi-automatic. This part is my personal preference, and you may or may not like it too.

If you decide to use my way, create a new class and put the following code in it. (MAKE SURE TO ADJUST THE NAMESPACE AND CLASS NAME)

PHP:

<?php namespace My\Namespace; class CommandOverloads {     private static $commandOverloads = [           "mycommand" => [                [                  "type" => "int",                  "name" => "amount",                  "optional" => false,               ],               [                  "type" => "rawtext",                  "name" => "player",                  "optional" => false                ],                [                  "type" => "stringenum",                  "name" => "parameter",                  "optional" => true                  "enum_values" => ["hi", "hello"]                ]             ],        ];     /**     * @param string $command     *     * @return array     */     public static function getOverloads(string $command): array {         return self::$commandOverloads[$command];     } }

You could of course use json for this as well. I was just too lazy for that, and this works fine as well. In order to get this all working, you will need a superclass for the command classes you made, and make your commands extend that superclass. In your superclass, for example BaseCommand, you can then add the following code:

PHP:

public function generateCustomCommandData(Player $player) {     $commandData = parent::generateCustomCommandData($player);     $commandData["overloads"]["default"]["input"]["parameters"] = CommandOverloads::getOverloads($this->getName());     return $commandData; }

Just make sure to have the key in the array from CommandOverloads be exactly the same name as your command name, and there you go! You can now simply add new arguments to the array and add new commands without any additional code.

I hope this helped for you. Looking forward to seeing more plugins with MCPE argument syntax checking!
Remember, once a proper API gets added in PMMP this tutorial will be obsolete. Examples of the usage of this can be found in some of the plugins I work on. I'm not going to mention them here as I'm not a supporter of advertisement.
Click to expand...

is this patched?

notdrewdev · Apr 16, 2019

@Levi, Thanks for bumping a 2 year old thread. Your question has an answer though, yes it is patched.

Nie znam · Aug 12, 2021

@Sandertv, there is no such method in Command.php

ethaniccc · Aug 12, 2021

Nie znam said: ↑

@Sandertv, there is no such method in Command.php
Click to expand...

The tutorial was made in 2017, the API probably changed alot since then

Nie znam · Aug 12, 2021

that's how to do it now?

Tutorial Temporary: MCPE Command Syntax checking

jasonwynn10 Moderator Poggit Reviewer

Levi Skeleton

notdrewdev Spider Jockey

Nie znam Creeper

ethaniccc Baby Zombie

Nie znam Creeper