Formula AI Howto - Revision history

Egallager: new "See Also" section

2023-04-07T15:22:47Z

new "See Also" section

Celtic Minstrel: /* A Simpler Method for Adding Candidate Actions */ Fix broken syntax highlighting by expanding the macro

2022-11-14T01:58:54Z

‎A Simpler Method for Adding Candidate Actions: Fix broken syntax highlighting by expanding the macro

Celtic Minstrel: Use syntax highlighting

2022-11-11T03:56:27Z

Use syntax highlighting

Show changes

Mattsc: Remove link to a deleted page

2016-02-24T20:52:32Z

Remove link to a deleted page

Mattsc: Remove links to deleted pages

2016-02-24T20:42:01Z

Remove links to deleted pages

Mattsc: Remove links to a deleted page

2016-02-23T17:17:38Z

Remove links to a deleted page

Mattsc: Add not-maintained warning

2016-02-23T04:24:15Z

Add not-maintained warning

Mattsc: Delete links to page which is about to be removed

2016-02-14T19:10:48Z

Delete links to page which is about to be removed

Vultraz at 00:42, 7 April 2014

2014-04-07T00:42:21Z

Alarantalara: Add AI Category

2012-11-27T16:41:55Z

Add AI Category

← Older revision		Revision as of 15:22, 7 April 2023
Line 273:		Line 273:

	Many examples of Formula AI code can be found found in the [[Formula AI Code Library]] page and in [http://forums.wesnoth.org/viewtopic.php?f=10&t=34976 this forum thread].		Many examples of Formula AI code can be found found in the [[Formula AI Code Library]] page and in [http://forums.wesnoth.org/viewtopic.php?f=10&t=34976 this forum thread].
		+
		+	== See Also ==
		+	* [[FormulaAI/Replacing]]

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

@@ Line 171: / Line 171: @@
 <syntaxhighlight lang=wml>
          [ai]
-             {MODIFY_AI_ADD_CANDIDATE_ACTION {SIDE} main_loop (
+             [modify_ai]
                  [candidate_action]
                      engine=fai
@@ Line 182: / Line 184: @@
                      action="move(me.loc, loc(me.loc.x, me.loc.y + 1))"
                  [/candidate_action]
-             )}
+             [/modify_ai]
          [ai]
 </syntaxhighlight>

← Older revision		Revision as of 20:52, 24 February 2016
Line 20:		Line 20:

	The stages are executed in whichever order they are put into the side tag. That is to say, all the moves of the first stage in the [[AiWML\|[ai]]] tag are played out first, then all the moves of the second stage, and so on until the last stage. Then the turn ends.		The stages are executed in whichever order they are put into the side tag. That is to say, all the moves of the first stage in the [[AiWML\|[ai]]] tag are played out first, then all the moves of the second stage, and so on until the last stage. Then the turn ends.
−
−	~~Note: The [[AI Module]] module page mentions another Formula AI stage called ''rca_formulas''. However, that stage does not exist in the current Wesnoth version.~~

	===Setting up the Formula AI ''unit_formulas'' Stage===		===Setting up the Formula AI ''unit_formulas'' Stage===

@@ Line 8: / Line 8: @@
 This page is meant as a practical guide for setting up and testing Formula AI functionality in a scenario. It does not give a complete description of the Formula AI language. See [[FormulaAI]] and [[FormulaAI Functions]] for that.  In addition, the first post in [http://forums.wesnoth.org/viewtopic.php?f=10&t=27839 this thread] links to a file with (not quite complete but useful) information about Formula AI functions and variables.
-Make sure you have read the [[General RCA AI Howto]] as a basic understanding of the purpose of AI engines, stages and candidate actions is assumed here.
+Make sure you have read about the [[Wesnoth_AI_Framework]] as a basic understanding of the purpose of AI engines, stages and candidate actions is assumed here.
 Also note that we do not explain all the different ways of setting things up here. Instead, we focus on one specific method that works reasonably well. Using variations thereof will hopefully be straightforward once the principles are understood.

@@ Line 14: / Line 14: @@
 ==Formula AI Setup==
-Unlike [[Lua AI Howto|Lua AI]], Formula AI does not require an engine to be set up, and (usually) no global variables need to be defined up front either.  Thus, only one component needs to be set up, the stage, or stages, controlling Formula AI behavior.  Three different stages are available for Formula AI code:
+Formula AI does not require an engine to be set up, and (usually) no global variables need to be defined up front either.  Thus, only one component needs to be set up, the stage, or stages, controlling Formula AI behavior.  Three different stages are available for Formula AI code:
 *Formula AI ''unit_formulas'' stage: executes unit-specific Formula AI moves
 *Formula AI ''side_formulas'' stage: executes side-wide Formula AI moves
@@ Line 220: / Line 220: @@
 The important thing here is that we have now set up a mechanism that creates the ''me'' and ''target'' variables as they are used in some of the stages described above.  We can replace the move used here with whatever AI behavior we want to test.  Once we are done with testing, we can simply copy the code above the two 'where' lines into the AI stages or candidate actions.
-Note that the Formula AI functions and variables do not need to be initialized.  They are available at every turn for each side.  Thus, we do not need to go through the tricks described for testing [[Lua_AI_Howto#Testing_setup|Lua AI]], but can simply set up Side 1 with 'controller=human' and start with the testing.
+Note that the Formula AI functions and variables do not need to be initialized.  They are available at every turn for each side.  Thus, we can simply set up Side 1 with 'controller=human' and start with the testing.
 == Adding / Deleting Stages and Candidate Actions ==

← Older revision		Revision as of 04:24, 23 February 2016
Line 1:		Line 1:
		+	{\| class="wikitable" style="text-align: center;"
		+	\|'''Warning'''
		+	\|-
		+	\|Formula AI is still functional for the time being, but it is not maintained any more.
		+	That applies to both the code and these wiki pages.
		+	\|}
		+
	This page is meant as a practical guide for setting up and testing Formula AI functionality in a scenario. It does not give a complete description of the Formula AI language. See [[FormulaAI]] and [[FormulaAI Functions]] for that. In addition, the first post in [http://forums.wesnoth.org/viewtopic.php?f=10&t=27839 this thread] links to a file with (not quite complete but useful) information about Formula AI functions and variables.		This page is meant as a practical guide for setting up and testing Formula AI functionality in a scenario. It does not give a complete description of the Formula AI language. See [[FormulaAI]] and [[FormulaAI Functions]] for that. In addition, the first post in [http://forums.wesnoth.org/viewtopic.php?f=10&t=27839 this thread] links to a file with (not quite complete but useful) information about Formula AI functions and variables.

@@ Line 8: / Line 8: @@
 Unlike [[Lua AI Howto|Lua AI]], Formula AI does not require an engine to be set up, and (usually) no global variables need to be defined up front either.  Thus, only one component needs to be set up, the stage, or stages, controlling Formula AI behavior.  Three different stages are available for Formula AI code:
-*[[Customizing_AI_in_Wesnoth_1.8#A_stage_to_execute_unit_formulas|Formula AI ''unit_formulas'' stage]]: executes unit-specific Formula AI moves
+*Formula AI ''unit_formulas'' stage: executes unit-specific Formula AI moves
-*[[Customizing_AI_in_Wesnoth_1.8#A_stage_to_execute_side_formulas|Formula AI ''side_formulas'' stage]]: executes side-wide Formula AI moves
+*Formula AI ''side_formulas'' stage: executes side-wide Formula AI moves
-*[[Customizing_AI_in_Wesnoth_1.8#Working_with_main_loop_of_the_RCA_AI|RCA AI ''main_loop'' stage]] (''cpp''): the standard AI stage with its candidate actions
+*RCA AI ''main_loop'' stage (''cpp''): the standard AI stage with its candidate actions
 The stages are executed in whichever order they are put into the side tag.  That is to say, all the moves of the first stage in the [[AiWML|[ai]]] tag are played out first, then all the moves of the second stage, and so on until the last stage.  Then the turn ends.
@@ Line 219: / Line 219: @@
 Stages and candidate actions can be added and removed at any time in the scenario.  A large number of macros are available in [http://www.wesnoth.org/macro-reference.html#file:ai.cfg core/macros/ai.cfg] for this purpose.
-Here are two code examples of deleting candidate actions from the default RCA AI stage taken from [[Customizing_AI_in_Wesnoth_1.8]].  The first is done right at the beginning during the side definition:
+Here are two code examples of deleting candidate actions from the default RCA AI stage.  The first is done right at the beginning during the side definition:
   [side]

@@ Line 121: / Line 121: @@
 Note that we have two of the default CAs commented out.  If all of them were used unaltered, we could simply use
       {ai/aliases/stable_singleplayer.cfg}
-inside [[SideWML|[side]]] (but outside [[AiWML|[ai]]]) instead.  The advantage of listing them specifically is that individual CAs can then be commented out (as is done here) and/or replaced by custom CAs.  [Note that it is important not to add a second stage if 'stable_singleplayer.cfg' is included, even if it has the same name and id as the ''main_loop'' stage, if your new candidate action is to be evaluated against all the default CAs.  See the [[Lua_AI_Code_Library#Swamp_Lurker_Moves|swamp lurker moves]] example, and in particular the last note, for an explanation of how this can be done (yes, that's a Lua AI example, but this particular point applies here as well).]
+inside [[SideWML|[side]]] (but outside [[AiWML|[ai]]]) instead.  The advantage of listing them specifically is that individual CAs can then be commented out (as is done here) and/or replaced by custom CAs.  [Note that it is important not to add a second stage if 'stable_singleplayer.cfg' is included, even if it has the same name and id as the ''main_loop'' stage, if your new candidate action is to be evaluated against all the default CAs.  See the Micro AI Lurkers test scenario in ''/data/ai/micro_ais/'' for an explanation of how this can be done (yes, that's a Lua AI example, but this particular point applies here as well).]
 In this example, the default ''villages'' and ''retreat'' CAs are replaced by a custom-built CA.  This CA uses the ''fai'' engine and is given user-defined name ''go_south''.  It is of type ''movement'', which means that the evaluation code is called once for every unit of the AI's side that has movement points left, and that this unit is passed to the evaluation and action code in variable ''me''.

← Older revision		Revision as of 16:41, 27 November 2012
Line 244:		Line 244:

	Many examples of Formula AI code can be found found in the [[Formula AI Code Library]] page and in [http://forums.wesnoth.org/viewtopic.php?f=10&t=34976 this forum thread].		Many examples of Formula AI code can be found found in the [[Formula AI Code Library]] page and in [http://forums.wesnoth.org/viewtopic.php?f=10&t=34976 this forum thread].
		+
		+	[[Category:AI]]