From The Battle for Wesnoth Wiki

[edit]WML Tags


abilities, about, add_ai_behavior, advance, advanced_preference, advancefrom, advancement, advances, affect_adjacent, ai, allied_with, allow_end_turn, allow_extra_recruit, allow_recruit, allow_undo, and, animate, animate_unit, animation, array, aspect, attack, attack_anim, attacks, avoid;


base_unit, berserk, binary_path, break, brush;


campaign, candidate_action, capture_village, case, chance_to_hit, change_theme, chat, choose, clear_global_variable, clear_menu_item, clear_variable, color_adjust, command (action, replay), continue, criteria;


damage, death, deaths, default, defend, defends, defense, delay, deprecated_message, destination, difficulty, disable, disallow_end_turn, disallow_extra_recruit, disallow_recruit, do, do_command, drains, draw_weapon_anim;


editor_group, editor_music, editor_times, effect, else (action, animation), elseif, endlevel, end_turn (action, replay), enemy_of, engine, entry, era, event, extra_anim;


facet, facing, fake_unit, false, female, filter, filter_adjacent, filter_adjacent_location, filter_attack, filter_attacker, filter_base_value, filter_condition, filter_defender, filter_enemy, filter_location, filter_opponent, filter_own, filter_owner, filter_radius, filter_recall, filter_second, filter_second_attack, filter_self, filter_side, filter_vision, filter_weapon, filter_wml, find_path, fire_event, firststrike, floating_text, for, foreach, frame, full_heal;


game_config, get_global_variable, goal, gold, gold_carryover;


harm_unit, has_unit, have_location, have_unit, heal_on_hit, heal_unit, healed_anim, healing_anim, heals, hide_help, hide_unit, hides;


idle_anim, if (action, animation), illuminates, image, init_side, insert_tag, inspect, item, item_group;


jamming_costs, join;


kill, killed;


label, language, leader_goal, leadership, leading_anim, levelin_anim, levelout_anim, lift_fog, limit, literal, locale, lock_view, lua;


male, menu_item, message, micro_ai, missile_frame, modification, modifications, modify_ai, modify_side, modify_turns, modify_unit, move, move_unit, move_unit_fake, move_units_fake, movement_anim, movement costs, movetype, multiplayer, multiplayer_side, music;


not, note;


object, objective, objectives, open_help, option, options, or;


part, petrifies, petrify, place_shroud, plague, poison, portrait, post_movement_anim, pre_movement_anim, primary_attack, primary_unit, print, put_to_recall_list;


race, recall (action, replay), recalls, recruit, recruit_anim, recruiting_anim, recruits, redraw, regenerate, remove_event, remove_item, remove_object, remove_shroud, remove_sound_source, remove_time_area, remove_unit_overlay, repeat, replace_map, replace_schedule, replay, replay_start, reset_fog, resistance (ability, unit), resistance_defaults, resource, return, role, rule;


save, scenario, scroll, scroll_to, scroll_to_unit, secondary_attack, secondary_unit, section, select_unit, sequence, set_extra_recruit, set_global_variable, set_menu_item, set_recruit, set_specials, set_variable, set_variables, sheath_weapon_anim, show_if (message, set_menu_item), show_objectives, side, skirmisher, slow, snapshot, sound, sound_source, source (replay, teleport), specials, split, stage, standing_anim, statistics, status, store_gold, store_items, store_locations, store_map_dimensions, store_reachable_locations, store_relative_direction, store_side, store_starting_location, store_time_of_day, store_turns, store_unit, store_unit_type, store_unit_type_ids, store_villages, story, swarm, switch, sync_variable;


target, team, teleport (ability, action), teleport_anim, terrain, terrain_defaults, terrain_graphics, terrain_mask, terrain_type, test, test_condition, text_input, textdomain, then, tile, time, time_area, topic, toplevel, trait, transform_unit, traveler, true, tunnel, tutorial;


unhide_unit, unit, unit_overlay, unit_type, unit_worth, units, unlock_view, unpetrify, unstore_unit;


value, variable, variables, variation, victory_anim, village, vision_costs, volume;


while, wml_message;



The [terrain_mask] tag makes map manipulation from within WML much easier. It uses a Wesnoth map as a "mask" over a given location, placing it down on top of the scenario map. Fog ('_f') and Shroud ('_s') are used like alpha in an image; i.e. they cause the previous terrain to be used.

  • x,y: the x,y location in the scenario map to place the top-left corner of the mask onto
  • mask: a Wesnoth map; see BuildingMaps.
  • border: (default=no) Overlay on the border as well as the playable map area. The mask used must have a border_size equal to the map's border size (i.e. it must be a normal map), otherwise it will be ignored
  • [rule]: specifies a rule for blending the mask with the scenario.

The terrain on each hex fitting the rule will be changed to the terrain specified in the rule.

    • old: a comma-separated list of terrain codes. The rule fits only those hexes that have one of these terrains in the scenario. If omitted, matches any hex on the base map.
    • new: a list of terrain letters. The rule fits only those hexes with this terrain specified in the mask. If omitted, matches any hex on the mask.
    • terrain: the letter of the terrain to change hexes which fit this rule (i.e. for which the new terrain code in the mask falls on top of the old terrain in the scenario) into. If omitted, defaults to either the old or new terrain depending on the value of use_old.
    • layer: (overlay|base|both, default=both) only change the specified layer.
    • 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.
    • use_old: if yes, no change is done to hexes matching this rule. If no, the hex is changed to the new terrain or, if specified, the value of the terrain key.

As an example, suppose you want to lay down a road somewhere. You could specify by hand the path the road takes using [terrain], or you could use [terrain_mask]:

   Re,   Re,   _f,   _f,   _f,   _f,   _f,   _f,   _f,   _f,   _f,   _f
   Re,   Re,   _f,   _f,   _f,   _f,   _f,   _f,   _f,   _f,   _f,   _f
   Re,   Re,   _f,   _f,   _f,   _f,   _f,   _f,   _f,   _f,   _f,   _f
   _f,   _f,   Re,   _f,   _f,   _f,   _f,   _f,   _f,   _f,   _f,   _f
   _f,   _f,   Re,   _f,   _f,   _f,   _f,   _f,   _f,   _f,   _f,   _f
   Re,   Re,   _f,   _f,   _f,   _f,   _f,   _f,   _f,   _f,   _f,   _f
   _f,   _f,   Re,   _f,   _f,   Re,   Re,   _f,   _f,   _f,   _f,   _f
   _f,   _f,   _f,   Re,   Re,   Re,   _f,   Re,   Re,   _f,   _f,   _f
   _f,   _f,   _f,   _f,   _f,   _f,   _f,   Re,   _f,   _f,   _f,   _f
   _f,   _f,   _f,   _f,   _f,   _f,   _f,   Re,   Re,   _f,   _f,   _f
   _f,   _f,   _f,   _f,   _f,   _f,   _f,   Re,   Re,   Re,   Re,   Re
   _f,   _f,   _f,   _f,   _f,   _f,   _f,   Re,   Re,   Re,   Re,   Re

For instance, suppose you want snow to fall in an area. You want villages on green grass (Gg^Vh) to turn into snowy villages on snow (Aa^Vha), pine forest on semi-dry grass (Gs^Fp) to turn into snowy pine forest on snow (Aa^Fpa), hills (Hh) to turn into snowy hills (Ha), and green grass (Gg) and regular dirt (Re) to turn into snow (Aa), while other terrain remains untouched. You could look over your destination map and work out which terrain type is which and draw your mask, but that's a lot of effort, you want to just draw a simple mask which has areas of snow and areas of no snow, and make the game work out the rest.

You can do it like this:


 _f,   _f,   Aa,   _f,   _f,   _f,   Aa,   _f,   _f
 _f,   _f,   Aa,   _f,   _f,   _f,   Aa,   _f,   _f
 _f,   _f,   Aa,   _f,   Aa,   _f,   Aa,   _f,   _f
 Aa,   Aa,   _f,   _f,   Aa,   Aa,   Aa,   _f,   _f
 _f,   _f,   Aa,   Aa,   Aa,   Aa,   Aa,   Aa,   Aa
 _f,   _f,   _f,   Aa,   Aa,   Aa,   Aa,   Aa,   Aa
 _f,   _f,   _f,   _f,   Aa,   Aa,   _f,   _f,   _f
 _f,   _f,   _f,   _f,   Aa,   Aa,   _f,   _f,   _f"

   #don't specify terrain and it just uses the new terrain

#default: Will match everything, since 'old' and 'new' aren't
#specified. Set 'use_old=yes' to signal no change.
This page was last modified on 18 March 2013, at 16:36.