ChromaGaming/LimitedCreative
1
0
Fork 0
Code Issues 3 Pull requests Projects Releases 2 Packages Wiki Activity

Reworked DocComments for Better LineEnding parsing

Browse source
This commit is contained in:
Jascha Starke 2013-07-29 00:12:47 +02:00
parent cf028eb2dd
commit 5d7dee727b
9 changed files with 35 additions and 35 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

6
src/main/java/de/jaschastarke/minecraft/limitedcreative/Config.java
View file

@ -17,7 +17,7 @@ import de.jaschastarke.modularize.ModuleEntry.ModuleState;
*
* (YAML-Syntax: http://en.wikipedia.org/wiki/YAML)
*
* This configuration-file is automatically written when changed via ingame-commands. So any manual added comments are
* This configuration-file is automatically written when changed via ingame-commands. So any manual added comments are
* removed.
*/
@ArchiveDocComments
@ -59,8 +59,8 @@ public class Config extends PluginConfiguration {
/**
* Metrics
*
* This settings allows the Addon-Author to track the Servers using this plugin. It will not track any player
* related data like names, ips, online time or such. Please do not disable the option! As more servers are using
* This settings allows the Addon-Author to track the Servers using this plugin. It will not track any player
* related data like names, ips, online time or such. Please do not disable the option! As more servers are using
* the plugin and the author knows, as more he is willing to support the plugin! Its a win-win for both.
*
* default: true

2
src/main/java/de/jaschastarke/minecraft/limitedcreative/Permissions.java
View file

@ -37,7 +37,7 @@ public class Permissions extends SimplePermissionContainerNode {
*/
public static final IPermission CONFIG = new BasicPermission(CONTAINER, "config", PermissionDefault.OP);
/**
* Gives player access to the general /limitedcreative command. This permission doesn't affect the usability, but
* Gives player access to the general /limitedcreative command. This permission doesn't affect the usability, but
* allows to hide the command from /help for users.
*/
public static final IPermission COMMAND = new BasicPermission(CONTAINER, "command", PermissionDefault.OP);

4
src/main/java/de/jaschastarke/minecraft/limitedcreative/blockstate/BlockStateConfig.java
View file

@ -63,7 +63,7 @@ public class BlockStateConfig extends Configuration implements IConfigurationSub
/**
* BlockStateEnabled
*
* This experimental Feature stores the GameMode a Block was created in, and prevents drops if a Block was created
* This experimental Feature stores the GameMode a Block was created in, and prevents drops if a Block was created
* in creative mode.
*
* Due to the Experimental state this Feature isn't enabled by default. It uses the Database-credentials from
@ -79,7 +79,7 @@ public class BlockStateConfig extends Configuration implements IConfigurationSub
/**
* BlockStateTool
*
* The id or technical name (http://tinyurl.com/bukkit-material) of an item that displays information about the
* The id or technical name (http://tinyurl.com/bukkit-material) of an item that displays information about the
* right-clicked block.
*
* default: WOOD_PICKAXE

2
src/main/java/de/jaschastarke/minecraft/limitedcreative/cmdblocker/CmdBlockPermissions.java
View file

@ -31,7 +31,7 @@ public class CmdBlockPermissions extends SimplePermissionContainerNode {
* Allows to bypass specific blockings of commands as it tests against all partial permissions:
*
* Example:
* A Command "/execute a fuzzy command -n 256" is entered by the player which is blocked by the configuration the
* A Command "/execute a fuzzy command -n 256" is entered by the player which is blocked by the configuration the
* following permissions are tested, and if one is present for the user, he is allowed to execute the command:
* - limitedcreative.cmdblock.*
* - limitedcreative.cmdblock.execute

4
src/main/java/de/jaschastarke/minecraft/limitedcreative/cmdblocker/CmdBlockerConfig.java
View file

@ -74,8 +74,8 @@ public class CmdBlockerConfig extends Configuration implements IConfigurationSub
/**
* CmdBlockerList
*
* Defines the list of commands that are blocked while in creative mode. The leading / isn't included. By default
* the list-item is treated as simple string as typed in by the user after the /. All commands starting with
* Defines the list of commands that are blocked while in creative mode. The leading / isn't included. By default
* the list-item is treated as simple string as typed in by the user after the /. All commands starting with
* this string are blocked, even if more parameteres are entered by the user.
* If the first character is ^ the entry is interpreted as a regular expression (including the ^ for begin of the string).
* Only use regular expressions if you know them!

4
src/main/java/de/jaschastarke/minecraft/limitedcreative/gmperm/GMPermConfig.java
View file

@ -73,8 +73,8 @@ public class GMPermConfig extends Configuration implements IConfigurationSubGrou
/**
* GMPermCreativeGroup
*
* Defines the Permission-Group which the player gets added to on entering creative-mode. If this value is changed
* the old group won't be automatically removed from players already in it. So be sure to delete the old group or
* Defines the Permission-Group which the player gets added to on entering creative-mode. If this value is changed
* the old group won't be automatically removed from players already in it. So be sure to delete the old group or
* remove all player of it, that they don't get stuck with that permissions.
*/
@IsConfigurationNode(order = 200)

4
src/main/java/de/jaschastarke/minecraft/limitedcreative/inventories/InventoryConfig.java
View file

@ -72,7 +72,7 @@ public class InventoryConfig extends Configuration implements IConfigurationSubG
/**
* InventoryEnabled
*
* Use this option to disable the separated inventories feature, for example if you use another Plugin handling
* Use this option to disable the separated inventories feature, for example if you use another Plugin handling
* the inventories, like Multiverse-Inventories.
*
* default: true
@ -98,7 +98,7 @@ public class InventoryConfig extends Configuration implements IConfigurationSubG
/**
* InventorySeparateAdventure
*
* When true, your players get a separate inventory when switching to adventure gamemode (2). Otherwise
* When true, your players get a separate inventory when switching to adventure gamemode (2). Otherwise
* they have the default survival inventory while in adventure gamemode.
*
* default: false

32
src/main/java/de/jaschastarke/minecraft/limitedcreative/limits/LimitConfig.java
View file

@ -92,7 +92,7 @@ public class LimitConfig extends Configuration implements IConfigurationSubGroup
* - dropping items from "inventory" to the ground
* - doing PvP (wouldn't be fair, would it?)
*
* Also if this option is disabled all other Limit-Options below are disabled too. To just disable some of these
* Also if this option is disabled all other Limit-Options below are disabled too. To just disable some of these
* limitations, use the "nolimit"-permissions.
*
* default: true
@ -105,7 +105,7 @@ public class LimitConfig extends Configuration implements IConfigurationSubGroup
/**
* LimitDropsInsteadPrevent
*
* When enabled items that are dropped by creative players are removed (burning in the hellfire or so, they just
* When enabled items that are dropped by creative players are removed (burning in the hellfire or so, they just
* disappear). When disabled the items stay in the inventory of the player.
*
* default: false
@ -129,7 +129,7 @@ public class LimitConfig extends Configuration implements IConfigurationSubGroup
/**
* LimitDamageToMobs
*
* Prevents dealing damage to all creatures when the player is in creative (friendly sheeps as well as hostile
* Prevents dealing damage to all creatures when the player is in creative (friendly sheeps as well as hostile
* creepers).
*
* default: false
@ -143,8 +143,8 @@ public class LimitConfig extends Configuration implements IConfigurationSubGroup
/**
* LimitPickup
*
* Prevents the pickup of items while in creative mode. Either the items are just stay on ground and ignore that a
* creative player walks over it ("prevent"), or the are "remove"d when a creative player walks over it. This is
* Prevents the pickup of items while in creative mode. Either the items are just stay on ground and ignore that a
* creative player walks over it ("prevent"), or the are "remove"d when a creative player walks over it. This is
* helpful e.g. when the creative player destroys a long line of rails.
*
* valid options: remove / prevent / false
@ -165,12 +165,12 @@ public class LimitConfig extends Configuration implements IConfigurationSubGroup
/**
* LimitInteraction
*
* Prevents players of interacting with specific blocks as addition to chests in creative mode (and only in
* Prevents players of interacting with specific blocks as addition to chests in creative mode (and only in
* creative).
*
* You can use the technical name (http://tinyurl.com/bukkit-material) or
* the id of the block/item (better use the id, if you're not sure). You may add the data separated with a colon
* e.g.: "WOOL:11" blocks blue wool. But be sure to put it in quotes, to not break yml-configuration! Named data
* You can use the technical name (http://tinyurl.com/bukkit-material) or
* the id of the block/item (better use the id, if you're not sure). You may add the data separated with a colon
* e.g.: "WOOL:11" blocks blue wool. But be sure to put it in quotes, to not break yml-configuration! Named data
* values aren't supported yet. If you don't add a data-value, all blocks of this material are blocked.
*
* default:
@ -206,7 +206,7 @@ public class LimitConfig extends Configuration implements IConfigurationSubGroup
*
* Prevents players of interacting with specific entities in creative mode (and only in creative).
*
* You can use the technical name (see http://tinyurl.com/bukkit-entity) or the id of the entity (better use the id,
* You can use the technical name (see http://tinyurl.com/bukkit-entity) or the id of the entity (better use the id,
* if you're not sure).
*
* default:
@ -238,9 +238,9 @@ public class LimitConfig extends Configuration implements IConfigurationSubGroup
*
* Prevents players of using or placing specific items/blocks in creative mode (and only in creative).
*
* You can use the technical name (see http://tinyurl.com/bukkit-material) or
* the id of the block/item (better use the id, if you're not sure). You may add the data separated with a colon
* e.g.: "WOOL:11" blocks blue wool. But be sure to put it in quotes, to not break yml-configuration! Named data
* You can use the technical name (see http://tinyurl.com/bukkit-material) or
* the id of the block/item (better use the id, if you're not sure). You may add the data separated with a colon
* e.g.: "WOOL:11" blocks blue wool. But be sure to put it in quotes, to not break yml-configuration! Named data
* values aren't supported yet. If you don't add a data-value, all blocks of this material are blocked.
*
* default:
@ -265,9 +265,9 @@ public class LimitConfig extends Configuration implements IConfigurationSubGroup
*
* Prevents players of destroying specific blocks in creative mode (and only in creative).
*
* You can use the technical name (see http://tinyurl.com/bukkit-material) or
* the id of the block/item (better use the id, if you're not sure). You may add the data separated with a colon
* e.g.: "WOOL:11" blocks blue wool. But be sure to put it in quotes, to not break yml-configuration! Named data
* You can use the technical name (see http://tinyurl.com/bukkit-material) or
* the id of the block/item (better use the id, if you're not sure). You may add the data separated with a colon
* e.g.: "WOOL:11" blocks blue wool. But be sure to put it in quotes, to not break yml-configuration! Named data
* values aren't supported yet. If you don't add a data-value, all blocks of this material are blocked.
*
* default:

12
src/main/java/de/jaschastarke/minecraft/limitedcreative/regions/RegionConfig.java
View file

@ -66,7 +66,7 @@ public class RegionConfig extends Configuration implements IConfigurationSubGrou
/**
* RegionEnabled
*
* Enables the feature for "creative-regions". This Feature is automatically disabled, if the required plugin
* Enables the feature for "creative-regions". This Feature is automatically disabled, if the required plugin
* "WorldGuard" (http://dev.bukkit.org/server-mods/worldguard/) isn't found.
*
* default: true
@ -79,9 +79,9 @@ public class RegionConfig extends Configuration implements IConfigurationSubGrou
/**
* RegionRememberOptional
*
* Remembers if players disables the Region-GameMode (by switching in an optional region to World-Default-GameMode
* Remembers if players disables the Region-GameMode (by switching in an optional region to World-Default-GameMode
* with /lc creative|survival). So when the player re-enters the region, he keep his GameMode which he left it in.
* Hint: This is very confusing, if MultiVerse "enforce gamemode" swaps your state (default). So better don't use
* Hint: This is very confusing, if MultiVerse "enforce gamemode" swaps your state (default). So better don't use
* with Multiverse.
*
* default: false
@ -94,9 +94,9 @@ public class RegionConfig extends Configuration implements IConfigurationSubGrou
/**
* RegionSafeMode
*
* When a player leaves a region he always will get back to the World-GameMode, even if he entered the region already
* When a player leaves a region he always will get back to the World-GameMode, even if he entered the region already
* in the Region-GameMode. So its the opposite analog to RegionRememberOptional.
* That means: If a GM in creative-mode walks/flies through a creative-region in a survival world, he will get back
* That means: If a GM in creative-mode walks/flies through a creative-region in a survival world, he will get back
* to survival on leaving the region.
*
* default: false
@ -110,7 +110,7 @@ public class RegionConfig extends Configuration implements IConfigurationSubGrou
/**
* RegionMaximumFallingHeight
*
* When the player is more than this count of blocks above the ground, he is prevented from changing the region that
* When the player is more than this count of blocks above the ground, he is prevented from changing the region that
* sets him survival which would cause him falling and hurting.
*
* default: 3