Miscellaneous cleanup and commenting

2018-06-24 16:08:28 +01:00
parent 76473f7185
commit 55ae4b1161
13 changed files with 35 additions and 14 deletions
@@ -72,7 +72,8 @@ public final class ParticleBuilder {
 		/** Single pixel particle.<p><b>Defaults:</b><p>Lifetime: 16-80 ticks<br>Colour: white */ 			DUST,
 		/** Rapid flash, like fireworks.<p><b>Defaults:</b><p>Lifetime: 4 ticks<br>Colour: white */ 		FLASH,
 		/** Small shard of ice.<p><b>Defaults:</b><p>Lifetime: 8-40 ticks<br>Gravity: true */ 				ICE,
-		/** Single green/brown leaf.<p><b>Defaults:</b><p>Lifetime: 10-15 ticks<br>Velocity: (0, -0.03, 0) */ LEAF,
+		/** Single leaf.<p><b>Defaults:</b><p>Lifetime: 10-15 ticks<br>Velocity: (0, -0.03, 0)
+		 * <br>Colour: green/brown */ 																		LEAF,
 		/** Bubble that doesn't burst in air.<p><b>Defaults:</b><p>Lifetime: 8-40 ticks	*/					MAGIC_BUBBLE,
 		/** Scaleable, moving flame.<p><b>Defaults:</b><p>Lifetime: 8-40 ticks<br> */ 						MAGIC_FIRE,
 		/** Soft-edged round particle.<p><b>Defaults:</b><p>Lifetime: 8-40 ticks<br>Colour: white */ 		PATH,
@@ -260,7 +260,8 @@ public final class WandHelper {

 	/**
 	 * Applies the given upgrade to the given wand, or in other words increases the level for that upgrade by 1. This
-	 * does <b>not</b> account for the individual or total upgrade stack limits.
+	 * does <b>not</b> account for the individual or total upgrade stack limits or any special behaviour; it only deals
+	 * with the NBT data.
 	 */
 	public static void applyUpgrade(ItemStack wand, Item upgrade){

@@ -545,6 +545,7 @@ public final class WizardryUtilities {
 	 * private. (You <i>could</i> call {@link EntityCreeper#onStruckByLightning(...)} and then heal it and extinguish
 	 * it, but that's a bit awkward.)
 	 */
+	// The reflection here only gets done once to initialise the POWERED field, so it's not a performance issue at all.
 	public static void chargeCreeper(EntityCreeper creeper){
 		creeper.getDataManager().set(POWERED, true);
 	}