Command Interface

Start: Home ⬩ Previous: Overview ⬩ Next: Items
See also: Command Reference

---

BeastMaster has a kind of Object-Oriented command interface. Each concept that BeastMaster can configure is identified by distinct noun that forms part of the name of the command that configures it.

Concept	Noun	Command
Items	item	/beast-item
Mobs	mob	/beast-mob
Loot Tables	loot	/beast-loot
Zones	zone	/beast-zone
Potion Sets	potion	/beast-potion
Objectives	obj	/beast-obj

Instances of the nouns are the objects to be manipulated. Each of the BeastMaster commands supports a set of verbs that can be applied to that specific noun. In order to identify the specific instance of an object that will be affected, the command will also take an identifier or ID of that object. The general form of BeastMaster commands is, therefore:

/beast-<noun> <verb> <noun-id> [ <value1> .. <valueN> ]

For example:

• /beast-loot add my-loot-table - Add a new Loot Table with the ID "my-loot-table".
• /beast-loot add-drop my-loot-table item magic-wand 10 - Add a 10% chance drop to "my-loot-table" which is an item with the ID "magic-wand" (that has presumably been previously defined with /beast-item).
• /beast-mob list - List all of the types of Mob.

The BeastMaster command interface strives to be as uniform as possible, to make it easy to learn. To that end, verbs tend to do similar things, regardless of which command implements them:

• /beast-<noun> add ... will add a new <noun> to the collection of them managed by BeastMaster.
• /beast-<noun> remove ... will remove a <noun> from that collection.
• /beast-<noun> list lists all entries in the collection.
• /beast-<noun> add-<other-noun> ... will add an element of type <other-noun> (in the /beast-loot add-drop example above, that would be drop) where <noun> is the kind of thing that can contain other things (in this case, a Loot Table contains drops).

Getting Command Help

BeastMaster conforms to Bukkit's help conventions. That means you can get a list of all BeastMaster commands by running /help BeastMaster, followed by an optional page number. When you know the name of a command, you can get help on that specific command, e.g. /help /beast-zone, or equivalently /help beast-zone (without the second /).

In addition to the usual methods, all BeastMaster commands support help as their first argument, e.g. /beast-loot help.

Furthermore, some BeastMaster commands also provide additional information pertinent to the current sub-command, when an erroneous or incomplete command is issued. For example, /beast-mob set will show the full usage of the set sub-command (/beast-mob set <mob-id> <property> <value>) and will also list the names of all mob properties that can be set.

Command Reference

For detailed information on all commands, see the Command Reference page.

---

Start: Home ⬩ Previous: Overview ⬩ Next: Items