Initial 1.11.2 update

src/main/java/electroblob/wizardry/entity/living/ISpellCaster.java

@@ -8,10 +8,11 @@ import electroblob.wizardry.registry.Spells;
 import electroblob.wizardry.spell.Spell;
 import electroblob.wizardry.util.SpellModifiers;
 
-/** Interface for entities that can cast spells. Mainly intended for use by wizard-type entities, but can be
- * implemented by any subclass of EntityLiving. Designed to be as flexible as possible - ranging from the simplest
- * use of giving an entity a specific spell as an attack, to a complex AI which selects different spell types
- * depending on the situation. The only restriction is that the spells must be castable by NPCs.
+/**
+ * Interface for entities that can cast spells. Mainly intended for use by wizard-type entities, but can be implemented
+ * by any subclass of EntityLiving. Designed to be as flexible as possible - ranging from the simplest use of giving an
+ * entity a specific spell as an attack, to a complex AI which selects different spell types depending on the situation.
+ * The only restriction is that the spells must be castable by NPCs.
  * <p>
  * This is intended for entities that use {@link EntityAIAttackSpell}. If so, all the spell casting code (including
  * packets) is handled by that class, and all the implementor needs to do is decide which spell(s) to select.
@@ -20,42 +21,48 @@ import electroblob.wizardry.util.SpellModifiers;
  * needs to do is store the actual fields involved.
  */
 /* Perhaps this should be a capability? Though I can't help thinking they're mainly for attaching data to vanilla
- * classes, rather than custom ones. For now, the main purpose of this is to centralise code within wizardry itself,
- * and I may as well make it an API feature - but I'm not writing a capability unless someone sees a reason to attach
- * it to a class they don't own, and I don't see that happening anytime soon. */
+ * classes, rather than custom ones. For now, the main purpose of this is to centralise code within wizardry itself, and
+ * I may as well make it an API feature - but I'm not writing a capability unless someone sees a reason to attach it to
+ * a class they don't own, and I don't see that happening anytime soon. */
 // For even more fun, combine this with an ISummonedCreature and have skeletons that can cast spells!
 public interface ISpellCaster {
 
 	/**
-	 * Called each time the entity attacks to get the spells that can be cast. For simple implementations, just
-	 * return a list of size one containing the spell that the entity uses as an attack, perhaps performing some
-	 * simple logic within this method. For more intelligent implementations based on spell types, consider using
+	 * Called each time the entity attacks to get the spells that can be cast. For simple implementations, just return a
+	 * list of size one containing the spell that the entity uses as an attack, perhaps performing some simple logic
+	 * within this method. For more intelligent implementations based on spell types, consider using
 	 * {@link IIntelligentSpellCaster} instead.
+	 * 
 	 * @return A list of {@link Spell} instances. A random spell from this list will be cast when the entity attacks.
-	 * The list will not be modified by the AI class and can therefore be an immutable list. The spells in the list
-	 * <b>must</b> be castable by NPCs (i.e. {@link Spell#canBeCastByNPCs()} returns true).
+	 *         The list will not be modified by the AI class and can therefore be an immutable list. The spells in the
+	 *         list <b>must</b> be castable by NPCs (i.e. {@link Spell#canBeCastByNPCs()} returns true).
 	 */
 	@Nonnull
 	public List<Spell> getSpells();
-	
+
 	/**
 	 * Called each time the entity attacks to get the modifiers to apply to the spell.
-	 * @return A {@link SpellModifiers} object representing the modifiers to apply to the spell. If no modifiers are required,
-	 * pass in an empty {@code SpellModifiers} object.
+	 * 
+	 * @return A {@link SpellModifiers} object representing the modifiers to apply to the spell. If no modifiers are
+	 *         required, pass in an empty {@code SpellModifiers} object.
 	 */
 	@Nonnull
 	public SpellModifiers getModifiers();
-	
-	/** Returns the continuous spell that is currently being cast, or the None spell if there is none. Implementors should simply
-	 * store this as a private field and return it here. Will be synced by the AI class, but whether it is saved to NBT
-	 * is up to you. If the implementing class does not deal with continuous spells, just return {@link Spells#none}. If the
-	 * implementing class only ever uses one continuous spell, do <b>not</b> just return that spell; the field must still
-	 * be stored. */
+
+	/**
+	 * Returns the continuous spell that is currently being cast, or the None spell if there is none. Implementors
+	 * should simply store this as a private field and return it here. Will be synced by the AI class, but whether it is
+	 * saved to NBT is up to you. If the implementing class does not deal with continuous spells, just return
+	 * {@link Spells#none}. If the implementing class only ever uses one continuous spell, do <b>not</b> just return
+	 * that spell; the field must still be stored.
+	 */
 	@Nonnull
 	public Spell getContinuousSpell();
-	
-	/** Sets the continuous spell that is currently being cast, or the None spell if there is none. Implementors should simply
-	 * store this as a private field and assign it here. Will be synced by the AI class, but whether it is saved to NBT
-	 * is up to you. If the implementing class does not deal with continuous spells, leave this method blank. */
+
+	/**
+	 * Sets the continuous spell that is currently being cast, or the None spell if there is none. Implementors should
+	 * simply store this as a private field and assign it here. Will be synced by the AI class, but whether it is saved
+	 * to NBT is up to you. If the implementing class does not deal with continuous spells, leave this method blank.
+	 */
 	public void setContinuousSpell(Spell spell);
 }