AI:Development:Lang:Java - Revision history

Paulomorfeo: Update about serious quirk

2015-11-03T18:45:39Z

Update about serious quirk

← Older revision		Revision as of 19:45, 3 November 2015
Line 96:		Line 96:
	The file describes a number of attributes. Each attribute has a key, a value and a desc(ription). The key is the name of the attribute, the description tells you what the attribute is used for, and the value is what you will want to edit.		The file describes a number of attributes. Each attribute has a key, a value and a desc(ription). The key is the name of the attribute, the description tells you what the attribute is used for, and the value is what you will want to edit.

	The shortName attribute is the name used for your AI internally. It's most logical to change this into to the same name you gave your AI class. (MyJavaAI.)		The shortName attribute is the name used for your AI internally. It's most logical to change this into to the same name you gave your AI class. (MyJavaAI.) The shortName needs to agree with the folder name (see below) and cannot contain the char '_'.

	'version' tells the engine which version of your AI this is. If you're in the 0.1 folder, make this 0.1. Your AI should be located at AI/Skirmish/''shortName''/''version''/.		'version' tells the engine which version of your AI this is. If you're in the 0.1 folder, make this 0.1. Your AI should be located at AI/Skirmish/''shortName''/''version''/.

Abma: /* Links */

2015-09-24T20:12:37Z

Links

← Older revision		Revision as of 21:12, 24 September 2015
Line 357:		Line 357:
	* [https://springrts.com/dl/buildbot/doc/100.0.1-225-ga4855e7/JavaOO/ Javadoc of the Java AI OO Wrapper]		* [https://springrts.com/dl/buildbot/doc/100.0.1-225-ga4855e7/JavaOO/ Javadoc of the Java AI OO Wrapper]
	* '''OUTDATED''' [http://springrts.com/phpbb/download/file.php?id=4970 Netbeans Java Skirmish AI Tutorial] (from [http://springrts.com/phpbb/viewtopic.php?p=448743#p448743 this forum thread])		* '''OUTDATED''' [http://springrts.com/phpbb/download/file.php?id=4970 Netbeans Java Skirmish AI Tutorial] (from [http://springrts.com/phpbb/viewtopic.php?p=448743#p448743 this forum thread])
	* [http://modinfo.adune.nl/index.php?MOD=ba712 ModInfo] (contains a list of units and their short names)

	[[Category: AI Dev]]		[[Category: AI Dev]]

Abma: /* Links */

2015-09-24T20:12:25Z

Links

← Older revision		Revision as of 21:12, 24 September 2015
Line 355:		Line 355:
	== Links ==		== Links ==
	* [[AIInterface:Java\|Java AI Interface]]		* [[AIInterface:Java\|Java AI Interface]]
	* [~~http~~://~~spring~~.~~abma.de~~/doc-~~Interface~~-JavaOO/ Javadoc of the Java AI OO Wrapper] ~~(generated in 2014 from source by [[User:Abma\|abma]], currently broken)~~		* [https://springrts.com/dl/buildbot/doc/100.0.1-225-ga4855e7/JavaOO/ Javadoc of the Java AI OO Wrapper]
	* '''OUTDATED''' [http://springrts.com/phpbb/download/file.php?id=4970 Netbeans Java Skirmish AI Tutorial] (from [http://springrts.com/phpbb/viewtopic.php?p=448743#p448743 this forum thread])		* '''OUTDATED''' [http://springrts.com/phpbb/download/file.php?id=4970 Netbeans Java Skirmish AI Tutorial] (from [http://springrts.com/phpbb/viewtopic.php?p=448743#p448743 this forum thread])
	* [http://modinfo.adune.nl/index.php?MOD=ba712 ModInfo] (contains a list of units and their short names)		* [http://modinfo.adune.nl/index.php?MOD=ba712 ModInfo] (contains a list of units and their short names)

	[[Category: AI Dev]]		[[Category: AI Dev]]

Anarchid: /* Links */

2015-09-23T12:41:44Z

Links

← Older revision		Revision as of 13:41, 23 September 2015
Line 355:		Line 355:
	== Links ==		== Links ==
	* [[AIInterface:Java\|Java AI Interface]]		* [[AIInterface:Java\|Java AI Interface]]
	* [http://spring.abma.de/doc-Interface-JavaOO/ Javadoc of the Java AI OO Wrapper] (generated ~~daily~~ from source by [[User:Abma\|abma]])		* [http://spring.abma.de/doc-Interface-JavaOO/ Javadoc of the Java AI OO Wrapper] (generated in 2014 from source by [[User:Abma\|abma]], currently broken)
	* '''OUTDATED''' [http://springrts.com/phpbb/download/file.php?id=4970 Netbeans Java Skirmish AI Tutorial] (from [http://springrts.com/phpbb/viewtopic.php?p=448743#p448743 this forum thread])		* '''OUTDATED''' [http://springrts.com/phpbb/download/file.php?id=4970 Netbeans Java Skirmish AI Tutorial] (from [http://springrts.com/phpbb/viewtopic.php?p=448743#p448743 this forum thread])
	* [http://modinfo.adune.nl/index.php?MOD=ba712 ModInfo] (contains a list of units and their short names)		* [http://modinfo.adune.nl/index.php?MOD=ba712 ModInfo] (contains a list of units and their short names)

	[[Category: AI Dev]]		[[Category: AI Dev]]

Meriton: /* Building a metal extractor */

2014-05-19T18:43:30Z

Building a metal extractor

← Older revision		Revision as of 19:43, 19 May 2014
Line 316:		Line 316:
	if(metalmap){ sendTextMsg("About to build mex at frame " + frame);		if(metalmap){ sendTextMsg("About to build mex at frame " + frame);
	AIFloat3 closestspot=closestMetalSpot(commander.getPos());		AIFloat3 closestspot=closestMetalSpot(commander.getPos());
	commander.build(metalExtractor, ~~closestSpot~~, 0, (short) 0, Integer.MAX_VALUE);		commander.build(metalExtractor, closestspot, 0, (short) 0, Integer.MAX_VALUE);
	}		}
	</pre></code>		</pre></code>

Meriton: /* Building a metal extractor */

2014-05-19T18:42:52Z

Building a metal extractor

← Older revision		Revision as of 19:42, 19 May 2014
Line 316:		Line 316:
	if(metalmap){ sendTextMsg("About to build mex at frame " + frame);		if(metalmap){ sendTextMsg("About to build mex at frame " + frame);
	AIFloat3 closestspot=closestMetalSpot(commander.getPos());		AIFloat3 closestspot=closestMetalSpot(commander.getPos());
	~~BuildUnitAICommand command2=new BuildUnitAICommand(this.~~commander~~, -1,~~		commander.build(metalExtractor, closestSpot, 0, (short) 0, Integer.MAX_VALUE);
	~~new ArrayList<AICommand~~.~~Option>~~(~~), 10000,~~
	metalExtractor,~~closestspot~~, 0);
	~~handleEngineCommand(command2~~);}
	}		}
	</pre></code>		</pre></code>

Meriton: /* Telling the commander to build the solar plant */

2014-05-18T20:44:38Z

Telling the commander to build the solar plant

← Older revision		Revision as of 21:44, 18 May 2014
Line 210:		Line 210:
	</pre></code>		</pre></code>

	Commands are issued by invoking the respective method on the <code>Unit</code>. In our case, that's the <code>build</code> method, which takes the following arguments:		Commands are issued by invoking the respective method on the <code>Unit</code> (or <code>Group</code>). In our case, that's the <code>build</code> method, which takes the following arguments:

	* <code>UnitDef toBuildUnitDef</code>: the kind of unit to build		* <code>UnitDef toBuildUnitDef</code>: the kind of unit to build

Meriton: /* Getting a reference to the commander */

2014-05-18T20:43:46Z

Getting a reference to the commander

← Older revision		Revision as of 21:43, 18 May 2014
Line 166:		Line 166:
	public int unitFinished(Unit unit) {		public int unitFinished(Unit unit) {
	if (unit.getDef().getName().equals("armcom")) {		if (unit.getDef().getName().equals("armcom")) {
	~~Unit~~ commander = unit;		commander = unit;

	~~// do something with the commander here~~
	}		}

Meriton: Removed the command stuff (commands no longer exist)

2014-05-18T20:42:58Z

Removed the command stuff (commands no longer exist)

@@ Line 212: / Line 212: @@
 </pre></code>
-Giving a command is straightforward. All we need to do is to create the appropriate command object and pass it through the callback to the engine.
+Commands are issued by invoking the respective method on the <code>Unit</code>. In our case, that's the <code>build</code> method, which takes the following arguments:
-EDIT: the command class is outdated and not included in the current oo wrapper. Commands are now given via the unit class. See: http://spring.abma.de/doc-Interface-JavaOO/com/springrts/ai/oo/clb/Unit.html
+* <code>UnitDef toBuildUnitDef</code>: the kind of unit to build
-The command we need to tell commander to build a solar plant is a <code>BuildUnitAICommand</code>. This command takes a number of arguments:
+Therefore, our command looks like this:
 At this point you will want to see if your AI actually works. Export your code to ''Spring/AI/Skirmish/MyJavaAI/SkirmishAI.jar'' and start up a game. Your AI should now build a solar plant at its start position.

Meriton: Shorter example (if people don't know what a field is, they won't be having much luck coding an ai, so it's pointless repeating this here)

2014-05-18T20:23:44Z

Shorter example (if people don't know what a field is, they won't be having much luck coding an ai, so it's pointless repeating this here)

← Older revision		Revision as of 21:23, 18 May 2014
Line 160:		Line 160:
	=== Getting a reference to the commander ===		=== Getting a reference to the commander ===

	In order to have your AI build a solar plant, the first thing you need is a reference to your commander. You first need an instance field 'Unit commander' to put the reference in, then we need to get the reference itself.		Whenever a unit has been built, the engine sends a unitFinished event. At the start of the game, the engine will send a UnitFinished event for every starting unit. When playing BA, this means you will get a UnitFinished event for the commander. Therefore, the most straightforward way of finding the reference to the commander is overriding the <code>unitFinished()</code> method:
	~~A UnitFinished event is triggered whenever~~ a unit has been built~~. (This may sound similar to <code>unitCreated()</code>. For a quick explanation of the difference~~, ~~see~~ the ~~FAQ below~~.)
	At the start of the game, the engine will send a UnitFinished event for every starting unit. When playing BA, this means you will get a UnitFinished event for the commander. Therefore, the most straightforward way of finding the reference to the commander is overriding the <code>unitFinished()</code> method.

	~~To get a reference to the commander, you need to check if the unit is indeed the command, and if so, assign the value of the unit parameter to the commander field~~:

	<code><pre>		<code><pre>
	@Override		@Override
	public int unitFinished(Unit unit)		public int unitFinished(Unit unit) {
	{		if (unit.getDef().getName().equals("armcom")) {
	if (unit.getDef().getName().equals("armcom"))		Unit commander = unit;
	~~this.~~commander = unit;
			// do something with the commander here
			}

	return 0;		return 0;
	}		}
	</pre></code>		</pre></code>


	=== Getting a reference to the solar plant definition ===		=== Getting a reference to the solar plant definition ===