Code comments

This commit is contained in:
KHobbits 2012-10-06 03:31:34 +01:00
parent aa7a39d0b0
commit 7a410919a0
11 changed files with 15 additions and 6 deletions

View File

@ -27,6 +27,7 @@ public class EssentialsEntityListener implements Listener
this.ess = ess; this.ess = ess;
} }
// This method does something undocumented reguarding certain bucket types #EasterEgg
@EventHandler(priority = EventPriority.LOW) @EventHandler(priority = EventPriority.LOW)
public void onEntityDamage(final EntityDamageByEntityEvent event) public void onEntityDamage(final EntityDamageByEntityEvent event)
{ {

View File

@ -414,6 +414,7 @@ public class EssentialsPlayerListener implements Listener
} }
} }
// This method allows the /jump lock feature to work, allows teleporting while flying #EasterEgg
private void useFlyClickJump(final User user) private void useFlyClickJump(final User user)
{ {
try try

View File

@ -928,6 +928,8 @@ public class Settings implements ISettings
return maxSpeed > 1.0 ? 1.0 : Math.abs(maxSpeed); return maxSpeed > 1.0 ? 1.0 : Math.abs(maxSpeed);
} }
//This option does not exist in the config.yml because it wasn't yet implemented in bukkit
//The code was commented out in the /speed command
@Override @Override
public double getMaxWalkSpeed() public double getMaxWalkSpeed()
{ {

View File

@ -234,6 +234,9 @@ public class Trade
public static void log(String type, String subtype, String event, String sender, Trade charge, String receiver, Trade pay, Location loc, IEssentials ess) public static void log(String type, String subtype, String event, String sender, Trade charge, String receiver, Trade pay, Location loc, IEssentials ess)
{ {
//isEcoLogUpdateEnabled() - This refers to log entries with no location, ie API updates #EasterEgg
//isEcoLogEnabled() - This refers to log entries with with location, ie /pay /sell and eco signs.
if ((loc == null && !ess.getSettings().isEcoLogUpdateEnabled()) if ((loc == null && !ess.getSettings().isEcoLogUpdateEnabled())
|| (loc != null && !ess.getSettings().isEcoLogEnabled())) || (loc != null && !ess.getSettings().isEcoLogEnabled()))
{ {

View File

@ -306,6 +306,7 @@ public class User extends UserData implements Comparable<User>, IReplyTo, IUser
if (ess.getSettings().addPrefixSuffix()) if (ess.getSettings().addPrefixSuffix())
{ {
//These two extra toggles are not documented, because they are mostly redundant #EasterEgg
if (!ess.getSettings().disablePrefix()) if (!ess.getSettings().disablePrefix())
{ {
final String ptext = ess.getPermissionsHandler().getPrefix(base).replace('&', '§'); final String ptext = ess.getPermissionsHandler().getPrefix(base).replace('&', '§');

View File

@ -6,7 +6,7 @@ import org.bukkit.Location;
import org.bukkit.Server; import org.bukkit.Server;
import org.bukkit.entity.TNTPrimed; import org.bukkit.entity.TNTPrimed;
// This command has a in theme message that only shows if you supply a parameter #EasterEgg
public class Commandantioch extends EssentialsCommand public class Commandantioch extends EssentialsCommand
{ {
public Commandantioch() public Commandantioch()

View File

@ -14,7 +14,7 @@ import org.bukkit.command.CommandSender;
import org.bukkit.command.ConsoleCommandSender; import org.bukkit.command.ConsoleCommandSender;
import org.bukkit.entity.Player; import org.bukkit.entity.Player;
// This command has 4 undocumented behaviours #EasterEgg
public class Commandessentials extends EssentialsCommand public class Commandessentials extends EssentialsCommand
{ {
public Commandessentials() public Commandessentials()
@ -55,6 +55,7 @@ public class Commandessentials extends EssentialsCommand
} }
} }
//If you do not supply an argument this command will list 'overridden' commands.
private void run_disabled(final Server server, final CommandSender sender, final String commandLabel, final String[] args) throws Exception private void run_disabled(final Server server, final CommandSender sender, final String commandLabel, final String[] args) throws Exception
{ {
sender.sendMessage("Essentials " + ess.getDescription().getVersion()); sender.sendMessage("Essentials " + ess.getDescription().getVersion());

View File

@ -8,7 +8,7 @@ import org.bukkit.Location;
import org.bukkit.Server; import org.bukkit.Server;
import org.bukkit.event.player.PlayerTeleportEvent.TeleportCause; import org.bukkit.event.player.PlayerTeleportEvent.TeleportCause;
// This method contains an undocumented sub command #EasterEgg
public class Commandjump extends EssentialsCommand public class Commandjump extends EssentialsCommand
{ {
public Commandjump() public Commandjump()

View File

@ -7,7 +7,7 @@ import org.bukkit.Location;
import org.bukkit.Server; import org.bukkit.Server;
import org.bukkit.entity.Ocelot; import org.bukkit.entity.Ocelot;
// This command is not documented on the wiki #EasterEgg
public class Commandkittycannon extends EssentialsCommand public class Commandkittycannon extends EssentialsCommand
{ {
private static Random random = new Random(); private static Random random = new Random();

View File

@ -5,7 +5,7 @@ import com.earth2me.essentials.Util;
import org.bukkit.Server; import org.bukkit.Server;
import org.bukkit.command.CommandSender; import org.bukkit.command.CommandSender;
// This command can be used to echo messages to the users screen, mostly useless but also an #EasterEgg
public class Commandping extends EssentialsCommand public class Commandping extends EssentialsCommand
{ {
public Commandping() public Commandping()

View File

@ -10,7 +10,7 @@ import org.bukkit.block.BlockFace;
import org.bukkit.block.Sign; import org.bukkit.block.Sign;
import org.bukkit.inventory.ItemStack; import org.bukkit.inventory.ItemStack;
@Deprecated // This sign will be removed soon
public class SignProtection extends EssentialsSign public class SignProtection extends EssentialsSign
{ {
private final transient Set<Material> protectedBlocks = EnumSet.noneOf(Material.class); private final transient Set<Material> protectedBlocks = EnumSet.noneOf(Material.class);