refactor: deprecate the onAffordablePreview system

LordMidas · LordMidas · commit a309d6710b78 · 2024-04-14T23:10:06.000-04:00
diff --git a/msu/hooks/skills/skill.nut b/msu/hooks/skills/skill.nut
@@ -60,8 +60,8 @@
 	q.m.IsBaseValuesSaved <- false;
 	q.m.ScheduledChanges <- []; // Deprecated
 
-	q.m.IsApplyingPreview <- false;
-	q.m.PreviewField <- {};
+	q.m.IsApplyingPreview <- false; // Deprecated - Only needed for the legacy onAffordablePreview system -- use the new onUpdatePreview and onAfterUpdatePreview system
+	q.m.PreviewField <- {}; // Deprecated - Only needed for the legacy onAffordablePreview system -- use the new onUpdatePreview and onAfterUpdatePreview system
 
 	q.isType = @() function( _t, _any = true, _only = false )
 	{
@@ -345,15 +345,18 @@
 		this.onAfterUpdate(_properties);
 	}
 
+	// Deprecated - Only needed for the legacy onAffordablePreview system -- use the new onUpdatePreview and onAfterUpdatePreview system
 	q.onAffordablePreview <- function( _skill, _movementTile )
 	{
 	}
 
+	// Deprecated - Only needed for the legacy onAffordablePreview system -- use the new onUpdatePreview and onAfterUpdatePreview system
 	q.modifyPreviewField <- function( _skill, _field, _newChange, _multiplicative )
 	{
 		::MSU.Skills.modifyPreview(this, _skill, _field, _newChange, _multiplicative);
 	}
 
+	// Deprecated - Only needed for the legacy onAffordablePreview system -- use the new onUpdatePreview and onAfterUpdatePreview system
 	q.modifyPreviewProperty <- function( _skill, _field, _newChange, _multiplicative )
 	{
 		::MSU.Skills.modifyPreview(this, null, _field, _newChange, _multiplicative);
@@ -496,6 +499,7 @@
 
 ::MSU.QueueBucket.VeryLate.push(function() {
 	::MSU.MH.hook("scripts/skills/skill", function(q) {
+		// Deprecated - Only needed for the legacy onAffordablePreview system -- use the new onUpdatePreview and onAfterUpdatePreview system
 		foreach (func in ::MSU.Skills.PreviewApplicableFunctions)
 		{
 			q[func] = @(__original) function()
@@ -557,6 +561,7 @@
 			}
 		}
 
+		// Deprecated - Only needed for the legacy onAffordablePreview system -- use the new onUpdatePreview and onAfterUpdatePreview system
 		q.isAffordablePreview = @(__original) function()
 		{
 			if (!this.getContainer().m.IsPreviewing) return __original();
diff --git a/msu/hooks/skills/skill_container.nut b/msu/hooks/skills/skill_container.nut
@@ -1,7 +1,7 @@
 ::MSU.MH.hook("scripts/skills/skill_container", function(q) {
 	q.m.ScheduledChangesSkills <- []; // Deprecated
 	q.m.IsPreviewing <- false;
-	q.m.PreviewProperty <- {};
+	q.m.PreviewProperty <- {}; // Deprecated - Only needed for the legacy onAffordablePreview system -- use the new onUpdatePreview and onAfterUpdatePreview system
 
 	q.update = @(__original) function()
 	{
@@ -221,6 +221,7 @@
 		]);
 	}
 
+	// Deprecated - Only needed for the legacy onAffordablePreview system -- use the new onUpdatePreview and onAfterUpdatePreview system
 	q.onAffordablePreview <- function( _skill, _movementTile )
 	{
 		this.m.PreviewProperty.clear();
diff --git a/msu/hooks/ui/screens/tactical/modules/turn_sequence_bar/turn_sequence_bar.nut b/msu/hooks/ui/screens/tactical/modules/turn_sequence_bar/turn_sequence_bar.nut
@@ -52,7 +52,7 @@
 				activeEntity.getSkills().m.IsPreviewing = true;
 				this.m.MSU_PreviewSkill = skill;
 				this.m.MSU_PreviewMovement = movement;
-				activeEntity.getSkills().onAffordablePreview(skill, movement == null ? null : movement.End);
+				activeEntity.getSkills().onAffordablePreview(skill, movement == null ? null : movement.End); // Deprecated - Only needed for the legacy onAffordablePreview system -- use the new onUpdatePreview and onAfterUpdatePreview system
 				activeEntity.getSkills().updatePreview(skill, movement);
 			}
 		}
@@ -71,7 +71,7 @@
 		local activeEntity = this.getActiveEntity();
 		if (activeEntity != null)
 		{
-			activeEntity.getSkills().m.IsPreviewing = false;
+			activeEntity.getSkills().m.IsPreviewing = false; // Deprecated - Only needed for the legacy onAffordablePreview system -- use the new onUpdatePreview and onAfterUpdatePreview system
 			this.m.MSU_PreviewSkill = null;
 			this.m.MSU_PreviewMovement = null;
 		}
diff --git a/msu/utils/skills.nut b/msu/utils/skills.nut
@@ -1,9 +1,9 @@
 ::MSU.Skills <- {
-	PreviewApplicableFunctions = [
+	PreviewApplicableFunctions = [ // Deprecated - Only needed for the legacy onAffordablePreview system -- use the new onUpdatePreview and onAfterUpdatePreview system
 		"getActionPointCost",
 		"getFatigueCost"
 	],
-	QueuedPreviewChanges = {},
+	QueuedPreviewChanges = {}, // Deprecated - Only needed for the legacy onAffordablePreview system -- use the new onUpdatePreview and onAfterUpdatePreview system
 	SoftResetFields = [
 		"ActionPointCost",
 		"FatigueCost",
@@ -48,6 +48,7 @@
 		});
 	}
 
+	// Deprecated - Only needed for the legacy onAffordablePreview system -- use the new onUpdatePreview and onAfterUpdatePreview system
 	function addPreviewApplicableFunction( _name )
 	{
 		::MSU.requireString(_name);
@@ -65,6 +66,7 @@
 		if (idx != null) this.SoftResetFields.remove(idx);
 	}
 
+	// Deprecated - Only needed for the legacy onAffordablePreview system -- use the new onUpdatePreview and onAfterUpdatePreview system
 	// Private
 	function modifyPreview( _caller, _targetSkill, _field, _newChange, _multiplicative )
 	{

Original file line number	Diff line number	Diff line change
`@@ -60,8 +60,8 @@`
`60`	`60`	`q.m.IsBaseValuesSaved <- false;`
`61`	`61`	`q.m.ScheduledChanges <- []; // Deprecated`
`62`	`62`
`63`		`- q.m.IsApplyingPreview <- false;`
`64`		`- q.m.PreviewField <- {};`
	`63`	`+ q.m.IsApplyingPreview <- false; // Deprecated - Only needed for the legacy onAffordablePreview system -- use the new onUpdatePreview and onAfterUpdatePreview system`
	`64`	`+ q.m.PreviewField <- {}; // Deprecated - Only needed for the legacy onAffordablePreview system -- use the new onUpdatePreview and onAfterUpdatePreview system`
`65`	`65`
`66`	`66`	`q.isType = @() function( _t, _any = true, _only = false )`
`67`	`67`	`{`
`@@ -345,15 +345,18 @@`
`345`	`345`	`this.onAfterUpdate(_properties);`
`346`	`346`	`}`
`347`	`347`
	`348`	`+ // Deprecated - Only needed for the legacy onAffordablePreview system -- use the new onUpdatePreview and onAfterUpdatePreview system`
`348`	`349`	`q.onAffordablePreview <- function( _skill, _movementTile )`
`349`	`350`	`{`
`350`	`351`	`}`
`351`	`352`
	`353`	`+ // Deprecated - Only needed for the legacy onAffordablePreview system -- use the new onUpdatePreview and onAfterUpdatePreview system`
`352`	`354`	`q.modifyPreviewField <- function( _skill, _field, _newChange, _multiplicative )`
`353`	`355`	`{`
`354`	`356`	`::MSU.Skills.modifyPreview(this, _skill, _field, _newChange, _multiplicative);`
`355`	`357`	`}`
`356`	`358`
	`359`	`+ // Deprecated - Only needed for the legacy onAffordablePreview system -- use the new onUpdatePreview and onAfterUpdatePreview system`
`357`	`360`	`q.modifyPreviewProperty <- function( _skill, _field, _newChange, _multiplicative )`
`358`	`361`	`{`
`359`	`362`	`::MSU.Skills.modifyPreview(this, null, _field, _newChange, _multiplicative);`
`@@ -496,6 +499,7 @@`
`496`	`499`
`497`	`500`	`::MSU.QueueBucket.VeryLate.push(function() {`
`498`	`501`	`::MSU.MH.hook("scripts/skills/skill", function(q) {`
	`502`	`+ // Deprecated - Only needed for the legacy onAffordablePreview system -- use the new onUpdatePreview and onAfterUpdatePreview system`
`499`	`503`	`foreach (func in ::MSU.Skills.PreviewApplicableFunctions)`
`500`	`504`	`{`
`501`	`505`	`q[func] = @(__original) function()`
`@@ -557,6 +561,7 @@`
`557`	`561`	`}`
`558`	`562`	`}`
`559`	`563`
	`564`	`+ // Deprecated - Only needed for the legacy onAffordablePreview system -- use the new onUpdatePreview and onAfterUpdatePreview system`
`560`	`565`	`q.isAffordablePreview = @(__original) function()`
`561`	`566`	`{`
`562`	`567`	`if (!this.getContainer().m.IsPreviewing) return __original();`
Original file line number	Diff line number	Diff line change
`@@ -1,7 +1,7 @@`
`1`	`1`	`::MSU.MH.hook("scripts/skills/skill_container", function(q) {`
`2`	`2`	`q.m.ScheduledChangesSkills <- []; // Deprecated`
`3`	`3`	`q.m.IsPreviewing <- false;`
`4`		`- q.m.PreviewProperty <- {};`
	`4`	`+ q.m.PreviewProperty <- {}; // Deprecated - Only needed for the legacy onAffordablePreview system -- use the new onUpdatePreview and onAfterUpdatePreview system`
`5`	`5`
`6`	`6`	`q.update = @(__original) function()`
`7`	`7`	`{`
`@@ -221,6 +221,7 @@`
`221`	`221`	`]);`
`222`	`222`	`}`
`223`	`223`
	`224`	`+ // Deprecated - Only needed for the legacy onAffordablePreview system -- use the new onUpdatePreview and onAfterUpdatePreview system`
`224`	`225`	`q.onAffordablePreview <- function( _skill, _movementTile )`
`225`	`226`	`{`
`226`	`227`	`this.m.PreviewProperty.clear();`
Original file line number	Diff line number	Diff line change
`@@ -52,7 +52,7 @@`
`52`	`52`	`activeEntity.getSkills().m.IsPreviewing = true;`
`53`	`53`	`this.m.MSU_PreviewSkill = skill;`
`54`	`54`	`this.m.MSU_PreviewMovement = movement;`
`55`		`- activeEntity.getSkills().onAffordablePreview(skill, movement == null ? null : movement.End);`
	`55`	`+ activeEntity.getSkills().onAffordablePreview(skill, movement == null ? null : movement.End); // Deprecated - Only needed for the legacy onAffordablePreview system -- use the new onUpdatePreview and onAfterUpdatePreview system`
`56`	`56`	`activeEntity.getSkills().updatePreview(skill, movement);`
`57`	`57`	`}`
`58`	`58`	`}`
`@@ -71,7 +71,7 @@`
`71`	`71`	`local activeEntity = this.getActiveEntity();`
`72`	`72`	`if (activeEntity != null)`
`73`	`73`	`{`
`74`		`- activeEntity.getSkills().m.IsPreviewing = false;`
	`74`	`+ activeEntity.getSkills().m.IsPreviewing = false; // Deprecated - Only needed for the legacy onAffordablePreview system -- use the new onUpdatePreview and onAfterUpdatePreview system`
`75`	`75`	`this.m.MSU_PreviewSkill = null;`
`76`	`76`	`this.m.MSU_PreviewMovement = null;`
`77`	`77`	`}`
Original file line number	Diff line number	Diff line change
`@@ -1,9 +1,9 @@`
`1`	`1`	`::MSU.Skills <- {`
`2`		`- PreviewApplicableFunctions = [`
	`2`	`+ PreviewApplicableFunctions = [ // Deprecated - Only needed for the legacy onAffordablePreview system -- use the new onUpdatePreview and onAfterUpdatePreview system`
`3`	`3`	`"getActionPointCost",`
`4`	`4`	`"getFatigueCost"`
`5`	`5`	`],`
`6`		`- QueuedPreviewChanges = {},`
	`6`	`+ QueuedPreviewChanges = {}, // Deprecated - Only needed for the legacy onAffordablePreview system -- use the new onUpdatePreview and onAfterUpdatePreview system`
`7`	`7`	`SoftResetFields = [`
`8`	`8`	`"ActionPointCost",`
`9`	`9`	`"FatigueCost",`
`@@ -48,6 +48,7 @@`
`48`	`48`	`});`
`49`	`49`	`}`
`50`	`50`
	`51`	`+ // Deprecated - Only needed for the legacy onAffordablePreview system -- use the new onUpdatePreview and onAfterUpdatePreview system`
`51`	`52`	`function addPreviewApplicableFunction( _name )`
`52`	`53`	`{`
`53`	`54`	`::MSU.requireString(_name);`
`@@ -65,6 +66,7 @@`
`65`	`66`	`if (idx != null) this.SoftResetFields.remove(idx);`
`66`	`67`	`}`
`67`	`68`
	`69`	`+ // Deprecated - Only needed for the legacy onAffordablePreview system -- use the new onUpdatePreview and onAfterUpdatePreview system`
`68`	`70`	`// Private`
`69`	`71`	`function modifyPreview( _caller, _targetSkill, _field, _newChange, _multiplicative )`
`70`	`72`	`{`