Difference between revisions of "PlayMCOnline/Chest Keys"
From SupaHam
(Initial page creation.) |
(Added some commands.) |
||
| Line 1: | Line 1: | ||
'''Chest Keys''' are chests that require keys to be "opened". Each chest key is assigned it's own '''unique id'''. Almost every property belonging to a chest key can be configured through the commands. | '''Chest Keys''' are chests that require keys to be "opened". Each chest key is assigned it's own '''unique id'''. Almost every property belonging to a chest key can be configured through the commands. | ||
| − | == Configuration == | + | ==Configuration== |
| − | {{tip|text=Before starting to mess around with a configuration file, please head over | + | {{tip|text=Before starting to mess around with a configuration file, please head over [[Configurations|here]] and familiarise yourself.}} |
{| class="wiki-table" | {| class="wiki-table" | ||
| Line 20: | Line 20: | ||
|- | |- | ||
| chests.<world>.<id>.cooldowns || Map<String, Long> || '''String''' is the player name. <br /> '''Long''' is the milliseconds that the player's cooldown will expire. | | chests.<world>.<id>.cooldowns || Map<String, Long> || '''String''' is the player name. <br /> '''Long''' is the milliseconds that the player's cooldown will expire. | ||
| + | |} | ||
| + | |||
| + | ==Commands== | ||
| + | {{tip|text=Confused with command syntax or want to make the most out of them? Head over [[Commands|here]] for help.}} | ||
| + | |||
| + | {| class="wiki-table" | ||
| + | ! width="100"| Parent | ||
| + | ! width="200"| Command | ||
| + | ! width="200"| Permission | ||
| + | ! width="100"| Aliases | ||
| + | ! Description | ||
| + | |- | ||
| + | | || chestkeys || || ck || Chest keys management command. | ||
| + | |- | ||
| + | | chestkeys || create [-h] <id> [location] || pmco.cmd.chestkeys.create || c || Creates a chest key. The '''<id>''' argument is the id to assign to the chest.<br /> The [location] argument is the location of the chest, if no argument is provided it will attempt to default to a chest block the command sender is looking at.<br /> The -h flag will make the chest's key the item in the command sender's hand. | ||
| + | |- | ||
| + | | chestkeys || create [-h] <id> [location] || pmco.cmd.chestkeys.create || c || Creates a chest key. The '''<id>''' argument is the id to assign to the chest.<br /> The [location] argument is the location of the chest, if no argument is provided it will attempt to default to a chest block the command sender is looking at.<br /> The -h flag will make the chest's key the item in the command sender's hand. | ||
|} | |} | ||
Latest revision as of 03:01, 19 January 2014
Chest Keys are chests that require keys to be "opened". Each chest key is assigned it's own unique id. Almost every property belonging to a chest key can be configured through the commands.
Configuration
Tip: Before starting to mess around with a configuration file, please head over here and familiarise yourself.
| Configuration | Value | Description |
|---|---|---|
| enabled-worlds | List<String> | A list of worlds this module should be enabled for. |
| chests.<world>.<id> | N/A | This a configuration section for a chest key, where <id> is replaced with the id of a chest key. |
| chests.<world>.<id>.cooldown-duration | Integer | Duration (in seconds) that a player should be on cooldown for after interacting with this chest key. |
| chests.<world>.<id>.location | Location | The location of the chest block. |
| chests.<world>.<id>.key | ItemStack | The exact ItemStack required to open this chest key. |
| chests.<world>.<id>.cooldowns | Map<String, Long> | String is the player name. Long is the milliseconds that the player's cooldown will expire. |
Commands
Tip: Confused with command syntax or want to make the most out of them? Head over here for help.
| Parent | Command | Permission | Aliases | Description |
|---|---|---|---|---|
| chestkeys | ck | Chest keys management command. | ||
| chestkeys | create [-h] <id> [location] | pmco.cmd.chestkeys.create | c | Creates a chest key. The <id> argument is the id to assign to the chest. The [location] argument is the location of the chest, if no argument is provided it will attempt to default to a chest block the command sender is looking at. The -h flag will make the chest's key the item in the command sender's hand. |
| chestkeys | create [-h] <id> [location] | pmco.cmd.chestkeys.create | c | Creates a chest key. The <id> argument is the id to assign to the chest. The [location] argument is the location of the chest, if no argument is provided it will attempt to default to a chest block the command sender is looking at. The -h flag will make the chest's key the item in the command sender's hand. |
