EasySign: Difference between revisions

From MC Public Wiki
Jump to navigation Jump to search
(adding new commands.)
mNo edit summary
Line 16: Line 16:
An example would be: <code>/easy-sign warp 1 2 3</code>
An example would be: <code>/easy-sign warp 1 2 3</code>


== sleep ==
== announce ==
Command: /easy-sign announce <id> <message>


Args: None
Sets up an announcement sign. The message is broadcast (only once) when a player clicks the sign. The message supports colors with the same notation as <code>/signtext</code> and %s is replaced with the player's name. The id sets the "key" for the sign group, players can only announce once per group, but as many signs as you like can be in the group.


A sleep sign sets the players bed at their current location.
== cart ==
Command: /easy-sign cart [<world>] x y z


== warp ==
Spawns a minecart at the specified location.


Args: [world] x y z
== ci ==
Command: /easy-sign ci


A warp sign warps the user to the given x y z location in the current world, or another world if specified.  Default world names are world, world_nether and world_the_end.  Coordinates can include decimal points.
Clears the player's inventory


== ci ==
== clearpotions ==
Command: /easy-sign clearpotions


Args: None
Clears all potion effects.


Clears the player's inventory
== cmd ==
Command: /easy-sign cmd <command>


== cmd ==
runs the command as the user


Args: <command>
== dropinventory ==
Command: /easy-sign dropinventory [scatter] [<world>] <x> <y> <z>


runs the command as the user
Drops a copy of your current inventory at the specified coordinates. Specify 'scatter' as the first argument to give the dropped items random velocities.


== give ==
== give ==
 
Command: /easy-sign give <item> <qty> [<slot>]
Args: item qty [slot]


Gives the player a certain qty of an item. If slot is present, it is given directly to that slot number, which is useful for armor. Other items are simply added to the user's inventory directly. 100 is feet, 101 is legs, 102 is chest, and 103 is helmet. Item may use the item id, (like 1 for stone) or item id:value (like 35:11 for blue wool).
Gives the player a certain qty of an item. If slot is present, it is given directly to that slot number, which is useful for armor. Other items are simply added to the user's inventory directly. 100 is feet, 101 is legs, 102 is chest, and 103 is helmet. Item may use the item id, (like 1 for stone) or item id:value (like 35:11 for blue wool).
== givemax ==
Args: <id> <item> <qty> <max gives> [<slot>]
Gives the player max # of an item


== giveheld ==
== giveheld ==
 
Command: /easy-sign giveheld [<slot>]
Args: [<slot>]


Gives the player a duplicate of your currently held item.
Gives the player a duplicate of your currently held item.


== hunger ==
== giveinventory ==
Command: /easy-sign giveinventory


Args: none
Gives the player the items in your inventory, filling the empty space


Refills a players hunger bar
== givemax ==
Command: /easy-sign givemax <id> <item> <qty> <max gives> [<slot>]


== announce ==
Gives the player max # of an item
 
Args: id message...
 
Sets up an announcement sign. The message is broadcast (only once) when a player clicks the sign. The message supports colors with the same notation as <code>/signtext</code> and %s is replaced with the player's name. The id sets the "key" for the sign group, players can only announce once per group, but as many signs as you like can be in the group.


== heal ==
== heal ==
 
Command: /easy-sign heal [<gap>]
Args: [gap]  


Refills a player's health. If gap is provided (it defaults to 0) then the player gets a half a heart every gap seconds. 0 means it fills up instantly.
Refills a player's health. If gap is provided (it defaults to 0) then the player gets a half a heart every gap seconds. 0 means it fills up instantly.


== max ==
== hunger ==
Command: /easy-sign hunger


Args: <id> <uses>
Refills a players hunger bar


Allows the sign to be used <uses> number of times and no more. No other commands will be run with the limit is reached.
== inventory ==
Command: /easy-sign inventory


== msg ==
Clears the player's inventory and gives them an exact copy of your current inventory.


Args: message...
== launch ==
Command: /easy-sign launch x y z


Sends the player a message. Color codes with & are supported.
Launches a player with the specified velocity vector. The magnitude of the vector cannot exceed 10 (that is, sqrt(@x ** 2 + @y ** 2 + @z ** 2) must be < 10)


== take ==
== leather ==
Command: /easy-sign leather <red> <green> <blue> <item1> .. <itemN>


Args: item qty failmsg...
Gives the player leather armor with the specified red, green and blue color components (0 - 255). <item1> to <itemN> are a list of items to give and can only be: helmet, chestplate, leggings or boots.  There can be at most 4 of these item names.
 
Takes the given item from the player (at the specified quantity) and continues through the rest of the actions on the sign. If the player doesn't have the specified quantity of the item, none of the remaining actions will happen, and the fail message will be displayed, which supports color codes.


== lore ==
== lore ==
Args: <item> <qty> <lore>||<itemmsg>||<qtymsg>
Command: /easy-sign lore <item> <qty> <lore>||<itemmsg>||<qtymsg>


Takes a specified quantity of an item from a player if it has the required lore. Colors in the lore are ignored and multiple lines are concatenated without spaces.
Takes a specified quantity of an item from a player if it has the required lore. Colors in the lore are ignored and multiple lines are concatenated without spaces.
Line 103: Line 100:
If the item is not taken for whatever reason, subsequent sign actions are not processed. Caution: multiple consecutive spaces in any of these strings will be replaced with single spaces.
If the item is not taken for whatever reason, subsequent sign actions are not processed. Caution: multiple consecutive spaces in any of these strings will be replaced with single spaces.


== potion ==
== max ==
Command: /easy-sign max <id> <uses>


Args: <id> <strength> <seconds>
Allows the sign to be used <uses> number of times and no more. No other commands will be run with the limit is reached.


Applies a potion effect to the player. <id> must be in the range 1 - 23. <strength> has a minimum of level 1.
== msg ==
Command: /easy-sign msg <message>


Minecraft potion effect IDs are documented on the Minecraft Wiki [http://www.minecraftwiki.net/wiki/Potion_effect here].
Sends the player a message. Color codes with & are supported.


== clearpotions ==
== potion ==
Command: /easy-sign potion <id> <strength> <seconds>


Clears all potion effects.
Applies a potion effect to the player. <ID> must be 1-23 <strength> has a minimum level of 1


== leather ==
== randloc ==  
Command: /easy-sign randloc <max distance>


Args: <red> <green> <blue> <item1> .. <itemN>  
Randomly spawns the player <max distance> away from 0,0


Gives the player leather armor with the specified red, green and blue color components (0 - 255).  <item1> to <itemN> are a list of items to give and can only be: helmet, chestplate, leggings or boots.  There can be at most 4 of these item names.
== setbed ==
Command: /easy-sign setbed [<world>] x y z


== inventory ==
Sets the players bed at the specified coordinates


Args: None
== sleep ==
Command: /easy-sign sleep


Clears the player's inventory and gives them an exact copy of your current inventory.
A sleep sign sets the players bed at their current location.


== dropinventory ==
== take ==
Command: /easy-sign take <item> <qty> <fail message>


Args: [scatter] [<world>] <x> <y> <z>
Takes the given item from the player (at the specified quantity) and continues through the rest of the actions on the sign. If the player doesn't have the specified quantity of the item, none of the remaining actions will happen, and the fail message will be displayed, which supports color codes.
 
Drops a copy of your current inventory at the specified coordinates. Specify 'scatter' as the first argument to give the dropped items random velocities.
 
== giveinventory ==
 
Args: none
 
Gives the player the items in your inventory, filling the empty space
 
== cart ==
 
Args: [<world>] <x> <y> <z>
 
Spawns a minecart at the specified location.
 
== launch ==
 
Args: <x> <y> <z>
 
Launches a player with the specified velocity vector. The magnitude of the vector cannot exceed 10 (that is, sqrt(@x ** 2 + @y ** 2 + @z ** 2) must be < 10)
 
== randloc ==
 
Args: <max_distance>
 
Randomly spawns the player <max_distance> away from 0,0


== tpbed ==
== tpbed ==
 
Command: /easy-sign tpbed
Args: none


Teleports the player back to their bed
Teleports the player back to their bed


== setbed ==
== warp ==
Command /easy-sign warp [<world>] x y z


Args: [<world>] x y z
A warp sign warps the user to the given x y z location in the current world, or another world if specified.  Default world names are world, world_nether and world_the_end.  Coordinates can include decimal points.
 
Sets the players bed at the specified coordinates

Revision as of 18:46, 14 February 2016

Easy Signs is a sign configuration plugin. All sign types follow the same rules:

  • Signs are "special" based on their location, not the text on the sign
  • If a sign is broken, it will be removed as an easy sign within a few minutes
  • Only admins can configure a sign
  • All players can activate the sign
  • To configure a sign, look at it, and run /easy-sign <type> [<args>] (the options are listed below)
  • Multiple actions can be added. They are run in the order they are added to the sign during configuration.
  • To activate a sign, left or right click it
  • To remove a sign, simply break it, or look at it and run /easy-sign-delete
  • To list all the actions on the sign, use /easy-sign-info. Each action will have a number in this list.
  • To remove an action from a sign, use /easy-sign-remove <number>
  • To move an action from one position to another in the order, use /easy-sign-reorder <from> <to>

Each "module" or sign type is configured differently, and the documentation is listed below. For the quick version of this guide, just run /easy-sign in game. An example would be: /easy-sign warp 1 2 3

announce

Command: /easy-sign announce <id> <message>

Sets up an announcement sign. The message is broadcast (only once) when a player clicks the sign. The message supports colors with the same notation as /signtext and %s is replaced with the player's name. The id sets the "key" for the sign group, players can only announce once per group, but as many signs as you like can be in the group.

cart

Command: /easy-sign cart [<world>] x y z

Spawns a minecart at the specified location.

ci

Command: /easy-sign ci

Clears the player's inventory

clearpotions

Command: /easy-sign clearpotions

Clears all potion effects.

cmd

Command: /easy-sign cmd <command>

runs the command as the user

dropinventory

Command: /easy-sign dropinventory [scatter] [<world>] <x> <y> <z>

Drops a copy of your current inventory at the specified coordinates. Specify 'scatter' as the first argument to give the dropped items random velocities.

give

Command: /easy-sign give <item> <qty> [<slot>]

Gives the player a certain qty of an item. If slot is present, it is given directly to that slot number, which is useful for armor. Other items are simply added to the user's inventory directly. 100 is feet, 101 is legs, 102 is chest, and 103 is helmet. Item may use the item id, (like 1 for stone) or item id:value (like 35:11 for blue wool).

giveheld

Command: /easy-sign giveheld [<slot>]

Gives the player a duplicate of your currently held item.

giveinventory

Command: /easy-sign giveinventory

Gives the player the items in your inventory, filling the empty space

givemax

Command: /easy-sign givemax <id> <item> <qty> <max gives> [<slot>]

Gives the player max # of an item

heal

Command: /easy-sign heal [<gap>]

Refills a player's health. If gap is provided (it defaults to 0) then the player gets a half a heart every gap seconds. 0 means it fills up instantly.

hunger

Command: /easy-sign hunger

Refills a players hunger bar

inventory

Command: /easy-sign inventory

Clears the player's inventory and gives them an exact copy of your current inventory.

launch

Command: /easy-sign launch x y z

Launches a player with the specified velocity vector. The magnitude of the vector cannot exceed 10 (that is, sqrt(@x ** 2 + @y ** 2 + @z ** 2) must be < 10)

leather

Command: /easy-sign leather <red> <green> <blue> <item1> .. <itemN>

Gives the player leather armor with the specified red, green and blue color components (0 - 255). <item1> to <itemN> are a list of items to give and can only be: helmet, chestplate, leggings or boots. There can be at most 4 of these item names.

lore

Command: /easy-sign lore <item> <qty> <lore>||<itemmsg>||<qtymsg>

Takes a specified quantity of an item from a player if it has the required lore. Colors in the lore are ignored and multiple lines are concatenated without spaces.

The item must be in the player's hand. If the wrong item is held, <itemmsg> is shown. If it is the right item but insufficient in quantity, <qtymsg> is shown. The <itemmsg> and <qtymsg> can be multiple words and color codes are allowed. The double-bar sequence, '||', is used to separate those arguments.

If the item is not taken for whatever reason, subsequent sign actions are not processed. Caution: multiple consecutive spaces in any of these strings will be replaced with single spaces.

max

Command: /easy-sign max <id> <uses>

Allows the sign to be used <uses> number of times and no more. No other commands will be run with the limit is reached.

msg

Command: /easy-sign msg <message>

Sends the player a message. Color codes with & are supported.

potion

Command: /easy-sign potion <id> <strength> <seconds>

Applies a potion effect to the player. <ID> must be 1-23 <strength> has a minimum level of 1

randloc

Command: /easy-sign randloc <max distance>

Randomly spawns the player <max distance> away from 0,0

setbed

Command: /easy-sign setbed [<world>] x y z

Sets the players bed at the specified coordinates

sleep

Command: /easy-sign sleep

A sleep sign sets the players bed at their current location.

take

Command: /easy-sign take <item> <qty> <fail message>

Takes the given item from the player (at the specified quantity) and continues through the rest of the actions on the sign. If the player doesn't have the specified quantity of the item, none of the remaining actions will happen, and the fail message will be displayed, which supports color codes.

tpbed

Command: /easy-sign tpbed

Teleports the player back to their bed

warp

Command /easy-sign warp [<world>] x y z

A warp sign warps the user to the given x y z location in the current world, or another world if specified. Default world names are world, world_nether and world_the_end. Coordinates can include decimal points.