VariablesWML/How to use variables - Revision history

Celtic Minstrel: Add one missing case of syntax hilitinh

2019-07-17T12:57:07Z

Add one missing case of syntax hilitinh

2019-07-14T13:31:40Z

Added code highlighting

2019-01-26T14:32:57Z

‎Using arrays: Note that FOREACH is deprecated. This tutorial section is still relevant.

2017-10-14T22:28:07Z

Refer to WFL as WFL, instead of calling it the formulaAI syntax

2017-05-10T10:11:57Z

‎More with arrays

2017-05-10T01:59:13Z

2017-05-10T01:57:19Z

expanded arrays tutorial

2014-04-07T04:30:35Z

2013-12-10T09:49:58Z

‎Dynamic code with insert_tag

2013-12-10T09:37:06Z

‎Passing “parameters” to an event

@@ Line 67: / Line 67: @@
 We shall not use  '''[set_variable]''' tag anymore. Instead, we shall use the '''VARIABLE''' shortcut:
- {VARIABLE simpleVariable "Delfador the Great"}
+<syntaxhighlight lang="wml">
 stands for:
 <syntaxhighlight lang="wml">

@@ Line 383: / Line 383: @@
 different kind of records (for instance units and locations). The reason is most often, arrays
 are fetched and manipulated in loops. Loops are much more easy to program when all records
 have the same structure.
 The '''FOREACH''' macro is most often used for this purpose. It takes an array name and a
 variable name as arguments. The variable will contain an index incremented by one on each
@@ Line 434: / Line 438: @@
       [/if]
   {NEXT index}
 ==== <u>More with arrays</u> ====

@@ Line 63: / Line 63: @@
       value="Delfador the Great"
   [/set_variable]
-We shall not use the arithmetic variations of '''set_variable''' either. Instead we shall use the   '''formulaAI''' syntax which is much more natural. Instead of:
+We shall not use the arithmetic variations of '''set_variable''' either. Instead we shall use the   [[Wesnoth_Formula_Language]] which is much more natural. Instead of:
   [set_variable]
        name=simpleVariable
@@ Line 79: / Line 79: @@
 : # or
   {VARIABLE simpleVariable "$(35 + $anotherVariable)"}
-The formulaAI syntax is easy to use, the important thing is to always put the formula in this   sequence: “'''$( …''' here comes the formula '''… )'''”
+The [[Wesnoth_Formula_Language]] syntax is easy to use, the important thing is to always put the formula in this   sequence: “'''$( …''' here comes the formula '''… )'''”
 In other words, '''$simpleVariable''' can be written everywhere you want  to use the value of   '''simpleVariable.'''
 Clearing variables can be done using the '''[clear_variable]''' tag:

@@ Line 436: / Line 436: @@
 ==== <u>More with arrays</u> ====
-Let's say we want our Trapper unit to be able to put traps all around the map. Each trap position is saved as a location, a container with '''x''' and '''y''' values, stored using '''[store_locations]'''. We have stored all our trap positions in this variable "trap_pos", but now we want to another location where the Trapper is currently standing ($x1, $y1). How would we do that? Here is one simple way, using '''find_in''':
+Let's say we want our Trapper unit to be able to put traps all around the map. Each trap position is saved as a location, a container with '''x''' and '''y''' values, stored using '''[store_locations]'''. We have stored all our trap positions in this variable "trap_pos", but now we want to add another location where the Trapper is currently standing ($x1, $y1). How would we do that? Here is one simple way, using '''find_in''':
   [store_locations]

@@ Line 311: / Line 311: @@
-==== <u>More with arrays</u> ====
+==== <u>Using arrays</u> ====
-Arrays can be created using the '''[set_variables]''' tag. In it, we can repeat the '''[value][/value]'''
+Now that we understand containers (read the previous section if you skipped that), it's time to move on to arrays. Arrays can be created using the '''[set_variables]''' tag. In it, we can repeat the '''[value][/value]''' block at will, and this will create a container array:
   [set_variables]
       name=heroes
@@ Line 435: / Line 434: @@
       [/if]
   {NEXT index}
 === <u>First steps into darkness</u> ===
@@ Line 1,077: / Line 1,114: @@
 [[Category:WML_Reference]]

@@ Line 813: / Line 813: @@
       [/harm_unit]
   #enddef
 Then the code works. And the macro can be used in a normal way too.
 Pay heed, '''insert_tag''' must be included in some action (event and so on). It works not at the scenario level for instance.
 As you can see, the '''insert_tag''' allows to do many things, but in our opinion, should be used scarcely. Here we shall show how it can be used to solve a common problem. Suppose we want to list the objects of a unit in a option message, let the user choose an object and remove it from the unit. This can be done with this kind of code:

@@ Line 701: / Line 701: @@
 fire_event tag documentation, one can find:
 '''[primary_attack]''': Information passed to the primary attack filter and $weapon variable on
-the new event.
+the new event. Of course, we have no attacker and no attack here, but what happens if we set something here
 like :
   [fire_event]
@@ Line 720: / Line 719: @@
 Well, it pure voodoo but it works. Of course, one can pass anything in the '''primary_attack'''
 block, not only a single value. The block itself will be discarded when he event is finished,
 just like call parameters in subroutines.
 ==== <u>Dynamic code with insert_tag</u> ====