SideWML - Revision history

Soliton: /* Common Keys */

2025-06-27T08:16:04Z

‎Common Keys

Celtic Minstrel: /* Common Keys */ Link to the main documentation of [variables]

2025-03-31T04:24:32Z

‎Common Keys: Link to the main documentation of [variables]

Shiki: document [variables]

2025-03-24T13:53:46Z

document [variables]

Soliton: /* Common Keys */ add anchor to link to

2025-02-12T16:11:22Z

‎Common Keys: add anchor to link to

Dwarftough: /* Multiplayer Keys */

2024-05-26T23:08:39Z

‎Multiplayer Keys

Celtic Minstrel: /* Common Keys */ Add some anchors that can be linked to

2024-02-27T05:23:48Z

‎Common Keys: Add some anchors that can be linked to

Gfgtdf: remove outdated information about controller=null

2023-10-24T21:31:14Z

remove outdated information about controller=null

Soliton: /* Common Keys */ typo fix

2023-05-30T18:21:47Z

‎Common Keys: typo fix

Celtic Minstrel: Improve phrasing and minor clarification

2023-05-01T17:58:26Z

Improve phrasing and minor clarification

Gfgtdf: /* Common Keys */

2023-05-01T17:34:29Z

‎Common Keys

@@ Line 26: / Line 26: @@
 * '''gold''': the starting gold for this side. Default: 100. (If gold is carried over from a previous scenario, this value is the minimum starting gold.)
-* '''income''': the base income for this side. Default: 0. This is added to ''base_income'', '''[game_config]''' to determine the side's base income. (see [[GameConfigWML]]).
+* '''income''': additional income for this side. Default: 0. This is added to '''[[GameConfigWML|[game_config]]]'''''base_income'' to determine the side's base income.
 * '''hidden''': if 'yes', side is not shown in status table.

@@ Line 89: / Line 89: @@
 * {{anchor|leader|'''[leader]'''}}: describes the leader for the side, basically same as '''[unit]''' except that ''canrecruit'' will default to yes and current position to the side starting location if not specified. {{DevFeature1.17|17}} Furthermore, if left out, the '''name''' and '''save_id''' attributes in '''[side]''' will be set to the '''name''' and '''id''' attributes in the first '''[leader]''' tag.
-* {{anchor|variables|'''[variables]'''}}: {{DevFeature1.19|8}} Can be used to define side variables. When you use :inspect to see the variables, they will be listed under ''team''. This tag can also be placed in '''[unit]''' and '''[leader]''', where it will create variables as part of this unit.
+* {{anchor|variables|'''[variables]'''}}: {{DevFeature1.19|8}} Can be used to define side variables. When you use :inspect to see the variables, they will be listed under ''team''. This tag can also be placed in '''[unit]''' and '''[leader]''', where it will create variables as part of this unit. See [[VariablesWML#The_.5Bvariables.5D_tag|here]] for more info.
 * {{anchor|defeat_condition|'''defeat_condition'''}}: Specifies when a side is considered ''defeated'' this is checked ''for all sides'', after every player action and at the beginning of every turn.

← Older revision		Revision as of 13:53, 24 March 2025
Line 88:		Line 88:

	* {{anchor\|leader\|'''[leader]'''}}: describes the leader for the side, basically same as '''[unit]''' except that ''canrecruit'' will default to yes and current position to the side starting location if not specified. {{DevFeature1.17\|17}} Furthermore, if left out, the '''name''' and '''save_id''' attributes in '''[side]''' will be set to the '''name''' and '''id''' attributes in the first '''[leader]''' tag.		* {{anchor\|leader\|'''[leader]'''}}: describes the leader for the side, basically same as '''[unit]''' except that ''canrecruit'' will default to yes and current position to the side starting location if not specified. {{DevFeature1.17\|17}} Furthermore, if left out, the '''name''' and '''save_id''' attributes in '''[side]''' will be set to the '''name''' and '''id''' attributes in the first '''[leader]''' tag.
		+
		+	* {{anchor\|variables\|'''[variables]'''}}: {{DevFeature1.19\|8}} Can be used to define side variables. When you use :inspect to see the variables, they will be listed under ''team''. This tag can also be placed in '''[unit]''' and '''[leader]''', where it will create variables as part of this unit.

	* {{anchor\|defeat_condition\|'''defeat_condition'''}}: Specifies when a side is considered ''defeated'' this is checked ''for all sides'', after every player action and at the beginning of every turn.		* {{anchor\|defeat_condition\|'''defeat_condition'''}}: Specifies when a side is considered ''defeated'' this is checked ''for all sides'', after every player action and at the beginning of every turn.

@@ Line 13: / Line 13: @@
 * '''side''': a number. The leader of this side is placed on the tile represented by this number (see [[BuildingMaps]]). When defining sides, they must be defined in order since the side number is checked against the number of sides seen so far. Currently, the Multiplayer server rejects entering a scenario with more than 9 sides, even if those extra sides are AI sides. {{DevFeature1.13|2}} The server doesn't limit the number of sides anymore.
-* '''controller''' (required): how moves for this side should be inputted.
+* {{anchor|controller|'''controller'''}} (required): how moves for this side should be inputted.
 ** '''ai''': the Wesnoth AI makes this side's moves.
 ** '''human''': a player controls this side's moves.

@@ Line 123: / Line 123: @@
 * '''no_leader''': if 'yes', prevents the engine from generating a leader from the multiplayer faction, basically an alias of '''leader_lock'''
-* '''leader_lock''': if true then this side's leader (type or gender) is not allowed to be modified.
+* '''leader_lock''': if true then this side's leader (type or gender) is not allowed to be modified. Note that if ''type='' key is missing, ''leader_lock=yes'' means the side will have no leader.
 * '''faction''': if a valid faction id is provided then this side's faction will default to it in the game setup screen. {{DevFeature1.13|?}} if this key isn't included in the ''[side]'' then a random faction will be chosen, and the side's recruit list set from the faction. To use a custom ''recruit'' list, you must also specify ''faction=Custom''.

@@ Line 34: / Line 34: @@
 * '''fog_data''': describes the area which this team has de-fogged, using the same format as shroud_data. (This is not particularly useful when defining a side, though, as the game will recalculate fog as turns begin and end.) It is used in saved games.
-* '''[fog_override]''' With keys x= and y=, this records the hexes that have been cleared (multiturn) with {{tag|DirectActionsWML|lift_fog}}.
+* {{anchor|fog_override|'''[fog_override]'''}}: With keys x= and y=, this records the hexes that have been cleared (multiturn) with {{tag|DirectActionsWML|lift_fog}}.
 * '''shroud''': if 'yes', this side cannot see any tiles it has not moved within sight of. Please note that the AI currently ignores the shroud. NOTE: with shroud=no, this team *ignores* shroud, so it is not possible to modify it using place_shroud and remove_shroud tags. If you want to do so, use "shroud=yes" and place_shroud/remove_shroud tags.
@@ Line 80: / Line 80: @@
 * '''suppress_end_turn_confirmation''': If "yes", then the player will not be asked to confirm ending their turn even if they have not done anything. This is provided for some (probably few) user-made scenarios in which players often skip their turns. (default: no)
-* '''[ai]''' if '''controller=ai''', gives parameters to the AI. See [[AiWML]].
+* {{anchor|ai|'''[ai]'''}}: if '''controller=ai''', gives parameters to the AI. See [[AiWML]].
-* '''[village]''' describes a village the side begins in control of.
+* {{anchor|village|'''[village]'''}}: describes a village the side begins in control of.
 ** ''x'', ''y'' the location of the village. If the pair of coordinates is not a village or is duplicated in another '''[village]''' tag, behaviour is undefined. Recent game engine or wmllint should warn about these.
-* '''[unit]''' describes a unit which begins on the side. See [[SingleUnitWML]]. If the side has a recall list and the unit is not given a location, it will start on the recall list. Note that the ''side'' attribute under '''[unit]''' will be ignored, as the side will come from the ''side'' attribute of '''[side]'''.
+* {{anchor|unit|'''[unit]'''}}: describes a unit which begins on the side. See [[SingleUnitWML]]. If the side has a recall list and the unit is not given a location, it will start on the recall list. Note that the ''side'' attribute under '''[unit]''' will be ignored, as the side will come from the ''side'' attribute of '''[side]'''.
-* '''[leader]''' describes the leader for the side, basically same as '''[unit]''' except that ''canrecruit'' will default to yes and current position to the side starting location if not specified. {{DevFeature1.17|17}} Furthermore, if left out, the '''name''' and '''save_id''' attributes in '''[side]''' will be set to the '''name''' and '''id''' attributes in the first '''[leader]''' tag.
+* {{anchor|leader|'''[leader]'''}}: describes the leader for the side, basically same as '''[unit]''' except that ''canrecruit'' will default to yes and current position to the side starting location if not specified. {{DevFeature1.17|17}} Furthermore, if left out, the '''name''' and '''save_id''' attributes in '''[side]''' will be set to the '''name''' and '''id''' attributes in the first '''[leader]''' tag.
-* '''defeat_condition''' Specifies when a side is considered ''defeated'' this is checked ''for all sides'', after every player action and at the beginning of every turn.
+* {{anchor|defeat_condition|'''defeat_condition'''}}: Specifies when a side is considered ''defeated'' this is checked ''for all sides'', after every player action and at the beginning of every turn.
 ** '''no_leader_left''': (default) The side is considered defeated if it has no units with canrecruit=yes
 ** '''no_units_left''': The side is defeated as soon as it has no units left.

@@ Line 16: / Line 16: @@
 ** '''ai''': the Wesnoth AI makes this side's moves.
 ** '''human''': a player controls this side's moves.
-** '''null''': the side doesn't get a turn to move and doesn't have a leader generated from the contents of the [side] tag. (It still can get units from [unit] tags in the [side] tag.) Events that would usually occur on the side's turn will not take place. This includes healing (ability, villages and rest) and ''side turn'' events.
+** '''null''': the side doesn't get a turn to move. Events that would usually occur on the side's turn will not take place. This includes healing (ability, villages and rest) and ''side turn'' events.
 ** '''a number''': gives this side's control to a side with '''side''' matching the number (multiplayer only). {{DevFeature1.13|2}} using a number is deprecated, use previous_save_id= instead.
 ** Note: in multiplayer, when reading the side's data with ''[store_side]'', the value may differ between clients and using it for conditional actions may cause OOS. Discussion in https://r.wesnoth.org/p643343

@@ Line 47: / Line 47: @@
 * '''save_id''': defaults to the leader's ''id'' if available, 'Unknown' otherwise. The ID of the side with respect to the previous and next scenarios. Used to carry over the side's recall list (including the side's leader), recruitment list, and starting gold from scenario to scenario. Also used for the side's displayed name in the victory gold-calculation dialog.
-* '''previous_save_id''': {{DevFeature1.13|2}} defaults to ''save_id''. Only used in mp games, specially mp campaigns. This attribute specifies which user should play this side by default. For example if a side has previous_save_id="Konrad" then the side will be assigned to that player who played the side with the save_id="Konrad" in the previous level. If used in the first scenario, multiple sides with the same ''previous_side_id'' will be assigned to the same player.
+* '''previous_save_id''': {{DevFeature1.13|2}} defaults to ''save_id''. Only used in mp games, specially mp campaigns. This attribute specifies which user should play this side by default. For example if a side has previous_save_id="Konrad" then the side will be assigned to that player who played the side with the save_id="Konrad" in the previous level. If used in the first scenario, multiple sides with the same ''previous_save_id'' will be assigned to the same player.
 * '''team_name''': a non translatable string representing the team's description. Sides with the same team_name are allied. Default ''side''. ''team_name'' is now a comma-separated list of teams that the side is on.

@@ Line 20: / Line 20: @@
 ** Note: in multiplayer, when reading the side's data with ''[store_side]'', the value may differ between clients and using it for conditional actions may cause OOS. Discussion in https://r.wesnoth.org/p643343
-* '''no_leader''': if 'no' (default), then keys describing a unit which will begin on the side's keep will be the remainder of the '''[side]''' tag, See [[SingleUnitWML]]. Note that if the keys '''x''', '''y''' are included, the leader will begin there regardless of keep location. If this side has a recall list from a previous level, then the recall list will be searched for a leader (using ''canrecruit=yes'') and if one is found it will be used instead of the one described in the '''[side]''' tag. Typical keys used for defining the leader unit are ''type'' (mandatory), ''id'', ''name'' and ''unrenamable=yes'', see [[SingleUnitWML]]. The unit will automatically be set to be able to recruit.
+* '''type''': if present, the keys describing a unit (including '''type''') which will begin on the side's keep will be the remainder of the '''[side]''' tag, See [[SingleUnitWML]]. Note that if the keys '''x''', '''y''' are included, the leader will begin there regardless of keep location. If this side has a recall list from a previous level, then the recall list will be searched for a leader (using ''canrecruit=yes'') and if one is found it will be used instead of the one described in the '''[side]''' tag. Typical keys used for defining the leader unit are ''id'', ''name'' and ''unrenamable=yes'', see [[SingleUnitWML]]. The unit will automatically be set to be able to recruit.
 * '''recruit''': a list of unit types. At the beginning of the scenario, the side gains recruitment of these units. Units in the side recruit list can always be recruited by a leader on this side, in addition to any units in the individual leader's '''extra_recruit''' list. {{DevFeature1.13|?}} in multiplayer, unless you specify ''faction=Custom'', this will be overwritten by the recruit list from the faction.
@@ Line 87: / Line 87: @@
 * '''[unit]''' describes a unit which begins on the side. See [[SingleUnitWML]]. If the side has a recall list and the unit is not given a location, it will start on the recall list. Note that the ''side'' attribute under '''[unit]''' will be ignored, as the side will come from the ''side'' attribute of '''[side]'''.
-* '''[leader]''' same as '''[unit]''' except that ''canrecruit'' will default to yes and current position to the side starting location if not specified.
+* '''[leader]''' describes the leader for the side, basically same as '''[unit]''' except that ''canrecruit'' will default to yes and current position to the side starting location if not specified. {{DevFeature1.17|17}} furthermore if left out the '''name''' and '''save_id''' attributes in '''[side]''' will be set to the '''name''' and '''id''' attributes in '''[leader]'''
 * '''defeat_condition''' Specifies when a side is considered ''defeated'' this is checked ''for all sides'', after every player action and at the beginning of every turn.