Andy Breakdown - Revision history

MrDuck557: Links go to master branch now

2023-12-31T16:12:42Z

Links go to master branch now

← Older revision		Revision as of 16:12, 31 December 2023
Line 124:		Line 124:
	Note: CO_<co name> is standard convention for CO variables. Often, you'll store important variables for your CO on CO_<co name> like CO_ANDY.powerHeal. CO_<co name> is how other scripts are going to access your CO, and how your own script accesses your CO.		Note: CO_<co name> is standard convention for CO variables. Often, you'll store important variables for your CO on CO_<co name> like CO_ANDY.powerHeal. CO_<co name> is how other scripts are going to access your CO, and how your own script accesses your CO.

	At the end of the animation, the units will be healed for 2 hp. postAnimationHeal uses the prior three values to know what position to heal as well as how much to heal. setEndOfAnimationCall tells the animation engine to call a function (in this case postAnimationHeal) from an object (ANIMATION) at the end of the animation. Here's the actual postAnimationHeal if you're curious. [https://github.com/Robosturm/Commander_Wars/blob/~~5a820a28c520f5cfa0c18a5fe1e82a916c927f6f~~/resources/scripts/general/animation.js~~#L4~~]		At the end of the animation, the units will be healed for 2 hp. postAnimationHeal uses the prior three values to know what position to heal as well as how much to heal. setEndOfAnimationCall tells the animation engine to call a function (in this case postAnimationHeal) from an object (ANIMATION) at the end of the animation. Here's the actual postAnimationHeal if you're curious. [https://github.com/Robosturm/Commander_Wars/blob/master/resources/scripts/general/animation.js]


Line 153:		Line 153:
	</syntaxhighlight>animations.length < 5 means the animation queue isn't full. It then adds a sprite (power0) and positions it accordingly.		</syntaxhighlight>animations.length < 5 means the animation queue isn't full. It then adds a sprite (power0) and positions it accordingly.

	Looking at the source of addSprite [https://github.com/Robosturm/Commander_Wars/blob/~~5a820a28c520f5cfa0c18a5fe1e82a916c927f6f~~/game/gameanimation/gameanimation.cpp], it offsets the image so that the unit is in the center (-map.getImageSize()*1.27) (both of them), sets sleepAfterFinish (0 is no I think), sets the scale (2) and adds delay (delay). There's another parameter for loops, which would probably set repeats if you want the image to show up more than once.		Looking at the source of addSprite [https://github.com/Robosturm/Commander_Wars/blob/master/game/gameanimation/gameanimation.cpp], it offsets the image so that the unit is in the center (-map.getImageSize()*1.27) (both of them), sets sleepAfterFinish (0 is no I think), sets the scale (2) and adds delay (delay). There's another parameter for loops, which would probably set repeats if you want the image to show up more than once.

	powerNameAnimation.queueAnimation(animation) sets the current animation to fire right after powerNameAnimation (the screen fill with your power name). But while the animation starts right away internally, the sound and image are delayed (thanks to delay) so what you see and hear on screen actually starts a bit later (which is probably what you want). queueAnimation() is a function attached to the animation class in general, so don't be confused if you see a different animation object using this function.		powerNameAnimation.queueAnimation(animation) sets the current animation to fire right after powerNameAnimation (the screen fill with your power name). But while the animation starts right away internally, the sound and image are delayed (thanks to delay) so what you see and hear on screen actually starts a bit later (which is probably what you want). queueAnimation() is a function attached to the animation class in general, so don't be confused if you see a different animation object using this function.
Line 262:		Line 262:
	return "OS";		return "OS";
	};		};
	</syntaxhighlight>getCOUnitRange should return the CO zone range, in this case 3.		</syntaxhighlight>getCOUnitRange should return the CO zone range, in this case 3.

	getCOArmy should return a string corresponding to the co's country. In this case Andy is from Orange Star, so this function returns "OS". You can check other COs for their country's strings. <syntaxhighlight lang="javascript" line="1" start="158">		getCOArmy should return a string corresponding to the co's country. In this case Andy is from Orange Star, so this function returns "OS". You can check other COs for their country's strings. <syntaxhighlight lang="javascript" line="1" start="158">

MrDuck557: Sami's code incorrect, fixed

2023-12-31T13:17:01Z

Sami's code incorrect, fixed

← Older revision		Revision as of 13:17, 31 December 2023
Line 369:		Line 369:
	this.getAiCoUnitBonus = function(co, unit, map)		this.getAiCoUnitBonus = function(co, unit, map)
	{		{
	if (unit.getUnitID !== "INFANTRY")		if (unit.getUnitID() !== "INFANTRY")
	{		{
	if (unit.getUnitType() === GameEnums.UnitType_Infantry)		if (unit.getUnitType() === GameEnums.UnitType_Infantry)

MrDuck557: Endnote and removed unfinished notice

2023-12-30T20:03:03Z

Endnote and removed unfinished notice

@@ Line 2: / Line 2: @@
 '''This tutorial references https://github.com/Robosturm/Commander_Wars/blob/master/resources/scripts/cos/co_andy.js, the source code of the actual vanilla Andy in COW.'''
 == Small Disclaimer ==
@@ Line 498: / Line 496: @@
 And with those two lines, we are finished!
 [[Category:Modding tutorials]]

MrDuck557: Finished descriptions and footer

2023-12-30T20:00:41Z

Finished descriptions and footer

← Older revision		Revision as of 20:00, 30 December 2023
Line 389:		Line 389:

	Andy returns 1 no matter what, so no preference.		Andy returns 1 no matter what, so no preference.

			What a long winded way of explaining 4 lines of code.

			== Bio, Description, and Details ==
			<syntaxhighlight lang="javascript" line="1" start="239">
			// CO - Intel
			this.getBio = function(co)
			{
			return qsTr("A whiz with a wrench, this mechanical boy wonder earned fame as the hero who saved Macro Land in the last great war.");
			};
			</syntaxhighlight>Now we get to the CO information. This just returns a string. What's interesting is the use of the function qsTr. This converts the string into a format that's easier to display, so just put it around the test you're displaying and you're good to go.<syntaxhighlight lang="javascript" line="1" start="244">
			this.getHits = function(co)
			{
			return qsTr("Mechanics");
			};
			this.getMiss = function(co)
			{
			return qsTr("Waking up too early");
			};
			this.getCODescription = function(co)
			{
			return qsTr("No real weaknesses or strengths. Ready to fight wherever and whenever.");
			};
			</syntaxhighlight>More bio.

			getCODescription is where you'll put a short description of your CO. Nothing long and no numbers, just tell the user the basics. Also useful for more flavor text.<syntaxhighlight lang="javascript" line="1" start="256">
			this.getLongCODescription = function()
			{
			var text = qsTr("\nSpecial Unit:\nRepair Tanks\n") +
			qsTr("\nGlobal Effect: \nNone.") +
			qsTr("\n\nCO Zone Effect: \nAndy's units gain +%0% firepower and +%1% defence.");
			text = replaceTextArgs(text, [CO_ANDY.d2dCoZoneOffBonus, CO_ANDY.d2dCoZoneDefBonus]);
			return text;
			};
			</syntaxhighlight>Predictably, the long CO description, but this time with numbers!

			var text is just a temporary placeholder, the name isn't important

			You can join strings to each other with the + operator. You don't have to do this, but here it makes the text easier to read (code-side, there should be no difference on screen). \n is the newline symbol, which makes a newline. You can get more info on strings on google.

			What's the %0% doing in the string? It's used by the replaceTextArgs to substitute the proper bonus numbers into the description. Specifically, %0% says "insert the thing in index 0 of the list of objects here". In this case, it's easy to see that CO_ANDY.d2dCoZoneOffBonus is the first object in the list. Similar idea with %1%.

			Doing this rather than hardcoding the numbers into the string makes it easier to change the stats of the CO without messing up the description. You can hardcode the numbers if you like, just remember they're there.<syntaxhighlight lang="javascript" line="1" start="264">
			this.getPowerDescription = function(co)
			{
			var text = qsTr("Restores +%0 HP to all of Andy's units. His units gain +%1% firepower and +%2% defence.");
			text = replaceTextArgs(text, [CO_ANDY.powerHeal, CO_ANDY.powerOffBonus, CO_ANDY.powerDefBonus]);
			return text;
			};
			this.getPowerName = function(co)
			{
			return qsTr("Hyper Repair");
			};
			</syntaxhighlight>Power description and power name. What else is there to say.<syntaxhighlight lang="javascript" line="1" start="274">
			this.getSuperPowerDescription = function(co)
			{
			var text = qsTr("Restores +%0 HP to all of Andy's units. His units gain +%2 movement, +%1% firepower, and +%3% defence.");
			text = replaceTextArgs(text, [CO_ANDY.superPowerHeal, CO_ANDY.superPowerOffBonus, CO_ANDY.superPowerMovementBonus, CO_ANDY.powerDefBonus]);
			return text;
			};
			this.getSuperPowerName = function(co)
			{
			return qsTr("Hyper Upgrade");
			};
			</syntaxhighlight>The super power. Spicy I know<syntaxhighlight lang="javascript" line="1" start="284">
			this.getPowerSentences = function(co)
			{
			return [qsTr("I've got parts to spare!"),
			qsTr("I'm not giving up!"),
			qsTr("Time to roll up my sleeves!"),
			qsTr("I haven't even cranked the engine yet!"),
			qsTr("Pass me my wrench!"),
			qsTr("It's time for a tune-up!"),
			qsTr("Never give up, and never lose! I'm on my way!"),
			qsTr("I'm not worried! I can fix anything!")];
			};
			</syntaxhighlight>When you use a power, the CO says something before actually using it. What that something is comes from here.

			Just return a list of strings (using []), the hard part is thinking of what to say.<syntaxhighlight lang="javascript" line="1" start="295">
			this.getVictorySentences = function(co)
			{
			return [qsTr("We won! Woohoo!"),
			qsTr("I can fix anything!"),
			qsTr("I did it! Did you see that!?")];
			};
			this.getDefeatSentences = function(co)
			{
			return [qsTr("Oh, come on!"),
			qsTr("Next time I see you, you're in trouble!")];
			};
			</syntaxhighlight>There are a surprising number of words that go into making a CO aren't there?<syntaxhighlight lang="javascript" line="1" start="306">
			this.getName = function()
			{
			return qsTr("Andy");
			};
			}
			</syntaxhighlight>Just to confirm, we are in fact looking at Andy's code.

			Also the closing bracket of the original Constructor function. How long ago was that?

			== Footer ==
			Now for two vital lines of code:<syntaxhighlight lang="javascript" line="1" start="312">
			Constructor.prototype = CO;
			var CO_ANDY = new Constructor();
			</syntaxhighlight>We set the type of constructor to CO. This tells COW that this is a CO and not some weirdly shaped unit.

			Then we set the var CO_ANDY to a new instance of Constructor. This makes CO_ANDY and actual CO object, and not just the blueprints of how to make Andy. CO_ANDY is where COW (and other scripts) will reference your CO from now on.

			And with those two lines, we are finished!
	[[Category:Modding tutorials]]		[[Category:Modding tutorials]]

MrDuck557: Right category

2023-12-30T16:54:56Z

Right category

← Older revision		Revision as of 16:54, 30 December 2023
Line 389:		Line 389:

	Andy returns 1 no matter what, so no preference.		Andy returns 1 no matter what, so no preference.
	[[Category:Modding ~~Tutorials~~]]		[[Category:Modding tutorials]]

MrDuck557: Category added

2023-12-30T16:54:17Z

Category added

← Older revision		Revision as of 16:54, 30 December 2023
Line 389:		Line 389:

	Andy returns 1 no matter what, so no preference.		Andy returns 1 no matter what, so no preference.
			[[Category:Modding Tutorials]]

MrDuck557: Finish Music and Modifiers

2023-12-30T16:32:56Z

Finish Music and Modifiers

Show changes

MrDuck557: A bit of work on Music and Modifiers

2023-12-19T19:51:17Z

A bit of work on Music and Modifiers

@@ Line 262: / Line 262: @@
          return "OS";
      };
-</syntaxhighlight>getCOUnitRange
+</syntaxhighlight>getCOUnitRange should return the CO zone range, in this case 3.

MrDuck557: Started music and modifiers

2023-12-19T18:47:42Z

Started music and modifiers

← Older revision		Revision as of 18:47, 19 December 2023
Line 223:		Line 223:

	Not very long actually, they're far simpler and mostly just for returning numbers.		Not very long actually, they're far simpler and mostly just for returning numbers.

			== Music and Modifiers ==
			Most of these functions will return a value. Not much logic in these.<syntaxhighlight lang="javascript" line="1" start="127">
			this.loadCOMusic = function(co, map)
			{
			if (CO.isActive(co))
			{
			switch (co.getPowerMode())
			{
			case GameEnums.PowerMode_Power:
			audio.addMusic("resources/music/cos/power.mp3", 992, 45321);
			break;
			case GameEnums.PowerMode_Superpower:
			audio.addMusic("resources/music/cos/superpower.mp3", 1505, 49515);
			break;
			case GameEnums.PowerMode_Tagpower:
			audio.addMusic("resources/music/cos/tagpower.mp3", 14611, 65538);
			break;
			default:
			audio.addMusic("resources/music/cos/andy.mp3", 4466, 74972);
			break;
			}
			}
			};
			</syntaxhighlight>co.getPowerMode() returns something based on what power is activated.

			switch statements execute different code based on the input value. In this case that would be the power mode.

			audio.addMusic plays the music (in a loop presumably) from startTime (in milliseconds) to endTime (in milliseconds).

			The break statements prevent the code from considering other cases once one case has been run.<syntaxhighlight lang="javascript" line="1" start="149">
			this.getCOUnitRange = function(co, map)
			{
			return 3;
			};
			this.getCOArmy = function()
			{
			return "OS";
			};
			</syntaxhighlight>getCOUnitRange

MrDuck557: Power stuff finished. activatePower and activateSuperpower explained

2023-12-19T18:26:07Z

Power stuff finished. activatePower and activateSuperpower explained

@@ Line 123: / Line 123: @@
              animation.setEndOfAnimationCall("ANIMATION", "postAnimationHeal");
 </syntaxhighlight>Here the animation is set up. The animation is created on the map at the unit's position in createAnimation. Then the unit's position is written to the animation and CO_ANDY.powerHeal. powerHeal is an integer specifying the COP healing, in this case 2. The variable is useful to avoid "magic numbers", constant values that are typed in directly. If you want to change a magic number, you have to manually go into the code and edit every instance of that magic number. Keeping your constants in variables like CO_ANDY.powerHeal allows you to change the value quickly and easily from one place. You'll see variables like this later in the code.
 At the end of the animation, the units will be healed for 2 hp. postAnimationHeal uses the prior three values to know what position to heal as well as how much to heal. setEndOfAnimationCall tells the animation engine to call a function (in this case postAnimationHeal) from an object (ANIMATION) at the end of the animation. Here's the actual postAnimationHeal if you're curious. [https://github.com/Robosturm/Commander_Wars/blob/5a820a28c520f5cfa0c18a5fe1e82a916c927f6f/resources/scripts/general/animation.js#L4]