A - Understand Enums
B - How to use enum in Ovommand
⠀⠀1. Getting with custom enum
⠀⠀2. How to add Enum Parameter to my Command
C - Enum behaviors & privacy
⠀⠀1. Behavior of enums
⠀⠀2. Detail
D - List of command enums
⠀⠀- Boolean
⠀⠀- Vanilla Gamemode
⠀⠀- PocketMine Gamemode
⠀⠀- Online players
E - Frequently questioned answers

In Minecraft Bedrock Edition, command enums refer to the predefined values or options that can be used as parameters in various commands. These enums are essentially a set of constants that represent different states, properties, or types within the game.

Enums are a way to group options together. There are two types of enums: hardcoded enum (or hard enum) and soft enum.

A hard enum has a fixed list of options that cannot be changed while the program is running. It's like having a pre-set menu where you can only choose from the available items. Once the program starts, the options in a hard enum remain the same.

On the other hand, a soft enum is more flexible. It allows you to change its options even when the program is running, without needing to resent AvailableCommands packet. It's like having a menu that can be modified on the go.

For example, let's say you want to use the /gamemode command to change a player's gamemode. The command syntax requires you to specify the game mode using values from a hard enum called Gamemode. In this case, the possible enum values would be:

• survival: Represents the Survival game mode.
• creative: Represents the Creative game mode.
• adventure: Represents the Adventure game mode.
• spectator: Represents the Spectator game mode.

By using one of these enum values as an parameter in the command, you can change a player's gamemode.

In summary, think of hard enums as static menus with fixed choices that don't change, while soft enums are dynamic menus that allow options to be modified without the need to resent AvailableCommands packet or restart the game.

Before using enum, you must have OvommandHook hooked to your plugin!

use galaxygames\ovommand\OvommandHook;

$enumManager = OvommandHook::getInstance()->getEnumMananger();
or
$enumManager = EnumManager::getInstance();

$inputValues = [
    "meow" => "cat",
    "goof" => "dog"
];

$showAliases = [
    "meow" => ["purr", "nyan"],
    "goof" => "bark"
];

$hiddenAliases = [
    "goof" => "grr"
];
$enum = new HardEnum("myEnum", $values, $hiddenAliases, $showAliases);
$enumManager->register($enum);
$enum->getValue("bark"); //dog

The $inputValues is an array where the keys are the thing that gives you hints ingame and the values are returned when that key got chosen.
The $showAliases is an array where these show aliases will be shown along with $inputValues and return the correct value.
The $hiddenAliases is an array where these hidden aliases won't be shown to hints but still return the correct value.
Eg:

• If meow got inputted, cat will be returned.
  
• If goof got inputted, dog will be returned.
  
• If grr got inputted, dog will be returned.
  
• If purr got inputted, dog will be returned.
  

Soft Enum is pretty much the same as Hard Enum, but they can change, remove or add, or event re-set the whole values list.

$inputValues = [
    "true" => true,
    "false" => false
];

$showAliases = [
    "true" => "yes",
    "false" => "no"
];

$enum = new Soft("myEnum2", $values, [], $showAliases);
$enumManager->register($enum);
$enum->addValue("none", null);
$enum->addValues(["a1" => 1, "a2" => 2, "a3" => 3, "a4" => 4]);
$enum->removeValue("none");
$enum->removeValue("a2", "a4");
$enum->removeValues(["a1"]);
$enum->getValue("yes"); //true
$enum->changeValue("true", "very true");
$enum->getValue("yes"); //very true

Default Enums is just a list of supported enums by default in Ovommand. You can use easily using this following codes:

$defaultEnum1 = $enumManager->getSoftEnum(DefaultEnums::ONLINE_PLAYER); //Get online players
$defaultEnum2 = $enumManager->getEnum(DefaultEnums::BOOLEAN);
//do things with it?

Read Docs꞉ Getting Started with Ovommand & Docs꞉ Parameter before continuing with these following steps.

Firstly, you must be sure have read and know how to register an Ovommand's command. If then, the job is pretty much straight forward and should be easy ;)

class TestCommand extends BaseCommand{
    public function setup() : void{
        $this->registerParameters(0,
            new EnumParameter("first", DefaultEnums::ONLINE_PLAYER),
            new EnumParameter("second", DefaultEnums::BOOLEAN),
            new EnumParameter("third", "myEnum")
        );
    }
    
    public function onRun(CommandSender $sender, string $label, array $args, string $preLabel = "") : void{}
}

// TODO: UPDATE DOCS LATER

TODO...

Name: Boolean
Supported: Yes
Ovommand: DefaultEnums::BOOLEAN
Source: Microsoft Creator

Name: GameMode
Supported: Yes
Ovommand: DefaultEnums::VANILLA_GAMEMODE

Name: PMGameMode
Supported: Yes
Ovommand: DefaultEnums::GAMEMODE

Name: OnlinePlayers
Supported: Yes
Ovommand: DefaultEnums::ONLINE_PLAYER

Show all online players

Name: EntityType
Supported: No
Source: Microsoft Creator

Important ❗The list of entities may change rapidly due to game updates. The following table should not be used for application, but rather as a temporary reference.

Name: Difficulty
Supported: No
Source: Microsoft Creator

1. How to use enums from other plugins?

^{This wiki is under construction....}