Merge pull request #1999 from nandastone/1088-b

Abolished "Fiery Touch" ability change + shrunken targeting hexes, fixes #1088

src/abilities/Abolished.js

@@ -63,12 +63,31 @@ export default (G) => {
 				}
 			},
 		},
-		// Fiery touch
+
+		/**
+		 * Basic Ability: Fiery Touch
+		 *
+		 * Attack a single enemy unit within 3 range (forwards, backwards, or diagonal)
+		 * dealing both slash and burn damage.
+		 *
+		 * When upgraded, the range is extended to 6 but only the burn damage is applied.
+		 *
+		 * Targeting rules:
+		 * - The target must be an enemy unit.
+		 * - The target must be inline forwards, backwards, or diagonally within 3 range.
+		 * - The path to the target unit cannot be interrupted by any obstacles or units.
+		 *
+		 * Other rules:
+		 * - Whether dealing both damage types or just one (upgraded extra range), only
+		 *   one attack and damage should occur.
+		 * - When upgraded, the extended range of the burn damage should be indicated
+		 *   with "reduced effect" (scaled down) hexagons.
+		 */
 		{
-			//	Type : Can be "onQuery", "onStartPhase", "onDamage"
 			trigger: 'onQuery',
-			distance: 3,
-			_targetTeam: Team.enemy,
+
+			_targetTeam: Team.Enemy,
+
 			require() {
 				if (!this.testRequirements()) {
 					return false;
@@ -77,42 +96,46 @@ export default (G) => {
 				if (
 					!this.testDirection({
 						team: this._targetTeam,
-						distance: this.distance,
+						distance: this._getDistance(),
 						sourceCreature: this.creature,
 					})
 				) {
 					return false;
 				}
+
 				return true;
 			},
+
 			query() {
-				let ability = this;
-				let crea = this.creature;
+				const ability = this;
+				const abolished = this.creature;
 
-				if (this.isUpgraded()) {
-					this.distance = 5;
-				}
+				// TODO: Visually show reduced damage hexes for 4-6 range.
 
 				G.grid.queryDirection({
 					fnOnConfirm: function () {
 						ability.animation(...arguments);
 					},
-					flipped: crea.player.flipped,
+					flipped: abolished.player.flipped,
 					team: this._targetTeam,
 					id: this.creature.id,
 					requireCreature: true,
-					x: crea.x,
-					y: crea.y,
-					distance: this.distance,
-					sourceCreature: crea,
+					x: abolished.x,
+					y: abolished.y,
+					distance: this._getDistance(),
+					distanceFalloff: this.range.regular,
+					sourceCreature: abolished,
 				});
 			},
+
 			activate(path, args) {
-				let ability = this;
+				const ability = this;
+				const target = arrayUtils.last(path).creature;
 
-				let target = arrayUtils.last(path).creature;
-				let startX = ability.creature.sprite.scale.x > 0 ? 232 : 52;
-				let projectileInstance = G.animations.projectile(
+				ability.end();
+
+				const startX = ability.creature.sprite.scale.x > 0 ? 232 : 52;
+				const projectileInstance = G.animations.projectile(
 					this,
 					target,
 					'effects_fiery-touch',
@@ -121,29 +144,61 @@ export default (G) => {
 					startX,
 					-20,
 				);
-				let tween = projectileInstance[0];
-				let sprite = projectileInstance[1];
+				const tween = projectileInstance[0];
+				const sprite = projectileInstance[1];
+				const damage = this._getDamage(path);
 
 				tween.onComplete.add(function () {
-					let damage = new Damage(
-						ability.creature, // Attacker
-						ability.damages, // Damage Type
-						1, // Area
-						[], // Effects
-						G,
-					);
-					target.takeDamage(damage);
-
-					ability.end();
+					// `this` refers to the animation object, _not_ the ability.
 					this.destroy();
-				}, sprite); // End tween.onComplete
+
+					target.takeDamage(damage);
+				}, sprite);
 			},
+
 			getAnimationData: function () {
 				return {
 					duration: 425,
 				};
 			},
+
+			/**
+			 * Calculate the maximum distance the ability can be targeted and activated.
+			 *
+			 * @returns {number} Ability maximum distance
+			 */
+			_getDistance() {
+				return this.isUpgraded() ? this.range.upgraded : this.range.regular;
+			},
+
+			/**
+			 * Calculate the damage of the ability as it changes depending on the distance
+			 * that it is used.
+			 *
+			 * @param {Hex[]} path Path from the Abolished to the target unit. May contain
+			 * 	creature hexes.
+			 * @returns {Damage} Final damage
+			 */
+			_getDamage(path) {
+				/* The path may contain multiple hexes from the source/target unit, so reduce
+				to the path BETWEEN the source/target for simpler logic. */
+				const distance = arrayUtils.filterCreature([...path], false, false).length;
+				const damages = {
+					...this.damages,
+					slash:
+						/* If the ability was targeted beyond the regular range, only the burn
+						damage is applied.
+
+						`distance` is 1 less than the ability range as it's the distance BETWEEN
+						the units, rather than the distance used in query calculations which
+						may included hexagons of either creature. */
+						distance >= this.range.regular ? 0 : this.damages.slash,
+				};
+
+				return new Damage(this.creature, damages, 1, [], G);
+			},
 		},
+
 		// Wild Fire
 		{
 			//	Type : Can be "onQuery", "onStartPhase", "onDamage"

src/abilities/Asher.js

@@ -59,7 +59,7 @@ export default (G) => {
 			trigger: 'onQuery',
 
 			distance: 2,
-			_targetTeam: Team.enemy,
+			_targetTeam: Team.Enemy,
 
 			// 	require() :
 			require: function () {
@@ -121,7 +121,7 @@ export default (G) => {
 			//	Type : Can be "onQuery","onStartPhase","onDamage"
 			trigger: 'onQuery',
 
-			_targetTeam: Team.enemy,
+			_targetTeam: Team.Enemy,
 
 			// 	require() :
 			require: function () {

src/abilities/Chimera.js

@@ -38,7 +38,7 @@ export default (G) => {
 			//	Type : Can be "onQuery","onStartPhase","onDamage"
 			trigger: 'onQuery',
 
-			_targetTeam: Team.enemy,
+			_targetTeam: Team.Enemy,
 
 			//	require() :
 			require: function () {
@@ -108,7 +108,7 @@ export default (G) => {
 			//	Type : Can be "onQuery", "onStartPhase", "onDamage"
 			trigger: 'onQuery',
 
-			_targetTeam: Team.both,
+			_targetTeam: Team.Both,
 
 			//	require() :
 			require: function () {
@@ -200,7 +200,7 @@ export default (G) => {
 			//	Type : Can be "onQuery", "onStartPhase", "onDamage"
 			trigger: 'onQuery',
 
-			_targetTeam: Team.both,
+			_targetTeam: Team.Both,
 
 			_getDirections: function () {
 				return this.testDirections({

src/abilities/Cyber-Wolf.js

@@ -37,7 +37,7 @@ export default (G) => {
 				if (!target) {
 					return;
 				}
-				if (!isTeam(this.creature, target, Team.enemy)) {
+				if (!isTeam(this.creature, target, Team.Enemy)) {
 					return;
 				}
 
@@ -62,7 +62,7 @@ export default (G) => {
 			//	Type : Can be "onQuery", "onStartPhase", "onDamage"
 			trigger: 'onQuery',
 
-			_targetTeam: Team.enemy,
+			_targetTeam: Team.Enemy,
 
 			// 	require() :
 			require: function () {
@@ -218,7 +218,7 @@ export default (G) => {
 					fnOnConfirm: function () {
 						ability.animation(...arguments);
 					},
-					team: Team.both,
+					team: Team.Both,
 					id: crea.id,
 					requireCreature: false,
 					choices: choices,
@@ -337,7 +337,7 @@ export default (G) => {
 					fnOnConfirm: function () {
 						ability.animation(...arguments);
 					}, // fnOnConfirm
-					team: Team.enemy,
+					team: Team.Enemy,
 					id: crea.id,
 					flipped: crea.player.flipped,
 					hexes: hexes,

src/abilities/Dark-Priest.js

@@ -67,7 +67,7 @@ export default (G) => {
 			//	Type : Can be "onQuery", "onStartPhase", "onDamage"
 			trigger: 'onQuery',
 
-			_targetTeam: Team.enemy,
+			_targetTeam: Team.Enemy,
 
 			// 	require() :
 			require: function () {
@@ -126,7 +126,7 @@ export default (G) => {
 			//	Type : Can be "onQuery", "onStartPhase", "onDamage"
 			trigger: 'onQuery',
 
-			_targetTeam: Team.enemy,
+			_targetTeam: Team.Enemy,
 
 			// 	require() :
 			require: function () {

src/abilities/Golden-Wyrm.js

@@ -35,7 +35,7 @@ export default (G) => {
 					// Upgraded version only activates if enemy is in adjacent hexes
 					if (
 						!this.atLeastOneTarget(this._targets, {
-							team: Team.enemy,
+							team: Team.Enemy,
 						})
 					) {
 						return false;
@@ -88,7 +88,7 @@ export default (G) => {
 
 			_executeHealthThreshold: 45,
 
-			_targetTeam: Team.enemy,
+			_targetTeam: Team.Enemy,
 
 			require: function () {
 				if (!this.testRequirements()) {
@@ -305,7 +305,7 @@ export default (G) => {
 		{
 			trigger: 'onQuery',
 
-			_targetTeam: Team.ally,
+			_targetTeam: Team.Ally,
 
 			_maxTransferAmount: 50,
 

src/abilities/Gumble.js

@@ -107,7 +107,7 @@ export default (G) => {
 					fnOnConfirm: function () {
 						ability.animation(...arguments);
 					},
-					team: Team.both,
+					team: Team.Both,
 					id: this.creature.id,
 					requireCreature: false,
 					choices: choices,
@@ -135,7 +135,7 @@ export default (G) => {
 						continue;
 					}
 					let damages = this.damages;
-					if (isTeam(this.creature, targets[i].target, Team.enemy)) {
+					if (isTeam(this.creature, targets[i].target, Team.Enemy)) {
 						damages = enemyDamages;
 					}
 					let dmg = new Damage(this.creature, damages, targets[i].hexesHit, [], G);
@@ -251,7 +251,7 @@ export default (G) => {
 			trigger: 'onQuery',
 
 			directions: [1, 1, 1, 1, 1, 1],
-			_targetTeam: Team.enemy,
+			_targetTeam: Team.Enemy,
 
 			// 	require() :
 			require: function () {

src/abilities/Headless.js

@@ -28,7 +28,7 @@ export default (G) => {
 		{
 			trigger: 'onStartPhase onEndPhase',
 
-			_targetTeam: Team.enemy,
+			_targetTeam: Team.Enemy,
 
 			require: function () {
 				// Headless only triggers ability on its own turn.
@@ -96,7 +96,7 @@ export default (G) => {
 			//	Type : Can be "onQuery", "onStartPhase", "onDamage"
 			trigger: 'onQuery',
 
-			_targetTeam: Team.enemy,
+			_targetTeam: Team.Enemy,
 
 			// 	require() :
 			require: function () {
@@ -196,7 +196,7 @@ export default (G) => {
 		{
 			trigger: 'onQuery',
 
-			_targetTeam: Team.both,
+			_targetTeam: Team.Both,
 			_directions: [0, 1, 0, 0, 1, 0],
 
 			require: function () {
@@ -275,7 +275,7 @@ export default (G) => {
 				);
 				path = arrayUtils.sortByDirection(
 					[...deadzonePath, ...path],
-					args.direction === Direction.Left ? Direction.Right : Direction.Left,
+					args.direction === Direction.Right ? Direction.Left : Direction.Right,
 				);
 
 				ability.end();
@@ -391,7 +391,7 @@ export default (G) => {
 					fnOnConfirm: function () {
 						ability.animation(...arguments);
 					},
-					team: Team.both,
+					team: Team.Both,
 					requireCreature: 0,
 					id: crea.id,
 					flipped: crea.player.flipped,