https://wiki.wesnoth.org/api.php?action=feedcontributions&feedformat=atom&user=Gambit 2026-05-03T06:52:54Z User contributions MediaWiki 1.31.16 https://wiki.wesnoth.org/index.php?title=Template:GambCivGuideItem&diff=44008 2011-11-13T03:51:54Z

<p>Gambit: </p> <hr /> <div>&lt;div style=&quot;width:600px;border: 1px solid #111111;background-color:#E7D9C0;padding:3px;&quot;&gt;<br /> {{{name}}}<br /> Costs: {{{AP}}} Action Points, {{{GOLD}}} Gold, {{{FOOD}}} Food, {{{MATERIAL}}} Material</div>

Gambit https://wiki.wesnoth.org/index.php?title=User:Gambit/GambCiv&diff=44007 2011-11-13T03:48:53Z

<p>Gambit: </p> <hr /> <div>{{GambCivGuideItem|name=Hut|AP=1|GOLD=75|FOOD=20|MATERIAL=15}}</div>

Gambit https://wiki.wesnoth.org/index.php?title=User:Gambit/GambCiv&diff=44006 2011-11-13T03:48:33Z

<p>Gambit: </p> <hr /> <div>{{GambCivGuideItem|name=Hut|AP=1|GOLD=75|FOO=20|MATERIAL=15}}</div>

Gambit https://wiki.wesnoth.org/index.php?title=Template:GambCivGuideItem&diff=44005 2011-11-13T03:48:03Z

<p>Gambit: </p> <hr /> <div>{{{name}}}<br /> Costs: {{{AP}}} Action Points, {{{GOLD}}} Gold, {{{FOOD}}} Food, {{{MATERIAL}}} Material</div>

Gambit https://wiki.wesnoth.org/index.php?title=User:Gambit/GambCiv&diff=44004 2011-11-13T03:47:29Z

<p>Gambit: Created page with '{{GambCivGuideItem|Hut|1|75|20|15}}'</p> <hr /> <div>{{GambCivGuideItem|Hut|1|75|20|15}}</div>

Gambit https://wiki.wesnoth.org/index.php?title=Template:GambCivGuideItem&diff=44003 2011-11-13T03:45:46Z

<p>Gambit: testing templates</p> <hr /> <div>{{{1}}}<br /> Costs: {{{2}}} Action Points, {{{3}}} Gold, {{{4}}} Food, {{{5}}} Material</div>

Gambit https://wiki.wesnoth.org/index.php?title=DirectActionsWML&diff=43953 2011-11-08T21:02:12Z

<p>Gambit: /* [capture_village] */ [capture_village] needs [filter_location] now. It's no longer an SLF by itself.</p> <hr /> <div>{{WML Tags}}<br /> == Direct actions ==<br /> <br /> Direct actions are actions that have a direct effect on gameplay. They can be used inside of [[EventWML|events]].<br /> <br /> The following tags are actions:<br /> <br /> === [endlevel] ===<br /> Ends the scenario.<br /> * '''result''': before the scenario is over, all events with ''name=result'' are triggered. If ''result=victory'', the player progresses to the next level; if ''result=defeat'', the game returns to the main menu. <br /> <br /> When the result is &quot;victory&quot; the following keys can be used:<br /> * '''bonus''': whether the player should get bonus gold (maximum possible gold that could have been earned by waiting the level out). The default is bonus=yes.<br /> * '''carryover_report''': whether the player should receive a summary of the scenario outcome, the default is carryover_report=yes.<br /> * '''save''': whether a start-of-scenario save should be created for the next scenario, the default is save=yes. Do not confuse this with saving of replays for the current scenario.<br /> * '''replay_save''': whether a replay save for the current scenario is allowed, the default is replay_save=yes. If yes, the player's settings in preferences will be used to determine if a replay is saved. If no, will override and not save a replay. {{DevFeature1.9}}<br /> * '''linger_mode''': If ...=yes, the screen is greyed out and there's the possibility to save before advancing to the next scenario, the default is linger_mode=yes.<br /> * '''reveal_map''': (Multiplayer only) (Default is 'yes') If 'no', shroud doesn't disappear when game ended. {{DevFeature1.9}}<br /> * '''next_scenario''': (default specified in '''[scenario]''' tag) the ID of the next scenario that should be played. All units that side 1 controls at this point become available for recall in ''next_scenario''.<br /> * '''carryover_percentage''': by default 80% of the gold is carried over to the next scenario, with this key the amount can be changed.<br /> * '''carryover_add''': if true the gold will be added to the starting gold the next scenario, if false the next scenario will start with the amount of the current scenario (after taxes) or the minimum in the next scenario. Default is false.<br /> * '''music''': (default specified in '''[scenario]''' or '''[game_config]''' tags) a comma-separated list of music tracks from which one will be chosen and played once after any events related to the end of level result are executed; by default, victory_music is used on victory, and defeat_music on defeat.<br /> * '''end_text''': Text that is shown centered in a black screen at the end of a campaign. Defaults to &quot;The End&quot;. Note that this has cumulative effects over the campaign - it persists even if the endlevel does not trigger the end of the campaign. See also [[CampaignWML]].<br /> * '''end_text_duration''': Delay, in milliseconds, before displaying the game credits at the end of a campaign. In other words, for how much time '''end_text''' is displayed on screen. Defaults to 3500. Note that this has cumulative effects over the campaign - it persists even if the endlevel does not trigger the end of the campaign. See also [[CampaignWML]].<br /> <br /> === [unit] ===<br /> Places a unit on the map. For syntax see [[SingleUnitWML]].<br /> * {{Short Note:Predefined Macro|GENERIC_UNIT}}<br /> * '''to_variable''': spawn directly into a variable instead of on the map.<br /> <br /> === [recall] ===<br /> Recalls a unit. The unit is recalled free of charge, and is placed near the leader.<br /> * [[StandardUnitFilter]]: the first matching unit will be recalled. If no units match this tag is ignored. Do not use a [filter] tag. If a comma separated list is given, every unit currently considered for recall is checked against all the types (not each single one of the types against all units).<br /> * '''x,y''': the unit is placed here instead of next to the leader.<br /> * '''show''': yes/no, default yes: whether the unit is animated (faded in) or instantly displayed<br /> * '''fire_event''': {{DevFeature1.9}} boolean yes|no (default no); whether any according prerecall or recall events shall be fired. In pre-1.9.3 these events are all automatically fired and it can't be turned off.<br /> * '''check_passability''': {{DevFeature1.9}} (boolean yes|no, default yes): If yes, checks for terrain passability when placing the unit (a nearby passable hex is chosen). Before 1.9 this key is always &quot;no&quot;.<br /> <br /> === [teleport] ===<br /> Teleports a unit on map. {{Short Note:Predefined Macro|TELEPORT_UNIT}}<br /> * '''[filter]''': [[StandardUnitFilter]] the first unit matching this filter will be teleported.<br /> * '''x,y''': the position to teleport to.<br /> * '''clear_shroud''': should shroud be cleared on arrival<br /> * '''animate''': should a teleport animation be played (if the unit doesn't have a teleport animation, it will fade out/fade in)<br /> * '''ignore_passability''': {{DevFeature}} normally, units will not be teleported into terrain that is impassable for them. Setting this attribute to &quot;yes&quot; permits it. {{DevFeature1.9}}Renamed to check_passability (default yes).<br /> <br /> (Note: There is also a ability named teleport, see [[AbilitiesWML]].)<br /> <br /> === [terrain_mask] ===<br /> Changes the terrain on the map. See [[TerrainMaskWML]].<br /> <br /> === [terrain] ===<br /> Changes the terrain on the map.<br /> * '''terrain''': the character of the terrain to use. See [[TerrainCodesWML]] to see what letter a type of terrain uses.<br /> * '''x,y''': the position (or range of positions) to change. {{DevFeature1.9}}: [terrain] accepts a [[StandardLocationFilter]]. This [[StandardLocationFilter]]'s terrain= key is used for the new terrain, filtering by terrain can be done with a nested [[StandardLocationFilter]]: [and]terrain=terrain_string_to_be_filtered_for.<br /> * '''layer''': (overlay|base|both, default=both) only change the specified layer.<br /> * '''replace_if_failed''': (default=no) When replacing just one layer failed, try to replace the whole terrain. If '''terrain''' is an overlay only terrain, use the default_base as base layer. If the terrain has no default base, do nothing.<br /> <br /> === [gold] ===<br /> Gives one side gold.<br /> * '''amount''': the amount of gold to give.<br /> * '''side''': (default=1) the number of the side to give the gold to; {{DevFeature1.9}} takes a comma-separated list as of 1.9.5.<br /> * '''[filter_side]''' {{DevFeature1.9}} with a [[StandardSideFilter]] as argument<br /> <br /> === [unstore_unit] ===<br /> Creates a unit from a game variable, and activates it on the playing field. This must be a specific variable describing a unit, and may not be an array -- to unstore an entire array, iterate over it. The variable is not cleared. See also [[InternalActionsWML#.5Bstore_unit.5D|[store_unit]]], [[ConditionalActionsWML#.5Bwhile.5D|[while]]] and [[InternalActionsWML#.5Bclear_variable.5D|[clear_variable]]]. Note units with a negative amount of hitpoints will be unstored with 1 hitpoint.<br /> * '''variable''': the name of the variable.<br /> * '''find_vacant''': whether the unit should be placed on the nearest vacant tile to its specified location. If this is set to 'no'(default), then any unit on the same tile as the unit being unstored will be destroyed. <br /> * '''check_passability''': {{DevFeature1.9}} (boolean yes|no, default yes): If yes, checks for terrain passability when placing the unit. This key has no effect if find_vacant=no (no check performed then). Before 1.9 this key is always &quot;no&quot;.<br /> * '''text''': (translatable) floating text to display above the unit, such as a damage amount<br /> * '''red''', '''green''', '''blue''': (default=0,0,0) the color to display the text in. Values vary from 0-255. You may find it convenient to use the {COLOR_HARM} or {COLOR_HEAL} macro instead. (Use {COLOR_HARM} or {COLOR_HEAL} instead of the whole red,green,blue= line.)<br /> * '''advance''': (default=true) if true the unit is advanced if it has enough XP. When modifying XP make sure to do it from inside a [[EventWML#Multiplayer_safety|synchronized event]] or it may lead to OOS errors especially when several advancement paths exist. Note that advance and post advance events are called, so infinite loops can happen.<br /> * '''fire_event''': {{DevFeature1.9}}(boolean yes|no, default no) Whether any advance/post advance events shall be fired if an advancement takes place, no effect otherwise. Before 1.9 this is always &quot;yes&quot;.<br /> * '''x''' ,'''y''': override unit location, &quot;x,y=recall, recall&quot; will put the unit on the unit's side's recall list.<br /> <br /> === [allow_recruit] ===<br /> Allows a side to recruit units it couldn't previously recruit.<br /> * '''type''': the types of units that the side can now recruit.<br /> * '''side''': (default=1) the number of the side that is being allowed to recruit the units {{DevFeature1.9}} side= can be a comma-separated list<br /> <br /> === [allow_extra_recruit] ===<br /> {{DevFeature1.9}}; Allows a leader to recruit units it couldn't previously recruit.<br /> These types add to the types the leader can recruit because of [side]recruit=.<br /> * '''extra_recruit''': the types of units that the unit can now recruit.<br /> * '''[[StandardUnitFilter]]''': All units matching this filter are modified. Does not match on recall list units.<br /> <br /> === [disallow_recruit] ===<br /> Prevents a side from recruiting units it could previously recruit.<br /> * '''type''': the types of units that the side can no longer recruit.<br /> * '''side''': (default=1) the number of the side that may no longer recruit the units. {{DevFeature1.9}} side= can be a comma-separated list<br /> <br /> === [disallow_extra_recruit] ===<br /> {{DevFeature1.9}}; Prevents a leader from recruiting units it could previously recruit.<br /> * '''extra_recruit''': the types of units that the side can no longer recruit.<br /> * '''[[StandardUnitFilter]]''': All units matching this filter are modified. Does not match on recall list units.<br /> <br /> === [set_recruit] ===<br /> Sets the units a side can recruit.<br /> * '''recruit''': the types of units that the side can now recruit.<br /> * '''side''': (default=1) the number of the side that is having its recruitment set. {{DevFeature1.9}} side= can be a comma-separated list<br /> <br /> === [set_extra_recruit] === <br /> {{DevFeature1.9}}; Sets the units a leader can recruit.<br /> * '''extra_recruit''': the types of units that the leader can now recruit.<br /> * '''[[StandardUnitFilter]]''': All units matching this filter are modified. Does not match on recall list units.<br /> <br /> === [modify_side] ===<br /> Modifies some details of a given side in the middle of a scenario. '''The following listed properties are the only properties that [modify_side] can affect!'''<br /> * '''side''': (default=1) the number of the side that is to be changed.<br /> * '''[filter_side]''' {{DevFeature1.9}} with a [[StandardSideFilter]] as argument<br /> * '''income''': the income given at the begining of each turn.<br /> * '''team_name''': the team in which the side plays the scenario.<br /> * '''user_team_name''': a translatable string representing the team's description. This has no effect on alliances. Defaults to ''team_name''.<br /> * '''gold''': the amount of gold the side owns.<br /> * '''village_gold''': the income setting per village for the side.<br /> * '''controller''': the identifier string of the side's controller. Uses the same syntax of the ''controller'' key in the [[SideWML|[side]]] tag.<br /> * '''fog''': a boolean string (yes/no) describing the status of Fog for the side.<br /> * '''shroud''': a boolean string describing the status of Shroud for the side.<br /> * '''hidden''': a boolean string specifying whether side is shown in status table.<br /> * '''[ai]''': replaces a side's AI parameters with the new specified ones. Uses the same syntax described in [[AiWML]].<br /> * '''switch_ai''': {{DevFeature}} replaces a side ai with a new AI from specified file(ignoring those AI parameters above). Path to file follows the usual WML convention.<br /> * '''share_maps''': {{DevFeature}} change the share_maps side attribute. Be sure to use shroud=yes for that side and have it as an ally<br /> * '''share_view''': {{DevFeature}} change the share_view side attribute. Be sure to use fog=yes for that side and have it as an ally<br /> <br /> === [modify_turns] ===<br /> Modifies the turn limit in the middle of a scenario.<br /> * '''value''': the new turn limit.<br /> * '''add''': if used instead of ''value'', specifies the number of turns to add to the current limit (can be negative).<br /> * '''current''': changes the current turn number after applying turn limit modifications, if any. It is possible to change the current turn number to a greater one than the current only, cannot be changed to lesser one; also, it is not possible to change the turn number to exceed the turn limit. {{DevFeature1.9}}: Current turn can be changed to a lesser one (1 &lt;= current turns &lt;= max turns).<br /> <br /> === [allow_end_turn] ===<br /> {{DevFeature1.9}}<br /> Allows human players to end their turn through the user interface if they were previously affected by the '''[disallow_end_turn]''' action. This action doesn't take any arguments.<br /> <br /> === [disallow_end_turn] ===<br /> {{DevFeature1.9}}<br /> Disallows human players to end their turn through the user interface. This action doesn't take any arguments.<br /> <br /> === [capture_village] ===<br /> Changes the ownership of a village.<br /> * '''side''': the side that takes control of the village. This side needs to have a leader (canrecruit=yes). If the side key is not given, the village will become neutral ({{DevFeature1.9}} unless [filter_side] is present, in which case that side fiter decides, see below).<br /> * '''[filter_side]''' {{DevFeature1.9}} with [[StandardSideFilter]] tags and keys as arguments; if both this tag and inline side= are present it's an error. Otherwise, the first matching side gets ownership (or the village becomes neutral if none match).<br /> * '''x, y''': the location of the village. Can be a comma-separated list and/or location ranges. {{DevFeature1.9}}: [capture_village] accepts a full SLF via [filter_location]; all village locations matching the filter are affected.<br /> * '''fire_event''' {{DevFeature1.9}} (boolean yes|no, default: no): Whether any capture events shall be fired. Previously to {{DevFeature1.9}}, this was always yes.<br /> <br /> === [kill] ===<br /> Removes all units (including units in a recall list) that match the filter from the game.<br /> * [[StandardUnitFilter]]: Selection criterion; do not use a [filter] tag.<br /> * '''animate''': if 'yes', displays the unit dying (fading away).<br /> * '''fire_event''': if 'yes', triggers any appropriate 'die' events (See [[EventWML]]). Previously to {{DevFeature1.9}}, the variable second_unit in each of these die and last breath events is always the same as the variable unit (the dying unit). Note that events are only fired for killed units that have been on the map (as opposed to recall list).<br /> * '''[secondary_unit]''' {{DevFeature1.9}} with a [[StandardUnitFilter]] as argument. Do not use a [filter] tag. Has an effect only if fire_event=yes. The first on-map unit matching the filter becomes second_unit in any fired die and last breath events. If an on-map unit matches and if there are several units killed with a single [kill] tag, second_unit is this same unit for all of them. If no on-map unit matches or [secondary_unit] isn't present, the variable second_unit in each of the die and last breath events is always the same as the variable unit (the dying unit).<br /> <br /> === [move_unit] ===<br /> {{DevFeature1.9}}; works like the MOVE_UNIT macro.<br /> * [[StandardUnitFilter]] as argument; do not use a [filter] tag. All units matching the filter are moved. If the target location is occupied, the nearest free passable location is chosen. All target locations passed (see below) need to be passable hexes for the particular moved units.<br /> * '''to_x''' (unsigned integer): The units are moved to this x coordinate. Can be a comma-separated list, in which case the unit follows this given path during the move.<br /> * '''to_y''' (unsigned integer): The units are moved to this y coordinate. Can be a comma-separated list.<br /> * '''fire_event''' (optional, boolean yes|no, default no): Whether any according moveto events shall be fired. The target location ($x1, $y1 in the event) may not be the same location that the unit was tried to be moved to, if the original target location is occupied or impassable.<br /> * '''check_passability''' (boolean yes|no, default yes): Whether the terrain the unit is moved to should be checked for suiting the unit. (If it does not, a nearby suitable hex is chosen.)<br /> <br /> === [modify_ai] ===<br /> * '''[filter_side]''' {{DevFeature1.9}} with a [[StandardSideFilter]] as argument<br /> Changes the AI for a specified side. See [[Customizing_AI_in_Wesnoth_1.8#.5Bmodify_ai.5D_tag]]<br /> <br /> === [modify_unit] ===<br /> {{DevFeature1.9}}; works similar to the MODIFY_UNIT macro.<br /> * '''[filter]''' with a [[StandardUnitFilter]] as argument. All units matching this filter are modified. Matches on recall list units too.<br /> * Accepts generally the syntax inside of wml unit variables created by [store_unit] which can be viewed in a savefile or by using the :inspect command. Can add traits with immediate effect. Cannot remove things. Subtags with the same name must be written in the correct order to match them with the tag they are supposed to modify.<br /> example usage (see also the test scenario):<br /> [modify_unit]<br /> [filter]<br /> type=Troll Rocklobber<br /> [/filter]<br /> hitpoints=10<br /> [modifications]<br /> [trait]<br /> # first trait is unmodified<br /> [/trait]<br /> {TRAIT_HEALTHY}# second trait is replaced with the healthy trait<br /> [/modifications]<br /> [/modify_unit]<br /> <br /> The unit which is currently modified is accessible via $this_unit, e.g. hitpoints = &quot;$($this_unit.hitpoints / 2)&quot; to set the hitpoints of all units to half of their particular maxima. This this_unit variable is independent from the this_unit variable available in the SUF used to determine which units to modify (first all matching units are gathered, and then all those are modified).<br /> <br /> note: The syntax allowed is somehow vague. Just try things and possibly correct/add/modify this documentation. (a [http://forums.wesnoth.org/viewtopic.php?f=21&amp;t=31676&amp; forum thread] discusses some related issues).<br /> <br /> === [transform_unit] ===<br /> {{DevFeature1.9}}; transforms every unit matching the filter to the given unit type. Keeps intact hitpoints, experience and status. If the unit is transformed to a non-living type (undead or mechanical), it will be also unpoisoned.<br /> * [[StandardUnitFilter]]: do not use a [filter] tag.<br /> * '''transform_to''': the unit type in which all the units matching the filter will be transformed. If missing, the units will follow their normal advancement.<br /> <br /> === [petrify] ===<br /> {{DevFeature1.9}}(This tag never existed until r47553 (from 1.9.3 on), although it was already documented.)<br /> <br /> * [[StandardUnitFilter]] as an argument. Do not use a [filter] tag. All units matching this filter are petrified. Recall list units are included.<br /> <br /> === [unpetrify] ===<br /> * [[StandardUnitFilter]] as an argument. {{DevFeature1.9}}: Do not use a [filter] tag. All units matching this filter are unpetrified {{DevFeature1.9}}: recall list units included.<br /> <br /> === [object] ===<br /> Gives some unit an object and removes all items on the tile the unit is on.<br /> * '''id''': (Optional) when the object is picked up, a flag is set for ''id''. The object cannot be picked up if a flag for ''id'' has been set. This means that any object with an id can only be used once, even if first_time_only=no is set for the event. This restriction is per level. In a campaign objects with the same id can be assigned once per level.<br /> * '''[effect]''': one or more effect elements may be listed. See [[EffectWML]] for a description of [effect].<br /> * '''duration''': if 'level', effects only last until the end of the level (note : 'level' is the scenario, so this doesn't mean it last until the unit levels-up).<br /> * '''[filter]''' with a [[StandardUnitFilter]] as argument. The first unit found that matches the filter will be given the object. If no unit matches the filter, then a message is displayed and the object is not removed.<br /> * '''[then]''': a subtag that lets you execute actions if the filter conditions are met. The most common action that should be inside here is a '''[removeitem]''' tag, but you could probably put any tags that otherwise work in a [then] tag.<br /> * '''silent''': whether or not messages should be suppressed. Default is &quot;no&quot;.<br /> * '''image''': the displayed image of the object.<br /> * '''name''': (translatable) displayed as a caption of the image.<br /> <br /> * '''description''': (translatable) displayed as a message of the image.<br /> * '''cannot_use_message''': (translatable) displayed instead of '''description''' if no unit passes the filter test.<br /> * If you do not supply a filter, the object action will be applied to a unit at the location of the moveto event. Currently this isn't recommended as it is not clear that this will continue working this way. Instead it is better to explicitly include a location filter.<br /> * The object action does not act on units in the recall list. There is a feature request in to allow this, but it is not clear whether or not it will be accepted.<br /> <br /> === [remove_shroud] ===<br /> Removes some shroud from the map for a certain side (only relevant for sides that have shroud=yes).<br /> * '''side''': (default=1) the side for which to remove shroud. {{DevFeature1.9}} takes a comma-separated list as of 1.9.5.<br /> * '''[filter_side]''' {{DevFeature1.9}} with a [[StandardSideFilter]] as argument<br /> * [[StandardLocationFilter]]: the range of tiles for which shroud should be removed<br /> <br /> === [place_shroud] ===<br /> Places some shroud on the map for a certain side (only relevant for sides that have shroud=yes).<br /> * '''side''': (default=1) the side for which to place shroud. {{DevFeature1.9}} takes a comma-separated list as of 1.9.5.<br /> * '''[filter_side]''' {{DevFeature1.9}} with a [[StandardSideFilter]] as argument<br /> * [[StandardLocationFilter]]: the range of tiles on which shroud should be placed<br /> <br /> === [allow_undo] ===<br /> Allows the player to undo the event that this tag is inside. Has an effect only inside moveto events. If the move is undone, only the position of the unit will be restored; any altered variables or changes to the game will remain changed after the move is undone. It is up to the scenario designer to avoid abusing this command.<br /> * Technically, if '''[allow_undo]''' is inside an '''[event]''' with ''first_time_only=yes'' (the default setting), and the user undoes the event, then the state of the game has changed in this way: the event will not fire a second time, even though the user undid the move the first time.<br /> <br /> === [heal_unit] ===<br /> Heal a unit. The variable '''$heal_amount''' will be set to the exact number of points healed (i.e can be lesser than the parameter '''amount''' if the unit is fully healed). {{DevFeature1.9}} $heal_amount contains only the number of hitpoints the first unit that was found got healed (no change, actually).<br /> * '''[filter]''': [[StandardUnitFilter]] the first unit matching the filter will be healed. If no filter is supplied, it is tried to take the unit at $x1, $y1. {{DevFeature1.9}} All matching on-map units are healed.<br /> * '''[filter_second]''': [[StandardUnitFilter]] all the units matching the filter ''and'' having the ''heals'' ability will have their animation played (if ''animate'' is set to true) {{DevFeature1.9}}...for each of the units healed.<br /> * '''amount''': (integer, default full) the maximum points the unit(s) will be healed. Can't set below 1 or above max_hitpoints. If &quot;full&quot;, sets hitpoints to max_hitpoints. Before 1.9 the default is 0.<br /> * '''animate''': a boolean which indicate if the healing animations must be played. (default no)<br /> * '''moves''': {{DevFeature1.9}} (integer, default 0) The maximum current movement points the units will be &quot;healed&quot;. Can't set below 0 or above max_moves. If &quot;full&quot;, sets moves to max_moves.<br /> * '''restore_attacks''': {{DevFeature1.9}} (boolean, default no) Whether the units' attacks_left should be reset to their max_attacks (usually 1).<br /> * '''restore_statuses''': {{DevFeature1.9}} (boolean, default yes) Whether standard statuses should be reset to &quot;no&quot;. This affects poisoned, slowed, petrified and unhealable. Before 1.9 this is always &quot;no&quot;.<br /> <br /> === [harm_unit] ===<br /> {{DevFeature1.9}}Harms every unit matching the filter, for the specific damage amount.<br /> * '''[filter]''': [[StandardUnitFilter]] all matching units will be harmed (required).<br /> * '''[filter_second]''': [[StandardUnitFilter]] if present, the first matching unit will attack all the units matching the filter above.<br /> * '''amount''': the amount of damage that will be done (required).<br /> * '''alignment''': (default neutral) applies an alignment to the damage, this means that if alignment=chaotic, the damage will be increased at night and reduced at day.<br /> * '''damage_type''': if present, amount will be altered by unit resistance to the damage type specified.<br /> * '''kill''': (default yes) if yes, when an harmed unit goes to or below 0 HP, it is killed; if no its HP are set to 1.<br /> * '''fire_event''': (default no) if yes, when a unit is killed by harming, the corresponding events are fired.<br /> * '''animate''': (default no) if yes, scrolls to each unit before harming it and plays its defense (or attack, if it's the harmer) and death animations. Special values supported, other than the usual yes and no, are &quot;attacker&quot;, that means only the harmer will be animated, and &quot;defender&quot;, that means only the harmed units will be animated.<br /> * '''[primary_attack], [secondary_attack]''': both set the weapon against which the unit harmed will defend, and that the harming unit will use to attack, to allow playing specific defense and attack animations. Both take a weapon filter as argument, see [[FilterWML]].<br /> * '''delay''': if animate=yes, sets the delay (in milliseconds, default 500) between each unit harming.<br /> * '''variable''': if present, the damage caused to the unit, altered by resistances, will be stored in a WML array with the given name, under the &quot;harm_amount&quot; key.<br /> * '''poisoned, slowed, petrified, unhealable''': (default no) if yes, every harmed unit that doesn't already have such status will have it set.<br /> * '''experience''': if yes, and there is an harmer, experience will be attributed like in regular combat.<br /> <br /> === [time_area] ===<br /> How a day should progress in a given area. Everywhere not specified in a [time_area] tag is affected by the [time] tags in the [scenario] tag.<br /> * [[StandardLocationFilter]]: the locations to affect. ''note: only for [event][time_area]s - at scenario toplevel [time_area] does not support [[StandardLocationFilter]], only location ranges''<br /> * [[TimeWML]]: the new schedule.<br /> * '''id''': an unique identifier assigned to a time_area. Optional, unless you want to remove the time_area later. Can be a comma-separated list when removing time_areas, see below.<br /> * '''remove''': (boolean) yes/no value. Indicates whether the specified time_area should be removed. Requires an identifier. If no identifier is used, however, all time_areas are removed.<br /> <br /> === [end_turn] ===<br /> End the current side's turn. {{DevFeature}} The current event is finished before the turn is ended. Also, if the current event (where the tag appears) has been fired by another event, that event (and the complete stack of other possible parent events) is ended before [end_turn] comes into affect. Also, events following the event stack that fired [end_turn] are not omitted (e.g. [end_turn] is used by a side turn event and a turn refresh event does something afterwards).<br /> <br /> === [replace_map] ===<br /> <br /> Replaces the entire map.<br /> * '''map''': Content of a wesnoth map file. example:<br /> map=&quot;{campaigns/Heir_To_The_Throne/maps/01_The_Elves_Besieged.map}&quot;<br /> * '''expand''': if 'yes', allows the map size to increase. The expansion direction is currently always bottom-right.<br /> * '''shrink''': if 'yes', allows the map size to decrease. If the map size is reduced, any units that would no longer be on the map due to its coordinates no longer existing will be put into the recall list.<br /> <br /> === [replace_schedule] ===<br /> Replace the time of day schedule of the entire scenario. {{DevFeature1.9}}<br /> * [[TimeWML]]: the new schedule.<br /> <br /> === [tunnel] ===<br /> <br /> {{DevFeature1.9}}<br /> <br /> Create a tunnel between some locations, later usable by units to move from source hex to target hex (using the movement cost of unit on the target terrain). ([http://forums.wesnoth.org/viewtopic.php?f=21&amp;t=14749&amp;p=405667&amp;hilit=tunnel#p405667 source])<br /> <br /> * '''id''' identifier for the tunnel, to allow removing (optional).<br /> * '''remove''': (boolean) yes/no value. If yes, removes all defined tunnels with the same ID (then only id= is necessary). (default: no)<br /> * '''bidirectional''': (boolean) if yes, creates also a tunnel in the other direction. (default: yes)<br /> * '''always_visible''': (boolean) if yes, the possible movement of enemies under fog can be seen. (default: no)<br /> * '''[source]''': [[StandardLocationFilter]] the source hex(es) (required).<br /> * '''[target]''': [[StandardLocationFilter]] the target hex(es) (required).<br /> * '''[filter]''': [[StandardUnitFilter]] the units which can use the tunnel (required). Leave empty for &quot;all units&quot;.<br /> <br /> (Note: The tunnel tag can also be used inside the [[AbilitiesWML|[teleport]]] ability, without remove= and id=).<br /> <br /> == Useful Macros ==<br /> There are some predefined macros that you find useful for direct actions. You can find a complete list along with a detailed explanation of how they work [http://www.wesnoth.org/macro-reference.xhtml here].<br /> * '''{MOVE_UNIT}''': Moves a unit to another location in the map and the player sees the movement (unlike [teleport])<br /> * '''{FULL_HEAL}''': Brings a unit to full HP<br /> * '''{LOYAL_UNIT}''': Create a loyal unit<br /> * '''{MODIFY_TERRAIN_MASK}''': Modify an area of terrain<br /> <br /> == See Also ==<br /> <br /> * [[InternalActionsWML]]<br /> * [[InterfaceActionsWML]]<br /> * [[EventWML]]<br /> * [[ReferenceWML]]<br /> <br /> [[Category: WML Reference]]<br /> [[Category: ActionsWML]]</div>

Gambit https://wiki.wesnoth.org/index.php?title=Wesnoth_Acronyms_and_Slang&diff=43388 2011-08-14T20:43:31Z

<p>Gambit: /* General Acronyms */ &quot;god&quot; is a common noun. They are exclaiming to whatever god(s) they personally believe in.</p> <hr /> <div>Use the following list to demystify the various (mostly wesnoth specific) acronyms you may run into at the forum.<br /> <br /> &lt;!-- NOTE TO EDITORS: Please try to keep an alphabetic order to simplify manual searching --&gt;<br /> <br /> == Names of Mainline Campaigns and Scenarios ==<br /> <br /> *AoI - &quot;An Orcish Incursion&quot;<br /> *DiD - &quot;Descent into Darkness&quot;<br /> *DM - &quot;Delfador's Memoirs&quot;<br /> *EI - &quot;The Eastern Invasion&quot;<br /> *HttT - &quot;Heir to the Throne&quot;<br /> ** BoP - &quot;Bay of Pearls&quot;<br /> ** DD - &quot;Dwarven Doors&quot;<br /> ** HotNE - &quot;Home of the North Elves&quot;<br /> ** IotD - &quot;Isle of the Damned&quot;<br /> ** RtW - &quot;Return to Wesnoth&quot;<br /> ** SoE - &quot;Siege of Elensefar&quot;<br /> ** SoF - &quot;Scepter of Fire&quot;<br /> ** TotC - &quot;Test of the Clans&quot;<br /> ** VoD - &quot;Valley of Death&quot;<br /> *LoW - &quot;Legend of Wesmere&quot;<br /> *NR - &quot;Northern Rebirth&quot;<br /> *SoF - &quot;Sceptre of Fire&quot;<br /> *SotBE - &quot;Son of the Black Eye&quot;<br /> *TB - &quot;A Tale of Two Brothers&quot;<br /> *THoT - &quot;The Hammer of Thursagan&quot;<br /> *TRoW - &quot;The Rise of Wesnoth&quot;<br /> *TSG - &quot;The South Guard&quot;<br /> *UtBS - &quot;Under the Burning Suns&quot;<br /> <br /> == Unofficial Campaigns ==<br /> <br /> *FtF - &quot;Flight to Freedom&quot; (campaign name)<br /> *IftU - &quot;Invasion from the Unknown&quot; (campaign name)<br /> *SE - &quot;Saving Elensefar&quot; (campaign name)<br /> <br /> <br /> == Unit Names ==<br /> <br /> *bird - usually Gryphon Rider/Master (knaglans), or occasionally a Falcon or Eagle Rider from the [[Extended Era]] Aragwaith and Kalifa factions.<br /> *DA - Dark Adept (undead)<br /> *fish - Merman (loyalists or rebels) or Naga Fighter (northerners)<br /> * frog - a Saurian, especially &quot;magic frog&quot; for an Augur<br /> *gobo - An affectionate, if somewhat derogatory term for the Goblin Spearman<br /> *gunner - Dwarvish Thunderer/Thunderguard/Dragonguard (knaglans)<br /> *HI - Heavy Infantryman (loyalists)<br /> *MoL - Mage of Light (loyalists or rebels)<br /> *pyro - Unit in the Drake Burner line<br /> *Ulf - Dwarvish Ulfserker (knaglans)<br /> *WC - Walking Corpse (undead)<br /> *zombie - Walking Corpse<br /> <br /> == Other, Wesnoth-specific ==<br /> <br /> *AMLA - After Maximum Level Advancement<br /> *AoH - Age of Heroes<br /> *BfM - Battle for Meridia<br /> *BfW - Battle for Wesnoth (the name of the game)<br /> *BWH - Been suggested before. We think it's a good idea. Hope to add it eventually.<br /> *CABD - Can Already Be Done, e.g., you can already create custom unit abilities via WML.<br /> *CtH - Chance to Hit (also C2H)<br /> *CtBH - Chance to Be Hit (also C2BH)<br /> *CtK - Chance to Kill (also C2K)<br /> *CtBK - Chance to Be Killed (also C2BK)<br /> *EP - Elvish Pillager, moderator and great man :) at forum<br /> *FoW - Fog of War (i.e. fog)<br /> *FFA - Free For All (playing a map with &gt;2 players without teams)<br /> *FPI - Frequently Posted Idea (read the [http://www.wesnoth.org/forum/viewtopic.php?t=1158|FPI Post] from the Ideas Forum)<br /> *HANE—EtH - Hexes Are Not Evil - Embrace the Hex<br /> *HAPMA - Hexes Are Possibly Miles Across<br /> *HP - Hit points<br /> *IIRWIIR - It Is Ready When It Is Ready<br /> *KISS - Keep It Simple, Stupid: Applies to coding, not game rules (although indirectly it does): see [[WesnothPhilosophy]]<br /> *MP - Multiplayer or Movement Points<br /> *N3T - No 3-Teams; A belief stating that contests between three equal and opposing forces are inherently unbalanced<br /> *OAB - Options Are Bad; In reference to gameplay, not user interface options. Mostly used by Turin. See also [[FrequentlyProposedIdeas]] (idea #1)<br /> *OFWRA - Old Flame War Revival Alert; In other words, we have discussed this before and have no interest in discussing it again, especially if it got ugly<br /> * OOS - Out Of Synch - an error generated by Wesnoth. OOS errors occur when game data for one player is different/incompatible from the others<br /> * PoD - Paths of Daggers, the name of a 2v2 multiplayer map.<br /> *RiPLIB - Reduction in Power when Levelling Is Bad: means that when a unit upgrades, at least one of its options should be strictly superior to the original unit. [http://www.wesnoth.org/forum/viewtopic.php?t=1423 Reference 1] / [http://www.wesnoth.org/forum/viewtopic.php?t=7205 Reference 2]<br /> *RPG - Role Playing Game - [http://www.wesnoth.org/forum/viewtopic.php?t=4385 1)] Wesnoth's experience system. &lt;nowiki&gt;2)&lt;/nowiki&gt; An &quot;RPG-style&quot; game on the MP server means the primary focus will be walking your leader-units through a scripted storyline involving map exploration and lots of WML.<br /> *SLF - [[StandardLocationFilter]]<br /> *SP - Single Player (Campaigns)<br /> *SUF - [[StandardUnitFilter]]<br /> *ToD - Time of Day<br /> *TWP - The Wesnoth Philosophy: [[WesnothPhilosophy]]<br /> *UAPEB -Units Are Possibly Entire Battalions<br /> *UMC - User Made Campaign or User Made Content (any add-on not packaged with Wesnoth)<br /> *WICOT - WML is capable of this (the requested feature is already possible to script, so no need to hard-code it in C++)<br /> *WINR - Wesnoth Is Not Realistic<br /> *WIN_ - Wesnoth Is Not... (Warcraft, Lord of the Rings, medieval Europe, an RPG, a wargame, a war simulation, etc.)<br /> *WML - Wesnoth Markup Language: [[ReferenceWML]]<br /> *XP - Experience<br /> *ZoC - Zone of Control<br /> <br /> == General Acronyms ==<br /> <br /> *AFaICT - As Far as I Can Tell (A statement with a disclaimer on truthfulness)<br /> *AFaIK - As Far as I Know (A statement with a disclaimer on truthfulness)<br /> *AfK - Away from the Keyboard<br /> *AI - Artificial Intelligence (An 'AI side' is a side controlled by the computer)<br /> *ASaP - As Soon as Possible<br /> *BRB - Be Right Back<br /> *BtW - By the Way (A statement with a disclaimer on relevance)<br /> *EV - Expected Value<br /> *FYI - For Your Information<br /> *GtG - Got to Go<br /> *IIRC - If I Recall Correctly (A statement with a disclaimer on truthfulness)<br /> *IMHO - In My Humble Opinion (A statement with a disclaimer on objectiveness)<br /> *IMO - In My Opinion<br /> *IYSWIM - If You See What I Mean (A statement seeking agreement)<br /> *LTNS - Long Time No See<br /> *OMG - oh my god(s)<br /> *OT - Off Topic: can refer either to the forum category (http://www.wesnoth.org/forum/viewforum.php?f=11) or to spam<br /> *OtOH - On the Other Hand (A contrast)<br /> *QFT - Quote For Truth<br /> *RotFL - Rolling on the Floor Laughing; also RoFL<br /> *RNG - Random Number Generator<br /> *RtFM - Read the F***ing Manual<br /> *RTS - Real Time Strategy Game - as opposed to a turn-based game like Wesnoth<br /> *SVN - Subversion -- the bleeding-edge up-to-the-minute current version of Wesnoth [[WesnothSVN]] ([[What_Is_SVN]])<br /> *TBS - Turn Based Strategy Game, like Wesnoth<br /> <br /> [[Category:World of Wesnoth]]</div>

Gambit https://wiki.wesnoth.org/index.php?title=DirectActionsWML&diff=40825 2011-03-16T15:30:18Z

<p>Gambit: /* [remove_shroud] */ Updated with information about patch #1887</p> <hr /> <div>{{WML Tags}}<br /> == Direct actions ==<br /> <br /> Direct actions are actions that have a direct effect on gameplay. They can be used inside of [[EventWML|events]].<br /> <br /> The following tags are actions:<br /> <br /> === [endlevel] ===<br /> Ends the scenario.<br /> * '''result''': before the scenario is over, all events with ''name=result'' are triggered. The message ''result_message'' with the heading ''result_heading'' (see [[LanguageWML]]) are displayed. If ''result=victory'', the player progresses to the next level; if ''result=defeat'', the game returns to the main menu. These last two are rarely used: ''result=continue'' behaves identically to ''result=victory'' except the player's gold is not reduced to 80%, and it does not bring up a &quot;Victory&quot; message or the gold changing message (since it doesn't change); ''result=continue_no_save'' works similarly, except the player is not asked whether to save the game, and is taken directly to the next scenario without any messages. {{DevFeature}}: All values for result=... except victory and defeat are being discarded in favor of modifying '''[endlevel]''' behaviour with single keys.<br /> Unless ''result=defeat'', the following keys can also be used:<br /> * '''bonus''': whether the player should get bonus gold (maximum possible gold that could have been earned by waiting the level out). The default is bonus=yes.<br /> * '''carryover_report''': whether the player should receive a summary of the scenario outcome, the default is carryover_report=yes.<br /> * '''save''': whether a start-of-scenario save should be created for the next scenario, the default is save=yes. Do not confuse this with saving of replays for the current scenario.<br /> * '''linger_mode''': If ...=yes, the screen is greyed out and there's the possibility to save before advancing to the next scenario, the default is linger_mode=yes.<br /> * '''reveal_map''': (Multiplayer only) (Default is 'yes') If 'no', shroud doesn't disappear when game ended. {{DevFeature1.9}}<br /> * '''next_scenario''': (default specified in '''[scenario]''' tag) the ID of the next scenario that should be played. All units that side 1 controls at this point become available for recall in ''next_scenario''.<br /> <br /> When the result is &quot;victory&quot; the following keys can be used:<br /> * '''carryover_percentage''': by default 80% of the gold is carried over to the next scenario, with this key the amount can be changed.<br /> * '''carryover_add''': if true the gold will be added to the starting gold the next scenario, if false the next scenario will start with the amount of the current scenario (after taxes) or the minimum in the next scenario. Default is false.<br /> * '''music''': (default specified in '''[scenario]''' or '''[game_config]''' tags) a comma-separated list of music tracks from which one will be chosen and played once after any events related to the end of level result are executed; by default, victory_music is used on victory, and defeat_music on defeat.<br /> * '''end_text''': Text that is shown centered in a black screen at the end of a campaign. Defaults to &quot;The End&quot;. Note that this has cumulative effects over the campaign - it persists even if the endlevel does not trigger the end of the campaign. See also [[CampaignWML]].<br /> * '''end_text_duration''': Delay, in milliseconds, before displaying the game credits at the end of a campaign. In other words, for how much time '''end_text''' is displayed on screen. Defaults to 3500. Note that this has cumulative effects over the campaign - it persists even if the endlevel does not trigger the end of the campaign. See also [[CampaignWML]].<br /> <br /> === [unit] ===<br /> Places a unit on the map. For syntax see [[SingleUnitWML]].<br /> * {{Short Note:Predefined Macro|GENERIC_UNIT}}<br /> * '''to_variable''': spawn directly into a variable instead of on the map.<br /> <br /> === [recall] ===<br /> Recalls a unit. The unit is recalled free of charge, and is placed near the leader.<br /> * [[StandardUnitFilter]]: the first matching unit will be recalled. If no units match this tag is ignored. Do not use a [filter] tag. If a comma separated list is given, every unit currently considered for recall is checked against all the types (not each single one of the types against all units).<br /> * '''x,y''': the unit is placed here instead of next to the leader.<br /> * '''show''': yes/no, default yes: whether the unit is animated (faded in) or instantly displayed<br /> * '''fire_event''': {{DevFeature1.9}} boolean yes|no (default no); whether any according prerecall or recall events shall be fired. In pre-1.9.3 these events are all automatically fired and it can't be turned off.<br /> <br /> === [teleport] ===<br /> Teleports a unit on map. {{Short Note:Predefined Macro|TELEPORT_UNIT}}<br /> * '''[filter]''': [[StandardUnitFilter]] the first unit matching this filter will be teleported.<br /> * '''x,y''': the position to teleport to.<br /> * '''clear_shroud''': should shroud be cleared on arrival<br /> * '''animate''': should a teleport animation be played (if the unit doesn't have a teleport animation, it will fade out/fade in)<br /> * '''ignore_passability''': {{DevFeature}} normally, units will not be teleported into terrain that is impassable for them. Setting this attribute to &quot;yes&quot; permits it. {{DevFeature1.9}}Renamed to check_passability (default yes).<br /> <br /> (Note: There is also a ability named teleport, see [[AbilitiesWML]].)<br /> <br /> === [terrain_mask] ===<br /> Changes the terrain on the map. See [[TerrainMaskWML]].<br /> <br /> === [terrain] ===<br /> Changes the terrain on the map.<br /> * '''terrain''': the character of the terrain to use. See [[TerrainCodesWML]] to see what letter a type of terrain uses.<br /> * '''x,y''': the position (or range of positions) to change. {{DevFeature1.9}}: [terrain] accepts a [[StandardLocationFilter]]. This [[StandardLocationFilter]]'s terrain= key is used for the new terrain, filtering by terrain can be done with a nested [[StandardLocationFilter]]: [and]terrain=terrain_string_to_be_filtered_for.<br /> * '''layer''': (overlay|base|both, default=both) only change the specified layer.<br /> * '''replace_if_failed''': (default=no) When replacing just one layer failed, try to replace the whole terrain. If '''terrain''' is an overlay only terrain, use the default_base as base layer. If the terrain has no default base, do nothing.<br /> <br /> === [gold] ===<br /> Gives one side gold.<br /> * '''amount''': the amount of gold to give.<br /> * '''side''': (default=1) the number of the side to give the gold to.<br /> * side will default to all sides after 1.9.5's release. {{DevFeature1.9}}<br /> <br /> === [unstore_unit] ===<br /> Creates a unit from a game variable, and activates it on the playing field. This must be a specific variable describing a unit, and may not be an array -- to unstore an entire array, iterate over it. The variable is not cleared. See also [[InternalActionsWML#.5Bstore_unit.5D|[store_unit]]], [[ConditionalActionsWML#.5Bwhile.5D|[while]]] and [[InternalActionsWML#.5Bclear_variable.5D|[clear_variable]]]. Note units with a negative amount of hitpoints will be unstored with 1 hitpoint.<br /> * '''variable''': the name of the variable.<br /> * '''find_vacant''': whether the unit should be placed on the nearest vacant tile to its specified location. If this is set to 'no'(default), then any unit on the same tile as the unit being unstored will be destroyed. <br /> * '''check_passability''': {{DevFeature1.9}} (boolean yes|no, default yes): If yes, checks for terrain passability when placing the unit. This key has no effect if find_vacant=no (no check performed then). Before 1.9 this key is always &quot;no&quot;.<br /> * '''text''': (translatable) floating text to display above the unit, such as a damage amount<br /> * '''red''', '''green''', '''blue''': (default=0,0,0) the color to display the text in. Values vary from 0-255. You may find it convenient to use the {COLOR_HARM} or {COLOR_HEAL} macro instead. (Use {COLOR_HARM} or {COLOR_HEAL} instead of the whole red,green,blue= line.)<br /> * '''advance''': (default=true) if true the unit is advanced if it has enough XP. When modifying XP make sure to do it from inside a [[EventWML#Multiplayer_safety|synchronized event]] or it may lead to OOS errors especially when several advancement paths exist. Note that advance and post advance events are called, so infinite loops can happen.<br /> * '''fire_event''': {{DevFeature1.9}}(boolean yes|no, default no) Whether any advance/post advance events shall be fired if an advancement takes place, no effect otherwise. Before 1.9 this is always &quot;yes&quot;.<br /> * '''x''' ,'''y''': override unit location, &quot;x,y=recall, recall&quot; will put the unit on the unit's side's recall list.<br /> <br /> === [allow_recruit] ===<br /> Allows a side to recruit units it couldn't previously recruit.<br /> * '''type''': the types of units that the side can now recruit.<br /> * '''side''': (default=1) the number of the side that is being allowed to recruit the units {{DevFeature1.9}} side= can be a comma-separated list<br /> <br /> === [disallow_recruit] ===<br /> Prevents a side from recruiting units it could previously recruit.<br /> * '''type''': the types of units that the side can no longer recruit.<br /> * '''side''': (default=1) the number of the side that may no longer recruit the units. {{DevFeature1.9}} side= can be a comma-separated list<br /> <br /> === [set_recruit] ===<br /> Sets the units a side can recruit.<br /> ** '''recruit''': the types of units that the side can now recruit.<br /> ** '''side''': (default=1) the number of the side that is having its recruitment set. {{DevFeature1.9}} side= can be a comma-separated list<br /> === [modify_side] ===<br /> Modifies some details of a given side in the middle of a scenario. '''The following listed properties are the only properties that [modify_side] can affect!'''<br /> * '''side''': (default=1) the number of the side that is to be changed.<br /> * '''income''': the income given at the begining of each turn.<br /> * '''team_name''': the team in which the side plays the scenario.<br /> * '''user_team_name''': a translatable string representing the team's description. This has no effect on alliances. Defaults to ''team_name''.<br /> * '''gold''': the amount of gold the side owns.<br /> * '''village_gold''': the income setting per village for the side.<br /> * '''controller''': the identifier string of the side's controller. Uses the same syntax of the ''controller'' key in the [[SideWML|[side]]] tag.<br /> * '''fog''': a boolean string (yes/no) describing the status of Fog for the side.<br /> * '''shroud''': a boolean string describing the status of Shroud for the side.<br /> * '''hidden''': a boolean string specifying whether side is shown in status table.<br /> * '''[ai]''': replaces a side's AI parameters with the new specified ones. Uses the same syntax described in [[AiWML]].<br /> * '''switch_ai''': {{DevFeature}} replaces a side ai with a new AI from specified file(ignoring those AI parameters above). Path to file follows the usual WML convention.<br /> * '''share_maps''': {{DevFeature}} change the share_maps side attribute. Be sure to use shroud=yes for that side and have it as an ally<br /> * '''share_view''': {{DevFeature}} change the share_view side attribute. Be sure to use fog=yes for that side and have it as an ally<br /> <br /> === [modify_turns] ===<br /> Modifies the turn limit in the middle of a scenario.<br /> * '''value''': the new turn limit.<br /> * '''add''': if used instead of ''value'', specifies the number of turns to add to the current limit (can be negative).<br /> * '''current''': changes the current turn number after applying turn limit modifications, if any. It is possible to change the current turn number to a greater one than the current only; also, it is not possible to change the turn number to exceed the turn limit.<br /> <br /> === [capture_village] ===<br /> Changes the ownership of a village.<br /> * '''side''': the side that takes control of the village. This side needs to have a leader (canrecruit=yes). If the side key is not given, the village will become neutral.<br /> * '''x, y''': the location of the village. Can be a comma-separated list and/or location ranges. {{DevFeature1.9}}: [capture_village] accepts a full SLF; all village locations matching the filter are affected.<br /> <br /> === [kill] ===<br /> Removes all units (including units in a recall list) that match the filter from the game.<br /> * [[StandardUnitFilter]]: Selection criterion; do not use a [filter] tag.<br /> * '''animate''': if 'yes', displays the unit dying (fading away).<br /> * '''fire_event''': if 'yes', triggers any appropriate 'die' events (See [[EventWML]]). Note that any 'last breath' and 'die' events triggered by this are executed immediately, interrupting the current event and thus causing the x1, y1, x2, and y2 variables to be reset for that 'die' event, which in turn causes those variables to be invalid for the remainder of this event. In the stable version, the variable second_unit in each of these die and last breath events is always the same as the variable unit (the dying unit). Note that events are only fired for killed units that have been on the map (as opposed to recall list).<br /> * '''[secondary_unit]''' {{DevFeature1.9}} with a [[StandardUnitFilter]] as argument. Do not use a [filter] tag. Has an effect only if fire_event=yes. The first on-map unit matching the filter becomes second_unit in any fired die and last breath events. If an on-map unit matches and if there are several units killed with a single [kill] tag, second_unit is this same unit for all of them. If no on-map unit matches or [secondary_unit] isn't present, the variable second_unit in each of the die and last breath events is always the same as the variable unit (the dying unit).<br /> <br /> === [move_unit] ===<br /> {{DevFeature1.9}}; works like the MOVE_UNIT macro.<br /> * [[StandardUnitFilter]] as argument; do not use a [filter] tag. All units matching the filter are moved. If the target location is occupied, the nearest free passable location is chosen. All target locations passed (see below) need to be passable hexes for the particular moved units.<br /> * '''to_x''' (unsigned integer): The units are moved to this x coordinate. Can be a comma-separated list, in which case the unit follows this given path during the move.<br /> * '''to_y''' (unsigned integer): The units are moved to this y coordinate. Can be a comma-separated list.<br /> * '''fire_event''' (optional, boolean yes|no, default no): Whether any according moveto events shall be fired. The target location ($x1, $y1 in the event) may not be the same location that the unit was tried to be moved to, if the original target location is occupied or impassable.<br /> * '''check_passability''' (boolean yes|no, default yes): Whether the terrain the unit is moved to should be checked for suiting the unit. (If it does not, a nearby suitable hex is chosen.)<br /> <br /> === [modify_ai] ===<br /> Changes the AI for a specified side. See [[Customizing_AI_in_Wesnoth_1.8#.5Bmodify_ai.5D_tag]]<br /> <br /> === [modify_unit] ===<br /> {{DevFeature1.9}}; works similar to the MODIFY_UNIT macro.<br /> * '''[filter]''' with a [[StandardUnitFilter]] as argument. All units matching this filter are modified. Matches on recall list units too.<br /> * Accepts generally the syntax inside of wml unit variables created by [store_unit] which can be viewed in a savefile or by using the :inspect command. Can add traits with immediate effect. Cannot remove things. Subtags with the same name must be written in the correct order to match them with the tag they are supposed to modify.<br /> example usage (see also the test scenario):<br /> [modify_unit]<br /> [filter]<br /> type=Troll Rocklobber<br /> [/filter]<br /> hitpoints=10<br /> [modifications]<br /> [trait]<br /> # first trait is unmodified<br /> [/trait]<br /> {TRAIT_HEALTHY}# second trait is replaced with the healthy trait<br /> [/modifications]<br /> [/modify_unit]<br /> <br /> The unit which is currently modified is accessible via $this_unit, e.g. hitpoints = &quot;$($this_unit.hitpoints / 2)&quot; to set the hitpoints of all units to half of their particular maxima. This this_unit variable is independent from the this_unit variable available in the SUF used to determine which units to modify (first all matching units are gathered, and then all those are modified).<br /> <br /> note: The syntax allowed is somehow vage. Just try things and possibly correct/add/modify this documentation. (a [http://forums.wesnoth.org/viewtopic.php?f=21&amp;t=31676&amp; forum thread] discusses some related issues).<br /> <br /> === [transform_unit] ===<br /> {{DevFeature1.9}}; transforms every unit matching the filter to the given unit type. Keeps intact hitpoints, experience and status. If the unit is transformed to a non-living type (undead or mechanical), it will be also unpoisoned.<br /> * [[StandardUnitFilter]]: do not use a [filter] tag.<br /> * '''transform_to''': the unit type in which all the units matching the filter will be transformed. If missing, the units will follow their normal advancement.<br /> <br /> === [petrify] ===<br /> {{DevFeature1.9}}(This tag did never exist until r47553 (from 1.9.3 on), although it was already documented.)<br /> <br /> * [[StandardUnitFilter]] as an argument. Do not use a [filter] tag. All units matching this filter are petrified. Recall list units are included.<br /> <br /> === [unpetrify] ===<br /> * [[StandardUnitFilter]] as an argument. {{DevFeature1.9}}: Do not use a [filter] tag. All units matching this filter are unpetrified {{DevFeature1.9}}: recall list units included.<br /> <br /> === [object] ===<br /> Gives some unit an object and removes all items on the tile the unit is on.<br /> * '''id''': (Optional) when the object is picked up, a flag is set for ''id''. The object cannot be picked up if a flag for ''id'' has been set. This means that any object with an id can only be used once, even if first_time_only=no is set for the event. This restriction is per level. In a campaign objects with the same id can be assigned once per level.<br /> * '''[effect]''': one or more effect elements may be listed. See [[EffectWML]] for a description of [effect].<br /> * '''duration''': if 'level', effects only last until the end of the level (note : 'level' is the scenario, so this doesn't mean it last until the unit levels-up).<br /> * '''[filter]''' with a [[StandardUnitFilter]] as argument. The first unit found that matches the filter will be given the object. If no unit matches the filter, then a message is displayed and the object is not removed.<br /> * '''[then]''': a subtag that lets you execute actions if the filter conditions are met. The most common action that should be inside here is a '''[removeitem]''' tag, but you could probably put any tags that otherwise work in a [then] tag.<br /> * '''silent''': whether or not messages should be suppressed. Default is &quot;no&quot;.<br /> * '''image''': the displayed image of the object.<br /> * '''name''': (translatable) displayed as a caption of the image.<br /> <br /> * '''description''': (translatable) displayed as a message of the image.<br /> * '''cannot_use_message''': (translatable) displayed instead of '''description''' if no unit passes the filter test.<br /> * If you do not supply a filter, the object action will be applied to a unit at the location of the moveto event. Currently this isn't recommended as it is not clear that this will continue working this way. Instead it is better to explicitly include a location filter.<br /> * The object action does not act on units in the recall list. There is a feature request in to allow this, but it is not clear whether or not it will be accepted.<br /> <br /> === [remove_shroud] ===<br /> Removes some shroud from the map for a certain side (only relevant for sides that have shroud=yes).<br /> * '''side''': (default=1) the side for which to remove shroud.<br /> * [[StandardLocationFilter]]: the range of tiles for which shroud should be removed.<br /> * side will default to all sides after 1.9.5's release. {{DevFeature1.9}}<br /> <br /> === [place_shroud] ===<br /> Places some shroud on the map for a certain side (only relevant for sides that have shroud=yes).<br /> * '''side''': (default=1) the side for which to place shroud.<br /> * [[StandardLocationFilter]]: the range of tiles on which shroud should be placed.<br /> * side will default to all sides after 1.9.5's release. {{DevFeature1.9}}<br /> <br /> === [allow_undo] ===<br /> Allows the player to undo the event that this tag is inside. Has an effect only inside moveto events. If the move is undone, only the position of the unit will be restored; any altered variables or changes to the game will remain changed after the move is undone. It is up to the scenario designer to avoid abusing this command.<br /> * Technically, if '''[allow_undo]''' is inside an '''[event]''' with ''first_time_only=yes'' (the default setting), and the user undoes the event, then the state of the game has changed in this way: the event will not fire a second time, even though the user undid the move the first time.<br /> <br /> === [heal_unit] ===<br /> Heal a unit. The variable '''$heal_amount''' will be set to the exact number of points healed (i.e can be lesser than the parameter '''amount''' if the unit is fully healed).<br /> * '''[filter]''': [[StandardUnitFilter]] the first unit matching the filter will be healed.<br /> * '''[filter_second]''': [[StandardUnitFilter]] all the units matching the filter ''and'' having the ''heals'' ability will have their animation played (if ''animate'' is set to true).<br /> * '''amount''': the maximum points the unit will be healed.<br /> * '''animate''': a boolean which indicate if the healing animations must be played.<br /> <br /> === [harm_unit] ===<br /> {{DevFeature1.9}}Harms every unit matching the filter, for the specific damage amount.<br /> * '''[filter]''': [[StandardUnitFilter]] all matching units will be harmed (required).<br /> * '''amount''': the amount of damage that will be done (required).<br /> * '''alignment''': (default neutral) applies an alignment to the damage, this means that if alignment=chaotic, the damage will be increased at night and reduced at day.<br /> * '''damage_type''': if present, amount will be altered by unit resistance to the damage type specified.<br /> * '''kill''': (default yes) if yes, when an harmed unit goes to or below 0 HP, it is killed; if no its HP are set to 1.<br /> * '''fire_event''': (default no) if yes, when a unit is killed by harming, the corresponding events are fired.<br /> * '''animate''': (default no) if yes, scrolls to each unit before harming it and plays its defense and death animations.<br /> * '''[secondary_attack]''': sets the weapon against which the unit harmed will defend, to allow playing specific defense animations. Takes a weapon filter as argument, see [[FilterWML]].<br /> * '''delay''': if animate=yes, sets the delay (in milliseconds, default 500) between each unit harming.<br /> * '''variable''': if present, the damage caused to the unit, altered by resistances, will be stored in a WML array with the given name, under the &quot;harm_amount&quot; key.<br /> * '''poisoned, slowed, petrified, unhealable''': (default no) if yes, every harmed unit that doesn't already have such status will have it set.<br /> <br /> === [time_area] ===<br /> How a day should progress in a given area. Everywhere not specified in a [time_area] tag is affected by the [time] and [illuminated_time] tags in the [scenario] tag.<br /> * [[StandardLocationFilter]]: the locations to affect.<br /> * [[TimeWML]]: the new schedule.<br /> * '''id''': an unique identifier assigned to a time_area. Optional, unless you want to remove the time_area later. Can be a comma-separated list when removing time_areas, see below.<br /> * '''remove''': (boolean) yes/no value. Indicates whether the specified time_area should be removed. Requires an identifier. If no identifier is used, however, all time_areas are removed.<br /> <br /> === [end_turn] ===<br /> End the current side's turn. {{DevFeature}} The current event is finished before the turn is ended. Also, if the current event (where the tag appears) has been fired by another event, that event (and the complete stack of other possible parent events) is ended before [end_turn] comes into affect. Also, events following the event stack that fired [end_turn] are not omitted (e.g. [end_turn] is used by a side turn event and a turn refresh event does something afterwards).<br /> <br /> === [replace_map] ===<br /> <br /> Replaces the entire map.<br /> * '''map''': Content of a wesnoth map file. example:<br /> map=&quot;{campaigns/Heir_To_The_Throne/maps/01_The_Elves_Besieged.map}&quot;<br /> * '''expand''': if 'yes', allows the map size to increase. The expansion direction is currently always bottom-right.<br /> * '''shrink''': if 'yes', allows the map size to decrease. If the map size is reduced, any units that would no longer be on the map due to its coordinates no longer existing will be put into the recall list.<br /> <br /> === [replace_schedule] ===<br /> Replace the time of day schedule of the entire scenario. {{DevFeature1.9}}<br /> * [[TimeWML]]: the new schedule.<br /> <br /> === [tunnel] ===<br /> <br /> {{DevFeature1.9}}<br /> <br /> Create a tunnel between some locations, later usable by units to move from source hex to target hex (using the movement cost of unit on the target terrain). ([http://forums.wesnoth.org/viewtopic.php?f=21&amp;t=14749&amp;p=405667&amp;hilit=tunnel#p405667 source])<br /> <br /> * '''id''' identifier for the tunnel, to allow removing (optional).<br /> * '''remove''': (boolean) yes/no value. If yes, removes all defined tunnels with the same ID (then only id= is necessary). (default: no)<br /> * '''bidirectional''': (boolean) if yes, creates also a tunnel in the other direction. (default: yes)<br /> * '''always_visible''': (boolean) if yes, the possible movement of enemies under fog can be seen. (default: no)<br /> * '''[source]''': [[StandardLocationFilter]] the source hex(es) (required).<br /> * '''[target]''': [[StandardLocationFilter]] the target hex(es) (required).<br /> * '''[filter]''': [[StandardUnitFilter]] the units which can use the tunnel (required). Leave empty for &quot;all units&quot;.<br /> <br /> (Note: The tunnel tag can also be used inside the [[AbilitiesWML|[teleport]]] ability, without remove= and id=).<br /> <br /> == Useful Macros ==<br /> There are some predefined macros that you find useful for direct actions. You can find a complete list along with a detailed explanation of how they work [http://www.wesnoth.org/macro-reference.xhtml here].<br /> * '''{MOVE_UNIT}''': Moves a unit to another location in the map and the player sees the movement (unlike [teleport])<br /> * '''{FULL_HEAL}''': Brings a unit to full HP<br /> * '''{LOYAL_UNIT}''': Create a loyal unit<br /> * '''{MODIFY_TERRAIN_MASK}''': Modify an area of terrain<br /> <br /> == See Also ==<br /> <br /> * [[InternalActionsWML]]<br /> * [[InterfaceActionsWML]]<br /> * [[EventWML]]<br /> * [[ReferenceWML]]<br /> <br /> [[Category: WML Reference]]<br /> [[Category: ActionsWML]]</div>

Gambit https://wiki.wesnoth.org/index.php?title=DirectActionsWML&diff=40824 2011-03-16T15:29:41Z

<p>Gambit: /* [place_shroud] */ Updated with information about patch #1887</p> <hr /> <div>{{WML Tags}}<br /> == Direct actions ==<br /> <br /> Direct actions are actions that have a direct effect on gameplay. They can be used inside of [[EventWML|events]].<br /> <br /> The following tags are actions:<br /> <br /> === [endlevel] ===<br /> Ends the scenario.<br /> * '''result''': before the scenario is over, all events with ''name=result'' are triggered. The message ''result_message'' with the heading ''result_heading'' (see [[LanguageWML]]) are displayed. If ''result=victory'', the player progresses to the next level; if ''result=defeat'', the game returns to the main menu. These last two are rarely used: ''result=continue'' behaves identically to ''result=victory'' except the player's gold is not reduced to 80%, and it does not bring up a &quot;Victory&quot; message or the gold changing message (since it doesn't change); ''result=continue_no_save'' works similarly, except the player is not asked whether to save the game, and is taken directly to the next scenario without any messages. {{DevFeature}}: All values for result=... except victory and defeat are being discarded in favor of modifying '''[endlevel]''' behaviour with single keys.<br /> Unless ''result=defeat'', the following keys can also be used:<br /> * '''bonus''': whether the player should get bonus gold (maximum possible gold that could have been earned by waiting the level out). The default is bonus=yes.<br /> * '''carryover_report''': whether the player should receive a summary of the scenario outcome, the default is carryover_report=yes.<br /> * '''save''': whether a start-of-scenario save should be created for the next scenario, the default is save=yes. Do not confuse this with saving of replays for the current scenario.<br /> * '''linger_mode''': If ...=yes, the screen is greyed out and there's the possibility to save before advancing to the next scenario, the default is linger_mode=yes.<br /> * '''reveal_map''': (Multiplayer only) (Default is 'yes') If 'no', shroud doesn't disappear when game ended. {{DevFeature1.9}}<br /> * '''next_scenario''': (default specified in '''[scenario]''' tag) the ID of the next scenario that should be played. All units that side 1 controls at this point become available for recall in ''next_scenario''.<br /> <br /> When the result is &quot;victory&quot; the following keys can be used:<br /> * '''carryover_percentage''': by default 80% of the gold is carried over to the next scenario, with this key the amount can be changed.<br /> * '''carryover_add''': if true the gold will be added to the starting gold the next scenario, if false the next scenario will start with the amount of the current scenario (after taxes) or the minimum in the next scenario. Default is false.<br /> * '''music''': (default specified in '''[scenario]''' or '''[game_config]''' tags) a comma-separated list of music tracks from which one will be chosen and played once after any events related to the end of level result are executed; by default, victory_music is used on victory, and defeat_music on defeat.<br /> * '''end_text''': Text that is shown centered in a black screen at the end of a campaign. Defaults to &quot;The End&quot;. Note that this has cumulative effects over the campaign - it persists even if the endlevel does not trigger the end of the campaign. See also [[CampaignWML]].<br /> * '''end_text_duration''': Delay, in milliseconds, before displaying the game credits at the end of a campaign. In other words, for how much time '''end_text''' is displayed on screen. Defaults to 3500. Note that this has cumulative effects over the campaign - it persists even if the endlevel does not trigger the end of the campaign. See also [[CampaignWML]].<br /> <br /> === [unit] ===<br /> Places a unit on the map. For syntax see [[SingleUnitWML]].<br /> * {{Short Note:Predefined Macro|GENERIC_UNIT}}<br /> * '''to_variable''': spawn directly into a variable instead of on the map.<br /> <br /> === [recall] ===<br /> Recalls a unit. The unit is recalled free of charge, and is placed near the leader.<br /> * [[StandardUnitFilter]]: the first matching unit will be recalled. If no units match this tag is ignored. Do not use a [filter] tag. If a comma separated list is given, every unit currently considered for recall is checked against all the types (not each single one of the types against all units).<br /> * '''x,y''': the unit is placed here instead of next to the leader.<br /> * '''show''': yes/no, default yes: whether the unit is animated (faded in) or instantly displayed<br /> * '''fire_event''': {{DevFeature1.9}} boolean yes|no (default no); whether any according prerecall or recall events shall be fired. In pre-1.9.3 these events are all automatically fired and it can't be turned off.<br /> <br /> === [teleport] ===<br /> Teleports a unit on map. {{Short Note:Predefined Macro|TELEPORT_UNIT}}<br /> * '''[filter]''': [[StandardUnitFilter]] the first unit matching this filter will be teleported.<br /> * '''x,y''': the position to teleport to.<br /> * '''clear_shroud''': should shroud be cleared on arrival<br /> * '''animate''': should a teleport animation be played (if the unit doesn't have a teleport animation, it will fade out/fade in)<br /> * '''ignore_passability''': {{DevFeature}} normally, units will not be teleported into terrain that is impassable for them. Setting this attribute to &quot;yes&quot; permits it. {{DevFeature1.9}}Renamed to check_passability (default yes).<br /> <br /> (Note: There is also a ability named teleport, see [[AbilitiesWML]].)<br /> <br /> === [terrain_mask] ===<br /> Changes the terrain on the map. See [[TerrainMaskWML]].<br /> <br /> === [terrain] ===<br /> Changes the terrain on the map.<br /> * '''terrain''': the character of the terrain to use. See [[TerrainCodesWML]] to see what letter a type of terrain uses.<br /> * '''x,y''': the position (or range of positions) to change. {{DevFeature1.9}}: [terrain] accepts a [[StandardLocationFilter]]. This [[StandardLocationFilter]]'s terrain= key is used for the new terrain, filtering by terrain can be done with a nested [[StandardLocationFilter]]: [and]terrain=terrain_string_to_be_filtered_for.<br /> * '''layer''': (overlay|base|both, default=both) only change the specified layer.<br /> * '''replace_if_failed''': (default=no) When replacing just one layer failed, try to replace the whole terrain. If '''terrain''' is an overlay only terrain, use the default_base as base layer. If the terrain has no default base, do nothing.<br /> <br /> === [gold] ===<br /> Gives one side gold.<br /> * '''amount''': the amount of gold to give.<br /> * '''side''': (default=1) the number of the side to give the gold to.<br /> * side will default to all sides after 1.9.5's release. {{DevFeature1.9}}<br /> <br /> === [unstore_unit] ===<br /> Creates a unit from a game variable, and activates it on the playing field. This must be a specific variable describing a unit, and may not be an array -- to unstore an entire array, iterate over it. The variable is not cleared. See also [[InternalActionsWML#.5Bstore_unit.5D|[store_unit]]], [[ConditionalActionsWML#.5Bwhile.5D|[while]]] and [[InternalActionsWML#.5Bclear_variable.5D|[clear_variable]]]. Note units with a negative amount of hitpoints will be unstored with 1 hitpoint.<br /> * '''variable''': the name of the variable.<br /> * '''find_vacant''': whether the unit should be placed on the nearest vacant tile to its specified location. If this is set to 'no'(default), then any unit on the same tile as the unit being unstored will be destroyed. <br /> * '''check_passability''': {{DevFeature1.9}} (boolean yes|no, default yes): If yes, checks for terrain passability when placing the unit. This key has no effect if find_vacant=no (no check performed then). Before 1.9 this key is always &quot;no&quot;.<br /> * '''text''': (translatable) floating text to display above the unit, such as a damage amount<br /> * '''red''', '''green''', '''blue''': (default=0,0,0) the color to display the text in. Values vary from 0-255. You may find it convenient to use the {COLOR_HARM} or {COLOR_HEAL} macro instead. (Use {COLOR_HARM} or {COLOR_HEAL} instead of the whole red,green,blue= line.)<br /> * '''advance''': (default=true) if true the unit is advanced if it has enough XP. When modifying XP make sure to do it from inside a [[EventWML#Multiplayer_safety|synchronized event]] or it may lead to OOS errors especially when several advancement paths exist. Note that advance and post advance events are called, so infinite loops can happen.<br /> * '''fire_event''': {{DevFeature1.9}}(boolean yes|no, default no) Whether any advance/post advance events shall be fired if an advancement takes place, no effect otherwise. Before 1.9 this is always &quot;yes&quot;.<br /> * '''x''' ,'''y''': override unit location, &quot;x,y=recall, recall&quot; will put the unit on the unit's side's recall list.<br /> <br /> === [allow_recruit] ===<br /> Allows a side to recruit units it couldn't previously recruit.<br /> * '''type''': the types of units that the side can now recruit.<br /> * '''side''': (default=1) the number of the side that is being allowed to recruit the units {{DevFeature1.9}} side= can be a comma-separated list<br /> <br /> === [disallow_recruit] ===<br /> Prevents a side from recruiting units it could previously recruit.<br /> * '''type''': the types of units that the side can no longer recruit.<br /> * '''side''': (default=1) the number of the side that may no longer recruit the units. {{DevFeature1.9}} side= can be a comma-separated list<br /> <br /> === [set_recruit] ===<br /> Sets the units a side can recruit.<br /> ** '''recruit''': the types of units that the side can now recruit.<br /> ** '''side''': (default=1) the number of the side that is having its recruitment set. {{DevFeature1.9}} side= can be a comma-separated list<br /> === [modify_side] ===<br /> Modifies some details of a given side in the middle of a scenario. '''The following listed properties are the only properties that [modify_side] can affect!'''<br /> * '''side''': (default=1) the number of the side that is to be changed.<br /> * '''income''': the income given at the begining of each turn.<br /> * '''team_name''': the team in which the side plays the scenario.<br /> * '''user_team_name''': a translatable string representing the team's description. This has no effect on alliances. Defaults to ''team_name''.<br /> * '''gold''': the amount of gold the side owns.<br /> * '''village_gold''': the income setting per village for the side.<br /> * '''controller''': the identifier string of the side's controller. Uses the same syntax of the ''controller'' key in the [[SideWML|[side]]] tag.<br /> * '''fog''': a boolean string (yes/no) describing the status of Fog for the side.<br /> * '''shroud''': a boolean string describing the status of Shroud for the side.<br /> * '''hidden''': a boolean string specifying whether side is shown in status table.<br /> * '''[ai]''': replaces a side's AI parameters with the new specified ones. Uses the same syntax described in [[AiWML]].<br /> * '''switch_ai''': {{DevFeature}} replaces a side ai with a new AI from specified file(ignoring those AI parameters above). Path to file follows the usual WML convention.<br /> * '''share_maps''': {{DevFeature}} change the share_maps side attribute. Be sure to use shroud=yes for that side and have it as an ally<br /> * '''share_view''': {{DevFeature}} change the share_view side attribute. Be sure to use fog=yes for that side and have it as an ally<br /> <br /> === [modify_turns] ===<br /> Modifies the turn limit in the middle of a scenario.<br /> * '''value''': the new turn limit.<br /> * '''add''': if used instead of ''value'', specifies the number of turns to add to the current limit (can be negative).<br /> * '''current''': changes the current turn number after applying turn limit modifications, if any. It is possible to change the current turn number to a greater one than the current only; also, it is not possible to change the turn number to exceed the turn limit.<br /> <br /> === [capture_village] ===<br /> Changes the ownership of a village.<br /> * '''side''': the side that takes control of the village. This side needs to have a leader (canrecruit=yes). If the side key is not given, the village will become neutral.<br /> * '''x, y''': the location of the village. Can be a comma-separated list and/or location ranges. {{DevFeature1.9}}: [capture_village] accepts a full SLF; all village locations matching the filter are affected.<br /> <br /> === [kill] ===<br /> Removes all units (including units in a recall list) that match the filter from the game.<br /> * [[StandardUnitFilter]]: Selection criterion; do not use a [filter] tag.<br /> * '''animate''': if 'yes', displays the unit dying (fading away).<br /> * '''fire_event''': if 'yes', triggers any appropriate 'die' events (See [[EventWML]]). Note that any 'last breath' and 'die' events triggered by this are executed immediately, interrupting the current event and thus causing the x1, y1, x2, and y2 variables to be reset for that 'die' event, which in turn causes those variables to be invalid for the remainder of this event. In the stable version, the variable second_unit in each of these die and last breath events is always the same as the variable unit (the dying unit). Note that events are only fired for killed units that have been on the map (as opposed to recall list).<br /> * '''[secondary_unit]''' {{DevFeature1.9}} with a [[StandardUnitFilter]] as argument. Do not use a [filter] tag. Has an effect only if fire_event=yes. The first on-map unit matching the filter becomes second_unit in any fired die and last breath events. If an on-map unit matches and if there are several units killed with a single [kill] tag, second_unit is this same unit for all of them. If no on-map unit matches or [secondary_unit] isn't present, the variable second_unit in each of the die and last breath events is always the same as the variable unit (the dying unit).<br /> <br /> === [move_unit] ===<br /> {{DevFeature1.9}}; works like the MOVE_UNIT macro.<br /> * [[StandardUnitFilter]] as argument; do not use a [filter] tag. All units matching the filter are moved. If the target location is occupied, the nearest free passable location is chosen. All target locations passed (see below) need to be passable hexes for the particular moved units.<br /> * '''to_x''' (unsigned integer): The units are moved to this x coordinate. Can be a comma-separated list, in which case the unit follows this given path during the move.<br /> * '''to_y''' (unsigned integer): The units are moved to this y coordinate. Can be a comma-separated list.<br /> * '''fire_event''' (optional, boolean yes|no, default no): Whether any according moveto events shall be fired. The target location ($x1, $y1 in the event) may not be the same location that the unit was tried to be moved to, if the original target location is occupied or impassable.<br /> * '''check_passability''' (boolean yes|no, default yes): Whether the terrain the unit is moved to should be checked for suiting the unit. (If it does not, a nearby suitable hex is chosen.)<br /> <br /> === [modify_ai] ===<br /> Changes the AI for a specified side. See [[Customizing_AI_in_Wesnoth_1.8#.5Bmodify_ai.5D_tag]]<br /> <br /> === [modify_unit] ===<br /> {{DevFeature1.9}}; works similar to the MODIFY_UNIT macro.<br /> * '''[filter]''' with a [[StandardUnitFilter]] as argument. All units matching this filter are modified. Matches on recall list units too.<br /> * Accepts generally the syntax inside of wml unit variables created by [store_unit] which can be viewed in a savefile or by using the :inspect command. Can add traits with immediate effect. Cannot remove things. Subtags with the same name must be written in the correct order to match them with the tag they are supposed to modify.<br /> example usage (see also the test scenario):<br /> [modify_unit]<br /> [filter]<br /> type=Troll Rocklobber<br /> [/filter]<br /> hitpoints=10<br /> [modifications]<br /> [trait]<br /> # first trait is unmodified<br /> [/trait]<br /> {TRAIT_HEALTHY}# second trait is replaced with the healthy trait<br /> [/modifications]<br /> [/modify_unit]<br /> <br /> The unit which is currently modified is accessible via $this_unit, e.g. hitpoints = &quot;$($this_unit.hitpoints / 2)&quot; to set the hitpoints of all units to half of their particular maxima. This this_unit variable is independent from the this_unit variable available in the SUF used to determine which units to modify (first all matching units are gathered, and then all those are modified).<br /> <br /> note: The syntax allowed is somehow vage. Just try things and possibly correct/add/modify this documentation. (a [http://forums.wesnoth.org/viewtopic.php?f=21&amp;t=31676&amp; forum thread] discusses some related issues).<br /> <br /> === [transform_unit] ===<br /> {{DevFeature1.9}}; transforms every unit matching the filter to the given unit type. Keeps intact hitpoints, experience and status. If the unit is transformed to a non-living type (undead or mechanical), it will be also unpoisoned.<br /> * [[StandardUnitFilter]]: do not use a [filter] tag.<br /> * '''transform_to''': the unit type in which all the units matching the filter will be transformed. If missing, the units will follow their normal advancement.<br /> <br /> === [petrify] ===<br /> {{DevFeature1.9}}(This tag did never exist until r47553 (from 1.9.3 on), although it was already documented.)<br /> <br /> * [[StandardUnitFilter]] as an argument. Do not use a [filter] tag. All units matching this filter are petrified. Recall list units are included.<br /> <br /> === [unpetrify] ===<br /> * [[StandardUnitFilter]] as an argument. {{DevFeature1.9}}: Do not use a [filter] tag. All units matching this filter are unpetrified {{DevFeature1.9}}: recall list units included.<br /> <br /> === [object] ===<br /> Gives some unit an object and removes all items on the tile the unit is on.<br /> * '''id''': (Optional) when the object is picked up, a flag is set for ''id''. The object cannot be picked up if a flag for ''id'' has been set. This means that any object with an id can only be used once, even if first_time_only=no is set for the event. This restriction is per level. In a campaign objects with the same id can be assigned once per level.<br /> * '''[effect]''': one or more effect elements may be listed. See [[EffectWML]] for a description of [effect].<br /> * '''duration''': if 'level', effects only last until the end of the level (note : 'level' is the scenario, so this doesn't mean it last until the unit levels-up).<br /> * '''[filter]''' with a [[StandardUnitFilter]] as argument. The first unit found that matches the filter will be given the object. If no unit matches the filter, then a message is displayed and the object is not removed.<br /> * '''[then]''': a subtag that lets you execute actions if the filter conditions are met. The most common action that should be inside here is a '''[removeitem]''' tag, but you could probably put any tags that otherwise work in a [then] tag.<br /> * '''silent''': whether or not messages should be suppressed. Default is &quot;no&quot;.<br /> * '''image''': the displayed image of the object.<br /> * '''name''': (translatable) displayed as a caption of the image.<br /> <br /> * '''description''': (translatable) displayed as a message of the image.<br /> * '''cannot_use_message''': (translatable) displayed instead of '''description''' if no unit passes the filter test.<br /> * If you do not supply a filter, the object action will be applied to a unit at the location of the moveto event. Currently this isn't recommended as it is not clear that this will continue working this way. Instead it is better to explicitly include a location filter.<br /> * The object action does not act on units in the recall list. There is a feature request in to allow this, but it is not clear whether or not it will be accepted.<br /> <br /> === [remove_shroud] ===<br /> Removes some shroud from the map for a certain side (only relevant for sides that have shroud=yes).<br /> * '''side''': (default=1) the side for which to remove shroud.<br /> * [[StandardLocationFilter]]: the range of tiles for which shroud should be removed.<br /> === [place_shroud] ===<br /> Places some shroud on the map for a certain side (only relevant for sides that have shroud=yes).<br /> * '''side''': (default=1) the side for which to place shroud.<br /> * [[StandardLocationFilter]]: the range of tiles on which shroud should be placed.<br /> * side will default to all sides after 1.9.5's release. {{DevFeature1.9}}<br /> <br /> === [allow_undo] ===<br /> Allows the player to undo the event that this tag is inside. Has an effect only inside moveto events. If the move is undone, only the position of the unit will be restored; any altered variables or changes to the game will remain changed after the move is undone. It is up to the scenario designer to avoid abusing this command.<br /> * Technically, if '''[allow_undo]''' is inside an '''[event]''' with ''first_time_only=yes'' (the default setting), and the user undoes the event, then the state of the game has changed in this way: the event will not fire a second time, even though the user undid the move the first time.<br /> <br /> === [heal_unit] ===<br /> Heal a unit. The variable '''$heal_amount''' will be set to the exact number of points healed (i.e can be lesser than the parameter '''amount''' if the unit is fully healed).<br /> * '''[filter]''': [[StandardUnitFilter]] the first unit matching the filter will be healed.<br /> * '''[filter_second]''': [[StandardUnitFilter]] all the units matching the filter ''and'' having the ''heals'' ability will have their animation played (if ''animate'' is set to true).<br /> * '''amount''': the maximum points the unit will be healed.<br /> * '''animate''': a boolean which indicate if the healing animations must be played.<br /> <br /> === [harm_unit] ===<br /> {{DevFeature1.9}}Harms every unit matching the filter, for the specific damage amount.<br /> * '''[filter]''': [[StandardUnitFilter]] all matching units will be harmed (required).<br /> * '''amount''': the amount of damage that will be done (required).<br /> * '''alignment''': (default neutral) applies an alignment to the damage, this means that if alignment=chaotic, the damage will be increased at night and reduced at day.<br /> * '''damage_type''': if present, amount will be altered by unit resistance to the damage type specified.<br /> * '''kill''': (default yes) if yes, when an harmed unit goes to or below 0 HP, it is killed; if no its HP are set to 1.<br /> * '''fire_event''': (default no) if yes, when a unit is killed by harming, the corresponding events are fired.<br /> * '''animate''': (default no) if yes, scrolls to each unit before harming it and plays its defense and death animations.<br /> * '''[secondary_attack]''': sets the weapon against which the unit harmed will defend, to allow playing specific defense animations. Takes a weapon filter as argument, see [[FilterWML]].<br /> * '''delay''': if animate=yes, sets the delay (in milliseconds, default 500) between each unit harming.<br /> * '''variable''': if present, the damage caused to the unit, altered by resistances, will be stored in a WML array with the given name, under the &quot;harm_amount&quot; key.<br /> * '''poisoned, slowed, petrified, unhealable''': (default no) if yes, every harmed unit that doesn't already have such status will have it set.<br /> <br /> === [time_area] ===<br /> How a day should progress in a given area. Everywhere not specified in a [time_area] tag is affected by the [time] and [illuminated_time] tags in the [scenario] tag.<br /> * [[StandardLocationFilter]]: the locations to affect.<br /> * [[TimeWML]]: the new schedule.<br /> * '''id''': an unique identifier assigned to a time_area. Optional, unless you want to remove the time_area later. Can be a comma-separated list when removing time_areas, see below.<br /> * '''remove''': (boolean) yes/no value. Indicates whether the specified time_area should be removed. Requires an identifier. If no identifier is used, however, all time_areas are removed.<br /> <br /> === [end_turn] ===<br /> End the current side's turn. {{DevFeature}} The current event is finished before the turn is ended. Also, if the current event (where the tag appears) has been fired by another event, that event (and the complete stack of other possible parent events) is ended before [end_turn] comes into affect. Also, events following the event stack that fired [end_turn] are not omitted (e.g. [end_turn] is used by a side turn event and a turn refresh event does something afterwards).<br /> <br /> === [replace_map] ===<br /> <br /> Replaces the entire map.<br /> * '''map''': Content of a wesnoth map file. example:<br /> map=&quot;{campaigns/Heir_To_The_Throne/maps/01_The_Elves_Besieged.map}&quot;<br /> * '''expand''': if 'yes', allows the map size to increase. The expansion direction is currently always bottom-right.<br /> * '''shrink''': if 'yes', allows the map size to decrease. If the map size is reduced, any units that would no longer be on the map due to its coordinates no longer existing will be put into the recall list.<br /> <br /> === [replace_schedule] ===<br /> Replace the time of day schedule of the entire scenario. {{DevFeature1.9}}<br /> * [[TimeWML]]: the new schedule.<br /> <br /> === [tunnel] ===<br /> <br /> {{DevFeature1.9}}<br /> <br /> Create a tunnel between some locations, later usable by units to move from source hex to target hex (using the movement cost of unit on the target terrain). ([http://forums.wesnoth.org/viewtopic.php?f=21&amp;t=14749&amp;p=405667&amp;hilit=tunnel#p405667 source])<br /> <br /> * '''id''' identifier for the tunnel, to allow removing (optional).<br /> * '''remove''': (boolean) yes/no value. If yes, removes all defined tunnels with the same ID (then only id= is necessary). (default: no)<br /> * '''bidirectional''': (boolean) if yes, creates also a tunnel in the other direction. (default: yes)<br /> * '''always_visible''': (boolean) if yes, the possible movement of enemies under fog can be seen. (default: no)<br /> * '''[source]''': [[StandardLocationFilter]] the source hex(es) (required).<br /> * '''[target]''': [[StandardLocationFilter]] the target hex(es) (required).<br /> * '''[filter]''': [[StandardUnitFilter]] the units which can use the tunnel (required). Leave empty for &quot;all units&quot;.<br /> <br /> (Note: The tunnel tag can also be used inside the [[AbilitiesWML|[teleport]]] ability, without remove= and id=).<br /> <br /> == Useful Macros ==<br /> There are some predefined macros that you find useful for direct actions. You can find a complete list along with a detailed explanation of how they work [http://www.wesnoth.org/macro-reference.xhtml here].<br /> * '''{MOVE_UNIT}''': Moves a unit to another location in the map and the player sees the movement (unlike [teleport])<br /> * '''{FULL_HEAL}''': Brings a unit to full HP<br /> * '''{LOYAL_UNIT}''': Create a loyal unit<br /> * '''{MODIFY_TERRAIN_MASK}''': Modify an area of terrain<br /> <br /> == See Also ==<br /> <br /> * [[InternalActionsWML]]<br /> * [[InterfaceActionsWML]]<br /> * [[EventWML]]<br /> * [[ReferenceWML]]<br /> <br /> [[Category: WML Reference]]<br /> [[Category: ActionsWML]]</div>

Gambit https://wiki.wesnoth.org/index.php?title=DirectActionsWML&diff=40823 2011-03-16T15:28:50Z

<p>Gambit: /* [gold] */ Update with info about path #1883</p> <hr /> <div>{{WML Tags}}<br /> == Direct actions ==<br /> <br /> Direct actions are actions that have a direct effect on gameplay. They can be used inside of [[EventWML|events]].<br /> <br /> The following tags are actions:<br /> <br /> === [endlevel] ===<br /> Ends the scenario.<br /> * '''result''': before the scenario is over, all events with ''name=result'' are triggered. The message ''result_message'' with the heading ''result_heading'' (see [[LanguageWML]]) are displayed. If ''result=victory'', the player progresses to the next level; if ''result=defeat'', the game returns to the main menu. These last two are rarely used: ''result=continue'' behaves identically to ''result=victory'' except the player's gold is not reduced to 80%, and it does not bring up a &quot;Victory&quot; message or the gold changing message (since it doesn't change); ''result=continue_no_save'' works similarly, except the player is not asked whether to save the game, and is taken directly to the next scenario without any messages. {{DevFeature}}: All values for result=... except victory and defeat are being discarded in favor of modifying '''[endlevel]''' behaviour with single keys.<br /> Unless ''result=defeat'', the following keys can also be used:<br /> * '''bonus''': whether the player should get bonus gold (maximum possible gold that could have been earned by waiting the level out). The default is bonus=yes.<br /> * '''carryover_report''': whether the player should receive a summary of the scenario outcome, the default is carryover_report=yes.<br /> * '''save''': whether a start-of-scenario save should be created for the next scenario, the default is save=yes. Do not confuse this with saving of replays for the current scenario.<br /> * '''linger_mode''': If ...=yes, the screen is greyed out and there's the possibility to save before advancing to the next scenario, the default is linger_mode=yes.<br /> * '''reveal_map''': (Multiplayer only) (Default is 'yes') If 'no', shroud doesn't disappear when game ended. {{DevFeature1.9}}<br /> * '''next_scenario''': (default specified in '''[scenario]''' tag) the ID of the next scenario that should be played. All units that side 1 controls at this point become available for recall in ''next_scenario''.<br /> <br /> When the result is &quot;victory&quot; the following keys can be used:<br /> * '''carryover_percentage''': by default 80% of the gold is carried over to the next scenario, with this key the amount can be changed.<br /> * '''carryover_add''': if true the gold will be added to the starting gold the next scenario, if false the next scenario will start with the amount of the current scenario (after taxes) or the minimum in the next scenario. Default is false.<br /> * '''music''': (default specified in '''[scenario]''' or '''[game_config]''' tags) a comma-separated list of music tracks from which one will be chosen and played once after any events related to the end of level result are executed; by default, victory_music is used on victory, and defeat_music on defeat.<br /> * '''end_text''': Text that is shown centered in a black screen at the end of a campaign. Defaults to &quot;The End&quot;. Note that this has cumulative effects over the campaign - it persists even if the endlevel does not trigger the end of the campaign. See also [[CampaignWML]].<br /> * '''end_text_duration''': Delay, in milliseconds, before displaying the game credits at the end of a campaign. In other words, for how much time '''end_text''' is displayed on screen. Defaults to 3500. Note that this has cumulative effects over the campaign - it persists even if the endlevel does not trigger the end of the campaign. See also [[CampaignWML]].<br /> <br /> === [unit] ===<br /> Places a unit on the map. For syntax see [[SingleUnitWML]].<br /> * {{Short Note:Predefined Macro|GENERIC_UNIT}}<br /> * '''to_variable''': spawn directly into a variable instead of on the map.<br /> <br /> === [recall] ===<br /> Recalls a unit. The unit is recalled free of charge, and is placed near the leader.<br /> * [[StandardUnitFilter]]: the first matching unit will be recalled. If no units match this tag is ignored. Do not use a [filter] tag. If a comma separated list is given, every unit currently considered for recall is checked against all the types (not each single one of the types against all units).<br /> * '''x,y''': the unit is placed here instead of next to the leader.<br /> * '''show''': yes/no, default yes: whether the unit is animated (faded in) or instantly displayed<br /> * '''fire_event''': {{DevFeature1.9}} boolean yes|no (default no); whether any according prerecall or recall events shall be fired. In pre-1.9.3 these events are all automatically fired and it can't be turned off.<br /> <br /> === [teleport] ===<br /> Teleports a unit on map. {{Short Note:Predefined Macro|TELEPORT_UNIT}}<br /> * '''[filter]''': [[StandardUnitFilter]] the first unit matching this filter will be teleported.<br /> * '''x,y''': the position to teleport to.<br /> * '''clear_shroud''': should shroud be cleared on arrival<br /> * '''animate''': should a teleport animation be played (if the unit doesn't have a teleport animation, it will fade out/fade in)<br /> * '''ignore_passability''': {{DevFeature}} normally, units will not be teleported into terrain that is impassable for them. Setting this attribute to &quot;yes&quot; permits it. {{DevFeature1.9}}Renamed to check_passability (default yes).<br /> <br /> (Note: There is also a ability named teleport, see [[AbilitiesWML]].)<br /> <br /> === [terrain_mask] ===<br /> Changes the terrain on the map. See [[TerrainMaskWML]].<br /> <br /> === [terrain] ===<br /> Changes the terrain on the map.<br /> * '''terrain''': the character of the terrain to use. See [[TerrainCodesWML]] to see what letter a type of terrain uses.<br /> * '''x,y''': the position (or range of positions) to change. {{DevFeature1.9}}: [terrain] accepts a [[StandardLocationFilter]]. This [[StandardLocationFilter]]'s terrain= key is used for the new terrain, filtering by terrain can be done with a nested [[StandardLocationFilter]]: [and]terrain=terrain_string_to_be_filtered_for.<br /> * '''layer''': (overlay|base|both, default=both) only change the specified layer.<br /> * '''replace_if_failed''': (default=no) When replacing just one layer failed, try to replace the whole terrain. If '''terrain''' is an overlay only terrain, use the default_base as base layer. If the terrain has no default base, do nothing.<br /> <br /> === [gold] ===<br /> Gives one side gold.<br /> * '''amount''': the amount of gold to give.<br /> * '''side''': (default=1) the number of the side to give the gold to.<br /> * side will default to all sides after 1.9.5's release. {{DevFeature1.9}}<br /> <br /> === [unstore_unit] ===<br /> Creates a unit from a game variable, and activates it on the playing field. This must be a specific variable describing a unit, and may not be an array -- to unstore an entire array, iterate over it. The variable is not cleared. See also [[InternalActionsWML#.5Bstore_unit.5D|[store_unit]]], [[ConditionalActionsWML#.5Bwhile.5D|[while]]] and [[InternalActionsWML#.5Bclear_variable.5D|[clear_variable]]]. Note units with a negative amount of hitpoints will be unstored with 1 hitpoint.<br /> * '''variable''': the name of the variable.<br /> * '''find_vacant''': whether the unit should be placed on the nearest vacant tile to its specified location. If this is set to 'no'(default), then any unit on the same tile as the unit being unstored will be destroyed. <br /> * '''check_passability''': {{DevFeature1.9}} (boolean yes|no, default yes): If yes, checks for terrain passability when placing the unit. This key has no effect if find_vacant=no (no check performed then). Before 1.9 this key is always &quot;no&quot;.<br /> * '''text''': (translatable) floating text to display above the unit, such as a damage amount<br /> * '''red''', '''green''', '''blue''': (default=0,0,0) the color to display the text in. Values vary from 0-255. You may find it convenient to use the {COLOR_HARM} or {COLOR_HEAL} macro instead. (Use {COLOR_HARM} or {COLOR_HEAL} instead of the whole red,green,blue= line.)<br /> * '''advance''': (default=true) if true the unit is advanced if it has enough XP. When modifying XP make sure to do it from inside a [[EventWML#Multiplayer_safety|synchronized event]] or it may lead to OOS errors especially when several advancement paths exist. Note that advance and post advance events are called, so infinite loops can happen.<br /> * '''fire_event''': {{DevFeature1.9}}(boolean yes|no, default no) Whether any advance/post advance events shall be fired if an advancement takes place, no effect otherwise. Before 1.9 this is always &quot;yes&quot;.<br /> * '''x''' ,'''y''': override unit location, &quot;x,y=recall, recall&quot; will put the unit on the unit's side's recall list.<br /> <br /> === [allow_recruit] ===<br /> Allows a side to recruit units it couldn't previously recruit.<br /> * '''type''': the types of units that the side can now recruit.<br /> * '''side''': (default=1) the number of the side that is being allowed to recruit the units {{DevFeature1.9}} side= can be a comma-separated list<br /> <br /> === [disallow_recruit] ===<br /> Prevents a side from recruiting units it could previously recruit.<br /> * '''type''': the types of units that the side can no longer recruit.<br /> * '''side''': (default=1) the number of the side that may no longer recruit the units. {{DevFeature1.9}} side= can be a comma-separated list<br /> <br /> === [set_recruit] ===<br /> Sets the units a side can recruit.<br /> ** '''recruit''': the types of units that the side can now recruit.<br /> ** '''side''': (default=1) the number of the side that is having its recruitment set. {{DevFeature1.9}} side= can be a comma-separated list<br /> === [modify_side] ===<br /> Modifies some details of a given side in the middle of a scenario. '''The following listed properties are the only properties that [modify_side] can affect!'''<br /> * '''side''': (default=1) the number of the side that is to be changed.<br /> * '''income''': the income given at the begining of each turn.<br /> * '''team_name''': the team in which the side plays the scenario.<br /> * '''user_team_name''': a translatable string representing the team's description. This has no effect on alliances. Defaults to ''team_name''.<br /> * '''gold''': the amount of gold the side owns.<br /> * '''village_gold''': the income setting per village for the side.<br /> * '''controller''': the identifier string of the side's controller. Uses the same syntax of the ''controller'' key in the [[SideWML|[side]]] tag.<br /> * '''fog''': a boolean string (yes/no) describing the status of Fog for the side.<br /> * '''shroud''': a boolean string describing the status of Shroud for the side.<br /> * '''hidden''': a boolean string specifying whether side is shown in status table.<br /> * '''[ai]''': replaces a side's AI parameters with the new specified ones. Uses the same syntax described in [[AiWML]].<br /> * '''switch_ai''': {{DevFeature}} replaces a side ai with a new AI from specified file(ignoring those AI parameters above). Path to file follows the usual WML convention.<br /> * '''share_maps''': {{DevFeature}} change the share_maps side attribute. Be sure to use shroud=yes for that side and have it as an ally<br /> * '''share_view''': {{DevFeature}} change the share_view side attribute. Be sure to use fog=yes for that side and have it as an ally<br /> <br /> === [modify_turns] ===<br /> Modifies the turn limit in the middle of a scenario.<br /> * '''value''': the new turn limit.<br /> * '''add''': if used instead of ''value'', specifies the number of turns to add to the current limit (can be negative).<br /> * '''current''': changes the current turn number after applying turn limit modifications, if any. It is possible to change the current turn number to a greater one than the current only; also, it is not possible to change the turn number to exceed the turn limit.<br /> <br /> === [capture_village] ===<br /> Changes the ownership of a village.<br /> * '''side''': the side that takes control of the village. This side needs to have a leader (canrecruit=yes). If the side key is not given, the village will become neutral.<br /> * '''x, y''': the location of the village. Can be a comma-separated list and/or location ranges. {{DevFeature1.9}}: [capture_village] accepts a full SLF; all village locations matching the filter are affected.<br /> <br /> === [kill] ===<br /> Removes all units (including units in a recall list) that match the filter from the game.<br /> * [[StandardUnitFilter]]: Selection criterion; do not use a [filter] tag.<br /> * '''animate''': if 'yes', displays the unit dying (fading away).<br /> * '''fire_event''': if 'yes', triggers any appropriate 'die' events (See [[EventWML]]). Note that any 'last breath' and 'die' events triggered by this are executed immediately, interrupting the current event and thus causing the x1, y1, x2, and y2 variables to be reset for that 'die' event, which in turn causes those variables to be invalid for the remainder of this event. In the stable version, the variable second_unit in each of these die and last breath events is always the same as the variable unit (the dying unit). Note that events are only fired for killed units that have been on the map (as opposed to recall list).<br /> * '''[secondary_unit]''' {{DevFeature1.9}} with a [[StandardUnitFilter]] as argument. Do not use a [filter] tag. Has an effect only if fire_event=yes. The first on-map unit matching the filter becomes second_unit in any fired die and last breath events. If an on-map unit matches and if there are several units killed with a single [kill] tag, second_unit is this same unit for all of them. If no on-map unit matches or [secondary_unit] isn't present, the variable second_unit in each of the die and last breath events is always the same as the variable unit (the dying unit).<br /> <br /> === [move_unit] ===<br /> {{DevFeature1.9}}; works like the MOVE_UNIT macro.<br /> * [[StandardUnitFilter]] as argument; do not use a [filter] tag. All units matching the filter are moved. If the target location is occupied, the nearest free passable location is chosen. All target locations passed (see below) need to be passable hexes for the particular moved units.<br /> * '''to_x''' (unsigned integer): The units are moved to this x coordinate. Can be a comma-separated list, in which case the unit follows this given path during the move.<br /> * '''to_y''' (unsigned integer): The units are moved to this y coordinate. Can be a comma-separated list.<br /> * '''fire_event''' (optional, boolean yes|no, default no): Whether any according moveto events shall be fired. The target location ($x1, $y1 in the event) may not be the same location that the unit was tried to be moved to, if the original target location is occupied or impassable.<br /> * '''check_passability''' (boolean yes|no, default yes): Whether the terrain the unit is moved to should be checked for suiting the unit. (If it does not, a nearby suitable hex is chosen.)<br /> <br /> === [modify_ai] ===<br /> Changes the AI for a specified side. See [[Customizing_AI_in_Wesnoth_1.8#.5Bmodify_ai.5D_tag]]<br /> <br /> === [modify_unit] ===<br /> {{DevFeature1.9}}; works similar to the MODIFY_UNIT macro.<br /> * '''[filter]''' with a [[StandardUnitFilter]] as argument. All units matching this filter are modified. Matches on recall list units too.<br /> * Accepts generally the syntax inside of wml unit variables created by [store_unit] which can be viewed in a savefile or by using the :inspect command. Can add traits with immediate effect. Cannot remove things. Subtags with the same name must be written in the correct order to match them with the tag they are supposed to modify.<br /> example usage (see also the test scenario):<br /> [modify_unit]<br /> [filter]<br /> type=Troll Rocklobber<br /> [/filter]<br /> hitpoints=10<br /> [modifications]<br /> [trait]<br /> # first trait is unmodified<br /> [/trait]<br /> {TRAIT_HEALTHY}# second trait is replaced with the healthy trait<br /> [/modifications]<br /> [/modify_unit]<br /> <br /> The unit which is currently modified is accessible via $this_unit, e.g. hitpoints = &quot;$($this_unit.hitpoints / 2)&quot; to set the hitpoints of all units to half of their particular maxima. This this_unit variable is independent from the this_unit variable available in the SUF used to determine which units to modify (first all matching units are gathered, and then all those are modified).<br /> <br /> note: The syntax allowed is somehow vage. Just try things and possibly correct/add/modify this documentation. (a [http://forums.wesnoth.org/viewtopic.php?f=21&amp;t=31676&amp; forum thread] discusses some related issues).<br /> <br /> === [transform_unit] ===<br /> {{DevFeature1.9}}; transforms every unit matching the filter to the given unit type. Keeps intact hitpoints, experience and status. If the unit is transformed to a non-living type (undead or mechanical), it will be also unpoisoned.<br /> * [[StandardUnitFilter]]: do not use a [filter] tag.<br /> * '''transform_to''': the unit type in which all the units matching the filter will be transformed. If missing, the units will follow their normal advancement.<br /> <br /> === [petrify] ===<br /> {{DevFeature1.9}}(This tag did never exist until r47553 (from 1.9.3 on), although it was already documented.)<br /> <br /> * [[StandardUnitFilter]] as an argument. Do not use a [filter] tag. All units matching this filter are petrified. Recall list units are included.<br /> <br /> === [unpetrify] ===<br /> * [[StandardUnitFilter]] as an argument. {{DevFeature1.9}}: Do not use a [filter] tag. All units matching this filter are unpetrified {{DevFeature1.9}}: recall list units included.<br /> <br /> === [object] ===<br /> Gives some unit an object and removes all items on the tile the unit is on.<br /> * '''id''': (Optional) when the object is picked up, a flag is set for ''id''. The object cannot be picked up if a flag for ''id'' has been set. This means that any object with an id can only be used once, even if first_time_only=no is set for the event. This restriction is per level. In a campaign objects with the same id can be assigned once per level.<br /> * '''[effect]''': one or more effect elements may be listed. See [[EffectWML]] for a description of [effect].<br /> * '''duration''': if 'level', effects only last until the end of the level (note : 'level' is the scenario, so this doesn't mean it last until the unit levels-up).<br /> * '''[filter]''' with a [[StandardUnitFilter]] as argument. The first unit found that matches the filter will be given the object. If no unit matches the filter, then a message is displayed and the object is not removed.<br /> * '''[then]''': a subtag that lets you execute actions if the filter conditions are met. The most common action that should be inside here is a '''[removeitem]''' tag, but you could probably put any tags that otherwise work in a [then] tag.<br /> * '''silent''': whether or not messages should be suppressed. Default is &quot;no&quot;.<br /> * '''image''': the displayed image of the object.<br /> * '''name''': (translatable) displayed as a caption of the image.<br /> <br /> * '''description''': (translatable) displayed as a message of the image.<br /> * '''cannot_use_message''': (translatable) displayed instead of '''description''' if no unit passes the filter test.<br /> * If you do not supply a filter, the object action will be applied to a unit at the location of the moveto event. Currently this isn't recommended as it is not clear that this will continue working this way. Instead it is better to explicitly include a location filter.<br /> * The object action does not act on units in the recall list. There is a feature request in to allow this, but it is not clear whether or not it will be accepted.<br /> <br /> === [remove_shroud] ===<br /> Removes some shroud from the map for a certain side (only relevant for sides that have shroud=yes).<br /> * '''side''': (default=1) the side for which to remove shroud.<br /> * [[StandardLocationFilter]]: the range of tiles for which shroud should be removed.<br /> === [place_shroud] ===<br /> Places some shroud on the map for a certain side (only relevant for sides that have shroud=yes).<br /> * '''side''': (default=1) the side for which to place shroud.<br /> * [[StandardLocationFilter]]: the range of tiles on which shroud should be placed.<br /> <br /> === [allow_undo] ===<br /> Allows the player to undo the event that this tag is inside. Has an effect only inside moveto events. If the move is undone, only the position of the unit will be restored; any altered variables or changes to the game will remain changed after the move is undone. It is up to the scenario designer to avoid abusing this command.<br /> * Technically, if '''[allow_undo]''' is inside an '''[event]''' with ''first_time_only=yes'' (the default setting), and the user undoes the event, then the state of the game has changed in this way: the event will not fire a second time, even though the user undid the move the first time.<br /> <br /> === [heal_unit] ===<br /> Heal a unit. The variable '''$heal_amount''' will be set to the exact number of points healed (i.e can be lesser than the parameter '''amount''' if the unit is fully healed).<br /> * '''[filter]''': [[StandardUnitFilter]] the first unit matching the filter will be healed.<br /> * '''[filter_second]''': [[StandardUnitFilter]] all the units matching the filter ''and'' having the ''heals'' ability will have their animation played (if ''animate'' is set to true).<br /> * '''amount''': the maximum points the unit will be healed.<br /> * '''animate''': a boolean which indicate if the healing animations must be played.<br /> <br /> === [harm_unit] ===<br /> {{DevFeature1.9}}Harms every unit matching the filter, for the specific damage amount.<br /> * '''[filter]''': [[StandardUnitFilter]] all matching units will be harmed (required).<br /> * '''amount''': the amount of damage that will be done (required).<br /> * '''alignment''': (default neutral) applies an alignment to the damage, this means that if alignment=chaotic, the damage will be increased at night and reduced at day.<br /> * '''damage_type''': if present, amount will be altered by unit resistance to the damage type specified.<br /> * '''kill''': (default yes) if yes, when an harmed unit goes to or below 0 HP, it is killed; if no its HP are set to 1.<br /> * '''fire_event''': (default no) if yes, when a unit is killed by harming, the corresponding events are fired.<br /> * '''animate''': (default no) if yes, scrolls to each unit before harming it and plays its defense and death animations.<br /> * '''[secondary_attack]''': sets the weapon against which the unit harmed will defend, to allow playing specific defense animations. Takes a weapon filter as argument, see [[FilterWML]].<br /> * '''delay''': if animate=yes, sets the delay (in milliseconds, default 500) between each unit harming.<br /> * '''variable''': if present, the damage caused to the unit, altered by resistances, will be stored in a WML array with the given name, under the &quot;harm_amount&quot; key.<br /> * '''poisoned, slowed, petrified, unhealable''': (default no) if yes, every harmed unit that doesn't already have such status will have it set.<br /> <br /> === [time_area] ===<br /> How a day should progress in a given area. Everywhere not specified in a [time_area] tag is affected by the [time] and [illuminated_time] tags in the [scenario] tag.<br /> * [[StandardLocationFilter]]: the locations to affect.<br /> * [[TimeWML]]: the new schedule.<br /> * '''id''': an unique identifier assigned to a time_area. Optional, unless you want to remove the time_area later. Can be a comma-separated list when removing time_areas, see below.<br /> * '''remove''': (boolean) yes/no value. Indicates whether the specified time_area should be removed. Requires an identifier. If no identifier is used, however, all time_areas are removed.<br /> <br /> === [end_turn] ===<br /> End the current side's turn. {{DevFeature}} The current event is finished before the turn is ended. Also, if the current event (where the tag appears) has been fired by another event, that event (and the complete stack of other possible parent events) is ended before [end_turn] comes into affect. Also, events following the event stack that fired [end_turn] are not omitted (e.g. [end_turn] is used by a side turn event and a turn refresh event does something afterwards).<br /> <br /> === [replace_map] ===<br /> <br /> Replaces the entire map.<br /> * '''map''': Content of a wesnoth map file. example:<br /> map=&quot;{campaigns/Heir_To_The_Throne/maps/01_The_Elves_Besieged.map}&quot;<br /> * '''expand''': if 'yes', allows the map size to increase. The expansion direction is currently always bottom-right.<br /> * '''shrink''': if 'yes', allows the map size to decrease. If the map size is reduced, any units that would no longer be on the map due to its coordinates no longer existing will be put into the recall list.<br /> <br /> === [replace_schedule] ===<br /> Replace the time of day schedule of the entire scenario. {{DevFeature1.9}}<br /> * [[TimeWML]]: the new schedule.<br /> <br /> === [tunnel] ===<br /> <br /> {{DevFeature1.9}}<br /> <br /> Create a tunnel between some locations, later usable by units to move from source hex to target hex (using the movement cost of unit on the target terrain). ([http://forums.wesnoth.org/viewtopic.php?f=21&amp;t=14749&amp;p=405667&amp;hilit=tunnel#p405667 source])<br /> <br /> * '''id''' identifier for the tunnel, to allow removing (optional).<br /> * '''remove''': (boolean) yes/no value. If yes, removes all defined tunnels with the same ID (then only id= is necessary). (default: no)<br /> * '''bidirectional''': (boolean) if yes, creates also a tunnel in the other direction. (default: yes)<br /> * '''always_visible''': (boolean) if yes, the possible movement of enemies under fog can be seen. (default: no)<br /> * '''[source]''': [[StandardLocationFilter]] the source hex(es) (required).<br /> * '''[target]''': [[StandardLocationFilter]] the target hex(es) (required).<br /> * '''[filter]''': [[StandardUnitFilter]] the units which can use the tunnel (required). Leave empty for &quot;all units&quot;.<br /> <br /> (Note: The tunnel tag can also be used inside the [[AbilitiesWML|[teleport]]] ability, without remove= and id=).<br /> <br /> == Useful Macros ==<br /> There are some predefined macros that you find useful for direct actions. You can find a complete list along with a detailed explanation of how they work [http://www.wesnoth.org/macro-reference.xhtml here].<br /> * '''{MOVE_UNIT}''': Moves a unit to another location in the map and the player sees the movement (unlike [teleport])<br /> * '''{FULL_HEAL}''': Brings a unit to full HP<br /> * '''{LOYAL_UNIT}''': Create a loyal unit<br /> * '''{MODIFY_TERRAIN_MASK}''': Modify an area of terrain<br /> <br /> == See Also ==<br /> <br /> * [[InternalActionsWML]]<br /> * [[InterfaceActionsWML]]<br /> * [[EventWML]]<br /> * [[ReferenceWML]]<br /> <br /> [[Category: WML Reference]]<br /> [[Category: ActionsWML]]</div>

Gambit https://wiki.wesnoth.org/index.php?title=SpellingMistakes&diff=40273 2011-02-03T19:47:41Z

<p>Gambit: Undo revision 40272 by Gambit (Talk)</p> <hr /> <div>This page is meant to be a list of spelling mistakes in campaigns and other translatable texts in the en_US development version of the game.<br /> <br /> Note: The house style of Wesnoth uses a good many words and constructions that are archaic, poetic, or dialectal. If you speak modern English as a second language you may incorrectly read these as errors. Please see [[NotSpellingMistakes]] for a list of things you will encounter that may look like spelling or usage errors but are not. Note that the mainline campaigns are now using correct typography, including sexed quotes and en and em dashes. These will appear as three byte sequences if you are not using a viewer that supports UTF-8.<br /> <br /> ==Mainline Campaigns==<br /> <br /> ===An Orcish Incursion===<br /> <br /> ===Dead Water===<br /> <br /> ===Delfador's Memoirs===<br /> S13: &quot;This was ill tidings for men and Elves alike.&quot;<br /> This was -&gt; These were<br /> <br /> ===Descent into Darkness===<br /> <br /> ===Eastern Invasion===<br /> S1: &quot;In the days of the king Garard I...&quot;<br /> king Garard I -&gt; King Garard I<br /> <br /> ===Heir to the Throne===<br /> <br /> ===Liberty===<br /> <br /> ===Northern Rebirth===<br /> S05a: &quot;The hole wasn’t big enough for me to go through but one you little guys you might fit.&quot;<br /> one you little guys you might fit -&gt; one of you little guys might fit<br /> S07a: &quot;That’s why we have come here, to seek yours and your brothers help in defeating the orcs.&quot;<br /> yours and your brothers -&gt; your and your brother's<br /> S09a: &quot;Pff, foolish human. What in the world gave you that idea.&quot;<br /> idea. -&gt; idea?<br /> <br /> ===Sceptre of Fire===<br /> S5: &quot;Och, its some o’ them cave-dwarves.&quot;<br /> its -&gt; it’s<br /> <br /> * data/campaigns/Sceptre_of_Fire/scenarios/1_A_Bargain_is_Struck.cfg:318 &quot;That'''‘'''s right. I’ll be coming over along with the silver.&quot;<br /> That‘s -&gt; That’s<br /> <br /> ===Son of the Black Eye===<br /> <br /> ===The Hammer of Thursagan===<br /> <br /> ===The Legend of Wesmere===<br /> S3: &quot;How can they dare to brake the treaty!&quot; brake -&gt; break<br /> <br /> ===The Rise of Wesnoth===<br /> <br /> ===The South Guard===<br /> <br /> ===Two Brothers===<br /> <br /> ===Under the Burning Suns===<br /> <br /> ==Wesnoth Game==<br /> <br /> ===Editor===<br /> <br /> ===Tutorial===<br /> <br /> ===Manual===<br /> <br /> ===Manpages===<br /> <br /> ===Units===<br /> <br /> ===1.10 Announcement===<br /> <br /> ===Other (ingame help, ...)===<br /> <br /> * Mechanical units generally have mechan'''o'''cal as their only trait. Since mechanical units don’t really have life, drain, poison and plague has no effect upon them.<br /> mechanocal -&gt; mechanical *fixed in development version<br /> <br /> ===Multiplayer maps===<br /> <br /> ===Translation code bugs===<br /> <br /> ==Unofficial campaigns==<br /> <br /> ===Invasion from the unknown===</div>

Gambit https://wiki.wesnoth.org/index.php?title=SpellingMistakes&diff=40272 2011-02-03T19:45:56Z

<p>Gambit: /* Other (ingame help, ...) */ Removed information about it being fixed. It is not fixed in trunk.</p> <hr /> <div>This page is meant to be a list of spelling mistakes in campaigns and other translatable texts in the en_US development version of the game.<br /> <br /> Note: The house style of Wesnoth uses a good many words and constructions that are archaic, poetic, or dialectal. If you speak modern English as a second language you may incorrectly read these as errors. Please see [[NotSpellingMistakes]] for a list of things you will encounter that may look like spelling or usage errors but are not. Note that the mainline campaigns are now using correct typography, including sexed quotes and en and em dashes. These will appear as three byte sequences if you are not using a viewer that supports UTF-8.<br /> <br /> ==Mainline Campaigns==<br /> <br /> ===An Orcish Incursion===<br /> <br /> ===Dead Water===<br /> <br /> ===Delfador's Memoirs===<br /> S13: &quot;This was ill tidings for men and Elves alike.&quot;<br /> This was -&gt; These were<br /> <br /> ===Descent into Darkness===<br /> <br /> ===Eastern Invasion===<br /> S1: &quot;In the days of the king Garard I...&quot;<br /> king Garard I -&gt; King Garard I<br /> <br /> ===Heir to the Throne===<br /> <br /> ===Liberty===<br /> <br /> ===Northern Rebirth===<br /> S05a: &quot;The hole wasn’t big enough for me to go through but one you little guys you might fit.&quot;<br /> one you little guys you might fit -&gt; one of you little guys might fit<br /> S07a: &quot;That’s why we have come here, to seek yours and your brothers help in defeating the orcs.&quot;<br /> yours and your brothers -&gt; your and your brother's<br /> S09a: &quot;Pff, foolish human. What in the world gave you that idea.&quot;<br /> idea. -&gt; idea?<br /> <br /> ===Sceptre of Fire===<br /> S5: &quot;Och, its some o’ them cave-dwarves.&quot;<br /> its -&gt; it’s<br /> <br /> * data/campaigns/Sceptre_of_Fire/scenarios/1_A_Bargain_is_Struck.cfg:318 &quot;That'''‘'''s right. I’ll be coming over along with the silver.&quot;<br /> That‘s -&gt; That’s<br /> <br /> ===Son of the Black Eye===<br /> <br /> ===The Hammer of Thursagan===<br /> <br /> ===The Legend of Wesmere===<br /> S3: &quot;How can they dare to brake the treaty!&quot; brake -&gt; break<br /> <br /> ===The Rise of Wesnoth===<br /> <br /> ===The South Guard===<br /> <br /> ===Two Brothers===<br /> <br /> ===Under the Burning Suns===<br /> <br /> ==Wesnoth Game==<br /> <br /> ===Editor===<br /> <br /> ===Tutorial===<br /> <br /> ===Manual===<br /> <br /> ===Manpages===<br /> <br /> ===Units===<br /> <br /> ===1.10 Announcement===<br /> <br /> ===Other (ingame help, ...)===<br /> <br /> * Mechanical units generally have mechan'''o'''cal as their only trait. Since mechanical units don’t really have life, drain, poison and plague has no effect upon them.<br /> mechanocal -&gt; mechanical<br /> <br /> ===Multiplayer maps===<br /> <br /> ===Translation code bugs===<br /> <br /> ==Unofficial campaigns==<br /> <br /> ===Invasion from the unknown===</div>

Gambit https://wiki.wesnoth.org/index.php?title=InterfaceActionsWML&diff=39907 2010-12-31T23:02:26Z

<p>Gambit: /* Other interface tags */ Updated information about the speaker attribute of [chat]</p> <hr /> <div>{{WML Tags}}<br /> == Interface actions ==<br /> <br /> Interface actions are actions that do not have an effect on gameplay;<br /> instead, they show something to the player. The main interface tags<br /> are '''[message]''' and '''[objectives]''', but several other tags affect<br /> the interface also.<br /> <br /> == [inspect] ==<br /> This user interface action only works in debug mode. It displays the gamestate inspector dialog (the same one which can be brought up with '':inspect'' ), which can be used to inspect the values of WML variables, AI configuration, recall lists, and more.<br /> <br /> * '''name''': optional attribute to specify the name of this gamestate inspector dialog. It is just a label to help differentiate between different invocations of gamestate inspector dialog.<br /> <br /> == [message] ==<br /> The most commonly used interface action is [message], which displays a message to the user in a dialog box. It can also be used to take input from the user.<br /> <br /> The following key/tags are accepted for [message]:<br /> * [[StandardUnitFilter]]: The unit whose profile and name are displayed. Do not use a [filter] tag. If no unit matching this filter is found, the message is not displayed (The unit has probably been killed).&lt;br&gt;'''[message]''' elements should be constructed so that it is either guaranteed that a certain unit is alive, or so that dialog flows smoothly even if the message isn't displayed.<br /> <br /> * '''speaker''': an alternative to standard unit filter. You may specify as the value of the speaker attribute a unit id or any of the following special values:<br /> ** '''narrator''': the dialog box is displayed without a caption for the unit speaking or a unit image<br /> ** '''unit''': the primary unit for the event is speaking<br /> ** '''second_unit''': the secondary unit for the event is speaking<br /> <br /> * '''message''': (translatable) the text to display to the right of the image. ''message'' is sometimes multiple lines; if it is, be sure to use quotes(''' ' ''' or ''' &quot; ''')<br /> * '''[show_if]''': if present then this message will only be displayed if the conditional statement in this tag is passed (see [[ConditionalActionsWML#Condition_Tags|ConditionalActionsWML]])<br /> * '''side_for''': (default: all sides) comma-separated list of sides for who message is shown.<br /> * '''image''': (default: profile image of speaker) the image to display next to the message.<br /> * '''caption''': (default: name of speaker) the caption to display beside the image. Name to be displayed. Note: use a translation mark to avoid wmllint errors.<br /> * '''scroll''': {{DevFeature1.9}} Boolean specifying whether the game view should scroll to the speaking unit. Defaults to ''yes''.<br /> * '''duration''': (default: 10) the minimum number of frames for this message to be displayed. (A frame lasts about 30 milliseconds.) During this time any dialog decisions will be disregarded.<br /> * '''sound''': a sound effect (wav file) to play as the message is displayed. This can be a comma-separated list, from which one will be randomly chosen.<br /> * '''[option]''': No '''[option]''' elements have to be used. If '''[option]''' elements are present, then each option will be displayed in a menu for the user to select one option.<br /> ** '''message''': (translatable) the text displayed for the option (see [[DescriptionWML]])<br /> ** '''[show_if]''': if present then this option will only be displayed if the conditional statement in this tag is passed (see [[InternalActionsWML]])<br /> ** '''[command]''': an element containing actions which are executed if the option is selected.<br /> * '''[text_input]''': there can be only one [text_input] tag. this adds a text input field to the message.<br /> ** '''variable''': the variable that the user's input will be written to<br /> ** '''label''': a text label to the left of the input field<br /> ** '''max_length''': the maximum number of characters that may be typed into the field<br /> ** '''text''': text that is written into the field in the beginning<br /> * Check [[EventWML#Multiplayer_safety]] to find out in which events you can safely use '''[option]''' and '''[text_input]''' without causing OOS.<br /> <br /> === Formatting ===<br /> In 1.8, [http://library.gnome.org/devel/pango/unstable/PangoMarkupFormat.html Pango markup formatting codes] have been adopted for '''[message]'''. These can also be used in unit names (user_description), objectives, and such. Note that you'll probably want to use a single quote ' instead of a double quote &quot; as double quotes cannot be escaped, otherwise the string will appear fragmented and you may also encounter errors. Running wmllint on your campaign will up-convert it, warning you about unusual cases you must fix by hand.<br /> <br /> For example, if you wanted to write &quot;You are victorious!&quot; in large, italic, gold letters, you might write it this way:<br /> <br /> &lt;nowiki&gt;&lt;span color='#BCB088' size='large' font-style='italic'&gt;You are victorious!&lt;/span&gt;&lt;/nowiki&gt;<br /> <br /> <br /> These are the codes taken from the Pango markup formatting guide:<br /> <br /> *'''font''', '''font_desc''': A font description string, such as &quot;Sans Italic 12&quot;.<br /> *'''font_family''', '''face''': A font family name.<br /> *'''font_size''', '''size''': Font size in 1024ths of a point, or one of the absolute sizes 'xx-small', 'x-small', 'small', 'medium', 'large', 'x-large', 'xx-large', or one of the relative sizes 'smaller' or 'larger'.<br /> *'''font_style''', '''style''': One of 'normal', 'oblique', 'italic'.<br /> *'''font_weight''', '''weight''': One of 'ultralight', 'light', 'normal', 'bold', 'ultrabold', 'heavy', or a numeric weight.<br /> *'''font_variant''', '''variant''': One of 'normal' or 'smallcaps'.<br /> *'''font_stretch''', '''stretch''': One of 'ultracondensed', 'extracondensed', 'condensed', 'semicondensed', 'normal', 'semiexpanded', 'expanded', 'extraexpanded', 'ultraexpanded'.<br /> *'''foreground''', '''fgcolor''', '''color''': An RGB color specification such as '#00FF00' or a color name such as 'red'.<br /> *'''background, bgcolor''': An RGB color specification such as '#00FF00' or a color name such as 'red'.<br /> *'''underline''': One of 'none', 'single', 'double', 'low', 'error'.<br /> *'''underline_color''': The color of underlines; an RGB color specification such as '#00FF00' or a color name such as 'red'.<br /> *'''rise''': Vertical displacement, in 10000ths of an em. Can be negative for subscript, positive for superscript.<br /> *'''strikethrough''': 'true' or 'false' whether to strike through the text.<br /> *'''strikethrough_color''': The color of strikethrough lines; an RGB color specification such as '#00FF00' or a color name such as 'red'<br /> *'''fallback''': 'true' or 'false' whether to enable fallback. If disabled, then characters will only be used from the closest matching font on the system. No fallback will be done to other fonts on the system that might contain the characters in the text. Fallback is enabled by default. Most applications should not disable fallback.<br /> *'''letter_spacing''': Inter-letter spacing in 1024ths of a point.<br /> *'''gravity''': One of 'south', 'east', 'north', 'west', 'auto'.<br /> *'''gravity_hint''': One of 'natural', 'strong', 'line'.<br /> <br /> <br /> In 1.6, Wesnoth uses older text formatting options<br /> * A tilde (~) as the first character causes the line to be boldfaced.<br /> * An at symbol (@) as the first character causes the line to be green, as done with victory conditions.<br /> * A pound symbol (#) as the first character causes the line to be red, as done with defeat conditions.<br /> * An asterisk (*) as the first character causes the line to be bigger.<br /> * A backquote (`) as the first character causes the line to be smaller.<br /> * If used, the caption key text is boldfaced.<br /> * An RGB colour code in the beginning causes the line to be the given colour. This can still be preceded by the above characters. Example: ''message=_&quot;&lt;255,0,0&gt;Red!&quot;''<br /> <br /> == [objectives] ==<br /> The other tag used for plot development is '''[objectives]'''.<br /> The '''[objectives]''' tag overwrites any previously set objectives,<br /> and displays text which should describe the objectives of the scenario.<br /> Scenario objectives are displayed on the player's first turn after the tag is used,<br /> or as part of the event if it triggers during that player's turn.<br /> Objectives can also be accessed at any time in a scenario using the<br /> &quot;Scenario Objectives&quot; game menu option, making this tag useful for<br /> scenario-specific information that the player may need to refer to during play.<br /> <br /> This tag renders the ''objectives'' attribute of [scenario] obsolete (see ''objectives'', [[ScenarioWML]]).<br /> Instead of using ''objectives'', use '''[objectives]''' to set scenario objectives inside a prestart event.<br /> It can also be used to overwrite the starting objectives mid-scenario.<br /> <br /> Attributes of '''[objectives]''':<br /> * '''side''': Default '0'. The side to set the objectives for. A value of 0 sets objectives for all sides.<br /> * '''summary''': Displayed first in the objectives text, this should describe the basic objective for the overall scenario. Can be omitted.<br /> * '''note''': Displayed last in the objectives text, this is sometimes used for hints or additional information. Can be omitted.<br /> * '''victory_string''': Default ' _ &quot;Victory:&quot;', this text precedes the victory objectives.<br /> * '''defeat_string''': Default ' _ &quot;Defeat:&quot;', this text precedes the defeat objectives.<br /> * '''gold_carryover_string''' {{DevFeature1.9}}: Default ' _ &quot;Gold carryover:&quot;', this text precedes the gold carryover information.<br /> * '''notes_string''' {{DevFeature1.9}}: Default ' _ &quot;Notes:&quot;', this text precedes the notes.<br /> * '''silent''': Default: not present. If set to &quot;yes&quot;, the objectives are silently changed. Else, they will be shown to the user when appropriate.<br /> <br /> Tags of '''[objectives]''':<br /> * '''[objective]''': describes a win or loss condition. Most scenarios have multiple win or loss conditions, so use a separate [objective] subtag for each line; this helps with translations.<br /> ** '''description''': text for the specific win or loss condition.<br /> ** '''condition''': The color and placement of the text. Values are 'win'(colored green, placed after ''victory_string'') and 'lose'(colored red, placed after ''defeat_string'')<br /> ** '''show_turn_counter''' {{DevFeature1.9}}: If set to yes, displays the number of turns remaining in the scenario. Default is no.<br /> ** '''[show_if]''': A condition that disables the objective if it doesn't hold. Conditional objectives are refreshed at '''[show_objectives]''' time only. {{DevFeature}}<br /> * '''[gold_carryover]''' {{DevFeature1.9}}: describes how the gold carryover works in this scenario. This is intended to be a more convenient way of displaying carryover information than using the note= key in [objectives].<br /> ** '''bonus''' (boolean): whether an early finish bonus is granted. If omitted, early finish bonus is not mentioned.<br /> ** '''carryover_percentage''': the amount of carryover gold. If omitted, the amount is not mentioned.<br /> * '''[note]''' {{DevFeature1.9}}: describes a note, usually used for hints or additional information. This is an easier way of adding several notes than concatenating them together into a single string to use with the ''note='' key.<br /> ** '''description''': the text of the note.<br /> <br /> === Macros ===<br /> There are a few predefined macros for Objectives that you can use to shorten the code: [http://www.wesnoth.org/macro-reference.xhtml#SET_OBJECTIVES SET_OBJECTIVES], [http://www.wesnoth.org/macro-reference.xhtml#VICTORY_CONDITION VICTORY_CONDITION], and [http://www.wesnoth.org/macro-reference.xhtml#DEFEAT_CONDITION DEFEAT_CONDITION]. Follow the links for each one to see complete syntax and example usage.<br /> <br /> == [set_menu_item] ==<br /> This tag is used to add a custom option in the right-click context menu which can then be used to trigger arbitrary WML commands.<br /> <br /> '''Note:''' Due to limitations in portable devices where there are no scroll bars for context menus, there is a hard-coded limit of 7 custom WML menu items. If you really need to have more than 7 menu items, try combining some of them in a submenu.<br /> <br /> * '''id''': the unique id for this menu item. If a menu item with this id already exists, it allows you to set specific changes to that item.<br /> * '''description''': the in-game text that will appear for this item in the menu.<br /> * '''image''': the image to display next to this item.<br /> * '''needs_select''': if ''yes'' (default ''no''), then the latest select event (see [[EventWML]]) that triggered before this menu item was chosen will be transmitted over the network before this menu item action will be. This only has any effect in networked multiplayer, and is intended to allow more elaborate menu item behaviour there without causing out of sync errors. If you don't know what this means, just leave it false.<br /> * '''[show_if]''': If present, the menu item will only be available if the conditional statement (see [[InternalActionsWML]]) within evaluates to true. When this is evaluated, the WML variables ''$x1'' and ''$y1'' will point to the location on which the context menu was invoked, so it's possible to for example only enable the option on empty hexes or on a particular unit.<br /> * '''[filter_location]''': contains a location filter similar to the one found inside Single Unit Filters (see [[FilterWML]]). The menu item will only be available on matching locations.<br /> * '''[command]''': contains the WML actions to be executed when the menu item is selected. Again, the WML variables ''$x1'' and ''$y1'' will point to the location on which the context menu was invoked on.<br /> <br /> == Other interface tags ==<br /> <br /> The following tags are also action tags:<br /> * '''[item]''': makes a graphical item appear on a certain hex. Note this only places the graphics for an item. It does not make the item do anything. Use a moveto event to make moving onto the item do something. &lt;tt&gt;''('''Hint:''' There are a number of predefined items that are used in various campaigns that you can make use of. You can find [http://www.wesnoth.org/macro-reference.xhtml#file:items.cfg a list of them] if you look into the items.cfg file in the wesnoth install directory (under /data/core/macros))''&lt;/tt&gt;<br /> ** '''x''', '''y''': the location to place the item.<br /> ** '''image''': the image (in ''images/'' as .png) to place on the hex.<br /> ** '''halo''': an image to place centered on the hex. Use this instead of ''image'' if the image is bigger than the hex or if you want to animate an image. ''Example (where the integer after the colon is the duration of each frame): halo=scenery/fire1.png:100,scenery/fire2.png:100,scenery/fire3.png:100,scenery/fire4.png:100,scenery/fire5.png:100,scenery/fire6.png:100,scenery/fire7.png:100,scenery/fire8.png:100''<br /> ** '''team_name''': name of the team for which the item is to be displayed (hidden for others). For multiple teams just put all the names in one string, for example separated by commas.<br /> ** '''visible_in_fog''': whether the item should be visible through fog or not. Default yes.<br /> * '''[removeitem]''': removes any graphical items on a given hex. (In version 1.9.2, this was renamed to '''[remove_item]''')<br /> ** '''x''', '''y''': the hex to remove items off<br /> ** '''image''' if specified, only removes the given image item (This image name must include any [[ImagePathFunctionWML|image path functions]] appended to the original image name.)<br /> * '''[print]''': displays a message across the screen. The message will disappear after a certain time.<br /> ** '''text''': (translatable) the text to display.<br /> ** '''size''': (default=12) the pointsize of the font to use<br /> ** '''duration''': (default=50) the length of time to display the text for. This is measured in the number of 'frames'. A frame in Wesnoth is usually displayed for around 30ms.<br /> ** '''red''', '''green''', '''blue''': (default=0,0,0) the color to display the text in. Values vary from 0-255.<br /> * '''[move_unit_fake]''': moves an image of a unit along a certain path on the map. The path does not need to be a continuous list of adjacent hexes, so for example only the start and end points can be given, in which case the straightest line between those points will be calculated and used.<br /> ** '''type''': the type of the unit whose image to use<br /> ** '''x''': a comma-separated list of x locations to move along<br /> ** '''y''': a comma-separated list of y locations to move along (x and y values are matched pairs)<br /> ** '''side''': the side of the fake unit, used for team-coloring the fake unit<br /> ** '''gender''': the gender of the fake unit. Example: gender=female<br /> ** '''variation''': the variation of the fake unit. Example: variation=undead<br /> * '''[move_units_fake]''': {{DevFeature1.9}} moves multiple images of units along paths on the map. These units are moved in lockstep.<br /> ** '''[fake_unit]''': A fake unit to move<br /> *** '''type''': the type of unit whose image to use<br /> *** '''x''': a comma-separated list of x locations to move along<br /> *** '''y''': a comma-separated list of y locations to move along (x and y values are matched pairs)<br /> *** '''side''': the side of the fake unit, used for team-coloring the fake unit<br /> *** '''skip_steps''': the number of steps to skip before this unit starts moving<br /> * '''[hide_unit]''': temporarily prevents the engine from displaying the given unit. The unit does not become invisible, as it would be with the '''[hides]''' ability; it is still the same plain unit, but without an image. Useful in conjunction with '''[move_unit_fake]''': to move a leader unit into position on-screen. Each '''[hide_unit]''' tag only hides one unit.<br /> ** '''x''', '''y''': location of the unit to be hidden. (NOT a standard unit filter! Just x and y.)<br /> ** {{DevFeature1.9}}: '''[hide_unit]''' accepts a [[StandardUnitFilter]] as argument and can disable several units at once.<br /> * '''[unhide_unit]''': stops the currently hidden units from being hidden.<br /> ** {{DevFeature1.9}}: '''[unhide_unit]''' accepts a [[StandardUnitFilter]] as argument.<br /> * '''[scroll]''': Scroll a certain number of pixels in a given direction. Useful for earthquake/shaking effects.<br /> ** '''x''', '''y''': the number of pixels to scroll along the x and y axis<br /> * '''[scroll_to]''': Scroll to a given hex<br /> ** '''x''', '''y''': the hex to scroll to<br /> ** '''check_fogged''': whether to scroll even to locations covered in fog or shroud. Possible values ''true'' (don't scroll to fog) and ''false'' (scroll even to fog), with ''false'' as the default.<br /> * '''[scroll_to_unit]''' Scroll to a given unit<br /> ** [[StandardUnitFilter]]<br /> ** '''check_fogged''': whether to scroll even to locations covered in fog or shroud. Possible values ''true'' (don't scroll to fog) and ''false'' (scroll even to fog), with ''false'' as the default.<br /> * '''[select_unit]''': {{DevFeature1.9}} Selects a given unit<br /> ** [[StandardUnitFilter]]<br /> ** '''fire_event''': whether a ''select'' event should be triggered or not (def. ''no'').<br /> ** '''highlight''': whether the unit's current hex should be highlighted (def. ''yes'').<br /> * '''[sound]''': Plays a sound<br /> ** '''name''': the filename of the sound to play (in ''sounds/'' as .wav or .ogg)<br /> ** '''repeat''': repeats the sound for a specified additional number of times (default=0)<br /> * '''[sound_source]''': Creates a sound source. &quot;Sound sources&quot; is a general name for a mechanism which makes possible for map elements to emit sounds according to some rules, where &quot;map elements&quot; can be specific locations or terrain types. For now, only sound sources tied to locations are supported.<br /> ** '''id''': a unique identification key of the sound source<br /> ** '''sounds''': a list of comma separated, randomly played sounds associated with the sound source<br /> ** '''delay''': a numerical value (in milliseconds) of the minimal delay between two playbacks of the source's sound if the source remains visible on the screen; if one scrolls out and back in, the source will be considered as ready to play<br /> ** '''chance''': a percentage (a value from 0 to 100) describing the chance of the source being activated every second after the delay has passed or when the source's location appears on the screen (note that it cannot play more than one file at the same time)<br /> ** '''check_fogged''': possible values &quot;true&quot; and &quot;false&quot; - if true the source will not play if its locations are fogged<br /> ** '''check_shrouded''': {{DevFeature}} possible values &quot;true&quot; and &quot;false&quot; - if true the source will not play if its locations are shrouded<br /> ** '''x,y''': similar to x,y as found in a [[StandardLocationFilter]], these are the locations associated with the sound source<br /> ** '''fade_range''' (default = 3): distance in hexes that determines a &quot;circular&quot; area around the one specified by '''full_range''' where sound volume fades out linearly<br /> ** '''full_range''' (default = 14): distance in hexes that determines a &quot;circular&quot; area where source plays with full volume, relative to screen center<br /> ** '''loop''': number of times a sound sample should be looped if it stays visible. -1 means infinite (~65000)<br /> * '''[remove_sound_source]''': Removes a previously defined sound source.<br /> ** '''id''': the identification key of the sound source to remove<br /> * '''[music]''': Switches to playing different music<br /> ** '''name''': the filename of the music to play (in ''music/'' as .ogg)<br /> ** see [[MusicListWML]] for the correct syntax<br /> * '''[volume]''': {{DevFeature1.9}} Changes the game volume to a percent of the preferences volume for the game being played. Values can go from 0 to 100: <br /> ** '''music''': Changes the music volume.<br /> ** '''sound''': Changes the sound volume.<br /> * '''[colour_adjust]''': tints the color of the screen. {{DevFeature1.9}}: now named '''[color_adjust]'''.<br /> ** '''red''', '''green''', '''blue''': values from -255 to 255, the amount to tint by for each color<br /> * '''[delay]''': pauses the game<br /> ** '''time''': the time to pause in milliseconds<br /> * '''[redraw]''': redraws the screen (this normally isn't done during events, although some of the other interface actions cause the screen or parts of it to be redrawn).<br /> ** '''side''': if used, recalculates fog and shroud for that side. Useful if you for example spawn friendly units in the middle of an event and want the shroud to update accordingly (otherwise units that spawn inside fog would remain invisible for the duration of the event, since the fog would not automatically get cleared around them).<br /> * '''[unit_overlay]''': sets an image that will be drawn over a particular unit, and follow it around<br /> ** '''x''', '''y''': the location of the unit to overlay on<br /> ** '''image''': the image to place on the unit<br /> ** {{DevFeature1.9}}: '''[unit_overlay]''' accepts a [[StandardUnitFilter]] as argument<br /> * '''[remove_unit_overlay]''': removes a particular overlayed image from a unit<br /> ** '''x''', '''y''': the location of the unit to remove an overlay from<br /> ** '''image''': the image to remove from the unit<br /> ** {{DevFeature1.9}}: '''[remove_unit_overlay]''' accepts a [[StandardUnitFilter]] as argument<br /> * '''[animate_unit]''': Uses an animation of a unit to animate it on screen (if the unit has the corresponding animation).<br /> ** '''flag''': The key to find the custom animation in the unit description (see the '''[extra_anim]''' description in [[AnimationWML]]). Standard animations can be triggered with the following keywords: ''leading recruited standing idling levelin levelout healing healed poisoned movement defend attack death victory pre_teleport post_teleport''<br /> ** '''[filter]''' with a [[StandardUnitFilter]] as argument, see [[FilterWML]]. By default, the unit at the event location will be animated. You can use this tag to choose any other unit to animate.<br /> ** '''[primary_attack]''': If this tag is not present, the filter for animation will be triggered with no attack. If it is here, all attacks from the unit will be filtered, and a matching one will be used to filter the animation. Takes a weapon filter as argument, see [[FilterWML]].<br /> ** '''[secondary_attack]''': Similar to '''[primary_attack]'''. May be needed to trigger a defense animation correctly, if there are more than one animations available for the defending unit.<br /> ** '''hits''': yes/no/hit/miss/kill: which according variation of a attack/defense animation shall be chosen (required)<br /> ** '''text''': a text to hover during the animation <br /> ** '''red''': red value for the text color (0-255)<br /> ** '''green''': green value for the text color<br /> ** '''blue''': blue value for the text color<br /> ** '''with_bars''': yes/no: whether to display the status bars during the animation (e.g. the hitpoint bar)<br /> ** '''[animate]''': a sub block with the same syntax as '''[animate_unit]''' except that the '''[filter]''' block is mandatory to find the unit. This block will find and animate another unit simultaneously.<br /> ** '''[facing]''': a [[StandardLocationFilter]] specifying what direction the unit should be facing when animated<br /> * '''[label]''' places a label on the map.<br /> ** '''x''', '''y''': the location of the label<br /> ** '''text''': what the label should say<br /> ** '''team_name''': if specified, the label will only be visible to the given team.<br /> ** '''colour''': color of the label. The format is r,g,b; r, g and b are numbers between 0 and 255. {{DevFeature1.9}}: now named '''color'''.<br /> ** '''visible_in_fog''': whether the label should be visible through fog or not. Default yes.<br /> ** '''visible_in_shroud''': whether the label should be visible through shroud or not. Default no.<br /> ** '''immutable''': whether this label is protected from being removed or changed by players. Default yes. {{DevFeature1.9}}<br /> * '''[floating_text]''': {{DevFeature1.9}} floats text (similar to the damage and healing numbers) on the given locations.<br /> ** [[StandardLocationFilter]]: the text will be floated on all matching locations simultaneously.<br /> ** '''text''': the text to display.<br /> * '''[deprecated_message]''' shows a deprecated message in the message area, this feature is only intended to be used to warn about deprecated macros in mainline. The message is not translatable.<br /> ** '''message''': the message to show.<br /> * '''[wml_message]''' outputs a message to Wesnoth's console output. Intended for campaign designers to output silent text to the console, without annoying the player; then, that text might contain information useful for later bug-reporting. The log domain for it is '''wml''', and the '''debug/dbg''' log level is available for use with the '''logger''' attribute. Depending on the current log level ('''error''' by default), which may be changed with the in-game :log command, or the --log-&lt;level&gt;=wml command line switch, the messages are echoed to the in-game chat.<br /> ** '''message''': the message to show.<br /> ** '''logger''': the Wesnoth engine output logger that should catch the text; this might be 'err' (the errors log level), 'warn'/'wrn' (the warnings log level) or anything else (the information log level). Not all information will be displayed depending on the log level chosen when starting Wesnoth.<br /> * '''[open_help]''' opens the in-game help.<br /> ** '''topic''': the id of the topic to open<br /> * '''[show_objectives]''': {{DevFeature}} refreshes the objectives defined by [objectives] and its [show_if] tags, and displays them. (It is also called whenever the user explicitly asks for the objectives; this matters only if the tag was overridden by a [[LuaWML#register_wml_action|Lua]] script.)<br /> ** '''side''': the side to show the objectives. If not set, all sides are used.<br /> * '''[chat]''' displays a message in the chat area. {{DevFeature1.9}}<br /> ** '''speaker''': A string for the name of the sender of the message.<br /> ** '''message''': The message that should be displayed<br /> ** '''side''': A comma separated list of sides to show the message to. If the same machine controls multiple sides that are in this list, then the message will only be displayed once. If left blank the message will be send to all sides.<br /> <br /> == Useful Macros ==<br /> There are some predefined macros that you find useful for interface actions. You can find a complete list along with a detailed explanation of how they work [http://www.wesnoth.org/macro-reference.xhtml here].<br /> * '''{FLOATING_TEXT}''' Float some text over a unit similar to the damage numbers.<br /> * '''{HIGHLIGHT_UNIT}''' Highlight a unit on the map. Use this to show important units<br /> * '''{HIGHLIGHT_IMAGE}''' Places and highlights an image on the map. Use this to show important items or locations<br /> * '''{SET_IMAGE}''' Places an image on the map which has no other function.<br /> * '''{QUAKE &lt;soundfile&gt;}''' Creates a tremor like screenshake and plays &lt;soundfile&gt;. ('''{TREMOR}''' is a deprecated version, equivalent to '''{QUAKE (rumble.ogg)}''')<br /> * '''{FLASH_WHITE}''' Flash the screen white momentarily. You can also replace WHITE with RED, BLUE or GREEN for a different colour.<br /> <br /> == See Also ==<br /> * [[DirectActionsWML]]<br /> * [[InternalActionsWML]]<br /> * [[EventWML]]<br /> * [[ReferenceWML]]<br /> <br /> <br /> [[Category: WML Reference]]<br /> [[Category: ActionsWML]]</div>

Gambit https://wiki.wesnoth.org/index.php?title=EventWML&diff=38107 2010-08-30T12:24:28Z

<p>Gambit: /* The 'name' Key (Mandatory) */ re-reordering</p> <hr /> <div>{{WML Tags}}<br /> == The [event] Tag ==<br /> <br /> This tag is a subtag of the [scenario], [unit_type] and [era] tags which is used to describe a set of actions which trigger at a certain point in a scenario. When used in a [scenario] tag (also includes [multiplayer], [tutorial] and [test]), the event only occurs in that scenario. When used in a [unit_type] tag, the event will occur in all scenarios in which a unit of that type appears in (only after such a unit appears during the scenario, however). When used in an [era], the event will occur in any scenario which is played using that era.<br /> <br /> This tag has keys and child tags that control when and if the event actions will be triggered. Most important of these is the '''name''' key. Without it, no error will be raised but the event will never fire. Therefore, from a practical standpoint, it can be considered mandatory. All of the others can be used or not and the event actions will fire either way.<br /> <br /> '''Lexicon side note:''' ''The word &quot;event&quot; in the [event] tag itself may be considered an abbreviation of the word &quot;event handler&quot; because it is technically not a game &quot;event&quot; but an event '''handler''' for the game events fired with the given 'name'. However, this distinction is usually unimportant in most discussions and the event handlers are therefore simply referred to as &quot;events&quot; in this documentation.''<br /> <br /> === The 'name' Key (Mandatory) ===<br /> <br /> Usage:<br /> name=&lt;value&gt;<br /> <br /> This key defines which game event or trigger your [event] tag will be handling. This 'name' key should not be confused with a descriptive comment; it is rather a precise value which must match the predefined game event's name to be valid.<br /> <br /> '''Lexicon side note:''' ''It is not uncommon to refer to these values as the 'trigger' for an event and, furthermore, to call an event by its 'trigger' name. For example, in an event containing '''name=moveto''', a person might refer to the event as a ''''moveto''' event' and/or refer to the ''''moveto''' trigger' in the event or even talk about the 'event trigger' when referring to the '''moveto''' value of the 'name' key in that event. Some or all of this usage can, in fact, be found throughout this page.''<br /> <br /> The '''name''' key can accept a list of comma separated values describing when the event will be triggered.* These values may be either predefined event types or custom event names not matching any predefined type.<br /> <br /> For example:<br /> <br /> name=attacker misses,defender misses<br /> <br /> ''* Note that unless you use [[#first_time_only|first_time_only=no]], the event will fire only once, '''not''' once for each listed type.''<br /> <br /> ==== Predefined 'name' Key Values ====<br /> <br /> All predefined event types are listed here along with a description of when this value will cause the event to be triggered. Any value ''not'' listed here is a custom event name which can be triggered only by a '''[fire_event]''' tag somewhere else. Spaces in event names can be interchanged with underscores (for example, '''name=new turn''' and '''name=new_turn''' are equivalent).<br /> <br /> ; preload<br /> : Triggers before a scenario 'prestarts' and when loading a savegame -- before anything is shown on the screen at all. Can be used to set up the [[LuaWML|Lua]] environment: loading libraries, defining helper functions, etc.<br /> : '''Note:''' Unlike prestart and start, the preload event '''must be able to fire more than once!''' This is because it is triggered each time a savegame is loaded in addition to the initial time when it loads before the scenario 'prestart'. This means that it is effectively ''mandatory'' to have the [[#first_time_only|first_time_only=no]] key value in a preload event. <br /> <br /> ; prestart<br /> : Triggers before a scenario 'starts' -- before anything is shown on the screen at all. Can be used to set up things like village ownership. For things displayed on-screen such as character dialog, use '''start''' instead.<br /> : '''Note:''' ''This value makes the [[#first_time_only|first_time_only]] key irrelevant since, by definition, it can only fire once.''<br /> <br /> ; start<br /> : Triggers after the map is shown but before the scenario begins -- before players can 'do' anything.<br /> : '''Note:''' ''This value makes the [[#first_time_only|first_time_only]] key irrelevant since, by definition, it can only fire once.''<br /> <br /> ; new turn<br /> : Triggers at the start of every turn (not side turn). See also [[#first_time_only|first_time_only=no]]. Before any events of this type trigger, the value of the WML variable '''turn_number''' is set to the number of the turn that is beginning.<br /> <br /> ; turn end {{DevFeature1.9}}<br /> : Triggers at the end of every turn (not side turn). See also [[#first_time_only|first_time_only=no]]. The WML variable '''side_number''' will contain the side that ended their turn.<br /> <br /> ; turn ''X'' end {{DevFeature1.9}}<br /> : Triggers at the end of turn ''X''.<br /> <br /> ; side turn<br /> : Triggers when a side is about to start its turn. Before events of this type trigger, the value of the WML variable '''side_number''' is set to the number of the side of the player about to take their turn. This is before any healing takes place for that side, before calculating income, and before restoring unit movement and status.<br /> <br /> ; ai turn<br /> : Triggered just before the AI is invoked for a side. This is called after ''side turn'', and thus the WML variable '''side_number''' still holds the number of this side. Note that this event might be called several times per turn in case that fallbacks to human or droiding is involved. I.e. it happens at the middle of turn of human side 1 if the human player droids his side. It happens after the selection of ai to play the turn but before AI is told that new turn has come.<br /> : '''Note:''' ''This event currently breaks replays since it is not explicitly saved in a replay and there is no AI involved in replays...''<br /> <br /> ; turn refresh<br /> : Like '''side turn''', triggers just before a side is taking control but '''after''' healing, calculating income, and restoring unit movement and status.<br /> <br /> ; turn ''X''<br /> : Triggers at the start of turn ''X''. It's the first side initialization event. <br /> :Side initialization events go in the order of: <br /> : 1) '''turn ''X''''' <br /> :2) '''new turn''' <br /> :3) '''side turn''' <br /> :4) '''side ''X'' turn''' <br /> :5) '''side turn ''X''''' <br /> :6) '''side ''X'' turn ''Y''''' <br /> :7) '''turn refresh''' <br /> :8) '''side ''X'' turn refresh''' <br /> :9) '''turn ''X'' refresh''' <br /> :10) '''side ''X'' turn ''Y'' refresh'''<br /> <br /> ; side ''X'' turn ''Y''<br /> : This event triggers at the start of turn ''Y'' of side X {{DevFeature}}<br /> <br /> ; side ''X'' turn<br /> : This event triggers at the start of any turn of side X {{DevFeature}}<br /> : '''Note:''' ''Of course, [[#first_time_only|first_time_only=no]] is needed for this event to be triggered more than once.''<br /> <br /> ; side turn ''X''<br /> : This event triggers at the start of any side on turn X {{DevFeature1.9}}<br /> : '''Note:''' ''Of course, [[#first_time_only|first_time_only=no]] is needed for this event to be triggered more than once.''<br /> <br /> ; side X turn Y refresh<br /> : This event triggers at the turn refresh for side X on turn Y {{DevFeature1.9}}<br /> <br /> ; side ''X'' turn refresh<br /> : This event triggers at the turn refresh for side X {{DevFeature1.9}}<br /> : '''Note:''' ''Of course, [[#first_time_only|first_time_only=no]] is needed for this event to be triggered more than once.''<br /> <br /> ; turn ''X'' refresh<br /> : This event triggers for any side at the refresh of turn X. {{DevFeature1.9}}<br /> : '''Note:''' ''Of course, [[#first_time_only|first_time_only=no]] is needed for this event to be triggered more than once.''<br /> <br /> ; side turn end {{DevFeature1.9}}<br /> : Triggers after a side ends its turn. Like side turn, there are also some variations for specific combinations of side number and turn number. Here is the order in which the turn end events trigger:<br /> :1) '''side turn end''' <br /> :2) '''side ''X'' turn end''' <br /> :3) '''side turn ''X'' end''' <br /> :4) '''side ''X'' turn ''Y'' end''' <br /> :5) '''turn end''' <br /> :6) '''turn ''X'' end''' <br /> <br /> ; time over<br /> : Triggers on turn ''turns''. (''turns'' is specified in [scenario])<br /> <br /> ; enemies defeated<br /> : Triggers when all units with '''canrecruit=yes''' (that is, all leaders) not allied with side 1 are killed.<br /> <br /> ; victory<br /> : In this scenario, any tag of the form '''[endlevel] result=victory [/endlevel]''' will be automatically preceded by all actions in this tag. It helps debugging if the victory event allows you to safely advance to any of the possible next maps after using the &quot;:n&quot; command. Scenarios where key units are picked up before the victory, or where some action chosen earlier determines which map to advance to, make it hard to quickly test scenarios in a campaign. (See also: [endlevel], [[DirectActionsWML]])<br /> <br /> ; defeat<br /> : In this scenario, any tag of the form '''[endlevel] result=defeat [/endlevel]''' will be automatically preceded by all actions in this tag. (See also [endlevel], [[DirectActionsWML]])<br /> <br /> <br /> Filters can be applied to the following event triggers (see [[FilterWML]]; see also below). The actions specified in the event tag will be executed only if the filter returns true. <br /> These event triggers are all actions by units ('''moveto''', '''attack''') or things that happen to units ('''recruit''', '''advance'''). When one of these events is triggered, the position of the active unit (referred to as the '''primary unit''') is stored in the variables '''x1''' and '''y1''' and the position of any unit that primary unit does something to is stored in the variables '''x2''' and '''y2''' (this unit is referred to as the '''secondary unit''' below). '' These units are also automatically stored in the variables 'unit' and 'second_unit' as if they had been stored using the '''[store_unit]''' tag. see [[SingleUnitWML]]<br /> <br /> ; moveto<br /> : Triggers after the primary unit moves. Typically this is used when the primary unit gets to a particular location and a filter for the location of the primary unit is included; remember that this is the location that the primary unit lands on, not the location it started on or any location it travels on.&lt;br /&gt;''An '''[allow_undo]''' tag anywhere within a moveto event will cancel any lack of undo functionality the event would have caused. Note that undo functionality will only move the unit back to its former location; it will not undo other changes to the game caused by the event. Thus it is up to the scenario designer to use this tag correctly.'' {{DevFeature}} $x2 and $y2 refer to the hex the unit came from.<br /> <br /> ; sighted<br /> : Triggers when the primary unit becomes visible to the secondary unit in particular after not being visible to the secondary unit's side (so if the secondary unit's side doesn't have shroud or fog, the event never triggers). This happens both when the primary unit moves into view during its turn, and when the secondary unit moves to a location where it can see the primary unit. (This editor hasn't tested whether the event triggers multiple times if the primary unit moves into view of multiple units at once, or if not, which one gets chosen to be the secondary unit here.) (Note: it appears that when a sighted event is triggered because an enemy unit moves into your field of view, the game engine cannot determine which unit (on your side) sees the unit that moved, and so it fires a ''name=sighted'' event without setting ''$second_unit''. This means that, for example, using ''speaker=second_unit'' inside a message tag may fail.) (Double note: it also appears that the sighted event in more recent versions of the game (1.6 and 1.7, maybe?) does not fire on enemy turns. That is, it only fires for units that become visible as a result of the motion of another unit, not for units that move into the vision of an enemy. This event is also buggy in general... it's usually better to use a moveto event with a [filter_vision] tag than to use a sighted event (and note that the combination of the two can achieve something like the old sighted event)).<br /> <br /> ; attack<br /> : Triggers when the primary unit attacks the secondary unit.<br /> <br /> ; attack end<br /> : Similar to '''attack''', but is triggered ''after'' the fight instead of before. Note that if either unit is killed during the fight, this event triggers before any '''die''' events.<br /> <br /> ; attacker hits<br /> : Triggers when the the primary unit (the attacker) hits the secondary unit (the defender). The value of the WML variable '''damage_inflicted''' is set to the number of hitpoints inflicted by the attacker.<br /> <br /> ; attacker misses<br /> : Same as ''attacker hits'', but is triggered when the attacker misses.<br /> <br /> ; defender hits<br /> : Triggers when the primary unit (the attacker) is hit in retaliation by the secondary unit (the defender). The value of the WML variable '''damage_inflicted''' is set to the number of hitpoints inflicted by the defender.<br /> <br /> ; defender misses<br /> : Same as ''defender hits'', but is triggered when the defender misses.<br /> <br /> ; stone<br /> : Triggers when the primary unit is hit by an attack with the 'stones' ability (See ''stones'', [[AbilitiesWML]]) by the secondary unit (the unit with the 'stones' ability). In {{DevFeature}}, this event name is changed to &quot;petrified&quot;.<br /> <br /> ; last breath<br /> : Triggers when the primary unit is killed by the secondary unit, but before the death animation is triggered. Use this instead of name=die when you want the primary unit to make a final [message]. <br /> <br /> ; die<br /> : Triggers when the primary unit is killed by the secondary unit. ''Note: The primary unit is not removed from the game until the end of this event. The primary unit can still be manipulated, will block other units from taking its hex, and will still be found by standard unit filters (except [have_unit]). To prevent this behavior, you can use [kill] to remove the unit immediately. However, this will stop any (still unfired) other events that also match the unit from firing afterwards, so use with caution.'' If you want to the primary unit to make a final [message], use name=last_breath, see above.<br /> <br /> ; capture<br /> : Triggers when the primary unit captures a village. The village may have been previously neutral, or previously owned by another side; merely moving into your own villages does not constitute a capture.<br /> <br /> ; recruit<br /> : Triggers when the primary unit is recruited. (That is, when a unit is recruited it will trigger this event and this event's filter will filter that unit.).<br /> <br /> ; prerecruit<br /> : Triggers when the primary unit is recruited but before it is displayed.<br /> <br /> ; recall<br /> : Triggers after a unit is recalled.<br /> <br /> ; prerecall<br /> : Triggers when a unit is recalled but before it is displayed.<br /> <br /> ; advance<br /> : Triggers just before the primary unit is going to advance to another unit.<br /> <br /> ; post advance<br /> : Triggers just after the primary unit has advanced to another unit.<br /> <br /> ; select<br /> : Triggers when the primary unit is selected. Also triggers when ending a move, as the game keeps the moving unit selected by selecting it again at the end of movement. ''Note: in networked multiplayer, these events are only executed by the client on which the event is triggered, leading to out of sync errors if you modify the game state in the event.''<br /> <br /> ; menu item ''X''<br /> : Triggers when a WML menu item with id=''X'' is selected. ''Note: if the menu item has a [command], this event may be executed before or after the command; there is no guarantee.''<br /> <br /> ==== Custom events ====<br /> <br /> An event with a custom name may be invoked using the [[InternalActionsWML#.5Bfire_event.5D|[fire_event]]] tag. Normally you'll use such custom events as named subroutines to be called by events with predefined types. One common case of this, for example, is that more than one '''sighted''' events might fire the same custom event that changes the scenario objectives.<br /> <br /> === Optional Keys and Tags ===<br /> <br /> These keys and tags are more complex ways to filter when an event should trigger:<br /> <br /> ==== first_time_only ====<br /> : Whether the event should be removed from the scenario after it is triggered. This key takes a [[ConditionalActionsWML#Boolean_Values|boolean]]; for example:<br /> : ''first_time_only=yes''<br /> :: Default behavior if key is omitted. The event will trigger the first time it can and never again.<br /> : ''first_time_only=no''<br /> :: The event will trigger every time the criteria are met instead of only the first time.<br /> <br /> ==== [filter] ====<br /> : The event will only trigger if the primary unit matches this filter.<br /> :* [[StandardUnitFilter]]: selection criteria<br /> <br /> ==== [filter_second] ====<br /> : Like [filter], but for the secondary unit.<br /> :* [[StandardUnitFilter]]: selection criteria<br /> <br /> ==== [filter_attack] ====<br /> : Can be used to set additional filtering criteria for the primary unit and the secondary unit that are not generally available in a standard unit filter. Can be used in events ''attack'', ''attacker hits'', ''attacker misses'', ''defender hits'', ''defender misses'' and ''attack end''. For more information and other filter keys, see [[FilterWML]].<br /> :* '''name''': the name of the weapon used.<br /> :* '''range''': the range of the weapon used.<br /> :* '''special''': filter on the attack's special power.<br /> <br /> ==== [filter_second_attack] ====<br /> : Like [filter_attack], but for the secondary unit.<br /> :* '''name''': the name of the weapon used.<br /> :* '''range''': the range of the weapon used.<br /> :* '''special''': filter on the attack's special power.<br /> <br /> ==== [event] ====<br /> : A special case 'action', the [event] tag may be used to create a [[#Nested Events|nested event]].<br /> <br /> ==== delayed_variable_substitution ====<br /> : This key is only relevant inside of a [[#Delayed Variable Substitution|nested event]] and controls when variable substitution will occur in those special case actions.<br /> <br /> === Actions triggered by [event] ===<br /> <br /> After the trigger conditions have been met, all action tags within the [event] tag are executed in the order they are written in.<br /> <br /> There are 3 main types of actions:<br /> * direct actions ([[DirectActionsWML]]) which have a direct effect on gameplay<br /> * display actions ([[InterfaceActionsWML]]) which show something to the user<br /> * internal actions ([[InternalActionsWML]]) which are used by WML internally<br /> <br /> Several actions use standard filters to find out which units<br /> to execute the command on. These are denoted by the phrases<br /> &quot;standard unit filter&quot; and &quot;standard location filter&quot;.<br /> <br /> === Nested Events ===<br /> <br /> There is one special type of action: event creation. By placing an '''[event]''' tag inside another '''[event]''' tag, the nested event is spawned (created) when the parent (outer) event is encountered (when executing the contents of the parent event).<br /> <br /> ([[#Nested Event Example|See Examples]])<br /> <br /> ==== Delayed Variable Substitution ====<br /> <br /> Variable substitution for a nested event can happen either when it is spawned by the parent event or when it is triggered itself. This is controlled with the key '''delayed_variable_substitution''' which is used in the nested event.<br /> <br /> If this key is set to ''yes'', the variables in the nested event will contain values from the turn in which the ''nested'' event was triggered. ''This is the default behavior if the key is omitted.'' If set to ''no'', the variables in the nested event are set at the time the ''parent'' event is triggered.<br /> <br /> This behavior can be fine tuned with a special syntax when referencing variables. Instead of the normal '''$variable''' syntax, use '''$|variable''' to cause a variable to contain values relevant to the turn in which the nested event was triggered even when '''delayed_variable_substitution''' is set to ''no''. In this way you can have a mix of variables relevant to the parent and nested event trigger times.<br /> <br /> ([[#Delayed Variable Substitution Example|See Examples]])<br /> <br /> == Multiplayer safety ==<br /> <br /> In multiplayer it is only safe to use WML that might require synchronization with other players because of input or random numbers (like [message] with input or options or [unstore_unit] where a unit might advance) in the following events. This is because in these cases WML needs data from other players to work right and/or do the same thing for all players. This data is only available after a network synchronization.<br /> <br /> List of synchronized events:<br /> * moveto<br /> * sighted <br /> * attack<br /> * attack_end <br /> * attacker hits <br /> * attacker misses <br /> * defender hits<br /> * defender misses <br /> * stone<br /> * last breath <br /> * menu item X<br /> * die<br /> * capture <br /> * recruit<br /> * prerecruit <br /> * recall <br /> * prerecall <br /> * advance <br /> * post_advance <br /> getting message options (etc) from the following events is not synchronized, except in the development version (1.9+svn):<br /> * new turn <br /> * side turn <br /> * turn X <br /> * side X turn <br /> * side X turn Y <br /> * turn refresh <br /> <br /> There is also the possibility of events that are normally synchronized when fired by the engine but can be non-synchronized when fired by WML tags from non-synchronized event. So when you are using them you must be extra careful. For example [unstore_unit] may trigger a unit advancement that will fire ''advance'' and ''post advance'' events.<br /> <br /> == A Trap for the Unwary ==<br /> <br /> It is perfectly possible (and, in fact, useful) to have multiple events with the same predefined name and thus the same trigger condition. However, it is not defined what order such events will fire in, so you need to code so the order <br /> will not matter.<br /> <br /> Because of the above, you need to beware of using macros to generate events. If you include a macro expanding to an event definition twice, the event will be executed twice (not once) each time the trigger condition fires. Consider this code:<br /> <br /> #define DOUBLE<br /> [event]<br /> name=multiply_by_2<br /> {VARIABLE_OP 2_becomes_4 multiply 2}<br /> [/event]<br /> #enddef<br /> <br /> {DOUBLE}<br /> {DOUBLE}<br /> <br /> {VARIABLE 2_becomes_4 2}<br /> <br /> [fire_event]<br /> name=multiply_by_2<br /> [/fire_event]<br /> <br /> {DEBUG_MSG &quot;$2_becomes_4 should be 4&quot;}<br /> <br /> After it executes, the debug message will reveal that the variable has been set to 8, not 4.<br /> <br /> == Miscellaneous Notes and Examples ==<br /> <br /> === Primary/Secondary Unit Speaker Example ===<br /> <br /> In events, the primary unit can be referred to as '''unit''' and the secondary unit can be referred to as '''second_unit''' in [message] tags using the '''speaker''' key. For example:<br /> <br /> [event]<br /> name=die<br /> [message]<br /> speaker='''second_unit'''<br /> message= _ &quot;Hahaha! I finally killed you!&quot;<br /> [/message]<br /> <br /> [message]<br /> speaker='''unit'''<br /> message= _ &quot;It's not over yet! I'll come back to haunt you!&quot;<br /> [/message]<br /> [/event]<br /> <br /> === Nested Event Example ===<br /> <br /> An event is created for a portal that opens on turn 10. The parent (or 'outer') event executes on turn 10 at which point the nested moveto event is created. This nested event executes when a player steps on a certain spot.<br /> <br /> [event]<br /> name=turn 10<br /> <br /> [event]<br /> name=moveto<br /> <br /> [filter]<br /> x,y=5,8<br /> [/filter]<br /> <br /> # moving to 5,8 will trigger this event only on turn 10 and after<br /> [/event]<br /> [/event]<br /> <br /> An equivalent way of doing this would be to create a single moveto event with an '''[if]''' statement to check for turn number but using nested '''[event]''' tags is a convenient shortcut to accomplish this task without resorting to '''[if]''' statements.<br /> <br /> === Delayed Variable Substitution Example ===<br /> <br /> This code will display a message showing the turn number on which the nested ''moveto'' event happens.<br /> <br /> [event]<br /> name=turn 10<br /> <br /> [event]<br /> name=moveto<br /> delayed_variable_substitution=yes<br /> <br /> [filter]<br /> x,y=5,8<br /> [/filter]<br /> <br /> {DEBUG_MSG &quot;Turn $turn_number&quot;} <br /> [/event]<br /> [/event]<br /> <br /> Since this is the default behavior for the '''delayed_variable_substitution''' key, the following example is identical.<br /> <br /> [event]<br /> name=turn 10<br /> <br /> [event]<br /> name=moveto<br /> <br /> [filter]<br /> x,y=5,8<br /> [/filter]<br /> <br /> {DEBUG_MSG &quot;Turn $turn_number&quot;} <br /> [/event]<br /> [/event]<br /> <br /> The following code will always display &quot;Turn 10&quot; when the nested ''moveto'' event happens. This is because the variable substitution is done when the parent event is triggered and spawns the nested event, ''not'' when the nested event is triggered.<br /> <br /> [event]<br /> name=turn 10<br /> <br /> [event]<br /> name=moveto<br /> delayed_variable_substitution=no<br /> <br /> [filter]<br /> x,y=5,8<br /> [/filter]<br /> <br /> {DEBUG_MSG &quot;Turn $turn_number&quot;} <br /> [/event]<br /> [/event]<br /> <br /> Finally, the following example is identical to the first two in that it will display a message showing the turn number on which the nested ''moveto'' event happens, despite the fact that the '''delayed_variable_substitution''' key is set to ''no''. This is because the special '''$|variable''' syntax is used.<br /> <br /> [event]<br /> name=turn 10<br /> <br /> [event]<br /> name=moveto<br /> delayed_variable_substitution=no<br /> <br /> [filter]<br /> x,y=5,8<br /> [/filter]<br /> <br /> {DEBUG_MSG &quot;Turn $|turn_number&quot;} <br /> [/event]<br /> [/event]<br /> <br /> === Multiple Nested Events ===<br /> <br /> Every delayed_variable_substitution=no causes a variable substitution run on the subevent where it occurs at the spawn time of this event and on all following subevents. For any specific event, variable substitution happens at least one time when the event is executed. For each delayed=no key appearing in itself or in an event of an &quot;older&quot; generation, which is not the toplevel event, an additional variable substitution run is made.<br /> [event]# parent<br /> name=turn 2<br /> #delayed_variable_substitution=no # In the parent event, delayed= has no effect.<br /> <br /> [event]# child<br /> name=turn 3<br /> delayed_variable_substitution=no # Causes variable substitution in the child, grandchild and great-grandchild event<br /> # at execution time of the parent event = spawn time of the child event.<br /> <br /> [event]# grandchild<br /> name=turn 4<br /> delayed_variable_substitution=yes # no variable substitution in the grandchild and great-grandchild event<br /> # at execution time of the child event = spawn time of the grandchild event<br /> <br /> [event]# great-grandchild<br /> name=turn 5<br /> {DEBUG_MSG $turn_number}# output: 2 - value from the variable substitution at execution time of the parent event,<br /> # caused by delayed=no in the child event<br /> <br /> {DEBUG_MSG $||turn_number}# output: &quot;$turn_number&quot;<br /> # Each variable substitution transforms a &quot;$|&quot; to a &quot;$&quot; (except when no | left).<br /> <br /> {DEBUG_MSG $|turn_number}# output: 5 - from the variable substitution at execution time<br /> # of the great-grandchild event<br /> [/event]<br /> [/event]<br /> [/event]<br /> [/event]<br /> <br /> == See Also ==<br /> <br /> * [[DirectActionsWML]]<br /> * [[InternalActionsWML]]<br /> * [[InterfaceActionsWML]]<br /> * [[FilterWML]]<br /> * [[ReferenceWML]]<br /> <br /> <br /> [[Category: WML Reference]]</div>

Gambit https://wiki.wesnoth.org/index.php?title=EventWML&diff=38106 2010-08-30T12:19:34Z

<p>Gambit: Undo revision 38056 by Gambit (Talk)</p> <hr /> <div>{{WML Tags}}<br /> == The [event] Tag ==<br /> <br /> This tag is a subtag of the [scenario], [unit_type] and [era] tags which is used to describe a set of actions which trigger at a certain point in a scenario. When used in a [scenario] tag (also includes [multiplayer], [tutorial] and [test]), the event only occurs in that scenario. When used in a [unit_type] tag, the event will occur in all scenarios in which a unit of that type appears in (only after such a unit appears during the scenario, however). When used in an [era], the event will occur in any scenario which is played using that era.<br /> <br /> This tag has keys and child tags that control when and if the event actions will be triggered. Most important of these is the '''name''' key. Without it, no error will be raised but the event will never fire. Therefore, from a practical standpoint, it can be considered mandatory. All of the others can be used or not and the event actions will fire either way.<br /> <br /> '''Lexicon side note:''' ''The word &quot;event&quot; in the [event] tag itself may be considered an abbreviation of the word &quot;event handler&quot; because it is technically not a game &quot;event&quot; but an event '''handler''' for the game events fired with the given 'name'. However, this distinction is usually unimportant in most discussions and the event handlers are therefore simply referred to as &quot;events&quot; in this documentation.''<br /> <br /> === The 'name' Key (Mandatory) ===<br /> <br /> Usage:<br /> name=&lt;value&gt;<br /> <br /> This key defines which game event or trigger your [event] tag will be handling. This 'name' key should not be confused with a descriptive comment; it is rather a precise value which must match the predefined game event's name to be valid.<br /> <br /> '''Lexicon side note:''' ''It is not uncommon to refer to these values as the 'trigger' for an event and, furthermore, to call an event by its 'trigger' name. For example, in an event containing '''name=moveto''', a person might refer to the event as a ''''moveto''' event' and/or refer to the ''''moveto''' trigger' in the event or even talk about the 'event trigger' when referring to the '''moveto''' value of the 'name' key in that event. Some or all of this usage can, in fact, be found throughout this page.''<br /> <br /> The '''name''' key can accept a list of comma separated values describing when the event will be triggered.* These values may be either predefined event types or custom event names not matching any predefined type.<br /> <br /> For example:<br /> <br /> name=attacker misses,defender misses<br /> <br /> ''* Note that unless you use [[#first_time_only|first_time_only=no]], the event will fire only once, '''not''' once for each listed type.''<br /> <br /> ==== Predefined 'name' Key Values ====<br /> <br /> All predefined event types are listed here along with a description of when this value will cause the event to be triggered. Any value ''not'' listed here is a custom event name which can be triggered only by a '''[fire_event]''' tag somewhere else. Spaces in event names can be interchanged with underscores (for example, '''name=new turn''' and '''name=new_turn''' are equivalent).<br /> <br /> ; preload<br /> : Triggers before a scenario 'prestarts' and when loading a savegame -- before anything is shown on the screen at all. Can be used to set up the [[LuaWML|Lua]] environment: loading libraries, defining helper functions, etc.<br /> : '''Note:''' Unlike prestart and start, the preload event '''must be able to fire more than once!''' This is because it is triggered each time a savegame is loaded in addition to the initial time when it loads before the scenario 'prestart'. This means that it is effectively ''mandatory'' to have the [[#first_time_only|first_time_only=no]] key value in a preload event. <br /> <br /> ; prestart<br /> : Triggers before a scenario 'starts' -- before anything is shown on the screen at all. Can be used to set up things like village ownership. For things displayed on-screen such as character dialog, use '''start''' instead.<br /> : '''Note:''' ''This value makes the [[#first_time_only|first_time_only]] key irrelevant since, by definition, it can only fire once.''<br /> <br /> ; start<br /> : Triggers after the map is shown but before the scenario begins -- before players can 'do' anything.<br /> : '''Note:''' ''This value makes the [[#first_time_only|first_time_only]] key irrelevant since, by definition, it can only fire once.''<br /> <br /> ; new turn<br /> : Triggers at the start of every turn (not side turn). See also [[#first_time_only|first_time_only=no]]. Before any events of this type trigger, the value of the WML variable '''turn_number''' is set to the number of the turn that is beginning.<br /> <br /> ; turn end {{DevFeature1.9}}<br /> : Triggers at the end of every turn (not side turn). See also [[#first_time_only|first_time_only=no]]. The WML variable '''side_number''' will contain the side that ended their turn.<br /> <br /> ; side turn<br /> : Triggers when a side is about to start its turn. Before events of this type trigger, the value of the WML variable '''side_number''' is set to the number of the side of the player about to take their turn. This is before any healing takes place for that side, before calculating income, and before restoring unit movement and status.<br /> <br /> ; ai turn<br /> : Triggered just before the AI is invoked for a side. This is called after ''side turn'', and thus the WML variable '''side_number''' still holds the number of this side. Note that this event might be called several times per turn in case that fallbacks to human or droiding is involved. I.e. it happens at the middle of turn of human side 1 if the human player droids his side. It happens after the selection of ai to play the turn but before AI is told that new turn has come.<br /> : '''Note:''' ''This event currently breaks replays since it is not explicitly saved in a replay and there is no AI involved in replays...''<br /> <br /> ; turn refresh<br /> : Like '''side turn''', triggers just before a side is taking control but '''after''' healing, calculating income, and restoring unit movement and status.<br /> <br /> ; turn ''X''<br /> : Triggers at the start of turn ''X''. It's the first side initialization event. <br /> <br /> ; turn ''X'' end {{DevFeature1.9}}<br /> : Triggers at the end of turn ''X''. It's the first event in the group of end turn events. <br /> <br /> :Side initialization events go in the order of: <br /> : 1) '''turn ''X''''' <br /> :2) '''new turn''' <br /> :3) '''side turn''' <br /> :4) '''side ''X'' turn''' <br /> :5) '''side turn ''X''''' <br /> :6) '''side ''X'' turn ''Y''''' <br /> :7) '''turn refresh''' <br /> :8) '''side ''X'' turn refresh''' <br /> :9) '''turn ''X'' refresh''' <br /> :10) '''side ''X'' turn ''Y'' refresh'''<br /> <br /> ; side ''X'' turn ''Y''<br /> : This event triggers at the start of turn ''Y'' of side X {{DevFeature}}<br /> <br /> ; side ''X'' turn<br /> : This event triggers at the start of any turn of side X {{DevFeature}}<br /> : '''Note:''' ''Of course, [[#first_time_only|first_time_only=no]] is needed for this event to be triggered more than once.''<br /> <br /> ; side turn ''X''<br /> : This event triggers at the start of any side on turn X {{DevFeature1.9}}<br /> : '''Note:''' ''Of course, [[#first_time_only|first_time_only=no]] is needed for this event to be triggered more than once.''<br /> <br /> ; side X turn Y refresh<br /> : This event triggers at the turn refresh for side X on turn Y {{DevFeature1.9}}<br /> <br /> ; side ''X'' turn refresh<br /> : This event triggers at the turn refresh for side X {{DevFeature1.9}}<br /> : '''Note:''' ''Of course, [[#first_time_only|first_time_only=no]] is needed for this event to be triggered more than once.''<br /> <br /> ; turn ''X'' refresh<br /> : This event triggers for any side at the refresh of turn X. {{DevFeature1.9}}<br /> : '''Note:''' ''Of course, [[#first_time_only|first_time_only=no]] is needed for this event to be triggered more than once.''<br /> <br /> ; side turn end {{DevFeature1.9}}<br /> : Triggers after a side ends its turn. Like side turn, there are also some variations for specific combinations of side number and turn number. Here is the order in which the turn end events trigger:<br /> :1) '''turn end''' <br /> :2) '''turn ''X'' end''' <br /> :3) '''side turn end''' <br /> :4) '''side ''X'' turn end''' <br /> :5) '''side turn ''X'' end''' <br /> :6) '''side ''X'' turn ''Y'' end''' <br /> <br /> ; time over<br /> : Triggers on turn ''turns''. (''turns'' is specified in [scenario])<br /> <br /> ; enemies defeated<br /> : Triggers when all units with '''canrecruit=yes''' (that is, all leaders) not allied with side 1 are killed.<br /> <br /> ; victory<br /> : In this scenario, any tag of the form '''[endlevel] result=victory [/endlevel]''' will be automatically preceded by all actions in this tag. It helps debugging if the victory event allows you to safely advance to any of the possible next maps after using the &quot;:n&quot; command. Scenarios where key units are picked up before the victory, or where some action chosen earlier determines which map to advance to, make it hard to quickly test scenarios in a campaign. (See also: [endlevel], [[DirectActionsWML]])<br /> <br /> ; defeat<br /> : In this scenario, any tag of the form '''[endlevel] result=defeat [/endlevel]''' will be automatically preceded by all actions in this tag. (See also [endlevel], [[DirectActionsWML]])<br /> <br /> <br /> Filters can be applied to the following event triggers (see [[FilterWML]]; see also below). The actions specified in the event tag will be executed only if the filter returns true. <br /> These event triggers are all actions by units ('''moveto''', '''attack''') or things that happen to units ('''recruit''', '''advance'''). When one of these events is triggered, the position of the active unit (referred to as the '''primary unit''') is stored in the variables '''x1''' and '''y1''' and the position of any unit that primary unit does something to is stored in the variables '''x2''' and '''y2''' (this unit is referred to as the '''secondary unit''' below). '' These units are also automatically stored in the variables 'unit' and 'second_unit' as if they had been stored using the '''[store_unit]''' tag. see [[SingleUnitWML]]<br /> <br /> ; moveto<br /> : Triggers after the primary unit moves. Typically this is used when the primary unit gets to a particular location and a filter for the location of the primary unit is included; remember that this is the location that the primary unit lands on, not the location it started on or any location it travels on.&lt;br /&gt;''An '''[allow_undo]''' tag anywhere within a moveto event will cancel any lack of undo functionality the event would have caused. Note that undo functionality will only move the unit back to its former location; it will not undo other changes to the game caused by the event. Thus it is up to the scenario designer to use this tag correctly.'' {{DevFeature}} $x2 and $y2 refer to the hex the unit came from.<br /> <br /> ; sighted<br /> : Triggers when the primary unit becomes visible to the secondary unit in particular after not being visible to the secondary unit's side (so if the secondary unit's side doesn't have shroud or fog, the event never triggers). This happens both when the primary unit moves into view during its turn, and when the secondary unit moves to a location where it can see the primary unit. (This editor hasn't tested whether the event triggers multiple times if the primary unit moves into view of multiple units at once, or if not, which one gets chosen to be the secondary unit here.) (Note: it appears that when a sighted event is triggered because an enemy unit moves into your field of view, the game engine cannot determine which unit (on your side) sees the unit that moved, and so it fires a ''name=sighted'' event without setting ''$second_unit''. This means that, for example, using ''speaker=second_unit'' inside a message tag may fail.) (Double note: it also appears that the sighted event in more recent versions of the game (1.6 and 1.7, maybe?) does not fire on enemy turns. That is, it only fires for units that become visible as a result of the motion of another unit, not for units that move into the vision of an enemy. This event is also buggy in general... it's usually better to use a moveto event with a [filter_vision] tag than to use a sighted event (and note that the combination of the two can achieve something like the old sighted event)).<br /> <br /> ; attack<br /> : Triggers when the primary unit attacks the secondary unit.<br /> <br /> ; attack end<br /> : Similar to '''attack''', but is triggered ''after'' the fight instead of before. Note that if either unit is killed during the fight, this event triggers before any '''die''' events.<br /> <br /> ; attacker hits<br /> : Triggers when the the primary unit (the attacker) hits the secondary unit (the defender). The value of the WML variable '''damage_inflicted''' is set to the number of hitpoints inflicted by the attacker.<br /> <br /> ; attacker misses<br /> : Same as ''attacker hits'', but is triggered when the attacker misses.<br /> <br /> ; defender hits<br /> : Triggers when the primary unit (the attacker) is hit in retaliation by the secondary unit (the defender). The value of the WML variable '''damage_inflicted''' is set to the number of hitpoints inflicted by the defender.<br /> <br /> ; defender misses<br /> : Same as ''defender hits'', but is triggered when the defender misses.<br /> <br /> ; stone<br /> : Triggers when the primary unit is hit by an attack with the 'stones' ability (See ''stones'', [[AbilitiesWML]]) by the secondary unit (the unit with the 'stones' ability). In {{DevFeature}}, this event name is changed to &quot;petrified&quot;.<br /> <br /> ; last breath<br /> : Triggers when the primary unit is killed by the secondary unit, but before the death animation is triggered. Use this instead of name=die when you want the primary unit to make a final [message]. <br /> <br /> ; die<br /> : Triggers when the primary unit is killed by the secondary unit. ''Note: The primary unit is not removed from the game until the end of this event. The primary unit can still be manipulated, will block other units from taking its hex, and will still be found by standard unit filters (except [have_unit]). To prevent this behavior, you can use [kill] to remove the unit immediately. However, this will stop any (still unfired) other events that also match the unit from firing afterwards, so use with caution.'' If you want to the primary unit to make a final [message], use name=last_breath, see above.<br /> <br /> ; capture<br /> : Triggers when the primary unit captures a village. The village may have been previously neutral, or previously owned by another side; merely moving into your own villages does not constitute a capture.<br /> <br /> ; recruit<br /> : Triggers when the primary unit is recruited. (That is, when a unit is recruited it will trigger this event and this event's filter will filter that unit.).<br /> <br /> ; prerecruit<br /> : Triggers when the primary unit is recruited but before it is displayed.<br /> <br /> ; recall<br /> : Triggers after a unit is recalled.<br /> <br /> ; prerecall<br /> : Triggers when a unit is recalled but before it is displayed.<br /> <br /> ; advance<br /> : Triggers just before the primary unit is going to advance to another unit.<br /> <br /> ; post advance<br /> : Triggers just after the primary unit has advanced to another unit.<br /> <br /> ; select<br /> : Triggers when the primary unit is selected. Also triggers when ending a move, as the game keeps the moving unit selected by selecting it again at the end of movement. ''Note: in networked multiplayer, these events are only executed by the client on which the event is triggered, leading to out of sync errors if you modify the game state in the event.''<br /> <br /> ; menu item ''X''<br /> : Triggers when a WML menu item with id=''X'' is selected. ''Note: if the menu item has a [command], this event may be executed before or after the command; there is no guarantee.''<br /> <br /> ==== Custom events ====<br /> <br /> An event with a custom name may be invoked using the [[InternalActionsWML#.5Bfire_event.5D|[fire_event]]] tag. Normally you'll use such custom events as named subroutines to be called by events with predefined types. One common case of this, for example, is that more than one '''sighted''' events might fire the same custom event that changes the scenario objectives.<br /> <br /> === Optional Keys and Tags ===<br /> <br /> These keys and tags are more complex ways to filter when an event should trigger:<br /> <br /> ==== first_time_only ====<br /> : Whether the event should be removed from the scenario after it is triggered. This key takes a [[ConditionalActionsWML#Boolean_Values|boolean]]; for example:<br /> : ''first_time_only=yes''<br /> :: Default behavior if key is omitted. The event will trigger the first time it can and never again.<br /> : ''first_time_only=no''<br /> :: The event will trigger every time the criteria are met instead of only the first time.<br /> <br /> ==== [filter] ====<br /> : The event will only trigger if the primary unit matches this filter.<br /> :* [[StandardUnitFilter]]: selection criteria<br /> <br /> ==== [filter_second] ====<br /> : Like [filter], but for the secondary unit.<br /> :* [[StandardUnitFilter]]: selection criteria<br /> <br /> ==== [filter_attack] ====<br /> : Can be used to set additional filtering criteria for the primary unit and the secondary unit that are not generally available in a standard unit filter. Can be used in events ''attack'', ''attacker hits'', ''attacker misses'', ''defender hits'', ''defender misses'' and ''attack end''. For more information and other filter keys, see [[FilterWML]].<br /> :* '''name''': the name of the weapon used.<br /> :* '''range''': the range of the weapon used.<br /> :* '''special''': filter on the attack's special power.<br /> <br /> ==== [filter_second_attack] ====<br /> : Like [filter_attack], but for the secondary unit.<br /> :* '''name''': the name of the weapon used.<br /> :* '''range''': the range of the weapon used.<br /> :* '''special''': filter on the attack's special power.<br /> <br /> ==== [event] ====<br /> : A special case 'action', the [event] tag may be used to create a [[#Nested Events|nested event]].<br /> <br /> ==== delayed_variable_substitution ====<br /> : This key is only relevant inside of a [[#Delayed Variable Substitution|nested event]] and controls when variable substitution will occur in those special case actions.<br /> <br /> === Actions triggered by [event] ===<br /> <br /> After the trigger conditions have been met, all action tags within the [event] tag are executed in the order they are written in.<br /> <br /> There are 3 main types of actions:<br /> * direct actions ([[DirectActionsWML]]) which have a direct effect on gameplay<br /> * display actions ([[InterfaceActionsWML]]) which show something to the user<br /> * internal actions ([[InternalActionsWML]]) which are used by WML internally<br /> <br /> Several actions use standard filters to find out which units<br /> to execute the command on. These are denoted by the phrases<br /> &quot;standard unit filter&quot; and &quot;standard location filter&quot;.<br /> <br /> === Nested Events ===<br /> <br /> There is one special type of action: event creation. By placing an '''[event]''' tag inside another '''[event]''' tag, the nested event is spawned (created) when the parent (outer) event is encountered (when executing the contents of the parent event).<br /> <br /> ([[#Nested Event Example|See Examples]])<br /> <br /> ==== Delayed Variable Substitution ====<br /> <br /> Variable substitution for a nested event can happen either when it is spawned by the parent event or when it is triggered itself. This is controlled with the key '''delayed_variable_substitution''' which is used in the nested event.<br /> <br /> If this key is set to ''yes'', the variables in the nested event will contain values from the turn in which the ''nested'' event was triggered. ''This is the default behavior if the key is omitted.'' If set to ''no'', the variables in the nested event are set at the time the ''parent'' event is triggered.<br /> <br /> This behavior can be fine tuned with a special syntax when referencing variables. Instead of the normal '''$variable''' syntax, use '''$|variable''' to cause a variable to contain values relevant to the turn in which the nested event was triggered even when '''delayed_variable_substitution''' is set to ''no''. In this way you can have a mix of variables relevant to the parent and nested event trigger times.<br /> <br /> ([[#Delayed Variable Substitution Example|See Examples]])<br /> <br /> == Multiplayer safety ==<br /> <br /> In multiplayer it is only safe to use WML that might require synchronization with other players because of input or random numbers (like [message] with input or options or [unstore_unit] where a unit might advance) in the following events. This is because in these cases WML needs data from other players to work right and/or do the same thing for all players. This data is only available after a network synchronization.<br /> <br /> List of synchronized events:<br /> * moveto<br /> * sighted <br /> * attack<br /> * attack_end <br /> * attacker hits <br /> * attacker misses <br /> * defender hits<br /> * defender misses <br /> * stone<br /> * last breath <br /> * menu item X<br /> * die<br /> * capture <br /> * recruit<br /> * prerecruit <br /> * recall <br /> * prerecall <br /> * advance <br /> * post_advance <br /> getting message options (etc) from the following events is not synchronized, except in the development version (1.9+svn):<br /> * new turn <br /> * side turn <br /> * turn X <br /> * side X turn <br /> * side X turn Y <br /> * turn refresh <br /> <br /> There is also the possibility of events that are normally synchronized when fired by the engine but can be non-synchronized when fired by WML tags from non-synchronized event. So when you are using them you must be extra careful. For example [unstore_unit] may trigger a unit advancement that will fire ''advance'' and ''post advance'' events.<br /> <br /> == A Trap for the Unwary ==<br /> <br /> It is perfectly possible (and, in fact, useful) to have multiple events with the same predefined name and thus the same trigger condition. However, it is not defined what order such events will fire in, so you need to code so the order <br /> will not matter.<br /> <br /> Because of the above, you need to beware of using macros to generate events. If you include a macro expanding to an event definition twice, the event will be executed twice (not once) each time the trigger condition fires. Consider this code:<br /> <br /> #define DOUBLE<br /> [event]<br /> name=multiply_by_2<br /> {VARIABLE_OP 2_becomes_4 multiply 2}<br /> [/event]<br /> #enddef<br /> <br /> {DOUBLE}<br /> {DOUBLE}<br /> <br /> {VARIABLE 2_becomes_4 2}<br /> <br /> [fire_event]<br /> name=multiply_by_2<br /> [/fire_event]<br /> <br /> {DEBUG_MSG &quot;$2_becomes_4 should be 4&quot;}<br /> <br /> After it executes, the debug message will reveal that the variable has been set to 8, not 4.<br /> <br /> == Miscellaneous Notes and Examples ==<br /> <br /> === Primary/Secondary Unit Speaker Example ===<br /> <br /> In events, the primary unit can be referred to as '''unit''' and the secondary unit can be referred to as '''second_unit''' in [message] tags using the '''speaker''' key. For example:<br /> <br /> [event]<br /> name=die<br /> [message]<br /> speaker='''second_unit'''<br /> message= _ &quot;Hahaha! I finally killed you!&quot;<br /> [/message]<br /> <br /> [message]<br /> speaker='''unit'''<br /> message= _ &quot;It's not over yet! I'll come back to haunt you!&quot;<br /> [/message]<br /> [/event]<br /> <br /> === Nested Event Example ===<br /> <br /> An event is created for a portal that opens on turn 10. The parent (or 'outer') event executes on turn 10 at which point the nested moveto event is created. This nested event executes when a player steps on a certain spot.<br /> <br /> [event]<br /> name=turn 10<br /> <br /> [event]<br /> name=moveto<br /> <br /> [filter]<br /> x,y=5,8<br /> [/filter]<br /> <br /> # moving to 5,8 will trigger this event only on turn 10 and after<br /> [/event]<br /> [/event]<br /> <br /> An equivalent way of doing this would be to create a single moveto event with an '''[if]''' statement to check for turn number but using nested '''[event]''' tags is a convenient shortcut to accomplish this task without resorting to '''[if]''' statements.<br /> <br /> === Delayed Variable Substitution Example ===<br /> <br /> This code will display a message showing the turn number on which the nested ''moveto'' event happens.<br /> <br /> [event]<br /> name=turn 10<br /> <br /> [event]<br /> name=moveto<br /> delayed_variable_substitution=yes<br /> <br /> [filter]<br /> x,y=5,8<br /> [/filter]<br /> <br /> {DEBUG_MSG &quot;Turn $turn_number&quot;} <br /> [/event]<br /> [/event]<br /> <br /> Since this is the default behavior for the '''delayed_variable_substitution''' key, the following example is identical.<br /> <br /> [event]<br /> name=turn 10<br /> <br /> [event]<br /> name=moveto<br /> <br /> [filter]<br /> x,y=5,8<br /> [/filter]<br /> <br /> {DEBUG_MSG &quot;Turn $turn_number&quot;} <br /> [/event]<br /> [/event]<br /> <br /> The following code will always display &quot;Turn 10&quot; when the nested ''moveto'' event happens. This is because the variable substitution is done when the parent event is triggered and spawns the nested event, ''not'' when the nested event is triggered.<br /> <br /> [event]<br /> name=turn 10<br /> <br /> [event]<br /> name=moveto<br /> delayed_variable_substitution=no<br /> <br /> [filter]<br /> x,y=5,8<br /> [/filter]<br /> <br /> {DEBUG_MSG &quot;Turn $turn_number&quot;} <br /> [/event]<br /> [/event]<br /> <br /> Finally, the following example is identical to the first two in that it will display a message showing the turn number on which the nested ''moveto'' event happens, despite the fact that the '''delayed_variable_substitution''' key is set to ''no''. This is because the special '''$|variable''' syntax is used.<br /> <br /> [event]<br /> name=turn 10<br /> <br /> [event]<br /> name=moveto<br /> delayed_variable_substitution=no<br /> <br /> [filter]<br /> x,y=5,8<br /> [/filter]<br /> <br /> {DEBUG_MSG &quot;Turn $|turn_number&quot;} <br /> [/event]<br /> [/event]<br /> <br /> === Multiple Nested Events ===<br /> <br /> Every delayed_variable_substitution=no causes a variable substitution run on the subevent where it occurs at the spawn time of this event and on all following subevents. For any specific event, variable substitution happens at least one time when the event is executed. For each delayed=no key appearing in itself or in an event of an &quot;older&quot; generation, which is not the toplevel event, an additional variable substitution run is made.<br /> [event]# parent<br /> name=turn 2<br /> #delayed_variable_substitution=no # In the parent event, delayed= has no effect.<br /> <br /> [event]# child<br /> name=turn 3<br /> delayed_variable_substitution=no # Causes variable substitution in the child, grandchild and great-grandchild event<br /> # at execution time of the parent event = spawn time of the child event.<br /> <br /> [event]# grandchild<br /> name=turn 4<br /> delayed_variable_substitution=yes # no variable substitution in the grandchild and great-grandchild event<br /> # at execution time of the child event = spawn time of the grandchild event<br /> <br /> [event]# great-grandchild<br /> name=turn 5<br /> {DEBUG_MSG $turn_number}# output: 2 - value from the variable substitution at execution time of the parent event,<br /> # caused by delayed=no in the child event<br /> <br /> {DEBUG_MSG $||turn_number}# output: &quot;$turn_number&quot;<br /> # Each variable substitution transforms a &quot;$|&quot; to a &quot;$&quot; (except when no | left).<br /> <br /> {DEBUG_MSG $|turn_number}# output: 5 - from the variable substitution at execution time<br /> # of the great-grandchild event<br /> [/event]<br /> [/event]<br /> [/event]<br /> [/event]<br /> <br /> == See Also ==<br /> <br /> * [[DirectActionsWML]]<br /> * [[InternalActionsWML]]<br /> * [[InterfaceActionsWML]]<br /> * [[FilterWML]]<br /> * [[ReferenceWML]]<br /> <br /> <br /> [[Category: WML Reference]]</div>

Gambit https://wiki.wesnoth.org/index.php?title=EventWML&diff=38105 2010-08-30T12:19:05Z

<p>Gambit: Undo revision 38057 by Gambit (Talk)</p> <hr /> <div>{{WML Tags}}<br /> == The [event] Tag ==<br /> <br /> This tag is a subtag of the [scenario], [unit_type] and [era] tags which is used to describe a set of actions which trigger at a certain point in a scenario. When used in a [scenario] tag (also includes [multiplayer], [tutorial] and [test]), the event only occurs in that scenario. When used in a [unit_type] tag, the event will occur in all scenarios in which a unit of that type appears in (only after such a unit appears during the scenario, however). When used in an [era], the event will occur in any scenario which is played using that era.<br /> <br /> This tag has keys and child tags that control when and if the event actions will be triggered. Most important of these is the '''name''' key. Without it, no error will be raised but the event will never fire. Therefore, from a practical standpoint, it can be considered mandatory. All of the others can be used or not and the event actions will fire either way.<br /> <br /> '''Lexicon side note:''' ''The word &quot;event&quot; in the [event] tag itself may be considered an abbreviation of the word &quot;event handler&quot; because it is technically not a game &quot;event&quot; but an event '''handler''' for the game events fired with the given 'name'. However, this distinction is usually unimportant in most discussions and the event handlers are therefore simply referred to as &quot;events&quot; in this documentation.''<br /> <br /> === The 'name' Key (Mandatory) ===<br /> <br /> Usage:<br /> name=&lt;value&gt;<br /> <br /> This key defines which game event or trigger your [event] tag will be handling. This 'name' key should not be confused with a descriptive comment; it is rather a precise value which must match the predefined game event's name to be valid.<br /> <br /> '''Lexicon side note:''' ''It is not uncommon to refer to these values as the 'trigger' for an event and, furthermore, to call an event by its 'trigger' name. For example, in an event containing '''name=moveto''', a person might refer to the event as a ''''moveto''' event' and/or refer to the ''''moveto''' trigger' in the event or even talk about the 'event trigger' when referring to the '''moveto''' value of the 'name' key in that event. Some or all of this usage can, in fact, be found throughout this page.''<br /> <br /> The '''name''' key can accept a list of comma separated values describing when the event will be triggered.* These values may be either predefined event types or custom event names not matching any predefined type.<br /> <br /> For example:<br /> <br /> name=attacker misses,defender misses<br /> <br /> ''* Note that unless you use [[#first_time_only|first_time_only=no]], the event will fire only once, '''not''' once for each listed type.''<br /> <br /> ==== Predefined 'name' Key Values ====<br /> <br /> All predefined event types are listed here along with a description of when this value will cause the event to be triggered. Any value ''not'' listed here is a custom event name which can be triggered only by a '''[fire_event]''' tag somewhere else. Spaces in event names can be interchanged with underscores (for example, '''name=new turn''' and '''name=new_turn''' are equivalent).<br /> <br /> ; preload<br /> : Triggers before a scenario 'prestarts' and when loading a savegame -- before anything is shown on the screen at all. Can be used to set up the [[LuaWML|Lua]] environment: loading libraries, defining helper functions, etc.<br /> : '''Note:''' Unlike prestart and start, the preload event '''must be able to fire more than once!''' This is because it is triggered each time a savegame is loaded in addition to the initial time when it loads before the scenario 'prestart'. This means that it is effectively ''mandatory'' to have the [[#first_time_only|first_time_only=no]] key value in a preload event. <br /> <br /> ; prestart<br /> : Triggers before a scenario 'starts' -- before anything is shown on the screen at all. Can be used to set up things like village ownership. For things displayed on-screen such as character dialog, use '''start''' instead.<br /> : '''Note:''' ''This value makes the [[#first_time_only|first_time_only]] key irrelevant since, by definition, it can only fire once.''<br /> <br /> ; start<br /> : Triggers after the map is shown but before the scenario begins -- before players can 'do' anything.<br /> : '''Note:''' ''This value makes the [[#first_time_only|first_time_only]] key irrelevant since, by definition, it can only fire once.''<br /> <br /> ; new turn<br /> : Triggers at the start of every turn (not side turn). See also [[#first_time_only|first_time_only=no]]. Before any events of this type trigger, the value of the WML variable '''turn_number''' is set to the number of the turn that is beginning.<br /> <br /> ; side turn<br /> : Triggers when a side is about to start its turn. Before events of this type trigger, the value of the WML variable '''side_number''' is set to the number of the side of the player about to take their turn. This is before any healing takes place for that side, before calculating income, and before restoring unit movement and status.<br /> :Side initialization events go in the order of: <br /> : 1) '''turn ''X''''' <br /> :2) '''new turn''' <br /> :3) '''side turn''' <br /> :4) '''side ''X'' turn''' <br /> :5) '''side turn ''X''''' <br /> :6) '''side ''X'' turn ''Y''''' <br /> :7) '''turn refresh''' <br /> :8) '''side ''X'' turn refresh''' <br /> :9) '''turn ''X'' refresh''' <br /> :10) '''side ''X'' turn ''Y'' refresh'''<br /> <br /> ; ai turn<br /> : Triggered just before the AI is invoked for a side. This is called after ''side turn'', and thus the WML variable '''side_number''' still holds the number of this side. Note that this event might be called several times per turn in case that fallbacks to human or droiding is involved. I.e. it happens at the middle of turn of human side 1 if the human player droids his side. It happens after the selection of ai to play the turn but before AI is told that new turn has come.<br /> : '''Note:''' ''This event currently breaks replays since it is not explicitly saved in a replay and there is no AI involved in replays...''<br /> <br /> ; turn refresh<br /> : Like '''side turn''', triggers just before a side is taking control but '''after''' healing, calculating income, and restoring unit movement and status.<br /> <br /> ; turn ''X''<br /> : Triggers at the start of turn ''X''. It's the first side initialization event. <br /> <br /> ; turn end {{DevFeature1.9}}<br /> : Triggers at the end of every turn (not side turn). See also [[#first_time_only|first_time_only=no]]. The WML variable '''side_number''' will contain the side that ended their turn. It is the first event in the group of end turn events.<br /> <br /> ; turn ''X'' end {{DevFeature1.9}}<br /> : Triggers at the end of turn ''X''. It's the second event in the group of end turn events. <br /> <br /> ; side ''X'' turn ''Y''<br /> : This event triggers at the start of turn ''Y'' of side X {{DevFeature}}<br /> <br /> ; side ''X'' turn<br /> : This event triggers at the start of any turn of side X {{DevFeature}}<br /> : '''Note:''' ''Of course, [[#first_time_only|first_time_only=no]] is needed for this event to be triggered more than once.''<br /> <br /> ; side turn ''X''<br /> : This event triggers at the start of any side on turn X {{DevFeature1.9}}<br /> : '''Note:''' ''Of course, [[#first_time_only|first_time_only=no]] is needed for this event to be triggered more than once.''<br /> <br /> ; side X turn Y refresh<br /> : This event triggers at the turn refresh for side X on turn Y {{DevFeature1.9}}<br /> <br /> ; side ''X'' turn refresh<br /> : This event triggers at the turn refresh for side X {{DevFeature1.9}}<br /> : '''Note:''' ''Of course, [[#first_time_only|first_time_only=no]] is needed for this event to be triggered more than once.''<br /> <br /> ; turn ''X'' refresh<br /> : This event triggers for any side at the refresh of turn X. {{DevFeature1.9}}<br /> : '''Note:''' ''Of course, [[#first_time_only|first_time_only=no]] is needed for this event to be triggered more than once.''<br /> <br /> ; side turn end {{DevFeature1.9}}<br /> : Triggers after a side ends its turn. Like side turn, there are also some variations for specific combinations of side number and turn number. Here is the order in which the turn end events trigger:<br /> :1) '''turn end''' <br /> :2) '''turn ''X'' end''' <br /> :3) '''side turn end''' <br /> :4) '''side ''X'' turn end''' <br /> :5) '''side turn ''X'' end''' <br /> :6) '''side ''X'' turn ''Y'' end''' <br /> <br /> ; time over<br /> : Triggers on turn ''turns''. (''turns'' is specified in [scenario])<br /> <br /> ; enemies defeated<br /> : Triggers when all units with '''canrecruit=yes''' (that is, all leaders) not allied with side 1 are killed.<br /> <br /> ; victory<br /> : In this scenario, any tag of the form '''[endlevel] result=victory [/endlevel]''' will be automatically preceded by all actions in this tag. It helps debugging if the victory event allows you to safely advance to any of the possible next maps after using the &quot;:n&quot; command. Scenarios where key units are picked up before the victory, or where some action chosen earlier determines which map to advance to, make it hard to quickly test scenarios in a campaign. (See also: [endlevel], [[DirectActionsWML]])<br /> <br /> ; defeat<br /> : In this scenario, any tag of the form '''[endlevel] result=defeat [/endlevel]''' will be automatically preceded by all actions in this tag. (See also [endlevel], [[DirectActionsWML]])<br /> <br /> <br /> Filters can be applied to the following event triggers (see [[FilterWML]]; see also below). The actions specified in the event tag will be executed only if the filter returns true. <br /> These event triggers are all actions by units ('''moveto''', '''attack''') or things that happen to units ('''recruit''', '''advance'''). When one of these events is triggered, the position of the active unit (referred to as the '''primary unit''') is stored in the variables '''x1''' and '''y1''' and the position of any unit that primary unit does something to is stored in the variables '''x2''' and '''y2''' (this unit is referred to as the '''secondary unit''' below). '' These units are also automatically stored in the variables 'unit' and 'second_unit' as if they had been stored using the '''[store_unit]''' tag. see [[SingleUnitWML]]<br /> <br /> ; moveto<br /> : Triggers after the primary unit moves. Typically this is used when the primary unit gets to a particular location and a filter for the location of the primary unit is included; remember that this is the location that the primary unit lands on, not the location it started on or any location it travels on.&lt;br /&gt;''An '''[allow_undo]''' tag anywhere within a moveto event will cancel any lack of undo functionality the event would have caused. Note that undo functionality will only move the unit back to its former location; it will not undo other changes to the game caused by the event. Thus it is up to the scenario designer to use this tag correctly.'' {{DevFeature}} $x2 and $y2 refer to the hex the unit came from.<br /> <br /> ; sighted<br /> : Triggers when the primary unit becomes visible to the secondary unit in particular after not being visible to the secondary unit's side (so if the secondary unit's side doesn't have shroud or fog, the event never triggers). This happens both when the primary unit moves into view during its turn, and when the secondary unit moves to a location where it can see the primary unit. (This editor hasn't tested whether the event triggers multiple times if the primary unit moves into view of multiple units at once, or if not, which one gets chosen to be the secondary unit here.) (Note: it appears that when a sighted event is triggered because an enemy unit moves into your field of view, the game engine cannot determine which unit (on your side) sees the unit that moved, and so it fires a ''name=sighted'' event without setting ''$second_unit''. This means that, for example, using ''speaker=second_unit'' inside a message tag may fail.) (Double note: it also appears that the sighted event in more recent versions of the game (1.6 and 1.7, maybe?) does not fire on enemy turns. That is, it only fires for units that become visible as a result of the motion of another unit, not for units that move into the vision of an enemy. This event is also buggy in general... it's usually better to use a moveto event with a [filter_vision] tag than to use a sighted event (and note that the combination of the two can achieve something like the old sighted event)).<br /> <br /> ; attack<br /> : Triggers when the primary unit attacks the secondary unit.<br /> <br /> ; attack end<br /> : Similar to '''attack''', but is triggered ''after'' the fight instead of before. Note that if either unit is killed during the fight, this event triggers before any '''die''' events.<br /> <br /> ; attacker hits<br /> : Triggers when the the primary unit (the attacker) hits the secondary unit (the defender). The value of the WML variable '''damage_inflicted''' is set to the number of hitpoints inflicted by the attacker.<br /> <br /> ; attacker misses<br /> : Same as ''attacker hits'', but is triggered when the attacker misses.<br /> <br /> ; defender hits<br /> : Triggers when the primary unit (the attacker) is hit in retaliation by the secondary unit (the defender). The value of the WML variable '''damage_inflicted''' is set to the number of hitpoints inflicted by the defender.<br /> <br /> ; defender misses<br /> : Same as ''defender hits'', but is triggered when the defender misses.<br /> <br /> ; stone<br /> : Triggers when the primary unit is hit by an attack with the 'stones' ability (See ''stones'', [[AbilitiesWML]]) by the secondary unit (the unit with the 'stones' ability). In {{DevFeature}}, this event name is changed to &quot;petrified&quot;.<br /> <br /> ; last breath<br /> : Triggers when the primary unit is killed by the secondary unit, but before the death animation is triggered. Use this instead of name=die when you want the primary unit to make a final [message]. <br /> <br /> ; die<br /> : Triggers when the primary unit is killed by the secondary unit. ''Note: The primary unit is not removed from the game until the end of this event. The primary unit can still be manipulated, will block other units from taking its hex, and will still be found by standard unit filters (except [have_unit]). To prevent this behavior, you can use [kill] to remove the unit immediately. However, this will stop any (still unfired) other events that also match the unit from firing afterwards, so use with caution.'' If you want to the primary unit to make a final [message], use name=last_breath, see above.<br /> <br /> ; capture<br /> : Triggers when the primary unit captures a village. The village may have been previously neutral, or previously owned by another side; merely moving into your own villages does not constitute a capture.<br /> <br /> ; recruit<br /> : Triggers when the primary unit is recruited. (That is, when a unit is recruited it will trigger this event and this event's filter will filter that unit.).<br /> <br /> ; prerecruit<br /> : Triggers when the primary unit is recruited but before it is displayed.<br /> <br /> ; recall<br /> : Triggers after a unit is recalled.<br /> <br /> ; prerecall<br /> : Triggers when a unit is recalled but before it is displayed.<br /> <br /> ; advance<br /> : Triggers just before the primary unit is going to advance to another unit.<br /> <br /> ; post advance<br /> : Triggers just after the primary unit has advanced to another unit.<br /> <br /> ; select<br /> : Triggers when the primary unit is selected. Also triggers when ending a move, as the game keeps the moving unit selected by selecting it again at the end of movement. ''Note: in networked multiplayer, these events are only executed by the client on which the event is triggered, leading to out of sync errors if you modify the game state in the event.''<br /> <br /> ; menu item ''X''<br /> : Triggers when a WML menu item with id=''X'' is selected. ''Note: if the menu item has a [command], this event may be executed before or after the command; there is no guarantee.''<br /> <br /> ==== Custom events ====<br /> <br /> An event with a custom name may be invoked using the [[InternalActionsWML#.5Bfire_event.5D|[fire_event]]] tag. Normally you'll use such custom events as named subroutines to be called by events with predefined types. One common case of this, for example, is that more than one '''sighted''' events might fire the same custom event that changes the scenario objectives.<br /> <br /> === Optional Keys and Tags ===<br /> <br /> These keys and tags are more complex ways to filter when an event should trigger:<br /> <br /> ==== first_time_only ====<br /> : Whether the event should be removed from the scenario after it is triggered. This key takes a [[ConditionalActionsWML#Boolean_Values|boolean]]; for example:<br /> : ''first_time_only=yes''<br /> :: Default behavior if key is omitted. The event will trigger the first time it can and never again.<br /> : ''first_time_only=no''<br /> :: The event will trigger every time the criteria are met instead of only the first time.<br /> <br /> ==== [filter] ====<br /> : The event will only trigger if the primary unit matches this filter.<br /> :* [[StandardUnitFilter]]: selection criteria<br /> <br /> ==== [filter_second] ====<br /> : Like [filter], but for the secondary unit.<br /> :* [[StandardUnitFilter]]: selection criteria<br /> <br /> ==== [filter_attack] ====<br /> : Can be used to set additional filtering criteria for the primary unit and the secondary unit that are not generally available in a standard unit filter. Can be used in events ''attack'', ''attacker hits'', ''attacker misses'', ''defender hits'', ''defender misses'' and ''attack end''. For more information and other filter keys, see [[FilterWML]].<br /> :* '''name''': the name of the weapon used.<br /> :* '''range''': the range of the weapon used.<br /> :* '''special''': filter on the attack's special power.<br /> <br /> ==== [filter_second_attack] ====<br /> : Like [filter_attack], but for the secondary unit.<br /> :* '''name''': the name of the weapon used.<br /> :* '''range''': the range of the weapon used.<br /> :* '''special''': filter on the attack's special power.<br /> <br /> ==== [event] ====<br /> : A special case 'action', the [event] tag may be used to create a [[#Nested Events|nested event]].<br /> <br /> ==== delayed_variable_substitution ====<br /> : This key is only relevant inside of a [[#Delayed Variable Substitution|nested event]] and controls when variable substitution will occur in those special case actions.<br /> <br /> === Actions triggered by [event] ===<br /> <br /> After the trigger conditions have been met, all action tags within the [event] tag are executed in the order they are written in.<br /> <br /> There are 3 main types of actions:<br /> * direct actions ([[DirectActionsWML]]) which have a direct effect on gameplay<br /> * display actions ([[InterfaceActionsWML]]) which show something to the user<br /> * internal actions ([[InternalActionsWML]]) which are used by WML internally<br /> <br /> Several actions use standard filters to find out which units<br /> to execute the command on. These are denoted by the phrases<br /> &quot;standard unit filter&quot; and &quot;standard location filter&quot;.<br /> <br /> === Nested Events ===<br /> <br /> There is one special type of action: event creation. By placing an '''[event]''' tag inside another '''[event]''' tag, the nested event is spawned (created) when the parent (outer) event is encountered (when executing the contents of the parent event).<br /> <br /> ([[#Nested Event Example|See Examples]])<br /> <br /> ==== Delayed Variable Substitution ====<br /> <br /> Variable substitution for a nested event can happen either when it is spawned by the parent event or when it is triggered itself. This is controlled with the key '''delayed_variable_substitution''' which is used in the nested event.<br /> <br /> If this key is set to ''yes'', the variables in the nested event will contain values from the turn in which the ''nested'' event was triggered. ''This is the default behavior if the key is omitted.'' If set to ''no'', the variables in the nested event are set at the time the ''parent'' event is triggered.<br /> <br /> This behavior can be fine tuned with a special syntax when referencing variables. Instead of the normal '''$variable''' syntax, use '''$|variable''' to cause a variable to contain values relevant to the turn in which the nested event was triggered even when '''delayed_variable_substitution''' is set to ''no''. In this way you can have a mix of variables relevant to the parent and nested event trigger times.<br /> <br /> ([[#Delayed Variable Substitution Example|See Examples]])<br /> <br /> == Multiplayer safety ==<br /> <br /> In multiplayer it is only safe to use WML that might require synchronization with other players because of input or random numbers (like [message] with input or options or [unstore_unit] where a unit might advance) in the following events. This is because in these cases WML needs data from other players to work right and/or do the same thing for all players. This data is only available after a network synchronization.<br /> <br /> List of synchronized events:<br /> * moveto<br /> * sighted <br /> * attack<br /> * attack_end <br /> * attacker hits <br /> * attacker misses <br /> * defender hits<br /> * defender misses <br /> * stone<br /> * last breath <br /> * menu item X<br /> * die<br /> * capture <br /> * recruit<br /> * prerecruit <br /> * recall <br /> * prerecall <br /> * advance <br /> * post_advance <br /> getting message options (etc) from the following events is not synchronized, except in the development version (1.9+svn):<br /> * new turn <br /> * side turn <br /> * turn X <br /> * side X turn <br /> * side X turn Y <br /> * turn refresh <br /> <br /> There is also the possibility of events that are normally synchronized when fired by the engine but can be non-synchronized when fired by WML tags from non-synchronized event. So when you are using them you must be extra careful. For example [unstore_unit] may trigger a unit advancement that will fire ''advance'' and ''post advance'' events.<br /> <br /> == A Trap for the Unwary ==<br /> <br /> It is perfectly possible (and, in fact, useful) to have multiple events with the same predefined name and thus the same trigger condition. However, it is not defined what order such events will fire in, so you need to code so the order <br /> will not matter.<br /> <br /> Because of the above, you need to beware of using macros to generate events. If you include a macro expanding to an event definition twice, the event will be executed twice (not once) each time the trigger condition fires. Consider this code:<br /> <br /> #define DOUBLE<br /> [event]<br /> name=multiply_by_2<br /> {VARIABLE_OP 2_becomes_4 multiply 2}<br /> [/event]<br /> #enddef<br /> <br /> {DOUBLE}<br /> {DOUBLE}<br /> <br /> {VARIABLE 2_becomes_4 2}<br /> <br /> [fire_event]<br /> name=multiply_by_2<br /> [/fire_event]<br /> <br /> {DEBUG_MSG &quot;$2_becomes_4 should be 4&quot;}<br /> <br /> After it executes, the debug message will reveal that the variable has been set to 8, not 4.<br /> <br /> == Miscellaneous Notes and Examples ==<br /> <br /> === Primary/Secondary Unit Speaker Example ===<br /> <br /> In events, the primary unit can be referred to as '''unit''' and the secondary unit can be referred to as '''second_unit''' in [message] tags using the '''speaker''' key. For example:<br /> <br /> [event]<br /> name=die<br /> [message]<br /> speaker='''second_unit'''<br /> message= _ &quot;Hahaha! I finally killed you!&quot;<br /> [/message]<br /> <br /> [message]<br /> speaker='''unit'''<br /> message= _ &quot;It's not over yet! I'll come back to haunt you!&quot;<br /> [/message]<br /> [/event]<br /> <br /> === Nested Event Example ===<br /> <br /> An event is created for a portal that opens on turn 10. The parent (or 'outer') event executes on turn 10 at which point the nested moveto event is created. This nested event executes when a player steps on a certain spot.<br /> <br /> [event]<br /> name=turn 10<br /> <br /> [event]<br /> name=moveto<br /> <br /> [filter]<br /> x,y=5,8<br /> [/filter]<br /> <br /> # moving to 5,8 will trigger this event only on turn 10 and after<br /> [/event]<br /> [/event]<br /> <br /> An equivalent way of doing this would be to create a single moveto event with an '''[if]''' statement to check for turn number but using nested '''[event]''' tags is a convenient shortcut to accomplish this task without resorting to '''[if]''' statements.<br /> <br /> === Delayed Variable Substitution Example ===<br /> <br /> This code will display a message showing the turn number on which the nested ''moveto'' event happens.<br /> <br /> [event]<br /> name=turn 10<br /> <br /> [event]<br /> name=moveto<br /> delayed_variable_substitution=yes<br /> <br /> [filter]<br /> x,y=5,8<br /> [/filter]<br /> <br /> {DEBUG_MSG &quot;Turn $turn_number&quot;} <br /> [/event]<br /> [/event]<br /> <br /> Since this is the default behavior for the '''delayed_variable_substitution''' key, the following example is identical.<br /> <br /> [event]<br /> name=turn 10<br /> <br /> [event]<br /> name=moveto<br /> <br /> [filter]<br /> x,y=5,8<br /> [/filter]<br /> <br /> {DEBUG_MSG &quot;Turn $turn_number&quot;} <br /> [/event]<br /> [/event]<br /> <br /> The following code will always display &quot;Turn 10&quot; when the nested ''moveto'' event happens. This is because the variable substitution is done when the parent event is triggered and spawns the nested event, ''not'' when the nested event is triggered.<br /> <br /> [event]<br /> name=turn 10<br /> <br /> [event]<br /> name=moveto<br /> delayed_variable_substitution=no<br /> <br /> [filter]<br /> x,y=5,8<br /> [/filter]<br /> <br /> {DEBUG_MSG &quot;Turn $turn_number&quot;} <br /> [/event]<br /> [/event]<br /> <br /> Finally, the following example is identical to the first two in that it will display a message showing the turn number on which the nested ''moveto'' event happens, despite the fact that the '''delayed_variable_substitution''' key is set to ''no''. This is because the special '''$|variable''' syntax is used.<br /> <br /> [event]<br /> name=turn 10<br /> <br /> [event]<br /> name=moveto<br /> delayed_variable_substitution=no<br /> <br /> [filter]<br /> x,y=5,8<br /> [/filter]<br /> <br /> {DEBUG_MSG &quot;Turn $|turn_number&quot;} <br /> [/event]<br /> [/event]<br /> <br /> === Multiple Nested Events ===<br /> <br /> Every delayed_variable_substitution=no causes a variable substitution run on the subevent where it occurs at the spawn time of this event and on all following subevents. For any specific event, variable substitution happens at least one time when the event is executed. For each delayed=no key appearing in itself or in an event of an &quot;older&quot; generation, which is not the toplevel event, an additional variable substitution run is made.<br /> [event]# parent<br /> name=turn 2<br /> #delayed_variable_substitution=no # In the parent event, delayed= has no effect.<br /> <br /> [event]# child<br /> name=turn 3<br /> delayed_variable_substitution=no # Causes variable substitution in the child, grandchild and great-grandchild event<br /> # at execution time of the parent event = spawn time of the child event.<br /> <br /> [event]# grandchild<br /> name=turn 4<br /> delayed_variable_substitution=yes # no variable substitution in the grandchild and great-grandchild event<br /> # at execution time of the child event = spawn time of the grandchild event<br /> <br /> [event]# great-grandchild<br /> name=turn 5<br /> {DEBUG_MSG $turn_number}# output: 2 - value from the variable substitution at execution time of the parent event,<br /> # caused by delayed=no in the child event<br /> <br /> {DEBUG_MSG $||turn_number}# output: &quot;$turn_number&quot;<br /> # Each variable substitution transforms a &quot;$|&quot; to a &quot;$&quot; (except when no | left).<br /> <br /> {DEBUG_MSG $|turn_number}# output: 5 - from the variable substitution at execution time<br /> # of the great-grandchild event<br /> [/event]<br /> [/event]<br /> [/event]<br /> [/event]<br /> <br /> == See Also ==<br /> <br /> * [[DirectActionsWML]]<br /> * [[InternalActionsWML]]<br /> * [[InterfaceActionsWML]]<br /> * [[FilterWML]]<br /> * [[ReferenceWML]]<br /> <br /> <br /> [[Category: WML Reference]]</div>

Gambit https://wiki.wesnoth.org/index.php?title=InterfaceActionsWML&diff=38062 2010-08-27T16:18:35Z

<p>Gambit: /* Other interface tags */ updated information on chat</p> <hr /> <div>{{WML Tags}}<br /> == Interface actions ==<br /> <br /> Interface actions are actions that do not have an effect on gameplay;<br /> instead, they show something to the player. The main interface tags<br /> are '''[message]''' and '''[objectives]''', but several other tags affect<br /> the interface also.<br /> <br /> == [inspect] ==<br /> This user interface action only works in debug mode. It displays the gamestate inspector dialog (the same one which can be brought up with '':inspect'' ), which can be used to inspect the values of WML variables, AI configuration, recall lists, and more.<br /> <br /> * '''name''': optional attribute to specify the name of this gamestate inspector dialog. It is just a label to help differentiate between different invocations of gamestate inspector dialog.<br /> <br /> == [message] ==<br /> The most commonly used interface action is [message], which displays a message to the user in a dialog box. It can also be used to take input from the user.<br /> <br /> The following key/tags are accepted for [message]:<br /> * [[StandardUnitFilter]]: The unit whose profile and name are displayed. Do not use a [filter] tag. If no unit matching this filter is found, the message is not displayed (The unit has probably been killed).&lt;br&gt;'''[message]''' elements should be constructed so that it is either guaranteed that a certain unit is alive, or so that dialog flows smoothly even if the message isn't displayed.<br /> <br /> * '''speaker''': an alternative to standard unit filter. You may specify as the value of the speaker attribute a unit id or any of the following special values:<br /> ** '''narrator''': the dialog box is displayed without a caption for the unit speaking or a unit image<br /> ** '''unit''': the primary unit for the event is speaking<br /> ** '''second_unit''': the secondary unit for the event is speaking<br /> <br /> * '''message''': (translatable) the text to display to the right of the image. ''message'' is sometimes multiple lines; if it is, be sure to use quotes(''' ' ''' or ''' &quot; ''')<br /> * '''[show_if]''': if present then this message will only be displayed if the conditional statement in this tag is passed (see [[ConditionalActionsWML#Condition_Tags|ConditionalActionsWML]])<br /> * '''side_for''': (default: all sides) comma-separated list of sides for who message is shown.<br /> * '''image''': (default: profile image of speaker) the image to display next to the message.<br /> * '''caption''': (default: name of speaker) the caption to display beside the image. Name to be displayed. Note: use a translation mark to avoid wmllint errors.<br /> * '''duration''': (default: 10) the minimum number of frames for this message to be displayed. (A frame lasts about 30 milliseconds.) During this time any dialog decisions will be disregarded.<br /> * '''sound''': a sound effect (wav file) to play as the message is displayed. This can be a comma-separated list, from which one will be randomly chosen.<br /> * '''[option]''': zero or more '''[option]''' elements may be present. If '''[option]''' elements are present, then each option will be displayed in a menu for the user to select one option.<br /> ** '''message''': (translatable) the text displayed for the option (see [[DescriptionWML]])<br /> ** '''[show_if]''': if present then this option will only be displayed if the conditional statement in this tag is passed (see [[InternalActionsWML]])<br /> ** '''[command]''': an element containing actions which are executed if the option is selected.<br /> * '''[text_input]''': there can be only one [text_input] tag. this adds a text input field to the message.<br /> ** '''variable''': the variable that the user's input will be written to<br /> ** '''label''': a text label to the left of the input field<br /> ** '''max_length''': the maximum number of characters that may be typed into the field<br /> ** '''text''': text that is written into the field in the beginning<br /> * Check [[EventWML#Multiplayer_safety]] to find out in which events you can safely use '''[option]''' and '''[text_input]''' without causing OOS.<br /> <br /> === Formatting ===<br /> In 1.8, [http://library.gnome.org/devel/pango/unstable/PangoMarkupFormat.html Pango markup formatting codes] have been adopted for '''[message]'''. These can also be used in unit names (user_description), objectives, and such. Note that you'll probably want to use a single quote ' instead of a double quote &quot; as double quotes cannot be escaped, otherwise the string will appear fragmented and you may also encounter errors. Running wmllint on your campaign will up-convert it, warning you about unusual cases you must fix by hand.<br /> <br /> For example, if you wanted to write &quot;You are victorious!&quot; in large, italic, gold letters, you might write it this way:<br /> <br /> &lt;nowiki&gt;&lt;span color='#BCB088' size='large' font-style='italic'&gt;You are victorious!&lt;/span&gt;&lt;/nowiki&gt;<br /> <br /> <br /> These are the codes taken from the Pango markup formatting guide:<br /> <br /> *'''font''', '''font_desc''': A font description string, such as &quot;Sans Italic 12&quot;.<br /> *'''font_family''', '''face''': A font family name.<br /> *'''font_size''', '''size''': Font size in 1024ths of a point, or one of the absolute sizes 'xx-small', 'x-small', 'small', 'medium', 'large', 'x-large', 'xx-large', or one of the relative sizes 'smaller' or 'larger'.<br /> *'''font_style''', '''style''': One of 'normal', 'oblique', 'italic'.<br /> *'''font_weight''', '''weight''': One of 'ultralight', 'light', 'normal', 'bold', 'ultrabold', 'heavy', or a numeric weight.<br /> *'''font_variant''', '''variant''': One of 'normal' or 'smallcaps'.<br /> *'''font_stretch''', '''stretch''': One of 'ultracondensed', 'extracondensed', 'condensed', 'semicondensed', 'normal', 'semiexpanded', 'expanded', 'extraexpanded', 'ultraexpanded'.<br /> *'''foreground''', '''fgcolor''', '''color''': An RGB color specification such as '#00FF00' or a color name such as 'red'.<br /> *'''background, bgcolor''': An RGB color specification such as '#00FF00' or a color name such as 'red'.<br /> *'''underline''': One of 'none', 'single', 'double', 'low', 'error'.<br /> *'''underline_color''': The color of underlines; an RGB color specification such as '#00FF00' or a color name such as 'red'.<br /> *'''rise''': Vertical displacement, in 10000ths of an em. Can be negative for subscript, positive for superscript.<br /> *'''strikethrough''': 'true' or 'false' whether to strike through the text.<br /> *'''strikethrough_color''': The color of strikethrough lines; an RGB color specification such as '#00FF00' or a color name such as 'red'<br /> *'''fallback''': 'true' or 'false' whether to enable fallback. If disabled, then characters will only be used from the closest matching font on the system. No fallback will be done to other fonts on the system that might contain the characters in the text. Fallback is enabled by default. Most applications should not disable fallback.<br /> *'''letter_spacing''': Inter-letter spacing in 1024ths of a point.<br /> *'''gravity''': One of 'south', 'east', 'north', 'west', 'auto'.<br /> *'''gravity_hint''': One of 'natural', 'strong', 'line'.<br /> <br /> <br /> In 1.6, Wesnoth uses older text formatting options<br /> * A tilde (~) as the first character causes the line to be boldfaced.<br /> * An at symbol (@) as the first character causes the line to be green, as done with victory conditions.<br /> * A pound symbol (#) as the first character causes the line to be red, as done with defeat conditions.<br /> * An asterisk (*) as the first character causes the line to be bigger.<br /> * A backquote (`) as the first character causes the line to be smaller.<br /> * If used, the caption key text is boldfaced.<br /> * An RGB colour code in the beginning causes the line to be the given colour. This can still be preceded by the above characters. Example: ''message=_&quot;&lt;255,0,0&gt;Red!&quot;''<br /> <br /> == [objectives] ==<br /> The other tag used for plot development is '''[objectives]'''.<br /> The '''[objectives]''' tag overwrites any previously set objectives,<br /> and displays text which should describe the objectives of the scenario.<br /> Scenario objectives are displayed on the player's first turn after the tag is used,<br /> or as part of the event if it triggers during that player's turn.<br /> Objectives can also be accessed at any time in a scenario using the<br /> &quot;Scenario Objectives&quot; game menu option, making this tag useful for<br /> scenario-specific information that the player may need to refer to during play.<br /> <br /> This tag renders the ''objectives'' attribute of [scenario] obsolete (see ''objectives'', [[ScenarioWML]]).<br /> Instead of using ''objectives'', use '''[objectives]''' to set scenario objectives inside a prestart event.<br /> It can also be used to overwrite the starting objectives mid-scenario.<br /> <br /> Attributes of '''[objectives]''':<br /> * '''side''': Default '0'. The side to set the objectives for. A value of 0 sets objectives for all sides.<br /> * '''summary''': Displayed first in the objectives text, this should describe the basic objective for the overall scenario. Can be omitted.<br /> * '''note''': Displayed last in the objectives text, this is sometimes used for hints or additional information. Can be omitted.<br /> * '''victory_string''': Default ' _ &quot;Victory:&quot;', this text precedes the victory objectives.<br /> * '''defeat_string''': Default ' _ &quot;Defeat:&quot;', this text precedes the defeat objectives.<br /> * '''gold_carryover_string''' {{DevFeature1.9}}: Default ' _ &quot;Gold carryover:&quot;', this text precedes the gold carryover information.<br /> * '''notes_string''' {{DevFeature1.9}}: Default ' _ &quot;Notes:&quot;', this text precedes the notes.<br /> * '''silent''': Default: not present. If set to &quot;yes&quot;, the objectives are silently changed. Else, they will be shown to the user when appropriate.<br /> <br /> Tags of '''[objectives]''':<br /> * '''[objective]''': describes a win or loss condition. Most scenarios have multiple win or loss conditions, so use a separate [objective] subtag for each line; this helps with translations.<br /> ** '''description''': text for the specific win or loss condition.<br /> ** '''condition''': The color and placement of the text. Values are 'win'(colored green, placed after ''victory_string'') and 'lose'(colored red, placed after ''defeat_string'')<br /> ** '''[show_if]''': A condition that disables the objective if it doesn't hold. Conditional objectives are refreshed at '''[show_objectives]''' time only. {{DevFeature}}<br /> * '''[gold_carryover]''' {{DevFeature1.9}}: describes how the gold carryover works in this scenario. This is intended to be a more convenient way of displaying carryover information than using the note= key in [objectives].<br /> ** '''bonus''' (boolean): whether an early finish bonus is granted. If omitted, early finish bonus is not mentioned.<br /> ** '''carryover_percentage''': the amount of carryover gold. If omitted, the amount is not mentioned.<br /> * '''[note]''' {{DevFeature1.9}}: describes a note, usually used for hints or additional information. This is an easier way of adding several notes than concatenating them together into a single string to use with the ''note='' key.<br /> ** '''description''': the text of the note.<br /> <br /> === Macros ===<br /> There are a few predefined macros for Objectives that you can use to shorten the code: [http://www.wesnoth.org/macro-reference.xhtml#SET_OBJECTIVES SET_OBJECTIVES], [http://www.wesnoth.org/macro-reference.xhtml#VICTORY_CONDITION VICTORY_CONDITION], and [http://www.wesnoth.org/macro-reference.xhtml#DEFEAT_CONDITION DEFEAT_CONDITION]. Follow the links for each one to see complete syntax and example usage.<br /> <br /> == [set_menu_item] ==<br /> This tag is used to add a custom option in the right-click context menu which can then be used to trigger arbitrary WML commands.<br /> <br /> '''Note:''' Due to limitations in portable devices where there are no scroll bars for context menus, there is a hard-coded limit of 7 custom WML menu items. If you really need to have more than 7 menu items, try combining some of them in a submenu.<br /> <br /> * '''id''': the unique id for this menu item. If a menu item with this id already exists, it allows you to set specific changes to that item.<br /> * '''description''': the in-game text that will appear for this item in the menu.<br /> * '''image''': the image to display next to this item.<br /> * '''needs_select''': if ''yes'' (default ''no''), then the latest select event (see [[EventWML]]) that triggered before this menu item was chosen will be transmitted over the network before this menu item action will be. This only has any effect in networked multiplayer, and is intended to allow more elaborate menu item behaviour there without causing out of sync errors. If you don't know what this means, just leave it false.<br /> * '''[show_if]''': If present, the menu item will only be available if the conditional statement (see [[InternalActionsWML]]) within evaluates to true. When this is evaluated, the WML variables ''$x1'' and ''$y1'' will point to the location on which the context menu was invoked, so it's possible to for example only enable the option on empty hexes or on a particular unit.<br /> * '''[filter_location]''': contains a location filter similar to the one found inside Single Unit Filters (see [[FilterWML]]). The menu item will only be available on matching locations.<br /> * '''[command]''': contains the WML actions to be executed when the menu item is selected. Again, the WML variables ''$x1'' and ''$y1'' will point to the location on which the context menu was invoked on.<br /> <br /> == Other interface tags ==<br /> <br /> The following tags are also action tags:<br /> * '''[item]''': makes a graphical item appear on a certain hex. Note this only places the graphics for an item. It does not make the item do anything. Use a moveto event to make moving onto the item do something. &lt;tt&gt;''('''Hint:''' There are a number of predefined items that are used in various campaigns that you can make use of. You can find [http://www.wesnoth.org/macro-reference.xhtml#file:items.cfg a list of them] if you look into the items.cfg file in the wesnoth install directory (under /data/core/macros))''&lt;/tt&gt;<br /> ** '''x''', '''y''': the location to place the item.<br /> ** '''image''': the image (in ''images/'' as .png) to place on the hex.<br /> ** '''halo''': an image to place centered on the hex. Use this instead of ''image'' if the image is bigger than the hex or if you want to animate an image. ''Example (where the integer after the colon is the duration of each frame): halo=scenery/fire1.png:100,scenery/fire2.png:100,scenery/fire3.png:100,scenery/fire4.png:100,scenery/fire5.png:100,scenery/fire6.png:100,scenery/fire7.png:100,scenery/fire8.png:100''<br /> ** '''team_name''': name of the team for which the item is to be displayed (hidden for others). For multiple teams just put all the names in one string, for example separated by commas.<br /> ** '''visible_in_fog''': whether the item should be visible through fog or not. Default yes.<br /> * '''[removeitem]''': removes any graphical items on a given hex<br /> ** '''x''', '''y''': the hex to remove items off<br /> ** '''image''' if specified, only removes the given image item (This image name must include any [[ImagePathFunctionWML|image path functions]] appended to the original image name.)<br /> * '''[print]''': displays a message across the screen. The message will disappear after a certain time.<br /> ** '''text''': (translatable) the text to display.<br /> ** '''size''': (default=12) the pointsize of the font to use<br /> ** '''duration''': (default=50) the length of time to display the text for. This is measured in the number of 'frames'. A frame in Wesnoth is usually displayed for around 30ms.<br /> ** '''red''', '''green''', '''blue''': (default=0,0,0) the color to display the text in. Values vary from 0-255.<br /> * '''[move_unit_fake]''': moves an image of a unit along a certain path on the map. The path does not need to be a continuous list of adjacent hexes, so for example only the start and end points can be given, in which case the straightest line between those points will be calculated and used.<br /> ** '''type''': the type of the unit whose image to use<br /> ** '''x''': a comma-separated list of x locations to move along<br /> ** '''y''': a comma-separated list of y locations to move along (x and y values are matched pairs)<br /> ** '''side''': the side of the fake unit, used for team-coloring the fake unit<br /> ** '''gender''': the gender of the fake unit. Example: gender=female<br /> ** '''variation''': the variation of the fake unit. Example: variation=undead<br /> * '''[move_units_fake]''': {{DevFeature1.9}} moves multiple images of units along paths on the map. These units are moved in lockstep.<br /> ** '''[fake_unit]''': A fake unit to move<br /> *** '''type''': the type of unit whose image to use<br /> *** '''x''': a comma-separated list of x locations to move along<br /> *** '''y''': a comma-separated list of y locations to move along (x and y values are matched pairs)<br /> *** '''side''': the side of the fake unit, used for team-coloring the fake unit<br /> *** '''skip_steps''': the number of steps to skip before this unit starts moving<br /> * '''[hide_unit]''': temporarily prevents the engine from displaying the given unit. The unit does not become invisible, as it would be with the '''[hides]''' ability; it is still the same plain unit, but without an image. Useful in conjunction with '''[move_unit_fake]''': to move a leader unit into position on-screen. Each '''[hide_unit]''' tag only hides one unit.<br /> ** '''x''', '''y''': location of the unit to be hidden. (NOT a standard unit filter! Just x and y.)<br /> ** {{DevFeature1.9}}: '''[hide_unit]''' accepts a [[StandardUnitFilter]] as argument and can disable several units at once.<br /> * '''[unhide_unit]''': stops the currently hidden units from being hidden.<br /> ** {{DevFeature1.9}}: '''[unhide_unit]''' accepts a [[StandardUnitFilter]] as argument.<br /> * '''[scroll]''': Scroll a certain number of pixels in a given direction. Useful for earthquake/shaking effects.<br /> ** '''x''', '''y''': the number of pixels to scroll along the x and y axis<br /> * '''[scroll_to]''': Scroll to a given hex<br /> ** '''x''', '''y''': the hex to scroll to<br /> ** '''check_fogged''': whether to scroll even to locations covered in fog or shroud. Possible values ''true'' (don't scroll to fog) and ''false'' (scroll even to fog), with ''false'' as the default.<br /> * '''[scroll_to_unit]''' Scroll to a given unit<br /> ** [[StandardUnitFilter]]<br /> ** '''check_fogged''': whether to scroll even to locations covered in fog or shroud. Possible values ''true'' (don't scroll to fog) and ''false'' (scroll even to fog), with ''false'' as the default.<br /> * '''[sound]''': Plays a sound<br /> ** '''name''': the filename of the sound to play (in ''sounds/'' as .wav or .ogg)<br /> ** '''repeat''': repeats the sound for a specified additional number of times (default=0)<br /> * '''[sound_source]''': Creates a sound source. &quot;Sound sources&quot; is a general name for a mechanism which makes possible for map elements to emit sounds according to some rules, where &quot;map elements&quot; can be specific locations or terrain types. For now, only sound sources tied to locations are supported.<br /> ** '''id''': a unique identification key of the sound source<br /> ** '''sounds''': a list of comma separated, randomly played sounds associated with the sound source<br /> ** '''delay''': a numerical value (in milliseconds) of the minimal delay between two playbacks of the source's sound if the source remains visible on the screen; if one scrolls out and back in, the source will be considered as ready to play<br /> ** '''chance''': a percentage (a value from 0 to 100) describing the chance of the source being activated every second after the delay has passed or when the source's location appears on the screen (note that it cannot play more than one file at the same time)<br /> ** '''check_fogged''': possible values &quot;true&quot; and &quot;false&quot; - if true the source will not play if its locations are fogged<br /> ** '''check_shrouded''': {{DevFeature}} possible values &quot;true&quot; and &quot;false&quot; - if true the source will not play if its locations are shrouded<br /> ** '''x,y''': similar to x,y as found in a [[StandardLocationFilter]], these are the locations associated with the sound source<br /> ** '''fade_range''' (default = 3): distance in hexes that determines a &quot;circular&quot; area around the one specified by '''full_range''' where sound volume fades out linearly<br /> ** '''full_range''' (default = 14): distance in hexes that determines a &quot;circular&quot; area where source plays with full volume, relative to screen center<br /> ** '''loop''': number of times a sound sample should be looped if it stays visible. -1 means infinite (~65000)<br /> * '''[remove_sound_source]''': Removes a previously defined sound source.<br /> ** '''id''': the identification key of the sound source to remove<br /> * '''[music]''': Switches to playing different music<br /> ** '''name''': the filename of the music to play (in ''music/'' as .ogg)<br /> ** see [[MusicListWML]] for the correct syntax<br /> * '''[volume]''': {{DevFeature1.9}} Changes the game volume to a percent of the preferences volume for the game being played. Values can go from 0 to 100: <br /> ** '''music''': Changes the music volume.<br /> ** '''sound''': Changes the sound volume.<br /> * '''[colour_adjust]''': tints the colour of the screen.<br /> ** '''red''', '''green''', '''blue''': values from -255 to 255, the amount to tint by for each colour<br /> * '''[delay]''': pauses the game<br /> ** '''time''': the time to pause in milliseconds<br /> * '''[redraw]''': redraws the screen (this normally isn't done during events, although some of the other interface actions cause the screen or parts of it to be redrawn).<br /> ** '''side''': if used, recalculates fog and shroud for that side. Useful if you for example spawn friendly units in the middle of an event and want the shroud to update accordingly (otherwise units that spawn inside fog would remain invisible for the duration of the event, since the fog would not automatically get cleared around them).<br /> * '''[unit_overlay]''': sets an image that will be drawn over a particular unit, and follow it around<br /> ** '''x''', '''y''': the location of the unit to overlay on<br /> ** '''image''': the image to place on the unit<br /> ** {{DevFeature1.9}}: '''[unit_overlay]''' accepts a [[StandardUnitFilter]] as argument<br /> * '''[remove_unit_overlay]''': removes a particular overlayed image from a unit<br /> ** '''x''', '''y''': the location of the unit to remove an overlay from<br /> ** '''image''': the image to remove from the unit<br /> ** {{DevFeature1.9}}: '''[remove_unit_overlay]''' accepts a [[StandardUnitFilter]] as argument<br /> * '''[animate_unit]''': Uses an animation of a unit to animate it on screen (if the unit has the corresponding animation).<br /> ** '''flag''': The key to find the custom animation in the unit description (see the '''[extra_anim]''' description in [[AnimationWML]]). Standard animations can be triggered with the following keywords: ''leading recruited standing idling levelin levelout healing healed poisoned movement defend attack death victory pre_teleport post_teleport''<br /> ** '''[filter]''' with a [[StandardUnitFilter]] as argument, see [[FilterWML]]. By default, the unit at the event location will be animated. You can use this tag to choose any other unit to animate.<br /> ** '''[primary_attack]''': If this tag is not present, the filter for animation will be triggered with no attack. If it is here, all attacks from the unit will be filtered, and a matching one will be used to filter the animation. Takes a weapon filter as argument, see [[FilterWML]].<br /> ** '''[secondary_attack]''': Similar to '''[primary_attack]'''. May be needed to trigger a defense animation correctly, if there are more than one animations available for the defending unit.<br /> ** '''hits''': yes/no: which according variation of a attack/defense animation shall be chosen (required)<br /> ** '''text''': a text to hover during the animation <br /> ** '''red''': red value for the text color (0-255)<br /> ** '''green''': green value for the text color<br /> ** '''blue''': blue value for the text color<br /> ** '''with_bars''': yes/no: whether to display the status bars during the animation (e.g. the hitpoint bar)<br /> ** '''[animate]''': a sub block with the same syntax as '''[animate_unit]''' except that the '''[filter]''' block is mandatory to find the unit. This block will find and animate another unit simultaneously.<br /> ** '''[facing]''': a [[StandardLocationFilter]] specifying what direction the unit should be facing when animated<br /> * '''[label]''' places a label on the map.<br /> ** '''x''', '''y''': the location of the label<br /> ** '''text''': what the label should say<br /> ** '''team_name''': if specified, the label will only be visible to the given team.<br /> ** '''colour''': color of the label. The format is r,g,b; r, g and b are numbers between 0 and 255. <br /> ** '''visible_in_fog''': whether the label should be visible through fog or not. Default yes.<br /> ** '''visible_in_shroud''': whether the label should be visible through shroud or not. Default no.<br /> ** '''immutable''': whether this label is protected from being removed or changed by players. Default yes. {{DevFeature1.9}}<br /> * '''[deprecated_message]''' shows a deprecated message in the message area, this feature is only intended to be used to warn about deprecated macros in mainline. The message is not translatable.<br /> ** '''message''': the message to show.<br /> * '''[wml_message]''' outputs a message to Wesnoth's console output. Intended for campaign designers to output silent text to the console, without annoying the player; then, that text might contain information useful for later bug-reporting. The log domain for it is '''wml''', and the '''debug/dbg''' log level is available for use with the '''logger''' attribute. Depending on the current log level ('''error''' by default), which may be changed with the in-game :log command, or the --log-&lt;level&gt;=wml command line switch, the messages are echoed to the in-game chat.<br /> ** '''message''': the message to show.<br /> ** '''logger''': the Wesnoth engine output logger that should catch the text; this might be 'err' (the errors log level), 'warn'/'wrn' (the warnings log level) or anything else (the information log level). Not all information will be displayed depending on the log level chosen when starting Wesnoth.<br /> * '''[open_help]''' opens the in-game help.<br /> ** '''topic''': the id of the topic to open<br /> * '''[show_objectives]''': {{DevFeature}} refreshes the objectives defined by [objectives] and its [show_if] tags, and displays them. (It is also called whenever the user explicitly asks for the objectives; this matters only if the tag was overridden by a [[LuaWML#register_wml_action|Lua]] script.)<br /> ** '''side''': the side to show the objectives. If not set, all sides are used.<br /> * '''[chat]''' displays a message in the chat area. {{DevFeature1.9}}<br /> ** '''speaker''': The sender of the message. Normally this is a string. However if you enter the name of a variable in which a unit is stored (such as ''second_unit'') it will display that unit's name instead.<br /> ** '''message''': The message that should be displayed<br /> ** '''side''': A comma separated list of sides to show the message to. If the same machine controls multiple sides that are in this list, then the message will only be displayed once. If left blank the message will be send to all sides.<br /> <br /> == Useful Macros ==<br /> There are some predefined macros that you find useful for interface actions. You can find a complete list along with a detailed explanation of how they work [http://www.wesnoth.org/macro-reference.xhtml here].<br /> * '''{FLOATING_TEXT}''' Float some text over a unit similar to the damage numbers.<br /> * '''{HIGHLIGHT_UNIT}''' Highlight a unit on the map. Use this to show important units<br /> * '''{HIGHLIGHT_IMAGE}''' Places and highlights an image on the map. Use this to show important items or locations<br /> * '''{SET_IMAGE}''' Places an image on the map which has no other function.<br /> * '''{QUAKE &lt;soundfile&gt;}''' Creates a tremor like screenshake and plays &lt;soundfile&gt;. ('''{TREMOR}''' is a deprecated version, equivalent to '''{QUAKE (rumble.ogg)}''')<br /> * '''{FLASH_WHITE}''' Flash the screen white momentarily. You can also replace WHITE with RED, BLUE or GREEN for a different colour.<br /> <br /> == See Also ==<br /> * [[DirectActionsWML]]<br /> * [[InternalActionsWML]]<br /> * [[EventWML]]<br /> * [[ReferenceWML]]<br /> <br /> <br /> [[Category: WML Reference]]<br /> [[Category: ActionsWML]]</div>

Gambit https://wiki.wesnoth.org/index.php?title=EventWML&diff=38057 2010-08-26T21:17:59Z

<p>Gambit: /* Predefined 'name' Key Values */ more reordering</p> <hr /> <div>{{WML Tags}}<br /> == The [event] Tag ==<br /> <br /> This tag is a subtag of the [scenario], [unit_type] and [era] tags which is used to describe a set of actions which trigger at a certain point in a scenario. When used in a [scenario] tag (also includes [multiplayer], [tutorial] and [test]), the event only occurs in that scenario. When used in a [unit_type] tag, the event will occur in all scenarios in which a unit of that type appears in (only after such a unit appears during the scenario, however). When used in an [era], the event will occur in any scenario which is played using that era.<br /> <br /> This tag has keys and child tags that control when and if the event actions will be triggered. Most important of these is the '''name''' key. Without it, no error will be raised but the event will never fire. Therefore, from a practical standpoint, it can be considered mandatory. All of the others can be used or not and the event actions will fire either way.<br /> <br /> '''Lexicon side note:''' ''The word &quot;event&quot; in the [event] tag itself may be considered an abbreviation of the word &quot;event handler&quot; because it is technically not a game &quot;event&quot; but an event '''handler''' for the game events fired with the given 'name'. However, this distinction is usually unimportant in most discussions and the event handlers are therefore simply referred to as &quot;events&quot; in this documentation.''<br /> <br /> === The 'name' Key (Mandatory) ===<br /> <br /> Usage:<br /> name=&lt;value&gt;<br /> <br /> This key defines which game event or trigger your [event] tag will be handling. This 'name' key should not be confused with a descriptive comment; it is rather a precise value which must match the predefined game event's name to be valid.<br /> <br /> '''Lexicon side note:''' ''It is not uncommon to refer to these values as the 'trigger' for an event and, furthermore, to call an event by its 'trigger' name. For example, in an event containing '''name=moveto''', a person might refer to the event as a ''''moveto''' event' and/or refer to the ''''moveto''' trigger' in the event or even talk about the 'event trigger' when referring to the '''moveto''' value of the 'name' key in that event. Some or all of this usage can, in fact, be found throughout this page.''<br /> <br /> The '''name''' key can accept a list of comma separated values describing when the event will be triggered.* These values may be either predefined event types or custom event names not matching any predefined type.<br /> <br /> For example:<br /> <br /> name=attacker misses,defender misses<br /> <br /> ''* Note that unless you use [[#first_time_only|first_time_only=no]], the event will fire only once, '''not''' once for each listed type.''<br /> <br /> ==== Predefined 'name' Key Values ====<br /> <br /> All predefined event types are listed here along with a description of when this value will cause the event to be triggered. Any value ''not'' listed here is a custom event name which can be triggered only by a '''[fire_event]''' tag somewhere else. Spaces in event names can be interchanged with underscores (for example, '''name=new turn''' and '''name=new_turn''' are equivalent).<br /> <br /> ; preload<br /> : Triggers before a scenario 'prestarts' and when loading a savegame -- before anything is shown on the screen at all. Can be used to set up the [[LuaWML|Lua]] environment: loading libraries, defining helper functions, etc.<br /> : '''Note:''' Unlike prestart and start, the preload event '''must be able to fire more than once!''' This is because it is triggered each time a savegame is loaded in addition to the initial time when it loads before the scenario 'prestart'. This means that it is effectively ''mandatory'' to have the [[#first_time_only|first_time_only=no]] key value in a preload event. <br /> <br /> ; prestart<br /> : Triggers before a scenario 'starts' -- before anything is shown on the screen at all. Can be used to set up things like village ownership. For things displayed on-screen such as character dialog, use '''start''' instead.<br /> : '''Note:''' ''This value makes the [[#first_time_only|first_time_only]] key irrelevant since, by definition, it can only fire once.''<br /> <br /> ; start<br /> : Triggers after the map is shown but before the scenario begins -- before players can 'do' anything.<br /> : '''Note:''' ''This value makes the [[#first_time_only|first_time_only]] key irrelevant since, by definition, it can only fire once.''<br /> <br /> ; new turn<br /> : Triggers at the start of every turn (not side turn). See also [[#first_time_only|first_time_only=no]]. Before any events of this type trigger, the value of the WML variable '''turn_number''' is set to the number of the turn that is beginning.<br /> <br /> ; side turn<br /> : Triggers when a side is about to start its turn. Before events of this type trigger, the value of the WML variable '''side_number''' is set to the number of the side of the player about to take their turn. This is before any healing takes place for that side, before calculating income, and before restoring unit movement and status.<br /> :Side initialization events go in the order of: <br /> : 1) '''turn ''X''''' <br /> :2) '''new turn''' <br /> :3) '''side turn''' <br /> :4) '''side ''X'' turn''' <br /> :5) '''side turn ''X''''' <br /> :6) '''side ''X'' turn ''Y''''' <br /> :7) '''turn refresh''' <br /> :8) '''side ''X'' turn refresh''' <br /> :9) '''turn ''X'' refresh''' <br /> :10) '''side ''X'' turn ''Y'' refresh'''<br /> <br /> ; ai turn<br /> : Triggered just before the AI is invoked for a side. This is called after ''side turn'', and thus the WML variable '''side_number''' still holds the number of this side. Note that this event might be called several times per turn in case that fallbacks to human or droiding is involved. I.e. it happens at the middle of turn of human side 1 if the human player droids his side. It happens after the selection of ai to play the turn but before AI is told that new turn has come.<br /> : '''Note:''' ''This event currently breaks replays since it is not explicitly saved in a replay and there is no AI involved in replays...''<br /> <br /> ; turn refresh<br /> : Like '''side turn''', triggers just before a side is taking control but '''after''' healing, calculating income, and restoring unit movement and status.<br /> <br /> ; turn ''X''<br /> : Triggers at the start of turn ''X''. It's the first side initialization event. <br /> <br /> ; turn end {{DevFeature1.9}}<br /> : Triggers at the end of every turn (not side turn end). The WML variable '''side_number''' will contain the side that ended their turn. It is the last event in the group of end turn events.<br /> <br /> ; turn ''X'' end {{DevFeature1.9}}<br /> : Triggers at the end of turn ''X''. It's the second to last event in the group of end turn events. <br /> <br /> ; side ''X'' turn ''Y''<br /> : This event triggers at the start of turn ''Y'' of side X {{DevFeature}}<br /> <br /> ; side ''X'' turn<br /> : This event triggers at the start of any turn of side X {{DevFeature}}<br /> : '''Note:''' ''Of course, [[#first_time_only|first_time_only=no]] is needed for this event to be triggered more than once.''<br /> <br /> ; side turn ''X''<br /> : This event triggers at the start of any side on turn X {{DevFeature1.9}}<br /> : '''Note:''' ''Of course, [[#first_time_only|first_time_only=no]] is needed for this event to be triggered more than once.''<br /> <br /> ; side X turn Y refresh<br /> : This event triggers at the turn refresh for side X on turn Y {{DevFeature1.9}}<br /> <br /> ; side ''X'' turn refresh<br /> : This event triggers at the turn refresh for side X {{DevFeature1.9}}<br /> : '''Note:''' ''Of course, [[#first_time_only|first_time_only=no]] is needed for this event to be triggered more than once.''<br /> <br /> ; turn ''X'' refresh<br /> : This event triggers for any side at the refresh of turn X. {{DevFeature1.9}}<br /> : '''Note:''' ''Of course, [[#first_time_only|first_time_only=no]] is needed for this event to be triggered more than once.''<br /> <br /> ; side turn end {{DevFeature1.9}}<br /> : Triggers after a side ends its turn. Like side turn, there are also some variations for specific combinations of side number and turn number. Here is the order in which the turn end events trigger:<br /> :1) '''side turn end''' <br /> :2) '''side ''X'' turn end''' <br /> :3) '''side turn ''X'' end''' <br /> :4) '''side ''X'' turn ''Y'' end''' <br /> :5) '''turn end''' <br /> :6) '''turn ''X'' end'''<br /> <br /> ==== Custom events ====<br /> <br /> An event with a custom name may be invoked using the [[InternalActionsWML#.5Bfire_event.5D|[fire_event]]] tag. Normally you'll use such custom events as named subroutines to be called by events with predefined types. One common case of this, for example, is that more than one '''sighted''' events might fire the same custom event that changes the scenario objectives.<br /> <br /> === Optional Keys and Tags ===<br /> <br /> These keys and tags are more complex ways to filter when an event should trigger:<br /> <br /> ==== first_time_only ====<br /> : Whether the event should be removed from the scenario after it is triggered. This key takes a [[ConditionalActionsWML#Boolean_Values|boolean]]; for example:<br /> : ''first_time_only=yes''<br /> :: Default behavior if key is omitted. The event will trigger the first time it can and never again.<br /> : ''first_time_only=no''<br /> :: The event will trigger every time the criteria are met instead of only the first time.<br /> <br /> ==== [filter] ====<br /> : The event will only trigger if the primary unit matches this filter.<br /> :* [[StandardUnitFilter]]: selection criteria<br /> <br /> ==== [filter_second] ====<br /> : Like [filter], but for the secondary unit.<br /> :* [[StandardUnitFilter]]: selection criteria<br /> <br /> ==== [filter_attack] ====<br /> : Can be used to set additional filtering criteria for the primary unit and the secondary unit that are not generally available in a standard unit filter. Can be used in events ''attack'', ''attacker hits'', ''attacker misses'', ''defender hits'', ''defender misses'' and ''attack end''. For more information and other filter keys, see [[FilterWML]].<br /> :* '''name''': the name of the weapon used.<br /> :* '''range''': the range of the weapon used.<br /> :* '''special''': filter on the attack's special power.<br /> <br /> ==== [filter_second_attack] ====<br /> : Like [filter_attack], but for the secondary unit.<br /> :* '''name''': the name of the weapon used.<br /> :* '''range''': the range of the weapon used.<br /> :* '''special''': filter on the attack's special power.<br /> <br /> ==== [event] ====<br /> : A special case 'action', the [event] tag may be used to create a [[#Nested Events|nested event]].<br /> <br /> ==== delayed_variable_substitution ====<br /> : This key is only relevant inside of a [[#Delayed Variable Substitution|nested event]] and controls when variable substitution will occur in those special case actions.<br /> <br /> === Actions triggered by [event] ===<br /> <br /> After the trigger conditions have been met, all action tags within the [event] tag are executed in the order they are written in.<br /> <br /> There are 3 main types of actions:<br /> * direct actions ([[DirectActionsWML]]) which have a direct effect on gameplay<br /> * display actions ([[InterfaceActionsWML]]) which show something to the user<br /> * internal actions ([[InternalActionsWML]]) which are used by WML internally<br /> <br /> Several actions use standard filters to find out which units<br /> to execute the command on. These are denoted by the phrases<br /> &quot;standard unit filter&quot; and &quot;standard location filter&quot;.<br /> <br /> === Nested Events ===<br /> <br /> There is one special type of action: event creation. By placing an '''[event]''' tag inside another '''[event]''' tag, the nested event is spawned (created) when the parent (outer) event is encountered (when executing the contents of the parent event).<br /> <br /> ([[#Nested Event Example|See Examples]])<br /> <br /> ==== Delayed Variable Substitution ====<br /> <br /> Variable substitution for a nested event can happen either when it is spawned by the parent event or when it is triggered itself. This is controlled with the key '''delayed_variable_substitution''' which is used in the nested event.<br /> <br /> If this key is set to ''yes'', the variables in the nested event will contain values from the turn in which the ''nested'' event was triggered. ''This is the default behavior if the key is omitted.'' If set to ''no'', the variables in the nested event are set at the time the ''parent'' event is triggered.<br /> <br /> This behavior can be fine tuned with a special syntax when referencing variables. Instead of the normal '''$variable''' syntax, use '''$|variable''' to cause a variable to contain values relevant to the turn in which the nested event was triggered even when '''delayed_variable_substitution''' is set to ''no''. In this way you can have a mix of variables relevant to the parent and nested event trigger times.<br /> <br /> ([[#Delayed Variable Substitution Example|See Examples]])<br /> <br /> == Multiplayer safety ==<br /> <br /> In multiplayer it is only safe to use WML that might require synchronization with other players because of input or random numbers (like [message] with input or options or [unstore_unit] where a unit might advance) in the following events. This is because in these cases WML needs data from other players to work right and/or do the same thing for all players. This data is only available after a network synchronization.<br /> <br /> List of synchronized events:<br /> * moveto<br /> * sighted <br /> * attack<br /> * attack_end <br /> * attacker hits <br /> * attacker misses <br /> * defender hits<br /> * defender misses <br /> * stone<br /> * last breath <br /> * menu item X<br /> * die<br /> * capture <br /> * recruit<br /> * prerecruit <br /> * recall <br /> * prerecall <br /> * advance <br /> * post_advance <br /> getting message options (etc) from the following events is not synchronized, except in the development version (1.9+svn):<br /> * new turn <br /> * side turn <br /> * turn X <br /> * side X turn <br /> * side X turn Y <br /> * turn refresh <br /> <br /> There is also the possibility of events that are normally synchronized when fired by the engine but can be non-synchronized when fired by WML tags from non-synchronized event. So when you are using them you must be extra careful. For example [unstore_unit] may trigger a unit advancement that will fire ''advance'' and ''post advance'' events.<br /> <br /> == A Trap for the Unwary ==<br /> <br /> It is perfectly possible (and, in fact, useful) to have multiple events with the same predefined name and thus the same trigger condition. However, it is not defined what order such events will fire in, so you need to code so the order <br /> will not matter.<br /> <br /> Because of the above, you need to beware of using macros to generate events. If you include a macro expanding to an event definition twice, the event will be executed twice (not once) each time the trigger condition fires. Consider this code:<br /> <br /> #define DOUBLE<br /> [event]<br /> name=multiply_by_2<br /> {VARIABLE_OP 2_becomes_4 multiply 2}<br /> [/event]<br /> #enddef<br /> <br /> {DOUBLE}<br /> {DOUBLE}<br /> <br /> {VARIABLE 2_becomes_4 2}<br /> <br /> [fire_event]<br /> name=multiply_by_2<br /> [/fire_event]<br /> <br /> {DEBUG_MSG &quot;$2_becomes_4 should be 4&quot;}<br /> <br /> After it executes, the debug message will reveal that the variable has been set to 8, not 4.<br /> <br /> == Miscellaneous Notes and Examples ==<br /> <br /> === Primary/Secondary Unit Speaker Example ===<br /> <br /> In events, the primary unit can be referred to as '''unit''' and the secondary unit can be referred to as '''second_unit''' in [message] tags using the '''speaker''' key. For example:<br /> <br /> [event]<br /> name=die<br /> [message]<br /> speaker='''second_unit'''<br /> message= _ &quot;Hahaha! I finally killed you!&quot;<br /> [/message]<br /> <br /> [message]<br /> speaker='''unit'''<br /> message= _ &quot;It's not over yet! I'll come back to haunt you!&quot;<br /> [/message]<br /> [/event]<br /> <br /> === Nested Event Example ===<br /> <br /> An event is created for a portal that opens on turn 10. The parent (or 'outer') event executes on turn 10 at which point the nested moveto event is created. This nested event executes when a player steps on a certain spot.<br /> <br /> [event]<br /> name=turn 10<br /> <br /> [event]<br /> name=moveto<br /> <br /> [filter]<br /> x,y=5,8<br /> [/filter]<br /> <br /> # moving to 5,8 will trigger this event only on turn 10 and after<br /> [/event]<br /> [/event]<br /> <br /> An equivalent way of doing this would be to create a single moveto event with an '''[if]''' statement to check for turn number but using nested '''[event]''' tags is a convenient shortcut to accomplish this task without resorting to '''[if]''' statements.<br /> <br /> === Delayed Variable Substitution Example ===<br /> <br /> This code will display a message showing the turn number on which the nested ''moveto'' event happens.<br /> <br /> [event]<br /> name=turn 10<br /> <br /> [event]<br /> name=moveto<br /> delayed_variable_substitution=yes<br /> <br /> [filter]<br /> x,y=5,8<br /> [/filter]<br /> <br /> {DEBUG_MSG &quot;Turn $turn_number&quot;} <br /> [/event]<br /> [/event]<br /> <br /> Since this is the default behavior for the '''delayed_variable_substitution''' key, the following example is identical.<br /> <br /> [event]<br /> name=turn 10<br /> <br /> [event]<br /> name=moveto<br /> <br /> [filter]<br /> x,y=5,8<br /> [/filter]<br /> <br /> {DEBUG_MSG &quot;Turn $turn_number&quot;} <br /> [/event]<br /> [/event]<br /> <br /> The following code will always display &quot;Turn 10&quot; when the nested ''moveto'' event happens. This is because the variable substitution is done when the parent event is triggered and spawns the nested event, ''not'' when the nested event is triggered.<br /> <br /> [event]<br /> name=turn 10<br /> <br /> [event]<br /> name=moveto<br /> delayed_variable_substitution=no<br /> <br /> [filter]<br /> x,y=5,8<br /> [/filter]<br /> <br /> {DEBUG_MSG &quot;Turn $turn_number&quot;} <br /> [/event]<br /> [/event]<br /> <br /> Finally, the following example is identical to the first two in that it will display a message showing the turn number on which the nested ''moveto'' event happens, despite the fact that the '''delayed_variable_substitution''' key is set to ''no''. This is because the special '''$|variable''' syntax is used.<br /> <br /> [event]<br /> name=turn 10<br /> <br /> [event]<br /> name=moveto<br /> delayed_variable_substitution=no<br /> <br /> [filter]<br /> x,y=5,8<br /> [/filter]<br /> <br /> {DEBUG_MSG &quot;Turn $|turn_number&quot;} <br /> [/event]<br /> [/event]<br /> <br /> === Multiple Nested Events ===<br /> <br /> Every delayed_variable_substitution=no causes a variable substitution run on the subevent where it occurs at the spawn time of this event and on all following subevents. For any specific event, variable substitution happens at least one time when the event is executed. For each delayed=no key appearing in itself or in an event of an &quot;older&quot; generation, which is not the toplevel event, an additional variable substitution run is made.<br /> [event]# parent<br /> name=turn 2<br /> #delayed_variable_substitution=no # In the parent event, delayed= has no effect.<br /> <br /> [event]# child<br /> name=turn 3<br /> delayed_variable_substitution=no # Causes variable substitution in the child, grandchild and great-grandchild event<br /> # at execution time of the parent event = spawn time of the child event.<br /> <br /> [event]# grandchild<br /> name=turn 4<br /> delayed_variable_substitution=yes # no variable substitution in the grandchild and great-grandchild event<br /> # at execution time of the child event = spawn time of the grandchild event<br /> <br /> [event]# great-grandchild<br /> name=turn 5<br /> {DEBUG_MSG $turn_number}# output: 2 - value from the variable substitution at execution time of the parent event,<br /> # caused by delayed=no in the child event<br /> <br /> {DEBUG_MSG $||turn_number}# output: &quot;$turn_number&quot;<br /> # Each variable substitution transforms a &quot;$|&quot; to a &quot;$&quot; (except when no | left).<br /> <br /> {DEBUG_MSG $|turn_number}# output: 5 - from the variable substitution at execution time<br /> # of the great-grandchild event<br /> [/event]<br /> [/event]<br /> [/event]<br /> [/event]<br /> <br /> == See Also ==<br /> <br /> * [[DirectActionsWML]]<br /> * [[InternalActionsWML]]<br /> * [[InterfaceActionsWML]]<br /> * [[FilterWML]]<br /> * [[ReferenceWML]]<br /> <br /> <br /> [[Category: WML Reference]]</div>

Gambit https://wiki.wesnoth.org/index.php?title=EventWML&diff=38056 2010-08-26T21:07:38Z

<p>Gambit: reordered some things from my last edit</p> <hr /> <div>{{WML Tags}}<br /> == The [event] Tag ==<br /> <br /> This tag is a subtag of the [scenario], [unit_type] and [era] tags which is used to describe a set of actions which trigger at a certain point in a scenario. When used in a [scenario] tag (also includes [multiplayer], [tutorial] and [test]), the event only occurs in that scenario. When used in a [unit_type] tag, the event will occur in all scenarios in which a unit of that type appears in (only after such a unit appears during the scenario, however). When used in an [era], the event will occur in any scenario which is played using that era.<br /> <br /> This tag has keys and child tags that control when and if the event actions will be triggered. Most important of these is the '''name''' key. Without it, no error will be raised but the event will never fire. Therefore, from a practical standpoint, it can be considered mandatory. All of the others can be used or not and the event actions will fire either way.<br /> <br /> '''Lexicon side note:''' ''The word &quot;event&quot; in the [event] tag itself may be considered an abbreviation of the word &quot;event handler&quot; because it is technically not a game &quot;event&quot; but an event '''handler''' for the game events fired with the given 'name'. However, this distinction is usually unimportant in most discussions and the event handlers are therefore simply referred to as &quot;events&quot; in this documentation.''<br /> <br /> === The 'name' Key (Mandatory) ===<br /> <br /> Usage:<br /> name=&lt;value&gt;<br /> <br /> This key defines which game event or trigger your [event] tag will be handling. This 'name' key should not be confused with a descriptive comment; it is rather a precise value which must match the predefined game event's name to be valid.<br /> <br /> '''Lexicon side note:''' ''It is not uncommon to refer to these values as the 'trigger' for an event and, furthermore, to call an event by its 'trigger' name. For example, in an event containing '''name=moveto''', a person might refer to the event as a ''''moveto''' event' and/or refer to the ''''moveto''' trigger' in the event or even talk about the 'event trigger' when referring to the '''moveto''' value of the 'name' key in that event. Some or all of this usage can, in fact, be found throughout this page.''<br /> <br /> The '''name''' key can accept a list of comma separated values describing when the event will be triggered.* These values may be either predefined event types or custom event names not matching any predefined type.<br /> <br /> For example:<br /> <br /> name=attacker misses,defender misses<br /> <br /> ''* Note that unless you use [[#first_time_only|first_time_only=no]], the event will fire only once, '''not''' once for each listed type.''<br /> <br /> ==== Predefined 'name' Key Values ====<br /> <br /> All predefined event types are listed here along with a description of when this value will cause the event to be triggered. Any value ''not'' listed here is a custom event name which can be triggered only by a '''[fire_event]''' tag somewhere else. Spaces in event names can be interchanged with underscores (for example, '''name=new turn''' and '''name=new_turn''' are equivalent).<br /> <br /> ; preload<br /> : Triggers before a scenario 'prestarts' and when loading a savegame -- before anything is shown on the screen at all. Can be used to set up the [[LuaWML|Lua]] environment: loading libraries, defining helper functions, etc.<br /> : '''Note:''' Unlike prestart and start, the preload event '''must be able to fire more than once!''' This is because it is triggered each time a savegame is loaded in addition to the initial time when it loads before the scenario 'prestart'. This means that it is effectively ''mandatory'' to have the [[#first_time_only|first_time_only=no]] key value in a preload event. <br /> <br /> ; prestart<br /> : Triggers before a scenario 'starts' -- before anything is shown on the screen at all. Can be used to set up things like village ownership. For things displayed on-screen such as character dialog, use '''start''' instead.<br /> : '''Note:''' ''This value makes the [[#first_time_only|first_time_only]] key irrelevant since, by definition, it can only fire once.''<br /> <br /> ; start<br /> : Triggers after the map is shown but before the scenario begins -- before players can 'do' anything.<br /> : '''Note:''' ''This value makes the [[#first_time_only|first_time_only]] key irrelevant since, by definition, it can only fire once.''<br /> <br /> ; new turn<br /> : Triggers at the start of every turn (not side turn). See also [[#first_time_only|first_time_only=no]]. Before any events of this type trigger, the value of the WML variable '''turn_number''' is set to the number of the turn that is beginning.<br /> <br /> ; side turn<br /> : Triggers when a side is about to start its turn. Before events of this type trigger, the value of the WML variable '''side_number''' is set to the number of the side of the player about to take their turn. This is before any healing takes place for that side, before calculating income, and before restoring unit movement and status.<br /> :Side initialization events go in the order of: <br /> : 1) '''turn ''X''''' <br /> :2) '''new turn''' <br /> :3) '''side turn''' <br /> :4) '''side ''X'' turn''' <br /> :5) '''side turn ''X''''' <br /> :6) '''side ''X'' turn ''Y''''' <br /> :7) '''turn refresh''' <br /> :8) '''side ''X'' turn refresh''' <br /> :9) '''turn ''X'' refresh''' <br /> :10) '''side ''X'' turn ''Y'' refresh'''<br /> <br /> ; ai turn<br /> : Triggered just before the AI is invoked for a side. This is called after ''side turn'', and thus the WML variable '''side_number''' still holds the number of this side. Note that this event might be called several times per turn in case that fallbacks to human or droiding is involved. I.e. it happens at the middle of turn of human side 1 if the human player droids his side. It happens after the selection of ai to play the turn but before AI is told that new turn has come.<br /> : '''Note:''' ''This event currently breaks replays since it is not explicitly saved in a replay and there is no AI involved in replays...''<br /> <br /> ; turn refresh<br /> : Like '''side turn''', triggers just before a side is taking control but '''after''' healing, calculating income, and restoring unit movement and status.<br /> <br /> ; turn ''X''<br /> : Triggers at the start of turn ''X''. It's the first side initialization event. <br /> <br /> ; turn end {{DevFeature1.9}}<br /> : Triggers at the end of every turn (not side turn). See also [[#first_time_only|first_time_only=no]]. The WML variable '''side_number''' will contain the side that ended their turn. It is the first event in the group of end turn events.<br /> <br /> ; turn ''X'' end {{DevFeature1.9}}<br /> : Triggers at the end of turn ''X''. It's the second event in the group of end turn events. <br /> <br /> ; side ''X'' turn ''Y''<br /> : This event triggers at the start of turn ''Y'' of side X {{DevFeature}}<br /> <br /> ; side ''X'' turn<br /> : This event triggers at the start of any turn of side X {{DevFeature}}<br /> : '''Note:''' ''Of course, [[#first_time_only|first_time_only=no]] is needed for this event to be triggered more than once.''<br /> <br /> ; side turn ''X''<br /> : This event triggers at the start of any side on turn X {{DevFeature1.9}}<br /> : '''Note:''' ''Of course, [[#first_time_only|first_time_only=no]] is needed for this event to be triggered more than once.''<br /> <br /> ; side X turn Y refresh<br /> : This event triggers at the turn refresh for side X on turn Y {{DevFeature1.9}}<br /> <br /> ; side ''X'' turn refresh<br /> : This event triggers at the turn refresh for side X {{DevFeature1.9}}<br /> : '''Note:''' ''Of course, [[#first_time_only|first_time_only=no]] is needed for this event to be triggered more than once.''<br /> <br /> ; turn ''X'' refresh<br /> : This event triggers for any side at the refresh of turn X. {{DevFeature1.9}}<br /> : '''Note:''' ''Of course, [[#first_time_only|first_time_only=no]] is needed for this event to be triggered more than once.''<br /> <br /> ; side turn end {{DevFeature1.9}}<br /> : Triggers after a side ends its turn. Like side turn, there are also some variations for specific combinations of side number and turn number. Here is the order in which the turn end events trigger:<br /> :1) '''turn end''' <br /> :2) '''turn ''X'' end''' <br /> :3) '''side turn end''' <br /> :4) '''side ''X'' turn end''' <br /> :5) '''side turn ''X'' end''' <br /> :6) '''side ''X'' turn ''Y'' end''' <br /> <br /> ; time over<br /> : Triggers on turn ''turns''. (''turns'' is specified in [scenario])<br /> <br /> ; enemies defeated<br /> : Triggers when all units with '''canrecruit=yes''' (that is, all leaders) not allied with side 1 are killed.<br /> <br /> ; victory<br /> : In this scenario, any tag of the form '''[endlevel] result=victory [/endlevel]''' will be automatically preceded by all actions in this tag. It helps debugging if the victory event allows you to safely advance to any of the possible next maps after using the &quot;:n&quot; command. Scenarios where key units are picked up before the victory, or where some action chosen earlier determines which map to advance to, make it hard to quickly test scenarios in a campaign. (See also: [endlevel], [[DirectActionsWML]])<br /> <br /> ; defeat<br /> : In this scenario, any tag of the form '''[endlevel] result=defeat [/endlevel]''' will be automatically preceded by all actions in this tag. (See also [endlevel], [[DirectActionsWML]])<br /> <br /> <br /> Filters can be applied to the following event triggers (see [[FilterWML]]; see also below). The actions specified in the event tag will be executed only if the filter returns true. <br /> These event triggers are all actions by units ('''moveto''', '''attack''') or things that happen to units ('''recruit''', '''advance'''). When one of these events is triggered, the position of the active unit (referred to as the '''primary unit''') is stored in the variables '''x1''' and '''y1''' and the position of any unit that primary unit does something to is stored in the variables '''x2''' and '''y2''' (this unit is referred to as the '''secondary unit''' below). '' These units are also automatically stored in the variables 'unit' and 'second_unit' as if they had been stored using the '''[store_unit]''' tag. see [[SingleUnitWML]]<br /> <br /> ; moveto<br /> : Triggers after the primary unit moves. Typically this is used when the primary unit gets to a particular location and a filter for the location of the primary unit is included; remember that this is the location that the primary unit lands on, not the location it started on or any location it travels on.&lt;br /&gt;''An '''[allow_undo]''' tag anywhere within a moveto event will cancel any lack of undo functionality the event would have caused. Note that undo functionality will only move the unit back to its former location; it will not undo other changes to the game caused by the event. Thus it is up to the scenario designer to use this tag correctly.'' {{DevFeature}} $x2 and $y2 refer to the hex the unit came from.<br /> <br /> ; sighted<br /> : Triggers when the primary unit becomes visible to the secondary unit in particular after not being visible to the secondary unit's side (so if the secondary unit's side doesn't have shroud or fog, the event never triggers). This happens both when the primary unit moves into view during its turn, and when the secondary unit moves to a location where it can see the primary unit. (This editor hasn't tested whether the event triggers multiple times if the primary unit moves into view of multiple units at once, or if not, which one gets chosen to be the secondary unit here.) (Note: it appears that when a sighted event is triggered because an enemy unit moves into your field of view, the game engine cannot determine which unit (on your side) sees the unit that moved, and so it fires a ''name=sighted'' event without setting ''$second_unit''. This means that, for example, using ''speaker=second_unit'' inside a message tag may fail.) (Double note: it also appears that the sighted event in more recent versions of the game (1.6 and 1.7, maybe?) does not fire on enemy turns. That is, it only fires for units that become visible as a result of the motion of another unit, not for units that move into the vision of an enemy. This event is also buggy in general... it's usually better to use a moveto event with a [filter_vision] tag than to use a sighted event (and note that the combination of the two can achieve something like the old sighted event)).<br /> <br /> ; attack<br /> : Triggers when the primary unit attacks the secondary unit.<br /> <br /> ; attack end<br /> : Similar to '''attack''', but is triggered ''after'' the fight instead of before. Note that if either unit is killed during the fight, this event triggers before any '''die''' events.<br /> <br /> ; attacker hits<br /> : Triggers when the the primary unit (the attacker) hits the secondary unit (the defender). The value of the WML variable '''damage_inflicted''' is set to the number of hitpoints inflicted by the attacker.<br /> <br /> ; attacker misses<br /> : Same as ''attacker hits'', but is triggered when the attacker misses.<br /> <br /> ; defender hits<br /> : Triggers when the primary unit (the attacker) is hit in retaliation by the secondary unit (the defender). The value of the WML variable '''damage_inflicted''' is set to the number of hitpoints inflicted by the defender.<br /> <br /> ; defender misses<br /> : Same as ''defender hits'', but is triggered when the defender misses.<br /> <br /> ; stone<br /> : Triggers when the primary unit is hit by an attack with the 'stones' ability (See ''stones'', [[AbilitiesWML]]) by the secondary unit (the unit with the 'stones' ability). In {{DevFeature}}, this event name is changed to &quot;petrified&quot;.<br /> <br /> ; last breath<br /> : Triggers when the primary unit is killed by the secondary unit, but before the death animation is triggered. Use this instead of name=die when you want the primary unit to make a final [message]. <br /> <br /> ; die<br /> : Triggers when the primary unit is killed by the secondary unit. ''Note: The primary unit is not removed from the game until the end of this event. The primary unit can still be manipulated, will block other units from taking its hex, and will still be found by standard unit filters (except [have_unit]). To prevent this behavior, you can use [kill] to remove the unit immediately. However, this will stop any (still unfired) other events that also match the unit from firing afterwards, so use with caution.'' If you want to the primary unit to make a final [message], use name=last_breath, see above.<br /> <br /> ; capture<br /> : Triggers when the primary unit captures a village. The village may have been previously neutral, or previously owned by another side; merely moving into your own villages does not constitute a capture.<br /> <br /> ; recruit<br /> : Triggers when the primary unit is recruited. (That is, when a unit is recruited it will trigger this event and this event's filter will filter that unit.).<br /> <br /> ; prerecruit<br /> : Triggers when the primary unit is recruited but before it is displayed.<br /> <br /> ; recall<br /> : Triggers after a unit is recalled.<br /> <br /> ; prerecall<br /> : Triggers when a unit is recalled but before it is displayed.<br /> <br /> ; advance<br /> : Triggers just before the primary unit is going to advance to another unit.<br /> <br /> ; post advance<br /> : Triggers just after the primary unit has advanced to another unit.<br /> <br /> ; select<br /> : Triggers when the primary unit is selected. Also triggers when ending a move, as the game keeps the moving unit selected by selecting it again at the end of movement. ''Note: in networked multiplayer, these events are only executed by the client on which the event is triggered, leading to out of sync errors if you modify the game state in the event.''<br /> <br /> ; menu item ''X''<br /> : Triggers when a WML menu item with id=''X'' is selected. ''Note: if the menu item has a [command], this event may be executed before or after the command; there is no guarantee.''<br /> <br /> ==== Custom events ====<br /> <br /> An event with a custom name may be invoked using the [[InternalActionsWML#.5Bfire_event.5D|[fire_event]]] tag. Normally you'll use such custom events as named subroutines to be called by events with predefined types. One common case of this, for example, is that more than one '''sighted''' events might fire the same custom event that changes the scenario objectives.<br /> <br /> === Optional Keys and Tags ===<br /> <br /> These keys and tags are more complex ways to filter when an event should trigger:<br /> <br /> ==== first_time_only ====<br /> : Whether the event should be removed from the scenario after it is triggered. This key takes a [[ConditionalActionsWML#Boolean_Values|boolean]]; for example:<br /> : ''first_time_only=yes''<br /> :: Default behavior if key is omitted. The event will trigger the first time it can and never again.<br /> : ''first_time_only=no''<br /> :: The event will trigger every time the criteria are met instead of only the first time.<br /> <br /> ==== [filter] ====<br /> : The event will only trigger if the primary unit matches this filter.<br /> :* [[StandardUnitFilter]]: selection criteria<br /> <br /> ==== [filter_second] ====<br /> : Like [filter], but for the secondary unit.<br /> :* [[StandardUnitFilter]]: selection criteria<br /> <br /> ==== [filter_attack] ====<br /> : Can be used to set additional filtering criteria for the primary unit and the secondary unit that are not generally available in a standard unit filter. Can be used in events ''attack'', ''attacker hits'', ''attacker misses'', ''defender hits'', ''defender misses'' and ''attack end''. For more information and other filter keys, see [[FilterWML]].<br /> :* '''name''': the name of the weapon used.<br /> :* '''range''': the range of the weapon used.<br /> :* '''special''': filter on the attack's special power.<br /> <br /> ==== [filter_second_attack] ====<br /> : Like [filter_attack], but for the secondary unit.<br /> :* '''name''': the name of the weapon used.<br /> :* '''range''': the range of the weapon used.<br /> :* '''special''': filter on the attack's special power.<br /> <br /> ==== [event] ====<br /> : A special case 'action', the [event] tag may be used to create a [[#Nested Events|nested event]].<br /> <br /> ==== delayed_variable_substitution ====<br /> : This key is only relevant inside of a [[#Delayed Variable Substitution|nested event]] and controls when variable substitution will occur in those special case actions.<br /> <br /> === Actions triggered by [event] ===<br /> <br /> After the trigger conditions have been met, all action tags within the [event] tag are executed in the order they are written in.<br /> <br /> There are 3 main types of actions:<br /> * direct actions ([[DirectActionsWML]]) which have a direct effect on gameplay<br /> * display actions ([[InterfaceActionsWML]]) which show something to the user<br /> * internal actions ([[InternalActionsWML]]) which are used by WML internally<br /> <br /> Several actions use standard filters to find out which units<br /> to execute the command on. These are denoted by the phrases<br /> &quot;standard unit filter&quot; and &quot;standard location filter&quot;.<br /> <br /> === Nested Events ===<br /> <br /> There is one special type of action: event creation. By placing an '''[event]''' tag inside another '''[event]''' tag, the nested event is spawned (created) when the parent (outer) event is encountered (when executing the contents of the parent event).<br /> <br /> ([[#Nested Event Example|See Examples]])<br /> <br /> ==== Delayed Variable Substitution ====<br /> <br /> Variable substitution for a nested event can happen either when it is spawned by the parent event or when it is triggered itself. This is controlled with the key '''delayed_variable_substitution''' which is used in the nested event.<br /> <br /> If this key is set to ''yes'', the variables in the nested event will contain values from the turn in which the ''nested'' event was triggered. ''This is the default behavior if the key is omitted.'' If set to ''no'', the variables in the nested event are set at the time the ''parent'' event is triggered.<br /> <br /> This behavior can be fine tuned with a special syntax when referencing variables. Instead of the normal '''$variable''' syntax, use '''$|variable''' to cause a variable to contain values relevant to the turn in which the nested event was triggered even when '''delayed_variable_substitution''' is set to ''no''. In this way you can have a mix of variables relevant to the parent and nested event trigger times.<br /> <br /> ([[#Delayed Variable Substitution Example|See Examples]])<br /> <br /> == Multiplayer safety ==<br /> <br /> In multiplayer it is only safe to use WML that might require synchronization with other players because of input or random numbers (like [message] with input or options or [unstore_unit] where a unit might advance) in the following events. This is because in these cases WML needs data from other players to work right and/or do the same thing for all players. This data is only available after a network synchronization.<br /> <br /> List of synchronized events:<br /> * moveto<br /> * sighted <br /> * attack<br /> * attack_end <br /> * attacker hits <br /> * attacker misses <br /> * defender hits<br /> * defender misses <br /> * stone<br /> * last breath <br /> * menu item X<br /> * die<br /> * capture <br /> * recruit<br /> * prerecruit <br /> * recall <br /> * prerecall <br /> * advance <br /> * post_advance <br /> getting message options (etc) from the following events is not synchronized, except in the development version (1.9+svn):<br /> * new turn <br /> * side turn <br /> * turn X <br /> * side X turn <br /> * side X turn Y <br /> * turn refresh <br /> <br /> There is also the possibility of events that are normally synchronized when fired by the engine but can be non-synchronized when fired by WML tags from non-synchronized event. So when you are using them you must be extra careful. For example [unstore_unit] may trigger a unit advancement that will fire ''advance'' and ''post advance'' events.<br /> <br /> == A Trap for the Unwary ==<br /> <br /> It is perfectly possible (and, in fact, useful) to have multiple events with the same predefined name and thus the same trigger condition. However, it is not defined what order such events will fire in, so you need to code so the order <br /> will not matter.<br /> <br /> Because of the above, you need to beware of using macros to generate events. If you include a macro expanding to an event definition twice, the event will be executed twice (not once) each time the trigger condition fires. Consider this code:<br /> <br /> #define DOUBLE<br /> [event]<br /> name=multiply_by_2<br /> {VARIABLE_OP 2_becomes_4 multiply 2}<br /> [/event]<br /> #enddef<br /> <br /> {DOUBLE}<br /> {DOUBLE}<br /> <br /> {VARIABLE 2_becomes_4 2}<br /> <br /> [fire_event]<br /> name=multiply_by_2<br /> [/fire_event]<br /> <br /> {DEBUG_MSG &quot;$2_becomes_4 should be 4&quot;}<br /> <br /> After it executes, the debug message will reveal that the variable has been set to 8, not 4.<br /> <br /> == Miscellaneous Notes and Examples ==<br /> <br /> === Primary/Secondary Unit Speaker Example ===<br /> <br /> In events, the primary unit can be referred to as '''unit''' and the secondary unit can be referred to as '''second_unit''' in [message] tags using the '''speaker''' key. For example:<br /> <br /> [event]<br /> name=die<br /> [message]<br /> speaker='''second_unit'''<br /> message= _ &quot;Hahaha! I finally killed you!&quot;<br /> [/message]<br /> <br /> [message]<br /> speaker='''unit'''<br /> message= _ &quot;It's not over yet! I'll come back to haunt you!&quot;<br /> [/message]<br /> [/event]<br /> <br /> === Nested Event Example ===<br /> <br /> An event is created for a portal that opens on turn 10. The parent (or 'outer') event executes on turn 10 at which point the nested moveto event is created. This nested event executes when a player steps on a certain spot.<br /> <br /> [event]<br /> name=turn 10<br /> <br /> [event]<br /> name=moveto<br /> <br /> [filter]<br /> x,y=5,8<br /> [/filter]<br /> <br /> # moving to 5,8 will trigger this event only on turn 10 and after<br /> [/event]<br /> [/event]<br /> <br /> An equivalent way of doing this would be to create a single moveto event with an '''[if]''' statement to check for turn number but using nested '''[event]''' tags is a convenient shortcut to accomplish this task without resorting to '''[if]''' statements.<br /> <br /> === Delayed Variable Substitution Example ===<br /> <br /> This code will display a message showing the turn number on which the nested ''moveto'' event happens.<br /> <br /> [event]<br /> name=turn 10<br /> <br /> [event]<br /> name=moveto<br /> delayed_variable_substitution=yes<br /> <br /> [filter]<br /> x,y=5,8<br /> [/filter]<br /> <br /> {DEBUG_MSG &quot;Turn $turn_number&quot;} <br /> [/event]<br /> [/event]<br /> <br /> Since this is the default behavior for the '''delayed_variable_substitution''' key, the following example is identical.<br /> <br /> [event]<br /> name=turn 10<br /> <br /> [event]<br /> name=moveto<br /> <br /> [filter]<br /> x,y=5,8<br /> [/filter]<br /> <br /> {DEBUG_MSG &quot;Turn $turn_number&quot;} <br /> [/event]<br /> [/event]<br /> <br /> The following code will always display &quot;Turn 10&quot; when the nested ''moveto'' event happens. This is because the variable substitution is done when the parent event is triggered and spawns the nested event, ''not'' when the nested event is triggered.<br /> <br /> [event]<br /> name=turn 10<br /> <br /> [event]<br /> name=moveto<br /> delayed_variable_substitution=no<br /> <br /> [filter]<br /> x,y=5,8<br /> [/filter]<br /> <br /> {DEBUG_MSG &quot;Turn $turn_number&quot;} <br /> [/event]<br /> [/event]<br /> <br /> Finally, the following example is identical to the first two in that it will display a message showing the turn number on which the nested ''moveto'' event happens, despite the fact that the '''delayed_variable_substitution''' key is set to ''no''. This is because the special '''$|variable''' syntax is used.<br /> <br /> [event]<br /> name=turn 10<br /> <br /> [event]<br /> name=moveto<br /> delayed_variable_substitution=no<br /> <br /> [filter]<br /> x,y=5,8<br /> [/filter]<br /> <br /> {DEBUG_MSG &quot;Turn $|turn_number&quot;} <br /> [/event]<br /> [/event]<br /> <br /> === Multiple Nested Events ===<br /> <br /> Every delayed_variable_substitution=no causes a variable substitution run on the subevent where it occurs at the spawn time of this event and on all following subevents. For any specific event, variable substitution happens at least one time when the event is executed. For each delayed=no key appearing in itself or in an event of an &quot;older&quot; generation, which is not the toplevel event, an additional variable substitution run is made.<br /> [event]# parent<br /> name=turn 2<br /> #delayed_variable_substitution=no # In the parent event, delayed= has no effect.<br /> <br /> [event]# child<br /> name=turn 3<br /> delayed_variable_substitution=no # Causes variable substitution in the child, grandchild and great-grandchild event<br /> # at execution time of the parent event = spawn time of the child event.<br /> <br /> [event]# grandchild<br /> name=turn 4<br /> delayed_variable_substitution=yes # no variable substitution in the grandchild and great-grandchild event<br /> # at execution time of the child event = spawn time of the grandchild event<br /> <br /> [event]# great-grandchild<br /> name=turn 5<br /> {DEBUG_MSG $turn_number}# output: 2 - value from the variable substitution at execution time of the parent event,<br /> # caused by delayed=no in the child event<br /> <br /> {DEBUG_MSG $||turn_number}# output: &quot;$turn_number&quot;<br /> # Each variable substitution transforms a &quot;$|&quot; to a &quot;$&quot; (except when no | left).<br /> <br /> {DEBUG_MSG $|turn_number}# output: 5 - from the variable substitution at execution time<br /> # of the great-grandchild event<br /> [/event]<br /> [/event]<br /> [/event]<br /> [/event]<br /> <br /> == See Also ==<br /> <br /> * [[DirectActionsWML]]<br /> * [[InternalActionsWML]]<br /> * [[InterfaceActionsWML]]<br /> * [[FilterWML]]<br /> * [[ReferenceWML]]<br /> <br /> <br /> [[Category: WML Reference]]</div>

Gambit https://wiki.wesnoth.org/index.php?title=EventWML&diff=38055 2010-08-26T21:04:10Z

<p>Gambit: /* Predefined 'name' Key Values */ added information on the new turn end events</p> <hr /> <div>{{WML Tags}}<br /> == The [event] Tag ==<br /> <br /> This tag is a subtag of the [scenario], [unit_type] and [era] tags which is used to describe a set of actions which trigger at a certain point in a scenario. When used in a [scenario] tag (also includes [multiplayer], [tutorial] and [test]), the event only occurs in that scenario. When used in a [unit_type] tag, the event will occur in all scenarios in which a unit of that type appears in (only after such a unit appears during the scenario, however). When used in an [era], the event will occur in any scenario which is played using that era.<br /> <br /> This tag has keys and child tags that control when and if the event actions will be triggered. Most important of these is the '''name''' key. Without it, no error will be raised but the event will never fire. Therefore, from a practical standpoint, it can be considered mandatory. All of the others can be used or not and the event actions will fire either way.<br /> <br /> '''Lexicon side note:''' ''The word &quot;event&quot; in the [event] tag itself may be considered an abbreviation of the word &quot;event handler&quot; because it is technically not a game &quot;event&quot; but an event '''handler''' for the game events fired with the given 'name'. However, this distinction is usually unimportant in most discussions and the event handlers are therefore simply referred to as &quot;events&quot; in this documentation.''<br /> <br /> === The 'name' Key (Mandatory) ===<br /> <br /> Usage:<br /> name=&lt;value&gt;<br /> <br /> This key defines which game event or trigger your [event] tag will be handling. This 'name' key should not be confused with a descriptive comment; it is rather a precise value which must match the predefined game event's name to be valid.<br /> <br /> '''Lexicon side note:''' ''It is not uncommon to refer to these values as the 'trigger' for an event and, furthermore, to call an event by its 'trigger' name. For example, in an event containing '''name=moveto''', a person might refer to the event as a ''''moveto''' event' and/or refer to the ''''moveto''' trigger' in the event or even talk about the 'event trigger' when referring to the '''moveto''' value of the 'name' key in that event. Some or all of this usage can, in fact, be found throughout this page.''<br /> <br /> The '''name''' key can accept a list of comma separated values describing when the event will be triggered.* These values may be either predefined event types or custom event names not matching any predefined type.<br /> <br /> For example:<br /> <br /> name=attacker misses,defender misses<br /> <br /> ''* Note that unless you use [[#first_time_only|first_time_only=no]], the event will fire only once, '''not''' once for each listed type.''<br /> <br /> ==== Predefined 'name' Key Values ====<br /> <br /> All predefined event types are listed here along with a description of when this value will cause the event to be triggered. Any value ''not'' listed here is a custom event name which can be triggered only by a '''[fire_event]''' tag somewhere else. Spaces in event names can be interchanged with underscores (for example, '''name=new turn''' and '''name=new_turn''' are equivalent).<br /> <br /> ; preload<br /> : Triggers before a scenario 'prestarts' and when loading a savegame -- before anything is shown on the screen at all. Can be used to set up the [[LuaWML|Lua]] environment: loading libraries, defining helper functions, etc.<br /> : '''Note:''' Unlike prestart and start, the preload event '''must be able to fire more than once!''' This is because it is triggered each time a savegame is loaded in addition to the initial time when it loads before the scenario 'prestart'. This means that it is effectively ''mandatory'' to have the [[#first_time_only|first_time_only=no]] key value in a preload event. <br /> <br /> ; prestart<br /> : Triggers before a scenario 'starts' -- before anything is shown on the screen at all. Can be used to set up things like village ownership. For things displayed on-screen such as character dialog, use '''start''' instead.<br /> : '''Note:''' ''This value makes the [[#first_time_only|first_time_only]] key irrelevant since, by definition, it can only fire once.''<br /> <br /> ; start<br /> : Triggers after the map is shown but before the scenario begins -- before players can 'do' anything.<br /> : '''Note:''' ''This value makes the [[#first_time_only|first_time_only]] key irrelevant since, by definition, it can only fire once.''<br /> <br /> ; new turn<br /> : Triggers at the start of every turn (not side turn). See also [[#first_time_only|first_time_only=no]]. Before any events of this type trigger, the value of the WML variable '''turn_number''' is set to the number of the turn that is beginning.<br /> <br /> ; turn end {{DevFeature1.9}}<br /> : Triggers at the end of every turn (not side turn). See also [[#first_time_only|first_time_only=no]]. The WML variable '''side_number''' will contain the side that ended their turn.<br /> <br /> ; side turn<br /> : Triggers when a side is about to start its turn. Before events of this type trigger, the value of the WML variable '''side_number''' is set to the number of the side of the player about to take their turn. This is before any healing takes place for that side, before calculating income, and before restoring unit movement and status.<br /> <br /> ; ai turn<br /> : Triggered just before the AI is invoked for a side. This is called after ''side turn'', and thus the WML variable '''side_number''' still holds the number of this side. Note that this event might be called several times per turn in case that fallbacks to human or droiding is involved. I.e. it happens at the middle of turn of human side 1 if the human player droids his side. It happens after the selection of ai to play the turn but before AI is told that new turn has come.<br /> : '''Note:''' ''This event currently breaks replays since it is not explicitly saved in a replay and there is no AI involved in replays...''<br /> <br /> ; turn refresh<br /> : Like '''side turn''', triggers just before a side is taking control but '''after''' healing, calculating income, and restoring unit movement and status.<br /> <br /> ; turn ''X''<br /> : Triggers at the start of turn ''X''. It's the first side initialization event. <br /> <br /> ; turn ''X'' end {{DevFeature1.9}}<br /> : Triggers at the end of turn ''X''. It's the first event in the group of end turn events. <br /> <br /> :Side initialization events go in the order of: <br /> : 1) '''turn ''X''''' <br /> :2) '''new turn''' <br /> :3) '''side turn''' <br /> :4) '''side ''X'' turn''' <br /> :5) '''side turn ''X''''' <br /> :6) '''side ''X'' turn ''Y''''' <br /> :7) '''turn refresh''' <br /> :8) '''side ''X'' turn refresh''' <br /> :9) '''turn ''X'' refresh''' <br /> :10) '''side ''X'' turn ''Y'' refresh'''<br /> <br /> ; side ''X'' turn ''Y''<br /> : This event triggers at the start of turn ''Y'' of side X {{DevFeature}}<br /> <br /> ; side ''X'' turn<br /> : This event triggers at the start of any turn of side X {{DevFeature}}<br /> : '''Note:''' ''Of course, [[#first_time_only|first_time_only=no]] is needed for this event to be triggered more than once.''<br /> <br /> ; side turn ''X''<br /> : This event triggers at the start of any side on turn X {{DevFeature1.9}}<br /> : '''Note:''' ''Of course, [[#first_time_only|first_time_only=no]] is needed for this event to be triggered more than once.''<br /> <br /> ; side X turn Y refresh<br /> : This event triggers at the turn refresh for side X on turn Y {{DevFeature1.9}}<br /> <br /> ; side ''X'' turn refresh<br /> : This event triggers at the turn refresh for side X {{DevFeature1.9}}<br /> : '''Note:''' ''Of course, [[#first_time_only|first_time_only=no]] is needed for this event to be triggered more than once.''<br /> <br /> ; turn ''X'' refresh<br /> : This event triggers for any side at the refresh of turn X. {{DevFeature1.9}}<br /> : '''Note:''' ''Of course, [[#first_time_only|first_time_only=no]] is needed for this event to be triggered more than once.''<br /> <br /> ; side turn end {{DevFeature1.9}}<br /> : Triggers after a side ends its turn. Like side turn, there are also some variations for specific combinations of side number and turn number. Here is the order in which the turn end events trigger:<br /> :1) '''turn end''' <br /> :2) '''turn ''X'' end''' <br /> :3) '''side turn end''' <br /> :4) '''side ''X'' turn end''' <br /> :5) '''side turn ''X'' end''' <br /> :6) '''side ''X'' turn ''Y'' end''' <br /> <br /> ; time over<br /> : Triggers on turn ''turns''. (''turns'' is specified in [scenario])<br /> <br /> ; enemies defeated<br /> : Triggers when all units with '''canrecruit=yes''' (that is, all leaders) not allied with side 1 are killed.<br /> <br /> ; victory<br /> : In this scenario, any tag of the form '''[endlevel] result=victory [/endlevel]''' will be automatically preceded by all actions in this tag. It helps debugging if the victory event allows you to safely advance to any of the possible next maps after using the &quot;:n&quot; command. Scenarios where key units are picked up before the victory, or where some action chosen earlier determines which map to advance to, make it hard to quickly test scenarios in a campaign. (See also: [endlevel], [[DirectActionsWML]])<br /> <br /> ; defeat<br /> : In this scenario, any tag of the form '''[endlevel] result=defeat [/endlevel]''' will be automatically preceded by all actions in this tag. (See also [endlevel], [[DirectActionsWML]])<br /> <br /> <br /> Filters can be applied to the following event triggers (see [[FilterWML]]; see also below). The actions specified in the event tag will be executed only if the filter returns true. <br /> These event triggers are all actions by units ('''moveto''', '''attack''') or things that happen to units ('''recruit''', '''advance'''). When one of these events is triggered, the position of the active unit (referred to as the '''primary unit''') is stored in the variables '''x1''' and '''y1''' and the position of any unit that primary unit does something to is stored in the variables '''x2''' and '''y2''' (this unit is referred to as the '''secondary unit''' below). '' These units are also automatically stored in the variables 'unit' and 'second_unit' as if they had been stored using the '''[store_unit]''' tag. see [[SingleUnitWML]]<br /> <br /> ; moveto<br /> : Triggers after the primary unit moves. Typically this is used when the primary unit gets to a particular location and a filter for the location of the primary unit is included; remember that this is the location that the primary unit lands on, not the location it started on or any location it travels on.&lt;br /&gt;''An '''[allow_undo]''' tag anywhere within a moveto event will cancel any lack of undo functionality the event would have caused. Note that undo functionality will only move the unit back to its former location; it will not undo other changes to the game caused by the event. Thus it is up to the scenario designer to use this tag correctly.'' {{DevFeature}} $x2 and $y2 refer to the hex the unit came from.<br /> <br /> ; sighted<br /> : Triggers when the primary unit becomes visible to the secondary unit in particular after not being visible to the secondary unit's side (so if the secondary unit's side doesn't have shroud or fog, the event never triggers). This happens both when the primary unit moves into view during its turn, and when the secondary unit moves to a location where it can see the primary unit. (This editor hasn't tested whether the event triggers multiple times if the primary unit moves into view of multiple units at once, or if not, which one gets chosen to be the secondary unit here.) (Note: it appears that when a sighted event is triggered because an enemy unit moves into your field of view, the game engine cannot determine which unit (on your side) sees the unit that moved, and so it fires a ''name=sighted'' event without setting ''$second_unit''. This means that, for example, using ''speaker=second_unit'' inside a message tag may fail.) (Double note: it also appears that the sighted event in more recent versions of the game (1.6 and 1.7, maybe?) does not fire on enemy turns. That is, it only fires for units that become visible as a result of the motion of another unit, not for units that move into the vision of an enemy. This event is also buggy in general... it's usually better to use a moveto event with a [filter_vision] tag than to use a sighted event (and note that the combination of the two can achieve something like the old sighted event)).<br /> <br /> ; attack<br /> : Triggers when the primary unit attacks the secondary unit.<br /> <br /> ; attack end<br /> : Similar to '''attack''', but is triggered ''after'' the fight instead of before. Note that if either unit is killed during the fight, this event triggers before any '''die''' events.<br /> <br /> ; attacker hits<br /> : Triggers when the the primary unit (the attacker) hits the secondary unit (the defender). The value of the WML variable '''damage_inflicted''' is set to the number of hitpoints inflicted by the attacker.<br /> <br /> ; attacker misses<br /> : Same as ''attacker hits'', but is triggered when the attacker misses.<br /> <br /> ; defender hits<br /> : Triggers when the primary unit (the attacker) is hit in retaliation by the secondary unit (the defender). The value of the WML variable '''damage_inflicted''' is set to the number of hitpoints inflicted by the defender.<br /> <br /> ; defender misses<br /> : Same as ''defender hits'', but is triggered when the defender misses.<br /> <br /> ; stone<br /> : Triggers when the primary unit is hit by an attack with the 'stones' ability (See ''stones'', [[AbilitiesWML]]) by the secondary unit (the unit with the 'stones' ability). In {{DevFeature}}, this event name is changed to &quot;petrified&quot;.<br /> <br /> ; last breath<br /> : Triggers when the primary unit is killed by the secondary unit, but before the death animation is triggered. Use this instead of name=die when you want the primary unit to make a final [message]. <br /> <br /> ; die<br /> : Triggers when the primary unit is killed by the secondary unit. ''Note: The primary unit is not removed from the game until the end of this event. The primary unit can still be manipulated, will block other units from taking its hex, and will still be found by standard unit filters (except [have_unit]). To prevent this behavior, you can use [kill] to remove the unit immediately. However, this will stop any (still unfired) other events that also match the unit from firing afterwards, so use with caution.'' If you want to the primary unit to make a final [message], use name=last_breath, see above.<br /> <br /> ; capture<br /> : Triggers when the primary unit captures a village. The village may have been previously neutral, or previously owned by another side; merely moving into your own villages does not constitute a capture.<br /> <br /> ; recruit<br /> : Triggers when the primary unit is recruited. (That is, when a unit is recruited it will trigger this event and this event's filter will filter that unit.).<br /> <br /> ; prerecruit<br /> : Triggers when the primary unit is recruited but before it is displayed.<br /> <br /> ; recall<br /> : Triggers after a unit is recalled.<br /> <br /> ; prerecall<br /> : Triggers when a unit is recalled but before it is displayed.<br /> <br /> ; advance<br /> : Triggers just before the primary unit is going to advance to another unit.<br /> <br /> ; post advance<br /> : Triggers just after the primary unit has advanced to another unit.<br /> <br /> ; select<br /> : Triggers when the primary unit is selected. Also triggers when ending a move, as the game keeps the moving unit selected by selecting it again at the end of movement. ''Note: in networked multiplayer, these events are only executed by the client on which the event is triggered, leading to out of sync errors if you modify the game state in the event.''<br /> <br /> ; menu item ''X''<br /> : Triggers when a WML menu item with id=''X'' is selected. ''Note: if the menu item has a [command], this event may be executed before or after the command; there is no guarantee.''<br /> <br /> ==== Custom events ====<br /> <br /> An event with a custom name may be invoked using the [[InternalActionsWML#.5Bfire_event.5D|[fire_event]]] tag. Normally you'll use such custom events as named subroutines to be called by events with predefined types. One common case of this, for example, is that more than one '''sighted''' events might fire the same custom event that changes the scenario objectives.<br /> <br /> === Optional Keys and Tags ===<br /> <br /> These keys and tags are more complex ways to filter when an event should trigger:<br /> <br /> ==== first_time_only ====<br /> : Whether the event should be removed from the scenario after it is triggered. This key takes a [[ConditionalActionsWML#Boolean_Values|boolean]]; for example:<br /> : ''first_time_only=yes''<br /> :: Default behavior if key is omitted. The event will trigger the first time it can and never again.<br /> : ''first_time_only=no''<br /> :: The event will trigger every time the criteria are met instead of only the first time.<br /> <br /> ==== [filter] ====<br /> : The event will only trigger if the primary unit matches this filter.<br /> :* [[StandardUnitFilter]]: selection criteria<br /> <br /> ==== [filter_second] ====<br /> : Like [filter], but for the secondary unit.<br /> :* [[StandardUnitFilter]]: selection criteria<br /> <br /> ==== [filter_attack] ====<br /> : Can be used to set additional filtering criteria for the primary unit and the secondary unit that are not generally available in a standard unit filter. Can be used in events ''attack'', ''attacker hits'', ''attacker misses'', ''defender hits'', ''defender misses'' and ''attack end''. For more information and other filter keys, see [[FilterWML]].<br /> :* '''name''': the name of the weapon used.<br /> :* '''range''': the range of the weapon used.<br /> :* '''special''': filter on the attack's special power.<br /> <br /> ==== [filter_second_attack] ====<br /> : Like [filter_attack], but for the secondary unit.<br /> :* '''name''': the name of the weapon used.<br /> :* '''range''': the range of the weapon used.<br /> :* '''special''': filter on the attack's special power.<br /> <br /> ==== [event] ====<br /> : A special case 'action', the [event] tag may be used to create a [[#Nested Events|nested event]].<br /> <br /> ==== delayed_variable_substitution ====<br /> : This key is only relevant inside of a [[#Delayed Variable Substitution|nested event]] and controls when variable substitution will occur in those special case actions.<br /> <br /> === Actions triggered by [event] ===<br /> <br /> After the trigger conditions have been met, all action tags within the [event] tag are executed in the order they are written in.<br /> <br /> There are 3 main types of actions:<br /> * direct actions ([[DirectActionsWML]]) which have a direct effect on gameplay<br /> * display actions ([[InterfaceActionsWML]]) which show something to the user<br /> * internal actions ([[InternalActionsWML]]) which are used by WML internally<br /> <br /> Several actions use standard filters to find out which units<br /> to execute the command on. These are denoted by the phrases<br /> &quot;standard unit filter&quot; and &quot;standard location filter&quot;.<br /> <br /> === Nested Events ===<br /> <br /> There is one special type of action: event creation. By placing an '''[event]''' tag inside another '''[event]''' tag, the nested event is spawned (created) when the parent (outer) event is encountered (when executing the contents of the parent event).<br /> <br /> ([[#Nested Event Example|See Examples]])<br /> <br /> ==== Delayed Variable Substitution ====<br /> <br /> Variable substitution for a nested event can happen either when it is spawned by the parent event or when it is triggered itself. This is controlled with the key '''delayed_variable_substitution''' which is used in the nested event.<br /> <br /> If this key is set to ''yes'', the variables in the nested event will contain values from the turn in which the ''nested'' event was triggered. ''This is the default behavior if the key is omitted.'' If set to ''no'', the variables in the nested event are set at the time the ''parent'' event is triggered.<br /> <br /> This behavior can be fine tuned with a special syntax when referencing variables. Instead of the normal '''$variable''' syntax, use '''$|variable''' to cause a variable to contain values relevant to the turn in which the nested event was triggered even when '''delayed_variable_substitution''' is set to ''no''. In this way you can have a mix of variables relevant to the parent and nested event trigger times.<br /> <br /> ([[#Delayed Variable Substitution Example|See Examples]])<br /> <br /> == Multiplayer safety ==<br /> <br /> In multiplayer it is only safe to use WML that might require synchronization with other players because of input or random numbers (like [message] with input or options or [unstore_unit] where a unit might advance) in the following events. This is because in these cases WML needs data from other players to work right and/or do the same thing for all players. This data is only available after a network synchronization.<br /> <br /> List of synchronized events:<br /> * moveto<br /> * sighted <br /> * attack<br /> * attack_end <br /> * attacker hits <br /> * attacker misses <br /> * defender hits<br /> * defender misses <br /> * stone<br /> * last breath <br /> * menu item X<br /> * die<br /> * capture <br /> * recruit<br /> * prerecruit <br /> * recall <br /> * prerecall <br /> * advance <br /> * post_advance <br /> getting message options (etc) from the following events is not synchronized, except in the development version (1.9+svn):<br /> * new turn <br /> * side turn <br /> * turn X <br /> * side X turn <br /> * side X turn Y <br /> * turn refresh <br /> <br /> There is also the possibility of events that are normally synchronized when fired by the engine but can be non-synchronized when fired by WML tags from non-synchronized event. So when you are using them you must be extra careful. For example [unstore_unit] may trigger a unit advancement that will fire ''advance'' and ''post advance'' events.<br /> <br /> == A Trap for the Unwary ==<br /> <br /> It is perfectly possible (and, in fact, useful) to have multiple events with the same predefined name and thus the same trigger condition. However, it is not defined what order such events will fire in, so you need to code so the order <br /> will not matter.<br /> <br /> Because of the above, you need to beware of using macros to generate events. If you include a macro expanding to an event definition twice, the event will be executed twice (not once) each time the trigger condition fires. Consider this code:<br /> <br /> #define DOUBLE<br /> [event]<br /> name=multiply_by_2<br /> {VARIABLE_OP 2_becomes_4 multiply 2}<br /> [/event]<br /> #enddef<br /> <br /> {DOUBLE}<br /> {DOUBLE}<br /> <br /> {VARIABLE 2_becomes_4 2}<br /> <br /> [fire_event]<br /> name=multiply_by_2<br /> [/fire_event]<br /> <br /> {DEBUG_MSG &quot;$2_becomes_4 should be 4&quot;}<br /> <br /> After it executes, the debug message will reveal that the variable has been set to 8, not 4.<br /> <br /> == Miscellaneous Notes and Examples ==<br /> <br /> === Primary/Secondary Unit Speaker Example ===<br /> <br /> In events, the primary unit can be referred to as '''unit''' and the secondary unit can be referred to as '''second_unit''' in [message] tags using the '''speaker''' key. For example:<br /> <br /> [event]<br /> name=die<br /> [message]<br /> speaker='''second_unit'''<br /> message= _ &quot;Hahaha! I finally killed you!&quot;<br /> [/message]<br /> <br /> [message]<br /> speaker='''unit'''<br /> message= _ &quot;It's not over yet! I'll come back to haunt you!&quot;<br /> [/message]<br /> [/event]<br /> <br /> === Nested Event Example ===<br /> <br /> An event is created for a portal that opens on turn 10. The parent (or 'outer') event executes on turn 10 at which point the nested moveto event is created. This nested event executes when a player steps on a certain spot.<br /> <br /> [event]<br /> name=turn 10<br /> <br /> [event]<br /> name=moveto<br /> <br /> [filter]<br /> x,y=5,8<br /> [/filter]<br /> <br /> # moving to 5,8 will trigger this event only on turn 10 and after<br /> [/event]<br /> [/event]<br /> <br /> An equivalent way of doing this would be to create a single moveto event with an '''[if]''' statement to check for turn number but using nested '''[event]''' tags is a convenient shortcut to accomplish this task without resorting to '''[if]''' statements.<br /> <br /> === Delayed Variable Substitution Example ===<br /> <br /> This code will display a message showing the turn number on which the nested ''moveto'' event happens.<br /> <br /> [event]<br /> name=turn 10<br /> <br /> [event]<br /> name=moveto<br /> delayed_variable_substitution=yes<br /> <br /> [filter]<br /> x,y=5,8<br /> [/filter]<br /> <br /> {DEBUG_MSG &quot;Turn $turn_number&quot;} <br /> [/event]<br /> [/event]<br /> <br /> Since this is the default behavior for the '''delayed_variable_substitution''' key, the following example is identical.<br /> <br /> [event]<br /> name=turn 10<br /> <br /> [event]<br /> name=moveto<br /> <br /> [filter]<br /> x,y=5,8<br /> [/filter]<br /> <br /> {DEBUG_MSG &quot;Turn $turn_number&quot;} <br /> [/event]<br /> [/event]<br /> <br /> The following code will always display &quot;Turn 10&quot; when the nested ''moveto'' event happens. This is because the variable substitution is done when the parent event is triggered and spawns the nested event, ''not'' when the nested event is triggered.<br /> <br /> [event]<br /> name=turn 10<br /> <br /> [event]<br /> name=moveto<br /> delayed_variable_substitution=no<br /> <br /> [filter]<br /> x,y=5,8<br /> [/filter]<br /> <br /> {DEBUG_MSG &quot;Turn $turn_number&quot;} <br /> [/event]<br /> [/event]<br /> <br /> Finally, the following example is identical to the first two in that it will display a message showing the turn number on which the nested ''moveto'' event happens, despite the fact that the '''delayed_variable_substitution''' key is set to ''no''. This is because the special '''$|variable''' syntax is used.<br /> <br /> [event]<br /> name=turn 10<br /> <br /> [event]<br /> name=moveto<br /> delayed_variable_substitution=no<br /> <br /> [filter]<br /> x,y=5,8<br /> [/filter]<br /> <br /> {DEBUG_MSG &quot;Turn $|turn_number&quot;} <br /> [/event]<br /> [/event]<br /> <br /> === Multiple Nested Events ===<br /> <br /> Every delayed_variable_substitution=no causes a variable substitution run on the subevent where it occurs at the spawn time of this event and on all following subevents. For any specific event, variable substitution happens at least one time when the event is executed. For each delayed=no key appearing in itself or in an event of an &quot;older&quot; generation, which is not the toplevel event, an additional variable substitution run is made.<br /> [event]# parent<br /> name=turn 2<br /> #delayed_variable_substitution=no # In the parent event, delayed= has no effect.<br /> <br /> [event]# child<br /> name=turn 3<br /> delayed_variable_substitution=no # Causes variable substitution in the child, grandchild and great-grandchild event<br /> # at execution time of the parent event = spawn time of the child event.<br /> <br /> [event]# grandchild<br /> name=turn 4<br /> delayed_variable_substitution=yes # no variable substitution in the grandchild and great-grandchild event<br /> # at execution time of the child event = spawn time of the grandchild event<br /> <br /> [event]# great-grandchild<br /> name=turn 5<br /> {DEBUG_MSG $turn_number}# output: 2 - value from the variable substitution at execution time of the parent event,<br /> # caused by delayed=no in the child event<br /> <br /> {DEBUG_MSG $||turn_number}# output: &quot;$turn_number&quot;<br /> # Each variable substitution transforms a &quot;$|&quot; to a &quot;$&quot; (except when no | left).<br /> <br /> {DEBUG_MSG $|turn_number}# output: 5 - from the variable substitution at execution time<br /> # of the great-grandchild event<br /> [/event]<br /> [/event]<br /> [/event]<br /> [/event]<br /> <br /> == See Also ==<br /> <br /> * [[DirectActionsWML]]<br /> * [[InternalActionsWML]]<br /> * [[InterfaceActionsWML]]<br /> * [[FilterWML]]<br /> * [[ReferenceWML]]<br /> <br /> <br /> [[Category: WML Reference]]</div>

Gambit https://wiki.wesnoth.org/index.php?title=Template:WML_Tags&diff=38054 2010-08-26T02:34:43Z

<p>Gambit: adding the [chat] tag to the list</p> <hr /> <div>{| class=&quot;gallery&quot; style=&quot;width:225px;float: right;border: 1px solid #B48648; color:#B48648; font-size: 7pt;margin-left;10px;&quot;<br /> |-<br /> |<br /> &lt;span style=&quot;float: right;&quot;&gt;&lt;small class=&quot;editlink noprint plainlinksneverexpand&quot;&gt;[{{SERVER}}{{localurl:Template:WML Tags|action=edit}} edit ]&lt;/small&gt;&lt;/span&gt;<br /> '''WML Tags'''<br /> <br /> |-<br /> |''A:'' <br /> [[AbilitiesWML|abilities]],<br /> [[CampaignWML|about]],<br /> [[AdvancedPreferenceWML|advanced_preference]],<br /> [[UnitTypeWML|advancefrom]],<br /> [[UnitTypeWML|advancement]],<br /> [[StatisticalScenarioWML|advances]],<br /> [[AiWML|ai]],<br /> [[DirectActionsWML#.5Ballow_recruit.5D|allow_recruit]],<br /> [[DirectActionsWML#.5Ballow_undo.5D|allow_undo]],<br /> [[ConditionalActionsWML#Meta_Condition_Tags|and]],<br /> [[InterfaceActionsWML|animate_unit]],<br /> [[AnimationWML|animation]],<br /> [[VariablesWML|array]],<br /> [[UnitTypeWML|attack]],<br /> [[AnimationWML|attack_filter]], <br /> [[StatisticalScenarioWML|attacks]],<br /> [[AiWML|avoid]];<br /> |-<br /> |''B:'' <br /> [[UnitTypeWML|base_unit]], [[BinaryPathWML|binary_path]], [[HelpWML|bold]], [[EditorWML|brush]];<br /> |-<br /> |''C:'' <br /> [[CampaignWML#The_.5Bcampaign.5D_tag|campaign]],<br /> [[DirectActionsWML#.5Bcapture_village.5D|capture_village]],<br /> [[ConditionalActionsWML#.5Bswitch.5D|case]],<br /> [[InterfaceActionsWML|chat]],<br /> [[ReplayWML|choose]],<br /> [[PersistenceWML|clear_global_variable]],<br /> [[InternalActionsWML|clear_variable]],<br /> [[InterfaceActionsWML|colour_adjust]],<br /> command([[InterfaceActionsWML|action]], [[ReplayWML|replay]]);<br /> |-<br /> |''D:'' <br /> [[AbilitiesWML|damage]],<br /> [[StatisticalScenarioWML|deaths]],<br /> [[InterfaceActionsWML|debug_message]],<br /> [[AnimationWML|defend]],<br /> [[StatisticalScenarioWML|defends]],<br /> [[UnitTypeWML|defense]],<br /> [[InterfaceActionsWML|delay]],<br /> [[ReplayWML|destination]],<br /> [[DirectActionsWML#.5Bdisallow_recruit.5D|disallow_recruit]],<br /> [[ConditionalActionsWML#.5Bwhile.5D|do]];<br /> |-<br /> |''E:'' <br /> [[EditorWML|editor_group]],<br /> [[EditorWML|editor_music]], <br /> [[EditorWML|editor_times]],<br /> [[EditorWML|editor_tool_hint]],<br /> [[EffectWML|effect]],<br /> [[ConditionalActionsWML#Conditional_Actions|else]],<br /> [[DirectActionsWML#.5Bendlevel.5D|endlevel]],<br /> end_turn&amp;nbsp;([[DirectActionsWML#.5Bend_turn.5D|action]], [[ReplayWML|replay]]),<br /> [[EraWML|era]],<br /> [[EventWML|event]],<br /> [[ThemeWML|expenses]];<br /> |-<br /> |''F:'' <br /> [[EventWML#.5Bfilter.5D|filter]],<br /> [[FilterWML|filter]],<br /> [[AnimationWML|filter_attack]],<br /> [[EventWML#.5Bfilter_attack.5D|filter_attack]],<br /> [[FilterWML|filter_location]],<br /> [[EventWML#.5Bfilter_second.5D|filter_second]],<br /> [[FilterWML|filter_second]],<br /> [[AnimationWML|filter_second_attack]],<br /> [[EventWML#.5Bfilter_second_attack.5D|filter_second_attack]],<br /> [[FilterWML|filter_vision]],<br /> [[StandardUnitFilter|filter_wml]],<br /> [[InternalActionsWML|fire_event]],<br /> [[HelpWML|format]],<br /> [[AnimationWML|frame]];<br /> |-<br /> |''G:'' <br /> [[GameConfigWML|game_config]],<br /> [[ScenarioWML|generator]],<br /> [[PersistenceWML|get_global_variable]],<br /> [[DirectActionsWML|gold]],<br /> [[ThemeWML|gold]];<br /> |-<br /> |''H:'' <br /> [[ConditionalActionsWML#Condition_Tags|have_location]],<br /> [[ConditionalActionsWML#Condition_Tags|have_unit]],<br /> [[HelpWML|header]],<br /> [[DirectActionsWML#.5Bheal_unit.5D|heal_unit]],<br /> [[UnitsWML|hide_help]],<br /> [[InterfaceActionsWML|hide_unit]];<br /> |-<br /> |''I:'' <br /> [[ConditionalActionsWML#.5Bif.5D|if]],<br /> [[TimeWML|illuminated_time]],<br /> [[TerrainGraphicsWML|image]],<br /> [[HelpWML|img]],<br /> [[ThemeWML|income]],<br /> [[ReplayWML|init_side]],<br /> [[InternalActionsWML|insert_tag]],<br /> [[InterfaceActionsWML#.5Binspect.5D|inspect]],<br /> [[HelpWML|italic]],<br /> [[InterfaceActionsWML|item]];<br /> |-<br /> |''J:''<br /> [[HelpWML|jump]],<br /> [[InternalActionsWML|join]];<br /> |-<br /> |''K:'' <br /> [[DirectActionsWML#.5Bkill.5D|kill]],<br /> [[StatisticalScenarioWML|killed]];<br /> |-<br /> |''L:'' <br /> label&amp;nbsp;([[InterfaceActionsWML|map]], [[ThemeWML|theme]]),<br /> [[LanguageWML|language]],<br /> [[AiWML|leader_goal]],<br /> [[LuaWML|lua]];<br /> |-<br /> |''M:'' <br /> [[ThemeWML|main_map]],<br /> [[ThemeWML|menu]],<br /> [[InterfaceActionsWML|message]],<br /> [[ThemeWML|mini_map]],<br /> [[AnimationWML|missile_frame]],<br /> [[SingleUnitWML|modifications]],<br /> [[DirectActionsWML#.5Bmodify_side.5D|modify_side]],<br /> [[DirectActionsWML#.5Bmodify_turns.5D|modify_turns]],<br /> [[ReplayWML|move]],<br /> [[DirectActionsWML#.5Bmove_unit.5D|move_unit]],<br /> [[InterfaceActionsWML|move_unit_fake]],<br /> [[UnitTypeWML|movement costs]],<br /> [[UnitsWML|movetype]],<br /> [[ScenarioWML|multiplayer]],<br /> [[EraWML|multiplayer_side]],<br /> [[InterfaceActionsWML|music]];<br /> |-<br /> |''N:'' <br /> [[ConditionalActionsWML#Meta_Condition_Tags|not]],<br /> [[FilterWML|not]],<br /> [[ThemeWML|num_units]];<br /> |-<br /> |''O:'' <br /> [[DirectActionsWML#.5Bobject.5D|object]],<br /> [[InterfaceActionsWML|objectives]],<br /> [[InterfaceActionsWML|objective]],<br /> [[ThemeWML|observers]],<br /> [[InterfaceActionsWML|open_help]],<br /> [[InterfaceActionsWML|option]],<br /> [[ConditionalActionsWML#Meta_Condition_Tags|or]];<br /> |-<br /> |''P:'' <br /> [[ThemeWML|panel]], [[IntroWML|part]], [[DirectActionsWML#.5Bpetrify.5D|petrify]], [[DirectActionsWML#.5Bplace_shroud.5D|place_shroud]], [[ThemeWML|position]],<br /> [[InterfaceActionsWML|print]], [[AiWML|protect_location]], [[AiWML|protect_unit]];<br /> |-<br /> |''R:'' <br /> [[UnitsWML|race]], [[ReplayWML|random]], recall&amp;nbsp;([[DirectActionsWML#.5Brecall.5D|action]], <br /> [[ReplayWML|replay]]), [[StatisticalScenarioWML|recalls]],<br /> [[ReplayWML|recruit]], [[StatisticalScenarioWML|recruits]], [[InterfaceActionsWML|redraw]],<br /> [[HelpWML|ref]], [[DirectActionsWML|remove_shroud]], [[InterfaceActionsWML|remove_unit_overlay]],<br /> [[InterfaceActionsWML|removeitem]], [[InterfaceActionsWML|remove_sound_source]], <br /> [[DirectActionsWML#.5Breplace_map.5D|replace_map]], [[DirectActionsWML#.5Breplace_schedule.5D|replace_schedule]], [[SavefileWML|replay]], [[SavefileWML|replay_start]],<br /> [[UnitTypeWML|resistance]], [[ThemeWML|resolution]], [[ReplayWML|results]], [[InternalActionsWML|role]];<br /> |-<br /> |''S:'' <br /> [[SavefileWML|save]], [[ScenarioWML|scenario]],<br /> [[InterfaceActionsWML|scroll]], [[InterfaceActionsWML|scroll_to]],<br /> [[InterfaceActionsWML|scroll_to_unit]], [[AnimationWML|secondary_attack_filter]], [[AnimationWML|secondary_unit_filter]], [[HelpWML|section]], [[PersistenceWML|set_global_variable]],<br /> [[InterfaceActionsWML#.5Bset_menu_item.5D_.28SVN_trunk_only.29|set_menu_item]], [[DirectActionsWML#.5Bset_recruit.5D|set_recruit]],<br /> [[InternalActionsWML|set_variable]], [[InternalActionsWML|set_variables]], [[InterfaceActionsWML|show_objectives]],<br /> [[SideWML|side]], [[ThemeWML|side_playing]], [[SavefileWML|snapshot]],<br /> [[InterfaceActionsWML|sound]], [[InterfaceActionsWML|sound_source]], [[ReplayWML|source]], [[EventWML|special_filter]], [[EventWML|special_filter_second]],<br /> [[InternalActionsWML|split]],<br /> [[StatisticalScenarioWML#The_.5Bstatistics.5D_tag|statistics]],<br /> status([[SingleUnitWML|single unit]], [[ThemeWML|theme]]), [[InternalActionsWML|store_gold]], [[InternalActionsWML|store_locations]],<br /> [[InternalActionsWML|store_map_dimensions]],<br /> [[InternalActionsWML|store_side]], [[InternalActionsWML|store_starting_location]], [[InternalActionsWML|store_time_of_day]], [[InternalActionsWML|store_unit]], [[InternalActionsWML|store_villages]] [[IntroWML|story]],<br /> [[ConditionalActionsWML#.5Bswitch.5D|switch]];<br /> |-<br /> |''T:'' <br /> [[AiWML|target]],<br /> [[StatisticalScenarioWML#The_.5Bteam.5D_tag|team]],<br /> teleport ([[DirectActionsWML#.5Bteleport.5D|action]], [[AbilitiesWML|ability]]), [[AnimationWML|teleport_anim]],<br /> terrain([[TerrainWML|define]], [[DirectActionsWML#.5Bterrain.5D|create]]), [[TerrainGraphicsWML|terrain_graphics]], [[TerrainMaskWML|terrain_mask]], [[ScenarioWML#Test_scenario|test]],<br /> [[WesCamp|textdomain]], [[InterfaceActionsWML|text_input]], [[ThemeWML|theme]], [[ConditionalActionsWML#.5Bif.5D|then]],<br /> [[TerrainGraphicsWML|tile]], [[TimeWML|time]], time_area&amp;nbsp;([[DirectActionsWML#.5Btime_area.5D|action]], [[ScenarioWML|scenario]]), <br /> [[ThemeWML|time_of_day]],<br /> [[HelpWML|topic]], [[HelpWML|toplevel]], [[SingleUnitWML|trait]], [[DirectActionsWML#.5Btunnel.5D|tunnel]] [[ThemeWML|turn]], [[ScenarioWML|tutorial]];<br /> |-<br /> |''U:'' <br /> [[InterfaceActionsWML|unhide_unit]], [[SingleUnitWML|unit]],<br /> [[ThemeWML|unit_abilities]], [[ThemeWML|unit_alignment]], [[ThemeWML|unit_description]], [[AnimationWML|unit_filter]], [[ThemeWML|unit_hp]], [[ThemeWML|unit_image]], [[ThemeWML|unit_level]], [[ThemeWML|unit_moves]],<br /> [[InterfaceActionsWML|unit_overlay]], [[ThemeWML|unit_profile]], [[ThemeWML|unit_status]],<br /> [[ThemeWML|unit_traits]], [[UnitTypeWML|unit_type]], [[ThemeWML|unit_weapons]], [[ThemeWML|unit_xp]],<br /> [[UnitsWML|units]], [[DirectActionsWML#.5Bunpetrify.5D|unpetrify]], [[DirectActionsWML#.5Bunstore_unit.5D|unstore_unit]], [[ThemeWML|upkeep]];<br /> |-<br /> | ''V:'' <br /> [[ConditionalActionsWML#Condition_Tags|variable]],<br /> [[VariablesWML|variables]],<br /> [[SideWML|village]],<br /> [[ThemeWML|villages]];<br /> |-<br /> | ''W:'' <br /> [[ConditionalActionsWML#.5Bwhile.5D|while]],<br /> [[InterfaceActionsWML|wml_message]];<br /> |}<br /> <br /> &lt;noinclude&gt;An box with all the WML tags, each linking to the page they are described in. This box should be included in each of the WML reference pages.&lt;/noinclude&gt;</div>

Gambit https://wiki.wesnoth.org/index.php?title=InterfaceActionsWML&diff=38053 2010-08-26T02:33:17Z

<p>Gambit: /* Other interface tags */ adding information about the [chat] tag</p> <hr /> <div>{{WML Tags}}<br /> == Interface actions ==<br /> <br /> Interface actions are actions that do not have an effect on gameplay;<br /> instead, they show something to the player. The main interface tags<br /> are '''[message]''' and '''[objectives]''', but several other tags affect<br /> the interface also.<br /> <br /> == [inspect] ==<br /> This user interface action only works in debug mode. It displays the gamestate inspector dialog (the same one which can be brought up with '':inspect'' ), which can be used to inspect the values of WML variables, AI configuration, recall lists, and more.<br /> <br /> * '''name''': optional attribute to specify the name of this gamestate inspector dialog. It is just a label to help differentiate between different invocations of gamestate inspector dialog.<br /> <br /> == [message] ==<br /> The most commonly used interface action is [message], which displays a message to the user in a dialog box. It can also be used to take input from the user.<br /> <br /> The following key/tags are accepted for [message]:<br /> * [[StandardUnitFilter]]: The unit whose profile and name are displayed. Do not use a [filter] tag. If no unit matching this filter is found, the message is not displayed (The unit has probably been killed).&lt;br&gt;'''[message]''' elements should be constructed so that it is either guaranteed that a certain unit is alive, or so that dialog flows smoothly even if the message isn't displayed.<br /> <br /> * '''speaker''': an alternative to standard unit filter. You may specify as the value of the speaker attribute a unit id or any of the following special values:<br /> ** '''narrator''': the dialog box is displayed without a caption for the unit speaking or a unit image<br /> ** '''unit''': the primary unit for the event is speaking<br /> ** '''second_unit''': the secondary unit for the event is speaking<br /> <br /> * '''message''': (translatable) the text to display to the right of the image. ''message'' is sometimes multiple lines; if it is, be sure to use quotes(''' ' ''' or ''' &quot; ''')<br /> * '''[show_if]''': if present then this message will only be displayed if the conditional statement in this tag is passed (see [[ConditionalActionsWML#Condition_Tags|ConditionalActionsWML]])<br /> * '''side_for''': (default: all sides) comma-separated list of sides for who message is shown.<br /> * '''image''': (default: profile image of speaker) the image to display next to the message.<br /> * '''caption''': (default: name of speaker) the caption to display beside the image. Name to be displayed. Note: use a translation mark to avoid wmllint errors.<br /> * '''duration''': (default: 10) the minimum number of frames for this message to be displayed. (A frame lasts about 30 milliseconds.) During this time any dialog decisions will be disregarded.<br /> * '''sound''': a sound effect (wav file) to play as the message is displayed. This can be a comma-separated list, from which one will be randomly chosen.<br /> * '''[option]''': zero or more '''[option]''' elements may be present. If '''[option]''' elements are present, then each option will be displayed in a menu for the user to select one option.<br /> ** '''message''': (translatable) the text displayed for the option (see [[DescriptionWML]])<br /> ** '''[show_if]''': if present then this option will only be displayed if the conditional statement in this tag is passed (see [[InternalActionsWML]])<br /> ** '''[command]''': an element containing actions which are executed if the option is selected.<br /> * '''[text_input]''': there can be only one [text_input] tag. this adds a text input field to the message.<br /> ** '''variable''': the variable that the user's input will be written to<br /> ** '''label''': a text label to the left of the input field<br /> ** '''max_length''': the maximum number of characters that may be typed into the field<br /> ** '''text''': text that is written into the field in the beginning<br /> * Check [[EventWML#Multiplayer_safety]] to find out in which events you can safely use '''[option]''' and '''[text_input]''' without causing OOS.<br /> <br /> === Formatting ===<br /> In 1.8, [http://library.gnome.org/devel/pango/unstable/PangoMarkupFormat.html Pango markup formatting codes] have been adopted for '''[message]'''. These can also be used in unit names (user_description), objectives, and such. Note that you'll probably want to use a single quote ' instead of a double quote &quot; as double quotes cannot be escaped, otherwise the string will appear fragmented and you may also encounter errors. Running wmllint on your campaign will up-convert it, warning you about unusual cases you must fix by hand.<br /> <br /> For example, if you wanted to write &quot;You are victorious!&quot; in large, italic, gold letters, you might write it this way:<br /> <br /> &lt;nowiki&gt;&lt;span color='#BCB088' size='large' font-style='italic'&gt;You are victorious!&lt;/span&gt;&lt;/nowiki&gt;<br /> <br /> <br /> These are the codes taken from the Pango markup formatting guide:<br /> <br /> *'''font''', '''font_desc''': A font description string, such as &quot;Sans Italic 12&quot;.<br /> *'''font_family''', '''face''': A font family name.<br /> *'''font_size''', '''size''': Font size in 1024ths of a point, or one of the absolute sizes 'xx-small', 'x-small', 'small', 'medium', 'large', 'x-large', 'xx-large', or one of the relative sizes 'smaller' or 'larger'.<br /> *'''font_style''', '''style''': One of 'normal', 'oblique', 'italic'.<br /> *'''font_weight''', '''weight''': One of 'ultralight', 'light', 'normal', 'bold', 'ultrabold', 'heavy', or a numeric weight.<br /> *'''font_variant''', '''variant''': One of 'normal' or 'smallcaps'.<br /> *'''font_stretch''', '''stretch''': One of 'ultracondensed', 'extracondensed', 'condensed', 'semicondensed', 'normal', 'semiexpanded', 'expanded', 'extraexpanded', 'ultraexpanded'.<br /> *'''foreground''', '''fgcolor''', '''color''': An RGB color specification such as '#00FF00' or a color name such as 'red'.<br /> *'''background, bgcolor''': An RGB color specification such as '#00FF00' or a color name such as 'red'.<br /> *'''underline''': One of 'none', 'single', 'double', 'low', 'error'.<br /> *'''underline_color''': The color of underlines; an RGB color specification such as '#00FF00' or a color name such as 'red'.<br /> *'''rise''': Vertical displacement, in 10000ths of an em. Can be negative for subscript, positive for superscript.<br /> *'''strikethrough''': 'true' or 'false' whether to strike through the text.<br /> *'''strikethrough_color''': The color of strikethrough lines; an RGB color specification such as '#00FF00' or a color name such as 'red'<br /> *'''fallback''': 'true' or 'false' whether to enable fallback. If disabled, then characters will only be used from the closest matching font on the system. No fallback will be done to other fonts on the system that might contain the characters in the text. Fallback is enabled by default. Most applications should not disable fallback.<br /> *'''letter_spacing''': Inter-letter spacing in 1024ths of a point.<br /> *'''gravity''': One of 'south', 'east', 'north', 'west', 'auto'.<br /> *'''gravity_hint''': One of 'natural', 'strong', 'line'.<br /> <br /> <br /> In 1.6, Wesnoth uses older text formatting options<br /> * A tilde (~) as the first character causes the line to be boldfaced.<br /> * An at symbol (@) as the first character causes the line to be green, as done with victory conditions.<br /> * A pound symbol (#) as the first character causes the line to be red, as done with defeat conditions.<br /> * An asterisk (*) as the first character causes the line to be bigger.<br /> * A backquote (`) as the first character causes the line to be smaller.<br /> * If used, the caption key text is boldfaced.<br /> * An RGB colour code in the beginning causes the line to be the given colour. This can still be preceded by the above characters. Example: ''message=_&quot;&lt;255,0,0&gt;Red!&quot;''<br /> <br /> == [objectives] ==<br /> The other tag used for plot development is '''[objectives]'''.<br /> The '''[objectives]''' tag overwrites any previously set objectives,<br /> and displays text which should describe the objectives of the scenario.<br /> Scenario objectives are displayed on the player's first turn after the tag is used,<br /> or as part of the event if it triggers during that player's turn.<br /> Objectives can also be accessed at any time in a scenario using the<br /> &quot;Scenario Objectives&quot; game menu option, making this tag useful for<br /> scenario-specific information that the player may need to refer to during play.<br /> <br /> This tag renders the ''objectives'' attribute of [scenario] obsolete (see ''objectives'', [[ScenarioWML]]).<br /> Instead of using ''objectives'', use '''[objectives]''' to set scenario objectives inside a prestart event.<br /> It can also be used to overwrite the starting objectives mid-scenario.<br /> <br /> Attributes of '''[objectives]''':<br /> * '''side''': Default '0'. The side to set the objectives for. A value of 0 sets objectives for all sides.<br /> * '''summary''': Displayed first in the objectives text, this should describe the basic objective for the overall scenario. Can be omitted.<br /> * '''note''': Displayed last in the objectives text, this is sometimes used for hints or additional information. Can be omitted.<br /> * '''victory_string''': Default ' _ &quot;Victory:&quot;', this text precedes the victory objectives.<br /> * '''defeat_string''': Default ' _ &quot;Defeat:&quot;', this text precedes the defeat objectives.<br /> * '''gold_carryover_string''' {{DevFeature1.9}}: Default ' _ &quot;Gold carryover:&quot;', this text precedes the gold carryover information.<br /> * '''notes_string''' {{DevFeature1.9}}: Default ' _ &quot;Notes:&quot;', this text precedes the notes.<br /> * '''silent''': Default: not present. If set to &quot;yes&quot;, the objectives are silently changed. Else, they will be shown to the user when appropriate.<br /> <br /> Tags of '''[objectives]''':<br /> * '''[objective]''': describes a win or loss condition. Most scenarios have multiple win or loss conditions, so use a separate [objective] subtag for each line; this helps with translations.<br /> ** '''description''': text for the specific win or loss condition.<br /> ** '''condition''': The color and placement of the text. Values are 'win'(colored green, placed after ''victory_string'') and 'lose'(colored red, placed after ''defeat_string'')<br /> ** '''[show_if]''': A condition that disables the objective if it doesn't hold. Conditional objectives are refreshed at '''[show_objectives]''' time only. {{DevFeature}}<br /> * '''[gold_carryover]''' {{DevFeature1.9}}: describes how the gold carryover works in this scenario. This is intended to be a more convenient way of displaying carryover information than using the note= key in [objectives].<br /> ** '''bonus''' (boolean): whether an early finish bonus is granted. If omitted, early finish bonus is not mentioned.<br /> ** '''carryover_percentage''': the amount of carryover gold. If omitted, the amount is not mentioned.<br /> * '''[note]''' {{DevFeature1.9}}: describes a note, usually used for hints or additional information. This is an easier way of adding several notes than concatenating them together into a single string to use with the ''note='' key.<br /> ** '''description''': the text of the note.<br /> <br /> === Macros ===<br /> There are a few predefined macros for Objectives that you can use to shorten the code: [http://www.wesnoth.org/macro-reference.xhtml#SET_OBJECTIVES SET_OBJECTIVES], [http://www.wesnoth.org/macro-reference.xhtml#VICTORY_CONDITION VICTORY_CONDITION], and [http://www.wesnoth.org/macro-reference.xhtml#DEFEAT_CONDITION DEFEAT_CONDITION]. Follow the links for each one to see complete syntax and example usage.<br /> <br /> == [set_menu_item] ==<br /> This tag is used to add a custom option in the right-click context menu which can then be used to trigger arbitrary WML commands.<br /> <br /> '''Note:''' Due to limitations in portable devices where there are no scroll bars for context menus, there is a hard-coded limit of 7 custom WML menu items. If you really need to have more than 7 menu items, try combining some of them in a submenu.<br /> <br /> * '''id''': the unique id for this menu item. If a menu item with this id already exists, it allows you to set specific changes to that item.<br /> * '''description''': the in-game text that will appear for this item in the menu.<br /> * '''image''': the image to display next to this item.<br /> * '''needs_select''': if ''yes'' (default ''no''), then the latest select event (see [[EventWML]]) that triggered before this menu item was chosen will be transmitted over the network before this menu item action will be. This only has any effect in networked multiplayer, and is intended to allow more elaborate menu item behaviour there without causing out of sync errors. If you don't know what this means, just leave it false.<br /> * '''[show_if]''': If present, the menu item will only be available if the conditional statement (see [[InternalActionsWML]]) within evaluates to true. When this is evaluated, the WML variables ''$x1'' and ''$y1'' will point to the location on which the context menu was invoked, so it's possible to for example only enable the option on empty hexes or on a particular unit.<br /> * '''[filter_location]''': contains a location filter similar to the one found inside Single Unit Filters (see [[FilterWML]]). The menu item will only be available on matching locations.<br /> * '''[command]''': contains the WML actions to be executed when the menu item is selected. Again, the WML variables ''$x1'' and ''$y1'' will point to the location on which the context menu was invoked on.<br /> <br /> == Other interface tags ==<br /> <br /> The following tags are also action tags:<br /> * '''[item]''': makes a graphical item appear on a certain hex. Note this only places the graphics for an item. It does not make the item do anything. Use a moveto event to make moving onto the item do something. &lt;tt&gt;''('''Hint:''' There are a number of predefined items that are used in various campaigns that you can make use of. You can find [http://www.wesnoth.org/macro-reference.xhtml#file:items.cfg a list of them] if you look into the items.cfg file in the wesnoth install directory (under /data/core/macros))''&lt;/tt&gt;<br /> ** '''x''', '''y''': the location to place the item.<br /> ** '''image''': the image (in ''images/'' as .png) to place on the hex.<br /> ** '''halo''': an image to place centered on the hex. Use this instead of ''image'' if the image is bigger than the hex or if you want to animate an image. ''Example (where the integer after the colon is the duration of each frame): halo=scenery/fire1.png:100,scenery/fire2.png:100,scenery/fire3.png:100,scenery/fire4.png:100,scenery/fire5.png:100,scenery/fire6.png:100,scenery/fire7.png:100,scenery/fire8.png:100''<br /> ** '''team_name''': name of the team for which the item is to be displayed (hidden for others). For multiple teams just put all the names in one string, for example separated by commas.<br /> ** '''visible_in_fog''': whether the item should be visible through fog or not. Default yes.<br /> * '''[removeitem]''': removes any graphical items on a given hex<br /> ** '''x''', '''y''': the hex to remove items off<br /> ** '''image''' if specified, only removes the given image item (This image name must include any [[ImagePathFunctionWML|image path functions]] appended to the original image name.)<br /> * '''[print]''': displays a message across the screen. The message will disappear after a certain time.<br /> ** '''text''': (translatable) the text to display.<br /> ** '''size''': (default=12) the pointsize of the font to use<br /> ** '''duration''': (default=50) the length of time to display the text for. This is measured in the number of 'frames'. A frame in Wesnoth is usually displayed for around 30ms.<br /> ** '''red''', '''green''', '''blue''': (default=0,0,0) the color to display the text in. Values vary from 0-255.<br /> * '''[move_unit_fake]''': moves an image of a unit along a certain path on the map. The path does not need to be a continuous list of adjacent hexes, so for example only the start and end points can be given, in which case the straightest line between those points will be calculated and used.<br /> ** '''type''': the type of the unit whose image to use<br /> ** '''x''': a comma-separated list of x locations to move along<br /> ** '''y''': a comma-separated list of y locations to move along (x and y values are matched pairs)<br /> ** '''side''': the side of the fake unit, used for team-coloring the fake unit<br /> ** '''gender''': the gender of the fake unit. Example: gender=female<br /> ** '''variation''': the variation of the fake unit. Example: variation=undead<br /> * '''[move_units_fake]''': {{DevFeature1.9}} moves multiple images of units along paths on the map. These units are moved in lockstep.<br /> ** '''[fake_unit]''': A fake unit to move<br /> *** '''type''': the type of unit whose image to use<br /> *** '''x''': a comma-separated list of x locations to move along<br /> *** '''y''': a comma-separated list of y locations to move along (x and y values are matched pairs)<br /> *** '''side''': the side of the fake unit, used for team-coloring the fake unit<br /> *** '''skip_steps''': the number of steps to skip before this unit starts moving<br /> * '''[hide_unit]''': temporarily prevents the engine from displaying the given unit. The unit does not become invisible, as it would be with the '''[hides]''' ability; it is still the same plain unit, but without an image. Useful in conjunction with '''[move_unit_fake]''': to move a leader unit into position on-screen. Each '''[hide_unit]''' tag only hides one unit.<br /> ** '''x''', '''y''': location of the unit to be hidden. (NOT a standard unit filter! Just x and y.)<br /> ** {{DevFeature1.9}}: '''[hide_unit]''' accepts a [[StandardUnitFilter]] as argument and can disable several units at once.<br /> * '''[unhide_unit]''': stops the currently hidden units from being hidden.<br /> ** {{DevFeature1.9}}: '''[unhide_unit]''' accepts a [[StandardUnitFilter]] as argument.<br /> * '''[scroll]''': Scroll a certain number of pixels in a given direction. Useful for earthquake/shaking effects.<br /> ** '''x''', '''y''': the number of pixels to scroll along the x and y axis<br /> * '''[scroll_to]''': Scroll to a given hex<br /> ** '''x''', '''y''': the hex to scroll to<br /> ** '''check_fogged''': whether to scroll even to locations covered in fog or shroud. Possible values ''true'' (don't scroll to fog) and ''false'' (scroll even to fog), with ''false'' as the default.<br /> * '''[scroll_to_unit]''' Scroll to a given unit<br /> ** [[StandardUnitFilter]]<br /> ** '''check_fogged''': whether to scroll even to locations covered in fog or shroud. Possible values ''true'' (don't scroll to fog) and ''false'' (scroll even to fog), with ''false'' as the default.<br /> * '''[sound]''': Plays a sound<br /> ** '''name''': the filename of the sound to play (in ''sounds/'' as .wav or .ogg)<br /> ** '''repeat''': repeats the sound for a specified additional number of times (default=0)<br /> * '''[sound_source]''': Creates a sound source. &quot;Sound sources&quot; is a general name for a mechanism which makes possible for map elements to emit sounds according to some rules, where &quot;map elements&quot; can be specific locations or terrain types. For now, only sound sources tied to locations are supported.<br /> ** '''id''': a unique identification key of the sound source<br /> ** '''sounds''': a list of comma separated, randomly played sounds associated with the sound source<br /> ** '''delay''': a numerical value (in milliseconds) of the minimal delay between two playbacks of the source's sound if the source remains visible on the screen; if one scrolls out and back in, the source will be considered as ready to play<br /> ** '''chance''': a percentage (a value from 0 to 100) describing the chance of the source being activated every second after the delay has passed or when the source's location appears on the screen (note that it cannot play more than one file at the same time)<br /> ** '''check_fogged''': possible values &quot;true&quot; and &quot;false&quot; - if true the source will not play if its locations are fogged<br /> ** '''check_shrouded''': {{DevFeature}} possible values &quot;true&quot; and &quot;false&quot; - if true the source will not play if its locations are shrouded<br /> ** '''x,y''': similar to x,y as found in a [[StandardLocationFilter]], these are the locations associated with the sound source<br /> ** '''fade_range''' (default = 3): distance in hexes that determines a &quot;circular&quot; area around the one specified by '''full_range''' where sound volume fades out linearly<br /> ** '''full_range''' (default = 14): distance in hexes that determines a &quot;circular&quot; area where source plays with full volume, relative to screen center<br /> ** '''loop''': number of times a sound sample should be looped if it stays visible. -1 means infinite (~65000)<br /> * '''[remove_sound_source]''': Removes a previously defined sound source.<br /> ** '''id''': the identification key of the sound source to remove<br /> * '''[music]''': Switches to playing different music<br /> ** '''name''': the filename of the music to play (in ''music/'' as .ogg)<br /> ** see [[MusicListWML]] for the correct syntax<br /> * '''[volume]''': {{DevFeature1.9}} Changes the game volume to a percent of the preferences volume for the game being played. Values can go from 0 to 100: <br /> ** '''music''': Changes the music volume.<br /> ** '''sound''': Changes the sound volume.<br /> * '''[colour_adjust]''': tints the colour of the screen.<br /> ** '''red''', '''green''', '''blue''': values from -255 to 255, the amount to tint by for each colour<br /> * '''[delay]''': pauses the game<br /> ** '''time''': the time to pause in milliseconds<br /> * '''[redraw]''': redraws the screen (this normally isn't done during events, although some of the other interface actions cause the screen or parts of it to be redrawn).<br /> ** '''side''': if used, recalculates fog and shroud for that side. Useful if you for example spawn friendly units in the middle of an event and want the shroud to update accordingly (otherwise units that spawn inside fog would remain invisible for the duration of the event, since the fog would not automatically get cleared around them).<br /> * '''[unit_overlay]''': sets an image that will be drawn over a particular unit, and follow it around<br /> ** '''x''', '''y''': the location of the unit to overlay on<br /> ** '''image''': the image to place on the unit<br /> ** {{DevFeature1.9}}: '''[unit_overlay]''' accepts a [[StandardUnitFilter]] as argument<br /> * '''[remove_unit_overlay]''': removes a particular overlayed image from a unit<br /> ** '''x''', '''y''': the location of the unit to remove an overlay from<br /> ** '''image''': the image to remove from the unit<br /> ** {{DevFeature1.9}}: '''[remove_unit_overlay]''' accepts a [[StandardUnitFilter]] as argument<br /> * '''[animate_unit]''': Uses an animation of a unit to animate it on screen (if the unit has the corresponding animation).<br /> ** '''flag''': The key to find the custom animation in the unit description (see the '''[extra_anim]''' description in [[AnimationWML]]). Standard animations can be triggered with the following keywords: ''leading recruited standing idling levelin levelout healing healed poisoned movement defend attack death victory pre_teleport post_teleport''<br /> ** '''[filter]''' with a [[StandardUnitFilter]] as argument, see [[FilterWML]]. By default, the unit at the event location will be animated. You can use this tag to choose any other unit to animate.<br /> ** '''[primary_attack]''': If this tag is not present, the filter for animation will be triggered with no attack. If it is here, all attacks from the unit will be filtered, and a matching one will be used to filter the animation. Takes a weapon filter as argument, see [[FilterWML]].<br /> ** '''[secondary_attack]''': Similar to '''[primary_attack]'''. May be needed to trigger a defense animation correctly, if there are more than one animations available for the defending unit.<br /> ** '''hits''': yes/no: which according variation of a attack/defense animation shall be chosen (required)<br /> ** '''text''': a text to hover during the animation <br /> ** '''red''': red value for the text color (0-255)<br /> ** '''green''': green value for the text color<br /> ** '''blue''': blue value for the text color<br /> ** '''with_bars''': yes/no: whether to display the status bars during the animation (e.g. the hitpoint bar)<br /> ** '''[animate]''': a sub block with the same syntax as '''[animate_unit]''' except that the '''[filter]''' block is mandatory to find the unit. This block will find and animate another unit simultaneously.<br /> ** '''[facing]''': a [[StandardLocationFilter]] specifying what direction the unit should be facing when animated<br /> * '''[label]''' places a label on the map.<br /> ** '''x''', '''y''': the location of the label<br /> ** '''text''': what the label should say<br /> ** '''team_name''': if specified, the label will only be visible to the given team.<br /> ** '''colour''': color of the label. The format is r,g,b; r, g and b are numbers between 0 and 255. <br /> ** '''visible_in_fog''': whether the label should be visible through fog or not. Default yes.<br /> ** '''visible_in_shroud''': whether the label should be visible through shroud or not. Default no.<br /> ** '''immutable''': whether this label is protected from being removed or changed by players. Default yes. {{DevFeature1.9}}<br /> * '''[deprecated_message]''' shows a deprecated message in the message area, this feature is only intended to be used to warn about deprecated macros in mainline. The message is not translatable.<br /> ** '''message''': the message to show.<br /> * '''[wml_message]''' outputs a message to Wesnoth's console output. Intended for campaign designers to output silent text to the console, without annoying the player; then, that text might contain information useful for later bug-reporting. The log domain for it is '''wml''', and the '''debug/dbg''' log level is available for use with the '''logger''' attribute. Depending on the current log level ('''error''' by default), which may be changed with the in-game :log command, or the --log-&lt;level&gt;=wml command line switch, the messages are echoed to the in-game chat.<br /> ** '''message''': the message to show.<br /> ** '''logger''': the Wesnoth engine output logger that should catch the text; this might be 'err' (the errors log level), 'warn'/'wrn' (the warnings log level) or anything else (the information log level). Not all information will be displayed depending on the log level chosen when starting Wesnoth.<br /> * '''[open_help]''' opens the in-game help.<br /> ** '''topic''': the id of the topic to open<br /> * '''[show_objectives]''': {{DevFeature}} refreshes the objectives defined by [objectives] and its [show_if] tags, and displays them. (It is also called whenever the user explicitly asks for the objectives; this matters only if the tag was overridden by a [[LuaWML#register_wml_action|Lua]] script.)<br /> ** '''side''': the side to show the objectives. If not set, all sides are used.<br /> * '''[chat]''' displays a message in the chat area. {{DevFeature1.9}}<br /> ** '''speaker''': The sender of the message<br /> ** '''message''': The message that should be displayed<br /> ** '''side''': A comma separated list of sides to show the message to. If left blank the message will be send to all sides.<br /> <br /> == Useful Macros ==<br /> There are some predefined macros that you find useful for interface actions. You can find a complete list along with a detailed explanation of how they work [http://www.wesnoth.org/macro-reference.xhtml here].<br /> * '''{FLOATING_TEXT}''' Float some text over a unit similar to the damage numbers.<br /> * '''{HIGHLIGHT_UNIT}''' Highlight a unit on the map. Use this to show important units<br /> * '''{HIGHLIGHT_IMAGE}''' Places and highlights an image on the map. Use this to show important items or locations<br /> * '''{SET_IMAGE}''' Places an image on the map which has no other function.<br /> * '''{QUAKE &lt;soundfile&gt;}''' Creates a tremor like screenshake and plays &lt;soundfile&gt;. ('''{TREMOR}''' is a deprecated version, equivalent to '''{QUAKE (rumble.ogg)}''')<br /> * '''{FLASH_WHITE}''' Flash the screen white momentarily. You can also replace WHITE with RED, BLUE or GREEN for a different colour.<br /> <br /> == See Also ==<br /> * [[DirectActionsWML]]<br /> * [[InternalActionsWML]]<br /> * [[EventWML]]<br /> * [[ReferenceWML]]<br /> <br /> <br /> [[Category: WML Reference]]<br /> [[Category: ActionsWML]]</div>

Gambit https://wiki.wesnoth.org/index.php?title=EventWML&diff=37998 2010-08-20T23:12:59Z

<p>Gambit: /* Predefined 'name' Key Values */ moves a line down</p> <hr /> <div>{{WML Tags}}<br /> == The [event] Tag ==<br /> <br /> This tag is a subtag of the [scenario], [unit_type] and [era] tags which is used to describe a set of actions which trigger at a certain point in a scenario. When used in a [scenario] tag (also includes [multiplayer], [tutorial] and [test]), the event only occurs in that scenario. When used in a [unit_type] tag, the event will occur in all scenarios in which a unit of that type appears in (only after such a unit appears during the scenario, however). When used in an [era], the event will occur in any scenario which is played using that era.<br /> <br /> This tag has keys and child tags that control when and if the event actions will be triggered. Most important of these is the '''name''' key. Without it, no error will be raised but the event will never fire. Therefore, from a practical standpoint, it can be considered mandatory. All of the others can be used or not and the event actions will fire either way.<br /> <br /> '''Lexicon side note:''' ''The word &quot;event&quot; in the [event] tag itself may be considered an abbreviation of the word &quot;event handler&quot; because it is technically not a game &quot;event&quot; but an event '''handler''' for the game events fired with the given 'name'. However, this distinction is usually unimportant in most discussions and the event handlers are therefore simply referred to as &quot;events&quot; in this documentation.''<br /> <br /> === The 'name' Key (Mandatory) ===<br /> <br /> Usage:<br /> name=&lt;value&gt;<br /> <br /> This key defines which game event or trigger your [event] tag will be handling. This 'name' key should not be confused with a descriptive comment; it is rather a precise value which must match the predefined game event's name to be valid.<br /> <br /> '''Lexicon side note:''' ''It is not uncommon to refer to these values as the 'trigger' for an event and, furthermore, to call an event by its 'trigger' name. For example, in an event containing '''name=moveto''', a person might refer to the event as a ''''moveto''' event' and/or refer to the ''''moveto''' trigger' in the event or even talk about the 'event trigger' when referring to the '''moveto''' value of the 'name' key in that event. Some or all of this usage can, in fact, be found throughout this page.''<br /> <br /> The '''name''' key can accept a list of comma separated values describing when the event will be triggered.* These values may be either predefined event types or custom event names not matching any predefined type.<br /> <br /> For example:<br /> <br /> name=attacker misses,defender misses<br /> <br /> ''* Note that unless you use [[#first_time_only|first_time_only=no]], the event will fire only once, '''not''' once for each listed type.''<br /> <br /> ==== Predefined 'name' Key Values ====<br /> <br /> All predefined event types are listed here along with a description of when this value will cause the event to be triggered. Any value ''not'' listed here is a custom event name which can be triggered only by a '''[fire_event]''' tag somewhere else. Spaces in event names can be interchanged with underscores (for example, '''name=new turn''' and '''name=new_turn''' are equivalent).<br /> <br /> ; preload<br /> : Triggers before a scenario 'prestarts' and when loading a savegame -- before anything is shown on the screen at all. Can be used to set up the [[LuaWML|Lua]] environment: loading libraries, defining helper functions, etc.<br /> : '''Note:''' Unlike prestart and start, the preload event '''must be able to fire more than once!''' This is because it is triggered each time a savegame is loaded in addition to the initial time when it loads before the scenario 'prestart'. This means that it is effectively ''mandatory'' to have the [[#first_time_only|first_time_only=no]] key value in a preload event. <br /> <br /> ; prestart<br /> : Triggers before a scenario 'starts' -- before anything is shown on the screen at all. Can be used to set up things like village ownership. For things displayed on-screen such as character dialog, use '''start''' instead.<br /> : '''Note:''' ''This value makes the [[#first_time_only|first_time_only]] key irrelevant since, by definition, it can only fire once.''<br /> <br /> ; start<br /> : Triggers after the map is shown but before the scenario begins -- before players can 'do' anything.<br /> : '''Note:''' ''This value makes the [[#first_time_only|first_time_only]] key irrelevant since, by definition, it can only fire once.''<br /> <br /> ; new turn<br /> : Triggers at the start of every turn (not side turn). See also [[#first_time_only|first_time_only=no]]. Before any events of this type trigger, the value of the WML variable '''turn_number''' is set to the number of the turn that is beginning.<br /> <br /> ; side turn<br /> : Triggers when a side is about to start its turn. Before events of this type trigger, the value of the WML variable '''side_number''' is set to the number of the side of the player about to take their turn. This is before any healing takes place for that side, before calculating income, and before restoring unit movement and status.<br /> <br /> ; ai turn<br /> : Triggered just before the AI is invoked for a side. This is called after ''side turn'', and thus the WML variable '''side_number''' still holds the number of this side. Note that this event might be called several times per turn in case that fallbacks to human or droiding is involved. I.e. it happens at the middle of turn of human side 1 if the human player droids his side. It happens after the selection of ai to play the turn but before AI is told that new turn has come.<br /> : '''Note:''' ''This event currently breaks replays since it is not explicitly saved in a replay and there is no AI involved in replays...''<br /> <br /> ; turn refresh<br /> : Like '''side turn''', triggers just before a side is taking control but '''after''' healing, calculating income, and restoring unit movement and status.<br /> <br /> ; turn ''X''<br /> : Triggers at the start of turn ''X''. It's the first side initialization event. <br /> <br /> :Side initialization events go in the order of: <br /> : 1) '''turn ''X''''' <br /> :2) '''new turn''' <br /> :3) '''side turn''' <br /> :4) '''side ''X'' turn''' <br /> :5) '''side turn ''X''''' <br /> :6) '''side ''X'' turn ''Y''''' <br /> :7) '''turn refresh''' <br /> :8) '''side ''X'' turn refresh''' <br /> :9) '''turn ''X'' refresh''' <br /> :10) '''side ''X'' turn ''Y'' refresh'''<br /> <br /> ; side ''X'' turn ''Y''<br /> : This event triggers at the start of turn ''Y'' of side X {{DevFeature}}<br /> <br /> ; side ''X'' turn<br /> : This event triggers at the start of any turn of side X {{DevFeature}}<br /> : '''Note:''' ''Of course, [[#first_time_only|first_time_only=no]] is needed for this event to be triggered more than once.''<br /> <br /> ; side turn ''X''<br /> : This event triggers at the start of any side on turn X {{DevFeature1.9}}<br /> : '''Note:''' ''Of course, [[#first_time_only|first_time_only=no]] is needed for this event to be triggered more than once.''<br /> <br /> ; side X turn Y refresh<br /> : This event triggers at the turn refresh for side X on turn Y {{DevFeature1.9}}<br /> <br /> ; side ''X'' turn refresh<br /> : This event triggers at the turn refresh for side X {{DevFeature1.9}}<br /> : '''Note:''' ''Of course, [[#first_time_only|first_time_only=no]] is needed for this event to be triggered more than once.''<br /> <br /> ; turn ''X'' refresh<br /> : This event triggers for any side at the refresh of turn X. {{DevFeature1.9}}<br /> : '''Note:''' ''Of course, [[#first_time_only|first_time_only=no]] is needed for this event to be triggered more than once.''<br /> <br /> ; time over<br /> : Triggers on turn ''turns''. (''turns'' is specified in [scenario])<br /> <br /> ; enemies defeated<br /> : Triggers when all units with '''canrecruit=yes''' (that is, all leaders) not allied with side 1 are killed.<br /> <br /> ; victory<br /> : In this scenario, any tag of the form '''[endlevel] result=victory [/endlevel]''' will be automatically preceded by all actions in this tag. It helps debugging if the victory event allows you to safely advance to any of the possible next maps after using the &quot;:n&quot; command. Scenarios where key units are picked up before the victory, or where some action chosen earlier determines which map to advance to, make it hard to quickly test scenarios in a campaign. (See also: [endlevel], [[DirectActionsWML]])<br /> <br /> ; defeat<br /> : In this scenario, any tag of the form '''[endlevel] result=defeat [/endlevel]''' will be automatically preceded by all actions in this tag. (See also [endlevel], [[DirectActionsWML]])<br /> <br /> <br /> Filters can be applied to the following event triggers (see [[FilterWML]]; see also below). The actions specified in the event tag will be executed only if the filter returns true. <br /> These event triggers are all actions by units ('''moveto''', '''attack''') or things that happen to units ('''recruit''', '''advance'''). When one of these events is triggered, the position of the active unit (referred to as the '''primary unit''') is stored in the variables '''x1''' and '''y1''' and the position of any unit that primary unit does something to is stored in the variables '''x2''' and '''y2''' (this unit is referred to as the '''secondary unit''' below). '' These units are also automatically stored in the variables 'unit' and 'second_unit' as if they had been stored using the '''[store_unit]''' tag. see [[SingleUnitWML]]<br /> <br /> ; moveto<br /> : Triggers after the primary unit moves. Typically this is used when the primary unit gets to a particular location and a filter for the location of the primary unit is included; remember that this is the location that the primary unit lands on, not the location it started on or any location it travels on.&lt;br /&gt;''An '''[allow_undo]''' tag anywhere within a moveto event will cancel any lack of undo functionality the event would have caused. Note that undo functionality will only move the unit back to its former location; it will not undo other changes to the game caused by the event. Thus it is up to the scenario designer to use this tag correctly.'' {{DevFeature}} $x2 and $y2 refer to the hex the unit came from.<br /> <br /> ; sighted<br /> : Triggers when the primary unit becomes visible to the secondary unit in particular after not being visible to the secondary unit's side (so if the secondary unit's side doesn't have shroud or fog, the event never triggers). This happens both when the primary unit moves into view during its turn, and when the secondary unit moves to a location where it can see the primary unit. (This editor hasn't tested whether the event triggers multiple times if the primary unit moves into view of multiple units at once, or if not, which one gets chosen to be the secondary unit here.) (Note: it appears that when a sighted event is triggered because an enemy unit moves into your field of view, the game engine cannot determine which unit (on your side) sees the unit that moved, and so it fires a ''name=sighted'' event without setting ''$second_unit''. This means that, for example, using ''speaker=second_unit'' inside a message tag may fail.) (Double note: it also appears that the sighted event in more recent versions of the game (1.6 and 1.7, maybe?) does not fire on enemy turns. That is, it only fires for units that become visible as a result of the motion of another unit, not for units that move into the vision of an enemy. This event is also buggy in general... it's usually better to use a moveto event with a [filter_vision] tag than to use a sighted event (and note that the combination of the two can achieve something like the old sighted event)).<br /> <br /> ; attack<br /> : Triggers when the primary unit attacks the secondary unit.<br /> <br /> ; attack end<br /> : Similar to '''attack''', but is triggered ''after'' the fight instead of before. Note that if either unit is killed during the fight, this event triggers before any '''die''' events.<br /> <br /> ; attacker hits<br /> : Triggers when the the primary unit (the attacker) hits the secondary unit (the defender). The value of the WML variable '''damage_inflicted''' is set to the number of hitpoints inflicted by the attacker.<br /> <br /> ; attacker misses<br /> : Same as ''attacker hits'', but is triggered when the attacker misses.<br /> <br /> ; defender hits<br /> : Triggers when the primary unit (the attacker) is hit in retaliation by the secondary unit (the defender). The value of the WML variable '''damage_inflicted''' is set to the number of hitpoints inflicted by the defender.<br /> <br /> ; defender misses<br /> : Same as ''defender hits'', but is triggered when the defender misses.<br /> <br /> ; stone<br /> : Triggers when the primary unit is hit by an attack with the 'stones' ability (See ''stones'', [[AbilitiesWML]]) by the secondary unit (the unit with the 'stones' ability). In {{DevFeature}}, this event name is changed to &quot;petrified&quot;.<br /> <br /> ; last breath<br /> : Triggers when the primary unit is killed by the secondary unit, but before the death animation is triggered. Use this instead of name=die when you want the primary unit to make a final [message]. <br /> <br /> ; die<br /> : Triggers when the primary unit is killed by the secondary unit. ''Note: The primary unit is not removed from the game until the end of this event. The primary unit can still be manipulated, will block other units from taking its hex, and will still be found by standard unit filters (except [have_unit]). To prevent this behavior, you can use [kill] to remove the unit immediately. However, this will stop any (still unfired) other events that also match the unit from firing afterwards, so use with caution.'' If you want to the primary unit to make a final [message], use name=last_breath, see above.<br /> <br /> ; capture<br /> : Triggers when the primary unit captures a village. The village may have been previously neutral, or previously owned by another side; merely moving into your own villages does not constitute a capture.<br /> <br /> ; recruit<br /> : Triggers when the primary unit is recruited. (That is, when a unit is recruited it will trigger this event and this event's filter will filter that unit.).<br /> <br /> ; prerecruit<br /> : Triggers when the primary unit is recruited but before it is displayed.<br /> <br /> ; recall<br /> : Triggers after a unit is recalled.<br /> <br /> ; prerecall<br /> : Triggers when a unit is recalled but before it is displayed.<br /> <br /> ; advance<br /> : Triggers just before the primary unit is going to advance to another unit.<br /> <br /> ; post advance<br /> : Triggers just after the primary unit has advanced to another unit.<br /> <br /> ; select<br /> : Triggers when the primary unit is selected. Also triggers when ending a move, as the game keeps the moving unit selected by selecting it again at the end of movement. ''Note: in networked multiplayer, these events are only executed by the client on which the event is triggered, leading to out of sync errors if you modify the game state in the event.''<br /> <br /> ; menu item ''X''<br /> : Triggers when a WML menu item with id=''X'' is selected. ''Note: if the menu item has a [command], this event may be executed before or after the command; there is no guarantee.''<br /> <br /> ==== Custom events ====<br /> <br /> An event with a custom name may be invoked using the [[InternalActionsWML#.5Bfire_event.5D|[fire_event]]] tag. Normally you'll use such custom events as named subroutines to be called by events with predefined types. One common case of this, for example, is that more than one '''sighted''' events might fire the same custom event that changes the scenario objectives.<br /> <br /> === Optional Keys and Tags ===<br /> <br /> These keys and tags are more complex ways to filter when an event should trigger:<br /> <br /> ==== first_time_only ====<br /> : Whether the event should be removed from the scenario after it is triggered. This key takes a [[ConditionalActionsWML#Boolean_Values|boolean]]; for example:<br /> : ''first_time_only=yes''<br /> :: Default behavior if key is omitted. The event will trigger the first time it can and never again.<br /> : ''first_time_only=no''<br /> :: The event will trigger every time the criteria are met instead of only the first time.<br /> <br /> ==== [filter] ====<br /> : The event will only trigger if the primary unit matches this filter.<br /> :* [[StandardUnitFilter]]: selection criteria<br /> <br /> ==== [filter_second] ====<br /> : Like [filter], but for the secondary unit.<br /> :* [[StandardUnitFilter]]: selection criteria<br /> <br /> ==== [filter_attack] ====<br /> : Can be used to set additional filtering criteria for the primary unit and the secondary unit that are not generally available in a standard unit filter. Can be used in events ''attack'', ''attacker hits'', ''attacker misses'', ''defender hits'', ''defender misses'' and ''attack end''. For more information and other filter keys, see [[FilterWML]].<br /> :* '''name''': the name of the weapon used.<br /> :* '''range''': the range of the weapon used.<br /> :* '''special''': filter on the attack's special power.<br /> <br /> ==== [filter_second_attack] ====<br /> : Like [filter_attack], but for the secondary unit.<br /> :* '''name''': the name of the weapon used.<br /> :* '''range''': the range of the weapon used.<br /> :* '''special''': filter on the attack's special power.<br /> <br /> ==== [event] ====<br /> : A special case 'action', the [event] tag may be used to create a [[#Nested Events|nested event]].<br /> <br /> ==== delayed_variable_substitution ====<br /> : This key is only relevant inside of a [[#Delayed Variable Substitution|nested event]] and controls when variable substitution will occur in those special case actions.<br /> <br /> === Actions triggered by [event] ===<br /> <br /> After the trigger conditions have been met, all action tags within the [event] tag are executed in the order they are written in.<br /> <br /> There are 3 main types of actions:<br /> * direct actions ([[DirectActionsWML]]) which have a direct effect on gameplay<br /> * display actions ([[InterfaceActionsWML]]) which show something to the user<br /> * internal actions ([[InternalActionsWML]]) which are used by WML internally<br /> <br /> Several actions use standard filters to find out which units<br /> to execute the command on. These are denoted by the phrases<br /> &quot;standard unit filter&quot; and &quot;standard location filter&quot;.<br /> <br /> === Nested Events ===<br /> <br /> There is one special type of action: event creation. By placing an '''[event]''' tag inside another '''[event]''' tag, the nested event is spawned (created) when the parent (outer) event is encountered (when executing the contents of the parent event).<br /> <br /> ([[#Nested Event Example|See Examples]])<br /> <br /> ==== Delayed Variable Substitution ====<br /> <br /> Variable substitution for a nested event can happen either when it is spawned by the parent event or when it is triggered itself. This is controlled with the key '''delayed_variable_substitution''' which is used in the nested event.<br /> <br /> If this key is set to ''yes'', the variables in the nested event will contain values from the turn in which the ''nested'' event was triggered. ''This is the default behavior if the key is omitted.'' If set to ''no'', the variables in the nested event are set at the time the ''parent'' event is triggered.<br /> <br /> This behavior can be fine tuned with a special syntax when referencing variables. Instead of the normal '''$variable''' syntax, use '''$|variable''' to cause a variable to contain values relevant to the turn in which the nested event was triggered even when '''delayed_variable_substitution''' is set to ''no''. In this way you can have a mix of variables relevant to the parent and nested event trigger times.<br /> <br /> ([[#Delayed Variable Substitution Example|See Examples]])<br /> <br /> == Multiplayer safety ==<br /> <br /> In multiplayer it is only safe to use WML that might require synchronization with other players because of input or random numbers (like [message] with input or options or [unstore_unit] where a unit might advance) in the following events. This is because in these cases WML needs data from other players to work right and/or do the same thing for all players. This data is only available after a network synchronization.<br /> <br /> List of synchronized events:<br /> * moveto<br /> * sighted <br /> * attack<br /> * attack_end <br /> * attacker hits <br /> * attacker misses <br /> * defender hits<br /> * defender misses <br /> * stone<br /> * last breath <br /> * menu item X<br /> * die<br /> * capture <br /> * recruit<br /> * prerecruit <br /> * recall <br /> * prerecall <br /> * advance <br /> * post_advance <br /> getting message options (etc) from the following events is not synchronized, except in the development version (1.9+svn):<br /> * new turn <br /> * side turn <br /> * turn X <br /> * side X turn <br /> * side X turn Y <br /> * turn refresh <br /> <br /> There is also the possibility of events that are normally synchronized when fired by the engine but can be non-synchronized when fired by WML tags from non-synchronized event. So when you are using them you must be extra careful. For example [unstore_unit] may trigger a unit advancement that will fire ''advance'' and ''post advance'' events.<br /> <br /> == A Trap for the Unwary ==<br /> <br /> It is perfectly possible (and, in fact, useful) to have multiple events with the same predefined name and thus the same trigger condition. However, it is not defined what order such events will fire in, so you need to code so the order <br /> will not matter.<br /> <br /> Because of the above, you need to beware of using macros to generate events. If you include a macro expanding to an event definition twice, the event will be executed twice (not once) each time the trigger condition fires. Consider this code:<br /> <br /> #define DOUBLE<br /> [event]<br /> name=multiply_by_2<br /> {VARIABLE_OP 2_becomes_4 multiply 2}<br /> [/event]<br /> #enddef<br /> <br /> {DOUBLE}<br /> {DOUBLE}<br /> <br /> {VARIABLE 2_becomes_4 2}<br /> <br /> [fire_event]<br /> name=multiply_by_2<br /> [/fire_event]<br /> <br /> {DEBUG_MSG &quot;$2_becomes_4 should be 4&quot;}<br /> <br /> After it executes, the debug message will reveal that the variable has been set to 8, not 4.<br /> <br /> == Miscellaneous Notes and Examples ==<br /> <br /> === Primary/Secondary Unit Speaker Example ===<br /> <br /> In events, the primary unit can be referred to as '''unit''' and the secondary unit can be referred to as '''second_unit''' in [message] tags using the '''speaker''' key. For example:<br /> <br /> [event]<br /> name=die<br /> [message]<br /> speaker='''second_unit'''<br /> message= _ &quot;Hahaha! I finally killed you!&quot;<br /> [/message]<br /> <br /> [message]<br /> speaker='''unit'''<br /> message= _ &quot;It's not over yet! I'll come back to haunt you!&quot;<br /> [/message]<br /> [/event]<br /> <br /> === Nested Event Example ===<br /> <br /> An event is created for a portal that opens on turn 10. The parent (or 'outer') event executes on turn 10 at which point the nested moveto event is created. This nested event executes when a player steps on a certain spot.<br /> <br /> [event]<br /> name=turn 10<br /> <br /> [event]<br /> name=moveto<br /> <br /> [filter]<br /> x,y=5,8<br /> [/filter]<br /> <br /> # moving to 5,8 will trigger this event only on turn 10 and after<br /> [/event]<br /> [/event]<br /> <br /> An equivalent way of doing this would be to create a single moveto event with an '''[if]''' statement to check for turn number but using nested '''[event]''' tags is a convenient shortcut to accomplish this task without resorting to '''[if]''' statements.<br /> <br /> === Delayed Variable Substitution Example ===<br /> <br /> This code will display a message showing the turn number on which the nested ''moveto'' event happens.<br /> <br /> [event]<br /> name=turn 10<br /> <br /> [event]<br /> name=moveto<br /> delayed_variable_substitution=yes<br /> <br /> [filter]<br /> x,y=5,8<br /> [/filter]<br /> <br /> {DEBUG_MSG &quot;Turn $turn_number&quot;} <br /> [/event]<br /> [/event]<br /> <br /> Since this is the default behavior for the '''delayed_variable_substitution''' key, the following example is identical.<br /> <br /> [event]<br /> name=turn 10<br /> <br /> [event]<br /> name=moveto<br /> <br /> [filter]<br /> x,y=5,8<br /> [/filter]<br /> <br /> {DEBUG_MSG &quot;Turn $turn_number&quot;} <br /> [/event]<br /> [/event]<br /> <br /> The following code will always display &quot;Turn 10&quot; when the nested ''moveto'' event happens. This is because the variable substitution is done when the parent event is triggered and spawns the nested event, ''not'' when the nested event is triggered.<br /> <br /> [event]<br /> name=turn 10<br /> <br /> [event]<br /> name=moveto<br /> delayed_variable_substitution=no<br /> <br /> [filter]<br /> x,y=5,8<br /> [/filter]<br /> <br /> {DEBUG_MSG &quot;Turn $turn_number&quot;} <br /> [/event]<br /> [/event]<br /> <br /> Finally, the following example is identical to the first two in that it will display a message showing the turn number on which the nested ''moveto'' event happens, despite the fact that the '''delayed_variable_substitution''' key is set to ''no''. This is because the special '''$|variable''' syntax is used.<br /> <br /> [event]<br /> name=turn 10<br /> <br /> [event]<br /> name=moveto<br /> delayed_variable_substitution=no<br /> <br /> [filter]<br /> x,y=5,8<br /> [/filter]<br /> <br /> {DEBUG_MSG &quot;Turn $|turn_number&quot;} <br /> [/event]<br /> [/event]<br /> <br /> === Multiple Nested Events ===<br /> <br /> Every delayed_variable_substitution=no causes a variable substitution run on the subevent where it occurs at the spawn time of this event and on all following subevents. For any specific event, variable substitution happens at least one time when the event is executed. For each delayed=no key appearing in itself or in an event of an &quot;older&quot; generation, which is not the toplevel event, an additional variable substitution run is made.<br /> [event]# parent<br /> name=turn 2<br /> #delayed_variable_substitution=no # In the parent event, delayed= has no effect.<br /> <br /> [event]# child<br /> name=turn 3<br /> delayed_variable_substitution=no # Causes variable substitution in the child, grandchild and great-grandchild event<br /> # at execution time of the parent event = spawn time of the child event.<br /> <br /> [event]# grandchild<br /> name=turn 4<br /> delayed_variable_substitution=yes # no variable substitution in the grandchild and great-grandchild event<br /> # at execution time of the child event = spawn time of the grandchild event<br /> <br /> [event]# great-grandchild<br /> name=turn 5<br /> {DEBUG_MSG $turn_number}# output: 2 - value from the variable substitution at execution time of the parent event,<br /> # caused by delayed=no in the child event<br /> <br /> {DEBUG_MSG $||turn_number}# output: &quot;$turn_number&quot;<br /> # Each variable substitution transforms a &quot;$|&quot; to a &quot;$&quot; (except when no | left).<br /> <br /> {DEBUG_MSG $|turn_number}# output: 5 - from the variable substitution at execution time<br /> # of the great-grandchild event<br /> [/event]<br /> [/event]<br /> [/event]<br /> [/event]<br /> <br /> == See Also ==<br /> <br /> * [[DirectActionsWML]]<br /> * [[InternalActionsWML]]<br /> * [[InterfaceActionsWML]]<br /> * [[FilterWML]]<br /> * [[ReferenceWML]]<br /> <br /> <br /> [[Category: WML Reference]]</div>

Gambit https://wiki.wesnoth.org/index.php?title=EventWML&diff=37997 2010-08-20T23:11:54Z

<p>Gambit: /* Predefined 'name' Key Values */ added information on side turn X and turn X refresh events.</p> <hr /> <div>{{WML Tags}}<br /> == The [event] Tag ==<br /> <br /> This tag is a subtag of the [scenario], [unit_type] and [era] tags which is used to describe a set of actions which trigger at a certain point in a scenario. When used in a [scenario] tag (also includes [multiplayer], [tutorial] and [test]), the event only occurs in that scenario. When used in a [unit_type] tag, the event will occur in all scenarios in which a unit of that type appears in (only after such a unit appears during the scenario, however). When used in an [era], the event will occur in any scenario which is played using that era.<br /> <br /> This tag has keys and child tags that control when and if the event actions will be triggered. Most important of these is the '''name''' key. Without it, no error will be raised but the event will never fire. Therefore, from a practical standpoint, it can be considered mandatory. All of the others can be used or not and the event actions will fire either way.<br /> <br /> '''Lexicon side note:''' ''The word &quot;event&quot; in the [event] tag itself may be considered an abbreviation of the word &quot;event handler&quot; because it is technically not a game &quot;event&quot; but an event '''handler''' for the game events fired with the given 'name'. However, this distinction is usually unimportant in most discussions and the event handlers are therefore simply referred to as &quot;events&quot; in this documentation.''<br /> <br /> === The 'name' Key (Mandatory) ===<br /> <br /> Usage:<br /> name=&lt;value&gt;<br /> <br /> This key defines which game event or trigger your [event] tag will be handling. This 'name' key should not be confused with a descriptive comment; it is rather a precise value which must match the predefined game event's name to be valid.<br /> <br /> '''Lexicon side note:''' ''It is not uncommon to refer to these values as the 'trigger' for an event and, furthermore, to call an event by its 'trigger' name. For example, in an event containing '''name=moveto''', a person might refer to the event as a ''''moveto''' event' and/or refer to the ''''moveto''' trigger' in the event or even talk about the 'event trigger' when referring to the '''moveto''' value of the 'name' key in that event. Some or all of this usage can, in fact, be found throughout this page.''<br /> <br /> The '''name''' key can accept a list of comma separated values describing when the event will be triggered.* These values may be either predefined event types or custom event names not matching any predefined type.<br /> <br /> For example:<br /> <br /> name=attacker misses,defender misses<br /> <br /> ''* Note that unless you use [[#first_time_only|first_time_only=no]], the event will fire only once, '''not''' once for each listed type.''<br /> <br /> ==== Predefined 'name' Key Values ====<br /> <br /> All predefined event types are listed here along with a description of when this value will cause the event to be triggered. Any value ''not'' listed here is a custom event name which can be triggered only by a '''[fire_event]''' tag somewhere else. Spaces in event names can be interchanged with underscores (for example, '''name=new turn''' and '''name=new_turn''' are equivalent).<br /> <br /> ; preload<br /> : Triggers before a scenario 'prestarts' and when loading a savegame -- before anything is shown on the screen at all. Can be used to set up the [[LuaWML|Lua]] environment: loading libraries, defining helper functions, etc.<br /> : '''Note:''' Unlike prestart and start, the preload event '''must be able to fire more than once!''' This is because it is triggered each time a savegame is loaded in addition to the initial time when it loads before the scenario 'prestart'. This means that it is effectively ''mandatory'' to have the [[#first_time_only|first_time_only=no]] key value in a preload event. <br /> <br /> ; prestart<br /> : Triggers before a scenario 'starts' -- before anything is shown on the screen at all. Can be used to set up things like village ownership. For things displayed on-screen such as character dialog, use '''start''' instead.<br /> : '''Note:''' ''This value makes the [[#first_time_only|first_time_only]] key irrelevant since, by definition, it can only fire once.''<br /> <br /> ; start<br /> : Triggers after the map is shown but before the scenario begins -- before players can 'do' anything.<br /> : '''Note:''' ''This value makes the [[#first_time_only|first_time_only]] key irrelevant since, by definition, it can only fire once.''<br /> <br /> ; new turn<br /> : Triggers at the start of every turn (not side turn). See also [[#first_time_only|first_time_only=no]]. Before any events of this type trigger, the value of the WML variable '''turn_number''' is set to the number of the turn that is beginning.<br /> <br /> ; side turn<br /> : Triggers when a side is about to start its turn. Before events of this type trigger, the value of the WML variable '''side_number''' is set to the number of the side of the player about to take their turn. This is before any healing takes place for that side, before calculating income, and before restoring unit movement and status.<br /> <br /> ; ai turn<br /> : Triggered just before the AI is invoked for a side. This is called after ''side turn'', and thus the WML variable '''side_number''' still holds the number of this side. Note that this event might be called several times per turn in case that fallbacks to human or droiding is involved. I.e. it happens at the middle of turn of human side 1 if the human player droids his side. It happens after the selection of ai to play the turn but before AI is told that new turn has come.<br /> : '''Note:''' ''This event currently breaks replays since it is not explicitly saved in a replay and there is no AI involved in replays...''<br /> <br /> ; turn refresh<br /> : Like '''side turn''', triggers just before a side is taking control but '''after''' healing, calculating income, and restoring unit movement and status.<br /> <br /> ; turn ''X''<br /> : Triggers at the start of turn ''X''. It's the first side initialization event. Side initialization events go in the order of: <br /> : 1) '''turn ''X''''' <br /> :2) '''new turn''' <br /> :3) '''side turn''' <br /> :4) '''side ''X'' turn''' <br /> :5) '''side turn ''X''''' <br /> :6) '''side ''X'' turn ''Y''''' <br /> :7) '''turn refresh''' <br /> :8) '''side ''X'' turn refresh''' <br /> :9) '''turn ''X'' refresh''' <br /> :10) '''side ''X'' turn ''Y'' refresh'''<br /> <br /> ; side ''X'' turn ''Y''<br /> : This event triggers at the start of turn ''Y'' of side X {{DevFeature}}<br /> <br /> ; side ''X'' turn<br /> : This event triggers at the start of any turn of side X {{DevFeature}}<br /> : '''Note:''' ''Of course, [[#first_time_only|first_time_only=no]] is needed for this event to be triggered more than once.''<br /> <br /> ; side turn ''X''<br /> : This event triggers at the start of any side on turn X {{DevFeature1.9}}<br /> : '''Note:''' ''Of course, [[#first_time_only|first_time_only=no]] is needed for this event to be triggered more than once.''<br /> <br /> ; side X turn Y refresh<br /> : This event triggers at the turn refresh for side X on turn Y {{DevFeature1.9}}<br /> <br /> ; side ''X'' turn refresh<br /> : This event triggers at the turn refresh for side X {{DevFeature1.9}}<br /> : '''Note:''' ''Of course, [[#first_time_only|first_time_only=no]] is needed for this event to be triggered more than once.''<br /> <br /> ; turn ''X'' refresh<br /> : This event triggers for any side at the refresh of turn X. {{DevFeature1.9}}<br /> : '''Note:''' ''Of course, [[#first_time_only|first_time_only=no]] is needed for this event to be triggered more than once.''<br /> <br /> ; time over<br /> : Triggers on turn ''turns''. (''turns'' is specified in [scenario])<br /> <br /> ; enemies defeated<br /> : Triggers when all units with '''canrecruit=yes''' (that is, all leaders) not allied with side 1 are killed.<br /> <br /> ; victory<br /> : In this scenario, any tag of the form '''[endlevel] result=victory [/endlevel]''' will be automatically preceded by all actions in this tag. It helps debugging if the victory event allows you to safely advance to any of the possible next maps after using the &quot;:n&quot; command. Scenarios where key units are picked up before the victory, or where some action chosen earlier determines which map to advance to, make it hard to quickly test scenarios in a campaign. (See also: [endlevel], [[DirectActionsWML]])<br /> <br /> ; defeat<br /> : In this scenario, any tag of the form '''[endlevel] result=defeat [/endlevel]''' will be automatically preceded by all actions in this tag. (See also [endlevel], [[DirectActionsWML]])<br /> <br /> <br /> Filters can be applied to the following event triggers (see [[FilterWML]]; see also below). The actions specified in the event tag will be executed only if the filter returns true. <br /> These event triggers are all actions by units ('''moveto''', '''attack''') or things that happen to units ('''recruit''', '''advance'''). When one of these events is triggered, the position of the active unit (referred to as the '''primary unit''') is stored in the variables '''x1''' and '''y1''' and the position of any unit that primary unit does something to is stored in the variables '''x2''' and '''y2''' (this unit is referred to as the '''secondary unit''' below). '' These units are also automatically stored in the variables 'unit' and 'second_unit' as if they had been stored using the '''[store_unit]''' tag. see [[SingleUnitWML]]<br /> <br /> ; moveto<br /> : Triggers after the primary unit moves. Typically this is used when the primary unit gets to a particular location and a filter for the location of the primary unit is included; remember that this is the location that the primary unit lands on, not the location it started on or any location it travels on.&lt;br /&gt;''An '''[allow_undo]''' tag anywhere within a moveto event will cancel any lack of undo functionality the event would have caused. Note that undo functionality will only move the unit back to its former location; it will not undo other changes to the game caused by the event. Thus it is up to the scenario designer to use this tag correctly.'' {{DevFeature}} $x2 and $y2 refer to the hex the unit came from.<br /> <br /> ; sighted<br /> : Triggers when the primary unit becomes visible to the secondary unit in particular after not being visible to the secondary unit's side (so if the secondary unit's side doesn't have shroud or fog, the event never triggers). This happens both when the primary unit moves into view during its turn, and when the secondary unit moves to a location where it can see the primary unit. (This editor hasn't tested whether the event triggers multiple times if the primary unit moves into view of multiple units at once, or if not, which one gets chosen to be the secondary unit here.) (Note: it appears that when a sighted event is triggered because an enemy unit moves into your field of view, the game engine cannot determine which unit (on your side) sees the unit that moved, and so it fires a ''name=sighted'' event without setting ''$second_unit''. This means that, for example, using ''speaker=second_unit'' inside a message tag may fail.) (Double note: it also appears that the sighted event in more recent versions of the game (1.6 and 1.7, maybe?) does not fire on enemy turns. That is, it only fires for units that become visible as a result of the motion of another unit, not for units that move into the vision of an enemy. This event is also buggy in general... it's usually better to use a moveto event with a [filter_vision] tag than to use a sighted event (and note that the combination of the two can achieve something like the old sighted event)).<br /> <br /> ; attack<br /> : Triggers when the primary unit attacks the secondary unit.<br /> <br /> ; attack end<br /> : Similar to '''attack''', but is triggered ''after'' the fight instead of before. Note that if either unit is killed during the fight, this event triggers before any '''die''' events.<br /> <br /> ; attacker hits<br /> : Triggers when the the primary unit (the attacker) hits the secondary unit (the defender). The value of the WML variable '''damage_inflicted''' is set to the number of hitpoints inflicted by the attacker.<br /> <br /> ; attacker misses<br /> : Same as ''attacker hits'', but is triggered when the attacker misses.<br /> <br /> ; defender hits<br /> : Triggers when the primary unit (the attacker) is hit in retaliation by the secondary unit (the defender). The value of the WML variable '''damage_inflicted''' is set to the number of hitpoints inflicted by the defender.<br /> <br /> ; defender misses<br /> : Same as ''defender hits'', but is triggered when the defender misses.<br /> <br /> ; stone<br /> : Triggers when the primary unit is hit by an attack with the 'stones' ability (See ''stones'', [[AbilitiesWML]]) by the secondary unit (the unit with the 'stones' ability). In {{DevFeature}}, this event name is changed to &quot;petrified&quot;.<br /> <br /> ; last breath<br /> : Triggers when the primary unit is killed by the secondary unit, but before the death animation is triggered. Use this instead of name=die when you want the primary unit to make a final [message]. <br /> <br /> ; die<br /> : Triggers when the primary unit is killed by the secondary unit. ''Note: The primary unit is not removed from the game until the end of this event. The primary unit can still be manipulated, will block other units from taking its hex, and will still be found by standard unit filters (except [have_unit]). To prevent this behavior, you can use [kill] to remove the unit immediately. However, this will stop any (still unfired) other events that also match the unit from firing afterwards, so use with caution.'' If you want to the primary unit to make a final [message], use name=last_breath, see above.<br /> <br /> ; capture<br /> : Triggers when the primary unit captures a village. The village may have been previously neutral, or previously owned by another side; merely moving into your own villages does not constitute a capture.<br /> <br /> ; recruit<br /> : Triggers when the primary unit is recruited. (That is, when a unit is recruited it will trigger this event and this event's filter will filter that unit.).<br /> <br /> ; prerecruit<br /> : Triggers when the primary unit is recruited but before it is displayed.<br /> <br /> ; recall<br /> : Triggers after a unit is recalled.<br /> <br /> ; prerecall<br /> : Triggers when a unit is recalled but before it is displayed.<br /> <br /> ; advance<br /> : Triggers just before the primary unit is going to advance to another unit.<br /> <br /> ; post advance<br /> : Triggers just after the primary unit has advanced to another unit.<br /> <br /> ; select<br /> : Triggers when the primary unit is selected. Also triggers when ending a move, as the game keeps the moving unit selected by selecting it again at the end of movement. ''Note: in networked multiplayer, these events are only executed by the client on which the event is triggered, leading to out of sync errors if you modify the game state in the event.''<br /> <br /> ; menu item ''X''<br /> : Triggers when a WML menu item with id=''X'' is selected. ''Note: if the menu item has a [command], this event may be executed before or after the command; there is no guarantee.''<br /> <br /> ==== Custom events ====<br /> <br /> An event with a custom name may be invoked using the [[InternalActionsWML#.5Bfire_event.5D|[fire_event]]] tag. Normally you'll use such custom events as named subroutines to be called by events with predefined types. One common case of this, for example, is that more than one '''sighted''' events might fire the same custom event that changes the scenario objectives.<br /> <br /> === Optional Keys and Tags ===<br /> <br /> These keys and tags are more complex ways to filter when an event should trigger:<br /> <br /> ==== first_time_only ====<br /> : Whether the event should be removed from the scenario after it is triggered. This key takes a [[ConditionalActionsWML#Boolean_Values|boolean]]; for example:<br /> : ''first_time_only=yes''<br /> :: Default behavior if key is omitted. The event will trigger the first time it can and never again.<br /> : ''first_time_only=no''<br /> :: The event will trigger every time the criteria are met instead of only the first time.<br /> <br /> ==== [filter] ====<br /> : The event will only trigger if the primary unit matches this filter.<br /> :* [[StandardUnitFilter]]: selection criteria<br /> <br /> ==== [filter_second] ====<br /> : Like [filter], but for the secondary unit.<br /> :* [[StandardUnitFilter]]: selection criteria<br /> <br /> ==== [filter_attack] ====<br /> : Can be used to set additional filtering criteria for the primary unit and the secondary unit that are not generally available in a standard unit filter. Can be used in events ''attack'', ''attacker hits'', ''attacker misses'', ''defender hits'', ''defender misses'' and ''attack end''. For more information and other filter keys, see [[FilterWML]].<br /> :* '''name''': the name of the weapon used.<br /> :* '''range''': the range of the weapon used.<br /> :* '''special''': filter on the attack's special power.<br /> <br /> ==== [filter_second_attack] ====<br /> : Like [filter_attack], but for the secondary unit.<br /> :* '''name''': the name of the weapon used.<br /> :* '''range''': the range of the weapon used.<br /> :* '''special''': filter on the attack's special power.<br /> <br /> ==== [event] ====<br /> : A special case 'action', the [event] tag may be used to create a [[#Nested Events|nested event]].<br /> <br /> ==== delayed_variable_substitution ====<br /> : This key is only relevant inside of a [[#Delayed Variable Substitution|nested event]] and controls when variable substitution will occur in those special case actions.<br /> <br /> === Actions triggered by [event] ===<br /> <br /> After the trigger conditions have been met, all action tags within the [event] tag are executed in the order they are written in.<br /> <br /> There are 3 main types of actions:<br /> * direct actions ([[DirectActionsWML]]) which have a direct effect on gameplay<br /> * display actions ([[InterfaceActionsWML]]) which show something to the user<br /> * internal actions ([[InternalActionsWML]]) which are used by WML internally<br /> <br /> Several actions use standard filters to find out which units<br /> to execute the command on. These are denoted by the phrases<br /> &quot;standard unit filter&quot; and &quot;standard location filter&quot;.<br /> <br /> === Nested Events ===<br /> <br /> There is one special type of action: event creation. By placing an '''[event]''' tag inside another '''[event]''' tag, the nested event is spawned (created) when the parent (outer) event is encountered (when executing the contents of the parent event).<br /> <br /> ([[#Nested Event Example|See Examples]])<br /> <br /> ==== Delayed Variable Substitution ====<br /> <br /> Variable substitution for a nested event can happen either when it is spawned by the parent event or when it is triggered itself. This is controlled with the key '''delayed_variable_substitution''' which is used in the nested event.<br /> <br /> If this key is set to ''yes'', the variables in the nested event will contain values from the turn in which the ''nested'' event was triggered. ''This is the default behavior if the key is omitted.'' If set to ''no'', the variables in the nested event are set at the time the ''parent'' event is triggered.<br /> <br /> This behavior can be fine tuned with a special syntax when referencing variables. Instead of the normal '''$variable''' syntax, use '''$|variable''' to cause a variable to contain values relevant to the turn in which the nested event was triggered even when '''delayed_variable_substitution''' is set to ''no''. In this way you can have a mix of variables relevant to the parent and nested event trigger times.<br /> <br /> ([[#Delayed Variable Substitution Example|See Examples]])<br /> <br /> == Multiplayer safety ==<br /> <br /> In multiplayer it is only safe to use WML that might require synchronization with other players because of input or random numbers (like [message] with input or options or [unstore_unit] where a unit might advance) in the following events. This is because in these cases WML needs data from other players to work right and/or do the same thing for all players. This data is only available after a network synchronization.<br /> <br /> List of synchronized events:<br /> * moveto<br /> * sighted <br /> * attack<br /> * attack_end <br /> * attacker hits <br /> * attacker misses <br /> * defender hits<br /> * defender misses <br /> * stone<br /> * last breath <br /> * menu item X<br /> * die<br /> * capture <br /> * recruit<br /> * prerecruit <br /> * recall <br /> * prerecall <br /> * advance <br /> * post_advance <br /> getting message options (etc) from the following events is not synchronized, except in the development version (1.9+svn):<br /> * new turn <br /> * side turn <br /> * turn X <br /> * side X turn <br /> * side X turn Y <br /> * turn refresh <br /> <br /> There is also the possibility of events that are normally synchronized when fired by the engine but can be non-synchronized when fired by WML tags from non-synchronized event. So when you are using them you must be extra careful. For example [unstore_unit] may trigger a unit advancement that will fire ''advance'' and ''post advance'' events.<br /> <br /> == A Trap for the Unwary ==<br /> <br /> It is perfectly possible (and, in fact, useful) to have multiple events with the same predefined name and thus the same trigger condition. However, it is not defined what order such events will fire in, so you need to code so the order <br /> will not matter.<br /> <br /> Because of the above, you need to beware of using macros to generate events. If you include a macro expanding to an event definition twice, the event will be executed twice (not once) each time the trigger condition fires. Consider this code:<br /> <br /> #define DOUBLE<br /> [event]<br /> name=multiply_by_2<br /> {VARIABLE_OP 2_becomes_4 multiply 2}<br /> [/event]<br /> #enddef<br /> <br /> {DOUBLE}<br /> {DOUBLE}<br /> <br /> {VARIABLE 2_becomes_4 2}<br /> <br /> [fire_event]<br /> name=multiply_by_2<br /> [/fire_event]<br /> <br /> {DEBUG_MSG &quot;$2_becomes_4 should be 4&quot;}<br /> <br /> After it executes, the debug message will reveal that the variable has been set to 8, not 4.<br /> <br /> == Miscellaneous Notes and Examples ==<br /> <br /> === Primary/Secondary Unit Speaker Example ===<br /> <br /> In events, the primary unit can be referred to as '''unit''' and the secondary unit can be referred to as '''second_unit''' in [message] tags using the '''speaker''' key. For example:<br /> <br /> [event]<br /> name=die<br /> [message]<br /> speaker='''second_unit'''<br /> message= _ &quot;Hahaha! I finally killed you!&quot;<br /> [/message]<br /> <br /> [message]<br /> speaker='''unit'''<br /> message= _ &quot;It's not over yet! I'll come back to haunt you!&quot;<br /> [/message]<br /> [/event]<br /> <br /> === Nested Event Example ===<br /> <br /> An event is created for a portal that opens on turn 10. The parent (or 'outer') event executes on turn 10 at which point the nested moveto event is created. This nested event executes when a player steps on a certain spot.<br /> <br /> [event]<br /> name=turn 10<br /> <br /> [event]<br /> name=moveto<br /> <br /> [filter]<br /> x,y=5,8<br /> [/filter]<br /> <br /> # moving to 5,8 will trigger this event only on turn 10 and after<br /> [/event]<br /> [/event]<br /> <br /> An equivalent way of doing this would be to create a single moveto event with an '''[if]''' statement to check for turn number but using nested '''[event]''' tags is a convenient shortcut to accomplish this task without resorting to '''[if]''' statements.<br /> <br /> === Delayed Variable Substitution Example ===<br /> <br /> This code will display a message showing the turn number on which the nested ''moveto'' event happens.<br /> <br /> [event]<br /> name=turn 10<br /> <br /> [event]<br /> name=moveto<br /> delayed_variable_substitution=yes<br /> <br /> [filter]<br /> x,y=5,8<br /> [/filter]<br /> <br /> {DEBUG_MSG &quot;Turn $turn_number&quot;} <br /> [/event]<br /> [/event]<br /> <br /> Since this is the default behavior for the '''delayed_variable_substitution''' key, the following example is identical.<br /> <br /> [event]<br /> name=turn 10<br /> <br /> [event]<br /> name=moveto<br /> <br /> [filter]<br /> x,y=5,8<br /> [/filter]<br /> <br /> {DEBUG_MSG &quot;Turn $turn_number&quot;} <br /> [/event]<br /> [/event]<br /> <br /> The following code will always display &quot;Turn 10&quot; when the nested ''moveto'' event happens. This is because the variable substitution is done when the parent event is triggered and spawns the nested event, ''not'' when the nested event is triggered.<br /> <br /> [event]<br /> name=turn 10<br /> <br /> [event]<br /> name=moveto<br /> delayed_variable_substitution=no<br /> <br /> [filter]<br /> x,y=5,8<br /> [/filter]<br /> <br /> {DEBUG_MSG &quot;Turn $turn_number&quot;} <br /> [/event]<br /> [/event]<br /> <br /> Finally, the following example is identical to the first two in that it will display a message showing the turn number on which the nested ''moveto'' event happens, despite the fact that the '''delayed_variable_substitution''' key is set to ''no''. This is because the special '''$|variable''' syntax is used.<br /> <br /> [event]<br /> name=turn 10<br /> <br /> [event]<br /> name=moveto<br /> delayed_variable_substitution=no<br /> <br /> [filter]<br /> x,y=5,8<br /> [/filter]<br /> <br /> {DEBUG_MSG &quot;Turn $|turn_number&quot;} <br /> [/event]<br /> [/event]<br /> <br /> === Multiple Nested Events ===<br /> <br /> Every delayed_variable_substitution=no causes a variable substitution run on the subevent where it occurs at the spawn time of this event and on all following subevents. For any specific event, variable substitution happens at least one time when the event is executed. For each delayed=no key appearing in itself or in an event of an &quot;older&quot; generation, which is not the toplevel event, an additional variable substitution run is made.<br /> [event]# parent<br /> name=turn 2<br /> #delayed_variable_substitution=no # In the parent event, delayed= has no effect.<br /> <br /> [event]# child<br /> name=turn 3<br /> delayed_variable_substitution=no # Causes variable substitution in the child, grandchild and great-grandchild event<br /> # at execution time of the parent event = spawn time of the child event.<br /> <br /> [event]# grandchild<br /> name=turn 4<br /> delayed_variable_substitution=yes # no variable substitution in the grandchild and great-grandchild event<br /> # at execution time of the child event = spawn time of the grandchild event<br /> <br /> [event]# great-grandchild<br /> name=turn 5<br /> {DEBUG_MSG $turn_number}# output: 2 - value from the variable substitution at execution time of the parent event,<br /> # caused by delayed=no in the child event<br /> <br /> {DEBUG_MSG $||turn_number}# output: &quot;$turn_number&quot;<br /> # Each variable substitution transforms a &quot;$|&quot; to a &quot;$&quot; (except when no | left).<br /> <br /> {DEBUG_MSG $|turn_number}# output: 5 - from the variable substitution at execution time<br /> # of the great-grandchild event<br /> [/event]<br /> [/event]<br /> [/event]<br /> [/event]<br /> <br /> == See Also ==<br /> <br /> * [[DirectActionsWML]]<br /> * [[InternalActionsWML]]<br /> * [[InterfaceActionsWML]]<br /> * [[FilterWML]]<br /> * [[ReferenceWML]]<br /> <br /> <br /> [[Category: WML Reference]]</div>

Gambit https://wiki.wesnoth.org/index.php?title=MultiplayerServers&diff=37734 2010-07-29T15:11:21Z

<p>Gambit: Formatting on my last edit, because I forgot how wikis work.</p> <hr /> <div>The game server runs on TCP port 15000 by default.<br /> <br /> == Public Official servers ==<br /> ; server.wesnoth.org : accepts up-to-date trunk SVN versions and redirects other clients to the appropriate server according to their version, runs on the default port 15000<br /> <br /> *Connecting on port 14998 gives the current stable version.<br /> *Connecting on port 14999 gives the previous stable version.<br /> *Connecting on port 15000 gives the current development version.<br /> <br /> To connect to a specific port choose &quot;Connect to Server&quot; in the multi-player options list and enter &quot;server.wesnoth.org:#####&quot; where the number signs are the port number.<br /> <br /> '''Alternate servers:'''<br /> ; server2.wesnoth.org aka gonzo.dicp.de : accepts up-to-date trunk SVN versions and redirects other clients to the appropriate server according to their version, runs on the default port 15000<br /> <br /> ; server3.wesnoth.org aka basilic.tuxfamily.org : accepts up-to-date trunk SVN versions and redirects other clients to the appropriate server according to their version, runs on the default port 15000<br /> <br /> Usually supported versions include: the current stable release, the old stable release, the current development release, the previous development release (runs only periodically in the transition phase between releases)<br /> <br /> == Alternate servers setup by users ==<br /> ; wesnoth.geeknode.org : v1.2 dedicated server ([irc://irc.geeknode.org#wesnoth #wesnoth])<br /> ; icestation.homeunix.org : Yet another mirror of the official server, located in Russia. Accepts latest development version on port 15000.<br /> ; &lt;nowiki&gt;alliance25.hd.free.fr:15000&lt;/nowiki&gt; : Another server, located in France. Accepts latest development version of the game on port 15000.<br /> ; &lt;nowiki&gt;games.kingshomeworld.com:15000&lt;/nowiki&gt; : Server hosted by K.I.M CHAT in Canada. We welcome beginners. Accepts latest stable Current Version release on default port 15000<br /> ; &lt;nowiki&gt;allfex.org:15000&lt;/nowiki&gt; : Just another server, located in germany. Everyone is welcome. All versions are accepted.<br /> ; &lt;nowiki&gt;game.chillat.net:15000&lt;/nowiki&gt; : Server hosted by Chillat.net in Sweden, running v1.6. ([http://forums.chillat.net/forum/wesnoth Chillat.net Wesnoth Forum])<br /> ; &lt;nowiki&gt;foss.uoa.gr:15000&lt;/nowiki&gt; : Server hosted by the Greek FOSS community at the University of Athens, running v1.6.5 (FreeBSD). ([http://foss.uoa.gr/forum/ FOSS-UoA Forum])<br /> ; &lt;nowiki&gt;vending-machine.game-server.cc:15000&lt;/nowiki&gt; : U.S. West - Any and all players welcome.<br /> <br /> == Debian Servers ==<br /> Please note that the terms ''Stable'' and ''Testing version'' refers to the Debian distribution, not wesnoth itself. Please check http://packages.debian.org/wesnoth if you are unsure what wesnoth versions they currently refer to.<br /> <br /> === Stable version ===<br /> ; &lt;nowiki&gt;www.salokine.org&lt;/nowiki&gt; : Lenny version (Contact [[User:Salokine|Salokine]])<br /> <br /> [[Category:Playing Wesnoth]]</div>

Gambit https://wiki.wesnoth.org/index.php?title=MultiplayerServers&diff=37733 2010-07-29T15:09:42Z

<p>Gambit: /* Public Official servers */ added information on connecting to other versions of wesnoth's servers</p> <hr /> <div>The game server runs on TCP port 15000 by default.<br /> <br /> == Public Official servers ==<br /> ; server.wesnoth.org : accepts up-to-date trunk SVN versions and redirects other clients to the appropriate server according to their version, runs on the default port 15000<br /> <br /> Connecting on port 14998 gives the current stable version.<br /> Connecting on port 14999 gives the previous stable version.<br /> Connecting on port 15000 gives the current development version.<br /> <br /> To connect to a specific port choose &quot;Connect to Server&quot; in the multi-player options list and enter &quot;server.wesnoth.org:#####&quot; where the number signs are the port number.<br /> <br /> '''Alternate servers:'''<br /> ; server2.wesnoth.org aka gonzo.dicp.de : accepts up-to-date trunk SVN versions and redirects other clients to the appropriate server according to their version, runs on the default port 15000<br /> <br /> ; server3.wesnoth.org aka basilic.tuxfamily.org : accepts up-to-date trunk SVN versions and redirects other clients to the appropriate server according to their version, runs on the default port 15000<br /> <br /> Usually supported versions include: the current stable release, the old stable release, the current development release, the previous development release (runs only periodically in the transition phase between releases)<br /> <br /> == Alternate servers setup by users ==<br /> ; wesnoth.geeknode.org : v1.2 dedicated server ([irc://irc.geeknode.org#wesnoth #wesnoth])<br /> ; icestation.homeunix.org : Yet another mirror of the official server, located in Russia. Accepts latest development version on port 15000.<br /> ; &lt;nowiki&gt;alliance25.hd.free.fr:15000&lt;/nowiki&gt; : Another server, located in France. Accepts latest development version of the game on port 15000.<br /> ; &lt;nowiki&gt;games.kingshomeworld.com:15000&lt;/nowiki&gt; : Server hosted by K.I.M CHAT in Canada. We welcome beginners. Accepts latest stable Current Version release on default port 15000<br /> ; &lt;nowiki&gt;allfex.org:15000&lt;/nowiki&gt; : Just another server, located in germany. Everyone is welcome. All versions are accepted.<br /> ; &lt;nowiki&gt;game.chillat.net:15000&lt;/nowiki&gt; : Server hosted by Chillat.net in Sweden, running v1.6. ([http://forums.chillat.net/forum/wesnoth Chillat.net Wesnoth Forum])<br /> ; &lt;nowiki&gt;foss.uoa.gr:15000&lt;/nowiki&gt; : Server hosted by the Greek FOSS community at the University of Athens, running v1.6.5 (FreeBSD). ([http://foss.uoa.gr/forum/ FOSS-UoA Forum])<br /> ; &lt;nowiki&gt;vending-machine.game-server.cc:15000&lt;/nowiki&gt; : U.S. West - Any and all players welcome.<br /> <br /> == Debian Servers ==<br /> Please note that the terms ''Stable'' and ''Testing version'' refers to the Debian distribution, not wesnoth itself. Please check http://packages.debian.org/wesnoth if you are unsure what wesnoth versions they currently refer to.<br /> <br /> === Stable version ===<br /> ; &lt;nowiki&gt;www.salokine.org&lt;/nowiki&gt; : Lenny version (Contact [[User:Salokine|Salokine]])<br /> <br /> [[Category:Playing Wesnoth]]</div>

Gambit https://wiki.wesnoth.org/index.php?title=ConditionalActionsWML&diff=36828 2010-06-23T15:51:57Z

<p>Gambit: /* [switch] */ put my last edit on a new line so it's clear which part is development only.</p> <hr /> <div>{{WML Tags}}<br /> <br /> Conditional Actions WML is used to describe container actions that create branching and flow control for WML. The [[#Conditional Actions|conditional actions]] act as gatekeepers, encapsulating other actions with [[#Condition Tags|conditions]] which must be met before an action can take place. These conditional actions also contain the actions which will take place if those conditions are met and, in some cases, what actions will take place if they are ''not'' met.<br /> <br /> == Conditional Actions ==<br /> <br /> These actions describe actions that should be executed only if certain conditions are met.<br /> <br /> === [if] ===<br /> <br /> Executes actions only if the contained [[#Condition Tags|conditions]] are met.<br /> <br /> * [[#Condition Tags|Condition Tags]]: Conditions which must be met for the actions in the '''[then]''' tag to be executed.<br /> <br /> * '''[then]''': Contains [[:Category:ActionsWML|actions]] which should be executed if all conditions evaluate as true ''or'' if any single '''[or]''' tag evaluates as true.<br /> <br /> * '''[else]''': Contains [[:Category:ActionsWML|actions]] which should be executed if any condition evaluates as false ''and'' '''all''' of the '''[or]''' tags evaluate as false.<br /> <br /> === [switch] ===<br /> <br /> The '''[switch]''' tag is a special case because it does not use [[#Condition Tags|Condition Tags]] to control whether actions are performed. Instead, it executes different sets of actions based on the value of a variable.<br /> <br /> * '''variable''': The name of the variable to check.<br /> * '''[case]''': Case tag which forms a block containing:<br /> ** '''value''': The value to test the variable's value against. <br /> This can be a comma separated list of values. {{DevFeature1.9}}<br /> ** [[:Category:ActionsWML|Action WML]]: Action WML to execute if the variable matches the value. (The rest of the '''[case]''' block after the '''value''' attribute.)<br /> * '''[else]''': Else tag which forms a block of [[:Category:ActionsWML|Action WML]] to execute if no '''[case]''' block contains a '''value''' matching the value of the '''variable'''.<br /> <br /> Example usage:<br /> [switch]<br /> variable=foo<br /> [case]<br /> value=&quot;A&quot;<br /> ... WML if foo=A ...<br /> [/case]<br /> [case]<br /> value=&quot;B&quot;<br /> ... WML if foo=B ...<br /> [/case]<br /> [else]<br /> ... WML if not foo=A nor foo=B ...<br /> [/else]<br /> [/switch]<br /> <br /> === [while] ===<br /> <br /> Like the '''[if]''' tag, executes actions only if conditions described in the contained [[#Condition Tags|conditions]] are met. Additionally, the '''[while]''' tag ''continues'' to execute the actions until the contained [[#Condition Tags|conditions]] are no longer met. Executes a maximum of 1024 iterations per invocation.<br /> <br /> * [[#Condition Tags|Condition Tags]]: Conditions which must be met for the actions in the '''[do]''' tag to be executed.<br /> <br /> * '''[do]''': contains [[:Category:ActionsWML|actions]] that should be executed repeatedly until some condition is false.<br /> <br /> The '''[while]''' tag is useful for iterating over an array.<br /> An array is a list of values.<br /> The ''number''th value in the array '''array''' is stored in the WML variable '''''array''[number]'''.<br /> Note that if '''number''' is the value of the variable '''variable''',<br /> the expression '''$''array''[$variable]''' will return the ''number''th value in ''array''.<br /> <br /> ==== 'FOREACH' Macro ====<br /> This macro simplifies the use of a '''[while]''' tag to create a ''for-each'' iteration format. This is useful, for example, when you want to iterate over each row in a table. To use it, use the [http://www.wesnoth.org/macro-reference.xhtml#FOREACH FOREACH] and [http://www.wesnoth.org/macro-reference.xhtml#NEXT NEXT] macros.<br /> <br /> ==== 'REPEAT' Macro ====<br /> This macro simplifies the use of a '''[while]''' tag to execute the same [[:Category:ActionsWML|actions]] repeatedly for a specified number of times. To use it, use the [http://www.wesnoth.org/macro-reference.xhtml#REPEAT REPEAT] macro.<br /> <br /> === [command] ===<br /> <br /> This tag is more of an Unconditional Action: when it is encountered, the contents are simply executed once. In practice, this tag serves little purpose. However, it may be used to arrange actions together in logical groups, for example, with actions that are stored in an array and later inserted.<br /> <br /> == Condition Tags ==<br /> <br /> ===True Condition Tags===<br /> These tags describe conditions which must be met before an action can take place. Some or all of them are used in the various [[#Conditional Actions|Conditional Actions]].<br /> <br /> ; [have_unit]<br /> : A unit with greater than zero hit points matching this filter exists.<br /> :* [[StandardUnitFilter]] '''*''': Selection criteria. Do not use a [filter] tag.&lt;br /&gt;'''* Note:''' ''Does '''not''' check for matching units in the recall list!''<br /> :* '''count''': ''(Optional)'' If used, a number of units equal to the value must match the filter. Accepts a number, range, or comma separated range. If not used, the default value is &quot;1-99999&quot;.<br /> :* '''search_recall_list''': ''(Optional)'' If 'yes', search through recall list too. (Default is 'no') {{DevFeature1.9}}<br /> <br /> ; [have_location]<br /> : A location matching this filter exists.<br /> :* [[StandardLocationFilter]]: Selection criteria.<br /> :* '''count''': ''(Optional)'' If used, a number of locations equal to the value must match the filter. Accepts a number, range, or comma separated range. If not used, the default value is &quot;1-99999&quot;.<br /> <br /> ; [variable]<br /> : Test the value of a WML variable (see [[VariablesWML]]) against another value.<br /> :* '''name''': The name of the variable to test.<br /> :* ''&lt;comparison&gt;'': '''One''' of the following keys must be used to compare the value of the named variable, represented as ''$name'' below, against another value:<br /> :** '''contains''': ''$name'' contains this string value.<br /> :** '''equals''': ''$name'' is equal (string wise) to this value.<br /> :** '''not_equals''': ''$name'' is not equal (string wise) to this value.<br /> :** '''numerical_equals''': ''$name'' is equal (numerically) to this value. <br /> :** '''numerical_not_equals''': ''$name'' is not equal (numerically) to this value. '''*'''&lt;br /&gt;'''*''' Using equals is faster. The point of numerical_equals and boolean_equals is not performance, it's representation. For instance, &quot;1&quot; and &quot;1.0&quot; are not equal as strings but they are equal as numbers; and &quot;yes&quot; and &quot;on&quot; are not equal as strings but they are equal as booleans. (This also explains why equals is faster: it is a straightforward comparison that doesn't try to understand what you have written.)<br /> :** '''greater_than''': ''$name'' is greater than this value.<br /> :** '''greater_than_equal_to''': ''$name'' is greater than or equal to this value.<br /> :** '''less_than''': ''$name'' is less than this value.<br /> :** '''less_than_equal_to''': ''$name'' is less than or equal to this value.<br /> :** '''boolean_equals''': ''$name'' has an equivalent boolean value. '''*'''<br /> :** '''boolean_not_equals''': ''$name'' does not have an equivalent boolean value. '''*'''<br /> ====Boolean Values====<br /> '''*''' When values are evaluated as boolean values they are checked to see if they are ''false'' or ''true''.&lt;br /&gt;These values are evaluated as ''false'': '''no''', '''false''', '''off''', '''0''', and '''0.0''' (and &quot;'''uninitialized'''&quot;)&lt;br /&gt;These values are evaluated as ''true'': '''yes''', '''true''', '''on''', '''1''', and '''0.1''' (and any other non-zero number)<br /> <br /> === Meta Condition Tags ===<br /> <br /> These tags aren't really conditions, themselves. Instead they are wrapped around condition tags to group them into multiple conditions that must all be met, lists of conditions that only one must be met, or conditions that must not be met. These are handled in order in any combination you can think of. One important thing to remember is if you are using '''[or]''' tags, the first conditional statement should ''not'' have an '''[or]''' tag wrapped around it.<br /> <br /> ; [and]<br /> : A condition which must evaluate to true in addition to any others. Useful as a bracket for complex conditions, but not strictly necessary.<br /> :* [[#Condition Tags|Condition Tags]]: If these evaluate to true, the '''[and]''' tag evaluates to true.<br /> <br /> ; [or]<br /> : A condition which, if it evaluates to true, is all that is necessary for the conditions to be met. In other words, if all other conditions are false, but one '''[or]''' condition is true, the conditions have been met for an [[:Category:ActionsWML|action]] to take place. (See [[AdvancedConditionalWML|Example]])<br /> :* [[#Condition Tags|Condition Tags]]: If these evaluate to true, the '''[or]''' tag evaluates to true. <br /> <br /> ; [not]<br /> : A condition which reverses the evaluation of the contained condition(s).<br /> :* [[#Condition Tags|Condition Tags]]: If these evaluate to true, the '''[not]''' tag evaluates to false. If these evaluate to false, the '''[not]''' tag evaluates to true.<br /> <br /> == See Also ==<br /> * [[VariablesWML]]<br /> * [[InternalActionsWML]]<br /> * [[DirectActionsWML]]<br /> * [[InterfaceActionsWML]]<br /> * [[EventWML]]<br /> * [[ReferenceWML]]<br /> <br /> [[Category: WML Reference]]<br /> [[Category: ActionsWML]]</div>

Gambit https://wiki.wesnoth.org/index.php?title=ConditionalActionsWML&diff=36827 2010-06-23T15:50:29Z

<p>Gambit: /* [switch] */ added information about [case] taking lists now.</p> <hr /> <div>{{WML Tags}}<br /> <br /> Conditional Actions WML is used to describe container actions that create branching and flow control for WML. The [[#Conditional Actions|conditional actions]] act as gatekeepers, encapsulating other actions with [[#Condition Tags|conditions]] which must be met before an action can take place. These conditional actions also contain the actions which will take place if those conditions are met and, in some cases, what actions will take place if they are ''not'' met.<br /> <br /> == Conditional Actions ==<br /> <br /> These actions describe actions that should be executed only if certain conditions are met.<br /> <br /> === [if] ===<br /> <br /> Executes actions only if the contained [[#Condition Tags|conditions]] are met.<br /> <br /> * [[#Condition Tags|Condition Tags]]: Conditions which must be met for the actions in the '''[then]''' tag to be executed.<br /> <br /> * '''[then]''': Contains [[:Category:ActionsWML|actions]] which should be executed if all conditions evaluate as true ''or'' if any single '''[or]''' tag evaluates as true.<br /> <br /> * '''[else]''': Contains [[:Category:ActionsWML|actions]] which should be executed if any condition evaluates as false ''and'' '''all''' of the '''[or]''' tags evaluate as false.<br /> <br /> === [switch] ===<br /> <br /> The '''[switch]''' tag is a special case because it does not use [[#Condition Tags|Condition Tags]] to control whether actions are performed. Instead, it executes different sets of actions based on the value of a variable.<br /> <br /> * '''variable''': The name of the variable to check.<br /> * '''[case]''': Case tag which forms a block containing:<br /> ** '''value''': The value to test the variable's value against. This can be a comma separated list of values. {{DevFeature1.9}}<br /> ** [[:Category:ActionsWML|Action WML]]: Action WML to execute if the variable matches the value. (The rest of the '''[case]''' block after the '''value''' attribute.)<br /> * '''[else]''': Else tag which forms a block of [[:Category:ActionsWML|Action WML]] to execute if no '''[case]''' block contains a '''value''' matching the value of the '''variable'''.<br /> <br /> Example usage:<br /> [switch]<br /> variable=foo<br /> [case]<br /> value=&quot;A&quot;<br /> ... WML if foo=A ...<br /> [/case]<br /> [case]<br /> value=&quot;B&quot;<br /> ... WML if foo=B ...<br /> [/case]<br /> [else]<br /> ... WML if not foo=A nor foo=B ...<br /> [/else]<br /> [/switch]<br /> <br /> === [while] ===<br /> <br /> Like the '''[if]''' tag, executes actions only if conditions described in the contained [[#Condition Tags|conditions]] are met. Additionally, the '''[while]''' tag ''continues'' to execute the actions until the contained [[#Condition Tags|conditions]] are no longer met. Executes a maximum of 1024 iterations per invocation.<br /> <br /> * [[#Condition Tags|Condition Tags]]: Conditions which must be met for the actions in the '''[do]''' tag to be executed.<br /> <br /> * '''[do]''': contains [[:Category:ActionsWML|actions]] that should be executed repeatedly until some condition is false.<br /> <br /> The '''[while]''' tag is useful for iterating over an array.<br /> An array is a list of values.<br /> The ''number''th value in the array '''array''' is stored in the WML variable '''''array''[number]'''.<br /> Note that if '''number''' is the value of the variable '''variable''',<br /> the expression '''$''array''[$variable]''' will return the ''number''th value in ''array''.<br /> <br /> ==== 'FOREACH' Macro ====<br /> This macro simplifies the use of a '''[while]''' tag to create a ''for-each'' iteration format. This is useful, for example, when you want to iterate over each row in a table. To use it, use the [http://www.wesnoth.org/macro-reference.xhtml#FOREACH FOREACH] and [http://www.wesnoth.org/macro-reference.xhtml#NEXT NEXT] macros.<br /> <br /> ==== 'REPEAT' Macro ====<br /> This macro simplifies the use of a '''[while]''' tag to execute the same [[:Category:ActionsWML|actions]] repeatedly for a specified number of times. To use it, use the [http://www.wesnoth.org/macro-reference.xhtml#REPEAT REPEAT] macro.<br /> <br /> === [command] ===<br /> <br /> This tag is more of an Unconditional Action: when it is encountered, the contents are simply executed once. In practice, this tag serves little purpose. However, it may be used to arrange actions together in logical groups, for example, with actions that are stored in an array and later inserted.<br /> <br /> == Condition Tags ==<br /> <br /> ===True Condition Tags===<br /> These tags describe conditions which must be met before an action can take place. Some or all of them are used in the various [[#Conditional Actions|Conditional Actions]].<br /> <br /> ; [have_unit]<br /> : A unit with greater than zero hit points matching this filter exists.<br /> :* [[StandardUnitFilter]] '''*''': Selection criteria. Do not use a [filter] tag.&lt;br /&gt;'''* Note:''' ''Does '''not''' check for matching units in the recall list!''<br /> :* '''count''': ''(Optional)'' If used, a number of units equal to the value must match the filter. Accepts a number, range, or comma separated range. If not used, the default value is &quot;1-99999&quot;.<br /> :* '''search_recall_list''': ''(Optional)'' If 'yes', search through recall list too. (Default is 'no') {{DevFeature1.9}}<br /> <br /> ; [have_location]<br /> : A location matching this filter exists.<br /> :* [[StandardLocationFilter]]: Selection criteria.<br /> :* '''count''': ''(Optional)'' If used, a number of locations equal to the value must match the filter. Accepts a number, range, or comma separated range. If not used, the default value is &quot;1-99999&quot;.<br /> <br /> ; [variable]<br /> : Test the value of a WML variable (see [[VariablesWML]]) against another value.<br /> :* '''name''': The name of the variable to test.<br /> :* ''&lt;comparison&gt;'': '''One''' of the following keys must be used to compare the value of the named variable, represented as ''$name'' below, against another value:<br /> :** '''contains''': ''$name'' contains this string value.<br /> :** '''equals''': ''$name'' is equal (string wise) to this value.<br /> :** '''not_equals''': ''$name'' is not equal (string wise) to this value.<br /> :** '''numerical_equals''': ''$name'' is equal (numerically) to this value. <br /> :** '''numerical_not_equals''': ''$name'' is not equal (numerically) to this value. '''*'''&lt;br /&gt;'''*''' Using equals is faster. The point of numerical_equals and boolean_equals is not performance, it's representation. For instance, &quot;1&quot; and &quot;1.0&quot; are not equal as strings but they are equal as numbers; and &quot;yes&quot; and &quot;on&quot; are not equal as strings but they are equal as booleans. (This also explains why equals is faster: it is a straightforward comparison that doesn't try to understand what you have written.)<br /> :** '''greater_than''': ''$name'' is greater than this value.<br /> :** '''greater_than_equal_to''': ''$name'' is greater than or equal to this value.<br /> :** '''less_than''': ''$name'' is less than this value.<br /> :** '''less_than_equal_to''': ''$name'' is less than or equal to this value.<br /> :** '''boolean_equals''': ''$name'' has an equivalent boolean value. '''*'''<br /> :** '''boolean_not_equals''': ''$name'' does not have an equivalent boolean value. '''*'''<br /> ====Boolean Values====<br /> '''*''' When values are evaluated as boolean values they are checked to see if they are ''false'' or ''true''.&lt;br /&gt;These values are evaluated as ''false'': '''no''', '''false''', '''off''', '''0''', and '''0.0''' (and &quot;'''uninitialized'''&quot;)&lt;br /&gt;These values are evaluated as ''true'': '''yes''', '''true''', '''on''', '''1''', and '''0.1''' (and any other non-zero number)<br /> <br /> === Meta Condition Tags ===<br /> <br /> These tags aren't really conditions, themselves. Instead they are wrapped around condition tags to group them into multiple conditions that must all be met, lists of conditions that only one must be met, or conditions that must not be met. These are handled in order in any combination you can think of. One important thing to remember is if you are using '''[or]''' tags, the first conditional statement should ''not'' have an '''[or]''' tag wrapped around it.<br /> <br /> ; [and]<br /> : A condition which must evaluate to true in addition to any others. Useful as a bracket for complex conditions, but not strictly necessary.<br /> :* [[#Condition Tags|Condition Tags]]: If these evaluate to true, the '''[and]''' tag evaluates to true.<br /> <br /> ; [or]<br /> : A condition which, if it evaluates to true, is all that is necessary for the conditions to be met. In other words, if all other conditions are false, but one '''[or]''' condition is true, the conditions have been met for an [[:Category:ActionsWML|action]] to take place. (See [[AdvancedConditionalWML|Example]])<br /> :* [[#Condition Tags|Condition Tags]]: If these evaluate to true, the '''[or]''' tag evaluates to true. <br /> <br /> ; [not]<br /> : A condition which reverses the evaluation of the contained condition(s).<br /> :* [[#Condition Tags|Condition Tags]]: If these evaluate to true, the '''[not]''' tag evaluates to false. If these evaluate to false, the '''[not]''' tag evaluates to true.<br /> <br /> == See Also ==<br /> * [[VariablesWML]]<br /> * [[InternalActionsWML]]<br /> * [[DirectActionsWML]]<br /> * [[InterfaceActionsWML]]<br /> * [[EventWML]]<br /> * [[ReferenceWML]]<br /> <br /> [[Category: WML Reference]]<br /> [[Category: ActionsWML]]</div>

Gambit https://wiki.wesnoth.org/index.php?title=User:Gambit&diff=33537 2009-12-31T20:23:01Z

<p>Gambit: </p> <hr /> <div>==Forum Achievements==<br /> WIP for fun. Note that this is not a list of things that I personally have done. It is a list of things that could be done. It is much in the nature of the PS3 trophy system. A lot of these names are references to my favorite shows, games, movies, and books. <br /> <br /> Anyone may feel free to edit *this section* of my page to add achievements.<br /> <br /> {| border=&quot;1&quot;<br /> |<br /> =====TV On The Brain=====<br /> :Reference the same TV show 3 times in a thread.<br /> |-<br /> |<br /> =====It's A Trap!=====<br /> :Set up a joke over the course of at least three posts.<br /> |-<br /> |<br /> =====Track Switch=====<br /> :Derail a thread.<br /> |-<br /> |<br /> =====Deocide=====<br /> :Defeat Crushmaster in an Off-Topic debate.<br /> |-<br /> |<br /> =====Beast Slayer=====<br /> :Defeat Zarel in an Off-Topic debate.<br /> |-<br /> |<br /> =====Badge Outta Heck=====<br /> :Defeat Turuk in an Off-Topic debate.<br /> |-<br /> |<br /> =====Jake The Snake=====<br /> :Get &quot;quoted for truth&quot;.<br /> |-<br /> |<br /> =====Chatty=====<br /> :Have at least 1000 posts.<br /> |-<br /> |<br /> =====Noteworthy=====<br /> :Get quoted in someone else's signature.<br /> |-<br /> |<br /> =====Give A Man A Fish=====<br /> :Give someone the exact code they need in the WML Workshop.<br /> |-<br /> |<br /> =====Shadowmaster's Wrath=====<br /> :Use a bit of BB code contrary to its intended purpose.<br /> |-<br /> |<br /> =====Give A Man A Net=====<br /> :Help someone solve their problem in the WML Workshop without giving them an explicit answer.<br /> |-<br /> |}</div>

Gambit https://wiki.wesnoth.org/index.php?title=User:Gambit&diff=33536 2009-12-31T16:16:35Z

<p>Gambit: </p> <hr /> <div>==Forum Achievements==<br /> WIP for fun. Note that this is not a list of things that I personally have done. It is a list of things that could be done. It is much in the nature of the PS3 trophy system. A lot of these names are references to my favorite shows, games, movies, and books. <br /> <br /> Anyone may feel free to edit *this section* of my page to add achievements.<br /> <br /> {| border=&quot;1&quot;<br /> |<br /> =====TV On The Brain=====<br /> :Reference the same TV show 3 times in a thread.<br /> |-<br /> |<br /> =====It's A Trap!=====<br /> :Set up a joke over the course of at least three posts.<br /> |-<br /> |<br /> =====Track Switch=====<br /> :Derail a thread.<br /> |-<br /> |<br /> =====Deocide=====<br /> :Defeat Crushmaster in an Off-Topic debate.<br /> |-<br /> |<br /> =====Beast Slayer=====<br /> :Defeat Zarel in an Off-Topic debate.<br /> |-<br /> |<br /> =====Badge Outta Heck=====<br /> :Defeat Turuk in an Off-Topic debate.<br /> |-<br /> |<br /> =====No Fake=====<br /> :Get &quot;quoted for truth&quot;.<br /> |-<br /> |<br /> =====Chatty=====<br /> :Have at least 1000 posts.<br /> |-<br /> |<br /> =====Noteworthy=====<br /> :Get quoted in someone else's signature.<br /> |-<br /> |<br /> =====Give A Man A Fish=====<br /> :Give someone the exact code they need in the WML Workshop.<br /> |-<br /> |<br /> =====Shadowmaster's Wrath=====<br /> :Use a bit of BB code contrary to its intended purpose.<br /> |-<br /> |<br /> =====Give A Man A Net=====<br /> :Help someone solve their problem in the WML Workshop without giving them an explicit answer.<br /> |-<br /> |}</div>

Gambit https://wiki.wesnoth.org/index.php?title=User:Gambit&diff=33535 2009-12-31T16:14:04Z

<p>Gambit: </p> <hr /> <div>==Forum Achievements==<br /> WIP for fun. Note that this is not a list of things that I personally have done. It is a list of things that could be done. It is much in the nature of the PS3 trophy system. A lot of these names are references to my favorite shows, games, movies, and books. <br /> <br /> Anyone may feel free to edit *this section* of my page to add achievements.<br /> <br /> {| border=&quot;1&quot;<br /> |<br /> =====TV On The Brain=====<br /> :Reference the same TV show 3 times in a thread.<br /> |-<br /> |<br /> =====It's A Trap!=====<br /> :Set up a joke over the course of at least three posts.<br /> |-<br /> |<br /> =====Track Switch=====<br /> :Derail a thread.<br /> |-<br /> |<br /> =====Deocide=====<br /> :Defeat Crushmaster in an Off-Topic debate.<br /> |-<br /> |<br /> =====Beast Slayer=====<br /> :Defeat Zarel in an Off-Topic debate.<br /> |-<br /> |<br /> =====Badge Outta Heck=====<br /> :Defeat Turuk in an Off-Topic debate.<br /> |-<br /> |<br /> =====No Fake=====<br /> :Get &quot;quoted for truth&quot;.<br /> |-<br /> |<br /> =====Chatty=====<br /> :Have at least 1000 posts.<br /> |-<br /> |<br /> =====Noteworthy=====<br /> :Get quoted in someone else's signature.<br /> |-<br /> |<br /> =====Give A Man A Fish=====<br /> :Give someone the exact code they need in the WML workshop.<br /> |-<br /> |<br /> =====Shadowmaster's Wrath=====<br /> :Use a bit of BB code contrary to its intended purpose.<br /> |-<br /> |}</div>

Gambit https://wiki.wesnoth.org/index.php?title=User:Gambit&diff=33534 2009-12-31T00:48:40Z

<p>Gambit: </p> <hr /> <div>==Forum Achievements==<br /> WIP for fun. Note that this is not a list of things that I personally have done. It is a list of things that could be done. It is much in the nature of the PS3 trophy system. A lot of these names are references to my favorite shows, games, movies, and books. <br /> <br /> Anyone may feel free to edit *this section* of my page to add achievements.<br /> <br /> {| border=&quot;1&quot;<br /> |<br /> =====TV On The Brain=====<br /> :Reference the same TV show 3 times in a thread.<br /> |-<br /> |<br /> =====It's A Trap!=====<br /> :Set up a joke over the course of at least three posts.<br /> |-<br /> |<br /> =====Track Switch=====<br /> :Derail a thread.<br /> |-<br /> |<br /> =====Deocide=====<br /> :Defeat Crushmaster in an Off-Topic debate.<br /> |-<br /> |<br /> =====Beast Slayer=====<br /> :Defeat Zarel in an Off-Topic debate.<br /> |-<br /> |<br /> =====Badge Outta Heck=====<br /> :Defeat Turuk in an Off-Topic debate.<br /> |-<br /> |<br /> =====No Fake=====<br /> :Get &quot;quoted for truth&quot;.<br /> |-<br /> |<br /> =====Chatty=====<br /> :Have at least 1000 posts.<br /> |-<br /> |<br /> =====Noteworthy=====<br /> :Get quoted in someone else's signature.<br /> |-<br /> |<br /> =====Give A Man A Fish=====<br /> :Give someone the exact code they need in the WML workshop.<br /> |-<br /> <br /> |}</div>

Gambit https://wiki.wesnoth.org/index.php?title=User:Gambit&diff=33533 2009-12-31T00:48:20Z

<p>Gambit: </p> <hr /> <div>==Forum Achievements==<br /> WIP for fun. Note that this is not a list of things that I personally have done. It is a list of things that could be done. It is much in the nature of the PS3 trophy system. A lot of these names are references to my favorite shows, games, movies, and books. <br /> <br /> Anyone may feel free to edit *this section* of my page.<br /> <br /> {| border=&quot;1&quot;<br /> |<br /> =====TV On The Brain=====<br /> :Reference the same TV show 3 times in a thread.<br /> |-<br /> |<br /> =====It's A Trap!=====<br /> :Set up a joke over the course of at least three posts.<br /> |-<br /> |<br /> =====Track Switch=====<br /> :Derail a thread.<br /> |-<br /> |<br /> =====Deocide=====<br /> :Defeat Crushmaster in an Off-Topic debate.<br /> |-<br /> |<br /> =====Beast Slayer=====<br /> :Defeat Zarel in an Off-Topic debate.<br /> |-<br /> |<br /> =====Badge Outta Heck=====<br /> :Defeat Turuk in an Off-Topic debate.<br /> |-<br /> |<br /> =====No Fake=====<br /> :Get &quot;quoted for truth&quot;.<br /> |-<br /> |<br /> =====Chatty=====<br /> :Have at least 1000 posts.<br /> |-<br /> |<br /> =====Noteworthy=====<br /> :Get quoted in someone else's signature.<br /> |-<br /> |<br /> =====Give A Man A Fish=====<br /> :Give someone the exact code they need in the WML workshop.<br /> |-<br /> <br /> |}</div>

Gambit https://wiki.wesnoth.org/index.php?title=User:Gambit&diff=33532 2009-12-31T00:46:06Z

<p>Gambit: </p> <hr /> <div>==Forum Achievements==<br /> WIP for fun. Note that this is not a list of things that I personally have done. It is a list of things that could be done. It is much in the nature of the PS3 trophy system. A lot of these names are references to my favorite shows, games, movies, and books.<br /> <br /> {| border=&quot;1&quot;<br /> |<br /> =====TV On The Brain=====<br /> :Reference the same TV show 3 times in a thread.<br /> |-<br /> |<br /> =====It's A Trap!=====<br /> :Set up a joke over the course of at least three posts.<br /> |-<br /> |<br /> =====Track Switch=====<br /> :Derail a thread.<br /> |-<br /> |<br /> =====Deocide=====<br /> :Defeat Crushmaster in an Off-Topic debate.<br /> |-<br /> |<br /> =====Beast Slayer=====<br /> :Defeat Zarel in an Off-Topic debate.<br /> |-<br /> |<br /> =====Badge Outta Heck=====<br /> :Defeat Turuk in an Off-Topic debate.<br /> |-<br /> |<br /> =====No Fake=====<br /> :Get &quot;quoted for truth&quot;.<br /> |-<br /> |<br /> =====Chatty=====<br /> :Have at least 1000 posts.<br /> |-<br /> |<br /> =====Noteworthy=====<br /> :Get quoted in someone else's signature.<br /> |-<br /> |<br /> =====Give A Man A Fish=====<br /> :Give someone the exact code they need in the WML workshop.<br /> |-<br /> <br /> |}</div>

Gambit https://wiki.wesnoth.org/index.php?title=User:Gambit&diff=33531 2009-12-31T00:45:51Z

<p>Gambit: </p> <hr /> <div>==Forum Achievements==<br /> WIP for fun. Note that this is not a list of things that I personally have done. It is a list of things that could be done. It is much in the nature of the PS3 trophy system. A lot of these names are references to my favorite shows, games, movies, and books.<br /> <br /> {| border=&quot;1&quot;<br /> |<br /> =====TV On The Brain=====<br /> :Reference the same TV show 3 times in a thread.<br /> |-<br /> |<br /> =====It's A Trap!=====<br /> :Set up a joke over the course of at least three posts.<br /> |-<br /> |<br /> =====Track Switch=====<br /> :Derail a thread.<br /> |-<br /> |<br /> =====Deocide=====<br /> :Defeat Crushmaster in an Off-Topic debate.<br /> |-<br /> |<br /> =====Beast Slayer=====<br /> :Defeat Zarel in an Off-Topic debate.<br /> |-<br /> |<br /> =====Badge Outta Heck=====<br /> :Defeat Turuk in an Off-Topic debate.<br /> |-<br /> |<br /> =====No Fake=====<br /> :Get &quot;quoted for truth&quot;.<br /> |-<br /> |<br /> =====Chatty=====<br /> :Have at least 1000 posts.<br /> |-<br /> |<br /> =====Noteworthy=====<br /> :Get quoted in someone else's signature.<br /> |-<br /> |<br /> =====Give A Man A Fish=====<br /> :Give someone the exact code they need in the WML workshop.<br /> |-<br /> |<br /> =====The Enemy's Gate Is Down=====<br /> :Report a real bug. (technically you shouldn't be doing this on the forums)<br /> |-<br /> <br /> |}</div>

Gambit https://wiki.wesnoth.org/index.php?title=User:Gambit&diff=33530 2009-12-31T00:44:04Z

<p>Gambit: </p> <hr /> <div>==Forum Achievements==<br /> WIP for fun. Note that this is not a list of things that I personally have done. It is a list of things that could be done. It is much in the nature of the PS3 trophy system. A lot of these names are references to my favorite shows, games, movies, and books.<br /> <br /> {| border=&quot;1&quot;<br /> |<br /> =====TV On The Brain=====<br /> :Reference the same TV show 3 times in a thread.<br /> |-<br /> |<br /> =====It's A Trap!=====<br /> :Set up a joke over the course of at least three posts.<br /> |-<br /> |<br /> =====Track Switch=====<br /> :Derail a thread.<br /> |-<br /> |<br /> =====Deocide=====<br /> :Defeat Crushmaster in an Off-Topic debate.<br /> |-<br /> |<br /> =====Beast Slayer=====<br /> :Defeat Zarel in an Off-Topic debate.<br /> |-<br /> |<br /> =====Badge Outta Heck=====<br /> :Defeat Turuk in an Off-Topic debate.<br /> |-<br /> |<br /> =====No Fake=====<br /> :Get &quot;quoted for truth&quot;.<br /> |-<br /> |<br /> =====Chatty=====<br /> :Have at least 1000 posts.<br /> |-<br /> |<br /> =====Noteworthy=====<br /> :Get quoted in someone else's signature.<br /> |-<br /> |<br /> =====Give A Man A Fish=====<br /> :Give someone the exact code they need in the WML workshop.<br /> |-<br /> <br /> |}</div>

Gambit https://wiki.wesnoth.org/index.php?title=User:Gambit&diff=33529 2009-12-31T00:43:53Z

<p>Gambit: </p> <hr /> <div>==Forum Achievements==<br /> WIP for fun. Note that this is not a list of things that I personally have done. It is a list of things that could be done. It is much in the nature of the PS3 trophy system. A lot of these names are references to my favorite shows, games, movies, and books.<br /> <br /> {| border=&quot;1&quot;<br /> |<br /> =====TV On The Brain=====<br /> :Reference the same TV show 3 times in a thread.<br /> |-<br /> |<br /> =====It's A Trap!=====<br /> :Set up a joke over the course of at least three posts.<br /> |-<br /> |<br /> =====Track Switch=====<br /> :Derail a thread.<br /> |-<br /> |<br /> =====Deocide=====<br /> :Defeat Crushmaster in an Off-Topic debate.<br /> |-<br /> |<br /> =====Beast Slayer=====<br /> :Defeat Zarel in an Off-Topic debate.<br /> |-<br /> |<br /> ====Badge Outta Heck=====<br /> :Defeat Turuk in an Off-Topic debate.<br /> |-<br /> |<br /> =====No Fake=====<br /> :Get &quot;quoted for truth&quot;.<br /> |-<br /> |<br /> =====Chatty=====<br /> :Have at least 1000 posts.<br /> |-<br /> |<br /> =====Noteworthy=====<br /> :Get quoted in someone else's signature.<br /> |-<br /> |<br /> =====Give A Man A Fish=====<br /> :Give someone the exact code they need in the WML workshop.<br /> |-<br /> <br /> |}</div>

Gambit https://wiki.wesnoth.org/index.php?title=User:Gambit&diff=33528 2009-12-31T00:43:42Z

<p>Gambit: </p> <hr /> <div>==Forum Achievements==<br /> WIP for fun. Note that this is not a list of things that I personally have done. It is a list of things that could be done. It is much in the nature of the PS3 trophy system. A lot of these names are references to my favorite shows, games, movies, and books.<br /> <br /> {| border=&quot;1&quot;<br /> |<br /> =====TV On The Brain=====<br /> :Reference the same TV show 3 times in a thread.<br /> |-<br /> |<br /> =====It's A Trap!=====<br /> :Set up a joke over the course of at least three posts.<br /> |-<br /> |<br /> =====Track Switch=====<br /> :Derail a thread.<br /> |-<br /> |<br /> =====Deocide=====<br /> :Defeat Crushmaster in an Off-Topic debate.<br /> |-<br /> |<br /> =====Beast Slayer=====<br /> :Defeat Zarel in an Off-Topic debate.<br /> |-<br /> |<br /> =====Badge Outta Heck====<br /> :Defeat Turuk in an Off-Topic debate.<br /> |-<br /> |<br /> =====No Fake=====<br /> :Get &quot;quoted for truth&quot;.<br /> |-<br /> |<br /> =====Chatty=====<br /> :Have at least 1000 posts.<br /> |-<br /> |<br /> =====Noteworthy=====<br /> :Get quoted in someone else's signature.<br /> |-<br /> |<br /> =====Give A Man A Fish=====<br /> :Give someone the exact code they need in the WML workshop.<br /> |-<br /> <br /> |}</div>

Gambit https://wiki.wesnoth.org/index.php?title=User:Gambit&diff=33527 2009-12-31T00:39:19Z

<p>Gambit: </p> <hr /> <div>==Forum Achievements==<br /> WIP for fun. Note that this is not a list of things that I personally have done. It is a list of things that could be done. It is much in the nature of the PS3 trophy system.<br /> <br /> {| border=&quot;1&quot;<br /> |<br /> =====TV On The Brain=====<br /> :Reference the same TV show 3 times in a thread.<br /> |-<br /> |<br /> =====It's A Trap!=====<br /> :Set up a joke over the course of at least three posts.<br /> |-<br /> |<br /> =====Track Switch=====<br /> :Derail a thread.<br /> |-<br /> |<br /> =====Deocide=====<br /> :Defeat Crushmaster in an Off-Topic debate.<br /> |-<br /> |<br /> =====Beast Slayer=====<br /> :Defeat Zarel in an Off-Topic debate.<br /> |-<br /> |<br /> =====Does Not Compute=====<br /> :Defeat Turuk in an Off-Topic debate.<br /> |-<br /> |<br /> =====No Fake=====<br /> :Get &quot;quoted for truth&quot;.<br /> |-<br /> |<br /> =====Chatty=====<br /> :Have at least 1000 posts.<br /> |-<br /> |<br /> =====Noteworthy=====<br /> :Get quoted in someone else's signature.<br /> |-<br /> |<br /> =====Give A Man A Fish=====<br /> :Give someone the exact code they need in the WML workshop.<br /> |-<br /> <br /> |}</div>

Gambit https://wiki.wesnoth.org/index.php?title=User:Gambit&diff=33526 2009-12-31T00:38:59Z

<p>Gambit: </p> <hr /> <div>==Forum Achievements==<br /> WIP for fun. Note that this is not a list of things that I personally have done. It is a list of things that could be done. It is much in the nature of the PS3 trophy system.<br /> <br /> {| border=&quot;1&quot;<br /> |<br /> =====TV On The Brain=====<br /> :Reference the same TV show 3 times in a thread.<br /> |-<br /> |<br /> =====It's A Trap!=====<br /> :Set up a joke over the course of at least three posts.<br /> |-<br /> |<br /> =====Track Switch=====<br /> :Derail a thread.<br /> |-<br /> |<br /> =====Deocide=====<br /> :Defeat Crushmaster in an Off-Topic debate.<br /> |-<br /> |<br /> =====Beast Slayer=====<br /> :Defeat Zarel in an Off-Topic debate.<br /> |-<br /> |<br /> =====Does Not Compute=====<br /> :Defeat Turuk in an Off-Topic debate.<br /> |-<br /> |<br /> =====No Fake=====<br /> :Get &quot;quoted for truth&quot;.<br /> |-<br /> |<br /> =====Chatty=====<br /> :1000 posts<br /> |-<br /> |<br /> =====Noteworthy=====<br /> :Get quoted in someone else's signature<br /> |-<br /> |<br /> =====Give A Man A Fish=====<br /> :Give someone the exact code they need in the WML workshop<br /> |-<br /> <br /> |}</div>

Gambit https://wiki.wesnoth.org/index.php?title=User:Gambit&diff=33525 2009-12-31T00:38:12Z

<p>Gambit: </p> <hr /> <div>==Forum Achievements==<br /> WIP for fun.<br /> <br /> {| border=&quot;1&quot;<br /> |<br /> =====TV On The Brain=====<br /> :Reference the same TV show 3 times in a thread.<br /> |-<br /> |<br /> =====It's A Trap!=====<br /> :Set up a joke over the course of at least three posts.<br /> |-<br /> |<br /> =====Track Switch=====<br /> :Derail a thread.<br /> |-<br /> |<br /> =====Deocide=====<br /> :Defeat Crushmaster in an Off-Topic debate.<br /> |-<br /> |<br /> =====Beast Slayer=====<br /> :Defeat Zarel in an Off-Topic debate.<br /> |-<br /> |<br /> =====Does Not Compute=====<br /> :Defeat Turuk in an Off-Topic debate.<br /> |-<br /> |<br /> =====No Fake=====<br /> :Get &quot;quoted for truth&quot;.<br /> |-<br /> |<br /> =====Chatty=====<br /> :1000 posts<br /> |-<br /> |<br /> =====Noteworthy=====<br /> :Get quoted in someone else's signature<br /> |-<br /> |<br /> =====Give A Man A Fish=====<br /> :Give someone the exact code they need in the WML workshop<br /> |-<br /> <br /> |}</div>

Gambit https://wiki.wesnoth.org/index.php?title=User:Gambit&diff=33524 2009-12-31T00:37:23Z

<p>Gambit: </p> <hr /> <div>==Forum Achievements==<br /> WIP for fun.<br /> <br /> {| border=&quot;1&quot;<br /> |<br /> =====TV On The Brain=====<br /> :Reference the same TV show 3 times in a thread.<br /> |-<br /> |<br /> =====It's A Trap!=====<br /> :Set up a joke over the course of at least three posts.<br /> |-<br /> |<br /> =====Track Switch=====<br /> :Derail a thread.<br /> |-<br /> |<br /> =====Deocide=====<br /> :Defeat Crushmaster.<br /> |-<br /> |<br /> =====Beast Slayer=====<br /> :Defeat Zarel.<br /> |-<br /> |<br /> =====Does Not Compute=====<br /> :Defeat Turuk.<br /> |-<br /> |<br /> =====No Fake=====<br /> :Get &quot;quoted for truth&quot;.<br /> |-<br /> |<br /> =====Chatty=====<br /> :1000 posts<br /> |-<br /> |<br /> =====Noteworthy=====<br /> :Get quoted in someone else's signature<br /> |-<br /> |<br /> =====Give A Man A Fish=====<br /> :Give someone the exact code they need in the WML workshop<br /> |-<br /> <br /> |}</div>

Gambit https://wiki.wesnoth.org/index.php?title=User:Gambit&diff=33523 2009-12-31T00:35:02Z

<p>Gambit: </p> <hr /> <div>==Forum Achievements==<br /> WIP for fun.<br /> <br /> {| border=&quot;1&quot;<br /> |<br /> =====TV On The Brain=====<br /> :Reference the same TV show 3 times in a thread.<br /> |<br /> <br /> <br /> |-<br /> |<br /> <br /> =====It's A Trap!=====<br /> :Set up a joke over the course of at least three posts.<br /> |<br /> <br /> <br /> |-<br /> |<br /> <br /> =====Track Switch=====<br /> :Derail a thread.<br /> |<br /> <br /> <br /> |-<br /> |<br /> <br /> =====Deocide=====<br /> :Defeat Crushmaster.<br /> |<br /> <br /> |-<br /> |<br /> =====Beast Slayer=====<br /> :Defeat Zarel.<br /> |<br /> <br /> |-<br /> |<br /> =====Does Not Compute=====<br /> :Defeat Turuk.<br /> |<br /> <br /> <br /> |-<br /> |<br /> <br /> =====No Fake=====<br /> :Get &quot;quoted for truth&quot;.<br /> |<br /> <br /> |-<br /> |<br /> =====Chatty=====<br /> :1000 posts<br /> |<br /> <br /> |-<br /> |<br /> <br /> =====Noteworthy=====<br /> :Get quoted in someone else's signature<br /> |<br /> |<br /> <br /> =====Give A Man A Fish=====<br /> :Give someone the exact code they need in the WML workshop<br /> |<br /> <br /> |-<br /> |}</div>

Gambit https://wiki.wesnoth.org/index.php?title=User:Gambit&diff=33522 2009-12-31T00:33:35Z

<p>Gambit: /* Track Switch */</p> <hr /> <div>==Forum Achievements==<br /> WIP for fun.<br /> <br /> {| border=&quot;1&quot;<br /> |<br /> =====TV On The Brain=====<br /> :Reference the same TV show 3 times in a thread.<br /> |<br /> <br /> <br /> |-<br /> |<br /> <br /> =====It's A Trap!=====<br /> :Set up a joke over the course of at least three posts.<br /> |<br /> <br /> <br /> |-<br /> |<br /> <br /> =====Track Switch=====<br /> :Derail a thread.<br /> |<br /> <br /> <br /> |-<br /> |<br /> <br /> =====Deocide=====<br /> :Defeat Crushmaster.<br /> |<br /> <br /> |-<br /> |<br /> =====Beast Slayer=====<br /> :Defeat Zarel.<br /> |<br /> <br /> |-<br /> |<br /> =====Does Not Compute=====<br /> :Defeat Turuk.<br /> |<br /> <br /> <br /> |-<br /> |<br /> <br /> =====No Fake=====<br /> :Get &quot;quoted for truth&quot;.<br /> |<br /> <br /> |-<br /> |<br /> =====Chatty=====<br /> :1000 posts<br /> |<br /> <br /> |-<br /> |<br /> <br /> =====Noteworthy=====<br /> :Get quoted in someone else's signature<br /> |<br /> |}</div>

Gambit https://wiki.wesnoth.org/index.php?title=User:Gambit&diff=33521 2009-12-31T00:33:30Z

<p>Gambit: /* It's A Trap! */</p> <hr /> <div>==Forum Achievements==<br /> WIP for fun.<br /> <br /> {| border=&quot;1&quot;<br /> |<br /> =====TV On The Brain=====<br /> :Reference the same TV show 3 times in a thread.<br /> |<br /> <br /> <br /> |-<br /> |<br /> <br /> =====It's A Trap!=====<br /> :Set up a joke over the course of at least three posts.<br /> |<br /> <br /> <br /> |-<br /> |<br /> <br /> =====Track Switch=====<br /> :Derail a thread.<br /> |<br /> http://www.studentdream.com/clipart/road/NO_U1.GIF<br /> <br /> |-<br /> |<br /> <br /> =====Deocide=====<br /> :Defeat Crushmaster.<br /> |<br /> <br /> |-<br /> |<br /> =====Beast Slayer=====<br /> :Defeat Zarel.<br /> |<br /> <br /> |-<br /> |<br /> =====Does Not Compute=====<br /> :Defeat Turuk.<br /> |<br /> <br /> <br /> |-<br /> |<br /> <br /> =====No Fake=====<br /> :Get &quot;quoted for truth&quot;.<br /> |<br /> <br /> |-<br /> |<br /> =====Chatty=====<br /> :1000 posts<br /> |<br /> <br /> |-<br /> |<br /> <br /> =====Noteworthy=====<br /> :Get quoted in someone else's signature<br /> |<br /> |}</div>

Gambit https://wiki.wesnoth.org/index.php?title=User:Gambit&diff=33520 2009-12-31T00:33:25Z

<p>Gambit: /* TV On The Brain */</p> <hr /> <div>==Forum Achievements==<br /> WIP for fun.<br /> <br /> {| border=&quot;1&quot;<br /> |<br /> =====TV On The Brain=====<br /> :Reference the same TV show 3 times in a thread.<br /> |<br /> <br /> <br /> |-<br /> |<br /> <br /> =====It's A Trap!=====<br /> :Set up a joke over the course of at least three posts.<br /> |<br /> http://www.df-21.net/phpbb/images/avatars/ackbar.gif<br /> <br /> |-<br /> |<br /> <br /> =====Track Switch=====<br /> :Derail a thread.<br /> |<br /> http://www.studentdream.com/clipart/road/NO_U1.GIF<br /> <br /> |-<br /> |<br /> <br /> =====Deocide=====<br /> :Defeat Crushmaster.<br /> |<br /> <br /> |-<br /> |<br /> =====Beast Slayer=====<br /> :Defeat Zarel.<br /> |<br /> <br /> |-<br /> |<br /> =====Does Not Compute=====<br /> :Defeat Turuk.<br /> |<br /> <br /> <br /> |-<br /> |<br /> <br /> =====No Fake=====<br /> :Get &quot;quoted for truth&quot;.<br /> |<br /> <br /> |-<br /> |<br /> =====Chatty=====<br /> :1000 posts<br /> |<br /> <br /> |-<br /> |<br /> <br /> =====Noteworthy=====<br /> :Get quoted in someone else's signature<br /> |<br /> |}</div>

Gambit https://wiki.wesnoth.org/index.php?title=User:Gambit&diff=33519 2009-12-31T00:32:31Z

<p>Gambit: /* Chatty */</p> <hr /> <div>==Forum Achievements==<br /> WIP for fun.<br /> <br /> {| border=&quot;1&quot;<br /> |<br /> =====TV On The Brain=====<br /> :Reference the same TV show 3 times in a thread.<br /> |<br /> http://a1.twimg.com/profile_images/505099932/TvHeadAvatar_bigger.jpg<br /> <br /> |-<br /> |<br /> <br /> =====It's A Trap!=====<br /> :Set up a joke over the course of at least three posts.<br /> |<br /> http://www.df-21.net/phpbb/images/avatars/ackbar.gif<br /> <br /> |-<br /> |<br /> <br /> =====Track Switch=====<br /> :Derail a thread.<br /> |<br /> http://www.studentdream.com/clipart/road/NO_U1.GIF<br /> <br /> |-<br /> |<br /> <br /> =====Deocide=====<br /> :Defeat Crushmaster.<br /> |<br /> <br /> |-<br /> |<br /> =====Beast Slayer=====<br /> :Defeat Zarel.<br /> |<br /> <br /> |-<br /> |<br /> =====Does Not Compute=====<br /> :Defeat Turuk.<br /> |<br /> <br /> <br /> |-<br /> |<br /> <br /> =====No Fake=====<br /> :Get &quot;quoted for truth&quot;.<br /> |<br /> <br /> |-<br /> |<br /> =====Chatty=====<br /> :1000 posts<br /> |<br /> <br /> |-<br /> |<br /> <br /> =====Noteworthy=====<br /> :Get quoted in someone else's signature<br /> |<br /> |}</div>

Gambit https://wiki.wesnoth.org/index.php?title=User:Gambit&diff=33518 2009-12-31T00:32:26Z

<p>Gambit: /* Does Not Compute */</p> <hr /> <div>==Forum Achievements==<br /> WIP for fun.<br /> <br /> {| border=&quot;1&quot;<br /> |<br /> =====TV On The Brain=====<br /> :Reference the same TV show 3 times in a thread.<br /> |<br /> http://a1.twimg.com/profile_images/505099932/TvHeadAvatar_bigger.jpg<br /> <br /> |-<br /> |<br /> <br /> =====It's A Trap!=====<br /> :Set up a joke over the course of at least three posts.<br /> |<br /> http://www.df-21.net/phpbb/images/avatars/ackbar.gif<br /> <br /> |-<br /> |<br /> <br /> =====Track Switch=====<br /> :Derail a thread.<br /> |<br /> http://www.studentdream.com/clipart/road/NO_U1.GIF<br /> <br /> |-<br /> |<br /> <br /> =====Deocide=====<br /> :Defeat Crushmaster.<br /> |<br /> <br /> |-<br /> |<br /> =====Beast Slayer=====<br /> :Defeat Zarel.<br /> |<br /> <br /> |-<br /> |<br /> =====Does Not Compute=====<br /> :Defeat Turuk.<br /> |<br /> <br /> <br /> |-<br /> |<br /> <br /> =====No Fake=====<br /> :Get &quot;quoted for truth&quot;.<br /> |<br /> <br /> |-<br /> |<br /> =====Chatty=====<br /> :1000 posts<br /> |<br /> *Too many to list<br /> <br /> |-<br /> |<br /> =====Noteworthy=====<br /> :Get quoted in someone else's signature<br /> |<br /> |}</div>

Gambit https://wiki.wesnoth.org/index.php?title=User:Gambit&diff=33517 2009-12-31T00:32:13Z

<p>Gambit: /* Track Switch */</p> <hr /> <div>==Forum Achievements==<br /> WIP for fun.<br /> <br /> {| border=&quot;1&quot;<br /> |<br /> =====TV On The Brain=====<br /> :Reference the same TV show 3 times in a thread.<br /> |<br /> http://a1.twimg.com/profile_images/505099932/TvHeadAvatar_bigger.jpg<br /> <br /> |-<br /> |<br /> <br /> =====It's A Trap!=====<br /> :Set up a joke over the course of at least three posts.<br /> |<br /> http://www.df-21.net/phpbb/images/avatars/ackbar.gif<br /> <br /> |-<br /> |<br /> <br /> =====Track Switch=====<br /> :Derail a thread.<br /> |<br /> http://www.studentdream.com/clipart/road/NO_U1.GIF<br /> <br /> |-<br /> |<br /> <br /> =====Deocide=====<br /> :Defeat Crushmaster.<br /> |<br /> <br /> |-<br /> |<br /> =====Beast Slayer=====<br /> :Defeat Zarel.<br /> |<br /> <br /> |-<br /> |<br /> =====Does Not Compute=====<br /> :Defeat Turuk.<br /> |<br /> *Haha. Yeah right.<br /> <br /> <br /> |-<br /> |<br /> =====No Fake=====<br /> :Get &quot;quoted for truth&quot;.<br /> |<br /> <br /> |-<br /> |<br /> =====Chatty=====<br /> :1000 posts<br /> |<br /> *Too many to list<br /> <br /> |-<br /> |<br /> =====Noteworthy=====<br /> :Get quoted in someone else's signature<br /> |<br /> |}</div>

Gambit