<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
    "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">

<head><script async src="//pagead2.googlesyndication.com/pagead/js/adsbygoogle.js"></script>
<!-- MyFirstUnitAd -->
<ins class="adsbygoogle"
     style="display:inline-block;width:970px;height:250px"
     data-ad-client="ca-pub-5778386704669218"
     data-ad-slot="1503492166"></ins>
<script>
(adsbygoogle = window.adsbygoogle || []).push({});
</script>

<title>Utility macro reference</title>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<link rel="shortcut icon" type="image/png" href="/mw/skins/glamdrol/ico.png" />
<style type="text/css">
/*<![CDATA[*/
@import url('http://www.wesnoth.org/mw/skins/glamdrol/main.css');
@import url('http://www.wesnoth.org/mw/skins/glamdrol/home.css');

.toplink           {float:right; font-size: small;}
.file_header       {font-style:normal; font-weight:bold;}
.file_explanation  {font-style:normal; font-weight:bold;}
.macro_name        {font-style:normal; font-weight:bold;}
.macro_formals     {font-style:italic; font-weight:normal;}
.macro_explanation {font-style:normal; font-weight:normal;}
.listing           {font-style:normal; font-family:monospace;}
/*]]>*/
</style>
</head>
<body>

<div id="global">

<div id="header">
  <div id="logo">
    <a href="home"><img alt="Wesnoth logo" src="http://www.wesnoth.org/mw/skins/glamdrol/wesnoth-logo.jpg" /></a>
  </div>
</div>

<div id="nav">
  <ul>
    <li><a href="http://www.wesnoth.org/">Home</a></li>
    <li><a href="http://wiki.wesnoth.org/Play">Play</a></li>
    <li><a href="http://wiki.wesnoth.org/Create">Create</a></li>
    <li><a href="http://forums.wesnoth.org/">Forums</a></li>
    <li><a href="http://wiki.wesnoth.org/Support">Support</a></li>
    <li><a href="http://wiki.wesnoth.org/Project">Project</a></li>
    <li><a href="http://wiki.wesnoth.org/Credits">Credits</a></li>
    <li><a href="http://wiki.wesnoth.org/UsefulLinks">Links</a></li>
  </ul>
</div>

<div id="main">

<p>This page is an automatically-generated reference for all the
utility macros with documentation strings in the Wesnoth source
distribution. It will reflect the state of the latest development
release. It can be generated with <code>make
macro-reference.html</code> in the data/tools-directory.</p>

<p>The organization of these macros may change in future releases,
and some may be moved out of the default load path.  If in doubt,
use <tt>wmlscope</tt> to check your campaign against the 
macros in the Wesnoth distribution.</p>
