UtilWML

From Wesnoth

edit WML Tags

A:

abilities, about, advancefrom, advancement, advances, ai, allow_recruit, allow_undo, animate_unit, animation, array, attack, attack_filter, attacks, avoid;

B:

base_unit,binary_path,bold;

C:

campaign, capture_village, choose, clear_variable, colour_adjust, command;

D:

damage,deaths,debug_message,defend,defends, defense, delay, destination, disallow_recruit, do;

E:

effect,else,end_turn, endlevel, era, event, expenses;

F:

filter, filter_location, filter_second, filter_vision, format, frame;

G:

game_config, generator, gold, gold;

H:

have_unit, header, hide_unit;

I:

if, illuminated_time, image, img, income, insert_tag, italic, item;

J:

jump, join;

K:

kill, killed;

L:

label (map, theme), language, leader_goal;

M:

main_map,menu, message, mini_map, missile_frame, modifications, modify_side, modify_turns, move, move_unit_fake, movement costs, movetype, multiplayer, multiplayer_side, music;

N:

neighbour_unit_filter, not, num_units;

O:

object, objectives, objective, observers, option, or;

P:

panel, part, place_shroud, position, print, protect_location, protect_unit;

R:

race, random, recall, recalls, recruit, recruits, redraw, ref, remove_shroud, remove_unit_overlay, removeitem, remove_sound_source, replay, replay_start, resistance, resolution, results, role;

S:

save, scenario, scroll, scroll_to, scroll_to_unit, secondary_attack_filter, secondary_unit_filter, section, set_menu_item, set_recruit, set_variable, set_variables, side, side_playing, snapshot, sound, sound_source, source, special_filter, special_filter_second, split, statistics, status, stone, store_gold, store_locations, store_map_dimensions, store_starting_location, store_side, store_unit, story;

T:

target, team, teleport, teleport_anim, terrain, terrain, terrain_graphics, terrain_mask, test, textdomain, theme, then, tile, time, time_area, time_of_day, topic, toplevel, trait, turn, tutorial;

U:

unhide_unit, unit (define, create), unit_abilities, unit_alignment, unit_description, unit_filter, unit_hp, unit_image, unit_level, unit_moves, unit_overlay, unit_profile, unit_status, unit_traits, unit_type, unit_weapons, unit_xp, units, unstone, unstore_unit, upkeep;

V:

variable, variables, village, villages;

W:

while, wml_filter

Predefined utility macros

There are many ready macros defined in data/utils.cfg that are always included. Many are relatively simple shortcuts like one-liners for setting variables but there are macros for more complex tasks as well, such as modifying properties of existing units or moving units around on the map. For an exact description of what each macro does, see data/utils.cfg.

Macro Descriptions

We no longer maintain reference documentation on the utility macros by hand. Instead, as of 1.3.2, there is an automatically generated page made from comments embedded in the macro source code.

See Also

Retrieved from "http://www.wesnoth.org/wiki/UtilWML"
This page was last modified 12:13, 23 July 2008.