Refactor variable construction to have a dedicated class handle selecting which type based upon the type parameter in the config.

Provide a method that can be overridden by variable classes to load additional data from the config.

Added a new option to passive spells called require-cancelled-event which defaults to false. When set to true, the spell will not cast if the event is not cancelled.

Corrected the handling of triggers which care about the state of an event being cancelled.

WARNING: this may break spells which depended upon previously flawed behavior.

Added a new variable type which may be referenced by specifying the config field, type, to distancetolocation
There are additional configuration fields to specify for this variable type.
There is a field called target-location which accepts a string in the format of world,x,y,z and defaults to world,0,0,0.
There is a field called cross-world which accepts a boolean and defaults to false. When set to true, distance will still be reported instead of returning the default value.
There is a field called cross-world-distance-multiplier which accepts a double and defaults to 1.0. When a distance is being reported that is actually between multiple worlds, the coordinate difference will be multiplied by this value.

Just a side note that this variable cannot be manually modified nor will its values be saved (it can't be set as a permanent variable).

Added a variant of the distancetolocation variable type referencable as squareddistancetolocation. Instead of calculating the distance between the locations, it just gives you the squared distance. Use this instead of the distancetolocation type whenever possible as it is much faster and avoids using the square root function (a very intensive function).

Explicitly cast null in some places in the memory addon to avoid overloaded method ambiguity.

Giving the cripple spell a little attention. Added new options to it.

use-slowness-effect accepts a boolean and defaults to true. When set to false, the cripple spell will no longer apply a slowness effect to the target.

apply-portal-cooldown accepts a boolean and defaults to false. When set to true, this spell will set the portal cooldown field of the target, if the duration of the new cooldown is longer than the existing cooldown.

portal-cooldown-ticks accepts an integer and defaults to 100. This number will be used as the target's new portal cooldown, if it is greater than the target's current portal cooldown (and if apply-portal-cooldown is set to true).

STRING VARIABLES
That's right, String variables are finally coming to MagicSpells.
To use them, start by setting type to playerstring
To set your default string value, just use the field default-value

Note: it is highly recommended to back up your variable data before loading this. This update contains significant changes and new concepts. I don't expect it to be problematic, but the nature of the changes warrants some extra caution. That said, enjoy.

Author: TheComputerGeek2

src/com/nisovin/magicspells/MagicSpells.java

@@ -938,7 +938,7 @@ public static String doSubjectVariableReplacements(Player player, String string)
 			while (matcher.find()) {
 				String varText = matcher.group();
 				String[] varData = varText.substring(5, varText.length() - 1).split(":");
-				double val = plugin.variableManager.getValue(varData[0], player);
+				String val = plugin.variableManager.getStringValue(varData[0], player);
 				String sval = varData.length == 1 ? Util.getStringNumber(val, -1) : Util.getStringNumber(val, Integer.parseInt(varData[1]));
 				string = string.replace(varText, sval);
 			}
@@ -956,7 +956,7 @@ public static String doVariableReplacements(Player player, String string) {
 				String varText = matcher.group();
 				String[] varData = varText.substring(11, varText.length() - 1).split(":");
 				String variableOwnerName = varData[0];
-				double val = plugin.variableManager.getValue(varData[1], variableOwnerName);
+				String val = plugin.variableManager.getStringValue(varData[1], variableOwnerName);
 				String sval = varData.length == 2 ? Util.getStringNumber(val, -1) : Util.getStringNumber(val, Integer.parseInt(varData[2]));
 				string = string.replace(varText, sval);
 			}

src/com/nisovin/magicspells/spells/PassiveSpell.java

@@ -52,6 +52,9 @@ public class PassiveSpell extends Spell {
 	@ConfigData(field="ignore-cancelled", dataType="boolean", defaultValue="true", description="Don't cast if the event has been canceled")
 	private boolean ignoreCancelled;
 
+	@ConfigData(field="require-cancelled-event", dataType="boolean", defaultValue="false", description="Don't cast if the event hasn't been cancelled.")
+	private boolean requireCancelledEvent;
+	
 	@ConfigData(field="send-failure-messages", dataType="boolean", defaultValue="false")
 	private boolean sendFailureMessages;
 
@@ -72,6 +75,7 @@ public PassiveSpell(MagicConfig config, String spellName) {
 		cancelDefaultAction = getConfigBoolean("cancel-default-action", false);
 		cancelDefaultActionWhenCastFails = getConfigBoolean("cancel-default-action-when-cast-fails", false);
 		ignoreCancelled = getConfigBoolean("ignore-cancelled", true);
+		requireCancelledEvent = getConfigBoolean("require-cancelled-event", false);
 		sendFailureMessages = getConfigBoolean("send-failure-messages", false);
 
 		spellNames = getConfigStringList("spells", null);
@@ -305,6 +309,10 @@ public boolean ignoreCancelled() {
 		return ignoreCancelled;
 	}
 
+	public boolean requireCancelledEvent() {
+		return requireCancelledEvent;
+	}
+	
 	@Override
 	public boolean canBind(CastItem item) {
 		return false;

src/com/nisovin/magicspells/spells/TargetedSpell.java

@@ -83,7 +83,7 @@ private String prepareMessage(String message, Player caster, String targetName,
 				while (matcher.find()) {
 					String varText = matcher.group();
 					String[] varData = varText.substring(5, varText.length() - 1).split(":");
-					double val = MagicSpells.getVariableManager().getValue(varData[0], playerTarget);
+					String val = MagicSpells.getVariableManager().getStringValue(varData[0], playerTarget);
 					String sval = varData.length == 1 ? Util.getStringNumber(val, -1) : Util.getStringNumber(val, Integer.parseInt(varData[1]));
 					message = message.replace(varText, sval);
 				}
@@ -93,7 +93,7 @@ private String prepareMessage(String message, Player caster, String targetName,
 				while (matcher.find()) {
 					String varText = matcher.group();
 					String[] varData = varText.substring(5, varText.length() - 1).split(":");
-					double val = MagicSpells.getVariableManager().getValue(varData[0], caster);
+					String val = MagicSpells.getVariableManager().getStringValue(varData[0], caster);
 					String sval = varData.length == 1 ? Util.getStringNumber(val, -1) : Util.getStringNumber(val, Integer.parseInt(varData[1]));
 					message = message.replace(varText, sval); //TODO make an alternative to overriding the parameter
 				}

src/com/nisovin/magicspells/spells/passive/BlockBreakListener.java

@@ -54,6 +54,7 @@ public void onBlockBreak(BlockBreakEvent event) {
 		Spellbook spellbook = MagicSpells.getSpellbook(event.getPlayer());
 		if (allTypes.size() > 0) {
 			for (PassiveSpell spell : allTypes) {
+				if (!isCancelStateOk(spell, event.isCancelled())) continue;
 				if (spellbook.hasSpell(spell, false)) {
 					boolean casted = spell.activate(event.getPlayer(), event.getBlock().getLocation().add(0.5, 0.5, 0.5));
 					if (PassiveListener.cancelDefaultAction(spell, casted)) {
@@ -66,6 +67,7 @@ public void onBlockBreak(BlockBreakEvent event) {
 			List<PassiveSpell> list = getSpells(event.getBlock());
 			if (list != null) {
 				for (PassiveSpell spell : list) {
+					if (!isCancelStateOk(spell, event.isCancelled())) continue;
 					if (spellbook.hasSpell(spell, false)) {
 						boolean casted = spell.activate(event.getPlayer(), event.getBlock().getLocation().add(0.5, 0.5, 0.5));
 						if (PassiveListener.cancelDefaultAction(spell, casted)) {

src/com/nisovin/magicspells/spells/passive/BlockPlaceListener.java

@@ -54,6 +54,7 @@ public void onBlockPlace(BlockPlaceEvent event) {
 		Spellbook spellbook = MagicSpells.getSpellbook(event.getPlayer());
 		if (allTypes.size() > 0) {
 			for (PassiveSpell spell : allTypes) {
+				if (!isCancelStateOk(spell, event.isCancelled())) continue;
 				if (spellbook.hasSpell(spell, false)) {
 					boolean casted = spell.activate(event.getPlayer(), event.getBlock().getLocation().add(0.5, 0.5, 0.5));
 					if (PassiveListener.cancelDefaultAction(spell, casted)) {
@@ -66,6 +67,7 @@ public void onBlockPlace(BlockPlaceEvent event) {
 			List<PassiveSpell> list = getSpells(event.getBlock());
 			if (list != null) {
 				for (PassiveSpell spell : list) {
+					if (!isCancelStateOk(spell, event.isCancelled())) continue;
 					if (spellbook.hasSpell(spell, false)) {
 						boolean casted = spell.activate(event.getPlayer(), event.getBlock().getLocation().add(0.5, 0.5, 0.5));
 						if (PassiveListener.cancelDefaultAction(spell, casted)) {

src/com/nisovin/magicspells/spells/passive/CraftListener.java

@@ -67,12 +67,11 @@ public void onCraft(CraftItemEvent event) {
 		if (allTypes.size() > 0) {
 			Spellbook spellbook = MagicSpells.getSpellbook(player);
 			for (PassiveSpell spell : allTypes) {
-				if (spell.ignoreCancelled() || !event.isCancelled()) {
-					if (spellbook.hasSpell(spell)) {
-						boolean casted = spell.activate(player);
-						if (PassiveListener.cancelDefaultAction(spell, casted)) {
-							event.setCancelled(true);
-						}
+				if (!isCancelStateOk(spell, event.isCancelled())) continue;
+				if (spellbook.hasSpell(spell)) {
+					boolean casted = spell.activate(player);
+					if (PassiveListener.cancelDefaultAction(spell, casted)) {
+						event.setCancelled(true);
 					}
 				}
 			}
@@ -83,12 +82,11 @@ public void onCraft(CraftItemEvent event) {
 			if (list != null) {
 				Spellbook spellbook = MagicSpells.getSpellbook(player);
 				for (PassiveSpell spell : list) {
-					if (spell.ignoreCancelled() || !event.isCancelled()) {
-						if (spellbook.hasSpell(spell)) {
-							boolean casted = spell.activate(player);
-							if (PassiveListener.cancelDefaultAction(spell, casted)) {
-								event.setCancelled(true);
-							}
+					if (!isCancelStateOk(spell, event.isCancelled())) continue;
+					if (spellbook.hasSpell(spell)) {
+						boolean casted = spell.activate(player);
+						if (PassiveListener.cancelDefaultAction(spell, casted)) {
+							event.setCancelled(true);
 						}
 					}
 				}

src/com/nisovin/magicspells/spells/passive/DropItemListener.java

@@ -63,6 +63,7 @@ public void onDrop(PlayerDropItemEvent event) {
 		if (allTypes.size() > 0) {
 			Spellbook spellbook = MagicSpells.getSpellbook(event.getPlayer());
 			for (PassiveSpell spell : allTypes) {
+				if (!isCancelStateOk(spell, event.isCancelled())) continue;
 				if (spellbook.hasSpell(spell)) {
 					boolean casted = spell.activate(event.getPlayer());
 					if (PassiveListener.cancelDefaultAction(spell, casted)) {
@@ -77,6 +78,7 @@ public void onDrop(PlayerDropItemEvent event) {
 			if (list != null) {
 				Spellbook spellbook = MagicSpells.getSpellbook(event.getPlayer());
 				for (PassiveSpell spell : list) {
+					if (!isCancelStateOk(spell, event.isCancelled())) continue;
 					if (spellbook.hasSpell(spell)) {
 						boolean casted = spell.activate(event.getPlayer());
 						if (PassiveListener.cancelDefaultAction(spell, casted)) {

src/com/nisovin/magicspells/spells/passive/EnterBedListener.java

@@ -26,6 +26,7 @@ public void registerSpell(PassiveSpell spell, PassiveTrigger trigger, String var
 	public void onDeath(PlayerBedEnterEvent event) {
 		Spellbook spellbook = MagicSpells.getSpellbook(event.getPlayer());
 		for (PassiveSpell spell : spells) {
+			if (!isCancelStateOk(spell, event.isCancelled())) continue;
 			if (spellbook.hasSpell(spell)) {
 				spell.activate(event.getPlayer()); // TODO is this safe to cancel?
 			}

src/com/nisovin/magicspells/spells/passive/FatalDamageListener.java

@@ -30,6 +30,7 @@ void onDamage(EntityDamageEvent event) {
 		if (event.getFinalDamage() >= player.getHealth()) {
 			Spellbook spellbook = MagicSpells.getSpellbook(player);
 			for (PassiveSpell spell : spells) {
+				if (!isCancelStateOk(spell, event.isCancelled())) continue;
 				if (spellbook.hasSpell(spell)) {
 					boolean casted = spell.activate(player);
 					if (PassiveListener.cancelDefaultAction(spell, casted)) {

src/com/nisovin/magicspells/spells/passive/FishListener.java

@@ -69,6 +69,7 @@ public void onFish(PlayerFishEvent event) {
 			Spellbook spellbook = MagicSpells.getSpellbook(player);
 			Entity entity = event.getCaught();
 			for (PassiveSpell spell : allTypes) {
+				if (!isCancelStateOk(spell, event.isCancelled())) continue;
 				if (spellbook.hasSpell(spell)) {
 					boolean casted = spell.activate(player, entity instanceof LivingEntity ? (LivingEntity)entity : null);
 					if (PassiveListener.cancelDefaultAction(spell, casted)) {
@@ -81,6 +82,7 @@ public void onFish(PlayerFishEvent event) {
 		if (state == State.IN_GROUND && ground.size() > 0) {
 			Spellbook spellbook = MagicSpells.getSpellbook(player);
 			for (PassiveSpell spell : ground) {
+				if (!isCancelStateOk(spell, event.isCancelled())) continue;
 				if (spellbook.hasSpell(spell)) {
 					boolean casted = spell.activate(player, event.getHook().getLocation());
 					if (PassiveListener.cancelDefaultAction(spell, casted)) {
@@ -91,6 +93,7 @@ public void onFish(PlayerFishEvent event) {
 		} else if (state == State.CAUGHT_FISH && fish.size() > 0) {
 			Spellbook spellbook = MagicSpells.getSpellbook(player);
 			for (PassiveSpell spell : fish) {
+				if (!isCancelStateOk(spell, event.isCancelled())) continue;
 				if (spellbook.hasSpell(spell)) {
 					boolean casted = spell.activate(player, event.getHook().getLocation());
 					if (PassiveListener.cancelDefaultAction(spell, casted)) {
@@ -101,6 +104,7 @@ public void onFish(PlayerFishEvent event) {
 		} else if (state == State.FAILED_ATTEMPT && fail.size() > 0) {
 			Spellbook spellbook = MagicSpells.getSpellbook(player);
 			for (PassiveSpell spell : fail) {
+				if (!isCancelStateOk(spell, event.isCancelled())) continue;
 				if (spellbook.hasSpell(spell)) {
 					boolean casted = spell.activate(player, event.getHook().getLocation());
 					if (PassiveListener.cancelDefaultAction(spell, casted)) {
@@ -113,6 +117,7 @@ public void onFish(PlayerFishEvent event) {
 			if (entity != null && types.containsKey(entity.getType())) {
 				Spellbook spellbook = MagicSpells.getSpellbook(player);
 				for (PassiveSpell spell : fail) {
+					if (!isCancelStateOk(spell, event.isCancelled())) continue;
 					if (spellbook.hasSpell(spell)) {
 						boolean casted = spell.activate(player, entity instanceof LivingEntity ? (LivingEntity)entity : null);
 						if (PassiveListener.cancelDefaultAction(spell, casted)) {