Commands - Revision history

SupaHam: Updated WorldEdit commands package.

2015-01-27T22:08:13Z

Updated WorldEdit commands package.

SupaHam: Forced TOC.

2014-01-18T07:35:40Z

Forced TOC.

SupaHam: Added flag section.

2014-01-18T07:32:21Z

Added flag section.

SupaHam: Fixed formatting.

2014-01-18T07:02:17Z

Fixed formatting.

SupaHam at 07:01, 18 January 2014

2014-01-18T07:01:58Z

SupaHam: Initial page creation. phew

2014-01-18T07:01:30Z

Initial page creation. phew

New page

A '''command''' in Minecraft starts with a '''forward slash (/)'''.

{{example|text='''/seed'''}}

The '''seed''' command is a vanilla command, meaning it comes with Minecraft without any modifications.
===Permissions===
Some commands require '''permissions'''. If a player does not have the appropriate permissions for a command an error message is sent to the player. Vanilla commands that require permissions are acquired by becoming an [http://minecraft.gamepedia.com/Operator Operator].

Though Minecraft server modifications such as [http://bukkit.org/ Bukkit] have a permissions implementation that allow you to apply permission nodes (String) to players, this allows for maximum flexibility.

{{example|text=Imagine a scenario where you, as a '''server admin''', want to give a player permission to only mute other players, to help keep the chat clean. '''Without''' Bukkit this is not possible. You would have to give that player op status which gives them permission to all other commands on the server. You might not be able to trust someone with that many permissions, this is where '''Bukkit's SuperPerms''' implementation comes in. SuperPerms is a Bukkit implementation that allows for plugins to hook into Bukkit and check player permissions and with a permissions management plugin such as [http://dev.bukkit.org/bukkit-plugins/permissionsex/ PermissionsEx] you are able to manage player permissions and do much more.}}

A permission node is a '''String''' (text) usually seperated with '''fullstops/periods (.)''' instead of whitespaces.

{{example|text="'''my.command.permission'''"}}

===Arguments===
There are commands such as /seed which are simple that tell you the seed of the current world you're in, but commands do much more than that. As a developer, you can implement '''commands with arguments''' to allow your users to insert their own values and the rest is done behind the scenes (in the code).

{{example|text=/tp [target player] <destination player> /tp [target player] <x> <y> <z>}}

The example above is copied straight out of the vanilla Minecraft which allows you to teleport around the world. Now, you might get confused since you see '''square brackets ([])''' and '''angle brackets (<>)''', those are the arguments. Any developer can implement their syntax just the way they want so don't base the following information on all plugins, though I (SupaHam) tend to make mine similar to how Minecraft and many Bukkit plugins do theirs. So with the '''tp''' command the square brackets are '''optional''' and the angle brackets are '''required'''. Usually between these brackets are a descriptive one/two words.

So, the tp command has the '''[target player]''' and the '''<destination player>''' argument for one of the usages. If you understood well then you should know that the [target player] is not required but the <destination player> is.

{{example|text=
'''A.''' SupaHam executes '''/tp Steve''' 
Minecraft then takes that 'Steve' argument and checks if it's valid 
'''Case: Steve is online''' 
* Minecraft checks if Steve is online on the same server as SupaHam. If Steve is online, SupaHam will get teleported to him.
'''Case: Steve is offline''' 
* Minecraft outputs an error to the command sender saying 'Steve' is not a valid player.

'''B.''' SupaHam executes '''/tp Steve SupaHam''' 

Notice the difference between command '''A''' and command '''B'''? Command B is making use of the optional argument ([target player]).
Minecraft then takes both 'Steve' and 'SupaHam' and check if they are both valid players, as shown with the cases above. If they are both valid Minecraft then teleports 'Steve' to 'SupaHam'.
}}

← Older revision		Revision as of 22:08, 27 January 2015
Line 46:		Line 46:
	}}		}}

−	As a developer, you might think "Wow, why waste so much time implementing such a complex system for my plugins?!", well here's some good news, there are frameworks already written for you to use! I personally prefer to use [http://wiki.sk89q.com/wiki/WorldEdit WorldEdit]'s command framework which can be found [https://github.com/sk89q/~~worldedit~~/tree/master/src/main/java/com/sk89q/minecraft/util/commands here], though this requires your plugin to depend on WorldEdit, while most Minecraft servers use WorldEdit it's still not very nice to force your users to install something they don't want to install, but... there is a fork of WorldEdit's command framework by the [https://oc.tc/ Overcast Network] which can be found [https://github.com/OvercastNetwork/sk89q-command-framework here]. Unlike WorldEdit's version, you can easily ''shade'' this fork into your plugin, meaning you save up a lot of space and don't have to force your users to install WorldEdit.	+	As a developer, you might think "Wow, why waste so much time implementing such a complex system for my plugins?!", well here's some good news, there are frameworks already written for you to use! I personally prefer to use [http://wiki.sk89q.com/wiki/WorldEdit WorldEdit]'s command framework which can be found [https://github.com/sk89q/WorldEdit/tree/master/worldedit-core/src/main/java/com/sk89q/minecraft/util/commands here], though this requires your plugin to depend on WorldEdit, while most Minecraft servers use WorldEdit it's still not very nice to force your users to install something they don't want to install, but... there is a fork of WorldEdit's command framework by the [https://oc.tc/ Overcast Network] which can be found [https://github.com/OvercastNetwork/sk89q-command-framework here]. Unlike WorldEdit's version, you can easily ''shade'' this fork into your plugin, meaning you save up a lot of space and don't have to force your users to install WorldEdit.

@@ Line 4: / Line 4: @@
 The '''seed''' command is a vanilla command, meaning it comes with Minecraft without any modifications.
 == Permissions ==
 Some commands require '''permissions'''. If a player does not have the appropriate permissions for a command an error message is sent to the player. Vanilla commands that require permissions are acquired by becoming an [http://minecraft.gamepedia.com/Operator Operator].

@@ Line 4: / Line 4: @@
 The '''seed''' command is a vanilla command, meaning it comes with Minecraft without any modifications.
-==Permissions==
+== Permissions ==
 Some commands require '''permissions'''. If a player does not have the appropriate permissions for a command an error message is sent to the player. Vanilla commands that require permissions are acquired by becoming an [http://minecraft.gamepedia.com/Operator Operator].
@@ Line 15: / Line 15: @@
 {{example|text="'''my.command.permission'''"}}
-==Arguments==
+== Arguments ==
 There are commands such as /seed which are simple that tell you the seed of the current world you're in, but commands do much more than that. As a developer, you can implement '''commands with arguments''' to allow your users to insert their own values and the rest is done behind the scenes (in the code).
@@ Line 37: / Line 37: @@
 Minecraft then takes both 'Steve' and 'SupaHam' and check if they are both valid players, as shown with the cases above. If they are both valid Minecraft then teleports 'Steve' to 'SupaHam'.
 }}