Entity selectors

Entity selectors (also known as target selectors) allows you to select certain entities or players which fit a certain criteria when writing a command. Typically, these are of the form @p, @r, @a, @e or @s. By default, when converting a command without arguments, the CommandAPI will not handle these entity selectors. In order to get entity selectors to cooperate with plugins, they must be declared in the relevant config.yml section.

Example - Converting EssentialsX's /ext command

EssentialsX includes a command /ext which lets you extinguish a player that is currently on fire. The command format is the following:

/ext
/ext <player>

In order to convert this command, we could use the following config.yml file:

verbose-outputs: false
create-dispatcher-json: false
plugins-to-convert:
  - Essentials:
    - ext

Using the above config.yml file will support the following commands:

/ext
/ext Notch

However, the above config.yml will not support the following commands:

/ext @a[distance=10]
/ext @p

In order to handle this, we have to use the conversion with arguments (as described in the previous section). For this ext command, we want to only use this command on one or more players, therefore we want to use the api:players argument which is compatible with one or more players:

verbose-outputs: false
create-dispatcher-json: false
plugins-to-convert:
  - Essentials:
    - ext
    - ext <player>[api:players]