Code-Style

This commit is contained in:
Tim Düsterhus 2011-09-10 17:49:12 +02:00
parent bcfa109944
commit 8788c9c4b6
28 changed files with 116 additions and 107 deletions

View File

@ -31,7 +31,7 @@ import com.tommytony.war.utils.*;
/** /**
* Main class of War * Main class of War
* *
* @author tommytony, Tim Düsterhus * @author tommytony, Tim Düsterhus
* @package bukkit.tommytony.war * @package bukkit.tommytony.war
*/ */
@ -164,7 +164,7 @@ public class War extends JavaPlugin {
} }
this.getServer().getScheduler().cancelTasks(this); this.getServer().getScheduler().cancelTasks(this);
this.log("War v" + this.desc.getVersion() + " is off.", Level.INFO); this.log("War v" + this.desc.getVersion() + " is off.", Level.INFO);
this.setLoaded(false); this.setLoaded(false);
} }
@ -192,7 +192,7 @@ public class War extends JavaPlugin {
/** /**
* Converts the player-inventory to a loadout hashmap * Converts the player-inventory to a loadout hashmap
* *
* @param inv * @param inv
* inventory to get the items from * inventory to get the items from
* @param loadout * @param loadout
@ -221,7 +221,7 @@ public class War extends JavaPlugin {
/** /**
* Converts the player-inventory to a loadout hashmap * Converts the player-inventory to a loadout hashmap
* *
* @param player * @param player
* player to get the inventory to get the items from * player to get the inventory to get the items from
* @param loadout * @param loadout
@ -497,7 +497,7 @@ public class War extends JavaPlugin {
/** /**
* Colors the teams and examples in messages * Colors the teams and examples in messages
* *
* @param String * @param String
* str message-string * str message-string
* @param String * @param String
@ -514,7 +514,7 @@ public class War extends JavaPlugin {
/** /**
* Logs a specified message with a specified level * Logs a specified message with a specified level
* *
* @param String * @param String
* str message to log * str message to log
* @param Level * @param Level
@ -866,7 +866,7 @@ public class War extends JavaPlugin {
} }
public TeamSpawnStyle getDefaultSpawnStyle() { public TeamSpawnStyle getDefaultSpawnStyle() {
return defaultSpawnStyle; return this.defaultSpawnStyle;
} }
public void setDefaultSpawnStyle(TeamSpawnStyle defaultSpawnStyle) { public void setDefaultSpawnStyle(TeamSpawnStyle defaultSpawnStyle) {
@ -878,7 +878,7 @@ public class War extends JavaPlugin {
} }
public FlagReturn getDefaultFlagReturn() { public FlagReturn getDefaultFlagReturn() {
return defaultFlagReturn; return this.defaultFlagReturn;
} }
public HashMap<String, InventoryStash> getDisconnected() { public HashMap<String, InventoryStash> getDisconnected() {

View File

@ -19,9 +19,9 @@ import com.tommytony.war.Team;
import com.tommytony.war.Warzone; import com.tommytony.war.Warzone;
/** /**
* *
* @author tommytony * @author tommytony
* *
*/ */
public class WarBlockListener extends BlockListener { public class WarBlockListener extends BlockListener {
@ -187,7 +187,7 @@ public class WarBlockListener extends BlockListener {
if (warzone.getFlagReturn() == FlagReturn.FLAG || warzone.getFlagReturn() == FlagReturn.SPAWN) { if (warzone.getFlagReturn() == FlagReturn.FLAG || warzone.getFlagReturn() == FlagReturn.SPAWN) {
spawnOrFlag = warzone.getFlagReturn().toString(); spawnOrFlag = warzone.getFlagReturn().toString();
} }
for (Team t : warzone.getTeams()) { for (Team t : warzone.getTeams()) {
t.teamcast(team.getKind().getColor() + player.getName() + ChatColor.WHITE + " stole team " + lostFlagTeam.getName() + "'s flag."); t.teamcast(team.getKind().getColor() + player.getName() + ChatColor.WHITE + " stole team " + lostFlagTeam.getName() + "'s flag.");
if (t.getName().equals(lostFlagTeam.getName())) { if (t.getName().equals(lostFlagTeam.getName())) {
@ -195,8 +195,8 @@ public class WarBlockListener extends BlockListener {
+ " from reaching team " + team.getName() + "'s " + spawnOrFlag + "."); + " from reaching team " + team.getName() + "'s " + spawnOrFlag + ".");
} }
} }
War.war.msg(player, "You have team " + lostFlagTeam.getName() + "'s flag. Reach your team " + spawnOrFlag + " to capture it!"); War.war.msg(player, "You have team " + lostFlagTeam.getName() + "'s flag. Reach your team " + spawnOrFlag + " to capture it!");
} else { } else {
War.war.msg(player, "You can't steal team " + lostFlagTeam.getName() + "'s flag since no players are on that team."); War.war.msg(player, "You can't steal team " + lostFlagTeam.getName() + "'s flag since no players are on that team.");

View File

@ -9,7 +9,7 @@ import bukkit.tommytony.war.command.*;
/** /**
* Handles commands received by War * Handles commands received by War
* *
* @author Tim Düsterhus * @author Tim Düsterhus
* @package bukkit.tommytony.war * @package bukkit.tommytony.war
*/ */
@ -17,7 +17,7 @@ public class WarCommandHandler {
/** /**
* Handles a command * Handles a command
* *
* @param sender * @param sender
* The sender of the command * The sender of the command
* @param cmd * @param cmd

View File

@ -25,7 +25,7 @@ import com.tommytony.war.Warzone;
/** /**
* Handles Entity-Events * Handles Entity-Events
* *
* @author tommytony, Tim Düsterhus * @author tommytony, Tim Düsterhus
* @package bukkit.tommytony.war * @package bukkit.tommytony.war
*/ */
@ -33,7 +33,7 @@ public class WarEntityListener extends EntityListener {
/** /**
* Handles PVP-Damage * Handles PVP-Damage
* *
* @param event * @param event
* fired event * fired event
*/ */
@ -133,7 +133,7 @@ public class WarEntityListener extends EntityListener {
/** /**
* Protects important structures from explosions * Protects important structures from explosions
* *
* @see EntityListener.onEntityExplode() * @see EntityListener.onEntityExplode()
*/ */
@Override @Override
@ -166,7 +166,7 @@ public class WarEntityListener extends EntityListener {
/** /**
* Handles damage on Players * Handles damage on Players
* *
* @see EntityListener.onEntityDamage() * @see EntityListener.onEntityDamage()
*/ */
@Override @Override
@ -227,7 +227,7 @@ public class WarEntityListener extends EntityListener {
/** /**
* Prevents creatures from spawning in warzones if no creatures is active * Prevents creatures from spawning in warzones if no creatures is active
* *
* @see EntityListener.onCreatureSpawn() * @see EntityListener.onCreatureSpawn()
*/ */
@Override @Override
@ -246,7 +246,7 @@ public class WarEntityListener extends EntityListener {
/** /**
* Prevents health regaining caused by peaceful mode * Prevents health regaining caused by peaceful mode
* *
* @see EntityListener.onEntityRegainHealth() * @see EntityListener.onEntityRegainHealth()
*/ */
@Override @Override
@ -254,7 +254,7 @@ public class WarEntityListener extends EntityListener {
if (!War.war.isLoaded() || event.getRegainReason() != RegainReason.REGEN) { if (!War.war.isLoaded() || event.getRegainReason() != RegainReason.REGEN) {
return; return;
} }
Entity entity = event.getEntity(); Entity entity = event.getEntity();
if (!(entity instanceof Player)) { if (!(entity instanceof Player)) {
return; return;

View File

@ -37,7 +37,7 @@ public class WarPlayerListener extends PlayerListener {
/** /**
* Correctly removes quitting players from warzones * Correctly removes quitting players from warzones
* *
* @see PlayerListener.onPlayerQuit() * @see PlayerListener.onPlayerQuit()
*/ */
@Override @Override
@ -376,7 +376,9 @@ public class WarPlayerListener extends PlayerListener {
boolean inFlag = (playerTeam.getFlagVolume() != null && playerTeam.getFlagVolume().contains(player.getLocation())); boolean inFlag = (playerTeam.getFlagVolume() != null && playerTeam.getFlagVolume().contains(player.getLocation()));
if (playerWarzone.getFlagReturn() == FlagReturn.BOTH) { if (playerWarzone.getFlagReturn() == FlagReturn.BOTH) {
if (!inSpawn && !inFlag) return; if (!inSpawn && !inFlag) {
return;
}
} else if (playerWarzone.getFlagReturn() == FlagReturn.SPAWN) { } else if (playerWarzone.getFlagReturn() == FlagReturn.SPAWN) {
if (inFlag) { if (inFlag) {
War.war.badMsg(player, "You have to capture the enemy flag at your team's spawn."); War.war.badMsg(player, "You have to capture the enemy flag at your team's spawn.");

View File

@ -11,7 +11,7 @@ import com.tommytony.war.Warzone;
/** /**
* Lists all warzones * Lists all warzones
* *
* @author Tim Düsterhus * @author Tim Düsterhus
*/ */
public class WarzonesCommand extends AbstractWarCommand { public class WarzonesCommand extends AbstractWarCommand {

View File

@ -4,7 +4,7 @@ public enum FlagReturn {
BOTH, BOTH,
FLAG, FLAG,
SPAWN; SPAWN;
@Override @Override
public String toString() { public String toString() {
return super.toString().toLowerCase(); return super.toString().toLowerCase();

View File

@ -8,9 +8,9 @@ import org.bukkit.block.BlockFace;
import com.tommytony.war.volumes.Volume; import com.tommytony.war.volumes.Volume;
/** /**
* *
* @author tommytony * @author tommytony
* *
*/ */
public class Monument { public class Monument {
private Location location; private Location location;

View File

@ -15,9 +15,9 @@ import com.tommytony.war.utils.SignHelper;
import com.tommytony.war.volumes.Volume; import com.tommytony.war.volumes.Volume;
/** /**
* *
* @author tommytony * @author tommytony
* *
*/ */
public class Team { public class Team {
private List<Player> players = new ArrayList<Player>(); private List<Player> players = new ArrayList<Player>();

View File

@ -52,6 +52,7 @@ public enum TeamKind {
return this.material; return this.material;
} }
@Override
public String toString() { public String toString() {
return super.toString().toLowerCase(); return super.toString().toLowerCase();
} }

View File

@ -15,7 +15,7 @@ import com.tommytony.war.volumes.BlockInfo;
import com.tommytony.war.volumes.Volume; import com.tommytony.war.volumes.Volume;
/** /**
* *
* @author tommytony, Tim Düsterhus * @author tommytony, Tim Düsterhus
* @package com.tommytony.war * @package com.tommytony.war
*/ */
@ -192,7 +192,7 @@ public class WarHub {
/** /**
* Resets the sign of the given warzone * Resets the sign of the given warzone
* *
* @param Warzone * @param Warzone
* zone * zone
*/ */

View File

@ -265,9 +265,13 @@ public class Warzone {
// nom drops // nom drops
for(Entity entity : (this.getWorld().getEntities())) { for(Entity entity : (this.getWorld().getEntities())) {
if (!(entity instanceof Item) && !(entity instanceof CraftItem)) continue; if (!(entity instanceof Item) && !(entity instanceof CraftItem)) {
continue;
}
// validate position // validate position
if (!this.getVolume().contains(entity.getLocation())) continue; if (!this.getVolume().contains(entity.getLocation())) {
continue;
}
// omnomnomnom // omnomnomnom
entity.remove(); entity.remove();

View File

@ -18,9 +18,9 @@ import com.tommytony.war.volumes.Volume;
import com.tommytony.war.volumes.ZoneVolume; import com.tommytony.war.volumes.ZoneVolume;
/** /**
* *
* @author tommytony * @author tommytony
* *
*/ */
public class ZoneLobby { public class ZoneLobby {
private final Warzone warzone; private final Warzone warzone;
@ -41,7 +41,7 @@ public class ZoneLobby {
/** /**
* Use this constructor with /setzonelobby <n/s/e/w> * Use this constructor with /setzonelobby <n/s/e/w>
* *
* @param war * @param war
* @param warzone * @param warzone
* @param wall * @param wall
@ -59,7 +59,7 @@ public class ZoneLobby {
/** /**
* Use this constructor with /setzonelobby <zonename>. Makes sure the lobby is not sticking inside the zone. * Use this constructor with /setzonelobby <zonename>. Makes sure the lobby is not sticking inside the zone.
* *
* @param war * @param war
* @param warzone * @param warzone
* @param wall * @param wall
@ -115,7 +115,7 @@ public class ZoneLobby {
/** /**
* Changes the lobby's position. Orientation is determined from the player location. Creates volume or resets. Saves new lobby blocks. * Changes the lobby's position. Orientation is determined from the player location. Creates volume or resets. Saves new lobby blocks.
* *
* @param playerLocation * @param playerLocation
*/ */
public void setLocation(Location playerLocation) { public void setLocation(Location playerLocation) {
@ -174,7 +174,7 @@ public class ZoneLobby {
/** /**
* Classic way of creating a lobby. Lobby position goes to middle of zone wall. Creates volume or resets. Saves new lobby blocks. * Classic way of creating a lobby. Lobby position goes to middle of zone wall. Creates volume or resets. Saves new lobby blocks.
* *
* @param newWall * @param newWall
*/ */
public void setWall(BlockFace newWall) { public void setWall(BlockFace newWall) {

View File

@ -14,9 +14,9 @@ import com.tommytony.war.volumes.BlockInfo;
import bukkit.tommytony.war.War; import bukkit.tommytony.war.War;
/** /**
* *
* @author tommytony * @author tommytony
* *
*/ */
public class ZoneWallGuard { public class ZoneWallGuard {
private Player player; private Player player;

View File

@ -23,7 +23,9 @@ public class HelmetProtectionTask implements Runnable {
* @see Runnable.run() * @see Runnable.run()
*/ */
public void run() { public void run() {
if (!War.war.isLoaded()) return; if (!War.war.isLoaded()) {
return;
}
for (Warzone zone : War.war.getWarzones()) { for (Warzone zone : War.war.getWarzones()) {
for (Team team : zone.getTeams()) { for (Team team : zone.getTeams()) {
for (Player player : team.getPlayers()) { for (Player player : team.getPlayers()) {
@ -33,7 +35,7 @@ public class HelmetProtectionTask implements Runnable {
teamBlockMaterial = team.getKind().getMaterial(); teamBlockMaterial = team.getKind().getMaterial();
// 1) Replace missing block head // 1) Replace missing block head
if (playerInv.getHelmet().getType() != teamBlockMaterial) { if (playerInv.getHelmet().getType() != teamBlockMaterial) {
playerInv.setHelmet(createBlockHead(team)); playerInv.setHelmet(this.createBlockHead(team));
} }
// 2) Get rid of extra blocks in inventory: only keep one // 2) Get rid of extra blocks in inventory: only keep one
HashMap<Integer, ? extends ItemStack> blocks = playerInv.all(teamBlockMaterial); HashMap<Integer, ? extends ItemStack> blocks = playerInv.all(teamBlockMaterial);
@ -48,7 +50,7 @@ public class HelmetProtectionTask implements Runnable {
} }
i++; i++;
} }
playerInv.setItem(playerInv.firstEmpty(), createBlockHead(team)); playerInv.setItem(playerInv.firstEmpty(), this.createBlockHead(team));
if (removed > 1) { if (removed > 1) {
War.war.badMsg(player, "All that " + team.getName() + " wool must have been heavy!"); War.war.badMsg(player, "All that " + team.getName() + " wool must have been heavy!");
} }

View File

@ -20,7 +20,7 @@ public class LoadoutResetJob implements Runnable {
public void run() { public void run() {
this.zone.resetInventory(this.team, this.player); this.zone.resetInventory(this.team, this.player);
// Stop fire here, since doing it in the same tick as death doesn't extinguish it // Stop fire here, since doing it in the same tick as death doesn't extinguish it
player.setFireTicks(0); this.player.setFireTicks(0);
} }
} }

View File

@ -30,9 +30,9 @@ import com.tommytony.war.volumes.ZoneVolume;
/** /**
* The ZoneVolumeMapper take the blocks from disk and sets them in the worlds, since the ZoneVolume doesn't hold its blocks in memory like regular Volumes. * The ZoneVolumeMapper take the blocks from disk and sets them in the worlds, since the ZoneVolume doesn't hold its blocks in memory like regular Volumes.
* *
* @author tommytony * @author tommytony
* *
*/ */
public class PreDeGaulleZoneVolumeMapper { public class PreDeGaulleZoneVolumeMapper {

View File

@ -10,7 +10,7 @@ import java.util.Properties;
/** /**
* Used for accessing and creating .[properties] files, reads them as utf-8, saves as utf-8. Internationalization is key importance especially for character codes. * Used for accessing and creating .[properties] files, reads them as utf-8, saves as utf-8. Internationalization is key importance especially for character codes.
* *
* @author Nijikokun * @author Nijikokun
* @version 1.0.4, %G% * @version 1.0.4, %G%
*/ */
@ -27,7 +27,7 @@ public final class PropertiesFile {
/** /**
* Creates or opens a properties file using specified filename * Creates or opens a properties file using specified filename
* *
* @param fileName * @param fileName
*/ */
public PropertiesFile(String fileName) { public PropertiesFile(String fileName) {
@ -48,7 +48,7 @@ public final class PropertiesFile {
/** /**
* The loader for property files, it reads the file as UTF8 or converts the string into UTF8. Used for simple runthrough's, loading, or reloading of the file. * The loader for property files, it reads the file as UTF8 or converts the string into UTF8. Used for simple runthrough's, loading, or reloading of the file.
* *
* @throws IOException * @throws IOException
*/ */
public void load() throws IOException { public void load() throws IOException {
@ -88,20 +88,20 @@ public final class PropertiesFile {
* Returns a Map of all <code>key=value</code> properties in the file as <code>&lt;key (java.lang.String), value (java.lang.String)></code> <br /> * Returns a Map of all <code>key=value</code> properties in the file as <code>&lt;key (java.lang.String), value (java.lang.String)></code> <br />
* <br /> * <br />
* Example: <blockquote> * Example: <blockquote>
* *
* <pre> * <pre>
* PropertiesFile settings = new PropertiesFile(&quot;settings.properties&quot;); * PropertiesFile settings = new PropertiesFile(&quot;settings.properties&quot;);
* Map&lt;String, String&gt; mappedSettings; * Map&lt;String, String&gt; mappedSettings;
* *
* try { * try {
* mappedSettings = settings.returnMap(); * mappedSettings = settings.returnMap();
* } catch (Exception ex) { * } catch (Exception ex) {
* log.info(&quot;Failed mapping settings.properties&quot;); * log.info(&quot;Failed mapping settings.properties&quot;);
* } * }
* </pre> * </pre>
* *
* </blockquote> * </blockquote>
* *
* @return <code>map</code> - Simple Map HashMap of the entire <code>key=value</code> as <code>&lt;key (java.lang.String), value (java.lang.String)></code> * @return <code>map</code> - Simple Map HashMap of the entire <code>key=value</code> as <code>&lt;key (java.lang.String), value (java.lang.String)></code>
* @throws Exception * @throws Exception
* If the properties file doesn't exist. * If the properties file doesn't exist.
@ -113,7 +113,7 @@ public final class PropertiesFile {
/** /**
* Checks to see if the .[properties] file contains the given <code>key</code>. * Checks to see if the .[properties] file contains the given <code>key</code>.
* *
* @param var * @param var
* The key we are going to be checking the existance of. * The key we are going to be checking the existance of.
* @return <code>Boolean</code> - True if the <code>key</code> exists, false if it cannot be found. * @return <code>Boolean</code> - True if the <code>key</code> exists, false if it cannot be found.
@ -124,7 +124,7 @@ public final class PropertiesFile {
/** /**
* Checks to see if this <code>key</code> exists in the .[properties] file. * Checks to see if this <code>key</code> exists in the .[properties] file.
* *
* @param var * @param var
* The key we are grabbing the value of. * The key we are grabbing the value of.
* @return <code>java.lang.String</code> - True if the <code>key</code> exists, false if it cannot be found. * @return <code>java.lang.String</code> - True if the <code>key</code> exists, false if it cannot be found.
@ -135,7 +135,7 @@ public final class PropertiesFile {
/** /**
* Remove a key from the file if it exists. This will save() which will invoke a load() on the file. * Remove a key from the file if it exists. This will save() which will invoke a load() on the file.
* *
* @see #save() * @see #save()
* @param var * @param var
* The <code>key</code> that will be removed from the file * The <code>key</code> that will be removed from the file
@ -149,7 +149,7 @@ public final class PropertiesFile {
/** /**
* Checks the existance of a <code>key</code>. * Checks the existance of a <code>key</code>.
* *
* @see #containsKey(java.lang.String) * @see #containsKey(java.lang.String)
* @param key * @param key
* The <code>key</code> in question of existance. * The <code>key</code> in question of existance.
@ -161,7 +161,7 @@ public final class PropertiesFile {
/** /**
* Returns the value of the <code>key</code> given as a <code>String</code>, however we do not set a string if no <code>key</code> is found. * Returns the value of the <code>key</code> given as a <code>String</code>, however we do not set a string if no <code>key</code> is found.
* *
* @see #getProperty(java.lang.String) * @see #getProperty(java.lang.String)
* @param key * @param key
* The <code>key</code> we will retrieve the property from, if no <code>key</code> is found default to "" or empty. * The <code>key</code> we will retrieve the property from, if no <code>key</code> is found default to "" or empty.
@ -176,7 +176,7 @@ public final class PropertiesFile {
/** /**
* Returns the value of the <code>key</code> given as a <code>String</code>. If it is not found, it will invoke saving the default <code>value</code> to the properties file. * Returns the value of the <code>key</code> given as a <code>String</code>. If it is not found, it will invoke saving the default <code>value</code> to the properties file.
* *
* @see #setString(java.lang.String, java.lang.String) * @see #setString(java.lang.String, java.lang.String)
* @see #getProperty(java.lang.String) * @see #getProperty(java.lang.String)
* @param key * @param key
@ -196,7 +196,7 @@ public final class PropertiesFile {
/** /**
* Save the value given as a <code>String</code> on the specified key. * Save the value given as a <code>String</code> on the specified key.
* *
* @see #save() * @see #save()
* @param key * @param key
* The <code>key</code> that we will be addressing the <code>value</code> to. * The <code>key</code> that we will be addressing the <code>value</code> to.
@ -210,7 +210,7 @@ public final class PropertiesFile {
/** /**
* Returns the value of the <code>key</code> given in a Integer, however we do not set a string if no <code>key</code> is found. * Returns the value of the <code>key</code> given in a Integer, however we do not set a string if no <code>key</code> is found.
* *
* @see #getProperty(String var) * @see #getProperty(String var)
* @param key * @param key
* The <code>key</code> we will retrieve the property from, if no <code>key</code> is found default to 0 * The <code>key</code> we will retrieve the property from, if no <code>key</code> is found default to 0
@ -225,7 +225,7 @@ public final class PropertiesFile {
/** /**
* Returns the int value of a key * Returns the int value of a key
* *
* @see #setInt(String key, int value) * @see #setInt(String key, int value)
* @param key * @param key
* The key that we will be grabbing the value from, if no value is found set and return <code>value</code> * The key that we will be grabbing the value from, if no value is found set and return <code>value</code>
@ -245,7 +245,7 @@ public final class PropertiesFile {
/** /**
* Save the value given as a <code>int</code> on the specified key. * Save the value given as a <code>int</code> on the specified key.
* *
* @see #save() * @see #save()
* @param key * @param key
* The <code>key</code> that we will be addressing the <code>value</code> to. * The <code>key</code> that we will be addressing the <code>value</code> to.
@ -260,7 +260,7 @@ public final class PropertiesFile {
/** /**
* Returns the value of the <code>key</code> given in a Double, however we do not set a string if no <code>key</code> is found. * Returns the value of the <code>key</code> given in a Double, however we do not set a string if no <code>key</code> is found.
* *
* @see #getProperty(String var) * @see #getProperty(String var)
* @param key * @param key
* The <code>key</code> we will retrieve the property from, if no <code>key</code> is found default to 0.0 * The <code>key</code> we will retrieve the property from, if no <code>key</code> is found default to 0.0
@ -275,7 +275,7 @@ public final class PropertiesFile {
/** /**
* Returns the double value of a key * Returns the double value of a key
* *
* @see #setDouble(String key, double value) * @see #setDouble(String key, double value)
* @param key * @param key
* The key that we will be grabbing the value from, if no value is found set and return <code>value</code> * The key that we will be grabbing the value from, if no value is found set and return <code>value</code>
@ -294,7 +294,7 @@ public final class PropertiesFile {
/** /**
* Save the value given as a <code>double</code> on the specified key. * Save the value given as a <code>double</code> on the specified key.
* *
* @see #save() * @see #save()
* @param key * @param key
* The <code>key</code> that we will be addressing the <code>value</code> to. * The <code>key</code> that we will be addressing the <code>value</code> to.
@ -309,7 +309,7 @@ public final class PropertiesFile {
/** /**
* Returns the value of the <code>key</code> given in a Long, however we do not set a string if no <code>key</code> is found. * Returns the value of the <code>key</code> given in a Long, however we do not set a string if no <code>key</code> is found.
* *
* @see #getProperty(String var) * @see #getProperty(String var)
* @param key * @param key
* The <code>key</code> we will retrieve the property from, if no <code>key</code> is found default to 0L * The <code>key</code> we will retrieve the property from, if no <code>key</code> is found default to 0L
@ -324,7 +324,7 @@ public final class PropertiesFile {
/** /**
* Returns the long value of a key * Returns the long value of a key
* *
* @see #setLong(String key, long value) * @see #setLong(String key, long value)
* @param key * @param key
* The key that we will be grabbing the value from, if no value is found set and return <code>value</code> * The key that we will be grabbing the value from, if no value is found set and return <code>value</code>
@ -343,7 +343,7 @@ public final class PropertiesFile {
/** /**
* Save the value given as a <code>long</code> on the specified key. * Save the value given as a <code>long</code> on the specified key.
* *
* @see #save() * @see #save()
* @param key * @param key
* The <code>key</code> that we will be addressing the <code>value</code> to. * The <code>key</code> that we will be addressing the <code>value</code> to.
@ -358,7 +358,7 @@ public final class PropertiesFile {
/** /**
* Returns the value of the <code>key</code> given in a Boolean, however we do not set a string if no <code>key</code> is found. * Returns the value of the <code>key</code> given in a Boolean, however we do not set a string if no <code>key</code> is found.
* *
* @see #getProperty(String var) * @see #getProperty(String var)
* @param key * @param key
* The <code>key</code> we will retrieve the property from, if no <code>key</code> is found default to false * The <code>key</code> we will retrieve the property from, if no <code>key</code> is found default to false
@ -373,7 +373,7 @@ public final class PropertiesFile {
/** /**
* Returns the boolean value of a key * Returns the boolean value of a key
* *
* @see #setBoolean(String key, boolean value) * @see #setBoolean(String key, boolean value)
* @param key * @param key
* The key that we will be grabbing the value from, if no value is found set and return <code>value</code> * The key that we will be grabbing the value from, if no value is found set and return <code>value</code>
@ -392,7 +392,7 @@ public final class PropertiesFile {
/** /**
* Save the value given as a <code>boolean</code> on the specified key. * Save the value given as a <code>boolean</code> on the specified key.
* *
* @see #save() * @see #save()
* @param key * @param key
* The <code>key</code> that we will be addressing the <code>value</code> to. * The <code>key</code> that we will be addressing the <code>value</code> to.

View File

@ -20,9 +20,9 @@ import bukkit.tommytony.war.War;
import com.tommytony.war.volumes.Volume; import com.tommytony.war.volumes.Volume;
/** /**
* *
* @author tommytony * @author tommytony
* *
*/ */
public class VolumeMapper { public class VolumeMapper {

View File

@ -17,9 +17,9 @@ import com.tommytony.war.jobs.RestoreWarhubJob;
import com.tommytony.war.jobs.RestoreWarzonesJob; import com.tommytony.war.jobs.RestoreWarzonesJob;
/** /**
* *
* @author tommytony * @author tommytony
* *
*/ */
public class WarMapper { public class WarMapper {
@ -239,7 +239,7 @@ public class WarMapper {
// spawnStyle // spawnStyle
warConfig.setString("flagReturn", War.war.getDefaultFlagReturn().toString()); warConfig.setString("flagReturn", War.war.getDefaultFlagReturn().toString());
// defaultReward // defaultReward
String defaultRewardStr = ""; String defaultRewardStr = "";
HashMap<Integer, ItemStack> rewardItems = War.war.getDefaultReward(); HashMap<Integer, ItemStack> rewardItems = War.war.getDefaultReward();

View File

@ -24,9 +24,9 @@ import com.tommytony.war.volumes.Volume;
import com.tommytony.war.volumes.ZoneVolume; import com.tommytony.war.volumes.ZoneVolume;
/** /**
* *
* @author tommytony * @author tommytony
* *
*/ */
public class WarzoneMapper { public class WarzoneMapper {
@ -370,7 +370,7 @@ public class WarzoneMapper {
// spawnStyle // spawnStyle
warzoneConfig.setString("spawnStyle", warzone.getSpawnStyle().toString()); warzoneConfig.setString("spawnStyle", warzone.getSpawnStyle().toString());
// flagReturn // flagReturn
warzoneConfig.setString("flagReturn", warzone.getFlagReturn().toString()); warzoneConfig.setString("flagReturn", warzone.getFlagReturn().toString());

View File

@ -34,7 +34,7 @@ import com.tommytony.war.volumes.ZoneVolume;
/** /**
* The ZoneVolumeMapper take the blocks from disk and sets them in the worlds, since the ZoneVolume doesn't hold its blocks in memory like regular Volumes. * The ZoneVolumeMapper take the blocks from disk and sets them in the worlds, since the ZoneVolume doesn't hold its blocks in memory like regular Volumes.
* *
* @author tommytony, Tim Düsterhus * @author tommytony, Tim Düsterhus
* @package com.tommytony.war.mappers * @package com.tommytony.war.mappers
*/ */
@ -42,7 +42,7 @@ public class ZoneVolumeMapper {
/** /**
* Loads the given volume * Loads the given volume
* *
* @param ZoneVolume * @param ZoneVolume
* volume Volume to load * volume Volume to load
* @param String * @param String
@ -277,7 +277,7 @@ public class ZoneVolumeMapper {
/** /**
* Parses an inventory string * Parses an inventory string
* *
* @param String * @param String
* invString string to parse * invString string to parse
* @return List<ItemStack> Parsed items * @return List<ItemStack> Parsed items
@ -309,7 +309,7 @@ public class ZoneVolumeMapper {
/** /**
* Saves the given volume * Saves the given volume
* *
* @param Volume * @param Volume
* volume Volume to save * volume Volume to save
* @param String * @param String
@ -478,7 +478,7 @@ public class ZoneVolumeMapper {
/** /**
* Saves the Volume as a background-job * Saves the Volume as a background-job
* *
* @param ZoneVolme * @param ZoneVolme
* volume volume to save * volume volume to save
* @param String * @param String
@ -494,7 +494,7 @@ public class ZoneVolumeMapper {
/** /**
* Deletes the given volume * Deletes the given volume
* *
* @param Volume * @param Volume
* volume volume to delete * volume volume to delete
* @param War * @param War
@ -510,7 +510,7 @@ public class ZoneVolumeMapper {
/** /**
* Deletes a volume file * Deletes a volume file
* *
* @param String * @param String
* path path of file * path path of file
* @param War * @param War

View File

@ -6,15 +6,15 @@ import org.bukkit.command.CommandSender;
/** /**
* The purpose of this tool is twofold: 1: Avoid client crashes due to bad color formating. 2: Make color continue on word wrapping * The purpose of this tool is twofold: 1: Avoid client crashes due to bad color formating. 2: Make color continue on word wrapping
* *
* In minecraft the degree sign is used as a prefix to another char to create a color. For example the code for white is "\u00A7f". The "\u00A7" is the unicode notation for the degree sign and the "f" means white. * In minecraft the degree sign is used as a prefix to another char to create a color. For example the code for white is "\u00A7f". The "\u00A7" is the unicode notation for the degree sign and the "f" means white.
* *
* When does minecraft wrap the text? After how many chars? Answer: Because the font isn't monospace this differs depending on what you write. However we can fit 53 "M" without wrapping and the 54th char would then wrap (be at the beginning of the next line instead) As there is no broader char than "M" we can know for sure the minimum line length is 53. Note that this means the number of DISPLAYED chars per row is 53. A degree sign and the char after will NOT count, as they will not be displayed as chars. * When does minecraft wrap the text? After how many chars? Answer: Because the font isn't monospace this differs depending on what you write. However we can fit 53 "M" without wrapping and the 54th char would then wrap (be at the beginning of the next line instead) As there is no broader char than "M" we can know for sure the minimum line length is 53. Note that this means the number of DISPLAYED chars per row is 53. A degree sign and the char after will NOT count, as they will not be displayed as chars.
* *
* Good to know: Numbers have the same font width as an M. * Good to know: Numbers have the same font width as an M.
* *
* When does the client crash? Answer: When a row ends with a degree char and optionally another sign after. Another way to say the same: When a line ends with either a broken or valid color notation. AND The client will ALWAYS crash if the sign after the last displayed char in a row is a degree char. A goofy way to explatin it: For a line with only "M" and numbers, the fiftyfourth "displayed char" musn't be a degree sign. * When does the client crash? Answer: When a row ends with a degree char and optionally another sign after. Another way to say the same: When a line ends with either a broken or valid color notation. AND The client will ALWAYS crash if the sign after the last displayed char in a row is a degree char. A goofy way to explatin it: For a line with only "M" and numbers, the fiftyfourth "displayed char" musn't be a degree sign.
* *
* WARNING: Above is a hypothesis I have created based on what my experiments have shown. I am fairly sure it is correct but please help me test it further. * WARNING: Above is a hypothesis I have created based on what my experiments have shown. I am fairly sure it is correct but please help me test it further.
*/ */
public class ChatFixUtil { public class ChatFixUtil {
@ -23,13 +23,13 @@ public class ChatFixUtil {
/** /**
* This method wraps the msg for you at row lengths of 53, avoids client crash scenarios and makes the previous color continue on the next line. * This method wraps the msg for you at row lengths of 53, avoids client crash scenarios and makes the previous color continue on the next line.
* *
* The upsides with filtering your messages through this method are: - No client crashes. - Line wrapping with preserved color. * The upsides with filtering your messages through this method are: - No client crashes. - Line wrapping with preserved color.
* *
* The downsides are: - The width of the chat window will not be used to it's fullest. For example you can fit more that 53 commas (,) in a chatwindow row but the line would break after 53 displayed chars. * The downsides are: - The width of the chat window will not be used to it's fullest. For example you can fit more that 53 commas (,) in a chatwindow row but the line would break after 53 displayed chars.
* *
* Suggested usage: NO NEED TO USE the fix method for static help pages in your plugin. As the text is static you can make sure there is no client crash yourself and be able to use the full line length. * Suggested usage: NO NEED TO USE the fix method for static help pages in your plugin. As the text is static you can make sure there is no client crash yourself and be able to use the full line length.
* *
* DO USE in cases like where you output colored messages with playernames in your plugin. As the player names have different length there is potential for client crash. * DO USE in cases like where you output colored messages with playernames in your plugin. As the player names have different length there is potential for client crash.
*/ */
public static ArrayList<String> fix(String msg) { public static ArrayList<String> fix(String msg) {

View File

@ -5,9 +5,9 @@ import org.bukkit.World;
import org.bukkit.block.Block; import org.bukkit.block.Block;
/** /**
* *
* @author tommytony * @author tommytony
* *
*/ */
public class BlockInfo { public class BlockInfo {
private int x; private int x;

View File

@ -5,7 +5,7 @@ import org.bukkit.World;
import org.bukkit.block.Block; import org.bukkit.block.Block;
/** /**
* *
* @author tommytony * @author tommytony
* @deprecated Broken, don't use. * @deprecated Broken, don't use.
*/ */

View File

@ -10,9 +10,9 @@ import org.bukkit.block.BlockFace;
import bukkit.tommytony.war.War; import bukkit.tommytony.war.War;
/** /**
* *
* @author tommytony * @author tommytony
* *
*/ */
@Deprecated @Deprecated
public class VerticalVolume extends Volume { public class VerticalVolume extends Volume {

View File

@ -22,9 +22,9 @@ import bukkit.tommytony.war.War;
import com.tommytony.war.jobs.BlockResetJob; import com.tommytony.war.jobs.BlockResetJob;
/** /**
* *
* @author tommytony * @author tommytony
* *
*/ */
public class Volume { public class Volume {
private final String name; private final String name;

View File

@ -11,9 +11,9 @@ import com.tommytony.war.Warzone;
import com.tommytony.war.mappers.ZoneVolumeMapper; import com.tommytony.war.mappers.ZoneVolumeMapper;
/** /**
* *
* @author tommytony * @author tommytony
* *
*/ */
public class ZoneVolume extends Volume { public class ZoneVolume extends Volume {