The Battle for Wesnoth Wiki - User contributions [en]

User:Bruno

2011-12-17T13:59:01Z

Bruno: I am mostly retired from Wesnoth now.

[http://wolff.to/bruno/ Bruno Wolff III]

* I have claimed responsibility for [[The Dark Hordes]] campaign.
** I never got very far with the Dark Hordes campaign.
* I update documentation in the wiki as I see something that needs work.
* I am slowly learning the mainline code and c++ and have started doing some bug fixes and minor feature additions to the core program.
* I am mostly retired from Wesnoth now, as I spend most of my free software time in Fedora. But I do still keep an eye on Wesnoth.

You can reach me via email at [mailto:bruno@wolff.to bruno@wolff.to].

FAQ

2011-12-17T13:42:44Z

Bruno: Point to the current campaign server.

{{FAQ/Translations}}
== General ==

===What is Battle for Wesnoth?===
Battle for Wesnoth is a turn-based tactical strategy game with a high fantasy theme, featuring both single-player, and online/hotseat multiplayer combat.

===What license is the game distributed under?===
The project is distributed under the [http://www.fsf.org/copyleft/gpl.html GPL]. All contributors retain copyright on the portions of the project that they contribute. For more information, see [[Wesnoth:Copyrights]].

===How to get informed about new releases?===
Check the front page of the website.

===A new version is out, but where is the download for [Windows, Mac OS X, etc.]?===
The packages provided, other than the source code tarball, are '''not''' part of the official project. The BfW team only releases the game's source code. Binary executables or applications are always contributed by community volunteers. If not for these volunteers, there would never be any downloads for us to enjoy. The volunteers compile the game and upload it on their own time, and sometimes they cannot do this in a timely fashion (or at all, at times). Although there are usual packagers designated for each operating system, there are times when other members of the community are asked to step in and contribute when the usual people cannot.

Every time a new version is released, the usual volunteers are notified by the project leaders. '''Please refrain from making forum posts asking where your download is''' because it doesn't help anything - the packagers already know, and they will get to it as soon as they can. In the past, the Windows and Mac communities have come together to produce home-grown unofficial builds for the community to use, and the renewed interest in community and learning how to compile is generally a good thing.

===Why doesn't Wesnoth have my favorite feature?===
Because we are building this game for ourselves, to suit our own preferences. We're not building the game for you, in large part because this is our hobby, not our job; whether you like it or not is immaterial to us.
You may wonder, then, what the point is of soliciting ideas, as we do on the forum. We, the developers, have certainly come up with many good ideas on our own, but our players often do as well, and generally ones we don't think of ourselves. If a player comes up with an idea we like, we might implement it. Not because they asked for it, but because of its own merits as an addition to our game.

The beautiful thing about the license our game is distributed under, as compared to closed-source, commercial games, is that if you want that feature badly enough, you can take the code and art of our game and modify it yourself; you are free to re-use any work in Wesnoth, as long as you follow the rules of the [http://www.fsf.org/copyleft/gpl.html GPL]. From this, you can build a game exactly the way that you like. Just don't expect us to build that game for you. Building this game is our hobby, not our profession, and you did not pay us to make it; rather, we are the ones who have paid for it, in time and labor.

===Do you want help making this game? How can I help?===
Yes, we want your help. Whether you're a programmer, artist, musician, writer, translator, level designer, playtester, or just have some great suggestions, you're welcome to contribute. How? You can:
* join the [http://www.wesnoth.org/wiki/Project project]
* share your opinions at the [http://www.wesnoth.org/forum/ Forum]
* talk with us on [[Support#IRC|IRC]]
* [[ReportingBugs|report]] bugs you find with Wesnoth and its mainline content
* update the wiki
* play against other players via the [[GettingStarted#Multiplayer|Multiplayer]] menu
* vote for Wesnoth at your favorite gaming web site
* spread the word!

=== What are the system requirements? ===
'''outdated!'''
We are not completely certain, but an x86 running at 400 MHz with 128 MB RAM should be adequate for versions 1.0.2 and below. For versions 1.1 and up we recommend a computer with at least 1 GHz and 512 MB RAM if you run KDE or Gnome as Windowmanager (The game itself needs about 100 MB RAM). Slower machines will have trouble scrolling large maps or processing AI turns with many units. See the [http://www.wesnoth.org/forum/viewtopic.php?t=7384 forum thread] about minimum and recommended system requirements.

=== I'm bored; how do I speed the game up? ===

There are several preferences you can change to shorten the time that the AI takes to make its moves. "Accelerated Speed" will make units move and fight faster. "Skip AI Moves" will not show the AI's units moving from hex to hex. Finally, you can turn off all combat animations via the "Show Combat" option on the Advanced tab.

=== My computer is too slow; how do I speed the game up? ===

First, turn off the music and sound effects. Turning off the color cursors will make your cursor respond faster. If scrolling the map is slow, run the game in "Full Screen" mode, not in a window. Turn off combat, map, and standing unit animations via the "Show Combat", "Animate Map" and "Unit Standing Animations" options on the Advanced tab in the game Preferences. You can try turning off halos and combat results, but this might make gameplay more difficult.
For some tips on tweaking the startup, see [[CustomizingStartup]].

== Gameplay and Controls ==

=== How do I learn to play? ===

If you just want to jump right in, start the game and play the tutorial. If you like reading documentation, see [[WesnothManual]]. At any time while playing, you can select help from the menu button (or hit F1). The online help is quite extensive and provides information on terrains, weapons, traits, abilities, units and a good overview of how to play.

=== My unit leveled up but didn't improve. What happened? ===

This is called "After Maximum Level Advancement" or AMLA for short. While most level 0, 1, and 2 units can advance, some cannot. However, some level 3 units can advance to level 4, or even 5. You can see whether a unit can advance further by right clicking and selecting "description."

After a unit reaches the highest level it can get, every time it reaches a new experience threshold (which increases with each advancement) it gains 3 hitpoints and is restored to a state of full health. This is a minor bonus so that experience gained by maxed out units is not altogether wasted. It is generally better to give experience to lower level units, rather than continue to advance units that have reached their maximum level.

=== I tried to trap an enemy with several weak units, but it still escaped. What happened? ===

Most units exert a zone of control (or ZoC). If an enemy moves into one of the six adjacent hexes, the zone of control will prevent it from moving any farther. However some weak units are level 0, meaning they are so weak that they do not have a ZoC. You can still surround an enemy unit entirely with level 0 units to keep it from escaping, but if there is any gap in your ranks, it could escape.

Also, some units have the "skirmish" ability, which allows them to ignore ZoCs.

=== How can I see where an enemy unit can move next turn? ===

During your turn you can click on an enemy unit. Wesnoth will highlight all the hexes the unit can move to in the next turn. This is useful when trying to arrange your units to block an enemy's movement.

=== There's too much luck in this game! ===

Sooner or later, you will become frustrated when your archmage with four 70% attacks misses all four times. This does not mean that the AI is cheating or the random number generator is futzed. It means you are noticing random negative events more than positive ones. During the development of the game, many mathematicians have done sophisticated statistical analysis of the combat system. Likewise, programmers have examined the random number generator. No flaws have been found, so streaks of "bad" and "good" luck should just be accepted as part of having randomness in Wesnoth. A more detailed rational and discussion of the role that randomness plays in Wesnoth can be found [http://www.wesnoth.org/forum/viewtopic.php?f=6&t=21317&start=0&st=0&sk=t&sd=a here].

Since Wesnoth is GPLed, it is possible that a new development team will someday "fork" the source and produce a version more like Heroes of Might & Magic, with less or no randomness. Until then, don't charge with your horsemen against troll rocklobbers at night...

=== The (random unit) is overpowered/underpowered! ===

The development team has spent years tweaking the units in the game. Each unit has had its gold cost, attack types, combat damage, defensive values, resistances, upgrade paths, and other stats carefully scrutinized and loudly discussed in the forum. However, the game code and the units were being modified right up until the 1.0 release, so some unbalanced units may have slipped through.

If you have evidence to back up your claim, search the forum for past discussions about this unit, and then try posting.

=== The (random scenario) is too hard/easy! ===

See above answer about random units.

=== What do the different difficulty levels do? ===

That depends on the scenario. Usually, the opponent will get more money and be able to recruit higher-level units at higher difficulty levels, and you will have fewer turns available.

== Maps, Scenarios and Campaigns ==

=== How do I beat scenario _______ ? ===

If you are stuck on a scenario in a campaign, you'll probably find a walkthrough at [[MainlineCampaigns]]. Or check out the "Strategies and Tips" forum at http://www.wesnoth.org/forum/viewforum.php?f=3

=== How do I download user campaigns? ===
Choose "Campaigns" in the main Wesnoth menu. Then scroll down to the bottom and choose "Get More Campaigns..." or since 1.1.5 there is a "Get add-ons" button in the main menu. This connects you to the campaign server. In the campaign server you can view a list of all available campaigns and download them, as well as posting or deleting your own campaigns.

If you are behind a firewall you may not be able to connect to the campaign server. In this case try to download the campaign directly from the campaign server at http://addons.wesnoth.org/. If you know how to change your firewall settings, then you should open port 15003 (version 1.1.1 and up) or port 15002 (versions 1.1.0 and lower). For added security, you can restrict traffic over those ports to the campaign server's IP address (currently 88.191.12.200).

=== Are there any tools to help me create maps and scenarios? ===
Yes, the game includes a built-in map editor, that you can use to build the terrain maps for your scenarios.

Unfortunately, there's no simple solution for creating the rest of what constitutes a complete scenario or campaign, which is the [[ReferenceWML|WML]] code. There have been some abandoned attempts at creating complete scenario editors such as [[CampGen]], but they are no longer maintained, nor do they work with the latest stable versions of the game.

You should take a look at the [[Create]] section for information and guides that can help you build your own scenario or campaign. Taking a look at how existing content works is also a good idea.

=== What are the .cfg files and how can I edit them? ===

The .cfg files are plain text files, saved with the file extension ".cfg". You can create and edit them using normal text editors; just save the files in correct format.

Please note that some Windows programs like to add a ".txt" extension, so the file is instead of "my_scenario.cfg" saved as "my_scenario.cfg.txt". And then the Windows Explorer will hide the ".txt" extension by default, so you may not notice it.

'''Notepad''': After you create a document, click "File", "Save as..." and select "Save as type: All files". To open the document, click "File", "Open..." and select "Files of type: All files (*.*)". If you open someone else's document, and the end-of-line symbols are displayed as small rectangles, you have to use another editor.

'''WordPad''': After you create a document, click "File", "Save as..." and select "Save as type: Text Document". After the document is saved, close WordPad and remove the ".txt" extension from file. To open the document, click "File", "Open..." and select "Files of type: All documents (*.*)".

Starting with the 1.9.x branch, there is a new IDE for helping User Made Content Authors to easily develop Wesnoth Add-ons. The website and details can be found at: http://eclipse.wesnoth.org

=== I already created an add-on and published it on the server. How can I get translations for the campaign? ===
Just have a look at [[WesCamp]]. This project is the easiest way to get translations for your campaign. All the info you need you can find at [[WesCamp]].

===How do I place an object or unit on my map with the map editor?===
You can't. You need to make a scenario file. There are more details on the [[BuildingMaps|maps]] page.

== Multiplayer ==

===How do I connect to a multiplayer server, when I sit behind a restrictive firewall?===

You have to open outgoing TCP port 15000 - 14997 (depending on the version you use) to play multiplayer games over the internet on the official servers.

===How to find players for multiplayer game?===
Hang around for a while on multiplayer servers and you might find someone to play with. If you observe other people playing you will get informed when someone joins the servers. Maybe you find someone willing to play in the [[Support#IRC|IRC]] channel dedicated to Wesnoth, #wesnoth at irc.freenode.net.

===How to save and load a multiplayer game===

Save the game. Give it a good name, so that you can find it among the other saved games.

Create new game. (Give it a name like "private game for X and Y", so that other players will not try joining it, and you do not have to explain or kick them.) The first item in the map/scenario list is "Saved games", select this. Choose the saved game. Wait for the other player(s) to connect. Start the game.

===How can I make my computer into a dedicated Wesnoth server?===

To setup a dedicated Wesnoth server, you have to compile the game with the "--enable-server" flag, and after you install, simply run wesnothd from the console. This will start the server, listening on TCP port 15000. To compile the server only you can use the flags "--disable-game --enable-server". If you aren't using a linux or mac operating system, there are a few ways you can compile on Windows... [[CompilingWesnoth/CrossCompiling|here is one way]].

'''Note:''' Packages for Wesnoth 1.4 and later include wesnothd by default since it's required by the "Host a network game" option from the Multiplayer menu, which is the preferred option for temporarily hosting a server instance to play in a LAN or privately through the Internet.

===Which versions of Wesnoth can play together?===

You only need to make sure you are using the same minor version number (6 in "1.6.x", 8 in "1.8.x" and so on) corresponding to stable branch releases. If you are using a development release (odd minor version numbers), you must be using exactly the same version number as other clients, to avoid out-of-sync (OOS) issues in multiplayer.

If you are using user-made eras or MP scenarios, all players should make sure they are using the same, latest version of the add-on.

== Translations ==

===Where can I find more information about translating Wesnoth?===
See [[WesnothTranslations]] for a list of currently maintained projects, and methods for contacting their maintainers and volunteering for help, and instructions for starting your own translation if it isn't included in the game already. [http://gettext.wesnoth.org] shows the current progress translations for different game development and stable branches, mainline campaigns and user-made add-ons.

== Other Questions You Have ==

The best way to get answers to less-frequently asked questions is by visiting the official [http://forums.wesnoth.org Battle for Wesnoth forums]. There are plenty of people willing to help. Make sure you read ALL of the forum sticky notes and announcements before posting!

[[Category:Troubleshooting and Bugs]]

UnitsWML

2007-08-18T17:26:50Z

Bruno: /* the [units] tag */

{{WML Tags}}
== the [units] tag ==

This tag is a top level WML tag which is in game.cfg.
It defines the set of all units in Wesnoth.

The following subtags are recognized:
* '''[unit]''' describes one unit type. See [[UnitWML]] for syntax.
* '''[trait]''' describes a global trait.
All races with the attribute '''ignore_global_traits=no''' will have this trait.
See '''[trait]''' below for syntax.
* '''[movetype]''' used to make shortcuts to describe units with similar terrain handicaps. Units from the same advancement tree should generally have the same movetype.
** ''name'' an ID for this movetype. Units with the attribute '''movetype=''name''''' will be assigned this movetype.
** ''flies'' either 'true' or 'false'(default). A unit with ''flies=true'' does not have its image's height adjusted for different terrains.
** '''[movement_costs]''' describes how fast the unit moves on different terrains. The attribute '''terrain=''speed''''' means that the unit will need to use ''speed'' move points to move onto the terrain with '''name=''terrain''''' (see [[TerrainWML]]).
** '''[defense]''' describes how likely the unit is to be hit on different terrains. The attribute '''terrain=''defense''''' means that the unit will be hit ''defense'' percent of the time in the terrain with '''name=''terrain'''''.
** '''[resistance]''' describes how much damage the unit takes from different types of attacks. The attribute '''type=''resistance''''' makes the unit receive '''resistance''' percent of damage, or resist '''100-resistance''' percent of damage from attacks with '''type=''type'''''. So for example, a resistance of fire=110 means, this unit will receive 110% of damage, or have a resistance of -10% as displayed in-game. A value of fire=0 would mean, the unit receives no damage and therefore has a resistance of 100%.
* '''[race]''' is used to make shortcuts to describe units with similar names. Units from the same advancement tree should generally have the same race. Also, units with the same race should generally be recruitable by the same sides/factions.
** ''name'' an ID for this race. Units with the attribute '''race=''name''''' will be assigned this race.
** ''male_names'', ''female_names'' lists of names (i.e. non-translatable strings). They are inputted into the Markov name generator to generate random names. ''male_names'' describes units with '''gender=male'''; ''female_names'' describes units with '''gender=female'''.
** ''markov_chain_size'' (default 2) number of letters per "syllable". "Syllables" are groupings of names that the Markov name generator uses to determine names. It does this by running a probability algorithm to guess from the name list which syllables fit well together, which can start or end a name, etc.
** ''not_living'' 'yes' or 'no'(default). Units with '''not_living=yes''' cannot be poisoned, drained from, or plagued (see [[AbilitiesWML]]). {{DevFeature}} ''not_living'' is no longer a property of race. Instead it is a per unit state that derives from the undead and mechanical traits.
** ''num_traits'' is the number of non-repeating traits each unit of this race can be assigned.
** ''ignore_global_traits'' 'yes' or 'no'(default). Determines whether global traits (see [traits] above) are applied.
** '''[trait]''' describes a trait for this race. :
*** ''id'' unique identifier
*** ''availability'' {{DevFeature}} describes whether a trait is "musthave" for a race or is available to "any" unit in a race, including leaders, or "none" if it is not normally available, but should be kept when advancing to this unit type. (Traits not available to the advanced unit type at all, are permanently lost upon advancement.) The default is for a trait to only be available to nonleaders. Currently "any" should not be used for traits available in multiplayer. It can be used for campaign specific traits. (Note that currently "musthave" is somewhat misused to have what are really abilities (''undead'' and ''mechanical'') default from a unit type's race. Ideally someone will eventually extend ''race'' to allow for default abilities. It might also be possible to unify traits and abilities with keys to indicate how you get them and what happens to them when you advance, while allowing them to come from race, unit type and unit definitions. There are also display issues related to doing this.)
*** ''male_name'' {{DevFeature}} text displayed in the status of unit with the trait if the unit is male.
*** ''female_name'' {{DevFeature}} text displayed in the status of unit with the trait if the unit is female.
*** ''name'' text displayed in the status of unit with the trait if none of the two above is used.
*** ''description'' text displayed for the description of the trait.
*** '''[effect]''', described in [[EffectWML]].

== See Also ==

* [[UnitWML]]
* [[ReferenceWML]]

[[Category: WML Reference]]

UnitsWML

2007-08-18T17:24:32Z

Bruno: /* the [units] tag */

{{WML Tags}}
== the [units] tag ==

This tag is a top level WML tag which is in game.cfg.
It defines the set of all units in Wesnoth.

The following subtags are recognized:
* '''[unit]''' describes one unit type. See [[UnitWML]] for syntax.
* '''[trait]''' describes a global trait.
All races with the attribute '''ignore_global_traits=no''' will have this trait.
See '''[trait]''' below for syntax.
* '''[movetype]''' used to make shortcuts to describe units with similar terrain handicaps. Units from the same advancement tree should generally have the same movetype.
** ''name'' an ID for this movetype. Units with the attribute '''movetype=''name''''' will be assigned this movetype.
** ''flies'' either 'true' or 'false'(default). A unit with ''flies=true'' does not have its image's height adjusted for different terrains.
** '''[movement_costs]''' describes how fast the unit moves on different terrains. The attribute '''terrain=''speed''''' means that the unit will need to use ''speed'' move points to move onto the terrain with '''name=''terrain''''' (see [[TerrainWML]]).
** '''[defense]''' describes how likely the unit is to be hit on different terrains. The attribute '''terrain=''defense''''' means that the unit will be hit ''defense'' percent of the time in the terrain with '''name=''terrain'''''.
** '''[resistance]''' describes how much damage the unit takes from different types of attacks. The attribute '''type=''resistance''''' makes the unit receive '''resistance''' percent of damage, or resist '''100-resistance''' percent of damage from attacks with '''type=''type'''''. So for example, a resistance of fire=110 means, this unit will receive 110% of damage, or have a resistance of -10% as displayed in-game. A value of fire=0 would mean, the unit receives no damage and therefore has a resistance of 100%.
* '''[race]''' is used to make shortcuts to describe units with similar names. Units from the same advancement tree should generally have the same race. Also, units with the same race should generally be recruitable by the same sides/factions.
** ''name'' an ID for this race. Units with the attribute '''race=''name''''' will be assigned this race.
** ''male_names'', ''female_names'' lists of names (i.e. non-translatable strings). They are inputted into the Markov name generator to generate random names. ''male_names'' describes units with '''gender=male'''; ''female_names'' describes units with '''gender=female'''.
** ''markov_chain_size'' (default 2) number of letters per "syllable". "Syllables" are groupings of names that the Markov name generator uses to determine names. It does this by running a probability algorithm to guess from the name list which syllables fit well together, which can start or end a name, etc.
** ''not_living'' 'yes' or 'no'(default). Units with '''not_living=yes''' cannot be poisoned, drained from, or plagued (see [[AbilitiesWML]]). {{DevFeature}} ''not_living'' is no longer a property of race. Instead it is a per unit state that derives from the undead and mechanical traits.
** ''num_traits'' is the number of non-repeating traits each unit of this race can be assigned.
** ''ignore_global_traits'' 'yes' or 'no'(default). Determines whether global traits (see [traits] above) are applied.
** '''[trait]''' describes a trait for this race. :
*** ''id'' unique identifier
*** ''availability'' {{DevFeature}} describes whether a trait is "musthave" for a race or is available to "any" unit in a race, including leaders, or "none" if it is not normally available, but should be kept when advancing to this unit type. The default is for a trait to only be available to nonleaders. Currently "any" should not be used for traits available in multiplayer. It can be used for campaign specific traits. (Note that currently "musthave" is somewhat misused to have what are really abilities (''undead'' and ''mechanical'') default from a unit type's race. Ideally someone will eventually extend ''race'' to allow for default abilities. It might also be possible to unify traits and abilities with keys to indicate how you get them and what happens to them when you advance, while allowing them to come from race, unit type and unit definitions. There are also display issues related to doing this.)
*** ''male_name'' {{DevFeature}} text displayed in the status of unit with the trait if the unit is male.
*** ''female_name'' {{DevFeature}} text displayed in the status of unit with the trait if the unit is female.
*** ''name'' text displayed in the status of unit with the trait if none of the two above is used.
*** ''description'' text displayed for the description of the trait.
*** '''[effect]''', described in [[EffectWML]].

== See Also ==

* [[UnitWML]]
* [[ReferenceWML]]

[[Category: WML Reference]]

UnitsWML

2007-08-18T17:20:52Z

Bruno: /* the [units] tag */

{{WML Tags}}
== the [units] tag ==

This tag is a top level WML tag which is in game.cfg.
It defines the set of all units in Wesnoth.

The following subtags are recognized:
* '''[unit]''' describes one unit type. See [[UnitWML]] for syntax.
* '''[trait]''' describes a global trait.
All races with the attribute '''ignore_global_traits=no''' will have this trait.
See '''[trait]''' below for syntax.
* '''[movetype]''' used to make shortcuts to describe units with similar terrain handicaps. Units from the same advancement tree should generally have the same movetype.
** ''name'' an ID for this movetype. Units with the attribute '''movetype=''name''''' will be assigned this movetype.
** ''flies'' either 'true' or 'false'(default). A unit with ''flies=true'' does not have its image's height adjusted for different terrains.
** '''[movement_costs]''' describes how fast the unit moves on different terrains. The attribute '''terrain=''speed''''' means that the unit will need to use ''speed'' move points to move onto the terrain with '''name=''terrain''''' (see [[TerrainWML]]).
** '''[defense]''' describes how likely the unit is to be hit on different terrains. The attribute '''terrain=''defense''''' means that the unit will be hit ''defense'' percent of the time in the terrain with '''name=''terrain'''''.
** '''[resistance]''' describes how much damage the unit takes from different types of attacks. The attribute '''type=''resistance''''' makes the unit receive '''resistance''' percent of damage, or resist '''100-resistance''' percent of damage from attacks with '''type=''type'''''. So for example, a resistance of fire=110 means, this unit will receive 110% of damage, or have a resistance of -10% as displayed in-game. A value of fire=0 would mean, the unit receives no damage and therefore has a resistance of 100%.
* '''[race]''' is used to make shortcuts to describe units with similar names. Units from the same advancement tree should generally have the same race. Also, units with the same race should generally be recruitable by the same sides/factions.
** ''name'' an ID for this race. Units with the attribute '''race=''name''''' will be assigned this race.
** ''male_names'', ''female_names'' lists of names (i.e. non-translatable strings). They are inputted into the Markov name generator to generate random names. ''male_names'' describes units with '''gender=male'''; ''female_names'' describes units with '''gender=female'''.
** ''markov_chain_size'' (default 2) number of letters per "syllable". "Syllables" are groupings of names that the Markov name generator uses to determine names. It does this by running a probability algorithm to guess from the name list which syllables fit well together, which can start or end a name, etc.
** ''not_living'' 'yes' or 'no'(default). Units with '''not_living=yes''' cannot be poisoned, drained from, or plagued (see [[AbilitiesWML]]). {{DevFeature}} ''not_living'' is no longer a property of race. Instead it is a per unit state that derives from the undead and mechanical traits.
** ''num_traits'' is the number of non-repeating traits each unit of this race can be assigned.
** ''ignore_global_traits'' 'yes' or 'no'(default). Determines whether global traits (see [traits] above) are applied.
** '''[trait]''' describes a trait for this race. :
*** ''id'' unique identifier
*** ''availability'' {{DevFeature}} describes whether a trait is "musthave" for a race or is available to "any" unit in a race, including leaders, or "none" if it is only available if manually set or when advancing to a this unit type. The default is for a trait to only be available to nonleaders. Currently "any" should not be used for traits available in multiplayer. It can be used for campaign specific traits. (Note that currently "musthave" is somewhat misused to have what are really abilities (''undead'' and ''mechanical'') default from a unit type's race. Ideally someone will eventually extend ''race'' to allow for default abilities. It might also be possible to unify traits and abilities with keys to indicate how you get them and what happens to them when you advance, while allowing them to come from race, unit type and unit definitions. There are also display issues related to doing this.)
*** ''male_name'' {{DevFeature}} text displayed in the status of unit with the trait if the unit is male.
*** ''female_name'' {{DevFeature}} text displayed in the status of unit with the trait if the unit is female.
*** ''name'' text displayed in the status of unit with the trait if none of the two above is used.
*** ''description'' text displayed for the description of the trait.
*** '''[effect]''', described in [[EffectWML]].

== See Also ==

* [[UnitWML]]
* [[ReferenceWML]]

[[Category: WML Reference]]

UnitsWML

2007-08-18T17:15:02Z

Bruno: /* the [units] tag */

{{WML Tags}}
== the [units] tag ==

This tag is a top level WML tag which is in game.cfg.
It defines the set of all units in Wesnoth.

The following subtags are recognized:
* '''[unit]''' describes one unit type. See [[UnitWML]] for syntax.
* '''[trait]''' describes a global trait.
All races with the attribute '''ignore_global_traits=no''' will have this trait.
See '''[trait]''' below for syntax.
* '''[movetype]''' used to make shortcuts to describe units with similar terrain handicaps. Units from the same advancement tree should generally have the same movetype.
** ''name'' an ID for this movetype. Units with the attribute '''movetype=''name''''' will be assigned this movetype.
** ''flies'' either 'true' or 'false'(default). A unit with ''flies=true'' does not have its image's height adjusted for different terrains.
** '''[movement_costs]''' describes how fast the unit moves on different terrains. The attribute '''terrain=''speed''''' means that the unit will need to use ''speed'' move points to move onto the terrain with '''name=''terrain''''' (see [[TerrainWML]]).
** '''[defense]''' describes how likely the unit is to be hit on different terrains. The attribute '''terrain=''defense''''' means that the unit will be hit ''defense'' percent of the time in the terrain with '''name=''terrain'''''.
** '''[resistance]''' describes how much damage the unit takes from different types of attacks. The attribute '''type=''resistance''''' makes the unit receive '''resistance''' percent of damage, or resist '''100-resistance''' percent of damage from attacks with '''type=''type'''''. So for example, a resistance of fire=110 means, this unit will receive 110% of damage, or have a resistance of -10% as displayed in-game. A value of fire=0 would mean, the unit receives no damage and therefore has a resistance of 100%.
* '''[race]''' is used to make shortcuts to describe units with similar names. Units from the same advancement tree should generally have the same race. Also, units with the same race should generally be recruitable by the same sides/factions.
** ''name'' an ID for this race. Units with the attribute '''race=''name''''' will be assigned this race.
** ''male_names'', ''female_names'' lists of names (i.e. non-translatable strings). They are inputted into the Markov name generator to generate random names. ''male_names'' describes units with '''gender=male'''; ''female_names'' describes units with '''gender=female'''.
** ''markov_chain_size'' (default 2) number of letters per "syllable". "Syllables" are groupings of names that the Markov name generator uses to determine names. It does this by running a probability algorithm to guess from the name list which syllables fit well together, which can start or end a name, etc.
** ''not_living'' 'yes' or 'no'(default). Units with '''not_living=yes''' cannot be poisoned, drained from, or plagued (see [[AbilitiesWML]]). {{DevFeature}} ''not_living'' is no longer a property of race. Instead it is a per unit state that derives from the undead and mechanical traits.
** ''num_traits'' is the number of non-repeating traits each unit of this race can be assigned.
** ''ignore_global_traits'' 'yes' or 'no'(default). Determines whether global traits (see [traits] above) are applied.
** '''[trait]''' describes a trait for this race. :
*** ''id'' unique identifier
*** ''availability'' {{DevFeature}} describes whether a trait is "musthave" for a race or is available to "any" unit in a race, including leaders. The default is for a trait to only be available to nonleaders. Currently "any" should not be used for traits available in multiplayer. It can be used for campaign specific traits. (Note that currently "musthave" is somewhat misused to have what are really abilities (''undead'' and ''mechanical'') default from a unit type's race. Ideally someone will eventually extend ''race'' to allow for default abilities. It might also be possible to unify traits and abilities with keys to indicate how you get them and what happens to them when you advance, while allowing them to come from race, unit type and unit definitions. There are also display issues related to doing this.)
*** ''keeponadvance'' 'yes' or 'no'(default). {{DevFeature}} 'yes' says to keep this trait when advancing even if the trait is not available to the advanced unit. Normally traits unavailable to the advanced unit are lost permanently.
*** ''male_name'' {{DevFeature}} text displayed in the status of unit with the trait if the unit is male.
*** ''female_name'' {{DevFeature}} text displayed in the status of unit with the trait if the unit is female.
*** ''name'' text displayed in the status of unit with the trait if none of the two above is used.
*** ''description'' text displayed for the description of the trait.
*** '''[effect]''', described in [[EffectWML]].

== See Also ==

* [[UnitWML]]
* [[ReferenceWML]]

[[Category: WML Reference]]

UnitsWML

2007-08-18T17:13:24Z

Bruno: /* the [units] tag */

{{WML Tags}}
== the [units] tag ==

This tag is a top level WML tag which is in game.cfg.
It defines the set of all units in Wesnoth.

The following subtags are recognized:
* '''[unit]''' describes one unit type. See [[UnitWML]] for syntax.
* '''[trait]''' describes a global trait.
All races with the attribute '''ignore_global_traits=no''' will have this trait.
See '''[trait]''' below for syntax.
* '''[movetype]''' used to make shortcuts to describe units with similar terrain handicaps. Units from the same advancement tree should generally have the same movetype.
** ''name'' an ID for this movetype. Units with the attribute '''movetype=''name''''' will be assigned this movetype.
** ''flies'' either 'true' or 'false'(default). A unit with ''flies=true'' does not have its image's height adjusted for different terrains.
** '''[movement_costs]''' describes how fast the unit moves on different terrains. The attribute '''terrain=''speed''''' means that the unit will need to use ''speed'' move points to move onto the terrain with '''name=''terrain''''' (see [[TerrainWML]]).
** '''[defense]''' describes how likely the unit is to be hit on different terrains. The attribute '''terrain=''defense''''' means that the unit will be hit ''defense'' percent of the time in the terrain with '''name=''terrain'''''.
** '''[resistance]''' describes how much damage the unit takes from different types of attacks. The attribute '''type=''resistance''''' makes the unit receive '''resistance''' percent of damage, or resist '''100-resistance''' percent of damage from attacks with '''type=''type'''''. So for example, a resistance of fire=110 means, this unit will receive 110% of damage, or have a resistance of -10% as displayed in-game. A value of fire=0 would mean, the unit receives no damage and therefore has a resistance of 100%.
* '''[race]''' is used to make shortcuts to describe units with similar names. Units from the same advancement tree should generally have the same race. Also, units with the same race should generally be recruitable by the same sides/factions.
** ''name'' an ID for this race. Units with the attribute '''race=''name''''' will be assigned this race.
** ''male_names'', ''female_names'' lists of names (i.e. non-translatable strings). They are inputted into the Markov name generator to generate random names. ''male_names'' describes units with '''gender=male'''; ''female_names'' describes units with '''gender=female'''.
** ''markov_chain_size'' (default 2) number of letters per "syllable". "Syllables" are groupings of names that the Markov name generator uses to determine names. It does this by running a probability algorithm to guess from the name list which syllables fit well together, which can start or end a name, etc.
** ''not_living'' 'yes' or 'no'(default). Units with '''not_living=yes''' cannot be poisoned, drained from, or plagued (see [[AbilitiesWML]]). {{DevFeature}} ''not_living'' is no longer a property of race. Instead it is a per unit state that derives from the undead and mechanical traits.
** ''num_traits'' is the number of non-repeating traits each unit of this race can be assigned.
** ''ignore_global_traits'' 'yes' or 'no'(default). Determines whether global traits (see [traits] above) are applied.
** '''[trait]''' describes a trait for this race. :
*** ''id'' unique identifier
*** ''availability'' {{DevFeature}} describes whether a trait is "musthave" for a race or is available to "any" unit in a race, including leaders. The default is for a trait to only be available to nonleaders. Currently "any" should not be used for traits available in multiplayer. It can be used for campaign specific traits. (Note that currently "musthave" is somewhat misused to have what are really abilities (''undead'' and ''mechanical'') default from a unit type's race. Ideally someone will eventually extend ''race'' to allow for default abilities. It might also be possible to unify traits and abilities with keys to indicate how you get them and what happens to them when you advance, while allowing them to come from race, unit type and unit definitions. There are also display issues related to doing this.)
*** ''keeponadvance'' 'yes' or 'no'(default). 'yes' says to keep this trait when advancing even if the trait is not available to the advanced unit. Normally traits unavailable to the advanced unit are lost permanently.
*** ''male_name'' {{DevFeature}} text displayed in the status of unit with the trait if the unit is male.
*** ''female_name'' {{DevFeature}} text displayed in the status of unit with the trait if the unit is female.
*** ''name'' text displayed in the status of unit with the trait if none of the two above is used.
*** ''description'' text displayed for the description of the trait.
*** '''[effect]''', described in [[EffectWML]].

== See Also ==

* [[UnitWML]]
* [[ReferenceWML]]

[[Category: WML Reference]]

UnitsWML

2007-08-16T13:31:37Z

Bruno: /* the [units] tag */

{{WML Tags}}
== the [units] tag ==

This tag is a top level WML tag which is in game.cfg.
It defines the set of all units in Wesnoth.

The following subtags are recognized:
* '''[unit]''' describes one unit type. See [[UnitWML]] for syntax.
* '''[trait]''' describes a global trait.
All races with the attribute '''ignore_global_traits=no''' will have this trait.
See '''[trait]''' below for syntax.
* '''[movetype]''' used to make shortcuts to describe units with similar terrain handicaps. Units from the same advancement tree should generally have the same movetype.
** ''name'' an ID for this movetype. Units with the attribute '''movetype=''name''''' will be assigned this movetype.
** ''flies'' either 'true' or 'false'(default). A unit with ''flies=true'' does not have its image's height adjusted for different terrains.
** '''[movement_costs]''' describes how fast the unit moves on different terrains. The attribute '''terrain=''speed''''' means that the unit will need to use ''speed'' move points to move onto the terrain with '''name=''terrain''''' (see [[TerrainWML]]).
** '''[defense]''' describes how likely the unit is to be hit on different terrains. The attribute '''terrain=''defense''''' means that the unit will be hit ''defense'' percent of the time in the terrain with '''name=''terrain'''''.
** '''[resistance]''' describes how much damage the unit takes from different types of attacks. The attribute '''type=''resistance''''' makes the unit receive '''resistance''' percent of damage, or resist '''100-resistance''' percent of damage from attacks with '''type=''type'''''. So for example, a resistance of fire=110 means, this unit will receive 110% of damage, or have a resistance of -10% as displayed in-game. A value of fire=0 would mean, the unit receives no damage and therefore has a resistance of 100%.
* '''[race]''' is used to make shortcuts to describe units with similar names. Units from the same advancement tree should generally have the same race. Also, units with the same race should generally be recruitable by the same sides/factions.
** ''name'' an ID for this race. Units with the attribute '''race=''name''''' will be assigned this race.
** ''male_names'', ''female_names'' lists of names (i.e. non-translatable strings). They are inputted into the Markov name generator to generate random names. ''male_names'' describes units with '''gender=male'''; ''female_names'' describes units with '''gender=female'''.
** ''markov_chain_size'' (default 2) number of letters per "syllable". "Syllables" are groupings of names that the Markov name generator uses to determine names. It does this by running a probability algorithm to guess from the name list which syllables fit well together, which can start or end a name, etc.
** ''not_living'' 'yes' or 'no'(default). Units with '''not_living=yes''' cannot be poisoned, drained from, or plagued (see [[AbilitiesWML]]). {{DevFeature}} ''not_living'' is no longer a property of race. Instead it is a per unit state that derives from the undead and mechanical traits.
** ''num_traits'' is the number of non-repeating traits each unit of this race can be assigned.
** ''ignore_global_traits'' 'yes' or 'no'(default). Determines whether global traits (see [traits] above) are applied.
** '''[trait]''' describes a trait for this race. :
*** ''id'' unique identifier
*** ''availability'' {{DevFeature}} describes whether a trait is "musthave" for a race or is available to "any" unit in a race, including leaders. The default is for a trait to only be available to nonleaders. Currently "any" should not be used for traits available in multiplayer. It can be used for campaign specific traits. (Note that currently "musthave" is somewhat misused to have what are really abilities (''undead'' and ''mechanical'') default from a unit type's race. Ideally someone will eventually extend ''race'' to allow for default abilities. It might also be possible to unify traits and abilities with keys to indicate how you get them and what happens to them when you advance, while allowing them to come from race, unit type and unit definitions. There are also display issues related to doing this.)
*** ''male_name'' {{DevFeature}} text displayed in the status of unit with the trait if the unit is male.
*** ''female_name'' {{DevFeature}} text displayed in the status of unit with the trait if the unit is female.
*** ''name'' text displayed in the status of unit with the trait if none of the two above is used.
*** ''description'' text displayed for the description of the trait.
*** '''[effect]''', described in [[EffectWML]].

== See Also ==

* [[UnitWML]]
* [[ReferenceWML]]

[[Category: WML Reference]]

UnitsWML

2007-08-16T04:54:07Z

Bruno: /* the [units] tag */

{{WML Tags}}
== the [units] tag ==

This tag is a top level WML tag which is in game.cfg.
It defines the set of all units in Wesnoth.

The following subtags are recognized:
* '''[unit]''' describes one unit type. See [[UnitWML]] for syntax.
* '''[trait]''' describes a global trait.
All races with the attribute '''ignore_global_traits=no''' will have this trait.
See '''[trait]''' below for syntax.
* '''[movetype]''' used to make shortcuts to describe units with similar terrain handicaps. Units from the same advancement tree should generally have the same movetype.
** ''name'' an ID for this movetype. Units with the attribute '''movetype=''name''''' will be assigned this movetype.
** ''flies'' either 'true' or 'false'(default). A unit with ''flies=true'' does not have its image's height adjusted for different terrains.
** '''[movement_costs]''' describes how fast the unit moves on different terrains. The attribute '''terrain=''speed''''' means that the unit will need to use ''speed'' move points to move onto the terrain with '''name=''terrain''''' (see [[TerrainWML]]).
** '''[defense]''' describes how likely the unit is to be hit on different terrains. The attribute '''terrain=''defense''''' means that the unit will be hit ''defense'' percent of the time in the terrain with '''name=''terrain'''''.
** '''[resistance]''' describes how much damage the unit takes from different types of attacks. The attribute '''type=''resistance''''' makes the unit receive '''resistance''' percent of damage, or resist '''100-resistance''' percent of damage from attacks with '''type=''type'''''. So for example, a resistance of fire=110 means, this unit will receive 110% of damage, or have a resistance of -10% as displayed in-game. A value of fire=0 would mean, the unit receives no damage and therefore has a resistance of 100%.
* '''[race]''' is used to make shortcuts to describe units with similar names. Units from the same advancement tree should generally have the same race. Also, units with the same race should generally be recruitable by the same sides/factions.
** ''name'' an ID for this race. Units with the attribute '''race=''name''''' will be assigned this race.
** ''male_names'', ''female_names'' lists of names (i.e. non-translatable strings). They are inputted into the Markov name generator to generate random names. ''male_names'' describes units with '''gender=male'''; ''female_names'' describes units with '''gender=female'''.
** ''markov_chain_size'' (default 2) number of letters per "syllable". "Syllables" are groupings of names that the Markov name generator uses to determine names. It does this by running a probability algorithm to guess from the name list which syllables fit well together, which can start or end a name, etc.
** ''not_living'' 'yes' or 'no'(default). Units with '''not_living=yes''' cannot be poisoned, drained from, or plagued (see [[AbilitiesWML]]). {{DevFeature}} ''not_living'' is no longer a property of race. Instead it is a per unit state that derives from the undead and mechanical traits.
** ''num_traits'' is the number of non-repeating traits each unit of this race can be assigned.
** ''ignore_global_traits'' 'yes' or 'no'(default). Determines whether global traits (see [traits] above) are applied.
** '''[trait]''' describes a trait for this race. :
*** ''id'' unique identifier
*** ''availability'' {{DevFeature}} describes whether a trait is "musthave" for a race or is available to "any" unit in a race, including leaders. The default is for a trait to only be available to nonleaders. Currently "any" should not be used for traits available in multiplayer. It can be used for campaign specific traits.
*** ''male_name'' {{DevFeature}} text displayed in the status of unit with the trait if the unit is male.
*** ''female_name'' {{DevFeature}} text displayed in the status of unit with the trait if the unit is female.
*** ''name'' text displayed in the status of unit with the trait if none of the two above is used.
*** ''description'' text displayed for the description of the trait.
*** '''[effect]''', described in [[EffectWML]].

== See Also ==

* [[UnitWML]]
* [[ReferenceWML]]

[[Category: WML Reference]]

UnitsWML

2007-08-15T14:44:58Z

Bruno: /* the [units] tag */

{{WML Tags}}
== the [units] tag ==

This tag is a top level WML tag which is in game.cfg.
It defines the set of all units in Wesnoth.

The following subtags are recognized:
* '''[unit]''' describes one unit type. See [[UnitWML]] for syntax.
* '''[trait]''' describes a global trait.
All races with the attribute '''ignore_global_traits=no''' will have this trait.
See '''[trait]''' below for syntax.
* '''[movetype]''' used to make shortcuts to describe units with similar terrain handicaps. Units from the same advancement tree should generally have the same movetype.
** ''name'' an ID for this movetype. Units with the attribute '''movetype=''name''''' will be assigned this movetype.
** ''flies'' either 'true' or 'false'(default). A unit with ''flies=true'' does not have its image's height adjusted for different terrains.
** '''[movement_costs]''' describes how fast the unit moves on different terrains. The attribute '''terrain=''speed''''' means that the unit will need to use ''speed'' move points to move onto the terrain with '''name=''terrain''''' (see [[TerrainWML]]).
** '''[defense]''' describes how likely the unit is to be hit on different terrains. The attribute '''terrain=''defense''''' means that the unit will be hit ''defense'' percent of the time in the terrain with '''name=''terrain'''''.
** '''[resistance]''' describes how much damage the unit takes from different types of attacks. The attribute '''type=''resistance''''' makes the unit receive '''resistance''' percent of damage, or resist '''100-resistance''' percent of damage from attacks with '''type=''type'''''. So for example, a resistance of fire=110 means, this unit will receive 110% of damage, or have a resistance of -10% as displayed in-game. A value of fire=0 would mean, the unit receives no damage and therefore has a resistance of 100%.
* '''[race]''' is used to make shortcuts to describe units with similar names. Units from the same advancement tree should generally have the same race. Also, units with the same race should generally be recruitable by the same sides/factions.
** ''name'' an ID for this race. Units with the attribute '''race=''name''''' will be assigned this race.
** ''male_names'', ''female_names'' lists of names (i.e. non-translatable strings). They are inputted into the Markov name generator to generate random names. ''male_names'' describes units with '''gender=male'''; ''female_names'' describes units with '''gender=female'''.
** ''markov_chain_size'' (default 2) number of letters per "syllable". "Syllables" are groupings of names that the Markov name generator uses to determine names. It does this by running a probability algorithm to guess from the name list which syllables fit well together, which can start or end a name, etc.
** ''not_living'' 'yes' or 'no'(default). Units with '''not_living=yes''' cannot be poisoned, drained from, or plagued (see [[AbilitiesWML]]). {{DevFeature}} ''not_living'' is no longer a property of race. Instead it is a per unit state that derives from the undead and mechanical traits. However, these traits really should be converted to abilities since they are (mostly) forced for a particular unit_type.
** ''num_traits'' is the number of non-repeating traits each unit of this race can be assigned.
** ''ignore_global_traits'' 'yes' or 'no'(default). Determines whether global traits (see [traits] above) are applied.
** '''[trait]''' describes a trait for this race. :
*** ''id'' unique identifier
*** ''availability'' {{DevFeature}} describes whether a trait is "musthave" for a race or is available to "any" unit in a race, including leaders. The default is for a trait to only be available to nonleaders. Currently "any" should not be used for traits available in multiplayer. It can be used for campaign specific traits.
*** ''male_name'' {{DevFeature}} text displayed in the status of unit with the trait if the unit is male.
*** ''female_name'' {{DevFeature}} text displayed in the status of unit with the trait if the unit is female.
*** ''name'' text displayed in the status of unit with the trait if none of the two above is used.
*** ''description'' text displayed for the description of the trait.
*** '''[effect]''', described in [[EffectWML]].

== See Also ==

* [[UnitWML]]
* [[ReferenceWML]]

[[Category: WML Reference]]

UnitsWML

2007-08-15T14:44:01Z

Bruno: /* the [units] tag */

{{WML Tags}}
== the [units] tag ==

This tag is a top level WML tag which is in game.cfg.
It defines the set of all units in Wesnoth.

The following subtags are recognized:
* '''[unit]''' describes one unit type. See [[UnitWML]] for syntax.
* '''[trait]''' describes a global trait.
All races with the attribute '''ignore_global_traits=no''' will have this trait.
See '''[trait]''' below for syntax.
* '''[movetype]''' used to make shortcuts to describe units with similar terrain handicaps. Units from the same advancement tree should generally have the same movetype.
** ''name'' an ID for this movetype. Units with the attribute '''movetype=''name''''' will be assigned this movetype.
** ''flies'' either 'true' or 'false'(default). A unit with ''flies=true'' does not have its image's height adjusted for different terrains.
** '''[movement_costs]''' describes how fast the unit moves on different terrains. The attribute '''terrain=''speed''''' means that the unit will need to use ''speed'' move points to move onto the terrain with '''name=''terrain''''' (see [[TerrainWML]]).
** '''[defense]''' describes how likely the unit is to be hit on different terrains. The attribute '''terrain=''defense''''' means that the unit will be hit ''defense'' percent of the time in the terrain with '''name=''terrain'''''.
** '''[resistance]''' describes how much damage the unit takes from different types of attacks. The attribute '''type=''resistance''''' makes the unit receive '''resistance''' percent of damage, or resist '''100-resistance''' percent of damage from attacks with '''type=''type'''''. So for example, a resistance of fire=110 means, this unit will receive 110% of damage, or have a resistance of -10% as displayed in-game. A value of fire=0 would mean, the unit receives no damage and therefore has a resistance of 100%.
* '''[race]''' is used to make shortcuts to describe units with similar names. Units from the same advancement tree should generally have the same race. Also, units with the same race should generally be recruitable by the same sides/factions.
** ''name'' an ID for this race. Units with the attribute '''race=''name''''' will be assigned this race.
** ''male_names'', ''female_names'' lists of names (i.e. non-translatable strings). They are inputted into the Markov name generator to generate random names. ''male_names'' describes units with '''gender=male'''; ''female_names'' describes units with '''gender=female'''.
** ''markov_chain_size'' (default 2) number of letters per "syllable". "Syllables" are groupings of names that the Markov name generator uses to determine names. It does this by running a probability algorithm to guess from the name list which syllables fit well together, which can start or end a name, etc.
** ''not_living'' 'yes' or 'no'(default). Units with '''not_living=yes''' cannot be poisoned, drained from, or plagued (see [[AbilitiesWML]]). {{DevFeature}} not_living is no longer a property of race. Instead it is a per unit state that derives from the undead and mechanical traits. However, these traits really should be converted to abilities since they are (mostly) forced for a particular unit_type.
** ''num_traits'' is the number of non-repeating traits each unit of this race can be assigned.
** ''ignore_global_traits'' 'yes' or 'no'(default). Determines whether global traits (see [traits] above) are applied.
** '''[trait]''' describes a trait for this race. :
*** ''id'' unique identifier
*** ''availability'' {{DevFeature}} describes whether a trait is "musthave" for a race or is available to "any" unit in a race, including leaders. The default is for a trait to only be available to nonleaders. Currently "any" should not be used for traits available in multiplayer. It can be used for campaign specific traits.
*** ''male_name'' {{DevFeature}} text displayed in the status of unit with the trait if the unit is male.
*** ''female_name'' {{DevFeature}} text displayed in the status of unit with the trait if the unit is female.
*** ''name'' text displayed in the status of unit with the trait if none of the two above is used.
*** ''description'' text displayed for the description of the trait.
*** '''[effect]''', described in [[EffectWML]].

== See Also ==

* [[UnitWML]]
* [[ReferenceWML]]

[[Category: WML Reference]]

SingleUnitWML

2007-08-15T13:32:19Z

Bruno: /* How to describe a single unit */

{{WML Tags}}
== How to describe a single unit ==

This tag, '''[unit]''', describes a single unit on the map, for example Konrad.
It is different from the [unit] in [units], which describes a class of units.

The following keys are recognized:
* ''type'' the ID of the unit's unit type. See [[UnitWML]].

* ''side'' the side that the unit is on.

* ''gender'' can be set to male or female to designate the gender of the unit. Default is male.

* ''x'', ''y'' the location of the unit. If a location isn't provided and the side the unit will belong to has a recall list, the unit will be created on the recall list.

* ''description'' a unique identifier for the unit. This is not displayed to the player, but is to be used only for identifying and filtering for units. {{DevFeature}} If not specified or when a unit is normally recruited, a random one will be generated for the unit to ensure that each unit has a unique ''description''.

* ''user_description'' the name of the unit that is shown to the player. Note that the player may use the "rename unit" action to change this.

* ''generate_description'' if set to "yes", will generate a new name (''user_description'' only, not ''description'') for the unit, as if the unit was a freshly-recruited one.

* ''unrenamable'' if 'yes', the ''user_description'' cannot be changed by the player (which is only possible when the unit is on the player's side anyway).

* ''traits_description'' the description of the unit's traits which is displayed. However if it is not specified explicitly, the unit's actual traits' names will be used instead, so it is normally not necessary to set this.

* ''random_traits'' {{DevFeature}}"no" will prevent random trait generation for units. You should only need to set this for placed nonleaders in multiplayer games or if you want to give a unit less traits than it would normally get for its unit type. When generating traits for a unit, first traits the unit has already been given are excluded. Then "musthave" traits (undead, mechanical) for the unit type are given. Then for leaders ('''canrecruit=1''') traits that are not available to "any" (currently that's all of them to avoid a multiplayer OOS issue, but later will be restricted based on multiplayer play balance issues) are removed from consideration. Then traits are added randomly until the maximum allowed for the unit type is reached or there are no more available traits.

* ''canrecruit'' a special key for leaders.
** '0' default. Unit cannot recruit.
** '1' unit can recruit.
: Normally when a team controls no units with '''canrecruit=1''', that team loses. However, even if your team has lost you continue to play with whatever units you still have until the scenario is over. Usually scenarios end when only one team is left with a leader that can recruit, but special victory conditions can be set up in campaigns. Normally you want to set the leader of a side with '''canrecruit=1'''. If you don't want the leader to recruit, it is usually better to just not give him any unit types to recruit, than to make a special victory condition. {{DevFeature}} Units with '''canrecruit=1''' are exempt from upkeep costs. So that leaders do not need to be given the ''loyal'' trait.

* ''variation'' the variation of itself the unit should be created as.

* ''upkeep'' the amount of upkeep the unit costs.
** "loyal" no upkeep cost. Can be changed by the effect 'loyal' (see [[EffectWML]])
** "full" unit costs ''level'' upkeep (see [[UnitWML]]).
** An integer can be used to set the upkeep cost to that number.
** The default is "full".
** Leaders (units with '''canrecruit=1''') never pay upkeep no matter what upkeep is set to.
** Normally you don't want to muck with this value. If you want to give a side units without upkeep costs, give those units the 'loyal' trait.

* ''overlays'' a list of images that are overlayed on the unit.

* ''goto_x'', ''goto_y'' UI settings that control courses. Default is 0,0 i.e. the unit is not on a course.

* ''hitpoints'' the HP of the unit. Default is the max HP for ''type''.

* ''experience'' the XP of the unit. Default is 0.

* ''moves'' number of move points the unit has left. Default is the movement for ''type''.

* ''resting'' whether the unit has not moved yet this turn. Used to decide whether to give a unit rest healing.

* ''role'' used in standard unit filter ([[FilterWML]]). Can be set using [role] (see [[InternalActionsWML]]).

* ''ai_special'' causes the unit to act differently.
** "guardian" the unit will not move, except to attack something in the turn it moves (so, it only can move if an enemy unit gets within range of it).

* ''facing'' which way the unit is facing (this only affects how the unit is displayed).
** Possible values are ''se'', ''s'', ''sw'', ''nw'', ''n'', ''ne''. Using ''sw'' is preferred for a "reversed" facing (looking to the left) and ''se'' for a normal (looking to the right) facing.

* ''profile'' sets a default portrait image for this unit. If the unit type already has a portrait set, this is used instead for this unit. When the unit advances, if the value of profile is different from the unit-type portrait, that value is preserved. If the profile field is empty or the same as the unit-type portrait, the level-advance changes the unit portrait to the default for the new level and type.

** "unit_image" if given instead of a filename, uses the unit's base image as the portrait (in the same manner that unit types without portraits do by default).

* ''animate'' if ''yes'', fades the unit in like when it's recruited/recalled.

* '''[status]''' the status of the unit. This affects different features of the unit, for example whether the unit loses health each turn. Default for all keys is 'off', but this can be changed by the scenario or by special abilities (see [[AbilitiesWML]]). The status of a unit is displayed on the Status Table; each status modification ''statusmod'' is represented by the image '''misc/statusmod.png'''.
** ''poisoned'' if 'on', the unit loses 8 HP each turn. See also ''heals'', ''cures'', [[AbilitiesWML]].
** ''slowed'' if 'on', the unit has 50% of its normal movement and does half damage. When the controller of the unit's turn is over, ''slowed'' is set to 'off'
** ''stone'' if 'on', the unit cannot move, attack, or be attacked.
** ''hides'' if 'yes', the unit cannot be seen by opponents.

* '''[variables]''' a set of variables that will be stored when this unit is stored (See [store_unit], [[InternalActionsWML]]). The attribute '''variable'''='''value''' means that when the unit is stored in the array ''unit'', the variable ''unit''.variables.''variable'' will have the value ''value'' (See [[VariablesWML]]).

* '''[modifications]''' changes that have been made to the unit.
** '''[trait]''' a trait the unit has. Same format as [trait], [[UnitsWML]].
** '''[object]''' an object the unit has. Same format as [object], [[DirectActionsWML]].

* ''unit_description'' overrides the unit type description for this unit. You will probably want to set up a ''post_advance'' [[EventWML|event]] to override the default description after promotions.

== See Also ==

* [[UnitWML]]
* [[ReferenceWML]]

UnitsWML

2007-08-15T13:22:03Z

Bruno: /* the [units] tag */

{{WML Tags}}
== the [units] tag ==

This tag is a top level WML tag which is in game.cfg.
It defines the set of all units in Wesnoth.

The following subtags are recognized:
* '''[unit]''' describes one unit type. See [[UnitWML]] for syntax.
* '''[trait]''' describes a global trait.
All races with the attribute '''ignore_global_traits=no''' will have this trait.
See '''[trait]''' below for syntax.
* '''[movetype]''' used to make shortcuts to describe units with similar terrain handicaps. Units from the same advancement tree should generally have the same movetype.
** ''name'' an ID for this movetype. Units with the attribute '''movetype=''name''''' will be assigned this movetype.
** ''flies'' either 'true' or 'false'(default). A unit with ''flies=true'' does not have its image's height adjusted for different terrains.
** '''[movement_costs]''' describes how fast the unit moves on different terrains. The attribute '''terrain=''speed''''' means that the unit will need to use ''speed'' move points to move onto the terrain with '''name=''terrain''''' (see [[TerrainWML]]).
** '''[defense]''' describes how likely the unit is to be hit on different terrains. The attribute '''terrain=''defense''''' means that the unit will be hit ''defense'' percent of the time in the terrain with '''name=''terrain'''''.
** '''[resistance]''' describes how much damage the unit takes from different types of attacks. The attribute '''type=''resistance''''' makes the unit receive '''resistance''' percent of damage, or resist '''100-resistance''' percent of damage from attacks with '''type=''type'''''. So for example, a resistance of fire=110 means, this unit will receive 110% of damage, or have a resistance of -10% as displayed in-game. A value of fire=0 would mean, the unit receives no damage and therefore has a resistance of 100%.
* '''[race]''' is used to make shortcuts to describe units with similar names. Units from the same advancement tree should generally have the same race. Also, units with the same race should generally be recruitable by the same sides/factions.
** ''name'' an ID for this race. Units with the attribute '''race=''name''''' will be assigned this race.
** ''male_names'', ''female_names'' lists of names (i.e. non-translatable strings). They are inputted into the Markov name generator to generate random names. ''male_names'' describes units with '''gender=male'''; ''female_names'' describes units with '''gender=female'''.
** ''markov_chain_size'' (default 2) number of letters per "syllable". "Syllables" are groupings of names that the Markov name generator uses to determine names. It does this by running a probability algorithm to guess from the name list which syllables fit well together, which can start or end a name, etc.
** ''not_living'' 'yes' or 'no'(default). Units with '''not_living=yes''' cannot be poisoned, drained from, or plagued (see [[AbilitiesWML]]).
** ''num_traits'' is the number of non-repeating traits each unit of this race can be assigned.
** ''ignore_global_traits'' 'yes' or 'no'(default). Determines whether global traits (see [traits] above) are applied.
** '''[trait]''' describes a trait for this race. :
*** ''id'' unique identifier
*** ''availability'' {{DevFeature}} describes whether a trait is "musthave" for a race or is available to "any" unit in a race, including leaders. The default is for a trait to only be available to nonleaders. Currently "any" should not be used for traits available in multiplayer. It can be used for campaign specific traits.
*** ''male_name'' {{DevFeature}} text displayed in the status of unit with the trait if the unit is male.
*** ''female_name'' {{DevFeature}} text displayed in the status of unit with the trait if the unit is female.
*** ''name'' text displayed in the status of unit with the trait if none of the two above is used.
*** ''description'' text displayed for the description of the trait.
*** '''[effect]''', described in [[EffectWML]].

== See Also ==

* [[UnitWML]]
* [[ReferenceWML]]

[[Category: WML Reference]]

SingleUnitWML

2007-08-13T02:17:44Z

Bruno: /* How to describe a single unit */

{{WML Tags}}
== How to describe a single unit ==

This tag, '''[unit]''', describes a single unit on the map, for example Konrad.
It is different from the [unit] in [units], which describes a class of units.

The following keys are recognized:
* ''type'' the ID of the unit's unit type. See [[UnitWML]].

* ''side'' the side that the unit is on.

* ''gender'' can be set to male or female to designate the gender of the unit. Default is male.

* ''x'', ''y'' the location of the unit. If a location isn't provided and the side the unit will belong to has a recall list, the unit will be created on the recall list.

* ''description'' a unique identifier for the unit. This is not displayed to the player, but is to be used only for identifying and filtering for units. {{DevFeature}} If not specified or when a unit is normally recruited, a random one will be generated for the unit to ensure that each unit has a unique ''description''.

* ''user_description'' the name of the unit that is shown to the player. Note that the player may use the "rename unit" action to change this.

* ''generate_description'' if set to "yes", will generate a new name (''user_description'' only, not ''description'') for the unit, as if the unit was a freshly-recruited one.

* ''unrenamable'' if 'yes', the ''user_description'' cannot be changed by the player (which is only possible when the unit is on the player's side anyway).

* ''traits_description'' the description of the unit's traits which is displayed. However if it is not specified explicitly, the unit's actual traits' names will be used instead, so it is normally not necessary to set this.

* ''random_traits'' 'yes' will choose the traits randomly, just like a recruited unit. '''Don't use this in an MP Scenario as this will cause an Out of Sync (OOS) error'''.

* ''canrecruit'' a special key for leaders.
** '0' default. Unit cannot recruit.
** '1' unit can recruit.
: Normally when a team controls no units with '''canrecruit=1''', that team loses. However, even if your team has lost you continue to play with whatever units you still have until the scenario is over. Usually scenarios end when only one team is left with a leader that can recruit, but special victory conditions can be set up in campaigns. Normally you want to set the leader of a side with '''canrecruit=1'''. If you don't want the leader to recruit, it is usually better to just not give him any unit types to recruit, than to make a special victory condition. {{DevFeature}} Units with '''canrecruit=1''' are exempt from upkeep costs. So that leaders do not need to be given the ''loyal'' trait.

* ''variation'' the variation of itself the unit should be created as.

* ''upkeep'' the amount of upkeep the unit costs.
** "loyal" no upkeep cost. Can be changed by the effect 'loyal' (see [[EffectWML]])
** "full" unit costs ''level'' upkeep (see [[UnitWML]]).
** An integer can be used to set the upkeep cost to that number.
** The default is "full".
** Leaders (units with '''canrecruit=1''') never pay upkeep no matter what upkeep is set to.
** Normally you don't want to muck with this value. If you want to give a side units without upkeep costs, give those units the 'loyal' trait.

* ''overlays'' a list of images that are overlayed on the unit.

* ''goto_x'', ''goto_y'' UI settings that control courses. Default is 0,0 i.e. the unit is not on a course.

* ''hitpoints'' the HP of the unit. Default is the max HP for ''type''.

* ''experience'' the XP of the unit. Default is 0.

* ''moves'' number of move points the unit has left. Default is the movement for ''type''.

* ''resting'' whether the unit has not moved yet this turn. Used to decide whether to give a unit rest healing.

* ''role'' used in standard unit filter ([[FilterWML]]). Can be set using [role] (see [[InternalActionsWML]]).

* ''ai_special'' causes the unit to act differently.
** "guardian" the unit will not move, except to attack something in the turn it moves (so, it only can move if an enemy unit gets within range of it).

* ''facing'' which way the unit is facing (this only affects how the unit is displayed).
** Possible values are ''se'', ''s'', ''sw'', ''nw'', ''n'', ''ne''. Using ''sw'' is preferred for a "reversed" facing (looking to the left) and ''se'' for a normal (looking to the right) facing.

* ''profile'' sets a default portrait image for this unit. If the unit type already has a portrait set, this is used instead for this unit. When the unit advances, if the value of profile is different from the unit-type portrait, that value is preserved. If the profile field is empty or the same as the unit-type portrait, the level-advance changes the unit portrait to the default for the new level and type.

** "unit_image" if given instead of a filename, uses the unit's base image as the portrait (in the same manner that unit types without portraits do by default).

* ''animate'' if ''yes'', fades the unit in like when it's recruited/recalled.

* '''[status]''' the status of the unit. This affects different features of the unit, for example whether the unit loses health each turn. Default for all keys is 'off', but this can be changed by the scenario or by special abilities (see [[AbilitiesWML]]). The status of a unit is displayed on the Status Table; each status modification ''statusmod'' is represented by the image '''misc/statusmod.png'''.
** ''poisoned'' if 'on', the unit loses 8 HP each turn. See also ''heals'', ''cures'', [[AbilitiesWML]].
** ''slowed'' if 'on', the unit has 50% of its normal movement and does half damage. When the controller of the unit's turn is over, ''slowed'' is set to 'off'
** ''stone'' if 'on', the unit cannot move, attack, or be attacked.
** ''hides'' if 'yes', the unit cannot be seen by opponents.

* '''[variables]''' a set of variables that will be stored when this unit is stored (See [store_unit], [[InternalActionsWML]]). The attribute '''variable'''='''value''' means that when the unit is stored in the array ''unit'', the variable ''unit''.variables.''variable'' will have the value ''value'' (See [[VariablesWML]]).

* '''[modifications]''' changes that have been made to the unit.
** '''[trait]''' a trait the unit has. Same format as [trait], [[UnitsWML]].
** '''[object]''' an object the unit has. Same format as [object], [[DirectActionsWML]].

* ''unit_description'' overrides the unit type description for this unit. You will probably want to set up a ''post_advance'' [[EventWML|event]] to override the default description after promotions.

== See Also ==

* [[UnitWML]]
* [[ReferenceWML]]

SingleUnitWML

2007-08-13T02:16:44Z

Bruno: /* How to describe a single unit */

{{WML Tags}}
== How to describe a single unit ==

This tag, '''[unit]''', describes a single unit on the map, for example Konrad.
It is different from the [unit] in [units], which describes a class of units.

The following keys are recognized:
* ''type'' the ID of the unit's unit type. See [[UnitWML]].

* ''side'' the side that the unit is on.

* ''gender'' can be set to male or female to designate the gender of the unit. Default is male.

* ''x'', ''y'' the location of the unit. If a location isn't provided and the side the unit will belong to has a recall list, the unit will be created on the recall list.

* ''description'' a unique identifier for the unit. This is not displayed to the player, but is to be used only for identifying and filtering for units. {{DevFeature}} If not specified or when a unit is normally recruited, a random one will be generated for the unit to ensure that each unit has a unique ''description''.

* ''user_description'' the name of the unit that is shown to the player. Note that the player may use the "rename unit" action to change this.

* ''generate_description'' if set to "yes", will generate a new name (''user_description'' only, not ''description'') for the unit, as if the unit was a freshly-recruited one.

* ''unrenamable'' if 'yes', the ''user_description'' cannot be changed by the player (which is only possible when the unit is on the player's side anyway).

* ''traits_description'' the description of the unit's traits which is displayed. However if it is not specified explicitly, the unit's actual traits' names will be used instead, so it is normally not necessary to set this.

* ''random_traits'' 'yes' will choose the traits randomly, just like a recruited unit. '''Don't use this in an MP Scenario as this will cause an Out of Sync (OOS) error'''.

* ''canrecruit'' a special key for leaders.
** '0' default. Unit cannot recruit.
** '1' unit can recruit.
: Normally when a team controls no units with '''canrecruit=1''', that team loses. However, even if your team has lost you continue to play with whatever units you still have until the scenario is over. Usually scenarios end when only one team is left with a leader that can recruit, but special victory conditions can be set up in campaigns. Normally you want to set the leader of a side with '''canrecruit=1'''. If you don't want the leader to recruit, it is usually better to just not give him any unit types to recruit, than to make a special victory condition. {{DevFeature}} Units with '''canrecruit=1''' are exempt from upkeep costs. So that leaders do not need to be given the ''loyal'' trait.

* ''variation'' the variation of itself the unit should be created as.

* ''upkeep'' the amount of upkeep the unit costs.
** "loyal" no upkeep cost. Can be changed by the effect 'loyal' (see [[EffectWML]])
** "full" unit costs ''level'' upkeep (see [[UnitWML]]).
** An integer can be used to set the upkeep cost to that number.
** The default is "full".
** Leaders (units with '''canrecruit=''') never pay upkeep no matter what upkeep is set to.
** Normally you don't want to muck with this value. If you want to give a side units without upkeep costs, give those units the 'loyal' trait.

* ''overlays'' a list of images that are overlayed on the unit.

* ''goto_x'', ''goto_y'' UI settings that control courses. Default is 0,0 i.e. the unit is not on a course.

* ''hitpoints'' the HP of the unit. Default is the max HP for ''type''.

* ''experience'' the XP of the unit. Default is 0.

* ''moves'' number of move points the unit has left. Default is the movement for ''type''.

* ''resting'' whether the unit has not moved yet this turn. Used to decide whether to give a unit rest healing.

* ''role'' used in standard unit filter ([[FilterWML]]). Can be set using [role] (see [[InternalActionsWML]]).

* ''ai_special'' causes the unit to act differently.
** "guardian" the unit will not move, except to attack something in the turn it moves (so, it only can move if an enemy unit gets within range of it).

* ''facing'' which way the unit is facing (this only affects how the unit is displayed).
** Possible values are ''se'', ''s'', ''sw'', ''nw'', ''n'', ''ne''. Using ''sw'' is preferred for a "reversed" facing (looking to the left) and ''se'' for a normal (looking to the right) facing.

* ''profile'' sets a default portrait image for this unit. If the unit type already has a portrait set, this is used instead for this unit. When the unit advances, if the value of profile is different from the unit-type portrait, that value is preserved. If the profile field is empty or the same as the unit-type portrait, the level-advance changes the unit portrait to the default for the new level and type.

** "unit_image" if given instead of a filename, uses the unit's base image as the portrait (in the same manner that unit types without portraits do by default).

* ''animate'' if ''yes'', fades the unit in like when it's recruited/recalled.

* '''[status]''' the status of the unit. This affects different features of the unit, for example whether the unit loses health each turn. Default for all keys is 'off', but this can be changed by the scenario or by special abilities (see [[AbilitiesWML]]). The status of a unit is displayed on the Status Table; each status modification ''statusmod'' is represented by the image '''misc/statusmod.png'''.
** ''poisoned'' if 'on', the unit loses 8 HP each turn. See also ''heals'', ''cures'', [[AbilitiesWML]].
** ''slowed'' if 'on', the unit has 50% of its normal movement and does half damage. When the controller of the unit's turn is over, ''slowed'' is set to 'off'
** ''stone'' if 'on', the unit cannot move, attack, or be attacked.
** ''hides'' if 'yes', the unit cannot be seen by opponents.

* '''[variables]''' a set of variables that will be stored when this unit is stored (See [store_unit], [[InternalActionsWML]]). The attribute '''variable'''='''value''' means that when the unit is stored in the array ''unit'', the variable ''unit''.variables.''variable'' will have the value ''value'' (See [[VariablesWML]]).

* '''[modifications]''' changes that have been made to the unit.
** '''[trait]''' a trait the unit has. Same format as [trait], [[UnitsWML]].
** '''[object]''' an object the unit has. Same format as [object], [[DirectActionsWML]].

* ''unit_description'' overrides the unit type description for this unit. You will probably want to set up a ''post_advance'' [[EventWML|event]] to override the default description after promotions.

== See Also ==

* [[UnitWML]]
* [[ReferenceWML]]

SingleUnitWML

2007-08-12T22:31:40Z

Bruno: /* How to describe a single unit */

{{WML Tags}}
== How to describe a single unit ==

This tag, '''[unit]''', describes a single unit on the map, for example Konrad.
It is different from the [unit] in [units], which describes a class of units.

The following keys are recognized:
* ''type'' the ID of the unit's unit type. See [[UnitWML]].

* ''side'' the side that the unit is on.

* ''gender'' can be set to male or female to designate the gender of the unit. Default is male.

* ''x'', ''y'' the location of the unit. If a location isn't provided and the side the unit will belong to has a recall list, the unit will be created on the recall list.

* ''description'' a unique identifier for the unit. This is not displayed to the player, but is to be used only for identifying and filtering for units. {{DevFeature}} If not specified or when a unit is normally recruited, a random one will be generated for the unit to ensure that each unit has a unique ''description''.

* ''user_description'' the name of the unit that is shown to the player. Note that the player may use the "rename unit" action to change this.

* ''generate_description'' if set to "yes", will generate a new name (''user_description'' only, not ''description'') for the unit, as if the unit was a freshly-recruited one.

* ''unrenamable'' if 'yes', the ''user_description'' cannot be changed by the player (which is only possible when the unit is on the player's side anyway).

* ''traits_description'' the description of the unit's traits which is displayed. However if it is not specified explicitly, the unit's actual traits' names will be used instead, so it is normally not necessary to set this.

* ''random_traits'' 'yes' will choose the traits randomly, just like a recruited unit. '''Don't use this in an MP Scenario as this will cause an Out of Sync (OOS) error'''.

* ''canrecruit'' a special key for leaders.
** '0' default. Unit cannot recruit.
** '1' unit can recruit.
: Normally when a team controls no units with '''canrecruit=1''', that team loses. However, even if your team has lost you continue to play with whatever units you still have until the scenario is over. Usually scenarios end when only one team is left with a leader that can recruit, but special victory conditions can be set up in campaigns. Normally you want to set the leader of a side with '''canrecruit=1'''. If you don't want the leader to recruit, it is usually better to just not give him any unit types to recruit, than to make a special victory condition. {{DevFeature}} Units with '''canrecruit=1''' are exempt from upkeep costs. So that leaders do not need to be given the ''loyal'' trait.

* ''variation'' the variation of itself the unit should be created as.

* ''upkeep'' the amount of upkeep the unit costs.
** "loyal" no upkeep cost. Can be changed by the effect 'loyal' (see [[EffectWML]])
** "full" unit costs ''level'' upkeep (see [[UnitWML]]). Default for recruited units.
** An integer can be used to set the upkeep cost to that number.
** If no upkeep is specified, which is the default for units defined in WML (including leaders in multiplayer games), there is no upkeep cost.

* ''overlays'' a list of images that are overlayed on the unit.

* ''goto_x'', ''goto_y'' UI settings that control courses. Default is 0,0 i.e. the unit is not on a course.

* ''hitpoints'' the HP of the unit. Default is the max HP for ''type''.

* ''experience'' the XP of the unit. Default is 0.

* ''moves'' number of move points the unit has left. Default is the movement for ''type''.

* ''resting'' whether the unit has not moved yet this turn. Used to decide whether to give a unit rest healing.

* ''role'' used in standard unit filter ([[FilterWML]]). Can be set using [role] (see [[InternalActionsWML]]).

* ''ai_special'' causes the unit to act differently.
** "guardian" the unit will not move, except to attack something in the turn it moves (so, it only can move if an enemy unit gets within range of it).

* ''facing'' which way the unit is facing (this only affects how the unit is displayed).
** Possible values are ''se'', ''s'', ''sw'', ''nw'', ''n'', ''ne''. Using ''sw'' is preferred for a "reversed" facing (looking to the left) and ''se'' for a normal (looking to the right) facing.

* ''profile'' sets a default portrait image for this unit. If the unit type already has a portrait set, this is used instead for this unit. When the unit advances, if the value of profile is different from the unit-type portrait, that value is preserved. If the profile field is empty or the same as the unit-type portrait, the level-advance changes the unit portrait to the default for the new level and type.

** "unit_image" if given instead of a filename, uses the unit's base image as the portrait (in the same manner that unit types without portraits do by default).

* ''animate'' if ''yes'', fades the unit in like when it's recruited/recalled.

* '''[status]''' the status of the unit. This affects different features of the unit, for example whether the unit loses health each turn. Default for all keys is 'off', but this can be changed by the scenario or by special abilities (see [[AbilitiesWML]]). The status of a unit is displayed on the Status Table; each status modification ''statusmod'' is represented by the image '''misc/statusmod.png'''.
** ''poisoned'' if 'on', the unit loses 8 HP each turn. See also ''heals'', ''cures'', [[AbilitiesWML]].
** ''slowed'' if 'on', the unit has 50% of its normal movement and does half damage. When the controller of the unit's turn is over, ''slowed'' is set to 'off'
** ''stone'' if 'on', the unit cannot move, attack, or be attacked.
** ''hides'' if 'yes', the unit cannot be seen by opponents.

* '''[variables]''' a set of variables that will be stored when this unit is stored (See [store_unit], [[InternalActionsWML]]). The attribute '''variable'''='''value''' means that when the unit is stored in the array ''unit'', the variable ''unit''.variables.''variable'' will have the value ''value'' (See [[VariablesWML]]).

* '''[modifications]''' changes that have been made to the unit.
** '''[trait]''' a trait the unit has. Same format as [trait], [[UnitsWML]].
** '''[object]''' an object the unit has. Same format as [object], [[DirectActionsWML]].

* ''unit_description'' overrides the unit type description for this unit. You will probably want to set up a ''post_advance'' [[EventWML|event]] to override the default description after promotions.

== See Also ==

* [[UnitWML]]
* [[ReferenceWML]]

Download

2007-06-25T21:11:15Z

Bruno: /* Mac OS X */

Welcome to the Battle for Wesnoth downloads page. The BFW project team only officially releases the source code. Binary packages are only provided by community volunteers and hosted here. Torrents are also unofficial.

If the latest binaries are not currently available for your OS, please check back in a few days to see if they have been placed here. Packagers have been informed of the release, please be patient. In the meantime, read the [[FAQ#A_new_version_is_out.2C_but_where_is_the_download_for_.5BWindows.2C_Mac_OS.2C_etc..5D.3F|FAQ]].

__NOTOC__
Jump to: [[Download#Stable_.281.2_branch.29|Stable Branch]] | [[Download#Development|Development Branch]]

== Stable (1.2 branch) ==

==== Source code ====
* [http://prdownloads.sourceforge.net/wesnoth/wesnoth-1.2.5.tar.bz2?download Current stable version] (1.2.5, 65.6 MB)
* [http://prdownloads.sourceforge.net/wesnoth/wesnoth-1.2.4.tar.bz2?download Previous stable version] (1.2.4, 65.4 MB)
* [[CompilingWesnoth|Compiling Guide]] - how to compile the source code

==== [[BeOS]] ====
* Current version (1.2.5) not available yet.
* [http://zeta-games.com/index.php?option=com_remository&Itemid=28&func=fileinfo&id=24 Previous stable version] (1.2.1, 70.11MB)
* [http://prdownloads.sourceforge.net/wesnoth/Wesnoth-1.0.2-BeOS-x86.pkg.zip?download Older stable version, not compatible with 1.2] (1.0.2, 42.3MB)

==== GNU/Linux ====
* There are specific binaries for many different GNU/Linux Distributions. Not all are always up to date with the current release. Please have a look at the [[WesnothBinariesLinux|Linux binary page]] for more informations about the binaries for your Distribution.

==== OpenBSD ====
* Current version (1.2.5) not available yet.
'''Note:''' OpenBSD 4.1 is required to play with these binaries:
* [http://downloads.sourceforge.net/wesnoth/wesnoth-openbsd--1.2.4.tgz?download Previous stable release ] (1.2.4, 69.2 MiB)
* [ftp://pkg@slz.sytes.net/wesnoth-1.2.4.tgz Previous stable release (mirror @ Stealth Landing Zone) ] (1.2.4, 69.2 MiB)
'''Note:''' OpenBSD 4.0 is required to play with these binaries:
* [http://downloads.sourceforge.net/wesnoth/wesnoth-openbsd--1.2.3.tgz?download Older stable release ] (1.2.3, 68.0 MiB)

==== OS/2 & eComStation ====
* [http://download.smedley.info/wesnoth-1.2.5-os2.zip Current version (1.2.5)] (1.2.5, 70MB)

==== Mac OS X ====
Be aware that OSX 10.3.9+ is required to play with these binaries.
* [http://prdownloads.sourceforge.net/wesnoth/Wesnoth_MacOSX_1.2.5a.dmg?download Current stable version] (1.2.5, Universal, 75.4 MB)
* [http://downloads.sourceforge.net/wesnoth/Wesnoth_MacOSX_1.2.5a_lite.dmg?download Current stable version - lite] (1.2.5, Universal, no art or music, 46.1MB)
* [http://prdownloads.sourceforge.net/wesnoth/Wesnoth_MacOSX_1.2.4.dmg?download Previous stable version] (1.2.4, Universal, 80.2 MB)
* [http://downloads.sourceforge.net/wesnoth/Wesnoth_MacOSX_1.2.4_lite.dmg?download Previous stable version - lite] (1.2.4, Universal, no art or music, 48.3MB)

==== MS Windows ====
* [http://prdownloads.sourceforge.net/wesnoth/wesnoth-1.2.5-windows.exe?download Current stable release] (1.2.5, 60.0 MB)
* [http://prdownloads.sourceforge.net/wesnoth/wesnoth-1.2.4-windows.exe?download Previous stable release] (1.2.4, 59.8 MB)

==== AmigaOS4 ====
* Current version (1.2.5) not available yet.
* [http://os4depot.net/index.php?function=showfile&file=game/strategy/wesnoth.lha Previous stable release ] (1.2.4, 63 MB)

==== Miscellaneous ====
* [http://prdownloads.sourceforge.net/wesnoth/wesnoth-1.2.5.tar.bz2.md5?download Source code md5sum]
* [http://www.wesnoth.org/wiki/Download_Xdeltas#Source_code Xdelta for the source code]
* [http://www.wesnoth.org/wiki/Download_Xdeltas#MS_Windows Xdelta for the Windows binary]

== Development (1.3 branch) ==

Version 1.3.x is the latest development version, boasting updated graphics and new exciting features. However, there may be occasional bugs or performance problems in the development versions since heavy changes are taking place all the time. For balanced and stable gaming, it is recommended you use the latest version of the 1.2.x branch. This version is recommended for coders and campaign developers, as well as those who want to preview the future of Wesnoth.

==== Source code ====
* [http://prdownloads.sourceforge.net/wesnoth/wesnoth-1.3.4.tar.bz2?download Current Version] (1.3.4, 82.8 MB)
* [http://prdownloads.sourceforge.net/wesnoth/wesnoth-1.3.3.tar.bz2?download Previous Version] (1.3.3, 81.9 MB)

* [[CompilingWesnoth|Compiling Guide]] - how to compile the source code

==== MS Windows ====
* Current version 1.3.4 not available yet.
* [http://downloads.sourceforge.net/wesnoth/wesnoth-1.3.3a-windows.exe?download Previous Version] (1.3.3, 75.5MB)
* [http://www.exong.net/builds/index.php?dir=&sort=date&order=desc Daily SVN snapshots] (only the .exe, in addition you need an SVN checkout to use it)

==== Mac OS X ====
* [http://prdownloads.sourceforge.net/wesnoth/Wesnoth_MacOSX_1.3.4.dmg?download Current Version] (1.3.4, Universal, 91.6MB)
* [http://prdownloads.sourceforge.net/wesnoth/Wesnoth_MacOSX_1.3.4_lite.dmg?download Current Version - lite] (1.3.4, Universal, no art or music, 50.0MB)
* [http://prdownloads.sourceforge.net/wesnoth/Wesnoth_MacOSX_1.3.3a.dmg?download Previous Version] (1.3.3, Universal, 90.6MB)
* [http://prdownloads.sourceforge.net/wesnoth/Wesnoth_MacOSX_1.3.3a_lite.dmg?download Previous Version - lite] (1.3.3, Universal, no art or music, 49.1MB)

==== GNU/Linux ====
* There are binaries for many different GNU/Linux Distributions. Not all are always up to date with the current release. Please have a look at the [[WesnothBinariesLinux|Linux binary page]] for more information about the binaries for your Distribution.

==== (Open)Solaris ====
* Current version 1.3.4 not available yet.
* [http://downloads.sourceforge.net/wesnoth/GAMEwesnoth-1.3.3-solaris.pkg.bz2?download Previous version for x86] (1.3.3, Solaris package for x86)

==== AmigaOS4 ====
* Current version 1.3.4 not available yet.
* [http://os4depot.net/index.php?function=showfile&file=game/strategy/wesnoth-devel.lha Previous Version] (1.3.3, 78MB)

==== OS/2 & eComStation ====
* current version not available
* [http://download.smedley.info/wesnoth-1.1.8-os2.zip Older Version] (1.1.8, 66MB)

==== Miscellaneous ====
* [http://prdownloads.sourceforge.net/wesnoth/wesnoth-1.3.4.tar.bz2.md5?download md5sum for current source code]
* [http://www.wesnoth.org/wiki/Download_Xdeltas#Source_code Xdelta for the source code]
* [http://sourceforge.net/project/showfiles.php?group_id=89495 SourceForge page for current and all previous versions]

== License ==
This program is free software; you can redistribute it and/or modify it under the terms of the [http://www.fsf.org/copyleft/gpl.html GNU General Public License version 2], as published by the [http://www.fsf.org/ Free Software Foundation].
This program is distributed in the hope that it will be useful, but without any warranty; without even the implied warranty of merchantability or fitness for a particular purpose. See the GNU General Public License for more details.

== See also ==
* [http://changelog.wesnoth.org Changelog]
* [[WesnothBinaries| More binaries]]
* [[WesnothSVN]] - bleeding edge version from SVN

HelpWML

2006-06-21T14:59:02Z

Bruno: /* The toplevel [help] tag */

{{WML Tags}}
== The toplevel [help] tag ==

The [help] tag describes the Wesnoth help system.
Each of the three subtags [toplevel], [section] and [topic] describe an element of the help system.

* '''[toplevel]''' The toplevel tag denotes sections and topics that should be shown immediately when the "Help" button is clicked on (see the "help" action, [[ThemeWML]]). The sections referenced within this tag are read recursively, including all subsections.
** ''sections'' a list of IDs of the sections to include recursively.
** ''topics'' a list of IDs of the topics to show as not being included in a section; i.e. top-level topics.
* '''[section]''' The section tag describes a section in the help browser. A section contains subsections and/or topics.
** ''id'' is the unique ID for this section.
** ''title'' (translatable) is the title of the section. It is displayed in the left menu.
** ''sections'' is a list of IDs of the sections that should be this section's subsections.
** ''topics'' is a list of IDs of the topics that should be included in this section. Topics will be included in the order listed unless sorting is requested.
** ''generator'' provides the name of a function that will generate a list of topics and include them in this section. These topics will be included after topics listed on the ''topics'' key unless ''sort_topics'' is ''yes''.
** ''sort_topics'' specifies whether or not to list the topics sorted by title or in the order listed on the ''topics'' key. ''yes'' indicates fixed and generated topics should be sorted together by title. ''no'' indicates that topics should appear in the order listed with fixed topics appearing before generated topics. ''generated'' indicates that fixed topics should not be sorted and will be followed by generated topics sorted by the generator. The default is ''generated''.
* '''[topic]''' The topic tag describes one topic, i.e, one help page. The keys that are meaningful in the topic tag:
** ''id'' is the unique ID for this topic.
** ''title'' (translatable) is the title of the topic. It is displayed in the left menu and as a header in the text area.
** ''text'' (translatable) is the contents of the topics. May contain markup described below.

== Help System Topic Markup ==

The markup that is allowed in the text key within a topic tag is in XML, a markup language similar to WML. Note that this is the only time that markup language is used as a value. To convert WML into XML, you need to make some changes:

- change brackets ('''[''', ''']''') into angle brackets('''<''', '''>''')

- change ''newline'' into space(''' ''')

- all values with spaces must be in quotes. This is because spaces are actually newlines.

Due to limitations of the wiki (it is coded using XML), the WML for the topic markup will be described rather than
the XML. However, you still need to use XML to code the topic.

The following key/tags are accepted for ''text'':
* '''[ref]''' creates a cross reference to another topic, a cross reference will not show up if the topic it refers to is not visible.
** ''dst'' the ID of the topic to reference.
** ''text'' the text to display as a link to ''dst''; i.e. when ''text'' is clicked on the page ''dst'' will be linked to.
** ''force'' shows the cross reference even though the referred topic is not shown.
* '''[jump]''' when this text is selected, the input position along the X axis is moved. Can be used for example to create columns of things. A jump is ignored if it would bring the input position to an invalid position.
** ''to'' the X coordinate of the text area to jump to. If it can't be done on the current row, the input position is moved down one line.
** ''amount'' the number of pixels to jump forward
* '''[img]''' insert an image in the topic
** ''src'' the path to the image relative to the '''images/''' directory.
** ''align'' the position of the image with respect to the page. Values are ''here'', ''left'', ''middle'', and ''right''.
** ''float'' whether the image should float(have text filled in around it) or not (be seen as included in a line).
* '''[format]''' describes a group of text in a different format. Can be used to describe different colors and font sizes.
** ''bold'' whether the text should be displayed in bold('''bold''').
** ''italic'' whether the text should be displayed in italics(''italics'').
** ''color'' the color of the text. Only a few colors are currently supported: ''white''(default), ''green'', ''red'', ''yellow'', and ''black''.
** ''font_size'' the height of the text in pixels. Default 9(?)
** ''text'' the text to be displayed using this format.
* '''[italic]''' a shortcut to '''[format]''' which inputs only the ''text'' key. Uses the attribute '''italic=yes'''
* '''[bold]''' like [italic], but uses '''bold=yes'''
* '''[header]''' like [italic], but uses both the attributes '''bold=yes''' and '''font_size=13'''(?)

Example:
[help]
[toplevel]
sections=introduction,gameplay
topics=about
[/toplevel]
[section]
id=gameplay
sections=combat
topics=income_and_upkeep,time_of_day,terrain
[/section]
[topic]
id=terrain
title=Terrain
text="<ref>dst=income_and_upkeep text='Link to Income and Upkeep topic'</ref>"
[/topic]
[/help]

== See Also ==

* [[ReferenceWML]]

[[Category: WML Reference]]

SingleUnitWML

2006-06-11T02:12:16Z

Bruno: /* how to describe a single unit */

{{WML Tags}}
== how to describe a single unit ==

This tag, '''[unit]''', describes a single unit on the map, for example Konrad.
It is different from the [unit] in [units], which describes a class of units.

The following keys are recognized:
* ''type'' the ID of the unit's unit type. See [[UnitWML]].

* ''side'' the side that the unit is on.

* ''gender'' can be set to male or female to designate the gender of the unit. Default is male.

* ''x'', ''y'' the location of the unit. If a location isn't provided and the side the unit will belong to has a recall list, the unit will be created on the recall list.

* ''description'' used in standard unit filter ([[FilterWML]]). Note that this field is not filled in with names created at random when recruiting units. Nor is it affected by a player renaming a unit. So when designing maps you don't have to worry about naming conflicts.

* ''user_description'' the name of the unit that is shown to the user. Default ''description''.

* ''generate_description'' if set to "yes", will generate a new name (user_description) for the unit, as if the unit was a freshly-recruited one.

* ''unrenamable'' if 'yes', the user_description cannot be changed by the player (which is only possible when the unit is on the player's side anyway).

* ''traits_description'' the description of the unit's traits which is displayed. However if it is not specified explicitly, the unit's actual traits' names will be used instead, so it is normally not necessary to set this.

* ''random_traits'' {{DevFeature}} 'yes' will choose the traits randomly, just like a recruited unit. '''Don't use this in a MP Scenario as this will cause an Out of Sync (OOS) error'''.

* ''canrecruit'' a special key for leaders.
** '0' default. Unit cannot recruit.
** '1' unit can recruit.
: Normally when a team controls no units with '''canrecruit=1''', that team loses. However, even if your team has lost you continue to play with whatever units you still have until the scenario is over. Usually scenarios end when only one team is left with a leader that can recruit, but special victory conditions can be set up in campaigns. Normally you want to set the leader of a side with '''canrecruit=1'''. If you don't want the leader to recruit, it is usually better to just not give him any unit types to recruit, than to make a special victory condition.

* ''upkeep'' the amount of upkeep the unit costs.
** "loyal" no upkeep cost. Can be changed by the effect 'loyal' (see [[EffectWML]])
** "full" unit costs ''level'' upkeep (see [[UnitWML]]). Default for recruited units.
** An integer can be used to set the upkeep cost to that number.
** If no upkeep is specified, which is the default for units defined in WML (including leaders in multiplayer games), there is no upkeep cost.

* ''overlays'' a list of images that are overlayed on the unit.

* ''goto_x'', ''goto_y'' UI settings that control courses. Default is 0,0 i.e. the unit is not on a course.

* ''hitpoints'' the HP of the unit. Default is the max HP for ''type''.

* ''experience'' the XP of the unit. Default is 0.

* ''moves'' number of move points the unit has left. Default is the movement for ''type''.

* ''resting'' whether the unit has not moved yet this turn. Used to decide whether to give a unit rest healing.

* ''role'' used in standard unit filter ([[FilterWML]]). Can be set using [role] (see [[InternalActionsWML]]).

* ''ai_special'' causes the unit to act differently.
** "guardian" the unit will not move, except to attack something in the turn it moves (so, it only can move if an enemy unit gets within range of it).

* ''facing'' which way the unit is facing (this only affects how the unit is displayed).
** "normal" (default) unit is facing to the right.
** "reverse" unit is facing to the left.
** "sw" {{DevFeature}} unit is facing to the left (substitute of "reverse").

* ''profile'' {{DevFeature}} sets a default portrait image for this unit. If the unit type already has a portrait set, this is used instead for this unit.
** "unit_image" if given instead of a filename, uses the unit's base image as the portrait (in the same manner that unit types without portraits do by default).

* ''fade_in'' {{DevFeature}} fades the unit in, like when it's recruited/recalled.

* '''[status]''' the status of the unit. This affects different features of the unit, for example whether the unit loses health each turn. Default for all keys is 'off', but this can be changed by the scenario or by special abilities (see [[AbilitiesWML]]). The status of a unit is displayed on the Status Table; each status modification ''statusmod'' is represented by the image '''misc/statusmod.png'''.
** ''poisoned'' if 'on', the unit loses 8 HP each turn. See also ''heals'', ''cures'', [[AbilitiesWML]].
** ''slowed'' if 'on', the unit has 50% of its normal movement and -1 strike on each attack with strikes>1. When the controller of the unit's turn is over, ''slowed'' is set to 'off' {{DevFeature}} slow now halves damage instead of removing one strike
** ''stone'' if 'on', the unit cannot move, attack, or be attacked.
** ''ambush'' if 'on', the unit cannot be seen by opponents.

* '''[variables]''' a set of variables that will be stored when this unit is stored (See [store_unit], [[InternalActionsWML]]). The attribute '''variable'''='''value''' means that when the unit is stored in the array ''unit'', the variable ''unit''.variables.''variable'' will have the value ''value'' (See [[VariablesWML]]).

* '''[modifications]''' changes that have been made to the unit.
** '''[trait]''' a trait the unit has. Same format as [trait], [[UnitsWML]].
** '''[object]''' an object the unit has. Same format as [object], [[DirectActionsWML]].

* ''unit_description'' {{DevFeature}} overrides the unit type description for this unit. You will probably want to set up a ''post_advance'' [[EventWML|event]] to override the default description after promotions.

== See Also ==

* [[UnitWML]]
* [[ReferenceWML]]

SingleUnitWML

2006-06-11T02:10:14Z

Bruno: /* how to describe a single unit */

{{WML Tags}}
== how to describe a single unit ==

This tag, '''[unit]''', describes a single unit on the map, for example Konrad.
It is different from the [unit] in [units], which describes a class of units.

The following keys are recognized:
* ''type'' the ID of the unit's unit type. See [[UnitWML]].

* ''side'' the side that the unit is on.

* ''gender'' can be set to male or female to designate the gender of the unit. Default is male.

* ''x'', ''y'' the location of the unit. If a location isn't provided and the side the unit will belong to has a recall list, the unit will be created on the recall list.

* ''description'' used in standard unit filter ([[FilterWML]]). Note that this field is not filled in with names created at random when recruiting units. Nor is it affected by a player renaming a unit. So when designing maps you don't have to worry about naming conflicts.

* ''user_description'' the name of the unit that is shown to the user. Default ''description''.

* ''generate_description'' if set to "yes", will generate a new name (user_description) for the unit, as if the unit was a freshly-recruited one.

* ''unrenamable'' if 'yes', the user_description cannot be changed by the player (which is only possible when the unit is on the player's side anyway).

* ''traits_description'' the description of the unit's traits which is displayed. However if it is not specified explicitly, the unit's actual traits' names will be used instead, so it is normally not necessary to set this.

* ''random_traits'' {{DevFeature}} 'yes' will choose the traits randomly, just like a recruited unit. '''Don't use this in a MP Scenario as this will cause an Out of Sync (OOS) error'''.

* ''canrecruit'' a special key for leaders.
** '0' default. Unit cannot recruit.
** '1' unit can recruit.
: Normally when a team controls no units with '''canrecruit=1''', that team loses. However, even if your team has lost you continue to play with whatever units you still have until the scenario is over. Usually scenarios end when only one team is left with a leader that can recruit, but special victory conditions can be set up in campaigns. Normally you want to set the leader of a side with '''canrecruit=1'''. If you don't want the leader to recruit, it is usually better to just not give him any unit types to recruit, than to make a special victory condition.

* ''upkeep'' the amount of upkeep the unit costs.
** "loyal" no upkeep cost. Can be changed by the effect 'loyal' (see [[EffectWML]])
** "full" unit costs ''level'' upkeep (see [[UnitWML]]). Default for recruited units.
** An integer can be used to set the upkeep cost to that number.
** If no upkeep is specified, which is the default for units defined in WML, there is no upkeep cost.

* ''overlays'' a list of images that are overlayed on the unit.

* ''goto_x'', ''goto_y'' UI settings that control courses. Default is 0,0 i.e. the unit is not on a course.

* ''hitpoints'' the HP of the unit. Default is the max HP for ''type''.

* ''experience'' the XP of the unit. Default is 0.

* ''moves'' number of move points the unit has left. Default is the movement for ''type''.

* ''resting'' whether the unit has not moved yet this turn. Used to decide whether to give a unit rest healing.

* ''role'' used in standard unit filter ([[FilterWML]]). Can be set using [role] (see [[InternalActionsWML]]).

* ''ai_special'' causes the unit to act differently.
** "guardian" the unit will not move, except to attack something in the turn it moves (so, it only can move if an enemy unit gets within range of it).

* ''facing'' which way the unit is facing (this only affects how the unit is displayed).
** "normal" (default) unit is facing to the right.
** "reverse" unit is facing to the left.
** "sw" {{DevFeature}} unit is facing to the left (substitute of "reverse").

* ''profile'' {{DevFeature}} sets a default portrait image for this unit. If the unit type already has a portrait set, this is used instead for this unit.
** "unit_image" if given instead of a filename, uses the unit's base image as the portrait (in the same manner that unit types without portraits do by default).

* ''fade_in'' {{DevFeature}} fades the unit in, like when it's recruited/recalled.

* '''[status]''' the status of the unit. This affects different features of the unit, for example whether the unit loses health each turn. Default for all keys is 'off', but this can be changed by the scenario or by special abilities (see [[AbilitiesWML]]). The status of a unit is displayed on the Status Table; each status modification ''statusmod'' is represented by the image '''misc/statusmod.png'''.
** ''poisoned'' if 'on', the unit loses 8 HP each turn. See also ''heals'', ''cures'', [[AbilitiesWML]].
** ''slowed'' if 'on', the unit has 50% of its normal movement and -1 strike on each attack with strikes>1. When the controller of the unit's turn is over, ''slowed'' is set to 'off' {{DevFeature}} slow now halves damage instead of removing one strike
** ''stone'' if 'on', the unit cannot move, attack, or be attacked.
** ''ambush'' if 'on', the unit cannot be seen by opponents.

* '''[variables]''' a set of variables that will be stored when this unit is stored (See [store_unit], [[InternalActionsWML]]). The attribute '''variable'''='''value''' means that when the unit is stored in the array ''unit'', the variable ''unit''.variables.''variable'' will have the value ''value'' (See [[VariablesWML]]).

* '''[modifications]''' changes that have been made to the unit.
** '''[trait]''' a trait the unit has. Same format as [trait], [[UnitsWML]].
** '''[object]''' an object the unit has. Same format as [object], [[DirectActionsWML]].

* ''unit_description'' {{DevFeature}} overrides the unit type description for this unit. You will probably want to set up a ''post_advance'' [[EventWML|event]] to override the default description after promotions.

== See Also ==

* [[UnitWML]]
* [[ReferenceWML]]

SingleUnitWML

2006-06-08T04:45:46Z

Bruno: /* how to describe a single unit */

{{WML Tags}}
== how to describe a single unit ==

This tag, '''[unit]''', describes a single unit on the map, for example Konrad.
It is different from the [unit] in [units], which describes a class of units.

The following keys are recognized:
* ''type'' the ID of the unit's unit type. See [[UnitWML]].

* ''side'' the side that the unit is on.

* ''gender'' can be set to male or female to designate the gender of the unit. Default is male.

* ''x'', ''y'' the location of the unit. If a location isn't provided and the side the unit will belong to has a recall list, the unit will be created on the recall list.

* ''description'' used in standard unit filter ([[FilterWML]]). Note that this field is not filled in with names created at random when recruiting units. Nor is it affected by a player renaming a unit. So when designing maps you don't have to worry about naming conflicts.

* ''user_description'' the name of the unit that is shown to the user. Default ''description''.

* ''generate_description'' if set to "yes", will generate a new name (user_description) for the unit, as if the unit was a freshly-recruited one.

* ''unrenamable'' if 'yes', the user_description cannot be changed by the player (which is only possible when the unit is on the player's side anyway).

* ''traits_description'' the description of the unit's traits which is displayed. However if it is not specified explicitly, the unit's actual traits' names will be used instead, so it is normally not necessary to set this.

* ''random_traits'' {{DevFeature}} 'yes' will choose the traits randomly, just like a recruited unit. '''Don't use this in a MP Scenario as this will cause an Out of Sync (OOS) error'''.

* ''canrecruit'' a special key for leaders.
** '0' default. Unit cannot recruit.
** '1' unit can recruit.
: Normally when a team controls no units with '''canrecruit=1''', that team loses. However, even if your team has lost you continue to play with whatever units you still have until the scenario is over. Usually scenarios end when only one team is left with a leader that can recruit, but special victory conditions can be set up in campaigns. Normally you want to set the leader of a side with '''canrecruit=1'''. If you don't want the leader to recruit, it is usually better to just not give him any unit types to recruit, than to make a special victory condition.

* ''upkeep'' the amount of upkeep the unit costs.
** "free" default for scenario-generated units. Unit does not cost upkeep
** "loyal" unit costs 1 upkeep. Can be changed by the effect 'loyal' (see [[EffectWML]])
** "full" unit costs ''level'' upkeep (see [[UnitWML]]). Default for recruited units

* ''overlays'' a list of images that are overlayed on the unit.

* ''goto_x'', ''goto_y'' UI settings that control courses. Default is 0,0 i.e. the unit is not on a course.

* ''hitpoints'' the HP of the unit. Default is the max HP for ''type''.

* ''experience'' the XP of the unit. Default is 0.

* ''moves'' number of move points the unit has left. Default is the movement for ''type''.

* ''resting'' whether the unit has not moved yet this turn. Used to decide whether to give a unit rest healing.

* ''role'' used in standard unit filter ([[FilterWML]]). Can be set using [role] (see [[InternalActionsWML]]).

* ''ai_special'' causes the unit to act differently.
** "guardian" the unit will not move, except to attack something in the turn it moves (so, it only can move if an enemy unit gets within range of it).

* ''facing'' which way the unit is facing (this only affects how the unit is displayed).
** "normal" (default) unit is facing to the right.
** "reverse" unit is facing to the left.
** "sw" {{DevFeature}} unit is facing to the left (substitute of "reverse").

* ''profile'' {{DevFeature}} sets a default portrait image for this unit. If the unit type already has a portrait set, this is used instead for this unit.
** "unit_image" if given instead of a filename, uses the unit's base image as the portrait (in the same manner that unit types without portraits do by default).

* ''fade_in'' {{DevFeature}} fades the unit in, like when it's recruited/recalled.

* '''[status]''' the status of the unit. This affects different features of the unit, for example whether the unit loses health each turn. Default for all keys is 'off', but this can be changed by the scenario or by special abilities (see [[AbilitiesWML]]). The status of a unit is displayed on the Status Table; each status modification ''statusmod'' is represented by the image '''misc/statusmod.png'''.
** ''poisoned'' if 'on', the unit loses 8 HP each turn. See also ''heals'', ''cures'', [[AbilitiesWML]].
** ''slowed'' if 'on', the unit has 50% of its normal movement and -1 strike on each attack with strikes>1. When the controller of the unit's turn is over, ''slowed'' is set to 'off' {{DevFeature}} slow now halves damage instead of removing one strike
** ''stone'' if 'on', the unit cannot move, attack, or be attacked.
** ''ambush'' if 'on', the unit cannot be seen by opponents.

* '''[variables]''' a set of variables that will be stored when this unit is stored (See [store_unit], [[InternalActionsWML]]). The attribute '''variable'''='''value''' means that when the unit is stored in the array ''unit'', the variable ''unit''.variables.''variable'' will have the value ''value'' (See [[VariablesWML]]).

* '''[modifications]''' changes that have been made to the unit.
** '''[trait]''' a trait the unit has. Same format as [trait], [[UnitsWML]].
** '''[object]''' an object the unit has. Same format as [object], [[DirectActionsWML]].

* ''unit_description'' {{DevFeature}} overrides the unit type description for this unit. You will probably want to set up a ''post_advance'' [[EventWML|event]] to override the default description after promotions.

== See Also ==

* [[UnitWML]]
* [[ReferenceWML]]

CampaignServerWML

2006-06-07T00:50:29Z

Bruno: /* Downloading a Campaign */

= Campaign Server WML =

This page describes the WML commands exchanged between campaign download clients and a campaign server. Note that this WML is not used in the game engine. Note that this page describes functions of the 1.1 campaign server, because that is what is used by the official campaign server.

== Listing Available Campaigns ==

This request is used to retrieve a list of campaigns available on the server and some overview information about them.

* Request
** '''[request_campaign_list]'''
*** ''after'' - only select campaigns last updated after the indicated time. ''after'' is in seconds relative to either the time when the command is processed or the [http://wikipedia.org/wiki/Unix_epoch Unix epoch]. As an example, to select campaigns last updated after Mon Oct 10 21:42:41 2005 GMT, you could not specify a value for ''times_relative_to'' (to use the default of relative to the [http://wikipedia.org/wiki/Unix_epoch Unix epoch]) and specify ''after'' = "1128980561".
*** ''before'' - only select campaigns last updated before the indicated time. ''before'' is in seconds relative to either the time when the command is processed or the [http://wikipedia.org/wiki/Unix_epoch Unix epoch]. As an example, to select campaigns last updated over a day ago, you could specify ''times_relative_to'' = "now" and ''before'' = "-86400".
*** ''language'' - return information only about campaigns that appear to be translated into this language. These names will normally be posix locale names. Typically you will want to either use a two letter language code (e.g. "de") or a two letter language code followed by a two character region code (e.g. "pt_BR"). Note that "pt" will not match "pt_BR".
*** ''name'' - return information for this campaign. If the name is specified and not the empty string then only information about campaigns with matching names (unless something changes there will be at most one such campaign) will be returned.
*** ''times_relative_to'' - "now" means that ''before'' and ''after'' are in seconds relative to the time when the request is processed by the campaign server. Any other value, or if it is not set, indicates that ''before'' and ''after'' are in seconds relative to the [http://wikipedia.org/wiki/Unix_epoch Unix epoch].
* Response
** ''timestamp'' - what time the campaign server thought it was when this response was generated. You shouldn't count on this as a guaranty that no new campaigns will appear with previous update times. This could be used to detect significant clock skew or possibly used as an approximate time for how far you need to look back for updated campaigns.
** '''[campaigns]'''
*** '''[campaign]'''
**** ''author'' - author(s) of the campaign.
**** ''description'' - description of the campaign. For pre 1.0 campaigns this should also describe the playability.
**** ''downloads'' - the number times the campaign (including previous versions) has been downloaded directly from the campaign server.
**** ''filename'' - filename campaign is stored in (currently the same as ''name'').
**** ''icon'' - path to an image in the standard image directory for Wesnoth. This path must use forward slashes (/). It cannot refer to custom images included with the campaign. This image is displayed as an icon by the campaign client built into Wesnoth.
**** ''name'' - the name of the campaign. Note this is not the title and shouldn't have spaces in it.
**** ''size'' - the size of the campaign in bytes on the campaign server.
**** ''timestamp'' - when this version of the campaign was uploaded.
**** ''title'' - campaign title. This is not a translatable string.
**** ''version'' - version of the campaign. The recommended format is x.y.z where x, y and z are decimal strings. x should be 0 for campaigns that are not yet complete.
**** '''[translation]'''
***** ''language'' - a language that this campaign has appeared to have been at least partially translated into. The following hueristic is used when a campaign is uploaded to extract a list of languages. The list of directories in the uploaded campaign is recursively searched. If a directory named 'LC_MESSAGES' is found then the name of the object containing this '''[dir]''' (normally the parent directory, but could be the campaign name if someone did something silly) is added to the list of translations. Directories named "LC_MESSAGES" are not searched for further matches. The normal naming convention is to use Posix locale names. This will usually be a two letter language code (e.g. "de") or a two letter language code followed by a two letter region code (e.g. "pt_BR"). Since "en_US" is the base language, this language will not be listed as an available translation.

== Downloading a Campaign ==

This command is used to download a specified campaign from the campaign server.

* Request
** '''[request_campaign]'''
*** ''name'' - the name of the campaign. Note this is not the title and shouldn't have spaces in it.
* Response
** ''author'' - author(s) of the campaign.
** ''campaign_name'' - the name of the campaign. Note this is not the title and shouldn't have spaces in it.
** ''description'' - description of the campaign. For pre 1.0 campaigns this should also describe the playability.
** ''icon'' - path to an image in the standard image directory for Wesnoth. This path must use forward slashes (/). It cannot refer to custom images included with the campaign. This image is displayed as an icon by the campaign client built into Wesnoth.
** ''name'' - this field will always be empty. Client code would treat it as a directory name if it was not empty.
** ''timestamp'' - the time the campaign was last uploaded to the campaign server. This is a decimal string containing the number of seconds since the unix epoch.
** ''title'' - the title of the campaign. This is not a translatable string.
** ''version'' - version of the campaign. The recommended format is x.y.z where x, y and z are decimal strings. x should be 0 for campaigns that are not yet complete.
** '''[file]'''
*** ''name'' - the name of the file. This does not include any path information.
*** ''contents'' - the content of the file (binary data). This data should have no zero bytes. A byte with the code of 1 is an escape byte. The next byte will be data, but its value should be reduced by 1. Normally only byte codes of 0 and 1 are escaped.
** '''[dir]'''
*** ''name'' - the name of the directory. This does not include any path information.
*** This tag may contain '''[file]''' or '''[dir]''' subtags (the latter are recursive).

== Uploading a Campaign ==

This command is used to upload a new or updated version of an add on campaign to the campaign server.

* Request
** '''[upload]'''
*** ''author'' - author(s) of the campaign.
*** ''description'' - description of the campaign. For pre 1.0 campaigns this should also describe the playability.
*** ''icon'' - path to an image in the standard image directory for Wesnoth. This path must use forward slashes (/). It cannot refer to custom images included with the campaign. This image is displayed as an icon by the campaign client built into Wesnoth.
*** ''name'' - the name of the campaign. Note this is not the title and shouldn't have spaces in it.
*** ''passphrase'' - this is used to control updates to campaigns on the server. For existing campaigns, if the passphrase doesn't match, the update will be rejected. You can't easily change the passphrase yourself. If you lose or need to change the passphrase you need to contact the server administrator.
*** ''title'' - the title of the campaign. This is not a translatable string.
*** ''version'' - version of the campaign. The recommended format is x.y.z where x, y and z are decimal strings. x should be 0 for campaigns that are not yet complete.
*** '''[data]'''
**** '''[file]'''
***** ''name'' - the name of the file. This does not include any path information.
***** ''contents'' - the content of the file (binary data). This data should have no zero bytes. A byte with the code of 1 is an escape byte. The next byte will be data, but its value should be reduced by 1. Normally only byte codes of 0 and 1 are escaped.
**** '''[dir]'''
***** ''name'' - the name of the directory. This does not include any path information.
***** This tag may contain '''[file]''' or '''[dir]''' subtags (the latter are recursive).
* Response
** '''[message]'''
*** ''message'' - translatable string that indicates that the campaign upload was successful.

== Changing the Passphrase for a Campaign ==

This command is used to change the passphrase for a campaign. Currently the normal client doesn't have a way to use this. However, you can use the perl script campaign_passphrase.pl to do it, if you have a copy of the source tree.

* Request
** '''[change_passphrase]'''
*** ''name'' - The name of campaign.
*** ''passphrase'' - The old passphrase.
*** ''new_passphrase'' - The new passphrase.
* Respose
** '''[message]'''
*** ''message'' - Translatable string that says that the passphrase was changed.

== Deleting a Campaign ==

This command is used to delete an existing campaign from the campaign server.

* Request
** '''[delete]'''
*** ''name'' - The name of the campaign to delete.
*** ''passphrase'' - This must match the passphrase on record for the campaign in order for the campaign to be deleted.
* Response
** '''[message]'''
*** ''message'' - Translatable string that says that the campaign was deleted.

== Request License Information ==

Retrieve the terms of the license used for any uploaded campaigns. You may not upload a campaign if you don't (or can't) aggree to the license. Wesnoth requires campaigns (including images and sound) to be licensed under the GPL.

* Request
** '''[request_terms]'''
* Response
** '''[message]'''
*** ''message'' - translatable string containing the text of the license.

== See Also ==

* [[UserScenarios#Campaign_Server_Web_Access]]
* [[PblWML]]
* [[BuildingCampaignsThePBLFile]]

CampaignServerWML

2006-06-07T00:40:58Z

Bruno: /* Uploading a Campaign */

= Campaign Server WML =

This page describes the WML commands exchanged between campaign download clients and a campaign server. Note that this WML is not used in the game engine. Note that this page describes functions of the 1.1 campaign server, because that is what is used by the official campaign server.

== Listing Available Campaigns ==

This request is used to retrieve a list of campaigns available on the server and some overview information about them.

* Request
** '''[request_campaign_list]'''
*** ''after'' - only select campaigns last updated after the indicated time. ''after'' is in seconds relative to either the time when the command is processed or the [http://wikipedia.org/wiki/Unix_epoch Unix epoch]. As an example, to select campaigns last updated after Mon Oct 10 21:42:41 2005 GMT, you could not specify a value for ''times_relative_to'' (to use the default of relative to the [http://wikipedia.org/wiki/Unix_epoch Unix epoch]) and specify ''after'' = "1128980561".
*** ''before'' - only select campaigns last updated before the indicated time. ''before'' is in seconds relative to either the time when the command is processed or the [http://wikipedia.org/wiki/Unix_epoch Unix epoch]. As an example, to select campaigns last updated over a day ago, you could specify ''times_relative_to'' = "now" and ''before'' = "-86400".
*** ''language'' - return information only about campaigns that appear to be translated into this language. These names will normally be posix locale names. Typically you will want to either use a two letter language code (e.g. "de") or a two letter language code followed by a two character region code (e.g. "pt_BR"). Note that "pt" will not match "pt_BR".
*** ''name'' - return information for this campaign. If the name is specified and not the empty string then only information about campaigns with matching names (unless something changes there will be at most one such campaign) will be returned.
*** ''times_relative_to'' - "now" means that ''before'' and ''after'' are in seconds relative to the time when the request is processed by the campaign server. Any other value, or if it is not set, indicates that ''before'' and ''after'' are in seconds relative to the [http://wikipedia.org/wiki/Unix_epoch Unix epoch].
* Response
** ''timestamp'' - what time the campaign server thought it was when this response was generated. You shouldn't count on this as a guaranty that no new campaigns will appear with previous update times. This could be used to detect significant clock skew or possibly used as an approximate time for how far you need to look back for updated campaigns.
** '''[campaigns]'''
*** '''[campaign]'''
**** ''author'' - author(s) of the campaign.
**** ''description'' - description of the campaign. For pre 1.0 campaigns this should also describe the playability.
**** ''downloads'' - the number times the campaign (including previous versions) has been downloaded directly from the campaign server.
**** ''filename'' - filename campaign is stored in (currently the same as ''name'').
**** ''icon'' - path to an image in the standard image directory for Wesnoth. This path must use forward slashes (/). It cannot refer to custom images included with the campaign. This image is displayed as an icon by the campaign client built into Wesnoth.
**** ''name'' - the name of the campaign. Note this is not the title and shouldn't have spaces in it.
**** ''size'' - the size of the campaign in bytes on the campaign server.
**** ''timestamp'' - when this version of the campaign was uploaded.
**** ''title'' - campaign title. This is not a translatable string.
**** ''version'' - version of the campaign. The recommended format is x.y.z where x, y and z are decimal strings. x should be 0 for campaigns that are not yet complete.
**** '''[translation]'''
***** ''language'' - a language that this campaign has appeared to have been at least partially translated into. The following hueristic is used when a campaign is uploaded to extract a list of languages. The list of directories in the uploaded campaign is recursively searched. If a directory named 'LC_MESSAGES' is found then the name of the object containing this '''[dir]''' (normally the parent directory, but could be the campaign name if someone did something silly) is added to the list of translations. Directories named "LC_MESSAGES" are not searched for further matches. The normal naming convention is to use Posix locale names. This will usually be a two letter language code (e.g. "de") or a two letter language code followed by a two letter region code (e.g. "pt_BR"). Since "en_US" is the base language, this language will not be listed as an available translation.

== Downloading a Campaign ==

This command is used to download a specified campaign from the campaign server.

* Request
** '''[request_campaign]'''
*** ''name'' - the name of the campaign. Note this is not the title and shouldn't have spaces in it.
* Response
** ''author'' - author(s) of the campaign.
** ''campaign_name'' - the name of the campaign. Note this is not the title and shouldn't have spaces in it.
** ''description'' - description of the campaign. For pre 1.0 campaigns this should also describe the playability.
** ''icon'' - path to an image in the standard image directory for Wesnoth. This path must use forward slashes (/). It cannot refer to custom images included with the campaign. This image is displayed as an icon by the campaign client built into Wesnoth.
** ''name'' - this field will always be empty. Client code would treat it as a directory name if it was not empty.
** ''passphrase'' - this is used to control updates to campaigns on the server. For existing campaigns, if the passphrase doesn't match the update will be rejected. You can't change the passphrase yourself. If you lose or need to change the passphrase you need to contact the server administrator.
** ''timestamp'' - the time the campaign was last uploaded to the campaign server. This is a decimal string containing the number of seconds since the unix epoch.
** ''title'' - the title of the campaign. This is not a translatable string.
** ''version'' - version of the campaign. The recommended format is x.y.z where x, y and z are decimal strings. x should be 0 for campaigns that are not yet complete.
** '''[file]'''
*** ''name'' - the name of the file. This does not include any path information.
*** ''contents'' - the content of the file (binary data). This data should have no zero bytes. A byte with the code of 1 is an escape byte. The next byte will be data, but its value should be reduced by 1. Normally only byte codes of 0 and 1 are escaped.
** '''[dir]'''
*** ''name'' - the name of the directory. This does not include any path information.
*** This tag may contain '''[file]''' or '''[dir]''' subtags (the latter are recursive).

== Uploading a Campaign ==

This command is used to upload a new or updated version of an add on campaign to the campaign server.

* Request
** '''[upload]'''
*** ''author'' - author(s) of the campaign.
*** ''description'' - description of the campaign. For pre 1.0 campaigns this should also describe the playability.
*** ''icon'' - path to an image in the standard image directory for Wesnoth. This path must use forward slashes (/). It cannot refer to custom images included with the campaign. This image is displayed as an icon by the campaign client built into Wesnoth.
*** ''name'' - the name of the campaign. Note this is not the title and shouldn't have spaces in it.
*** ''passphrase'' - this is used to control updates to campaigns on the server. For existing campaigns, if the passphrase doesn't match, the update will be rejected. You can't easily change the passphrase yourself. If you lose or need to change the passphrase you need to contact the server administrator.
*** ''title'' - the title of the campaign. This is not a translatable string.
*** ''version'' - version of the campaign. The recommended format is x.y.z where x, y and z are decimal strings. x should be 0 for campaigns that are not yet complete.
*** '''[data]'''
**** '''[file]'''
***** ''name'' - the name of the file. This does not include any path information.
***** ''contents'' - the content of the file (binary data). This data should have no zero bytes. A byte with the code of 1 is an escape byte. The next byte will be data, but its value should be reduced by 1. Normally only byte codes of 0 and 1 are escaped.
**** '''[dir]'''
***** ''name'' - the name of the directory. This does not include any path information.
***** This tag may contain '''[file]''' or '''[dir]''' subtags (the latter are recursive).
* Response
** '''[message]'''
*** ''message'' - translatable string that indicates that the campaign upload was successful.

== Changing the Passphrase for a Campaign ==

This command is used to change the passphrase for a campaign. Currently the normal client doesn't have a way to use this. However, you can use the perl script campaign_passphrase.pl to do it, if you have a copy of the source tree.

* Request
** '''[change_passphrase]'''
*** ''name'' - The name of campaign.
*** ''passphrase'' - The old passphrase.
*** ''new_passphrase'' - The new passphrase.
* Respose
** '''[message]'''
*** ''message'' - Translatable string that says that the passphrase was changed.

== Deleting a Campaign ==

This command is used to delete an existing campaign from the campaign server.

* Request
** '''[delete]'''
*** ''name'' - The name of the campaign to delete.
*** ''passphrase'' - This must match the passphrase on record for the campaign in order for the campaign to be deleted.
* Response
** '''[message]'''
*** ''message'' - Translatable string that says that the campaign was deleted.

== Request License Information ==

Retrieve the terms of the license used for any uploaded campaigns. You may not upload a campaign if you don't (or can't) aggree to the license. Wesnoth requires campaigns (including images and sound) to be licensed under the GPL.

* Request
** '''[request_terms]'''
* Response
** '''[message]'''
*** ''message'' - translatable string containing the text of the license.

== See Also ==

* [[UserScenarios#Campaign_Server_Web_Access]]
* [[PblWML]]
* [[BuildingCampaignsThePBLFile]]

CampaignServerWML

2006-06-07T00:40:21Z

Bruno: /* Uploading a Campaign */

= Campaign Server WML =

This page describes the WML commands exchanged between campaign download clients and a campaign server. Note that this WML is not used in the game engine. Note that this page describes functions of the 1.1 campaign server, because that is what is used by the official campaign server.

== Listing Available Campaigns ==

This request is used to retrieve a list of campaigns available on the server and some overview information about them.

* Request
** '''[request_campaign_list]'''
*** ''after'' - only select campaigns last updated after the indicated time. ''after'' is in seconds relative to either the time when the command is processed or the [http://wikipedia.org/wiki/Unix_epoch Unix epoch]. As an example, to select campaigns last updated after Mon Oct 10 21:42:41 2005 GMT, you could not specify a value for ''times_relative_to'' (to use the default of relative to the [http://wikipedia.org/wiki/Unix_epoch Unix epoch]) and specify ''after'' = "1128980561".
*** ''before'' - only select campaigns last updated before the indicated time. ''before'' is in seconds relative to either the time when the command is processed or the [http://wikipedia.org/wiki/Unix_epoch Unix epoch]. As an example, to select campaigns last updated over a day ago, you could specify ''times_relative_to'' = "now" and ''before'' = "-86400".
*** ''language'' - return information only about campaigns that appear to be translated into this language. These names will normally be posix locale names. Typically you will want to either use a two letter language code (e.g. "de") or a two letter language code followed by a two character region code (e.g. "pt_BR"). Note that "pt" will not match "pt_BR".
*** ''name'' - return information for this campaign. If the name is specified and not the empty string then only information about campaigns with matching names (unless something changes there will be at most one such campaign) will be returned.
*** ''times_relative_to'' - "now" means that ''before'' and ''after'' are in seconds relative to the time when the request is processed by the campaign server. Any other value, or if it is not set, indicates that ''before'' and ''after'' are in seconds relative to the [http://wikipedia.org/wiki/Unix_epoch Unix epoch].
* Response
** ''timestamp'' - what time the campaign server thought it was when this response was generated. You shouldn't count on this as a guaranty that no new campaigns will appear with previous update times. This could be used to detect significant clock skew or possibly used as an approximate time for how far you need to look back for updated campaigns.
** '''[campaigns]'''
*** '''[campaign]'''
**** ''author'' - author(s) of the campaign.
**** ''description'' - description of the campaign. For pre 1.0 campaigns this should also describe the playability.
**** ''downloads'' - the number times the campaign (including previous versions) has been downloaded directly from the campaign server.
**** ''filename'' - filename campaign is stored in (currently the same as ''name'').
**** ''icon'' - path to an image in the standard image directory for Wesnoth. This path must use forward slashes (/). It cannot refer to custom images included with the campaign. This image is displayed as an icon by the campaign client built into Wesnoth.
**** ''name'' - the name of the campaign. Note this is not the title and shouldn't have spaces in it.
**** ''size'' - the size of the campaign in bytes on the campaign server.
**** ''timestamp'' - when this version of the campaign was uploaded.
**** ''title'' - campaign title. This is not a translatable string.
**** ''version'' - version of the campaign. The recommended format is x.y.z where x, y and z are decimal strings. x should be 0 for campaigns that are not yet complete.
**** '''[translation]'''
***** ''language'' - a language that this campaign has appeared to have been at least partially translated into. The following hueristic is used when a campaign is uploaded to extract a list of languages. The list of directories in the uploaded campaign is recursively searched. If a directory named 'LC_MESSAGES' is found then the name of the object containing this '''[dir]''' (normally the parent directory, but could be the campaign name if someone did something silly) is added to the list of translations. Directories named "LC_MESSAGES" are not searched for further matches. The normal naming convention is to use Posix locale names. This will usually be a two letter language code (e.g. "de") or a two letter language code followed by a two letter region code (e.g. "pt_BR"). Since "en_US" is the base language, this language will not be listed as an available translation.

== Downloading a Campaign ==

This command is used to download a specified campaign from the campaign server.

* Request
** '''[request_campaign]'''
*** ''name'' - the name of the campaign. Note this is not the title and shouldn't have spaces in it.
* Response
** ''author'' - author(s) of the campaign.
** ''campaign_name'' - the name of the campaign. Note this is not the title and shouldn't have spaces in it.
** ''description'' - description of the campaign. For pre 1.0 campaigns this should also describe the playability.
** ''icon'' - path to an image in the standard image directory for Wesnoth. This path must use forward slashes (/). It cannot refer to custom images included with the campaign. This image is displayed as an icon by the campaign client built into Wesnoth.
** ''name'' - this field will always be empty. Client code would treat it as a directory name if it was not empty.
** ''passphrase'' - this is used to control updates to campaigns on the server. For existing campaigns, if the passphrase doesn't match the update will be rejected. You can't change the passphrase yourself. If you lose or need to change the passphrase you need to contact the server administrator.
** ''timestamp'' - the time the campaign was last uploaded to the campaign server. This is a decimal string containing the number of seconds since the unix epoch.
** ''title'' - the title of the campaign. This is not a translatable string.
** ''version'' - version of the campaign. The recommended format is x.y.z where x, y and z are decimal strings. x should be 0 for campaigns that are not yet complete.
** '''[file]'''
*** ''name'' - the name of the file. This does not include any path information.
*** ''contents'' - the content of the file (binary data). This data should have no zero bytes. A byte with the code of 1 is an escape byte. The next byte will be data, but its value should be reduced by 1. Normally only byte codes of 0 and 1 are escaped.
** '''[dir]'''
*** ''name'' - the name of the directory. This does not include any path information.
*** This tag may contain '''[file]''' or '''[dir]''' subtags (the latter are recursive).

== Uploading a Campaign ==

This command is used to upload a new or updated version of an add on campaign to the campaign server.

* Request
** '''[upload]'''
*** ''author'' - author(s) of the campaign.
*** ''description'' - description of the campaign. For pre 1.0 campaigns this should also describe the playability.
*** ''icon'' - path to an image in the standard image directory for Wesnoth. This path must use forward slashes (/). It cannot refer to custom images included with the campaign. This image is displayed as an icon by the campaign client built into Wesnoth.
*** ''name'' - the name of the campaign. Note this is not the title and shouldn't have spaces in it.
*** ''passphrase'' - this is used to control updates to campaigns on the server. For existing campaigns, if the passphrase doesn't match the update will be rejected. You can't easily change the passphrase yourself. If you lose or need to change the passphrase you need to contact the server administrator.
*** ''title'' - the title of the campaign. This is not a translatable string.
*** ''version'' - version of the campaign. The recommended format is x.y.z where x, y and z are decimal strings. x should be 0 for campaigns that are not yet complete.
*** '''[data]'''
**** '''[file]'''
***** ''name'' - the name of the file. This does not include any path information.
***** ''contents'' - the content of the file (binary data). This data should have no zero bytes. A byte with the code of 1 is an escape byte. The next byte will be data, but its value should be reduced by 1. Normally only byte codes of 0 and 1 are escaped.
**** '''[dir]'''
***** ''name'' - the name of the directory. This does not include any path information.
***** This tag may contain '''[file]''' or '''[dir]''' subtags (the latter are recursive).
* Response
** '''[message]'''
*** ''message'' - translatable string that indicates that the campaign upload was successful.

== Changing the Passphrase for a Campaign ==

This command is used to change the passphrase for a campaign. Currently the normal client doesn't have a way to use this. However, you can use the perl script campaign_passphrase.pl to do it, if you have a copy of the source tree.

* Request
** '''[change_passphrase]'''
*** ''name'' - The name of campaign.
*** ''passphrase'' - The old passphrase.
*** ''new_passphrase'' - The new passphrase.
* Respose
** '''[message]'''
*** ''message'' - Translatable string that says that the passphrase was changed.

== Deleting a Campaign ==

This command is used to delete an existing campaign from the campaign server.

* Request
** '''[delete]'''
*** ''name'' - The name of the campaign to delete.
*** ''passphrase'' - This must match the passphrase on record for the campaign in order for the campaign to be deleted.
* Response
** '''[message]'''
*** ''message'' - Translatable string that says that the campaign was deleted.

== Request License Information ==

Retrieve the terms of the license used for any uploaded campaigns. You may not upload a campaign if you don't (or can't) aggree to the license. Wesnoth requires campaigns (including images and sound) to be licensed under the GPL.

* Request
** '''[request_terms]'''
* Response
** '''[message]'''
*** ''message'' - translatable string containing the text of the license.

== See Also ==

* [[UserScenarios#Campaign_Server_Web_Access]]
* [[PblWML]]
* [[BuildingCampaignsThePBLFile]]

HelpWML

2006-05-29T17:47:54Z

Bruno: /* The toplevel [help] tag */

{{WML Tags}}
== The toplevel [help] tag ==

The [help] tag describes the Wesnoth help system.
Each of the three subtags [toplevel], [section] and [topic] describe an element of the help system.

* '''[toplevel]''' The toplevel tag denotes sections and topics that should be shown immediately when the "Help" button is clicked on (see the "help" action, [[ThemeWML]]). The sections referenced within this tag are read recursively, including all subsections.
** ''sections'' a list of IDs of the sections to include recursively.
** ''topics'' a list of IDs of the topics to show as not being included in a section; i.e. top-level topics.
* '''[section]''' The section tag describes a section in the help browser. A section contains subsections and/or topics.
** ''id'' is the unique ID for this section.
** ''title'' (translatable) is the title of the section. It is displayed in the left menu.
** ''sections'' is a list of IDs of the sections that should be this section's subsections.
** ''topics'' is a list of IDs of the topics that should be included in this section. Topics will be included in the order listed unless sorting is requested.
** ''generator'' provides the name of a function that will generate a list of topics and include them in this section. These topics will be included after topics listed on the ''topics'' key unless ''sort_topics'' is ''yes''.
** ''sort_topics'' specifies whether or not to list the topics sorted by title or in the order listed on the ''topics'' key. ''yes'' indicates fixed and generated topics should be sorted together by title. (Note: for this to work the generator must sort topics by title.) ''no'' indicates that topics should appear in the order listed with fixed topics appearing before generated topics. ''generated'' indicates that fixed topics should not be sorted and will be followed by generated topics sorted by the generator. The default is ''generated''.
* '''[topic]''' The topic tag describes one topic, i.e, one help page. The keys that are meaningful in the topic tag:
** ''id'' is the unique ID for this topic.
** ''title'' (translatable) is the title of the topic. It is displayed in the left menu and as a header in the text area.
** ''text'' (translatable) is the contents of the topics. May contain markup described below.

== Help System Topic Markup ==

The markup that is allowed in the text key within a topic tag is in XML, a markup language similar to WML. Note that this is the only time that markup language is used as a value. To convert WML into XML, you need to make some changes:

- change brackets ('''[''', ''']''') into angle brackets('''<''', '''>''')

- change ''newline'' into space(''' ''')

- all values with spaces must be in quotes. This is because spaces are actually newlines.

Due to limitations of the wiki (it is coded using XML), the WML for the topic markup will be described rather than
the XML. However, you still need to use XML to code the topic.

The following key/tags are accepted for ''text'':
* '''[ref]''' creates a cross reference to another topic, a cross reference will not show up if the topic it refers to is not visible.
** ''dst'' the ID of the topic to reference.
** ''text'' the text to display as a link to ''dst''; i.e. when ''text'' is clicked on the page ''dst'' will be linked to.
** ''force'' shows the cross reference even though the referred topic is not shown.
* '''[jump]''' when this text is selected, the input position along the X axis is moved. Can be used for example to create columns of things. A jump is ignored if it would bring the input position to an invalid position.
** ''to'' the X coordinate of the text area to jump to. If it can't be done on the current row, the input position is moved down one line.
** ''amount'' the number of pixels to jump forward
* '''[img]''' insert an image in the topic
** ''src'' the path to the image relative to the '''images/''' directory.
** ''align'' the position of the image with respect to the page. Values are ''here'', ''left'', ''middle'', and ''right''.
** ''float'' whether the image should float(have text filled in around it) or not (be seen as included in a line).
* '''[format]''' describes a group of text in a different format. Can be used to describe different colors and font sizes.
** ''bold'' whether the text should be displayed in bold('''bold''').
** ''italic'' whether the text should be displayed in italics(''italics'').
** ''color'' the color of the text. Only a few colors are currently supported: ''white''(default), ''green'', ''red'', ''yellow'', and ''black''.
** ''font_size'' the height of the text in pixels. Default 9(?)
** ''text'' the text to be displayed using this format.
* '''[italic]''' a shortcut to '''[format]''' which inputs only the ''text'' key. Uses the attribute '''italic=yes'''
* '''[bold]''' like [italic], but uses '''bold=yes'''
* '''[header]''' like [italic], but uses both the attributes '''bold=yes''' and '''font_size=13'''(?)

Example:
[help]
[toplevel]
sections=introduction,gameplay
topics=about
[/toplevel]
[section]
id=gameplay
sections=combat
topics=income_and_upkeep,time_of_day,terrain
[/section]
[topic]
id=terrain
title=Terrain
text="<ref>dst=income_and_upkeep text='Link to Income and Upkeep topic'</ref>"
[/topic]
[/help]

== See Also ==

* [[ReferenceWML]]

[[Category: WML Reference]]

HelpWML

2006-05-29T17:47:08Z

Bruno: /* The toplevel [help] tag */

{{WML Tags}}
== The toplevel [help] tag ==

The [help] tag describes the Wesnoth help system.
Each of the three subtags [toplevel], [section] and [topic] describe an element of the help system.

* '''[toplevel]''' The toplevel tag denotes sections and topics that should be shown immediately when the "Help" button is clicked on (see the "help" action, [[ThemeWML]]). The sections referenced within this tag are read recursively, including all subsections.
** ''sections'' a list of IDs of the sections to include recursively.
** ''topics'' a list of IDs of the topics to show as not being included in a section; i.e. top-level topics.
* '''[section]''' The section tag describes a section in the help browser. A section contains subsections and/or topics.
** ''id'' is the unique ID for this section.
** ''title'' (translatable) is the title of the section. It is displayed in the left menu.
** ''sections'' is a list of IDs of the sections that should be this section's subsections.
** ''topics'' is a list of IDs of the topics that should be included in this section. Topics will be included in the order listed unless sorting is requested.
** ''generator'' provides the name of a function that will generate a list of topics and include them in this section. These topics will be included after topics listed on the ''topics'' key unless ''sort_topics'' is ''yes''.
** ''sort_topics'' specifies whether or not to list the topics sorted by title or in the order listed on the ''topics'' key. ''yes'' indicates fixed and generated topics should be sorted together by title. (Note: for this to work the generator must sort units by title.) ''no'' indicates that topics should appear in the order listed with fixed topics appearing before generated topics. ''generated'' indicates that fixed topics should not be sorted and will be followed by generated topics sorted by the generator. The default is ''generated''.
* '''[topic]''' The topic tag describes one topic, i.e, one help page. The keys that are meaningful in the topic tag:
** ''id'' is the unique ID for this topic.
** ''title'' (translatable) is the title of the topic. It is displayed in the left menu and as a header in the text area.
** ''text'' (translatable) is the contents of the topics. May contain markup described below.

== Help System Topic Markup ==

The markup that is allowed in the text key within a topic tag is in XML, a markup language similar to WML. Note that this is the only time that markup language is used as a value. To convert WML into XML, you need to make some changes:

- change brackets ('''[''', ''']''') into angle brackets('''<''', '''>''')

- change ''newline'' into space(''' ''')

- all values with spaces must be in quotes. This is because spaces are actually newlines.

Due to limitations of the wiki (it is coded using XML), the WML for the topic markup will be described rather than
the XML. However, you still need to use XML to code the topic.

The following key/tags are accepted for ''text'':
* '''[ref]''' creates a cross reference to another topic, a cross reference will not show up if the topic it refers to is not visible.
** ''dst'' the ID of the topic to reference.
** ''text'' the text to display as a link to ''dst''; i.e. when ''text'' is clicked on the page ''dst'' will be linked to.
** ''force'' shows the cross reference even though the referred topic is not shown.
* '''[jump]''' when this text is selected, the input position along the X axis is moved. Can be used for example to create columns of things. A jump is ignored if it would bring the input position to an invalid position.
** ''to'' the X coordinate of the text area to jump to. If it can't be done on the current row, the input position is moved down one line.
** ''amount'' the number of pixels to jump forward
* '''[img]''' insert an image in the topic
** ''src'' the path to the image relative to the '''images/''' directory.
** ''align'' the position of the image with respect to the page. Values are ''here'', ''left'', ''middle'', and ''right''.
** ''float'' whether the image should float(have text filled in around it) or not (be seen as included in a line).
* '''[format]''' describes a group of text in a different format. Can be used to describe different colors and font sizes.
** ''bold'' whether the text should be displayed in bold('''bold''').
** ''italic'' whether the text should be displayed in italics(''italics'').
** ''color'' the color of the text. Only a few colors are currently supported: ''white''(default), ''green'', ''red'', ''yellow'', and ''black''.
** ''font_size'' the height of the text in pixels. Default 9(?)
** ''text'' the text to be displayed using this format.
* '''[italic]''' a shortcut to '''[format]''' which inputs only the ''text'' key. Uses the attribute '''italic=yes'''
* '''[bold]''' like [italic], but uses '''bold=yes'''
* '''[header]''' like [italic], but uses both the attributes '''bold=yes''' and '''font_size=13'''(?)

Example:
[help]
[toplevel]
sections=introduction,gameplay
topics=about
[/toplevel]
[section]
id=gameplay
sections=combat
topics=income_and_upkeep,time_of_day,terrain
[/section]
[topic]
id=terrain
title=Terrain
text="<ref>dst=income_and_upkeep text='Link to Income and Upkeep topic'</ref>"
[/topic]
[/help]

== See Also ==

* [[ReferenceWML]]

[[Category: WML Reference]]

UnitTypeWML

2006-05-29T07:46:40Z

Bruno: /* The [unit] tag */

{{WML Tags}}
== The [unit] tag ==

Each '''[unit]''' tag defines one unit type.

Unit animation syntax is described in [[AnimationWML]].

The following key/tags are recognized:
{| class="gallery" style="text-align:left;"
|-
! [[ability]]
| a list of the unit's abilities. See [[AbilitiesWML]] for a description of abilities.
|-
! [[advancefrom]]
| allows a campaign-specific unit to be spliced into an already existing advancement tree. It should generally be used only inside a campaign ifdef, to prevent changes to other campaigns. This tag makes changes to the ''advanceto'' and ''experience'' keys of a base unit to make it advance into this unit. It takes these keys: ** ''unit'' the id of the base unit from which this unit advances. This adds the unit into the list of units which ''unit'' can advance into. ** [[experience]] is optional. If present and lower than the experience already required for the base unit to advance, then the experience to advance is lowered. Note: this will also lower the experience required to advance to other units which the base unit can advance into.
|-
! [[advanceto]]
| When this unit has experience greater than or equal to [[experience]], it is replaced by a unit with 0 experience of the type that the value of [[advanceto]] refers to. All modifications that have been done to the unit are applied to the unit it is replaced by.
|-
! alignment
| how the unit's damage should be affected by its lawful bonus (See [[TimeWML]]).
|-
! cost
| when a player recruits a unit of this type, the player loses ''cost'' gold. If this would cause gold to drop below 0, the unit cannot be recruited.
|-
! experience
| When this unit has experience greater than or equal to ''experience'', it is replaced by a unit with 0 experience of the type that the value of ''advanceto'' refers to. All modifications that have been done to the unit are applied to the unit it is replaced by.
|-
! gender
| has a value of either ''male'' or ''female'', and determines which of the keys ''male_names'' and ''female_names'' should be read. When a unit of this type is recruited, it will be randomly assigned a name by the random name generator, which will use these names as a base.
|-
! hitpoints
| the maximum HP that the unit has, and the HP it has when it is created.
|-
! id
|the value of the ''type'' key for units of this type. An ''id'' should consist only of alphanumerics and underscores. ''type'' keys are found in [[SingleUnitWML]] and [[FilterWML]].
|-
! level
| the amount of upkeep the unit costs. After this unit fights, its opponent gains ''level'' experience. See also kill_experience ([[GameConfigWML]]), and leadership ([[AbilitiesWML]]).
|-
! movement
| the number of move points that this unit recieves each turn.
|-
! movetype
| See '''[[movetype]]''', [[UnitsWML]]. Note that the tags '''[[movement_costs]]''', '''[[defense]]''', and '''[[resistance]]''' can be used to modify this movetype.
|-
! name
|(translatable) displayed in the Status Table for units of this type.
|-
! num_traits
| the number of traits that units of this type should receive when they are recruited, overriding the value set in the [race] tag.
|-
! profile
| the portrait image to use for this unit type. {{DevFeature}}You can also set a portrait for an individual unit instead of the whole unit type (see [[SingleUnitWML]]).
|-
! race
| See '''[race]''', [[UnitsWML]]. Also used in standard unit filter (see [[FilterWML]]).
|-
! unit_description
| (translatable) the text displayed in the unit descriptor box for this unit. Default 'No description available...'.
|-
! undead_variation
| Which image to use when a unit of this type is killed by a unit with the plague ability.
|-
! usage
| the way that the AI should recruit this unit, as determined by the scenario designer. (See ''recruitment_pattern'', [[AiWML]]). The following are conventions on usage: ** 'scout' Fast, ** 'fighter' Melee fighter, ** 'archer' Ranged fighter, ** 'mixed fighter' Melee and ranged fighter, and ** 'healer' Specialty 'heals' or 'cures'.
|-
! zoc
| {{DevFeature}} if "yes" the unit will have a zone of control regardless of level. If present but set to anything other than "yes," the unit will have no zone of control. If the tag is omitted, zone of control is dictated by unit level (level 0 = no zoc, level 1+ = has zoc).
|}
==== After max level advancement (AMLA) ====
* '''[advancement]''' describes what happens to a unit when it reaches the XP required for advancement. It is considered as an advancement in the same way as advancement described by ''advanceto''; however, if the player chooses this advancement, the unit will have one or more effects applied to it instead of advancing.
** ''id'' normal internationalization id.
** ''description'' a description (see [[DescriptionWML]]) displayed as the option for this advancement if there is another advancement option that the player must choose from; otherwise, the advancement is chosen automatically and this key is irrelevant.
** ''max_times'' default 1. The maximum times the unit can be awarded this advancement.
** ''require_amla'' {{DevFeature}} An optional list of AMLA ''id'' keys that act as prerequisites for this advancement to become available. Order is not important, and an AMLA id can be repeated any number of times to indicate that another advancement must be chosen several times before this advancement option will become available.
*** example: ''require_amla=tough,tough,incr_damage'' assumes there exist other [advancement] options called ''id=tough'' and ''id=incr_damage''. Once ''tough'' is chosen twice and ''incr_damage'' is chosen once, then the current [advancement] will become available.
*** ''require_amla=tough,incr_damage,tough'' is an equivalent way of expressing this.
** '''[effect]''' A modification applied to the unit whenever this advancement is chosen. See [[EffectWML]]

==== Attacks ====
* '''[attack]''' one of the unit's attacks.
** ''description'' a translatable text for name of the attack, to be displayed to the user.
** ''name'' the name of the attack. Used as a default description, if ''description'' is not present, and to determine the default icon, if ''icon'' is not present (if ''name=x'' then ''icon=attacks/x.png'' is assumed unless present). Non-translatable. Used for the ''has_weapon'' key; see [[FilterWML]]
** ''type'' the damage type of the attack. Used in determining resistance to this attack (see '''[resistances]''', [[UnitWML]]). Possible values are 'blade', 'pierce', 'impact', 'fire', 'cold', and 'holy'.
** ''special'' the special ability of the attack. Currently having more than 1 ability is not supported. See [[AbilitiesWML]] for a list of possible values.
** ''icon'' the image to use as an icon for the attack in the attack choice menu, as a path relative to the images directory.
** ''range'' the range of the attack. Used to determine the enemy's retaliation, which will be of the same type. Also displayed on the status table in parentheses; 'short'(default) displays "melee", while 'long' displays "ranged". {{DevFeature}}: range can be anything. Standard values are now "melee" and "ranged". From now on, ''short'' and ''long'' will be treated as totally different ranges. You can create any number of ranges now (with any name), and units can only retaliate against attacks for which they have a corresponding attack of the same range. This value is translatable.
** ''damage'' the damage of this attack
** ''number'' the number of strikes per attack this weapon has
For those two following settings, the engine usually chooses the attack with the best average total damages * weight (default weight = 1.0).
** ''attack_weight'' helps the AI to choose which attack to use when attacking; highly weighted attacks are more likely to be used. {{DevFeature}}: Setting it to 0 disables the attack on attack
** ''defense_weight'' used to determine which attack is used for retaliation. This affects gameplay, as the player is not allowed to determine his unit's retaliation weapon. {{DevFeature}}: Setting it to 0 disable the attacks on defense

** '''[animation]'''
:: This describes an animation for this attack. If multiple animations are present, one will be randomly chosen each time the unit attacks. See [[AnimationWML]] for possible keys.

* '''[defend]''' See [[AnimationWML]]
* '''[death]''' See [[AnimationWML]]
* '''[teleport_anim]''' See [[AnimationWML]]
* '''[extra_anim]''' See [[AnimationWML]]
* '''[event]''' {{DevFeature}} Any [event] written inside the [unit] tag will get included into any scenario where a unit of this type appears in. Note that such events get included when a unit of this type first appears in the scenario, not automatically when the scenario begins (meaning that ''name=prestart'' events, for example, would usually never trigger). See [[EventWML]] and [[WML_Abilities]]

* '''[variation]''' Defines a variation of a unit. Variations are invoked with an [effect] tag. They are currently used for graphical variations (giving character sprites new weapons) but theoretically you could do anything with it.
** ''variation_name'' The name of the variation.
: All other keys in '''[variation]''' are the same as for '''[unit]''' itself.

* '''[male]''', '''[female]''' They can contain all '''[unit]''' tags, to specify a variation of different gender for a unit.

== See Also ==

* [[AnimationWML]]
* [[AnimationWML1.1]]
* [[ReferenceWML]]
* [[TerrainWML]]

[[Category: WML Reference]]

UnitTypeWML

2006-05-29T07:35:17Z

Bruno: /* The [unit] tag */

{{WML Tags}}
== The [unit] tag ==

Each '''[unit]''' tag defines one unit type.

Unit animation syntax is described in [[AnimationWML]].

The following key/tags are recognized:
{| class="gallery" style="text-align:left;"
|-
! [[ability]]
| a list of the unit's abilities. See [[AbilitiesWML]] for a description of abilities.
|-
! [[advancefrom]]
| allows a campaign-specific unit to be spliced into an already existing advancement tree. It should generally be used only inside a campaign ifdef, to prevent changes to other campaigns. This tag makes changes to the ''advanceto'' and ''experience'' keys of a base unit to make it advance into this unit. It takes these keys: ** ''unit'' the id of the base unit from which this unit advances. This adds the unit into the list of units which ''unit'' can advance into. ** [[experience]] is optional. If present and lower than the experience already required for the base unit to advance, then the experience to advance is lowered. Note: this will also lower the experience required to advance to other units which the base unit can advance into.
|-
! [[advanceto]]
| When this unit has experience greater than or equal to [[experience]], it is replaced by a unit with 0 experience of the type that the value of [[advanceto]] refers to. All modifications that have been done to the unit are applied to the unit it is replaced by.
|-
! alignment
| how the unit's damage should be affected by its lawful bonus (See [[TimeWML]]).
|-
! cost
| when a player recruits a unit of this type, the player loses ''cost'' gold. If this would cause gold to drop below 0, the unit cannot be recruited.
|-
! experience
| When this unit has experience greater than or equal to ''experience'', it is replaced by a unit with 0 experience of the type that the value of ''advanceto'' refers to. All modifications that have been done to the unit are applied to the unit it is replaced by.
|-
! gender
| has a value of either ''male'' or ''female'', and determines which of the keys ''male_names'' and ''female_names'' should be read. When a unit of this type is recruited, it will be randomly assigned a name by the random name generator, which will use these names as a base.
|-
! hitpoints
| the maximum HP that the unit has, and the HP it has when it is created.
|-
! id
|the value of the ''type'' key for units of this type. An ''id'' should consist only of alphanumerics and underscores. ''type'' keys are found in [[SingleUnitWML]] and [[FilterWML]].
|-
! level
| the amount of upkeep the unit costs. After this unit fights, its opponent gains ''level'' experience. See also kill_experience ([[GameConfigWML]]), and leadership ([[AbilitiesWML]]).
|-
! movement
| the number of move points that this unit recieves each turn.
|-
! movetype
| See '''[[movetype]]''', [[UnitsWML]]. Note that the tags '''[[movement_costs]]''', '''[[defense]]''', and '''[[resistance]]''' can be used to modify this movetype.
|-
! name
|(translatable) displayed in the Status Table for units of this type.
|-
! num_traits
| the number of traits that units of this type should receive when they are recruited, overriding the value set in the [race] tag.
|-
! profile
| the portrait image to use for this unit type. {{DevFeature}}You can also set a portrait for an individual unit instead of the whole unit type (see [[SingleUnitWML]]).
|-
! race
| See '''[race]''', [[UnitsWML]]. Also used in standard unit filter (see [[FilterWML]]).
|-
! unit_description
| (translatable) the text displayed in the unit descriptor box for this unit. Default 'No description available...'.
|-
! usage
| the way that the AI should recruit this unit, as determined by the scenario designer. (See ''recruitment_pattern'', [[AiWML]]). The following are conventions on usage: ** 'scout' Fast, ** 'fighter' Melee fighter, ** 'archer' Ranged fighter, ** 'mixed fighter' Melee and ranged fighter, and ** 'healer' Specialty 'heals' or 'cures'.
|-
! zoc
| {{DevFeature}} if "yes" the unit will have a zone of control regardless of level. If present but set to anything other than "yes," the unit will have no zone of control. If the tag is omitted, zone of control is dictated by unit level (level 0 = no zoc, level 1+ = has zoc).
|}
==== After max level advancement (AMLA) ====
* '''[advancement]''' describes what happens to a unit when it reaches the XP required for advancement. It is considered as an advancement in the same way as advancement described by ''advanceto''; however, if the player chooses this advancement, the unit will have one or more effects applied to it instead of advancing.
** ''id'' normal internationalization id.
** ''description'' a description (see [[DescriptionWML]]) displayed as the option for this advancement if there is another advancement option that the player must choose from; otherwise, the advancement is chosen automatically and this key is irrelevant.
** ''max_times'' default 1. The maximum times the unit can be awarded this advancement.
** ''require_amla'' {{DevFeature}} An optional list of AMLA ''id'' keys that act as prerequisites for this advancement to become available. Order is not important, and an AMLA id can be repeated any number of times to indicate that another advancement must be chosen several times before this advancement option will become available.
*** example: ''require_amla=tough,tough,incr_damage'' assumes there exist other [advancement] options called ''id=tough'' and ''id=incr_damage''. Once ''tough'' is chosen twice and ''incr_damage'' is chosen once, then the current [advancement] will become available.
*** ''require_amla=tough,incr_damage,tough'' is an equivalent way of expressing this.
** '''[effect]''' A modification applied to the unit whenever this advancement is chosen. See [[EffectWML]]

==== Attacks ====
* '''[attack]''' one of the unit's attacks.
** ''description'' a translatable text for name of the attack, to be displayed to the user.
** ''name'' the name of the attack. Used as a default description, if ''description'' is not present, and to determine the default icon, if ''icon'' is not present (if ''name=x'' then ''icon=attacks/x.png'' is assumed unless present). Non-translatable. Used for the ''has_weapon'' key; see [[FilterWML]]
** ''type'' the damage type of the attack. Used in determining resistance to this attack (see '''[resistances]''', [[UnitWML]]). Possible values are 'blade', 'pierce', 'impact', 'fire', 'cold', and 'holy'.
** ''special'' the special ability of the attack. Currently having more than 1 ability is not supported. See [[AbilitiesWML]] for a list of possible values.
** ''icon'' the image to use as an icon for the attack in the attack choice menu, as a path relative to the images directory.
** ''range'' the range of the attack. Used to determine the enemy's retaliation, which will be of the same type. Also displayed on the status table in parentheses; 'short'(default) displays "melee", while 'long' displays "ranged". {{DevFeature}}: range can be anything. Standard values are now "melee" and "ranged". From now on, ''short'' and ''long'' will be treated as totally different ranges. You can create any number of ranges now (with any name), and units can only retaliate against attacks for which they have a corresponding attack of the same range. This value is translatable.
** ''damage'' the damage of this attack
** ''number'' the number of strikes per attack this weapon has
For those two following settings, the engine usually chooses the attack with the best average total damages * weight (default weight = 1.0).
** ''attack_weight'' helps the AI to choose which attack to use when attacking; highly weighted attacks are more likely to be used. {{DevFeature}}: Setting it to 0 disables the attack on attack
** ''defense_weight'' used to determine which attack is used for retaliation. This affects gameplay, as the player is not allowed to determine his unit's retaliation weapon. {{DevFeature}}: Setting it to 0 disable the attacks on defense

** '''[animation]'''
:: This describes an animation for this attack. If multiple animations are present, one will be randomly chosen each time the unit attacks. See [[AnimationWML]] for possible keys.

* '''[defend]''' See [[AnimationWML]]
* '''[death]''' See [[AnimationWML]]
* '''[teleport_anim]''' See [[AnimationWML]]
* '''[extra_anim]''' See [[AnimationWML]]
* '''[event]''' {{DevFeature}} Any [event] written inside the [unit] tag will get included into any scenario where a unit of this type appears in. Note that such events get included when a unit of this type first appears in the scenario, not automatically when the scenario begins (meaning that ''name=prestart'' events, for example, would usually never trigger). See [[EventWML]] and [[WML_Abilities]]

* '''[variation]''' Defines a variation of a unit. Variations are invoked with an [effect] tag. They are currently used for graphical variations (giving character sprites new weapons) but theoretically you could do anything with it.
** ''variation_name'' The name of the variation.
: All other keys in '''[variation]''' are the same as for '''[unit]''' itself.

* '''[male]''', '''[female]''' They can contain all '''[unit]''' tags, to specify a variation of different gender for a unit.

== See Also ==

* [[AnimationWML]]
* [[AnimationWML1.1]]
* [[ReferenceWML]]
* [[TerrainWML]]

[[Category: WML Reference]]

UnitTypeWML

2006-05-29T07:34:12Z

Bruno: /* The [unit] tag */

{{WML Tags}}
== The [unit] tag ==

Each '''[unit]''' tag defines one unit type.

Unit animation syntax is described in [[AnimationWML]].

The following key/tags are recognized:
{| class="gallery" style="text-align:left;"
|-
! [[ability]]
| a list of the unit's abilities. See [[AbilitiesWML]] for a description of abilities.
|-
! [[advancefrom]]
| allows a campaign-specific unit to be spliced into an already existing advancement tree. It should generally be used only inside a campaign ifdef, to prevent changes to other campaigns. This tag makes changes to the ''advanceto'' and ''experience'' keys of a base unit to make it advance into this unit. It takes these keys: ** ''unit'' the id of the base unit from which this unit advances. This adds the unit into the list of units which ''unit'' can advance into. ** [[experience]] is optional. If present and lower than the experience already required for the base unit to advance, then the experience to advance is lowered. Note: this will also lower the experience required to advance to other units which the base unit can advance into.
|-
! [[advanceto]]
| When this unit has experience greater than or equal to [[experience]], it is replaced by a unit with 0 experience of the type that the value of [[advanceto]] refers to. All modifications that have been done to the unit are applied to the unit it is replaced by.
|-
! alignment
| how the unit's damage should be affected by its lawful bonus (See [[TimeWML]]).
|-
! cost
| when a player recruits a unit of this type, the player loses ''cost'' gold. If this would cause gold to drop below 0, the unit cannot be recruited.
|-
! experience
| When this unit has experience greater than or equal to ''experience'', it is replaced by a unit with 0 experience of the type that the value of ''advanceto'' refers to. All modifications that have been done to the unit are applied to the unit it is replaced by.
|-
! gender
| has a value of either ''male'' or ''female'', and determines which of the keys ''male_names'' and ''female_names'' should be read. When a unit of this type is recruited, it will be randomly assigned a name by the random name generator, which will use these names as a base.
|-
! hitpoints
| the maximum HP that the unit has, and the HP it has when it is created.
|-
! id
|the value of the ''type'' key for units of this type. An ''id'' should consist only of alphanumerics and underscores. ''type'' keys are found in [[SingleUnitWML]] and [[FilterWML]].
|-
! level
| the amount of upkeep the unit costs. After this unit fights, its opponent gains ''level'' experience. See also kill_experience ([[GameConfigWML]]), and leadership ([[AbilitiesWML]]).
|-
! movement
| the number of move points that this unit recieves each turn.
|-
! movetype
| See '''[[movetype]]''', [[UnitsWML]]. Note that the tags '''[[movement_costs]]''', '''[[defense]]''', and '''[[resistance]]''' can be used to modify this movetype.
|-
! name
|(translatable) displayed in the Status Table for units of this type.
|-
! num_traits
| the number of traits that units of this type should receive when they are recruited, overriding the value set in the [race] tag.
|-
! profile
| the portrait image to use for this unit type. {{DevFeature}}You can also set a portrait for an individual unit instead of the whole unit type (see [[SingleUnitWML]]).
|-
! race
| See '''[race]''', [[UnitsWML]]. Also used in standard unit filter (see [[FilterWML]]).
|-
! unit_description
| (translatable) the text displayed in the unit descriptor box for this unit. Default 'No description available...'.
|-
! usage
| the way that the AI should recruit this unit, as determined by the scenario designer. (See ''recruitment_pattern'', [[AiWML]]). The following are conventions on usage: ** 'scout' Fast, ** 'fighter' Melee fighter, ** 'archer' Ranged fighter, ** 'mixed fighter' Melee and ranged fighter, and ** 'healer' Specialty 'heals' or 'cures'.
|-
! zoc
| {{DevFeature}} if "yes" the unit will have a zone of control regardless of level. If present but set to anything other than "yes," the unit will have no zone of control. If the tag is omitted, zone of control is dictated by unit level (level 0 = no zoc, level 1+ = has zoc).
|}
==== After max level advancement (AMLA) ====
* '''[advancement]''' describes what happens to a unit when it reaches the XP required for advancement. It is considered as an advancement in the same way as advancement described by ''advanceto''; however, if the player chooses this advancement, the unit will have one or more effects applied to it instead of advancing.
** ''id'' normal internationalization id.
** ''description'' a description (see [[DescriptionWML]]) displayed as the option for this advancement if there is another advancement option that the player must choose from; otherwise, the advancement is chosen automatically and this key is irrelevant.
** ''max_times'' default 1. The maximum times the unit can be awarded this advancement.
** ''require_amla'' {{DevFeature}} An optional list of AMLA ''id'' keys that act as prerequisites for this advancement to become available. Order is not important, and an AMLA id can be repeated any number of times to indicate that another advancement must be chosen several times before this advancement option will become available.
*** example: ''require_amla=tough,tough,incr_damage'' assumes there exist other [advancement] options called ''id=tough'' and ''id=incr_damage''. Once ''tough'' is chosen twice and ''incr_damage'' is chosen once, then the current [advancement] will become available.
*** ''require_amla=tough,incr_damage,tough'' is an equivalent way of expressing this.
** '''[effect]''' A modification applied to the unit whenever this advancement is chosen. See [[EffectWML]]

==== Attacks ====
* '''[attack]''' one of the unit's attacks.
** ''description'' a translatable text for name of the attack, to be displayed to the user.
** ''name'' the name of the attack. Used as a default description, if ''description'' is not present, and to determine the default icon, if ''icon'' is not present (if ''name=x'' then ''icon=attacks/x.png'' is assumed unless present). Non-translatable. Used for the ''has_weapon'' key; see [[FilterWML]]
** ''type'' the damage type of the attack. Used in determining resistance to this attack (see '''[resistances]''', [[UnitWML]]). Possible values are 'blade', 'pierce', 'impact', 'fire', 'cold', and 'holy'.
** ''special'' the special ability of the attack. Currently having more than 1 ability is not supported. See [[AbilitiesWML]] for a list of possible values.
** ''icon'' the image to use as an icon for the attack in the attack choice menu, as a path relative to the images directory.
** ''range'' the range of the attack. Used to determine the enemy's retaliation, which will be of the same type. Also displayed on the status table in parentheses; 'short'(default) displays "melee", while 'long' displays "ranged". {{DevFeature}}: range can be anything. Standard values are now "melee" and "ranged". From now on, ''short'' and ''long'' will be treated as totally different ranges. You can create any number of ranges now (with any name), and units can only retaliate against attacks for which they have a corresponding attack of the same range. This value is translatable.
** ''damage'' the damage of this attack
** ''number'' the number of strikes per attack this weapon has
For those two following settings, the engine usually chooses the attack with the best average total damages * weight (default weight = 1.0).
** ''attack_weight'' helps the AI to choose which attack to use when attacking; highly weighted attacks are more likely to be used. {{DevFeature}}: Setting it to 0 disables the attack on attack
** ''defense_weight'' used to determine which attack is used for retaliation. This affects gameplay, as the player is not allowed to determine his unit's retaliation weapon. {{DevFeature}}: Setting it to 0 disable the attacks on defense

** '''[animation]'''
:: This describes an animation for this attack. If multiple animations are present, one will be randomly chosen each time the unit attacks. See [[AnimationWML]] for possible keys.

* '''[defend]''' See [[AnimationWML]]
* '''[death]''' See [[AnimationWML]]
* '''[teleport_anim]''' See [[AnimationWML]]
* '''[extra_anim]''' See [[AnimationWML]]
* '''[event]''' {{DevFeature}} Any [event] written inside the [unit] tag will get included into any scenario where a unit of this type appears in. Note that such events get included when a unit of this type first appears in the scenario, not automatically when the scenario begins (meaning that ''name=prestart'' events, for example, would usually never trigger). See [[EventWML]] and [[WML_Abilities]]

* '''[variation]''' Defines a variation of a unit. Variations are invoked with an [effect] tag. They are currently used for graphical variations (giving character sprites new weapons) but theoretically you could do anything with it.
** ''variation_name'' The name of the variation.
: All other keys in '''[variation]''' are the same as for '''[unit]''' itself.

* '''[male]''', '''[female]''' They can contain all '''[unit]''' tags, to specify a variation of different gender for a unit.

== See Also ==

* [[AnimationWML]]
* [[AnimationWML1.1]]
* [[ReferenceWML]]
* [[TerrainWML]]

[[Category: WML Reference]]

SingleUnitWML

2006-05-29T06:40:43Z

Bruno: /* how to describe a single unit */

{{WML Tags}}
== how to describe a single unit ==

This tag, '''[unit]''', describes a single unit on the map, for example Konrad.
It is different from the [unit] in [units], which describes a class of units.

The following keys are recognized:
* ''type'' the ID of the unit's unit type. See [[UnitWML]].

* ''side'' the side that the unit is on.

* ''gender'' can be set to male or female to designate the gender of the unit. Default is male.

* ''x'', ''y'' the location of the unit. If a location isn't provided and the side the unit will belong to has a recall list, the unit will be created on the recall list.

* ''description'' used in standard unit filter ([[FilterWML]]). Note that this field is not filled in with names created at random when recruiting units. Nor is it affected by a player renaming a unit. So when designing maps you don't have to worry about naming conflicts.

* ''user_description'' the name of the unit that is shown to the user. Default ''description''.

* ''generate_description'' if set to "yes", will generate a new name (user_description) for the unit, as if the unit was a freshly-recruited one.

* ''unrenamable'' if 'yes', the user_description cannot be changed by the player (which is only possible when the unit is on the player's side anyway).

* ''traits_description'' the description of the unit's traits which is displayed. However if it is not specified explicitly, the unit's actual traits' names will be used instead, so it is normally not necessary to set this.

* ''random_traits'' {{DevFeature}} choose the traits randomly, just like a recruited unit. '''Don't use this in a MP Scenario as this will cause an Out of Sync (OOS) error'''.

* ''canrecruit'' a special key for leaders.
** '0' default. Unit cannot recruit.
** '1' unit can recruit.
: Normally when a team controls no units with '''canrecruit=1''', that team loses. However, even if your team has lost you continue to play with whatever units you still have until the scenario is over. Usually scenarios end when only one team is left with a leader that can recruit, but special victory conditions can be set up in campaigns. Normally you want to set the leader of a side with '''canrecruit=1'''. If you don't want the leader to recruit, it is usually better to just not give him any unit types to recruit, than to make a special victory condition.

* ''upkeep'' the amount of upkeep the unit costs.
** "free" default for scenario-generated units. Unit does not cost upkeep
** "loyal" unit costs 1 upkeep. Can be changed by the effect 'loyal' (see [[EffectWML]])
** "full" unit costs ''level'' upkeep (see [[UnitWML]]). Default for recruited units

* ''overlays'' a list of images that are overlayed on the unit.

* ''goto_x'', ''goto_y'' UI settings that control courses. Default is 0,0 i.e. the unit is not on a course.

* ''hitpoints'' the HP of the unit. Default is the max HP for ''type''.

* ''experience'' the XP of the unit. Default is 0.

* ''moves'' number of move points the unit has left. Default is the movement for ''type''.

* ''resting'' whether the unit has not moved yet this turn. Used to decide whether to give a unit rest healing.

* ''role'' used in standard unit filter ([[FilterWML]]). Can be set using [role] (see [[InternalActionsWML]]).

* ''ai_special'' causes the unit to act differently.
** "guardian" the unit will not move, except to attack something in the turn it moves (so, it only can move if an enemy unit gets within range of it).

* ''facing'' which way the unit is facing (this only affects how the unit is displayed).
** "normal" (default) unit is facing to the right.
** "reverse" unit is facing to the left.
** "sw" {{DevFeature}} unit is facing to the left (substitute of "reverse").

* ''profile'' {{DevFeature}} sets a default portrait image for this unit. If the unit type already has a portrait set, this is used instead for this unit.
** "unit_image" if given instead of a filename, uses the unit's base image as the portrait (in the same manner that unit types without portraits do by default).

* ''fade_in'' {{DevFeature}} fades the unit in, like when it's recruited/recalled.

* '''[status]''' the status of the unit. This affects different features of the unit, for example whether the unit loses health each turn. Default for all keys is 'off', but this can be changed by the scenario or by special abilities (see [[AbilitiesWML]]). The status of a unit is displayed on the Status Table; each status modification ''statusmod'' is represented by the image '''misc/statusmod.png'''.
** ''poisoned'' if 'on', the unit loses 8 HP each turn. See also ''heals'', ''cures'', [[AbilitiesWML]].
** ''slowed'' if 'on', the unit has 50% of its normal movement and -1 strike on each attack with strikes>1. When the controller of the unit's turn is over, ''slowed'' is set to 'off' {{DevFeature}} slow now halves damage instead of removing one strike
** ''stone'' if 'on', the unit cannot move, attack, or be attacked.
** ''ambush'' if 'on', the unit cannot be seen by opponents.

* '''[variables]''' a set of variables that will be stored when this unit is stored (See [store_unit], [[InternalActionsWML]]). The attribute '''variable'''='''value''' means that when the unit is stored in the array ''unit'', the variable ''unit''.variables.''variable'' will have the value ''value'' (See [[VariablesWML]]).

* '''[modifications]''' changes that have been made to the unit.
** '''[trait]''' a trait the unit has. Same format as [trait], [[UnitsWML]].
** '''[object]''' an object the unit has. Same format as [object], [[DirectActionsWML]].

* ''unit_description'' {{DevFeature}} overrides the unit type description for this unit. You will probably want to set up a ''post_advance'' [[EventWML|event]] to override the default description after promotions.

== See Also ==

* [[UnitWML]]
* [[ReferenceWML]]

SingleUnitWML

2006-05-29T06:39:27Z

Bruno: /* how to describe a single unit */

{{WML Tags}}
== how to describe a single unit ==

This tag, '''[unit]''', describes a single unit on the map, for example Konrad.
It is different from the [unit] in [units], which describes a class of units.

The following keys are recognized:
* ''type'' the ID of the unit's unit type. See [[UnitWML]].

* ''side'' the side that the unit is on.

* ''gender'' can be set to male or female to designate the gender of the unit. Default is male.

* ''x'', ''y'' the location of the unit. If a location isn't provided and the side the unit will belong to has a recall list, the unit will be created on the recall list.

* ''description'' used in standard unit filter ([[FilterWML]]). Note that this field is not filled in with names created at random when recruiting units. Nor is it affected by a player renaming a unit. So when designing maps you don't have to worry about naming conflicts.

* ''user_description'' the name of the unit that is shown to the user. Default ''description''.

* ''generate_description'' if set to "yes", will generate a new name (user_description) for the unit, as if the unit was a freshly-recruited one.

* ''unrenamable'' if 'yes', the user_description cannot be changed by the player (which is only possible when the unit is on the player's side anyway).

* ''traits_description'' the description of the unit's traits which is displayed. However if it is not specified explicitly, the unit's actual traits' names will be used instead, so it is normally not necessary to set this.

* ''random_traits'' {{DevFeature}} choose the traits randomly, just like a recruited unit. '''Don't use this in a MP Scenario as this will cause an Out of Sync (OOS) error'''.

* ''canrecruit'' a special key for leaders.
** '0' default. Unit cannot recruit.
** '1' unit can recruit.
: Normally when a team controls no units with '''canrecruit=1''', that team loses. However, even if your team has lost you continue to play with whatever units you still have until the scenario is over. Usually scenarios end when only one team is left with a leader that can recruit, but special victory conditions can be set up in campaigns. Normally you want to set the leader of a side with '''canrecruit=1'''. If you don't want the leader to recruit, it is usually better to just not give him any unit types to recruit, than to make a special victory condition.

* ''upkeep'' the amount of upkeep the unit costs.
** "free" default for scenario-generated units. Unit does not cost upkeep
** "loyal" unit costs 1 upkeep. Can be changed by the effect 'loyal' (see [[EffectWML]])
** "full" unit costs ''level'' upkeep (see [[UnitWML]]). Default for recruited units

* ''overlays'' a list of images that are overlayed on the unit.

* ''goto_x'', ''goto_y'' UI settings that control courses. Default is 0,0 i.e. the unit is not on a course.

* ''hitpoints'' the HP of the unit. Default is the max HP for ''type''.

* ''experience'' the XP of the unit. Default is 0.

* ''moves'' number of move points the unit has left. Default is the movement for ''type''.

* ''resting'' whether the unit has not moved yet this turn. Used to decide whether to give a unit rest healing.

* ''role'' used in standard unit filter ([[FilterWML]]). Can be set using [role] (see [[InternalActionsWML]]).

* ''ai_special'' causes the unit to act differently.
** "guardian" the unit will not move, except to attack something in the turn it moves (so, it only can move if an enemy unit gets within range of it).

* ''facing'' which way the unit is facing (this only affects how the unit is displayed).
** "normal" (default) unit is facing to the right.
** "reverse" unit is facing to the left.
** "sw" {{DevFeature}} unit is facing to the left (substitute of "reverse").

* ''profile'' {{DevFeature}} sets a default portrait image for this unit. If the unit type already has a portrait set, this is used instead for this unit.
** "unit_image" if given instead of a filename, uses the unit's base image as the portrait (in the same manner that unit types without portraits do by default).

* ''fade_in'' {{DevFeature}} fades the unit in, like when it's recruited/recalled.

* '''[status]''' the status of the unit. This affects different features of the unit, for example whether the unit loses health each turn. Default for all keys is 'off', but this can be changed by the scenario or by special abilities (see [[AbilitiesWML]]). The status of a unit is displayed on the Status Table; each status modification ''statusmod'' is represented by the image '''misc/statusmod.png'''.
** ''poisoned'' if 'on', the unit loses 8 HP each turn. See also ''heals'', ''cures'', [[AbilitiesWML]].
** ''slowed'' if 'on', the unit has 50% of its normal movement and -1 strike on each attack with strikes>1. When the controller of the unit's turn is over, ''slowed'' is set to 'off' {{DevFeature}} slow now halves damage instead of removing one strike
** ''stone'' if 'on', the unit cannot move, attack, or be attacked.
** ''ambush'' if 'on', the unit cannot be seen by opponents.

* '''[variables]''' a set of variables that will be stored when this unit is stored (See [store_unit], [[InternalActionsWML]]). The attribute '''variable'''='''value''' means that when the unit is stored in the array ''unit'', the variable ''unit''.variables.''variable'' will have the value ''value'' (See [[VariablesWML]]).

* '''[modifications]''' changes that have been made to the unit.
** '''[trait]''' a trait the unit has. Same format as [trait], [[UnitsWML]].
** '''[object]''' an object the unit has. Same format as [object], [[DirectActionsWML]].

* ''unit_description'' {{DevFeature}} overrides the unit type description for this unit. You will probably want to set up a ''post_advance'' [[EventWML]] to override the default description after promotions.

== See Also ==

* [[UnitWML]]
* [[ReferenceWML]]

SingleUnitWML

2006-05-29T06:37:56Z

Bruno: /* how to describe a single unit */

{{WML Tags}}
== how to describe a single unit ==

This tag, '''[unit]''', describes a single unit on the map, for example Konrad.
It is different from the [unit] in [units], which describes a class of units.

The following keys are recognized:
* ''type'' the ID of the unit's unit type. See [[UnitWML]].

* ''side'' the side that the unit is on.

* ''gender'' can be set to male or female to designate the gender of the unit. Default is male.

* ''x'', ''y'' the location of the unit. If a location isn't provided and the side the unit will belong to has a recall list, the unit will be created on the recall list.

* ''description'' used in standard unit filter ([[FilterWML]]). Note that this field is not filled in with names created at random when recruiting units. Nor is it affected by a player renaming a unit. So when designing maps you don't have to worry about naming conflicts.

* ''user_description'' the name of the unit that is shown to the user. Default ''description''.

* ''generate_description'' if set to "yes", will generate a new name (user_description) for the unit, as if the unit was a freshly-recruited one.

* ''unrenamable'' if 'yes', the user_description cannot be changed by the player (which is only possible when the unit is on the player's side anyway).

* ''traits_description'' the description of the unit's traits which is displayed. However if it is not specified explicitly, the unit's actual traits' names will be used instead, so it is normally not necessary to set this.

* ''random_traits'' {{DevFeature}} choose the traits randomly, just like a recruited unit. '''Don't use this in a MP Scenario as this will cause an Out of Sync (OOS) error'''.

* ''canrecruit'' a special key for leaders.
** '0' default. Unit cannot recruit.
** '1' unit can recruit.
: Normally when a team controls no units with '''canrecruit=1''', that team loses. However, even if your team has lost you continue to play with whatever units you still have until the scenario is over. Usually scenarios end when only one team is left with a leader that can recruit, but special victory conditions can be set up in campaigns. Normally you want to set the leader of a side with '''canrecruit=1'''. If you don't want the leader to recruit, it is usually better to just not give him any unit types to recruit, than to make a special victory condition.

* ''upkeep'' the amount of upkeep the unit costs.
** "free" default for scenario-generated units. Unit does not cost upkeep
** "loyal" unit costs 1 upkeep. Can be changed by the effect 'loyal' (see [[EffectWML]])
** "full" unit costs ''level'' upkeep (see [[UnitWML]]). Default for recruited units

* ''overlays'' a list of images that are overlayed on the unit.

* ''goto_x'', ''goto_y'' UI settings that control courses. Default is 0,0 i.e. the unit is not on a course.

* ''hitpoints'' the HP of the unit. Default is the max HP for ''type''.

* ''experience'' the XP of the unit. Default is 0.

* ''moves'' number of move points the unit has left. Default is the movement for ''type''.

* ''resting'' whether the unit has not moved yet this turn. Used to decide whether to give a unit rest healing.

* ''role'' used in standard unit filter ([[FilterWML]]). Can be set using [role] (see [[InternalActionsWML]]).

* ''ai_special'' causes the unit to act differently.
** "guardian" the unit will not move, except to attack something in the turn it moves (so, it only can move if an enemy unit gets within range of it).

* ''facing'' which way the unit is facing (this only affects how the unit is displayed).
** "normal" (default) unit is facing to the right.
** "reverse" unit is facing to the left.
** "sw" {{DevFeature}} unit is facing to the left (substitute of "reverse").

* ''profile'' {{DevFeature}} sets a default portrait image for this unit. If the unit type already has a portrait set, this is used instead for this unit.
** "unit_image" if given instead of a filename, uses the unit's base image as the portrait (in the same manner that unit types without portraits do by default).

* ''fade_in'' {{DevFeature}} fades the unit in, like when it's recruited/recalled.

* '''[status]''' the status of the unit. This affects different features of the unit, for example whether the unit loses health each turn. Default for all keys is 'off', but this can be changed by the scenario or by special abilities (see [[AbilitiesWML]]). The status of a unit is displayed on the Status Table; each status modification ''statusmod'' is represented by the image '''misc/statusmod.png'''.
** ''poisoned'' if 'on', the unit loses 8 HP each turn. See also ''heals'', ''cures'', [[AbilitiesWML]].
** ''slowed'' if 'on', the unit has 50% of its normal movement and -1 strike on each attack with strikes>1. When the controller of the unit's turn is over, ''slowed'' is set to 'off' {{DevFeature}} slow now halves damage instead of removing one strike
** ''stone'' if 'on', the unit cannot move, attack, or be attacked.
** ''ambush'' if 'on', the unit cannot be seen by opponents.

* '''[variables]''' a set of variables that will be stored when this unit is stored (See [store_unit], [[InternalActionsWML]]). The attribute '''variable'''='''value''' means that when the unit is stored in the array ''unit'', the variable ''unit''.variables.''variable'' will have the value ''value'' (See [[VariablesWML]]).

* '''[modifications]''' changes that have been made to the unit.
** '''[trait]''' a trait the unit has. Same format as [trait], [[UnitsWML]].
** '''[object]''' an object the unit has. Same format as [object], [[DirectActionsWML]].

* ''unit_description'' {{DevFeature}} overrides the unit type description for this unit. You will probably want to set up a ''post_advance'' [[event]] to override the default description after promotions.

== See Also ==

* [[UnitWML]]
* [[ReferenceWML]]

SingleUnitWML

2006-05-29T06:36:15Z

Bruno: /* how to describe a single unit */

{{WML Tags}}
== how to describe a single unit ==

This tag, '''[unit]''', describes a single unit on the map, for example Konrad.
It is different from the [unit] in [units], which describes a class of units.

The following keys are recognized:
* ''type'' the ID of the unit's unit type. See [[UnitWML]].

* ''side'' the side that the unit is on.

* ''gender'' can be set to male or female to designate the gender of the unit. Default is male.

* ''x'', ''y'' the location of the unit. If a location isn't provided and the side the unit will belong to has a recall list, the unit will be created on the recall list.

* ''description'' used in standard unit filter ([[FilterWML]]). Note that this field is not filled in with names created at random when recruiting units. Nor is it affected by a player renaming a unit. So when designing maps you don't have to worry about naming conflicts.

* ''user_description'' the name of the unit that is shown to the user. Default ''description''.

* ''generate_description'' if set to "yes", will generate a new name (user_description) for the unit, as if the unit was a freshly-recruited one.

* ''unrenamable'' if 'yes', the user_description cannot be changed by the player (which is only possible when the unit is on the player's side anyway).

* ''traits_description'' the description of the unit's traits which is displayed. However if it is not specified explicitly, the unit's actual traits' names will be used instead, so it is normally not necessary to set this.

* ''random_traits'' {{DevFeature}} choose the traits randomly, just like a recruited unit. '''Don't use this in a MP Scenario as this will cause an Out of Sync (OOS) error'''.

* ''canrecruit'' a special key for leaders.
** '0' default. Unit cannot recruit.
** '1' unit can recruit.
: Normally when a team controls no units with '''canrecruit=1''', that team loses. However, even if your team has lost you continue to play with whatever units you still have until the scenario is over. Usually scenarios end when only one team is left with a leader that can recruit, but special victory conditions can be set up in campaigns. Normally you want to set the leader of a side with '''canrecruit=1'''. If you don't want the leader to recruit, it is usually better to just not give him any unit types to recruit, than to make a special victory condition.

* ''upkeep'' the amount of upkeep the unit costs.
** "free" default for scenario-generated units. Unit does not cost upkeep
** "loyal" unit costs 1 upkeep. Can be changed by the effect 'loyal' (see [[EffectWML]])
** "full" unit costs ''level'' upkeep (see [[UnitWML]]). Default for recruited units

* ''overlays'' a list of images that are overlayed on the unit.

* ''goto_x'', ''goto_y'' UI settings that control courses. Default is 0,0 i.e. the unit is not on a course.

* ''hitpoints'' the HP of the unit. Default is the max HP for ''type''.

* ''experience'' the XP of the unit. Default is 0.

* ''moves'' number of move points the unit has left. Default is the movement for ''type''.

* ''resting'' whether the unit has not moved yet this turn. Used to decide whether to give a unit rest healing.

* ''role'' used in standard unit filter ([[FilterWML]]). Can be set using [role] (see [[InternalActionsWML]]).

* ''ai_special'' causes the unit to act differently.
** "guardian" the unit will not move, except to attack something in the turn it moves (so, it only can move if an enemy unit gets within range of it).

* ''facing'' which way the unit is facing (this only affects how the unit is displayed).
** "normal" (default) unit is facing to the right.
** "reverse" unit is facing to the left.
** "sw" {{DevFeature}} unit is facing to the left (substitute of "reverse").

* ''profile'' {{DevFeature}} sets a default portrait image for this unit. If the unit type already has a portrait set, this is used instead for this unit.
** "unit_image" if given instead of a filename, uses the unit's base image as the portrait (in the same manner that unit types without portraits do by default).

* ''fade_in'' {{DevFeature}} fades the unit in, like when it's recruited/recalled.

* '''[status]''' the status of the unit. This affects different features of the unit, for example whether the unit loses health each turn. Default for all keys is 'off', but this can be changed by the scenario or by special abilities (see [[AbilitiesWML]]). The status of a unit is displayed on the Status Table; each status modification ''statusmod'' is represented by the image '''misc/statusmod.png'''.
** ''poisoned'' if 'on', the unit loses 8 HP each turn. See also ''heals'', ''cures'', [[AbilitiesWML]].
** ''slowed'' if 'on', the unit has 50% of its normal movement and -1 strike on each attack with strikes>1. When the controller of the unit's turn is over, ''slowed'' is set to 'off' {{DevFeature}} slow now halves damage instead of removing one strike
** ''stone'' if 'on', the unit cannot move, attack, or be attacked.
** ''ambush'' if 'on', the unit cannot be seen by opponents.

* '''[variables]''' a set of variables that will be stored when this unit is stored (See [store_unit], [[InternalActionsWML]]). The attribute '''variable'''='''value''' means that when the unit is stored in the array ''unit'', the variable ''unit''.variables.''variable'' will have the value ''value'' (See [[VariablesWML]]).

* '''[modifications]''' changes that have been made to the unit.
** '''[trait]''' a trait the unit has. Same format as [trait], [[UnitsWML]].
** '''[object]''' an object the unit has. Same format as [object], [[DirectActionsWML]].

* ''unit_description'' {{DevFeature}} overrides the unit type description for this unit. You will probably want to set up ''advanceto'' events to override the default description after promotions.

== See Also ==

* [[UnitWML]]
* [[ReferenceWML]]

SingleUnitWML

2006-05-29T06:24:06Z

Bruno: /* how to describe a single unit */

{{WML Tags}}
== how to describe a single unit ==

This tag, '''[unit]''', describes a single unit on the map, for example Konrad.
It is different from the [unit] in [units], which describes a class of units.

The following keys are recognized:
* ''type'' the ID of the unit's unit type. See [[UnitWML]].

* ''side'' the side that the unit is on.

* ''gender'' can be set to male or female to designate the gender of the unit. Default is male.

* ''x'', ''y'' the location of the unit. If a location isn't provided and the side the unit will belong to has a recall list, the unit will be created on the recall list.

* ''description'' used in standard unit filter ([[FilterWML]]). Note that this field is not filled in with names created at random when recruiting units. Nor is it affected by a player renaming a unit. So when designing maps you don't have to worry about naming conflicts.

* ''user_description'' the name of the unit that is shown to the user. Default ''description''.

* ''generate_description'' if set to "yes", will generate a new name (user_description) for the unit, as if the unit was a freshly-recruited one.

* ''unrenamable'' if 'yes', the user_description cannot be changed by the player (which is only possible when the unit is on the player's side anyway).

* ''traits_description'' the description of the unit's traits which is displayed. However if it is not specified explicitly, the unit's actual traits' names will be used instead, so it is normally not necessary to set this.

* ''random_traits'' {{DevFeature}} choose the traits randomly, just like a recruited unit. '''Don't use this in a MP Scenario as this will cause an Out of Sync (OOS) error'''.

* ''canrecruit'' a special key for leaders.
** '0' default. Unit cannot recruit.
** '1' unit can recruit.
: Normally when a team controls no units with '''canrecruit=1''', that team loses. However, even if your team has lost you continue to play with whatever units you still have until the scenario is over. Usually scenarios end when only one team is left with a leader that can recruit, but special victory conditions can be set up in campaigns. Normally you want to set the leader of a side with '''canrecruit=1'''. If you don't want the leader to recruit, it is usually better to just not give him any unit types to recruit, than to make a special victory condition.

* ''upkeep'' the amount of upkeep the unit costs.
** "free" default for scenario-generated units. Unit does not cost upkeep
** "loyal" unit costs 1 upkeep. Can be changed by the effect 'loyal' (see [[EffectWML]])
** "full" unit costs ''level'' upkeep (see [[UnitWML]]). Default for recruited units

* ''overlays'' a list of images that are overlayed on the unit.

* ''goto_x'', ''goto_y'' UI settings that control courses. Default is 0,0 i.e. the unit is not on a course.

* ''hitpoints'' the HP of the unit. Default is the max HP for ''type''.

* ''experience'' the XP of the unit. Default is 0.

* ''moves'' number of move points the unit has left. Default is the movement for ''type''.

* ''resting'' whether the unit has not moved yet this turn. Used to decide whether to give a unit rest healing.

* ''role'' used in standard unit filter ([[FilterWML]]). Can be set using [role] (see [[InternalActionsWML]]).

* ''ai_special'' causes the unit to act differently.
** "guardian" the unit will not move, except to attack something in the turn it moves (so, it only can move if an enemy unit gets within range of it).

* ''facing'' which way the unit is facing (this only affects how the unit is displayed).
** "normal" (default) unit is facing to the right.
** "reverse" unit is facing to the left.
** "sw" {{DevFeature}} unit is facing to the left (substitute of "reverse").

* ''profile'' {{DevFeature}} sets a default portrait image for this unit. If the unit type already has a portrait set, this is used instead for this unit.
** "unit_image" if given instead of a filename, uses the unit's base image as the portrait (in the same manner that unit types without portraits do by default).

* ''fade_in'' {{DevFeature}} fades the unit in, like when it's recruited/recalled.

* '''[status]''' the status of the unit. This affects different features of the unit, for example whether the unit loses health each turn. Default for all keys is 'off', but this can be changed by the scenario or by special abilities (see [[AbilitiesWML]]). The status of a unit is displayed on the Status Table; each status modification ''statusmod'' is represented by the image '''misc/statusmod.png'''.
** ''poisoned'' if 'on', the unit loses 8 HP each turn. See also ''heals'', ''cures'', [[AbilitiesWML]].
** ''slowed'' if 'on', the unit has 50% of its normal movement and -1 strike on each attack with strikes>1. When the controller of the unit's turn is over, ''slowed'' is set to 'off' {{DevFeature}} slow now halves damage instead of removing one strike
** ''stone'' if 'on', the unit cannot move, attack, or be attacked.
** ''ambush'' if 'on', the unit cannot be seen by opponents.

* '''[variables]''' a set of variables that will be stored when this unit is stored (See [store_unit], [[InternalActionsWML]]). The attribute '''variable'''='''value''' means that when the unit is stored in the array ''unit'', the variable ''unit''.variables.''variable'' will have the value ''value'' (See [[VariablesWML]]).

* '''[modifications]''' changes that have been made to the unit.
** '''[trait]''' a trait the unit has. Same format as [trait], [[UnitsWML]].
** '''[object]''' an object the unit has. Same format as [object], [[DirectActionsWML]].

* ''unit_description'' {{DevFeature}} overrides the unit type description for this unit. Currently this description is lost when the unit promotes.

== See Also ==

* [[UnitWML]]
* [[ReferenceWML]]

HelpWML

2006-05-29T06:05:33Z

Bruno: /* The toplevel [help] tag */

{{WML Tags}}
== The toplevel [help] tag ==

The [help] tag describes the Wesnoth help system.
Each of the three subtags [toplevel], [section] and [topic] describe an element of the help system.

* '''[toplevel]''' The toplevel tag denotes sections and topics that should be shown immediately when the "Help" button is clicked on (see the "help" action, [[ThemeWML]]). The sections referenced within this tag are read recursively, including all subsections.
** ''sections'' a list of IDs of the sections to include recursively.
** ''topics'' a list of IDs of the topics to show as not being included in a section; i.e. top-level topics.
* '''[section]''' The section tag describes a section in the help browser. A section contains subsections and/or topics.
** ''id'' is the unique ID for this section.
** ''title'' (translatable) is the title of the section. It is displayed in the left menu.
** ''sections'' is a list of IDs of the sections that should be this section's subsections.
** ''topics'' is a list of IDs of the topics that should be included in this section. Topics will be included in the order listed unless sorting is requested.
** ''generator'' provides the name of a function that will generate a list of topics and include them in this section. These topics will be sorted and included after topics listed on the ''topics'' key unless sorting is requested. (In which case all topics will be sorted together.)
** ''sort_topics'' specifies whether or not to list the topics sorted by title or in the order listed on the ''topics'' key. ''yes'' indicates sorting should be done. ''no'' indicates that topics should appear in the order listed. The default is not to sort.
* '''[topic]''' The topic tag describes one topic, i.e, one help page. The keys that are meaningful in the topic tag:
** ''id'' is the unique ID for this topic.
** ''title'' (translatable) is the title of the topic. It is displayed in the left menu and as a header in the text area.
** ''text'' (translatable) is the contents of the topics. May contain markup described below.

== Help System Topic Markup ==

The markup that is allowed in the text key within a topic tag is in XML, a markup language similar to WML. Note that this is the only time that markup language is used as a value. To convert WML into XML, you need to make some changes:

- change brackets ('''[''', ''']''') into angle brackets('''<''', '''>''')

- change ''newline'' into space(''' ''')

- all values with spaces must be in quotes. This is because spaces are actually newlines.

Due to limitations of the wiki (it is coded using XML), the WML for the topic markup will be described rather than
the XML. However, you still need to use XML to code the topic.

The following key/tags are accepted for ''text'':
* '''[ref]''' creates a cross reference to another topic, a cross reference will not show up if the topic it refers to is not visible.
** ''dst'' the ID of the topic to reference.
** ''text'' the text to display as a link to ''dst''; i.e. when ''text'' is clicked on the page ''dst'' will be linked to.
** ''force'' shows the cross reference even though the referred topic is not shown.
* '''[jump]''' when this text is selected, the input position along the X axis is moved. Can be used for example to create columns of things. A jump is ignored if it would bring the input position to an invalid position.
** ''to'' the X coordinate of the text area to jump to. If it can't be done on the current row, the input position is moved down one line.
** ''amount'' the number of pixels to jump forward
* '''[img]''' insert an image in the topic
** ''src'' the path to the image relative to the '''images/''' directory.
** ''align'' the position of the image with respect to the page. Values are ''here'', ''left'', ''middle'', and ''right''.
** ''float'' whether the image should float(have text filled in around it) or not (be seen as included in a line).
* '''[format]''' describes a group of text in a different format. Can be used to describe different colors and font sizes.
** ''bold'' whether the text should be displayed in bold('''bold''').
** ''italic'' whether the text should be displayed in italics(''italics'').
** ''color'' the color of the text. Only a few colors are currently supported: ''white''(default), ''green'', ''red'', ''yellow'', and ''black''.
** ''font_size'' the height of the text in pixels. Default 9(?)
** ''text'' the text to be displayed using this format.
* '''[italic]''' a shortcut to '''[format]''' which inputs only the ''text'' key. Uses the attribute '''italic=yes'''
* '''[bold]''' like [italic], but uses '''bold=yes'''
* '''[header]''' like [italic], but uses both the attributes '''bold=yes''' and '''font_size=13'''(?)

Example:
[help]
[toplevel]
sections=introduction,gameplay
topics=about
[/toplevel]
[section]
id=gameplay
sections=combat
topics=income_and_upkeep,time_of_day,terrain
[/section]
[topic]
id=terrain
title=Terrain
text="<ref>dst=income_and_upkeep text='Link to Income and Upkeep topic'</ref>"
[/topic]
[/help]

== See Also ==

* [[ReferenceWML]]

[[Category: WML Reference]]

HelpWML

2006-05-29T06:01:16Z

Bruno: /* The toplevel [help] tag */

{{WML Tags}}
== The toplevel [help] tag ==

The [help] tag describes the Wesnoth help system.
Each of the three subtags [toplevel], [section] and [topic] describe an element of the help system.

* '''[toplevel]''' The toplevel tag denotes sections and topics that should be shown immediately when the "Help" button is clicked on (see the "help" action, [[ThemeWML]]). The sections referenced within this tag are read recursively, including all subsections.
** ''sections'' a list of IDs of the sections to include recursively.
** ''topics'' a list of IDs of the topics to show as not being included in a section; i.e. top-level topics.
* '''[section]''' The section tag describes a section in the help browser. A section contains subsections and/or topics.
** ''id'' is the unique ID for this section.
** ''title'' (translatable) is the title of the section. It is displayed in the left menu.
** ''sections'' is a list of IDs of the sections that should be this section's subsections.
** ''topics'' is a list of IDs of the topics that should be included in this section. Topics will be included in the order listed unless sorting is requested.
** ''generator'' provides the name of a function that will generate a list of topics and include them in this section. These topics will be sorted and included after topics listed on the ''topics'' key unless sorting is requested. (In which case all topics will be sorted together.)
** ''sort_topics'' specifies whether or not to list the topics sorted by title or in the order listed on the ''topics'' key. ''yes'' indicates sorting should be done. ''no'' indicates that topics should appear in the order listed.
* '''[topic]''' The topic tag describes one topic, i.e, one help page. The keys that are meaningful in the topic tag:
** ''id'' is the unique ID for this topic.
** ''title'' (translatable) is the title of the topic. It is displayed in the left menu and as a header in the text area.
** ''text'' (translatable) is the contents of the topics. May contain markup described below.

== Help System Topic Markup ==

The markup that is allowed in the text key within a topic tag is in XML, a markup language similar to WML. Note that this is the only time that markup language is used as a value. To convert WML into XML, you need to make some changes:

- change brackets ('''[''', ''']''') into angle brackets('''<''', '''>''')

- change ''newline'' into space(''' ''')

- all values with spaces must be in quotes. This is because spaces are actually newlines.

Due to limitations of the wiki (it is coded using XML), the WML for the topic markup will be described rather than
the XML. However, you still need to use XML to code the topic.

The following key/tags are accepted for ''text'':
* '''[ref]''' creates a cross reference to another topic, a cross reference will not show up if the topic it refers to is not visible.
** ''dst'' the ID of the topic to reference.
** ''text'' the text to display as a link to ''dst''; i.e. when ''text'' is clicked on the page ''dst'' will be linked to.
** ''force'' shows the cross reference even though the referred topic is not shown.
* '''[jump]''' when this text is selected, the input position along the X axis is moved. Can be used for example to create columns of things. A jump is ignored if it would bring the input position to an invalid position.
** ''to'' the X coordinate of the text area to jump to. If it can't be done on the current row, the input position is moved down one line.
** ''amount'' the number of pixels to jump forward
* '''[img]''' insert an image in the topic
** ''src'' the path to the image relative to the '''images/''' directory.
** ''align'' the position of the image with respect to the page. Values are ''here'', ''left'', ''middle'', and ''right''.
** ''float'' whether the image should float(have text filled in around it) or not (be seen as included in a line).
* '''[format]''' describes a group of text in a different format. Can be used to describe different colors and font sizes.
** ''bold'' whether the text should be displayed in bold('''bold''').
** ''italic'' whether the text should be displayed in italics(''italics'').
** ''color'' the color of the text. Only a few colors are currently supported: ''white''(default), ''green'', ''red'', ''yellow'', and ''black''.
** ''font_size'' the height of the text in pixels. Default 9(?)
** ''text'' the text to be displayed using this format.
* '''[italic]''' a shortcut to '''[format]''' which inputs only the ''text'' key. Uses the attribute '''italic=yes'''
* '''[bold]''' like [italic], but uses '''bold=yes'''
* '''[header]''' like [italic], but uses both the attributes '''bold=yes''' and '''font_size=13'''(?)

Example:
[help]
[toplevel]
sections=introduction,gameplay
topics=about
[/toplevel]
[section]
id=gameplay
sections=combat
topics=income_and_upkeep,time_of_day,terrain
[/section]
[topic]
id=terrain
title=Terrain
text="<ref>dst=income_and_upkeep text='Link to Income and Upkeep topic'</ref>"
[/topic]
[/help]

== See Also ==

* [[ReferenceWML]]

[[Category: WML Reference]]

SingleUnitWML

2006-05-28T04:39:02Z

Bruno: /* how to describe a single unit */

{{WML Tags}}
== how to describe a single unit ==

This tag, '''[unit]''', describes a single unit on the map, for example Konrad.
It is different from the [unit] in [units], which describes a class of units.

The following keys are recognized:
* ''type'' the ID of the unit's unit type. See [[UnitWML]].

* ''side'' the side that the unit is on.

* ''gender'' can be set to male or female to designate the gender of the unit. Default is male.

* ''x'', ''y'' the location of the unit. If a location isn't provided and the side the unit will belong to has a recall list, the unit will be created on the recall list.

* ''description'' used in standard unit filter ([[FilterWML]]). Note that this field is not filled in with names created at random when recruiting units. Nor is it affected by a player renaming a unit. So when designing maps you don't have to worry about naming conflicts.

* ''user_description'' the name of the unit that is shown to the user. Default ''description''.

* ''generate_description'' if set to "yes", will generate a new name (user_description) for the unit, as if the unit was a freshly-recruited one.

* ''unrenamable'' if 'yes', the user_description cannot be changed by the player (which is only possible when the unit is on the player's side anyway).

* ''traits_description'' the description of the unit's traits which is displayed. However if it is not specified explicitly, the unit's actual traits' names will be used instead, so it is normally not necessary to set this.

* ''random_traits'' {{DevFeature}} choose the traits randomly, just like a recruited unit. '''Don't use this in a MP Scenario as this will cause an Out of Sync (OOS) error'''.

* ''canrecruit'' a special key for leaders.
** '0' default. Unit cannot recruit.
** '1' unit can recruit.
: Normally when a team controls no units with '''canrecruit=1''', that team loses. However, even if your team has lost you continue to play with whatever units you still have until the scenario is over. Usually scenarios end when only one team is left with a leader that can recruit, but special victory conditions can be set up in campaigns. Normally you want to set the leader of a side with '''canrecruit=1'''. If you don't want the leader to recruit, it is usually better to just not give him any unit types to recruit, than to make a special victory condition.

* ''upkeep'' the amount of upkeep the unit costs.
** "free" default for scenario-generated units. Unit does not cost upkeep
** "loyal" unit costs 1 upkeep. Can be changed by the effect 'loyal' (see [[EffectWML]])
** "full" unit costs ''level'' upkeep (see [[UnitWML]]). Default for recruited units

* ''overlays'' a list of images that are overlayed on the unit.

* ''goto_x'', ''goto_y'' UI settings that control courses. Default is 0,0 i.e. the unit is not on a course.

* ''hitpoints'' the HP of the unit. Default is the max HP for ''type''.

* ''experience'' the XP of the unit. Default is 0.

* ''moves'' number of move points the unit has left. Default is the movement for ''type''.

* ''resting'' whether the unit has not moved yet this turn. Used to decide whether to give a unit rest healing.

* ''role'' used in standard unit filter ([[FilterWML]]). Can be set using [role] (see [[InternalActionsWML]]).

* ''ai_special'' causes the unit to act differently.
** "guardian" the unit will not move, except to attack something in the turn it moves (so, it only can move if an enemy unit gets within range of it).

* ''facing'' which way the unit is facing (this only affects how the unit is displayed).
** "normal" (default) unit is facing to the right.
** "reverse" unit is facing to the left.
** "sw" {{DevFeature}} unit is facing to the left (substitute of "reverse").

* ''profile'' {{DevFeature}} sets a default portrait image for this unit. If the unit type already has a portrait set, this is used instead for this unit.
** "unit_image" if given instead of a filename, uses the unit's base image as the portrait (in the same manner that unit types without portraits do by default).

* ''fade_in'' {{DevFeature}} fades the unit in, like when it's recruited/recalled.

* '''[status]''' the status of the unit. This affects different features of the unit, for example whether the unit loses health each turn. Default for all keys is 'off', but this can be changed by the scenario or by special abilities (see [[AbilitiesWML]]). The status of a unit is displayed on the Status Table; each status modification ''statusmod'' is represented by the image '''misc/statusmod.png'''.
** ''poisoned'' if 'on', the unit loses 8 HP each turn. See also ''heals'', ''cures'', [[AbilitiesWML]].
** ''slowed'' if 'on', the unit has 50% of its normal movement and -1 strike on each attack with strikes>1. When the controller of the unit's turn is over, ''slowed'' is set to 'off' {{DevFeature}} slow now halves damage instead of removing one strike
** ''stone'' if 'on', the unit cannot move, attack, or be attacked.
** ''ambush'' if 'on', the unit cannot be seen by opponents.

* '''[variables]''' a set of variables that will be stored when this unit is stored (See [store_unit], [[InternalActionsWML]]). The attribute '''variable'''='''value''' means that when the unit is stored in the array ''unit'', the variable ''unit''.variables.''variable'' will have the value ''value'' (See [[VariablesWML]]).

* '''[modifications]''' changes that have been made to the unit.
** '''[trait]''' a trait the unit has. Same format as [trait], [[UnitsWML]].
** '''[object]''' an object the unit has. Same format as [object], [[DirectActionsWML]].

* ''unit_description'' {{DevFeature}} overrides the unit type description for this unit.

== See Also ==

* [[UnitWML]]
* [[ReferenceWML]]

Credits

2005-11-27T05:35:17Z

Bruno: /* Developers */

In July 2003, '''David White''' released the first version of Wesnoth. Since then, many people have joined the project, contributing in very different ways.

== Developers ==
* Alfredo Beaumont (ziberpunk) - autotools
* András Salamon ([[User:Ott|ott]]) - general QA and bug fixing, subediting
* [mailto:dragonking_AT_o2.pl Bartek Waresiak] (Dragonking) - multiplayer balancing
* Benjamin Drieu - scenario designer
* Bram Ridder (Morloth) - editor improvements
* [[User:bruno|Bruno Wolff III]] - Campaign web interface, [[MainlineScenarios#The_Dark_Hordes|The Dark Hordes]] maintainer, bug fixing, minor coder
* Cédric Duval - coder, internationalization manager
* Crossbow/Miyo - administrator, release manager
* David Philippi (Torangan) - internationalization manager, wescamp
* [mailto:davidnwhite_AT_verizon.net David White] (Sirp) - founder, lead developer, scenario designer
* Francisco Muñoz (fmunoz) - artwork manager, original units, scenario designer
* Guillaume Melquiond (silene) -
* Hogne Håskjold (frame) - terrain designer
* [mailto:isaac_AT_sindominio.net Isaac Clerencia] - administrator, release manager
* [mailto:Crazy-Ivanovic_AT_gmx.net Nils Kneuper] (Ivanovic) - internationalization manager
* James Spencer (Shade) - scenario designer
* Jan Zvánovec (jaz) -
* John B. Messerly -
* [mailto:forcemaster_AT_gmx.net Jon Daniel] (forcemstr) -
* [mailto:jorda_AT_ettin.org Jordà Polo] (ettin) -
* Joseph Simmons (Turin) - scenario designer, graphics
* J.R. Blain (Cowboy) -
* [mailto:mcnabb_AT_gravity.psu.edu J.W.C. McNabb] (Darth Fool) - coder, graphics
* Justin Zaun (jzaun) - coder, scenario designer
* Kristoffer Erlandsson (erl) - help system
* Maksim Orlovich (SadEagle) -
* Mark Michelsen (skovbaer) - internationalization manager
* [mailto:philippe.plantier_AT_naema.org Philippe Plantier] ([[User:Ayin|Ayin]]) - several parts of the code, notably terrain graphics code
* Richard Kettering (Jetryl) - artwork coordinator, several graphics
* Richard S. (Noy) - multiplayer balancing
* [mailto:susanna.bjorverud_AT_telia.com Susanna Björverud] (sanna) - internationalization manager
* [mailto:ydirson_AT_altern.org Yann Dirson] - gettext support, tinygui
* Zas -

== Artists ==
* Aleksi - music coordinator
* Alex Jarocha-Ernst (Jormungandr) - portraits
* Andrew James Patterson (Kamahawk) - sprites
* antwerp - sprites
* Christophe Anjard - sprites
* Diego Brea (Cobretti) - sprites
* Eli Dupree (Elvish Pillager) - sprites
* Fredrik Lindroth - music
* Gareth Miller (Gafgarion) - sprites
* James Barton (Sangel) - sprites
* James Woo (Pickslide) - portraits
* Jason Lutes - portraits
* Jimmy Olsson (Azlan) - icons
* Johanna Manninen (lohari) - tiles
* John Muccigrosso (Eponymous Archon) - sprites
* John-Robert Funck (XJaPaN) - sprites
* Jonatan Alamà (tin) - logo
* Joseph Toscano (zhaymusic.com) - music
* J.W. Bjerk (Eleazar) - tiles
* Michael Gil de Muro (grp21) - portraits
* Neorice - sprites
* Pau Congost - music
* Pekka Aikio - tiles
* Peter Geinitz (Shadow) - sprites
* Robert Bolin (Zebulon) - tiles
* Slainte - sprites
* Stephen Stone - [graphics]
* Svetac - [graphics]

== Translators ==
* adson - hungarian translation
* İhsan Akın - turkish translation
* Alessio D'Ascanio (otaku) - italian translation
* Alexander Alexiou (Santi) - greek translation
* Alexander Kjäll (capitol) - swedish translation
* Alexandr Menovchicov - russian translation
* Alfredo Beaumont (ziberpunk) - basque translation
* Ambra Viviani Loos - brazilian portuguese translation
* Americo Iacovizzi (DarkAmex) - italian translation
* Anders K. Madsen (madsen) - danish translation
* András Salamon ([[User:Ott|ott]]) - afrikaans, english and hungarian translation
* Andre Schmidt (schmidta) - german translation
* Ankka - finnish translation
* Anton Tsigularov (Atilla) - bulgarian translation
* Arne Deprez - dutch translation
* Artur R. Czechowski - polish translation
* Aurélien Brevers (Breversa) - french translation
* Azamat Hackimov - russian translation
* Bartek Waresiak (Dragonking) - polish translation
* Beer (Eddi) - hungarian translation
* Benoit Astruc - french translation
* Bjarke Sørensen (basher) - danish translation
* Boris Stumm (quijote_) - german translation
* BOrsuk - polish translation
* Cédric Duval - french translation
* Carles Company (brrr) - catalan translation
* Celso Goya - brazilian portuguese translation
* Christoph Berg (chrber) - german translation
* Claus Aranha - brazilian portuguese translation
* crys0000 - italian translation
* Dan Rosàs Garcia (focks) - catalan translation
* Daniel López (Azazelo) - catalan translation
* DaringTremayne - french translation
* David Martínez Moreno - spanish translation
* David Nečas (Yeti) - czech translation
* dentro - hungarian translation
* Enes Akın (yekialem) - turkish translation
* Erik J. Mesoy (Circon) - norwegian translation
* Eugenio Favalli (ElvenProgrammer) - italian translation
* Federico Tomassetti - italian translation
* Flamma - spanish translation
* Franciso Muñoz (fmunoz) - spanish translation
* François Orieux - french translation
* Gabriel Rodríguez (Chewie) - spanish translation
* Georgi Dimitrov (oblak)- bulgarian translation
* Gerfried Fuchs (Alfie) - german translation
* Gilluin - hungarian translation
* Guillaume Duwelz-Rebert - french translation
* Guillaume Massart (Piou2fois) - french translation
* Guillaume Melquiond (silene) - french translation
* Hallvard Norheim Bø (Lysander) - norwegian translation
* Håvard Korsvoll - norwegian translation
* Ilya Kaznacheev - russian translation
* isazi - italian translation
* Iván Herrero (navitux) - spanish translator
* Jaka Kranjc (lynx) - slovenian translation
* Jan Greve (Jan) - german translation
* Jan-Heiner Laberenz (jan-heiner) - german translation
* Jean Privat (Tout) - french translation
* Jean-Luc Richard (Le Gnome) - french translation
* Jérémy Rosen (Boucman) - french translation
* Jesper Fuglsang Wolff (ulven) - danish translation
* Jonatan Alamà (tin) - catalan translation
* [mailto:jorda_AT_ettin.org Jordà Polo] (ettin) - catalan translation coordinator
* Jose Gordillo (kilder) - spanish and catalan translation
* Jose Manuel Gomez (joseg) - spanish translation
* Julien Moncel - french translation
* Julien Tailleur - french translation
* Julen Landa (genars) - basque translation
* Kai Ensenbach (Pingu) - german translation
* Kékkői László (BlackEvil) - hungarian translation
* Karol Nowak (grzywacz) - polish translation
* Katerina Sykioti - greek translation
* Kertész Csaba - hungarian translation
* Khiraly - hungarian translation
* kko - finnish translation
* Konstantinos Karasavvas - greek translation
* Kosif - turkish translation
* Kovács Dániel - hungarian translation
* krix - hungarian translation
* Lala - dutch translation
* Leo Danielson (Lugo Moll) - swedish translation
* Lim Choon Kiat - 林俊杰 - chinese translation
* Lukáš Faltýnek - czech translation
* Maarten Albrecht - dutch translation
* Mark Michelsen (skovbaer) - danish translation
* Mark Polo (mpolo) - latin translation
* Mark Recasens - catalan translation
* Mart Tõnso - estonian translation
* Martin Šín - czech translation
* Mathias Bundgaard Svensson (freaken) - danish translation
* Matias Parmala - finnish translation
* methinks - polish translation
* Michał Jedynak (Artanis) - polish translation
* Michel Loos - brazilian portuguese translation
* Mikel Olasagasti (Hey_neken) - basque translation
* Mintaka - czech translation
* Naoki Iimura - japanese translation
* Nico Oliver - afrikaans translation
* Nicolas Boudin (Blurgk) - french translation
* [mailto:Crazy-Ivanovic_AT_gmx.net Nils Kneuper] (Ivanovic) - german translation
* Nobuhito Okada - japanese translation
* Pau Rul·lan Ferragut - catalan translation
* Paweł Stradomski - polish translation
* Paweł Tomak - polish translation
* paxed - finnish translation
* Petr Kopač (Ferda) - czech translation
* Petr Kovár (Juans) - czech translation
* [mailto:philippe.plantier_AT_naema.org Philippe Plantier] ([[User:Ayin|Ayin]]) - french translation
* Pieter Vermeylen (Onne) - dutch translation
* Pınar Yanardağ (moonquelle) - turkish translation
* Renato Cunha - brazilian portuguese translation
* Roel Thijs (Roel) - dutch translation
* RokStar - italian translation
* Roman Tuchin (Sankt) - russian translation
* Rudolf Orság - czech translation
* Ruben Philipp Wickenhäuser (The Very Uhu) - german translation
* Sérgio de Miranda Costa - brazilian portuguese translation
* Selim Farsakoğlu - turkish translation
* Sofronius - czech translation
* Spiros, Giorgis - greek translation
* Srecko Toroman (FreeCraft) - serbian translation
* Stefan Bergström (tephlon) - swedish translation
* Stephan Grochtmann (Schattenstephan) - german translation
* [mailto:susanna.bjorverud_AT_telia.com Susanna Björverud] (sanna) - swedish translation
* Susanne Mesoy (Rarlgland) - norwegian translation
* Széll Tamás (TomJoad) - hungarian translation
* Tiago Souza (Salvador) - brazilian portuguese translation
* Tobe Deprez - dutch translation
* Vít Komárek - czech translation
* Vít Krčál - czech translation
* Viliam Bur - slovak translation
* wint3r - swedish translation
* [mailto:ydirson_AT_altern.org Yann Dirson] - french translation
* Yuji Matsumoto - japanese translation
* Zas - french translation

== Other Contributions ==
* Ben Anderman (crimson_penguin) - unit list
* Dacyn - scenario designer
* Cyril Bouthors (CyrilB) - debian packager, patron
* Darryl Dixon - packager
* edge - packager
* Francesco Gigli (Jaramir) - wiki, wesnoth.slack.it
* Frédéric Wagner
* Jay Hopping - packager
* Marcin Konicki (ahwayakchih) - BeOS packager
* Marcus Phillips (Sithrandel) - Mac OS X packager
* Mark Michelsen (skovbaer) - slackware packager
* Mike Quinones (Doc Paterson) - multiplayer maps
* Peter Groen (pg) - multiplayer maps
* Ruben Philipp Wickenhäuser (The Very Uhu) - multiplayer maps
* Tom Chance (telex4) - multiplayer maps, scenario balancing

{{Home}}

User:Bruno

2005-11-27T05:33:28Z

Bruno:

[http://wolff.to/bruno/ Bruno Wolff III]

* I have claimed responsibility for [[MainlineScenarios#The_Dark_Hordes|The Dark Hordes]] campaign.
* I have developed a web based [http://wolff.to/campaigns/list.html campaign download interface].
* I have been adding some features to the campaign server.
* I update documentation in the wiki as I see something that needs work.
* I am slowly learning the mainline code and c++ and have started doing some bug fixes and minor feature additions to the core program.

You can reach me via email at [mailto:bruno@wolff.to bruno@wolff.to].

CampaignServerWML

2005-11-19T20:09:22Z

Bruno: /* Changing the passphrase for a campaign */

= Campaign Server WML =

This page describes the WML commands exchanged between campaign download clients and a campaign server. Note that this WML is not used in the game engine. Note that this page describes functions of the 1.1 campaign server, because that is what is used by the official campaign server.

== Listing Available Campaigns ==

This request is used to retrieve a list of campaigns available on the server and some overview information about them.

* Request
** '''[request_campaign_list]'''
*** ''after'' - only select campaigns last updated after the indicated time. ''after'' is in seconds relative to either the time when the command is processed or the [http://wikipedia.org/wiki/Unix_epoch Unix epoch]. As an example, to select campaigns last updated after Mon Oct 10 21:42:41 2005 GMT, you could not specify a value for ''times_relative_to'' (to use the default of relative to the [http://wikipedia.org/wiki/Unix_epoch Unix epoch]) and specify ''after'' = "1128980561".
*** ''before'' - only select campaigns last updated before the indicated time. ''before'' is in seconds relative to either the time when the command is processed or the [http://wikipedia.org/wiki/Unix_epoch Unix epoch]. As an example, to select campaigns last updated over a day ago, you could specify ''times_relative_to'' = "now" and ''before'' = "-86400".
*** ''language'' - return information only about campaigns that appear to be translated into this language. These names will normally be posix locale names. Typically you will want to either use a two letter language code (e.g. "de") or a two letter language code followed by a two character region code (e.g. "pt_BR"). Note that "pt" will not match "pt_BR".
*** ''name'' - return information for this campaign. If the name is specified and not the empty string then only information about campaigns with matching names (unless something changes there will be at most one such campaign) will be returned.
*** ''times_relative_to'' - "now" means that ''before'' and ''after'' are in seconds relative to the time when the request is processed by the campaign server. Any other value, or if it is not set, indicates that ''before'' and ''after'' are in seconds relative to the [http://wikipedia.org/wiki/Unix_epoch Unix epoch].
* Response
** ''timestamp'' - what time the campaign server thought it was when this response was generated. You shouldn't count on this as a guaranty that no new campaigns will appear with previous update times. This could be used to detect significant clock skew or possibly used as an approximate time for how far you need to look back for updated campaigns.
** '''[campaigns]'''
*** '''[campaign]'''
**** ''author'' - author(s) of the campaign.
**** ''description'' - description of the campaign. For pre 1.0 campaigns this should also describe the playability.
**** ''downloads'' - the number times the campaign (including previous versions) has been downloaded directly from the campaign server.
**** ''filename'' - filename campaign is stored in (currently the same as ''name'').
**** ''icon'' - path to an image in the standard image directory for Wesnoth. This path must use forward slashes (/). It cannot refer to custom images included with the campaign. This image is displayed as an icon by the campaign client built into Wesnoth.
**** ''name'' - the name of the campaign. Note this is not the title and shouldn't have spaces in it.
**** ''size'' - the size of the campaign in bytes on the campaign server.
**** ''timestamp'' - when this version of the campaign was uploaded.
**** ''title'' - campaign title. This is not a translatable string.
**** ''version'' - version of the campaign. The recommended format is x.y.z where x, y and z are decimal strings. x should be 0 for campaigns that are not yet complete.
**** '''[translation]'''
***** ''language'' - a language that this campaign has appeared to have been at least partially translated into. The following hueristic is used when a campaign is uploaded to extract a list of languages. The list of directories in the uploaded campaign is recursively searched. If a directory named 'LC_MESSAGES' is found then the name of the object containing this '''[dir]''' (normally the parent directory, but could be the campaign name if someone did something silly) is added to the list of translations. Directories named "LC_MESSAGES" are not searched for further matches. The normal naming convention is to use Posix locale names. This will usually be a two letter language code (e.g. "de") or a two letter language code followed by a two letter region code (e.g. "pt_BR"). Since "en_US" is the base language, this language will not be listed as an available translation.

== Downloading a Campaign ==

This command is used to download a specified campaign from the campaign server.

* Request
** '''[request_campaign]'''
*** ''name'' - the name of the campaign. Note this is not the title and shouldn't have spaces in it.
* Response
** ''author'' - author(s) of the campaign.
** ''campaign_name'' - the name of the campaign. Note this is not the title and shouldn't have spaces in it.
** ''description'' - description of the campaign. For pre 1.0 campaigns this should also describe the playability.
** ''icon'' - path to an image in the standard image directory for Wesnoth. This path must use forward slashes (/). It cannot refer to custom images included with the campaign. This image is displayed as an icon by the campaign client built into Wesnoth.
** ''name'' - this field will always be empty. Client code would treat it as a directory name if it was not empty.
** ''passphrase'' - this is used to control updates to campaigns on the server. For existing campaigns, if the passphrase doesn't match the update will be rejected. You can't change the passphrase yourself. If you lose or need to change the passphrase you need to contact the server administrator.
** ''timestamp'' - the time the campaign was last uploaded to the campaign server. This is a decimal string containing the number of seconds since the unix epoch.
** ''title'' - the title of the campaign. This is not a translatable string.
** ''version'' - version of the campaign. The recommended format is x.y.z where x, y and z are decimal strings. x should be 0 for campaigns that are not yet complete.
** '''[file]'''
*** ''name'' - the name of the file. This does not include any path information.
*** ''contents'' - the content of the file (binary data). This data should have no zero bytes. A byte with the code of 1 is an escape byte. The next byte will be data, but its value should be reduced by 1. Normally only byte codes of 0 and 1 are escaped.
** '''[dir]'''
*** ''name'' - the name of the directory. This does not include any path information.
*** This tag may contain '''[file]''' or '''[dir]''' subtags (the latter are recursive).

== Uploading a Campaign ==

This command is used to upload a new or updated version of an add on campaign to the campaign server.

* Request
** '''[upload]'''
*** ''author'' - author(s) of the campaign.
*** ''description'' - description of the campaign. For pre 1.0 campaigns this should also describe the playability.
*** ''icon'' - path to an image in the standard image directory for Wesnoth. This path must use forward slashes (/). It cannot refer to custom images included with the campaign. This image is displayed as an icon by the campaign client built into Wesnoth.
*** ''name'' - the name of the campaign. Note this is not the title and shouldn't have spaces in it.
*** ''passphrase'' - this is used to control updates to campaigns on the server. For existing campaigns, if the passphrase doesn't match the update will be rejected. You can't change the passphrase yourself. If you lose or need to change the passphrase you need to contact the server administrator.
*** ''title'' - the title of the campaign. This is not a translatable string.
*** ''version'' - version of the campaign. The recommended format is x.y.z where x, y and z are decimal strings. x should be 0 for campaigns that are not yet complete.
*** '''[data]'''
**** '''[file]'''
***** ''name'' - the name of the file. This does not include any path information.
***** ''contents'' - the content of the file (binary data). This data should have no zero bytes. A byte with the code of 1 is an escape byte. The next byte will be data, but its value should be reduced by 1. Normally only byte codes of 0 and 1 are escaped.
**** '''[dir]'''
***** ''name'' - the name of the directory. This does not include any path information.
***** This tag may contain '''[file]''' or '''[dir]''' subtags (the latter are recursive).
* Response
** '''[message]'''
*** ''message'' - translatable string that indicates that the campaign upload was successful.

== Changing the Passphrase for a Campaign ==

This command is used to change the passphrase for a campaign. Currently the normal client doesn't have a way to use this. However, you can use the perl script campaign_passphrase.pl to do it, if you have a copy of the source tree.

* Request
** '''[change_passphrase]'''
*** ''name'' - The name of campaign.
*** ''passphrase'' - The old passphrase.
*** ''new_passphrase'' - The new passphrase.
* Respose
** '''[message]'''
*** ''message'' - Translatable string that says that the passphrase was changed.

== Deleting a Campaign ==

This command is used to delete an existing campaign from the campaign server.

* Request
** '''[delete]'''
*** ''name'' - The name of the campaign to delete.
*** ''passphrase'' - This must match the passphrase on record for the campaign in order for the campaign to be deleted.
* Response
** '''[message]'''
*** ''message'' - Translatable string that says that the campaign was deleted.

== Request License Information ==

Retrieve the terms of the license used for any uploaded campaigns. You may not upload a campaign if you don't (or can't) aggree to the license. Wesnoth requires campaigns (including images and sound) to be licensed under the GPL.

* Request
** '''[request_terms]'''
* Response
** '''[message]'''
*** ''message'' - translatable string containing the text of the license.

== See Also ==

* [[UserScenarios#Campaign_Server_Web_Access]]
* [[PblWML]]
* [[BuildingCampaignsThePBLFile]]

CampaignServerWML

2005-11-19T20:08:33Z

Bruno: /* Campaign Server WML */

= Campaign Server WML =

This page describes the WML commands exchanged between campaign download clients and a campaign server. Note that this WML is not used in the game engine. Note that this page describes functions of the 1.1 campaign server, because that is what is used by the official campaign server.

== Listing Available Campaigns ==

This request is used to retrieve a list of campaigns available on the server and some overview information about them.

* Request
** '''[request_campaign_list]'''
*** ''after'' - only select campaigns last updated after the indicated time. ''after'' is in seconds relative to either the time when the command is processed or the [http://wikipedia.org/wiki/Unix_epoch Unix epoch]. As an example, to select campaigns last updated after Mon Oct 10 21:42:41 2005 GMT, you could not specify a value for ''times_relative_to'' (to use the default of relative to the [http://wikipedia.org/wiki/Unix_epoch Unix epoch]) and specify ''after'' = "1128980561".
*** ''before'' - only select campaigns last updated before the indicated time. ''before'' is in seconds relative to either the time when the command is processed or the [http://wikipedia.org/wiki/Unix_epoch Unix epoch]. As an example, to select campaigns last updated over a day ago, you could specify ''times_relative_to'' = "now" and ''before'' = "-86400".
*** ''language'' - return information only about campaigns that appear to be translated into this language. These names will normally be posix locale names. Typically you will want to either use a two letter language code (e.g. "de") or a two letter language code followed by a two character region code (e.g. "pt_BR"). Note that "pt" will not match "pt_BR".
*** ''name'' - return information for this campaign. If the name is specified and not the empty string then only information about campaigns with matching names (unless something changes there will be at most one such campaign) will be returned.
*** ''times_relative_to'' - "now" means that ''before'' and ''after'' are in seconds relative to the time when the request is processed by the campaign server. Any other value, or if it is not set, indicates that ''before'' and ''after'' are in seconds relative to the [http://wikipedia.org/wiki/Unix_epoch Unix epoch].
* Response
** ''timestamp'' - what time the campaign server thought it was when this response was generated. You shouldn't count on this as a guaranty that no new campaigns will appear with previous update times. This could be used to detect significant clock skew or possibly used as an approximate time for how far you need to look back for updated campaigns.
** '''[campaigns]'''
*** '''[campaign]'''
**** ''author'' - author(s) of the campaign.
**** ''description'' - description of the campaign. For pre 1.0 campaigns this should also describe the playability.
**** ''downloads'' - the number times the campaign (including previous versions) has been downloaded directly from the campaign server.
**** ''filename'' - filename campaign is stored in (currently the same as ''name'').
**** ''icon'' - path to an image in the standard image directory for Wesnoth. This path must use forward slashes (/). It cannot refer to custom images included with the campaign. This image is displayed as an icon by the campaign client built into Wesnoth.
**** ''name'' - the name of the campaign. Note this is not the title and shouldn't have spaces in it.
**** ''size'' - the size of the campaign in bytes on the campaign server.
**** ''timestamp'' - when this version of the campaign was uploaded.
**** ''title'' - campaign title. This is not a translatable string.
**** ''version'' - version of the campaign. The recommended format is x.y.z where x, y and z are decimal strings. x should be 0 for campaigns that are not yet complete.
**** '''[translation]'''
***** ''language'' - a language that this campaign has appeared to have been at least partially translated into. The following hueristic is used when a campaign is uploaded to extract a list of languages. The list of directories in the uploaded campaign is recursively searched. If a directory named 'LC_MESSAGES' is found then the name of the object containing this '''[dir]''' (normally the parent directory, but could be the campaign name if someone did something silly) is added to the list of translations. Directories named "LC_MESSAGES" are not searched for further matches. The normal naming convention is to use Posix locale names. This will usually be a two letter language code (e.g. "de") or a two letter language code followed by a two letter region code (e.g. "pt_BR"). Since "en_US" is the base language, this language will not be listed as an available translation.

== Downloading a Campaign ==

This command is used to download a specified campaign from the campaign server.

* Request
** '''[request_campaign]'''
*** ''name'' - the name of the campaign. Note this is not the title and shouldn't have spaces in it.
* Response
** ''author'' - author(s) of the campaign.
** ''campaign_name'' - the name of the campaign. Note this is not the title and shouldn't have spaces in it.
** ''description'' - description of the campaign. For pre 1.0 campaigns this should also describe the playability.
** ''icon'' - path to an image in the standard image directory for Wesnoth. This path must use forward slashes (/). It cannot refer to custom images included with the campaign. This image is displayed as an icon by the campaign client built into Wesnoth.
** ''name'' - this field will always be empty. Client code would treat it as a directory name if it was not empty.
** ''passphrase'' - this is used to control updates to campaigns on the server. For existing campaigns, if the passphrase doesn't match the update will be rejected. You can't change the passphrase yourself. If you lose or need to change the passphrase you need to contact the server administrator.
** ''timestamp'' - the time the campaign was last uploaded to the campaign server. This is a decimal string containing the number of seconds since the unix epoch.
** ''title'' - the title of the campaign. This is not a translatable string.
** ''version'' - version of the campaign. The recommended format is x.y.z where x, y and z are decimal strings. x should be 0 for campaigns that are not yet complete.
** '''[file]'''
*** ''name'' - the name of the file. This does not include any path information.
*** ''contents'' - the content of the file (binary data). This data should have no zero bytes. A byte with the code of 1 is an escape byte. The next byte will be data, but its value should be reduced by 1. Normally only byte codes of 0 and 1 are escaped.
** '''[dir]'''
*** ''name'' - the name of the directory. This does not include any path information.
*** This tag may contain '''[file]''' or '''[dir]''' subtags (the latter are recursive).

== Uploading a Campaign ==

This command is used to upload a new or updated version of an add on campaign to the campaign server.

* Request
** '''[upload]'''
*** ''author'' - author(s) of the campaign.
*** ''description'' - description of the campaign. For pre 1.0 campaigns this should also describe the playability.
*** ''icon'' - path to an image in the standard image directory for Wesnoth. This path must use forward slashes (/). It cannot refer to custom images included with the campaign. This image is displayed as an icon by the campaign client built into Wesnoth.
*** ''name'' - the name of the campaign. Note this is not the title and shouldn't have spaces in it.
*** ''passphrase'' - this is used to control updates to campaigns on the server. For existing campaigns, if the passphrase doesn't match the update will be rejected. You can't change the passphrase yourself. If you lose or need to change the passphrase you need to contact the server administrator.
*** ''title'' - the title of the campaign. This is not a translatable string.
*** ''version'' - version of the campaign. The recommended format is x.y.z where x, y and z are decimal strings. x should be 0 for campaigns that are not yet complete.
*** '''[data]'''
**** '''[file]'''
***** ''name'' - the name of the file. This does not include any path information.
***** ''contents'' - the content of the file (binary data). This data should have no zero bytes. A byte with the code of 1 is an escape byte. The next byte will be data, but its value should be reduced by 1. Normally only byte codes of 0 and 1 are escaped.
**** '''[dir]'''
***** ''name'' - the name of the directory. This does not include any path information.
***** This tag may contain '''[file]''' or '''[dir]''' subtags (the latter are recursive).
* Response
** '''[message]'''
*** ''message'' - translatable string that indicates that the campaign upload was successful.

== Changing the passphrase for a campaign ==

This command is used to change the passphrase for a campaign. Currently the normal client doesn't have a way to use this. However, you can use the perl script campaign_passphrase.pl to do it, if you have a copy of the source tree.

* Request
** '''[change_pasphrase]'''
*** ''name'' - The name of campaign.
*** ''passphrase'' - The old passphrase.
*** ''new_passphrase'' - The new passphrase.
* Respose
** '''[message]'''
*** ''message'' - Translatable string that says that the passphrase was changed.

== Deleting a Campaign ==

This command is used to delete an existing campaign from the campaign server.

* Request
** '''[delete]'''
*** ''name'' - The name of the campaign to delete.
*** ''passphrase'' - This must match the passphrase on record for the campaign in order for the campaign to be deleted.
* Response
** '''[message]'''
*** ''message'' - Translatable string that says that the campaign was deleted.

== Request License Information ==

Retrieve the terms of the license used for any uploaded campaigns. You may not upload a campaign if you don't (or can't) aggree to the license. Wesnoth requires campaigns (including images and sound) to be licensed under the GPL.

* Request
** '''[request_terms]'''
* Response
** '''[message]'''
*** ''message'' - translatable string containing the text of the license.

== See Also ==

* [[UserScenarios#Campaign_Server_Web_Access]]
* [[PblWML]]
* [[BuildingCampaignsThePBLFile]]

ReferenceWML

2005-11-19T19:56:57Z

Bruno: /* Other */

== The Wesnoth Markup Language ==

The Wesnoth Markup Language (WML) is used to code almost everything in Wesnoth,
including scenarios, units, savefiles, and the user interface layout.

This page is a collection of pointers to different common WML structures. See [[AlphabeticalWML]] for a quick listing of
all WML tags. The more
comprehensive [[BuildingScenariosIndex]] lists tags and keys.

See [[BuildingScenarios]], [[BuildingCampaigns]], [[BuildingUnits]]and [[CreatingNewUnits]]
for a tutorial style overview.

== How WML works ==

* [[PreprocessorRef]] the WML preprocessor syntax
** [[UtilWML]] utility macros defined in utils.cfg
* [[SyntaxWML]] the language syntax.
** [[VariablesWML]] how to use WML variables

== WML toplevel tags ==

* [[GameConfigWML]] the top level [game_config] tag
* [[UnitsWML]] the top level [units] tag
** [[UnitWML]] how to describe a unit type
** [[AnimationWML]] how to animate units
* [[CampaignWML]] the top level [campaign] tag
* [[ScenarioWML]] the top level tags [scenario], [multiplayer], [test], and [tutorial]
** [[EventWML]] how to describe an event
** [[SideWML]] how to describe a side
** [[MapGeneratorWML]] the random map generator
** [[TimeWML]] how to describe a day
** [[IntroWML]] how to describe the intro screen
* [[SavefileWML]] a description of the format of savegames
** [[ReplayWML]] a description of the format of player actions such as moving a unit.
** [[StatisticalScenarioWML]] used to generate statistics of a savegame
* [[PblWML]] a description of the format of server-uploadable campaigns
* [[EraWML]] the top level [era] tag
* [[TerrainWML]] the top level [terrain] tag
* [[TerrainGraphicsWML]], the top level [terrain_graphics] tag
* [[ThemeWML]] the top level [theme] tag
* [[LanguageWML]] the top level [language] tag
* [[HelpWML]] the top level [help] tag
* [[BinaryPathWML]] the top level [binary_path] tag
* [[FontsWML]] the top level [fonts] tag

== Other WML tags ==

* [[EventWML]] how to describe an event
** [[FilterWML]] the construct to filter on units, locations, and weapons
** [[DirectActionsWML]] actions that directly affect gameplay: for example creating a unit
** [[InternalActionsWML]] actions that WML uses internally: for example storing a variable
** [[InterfaceActionsWML]] actions that do not affect gameplay: for example displaying a message
* [[SingleUnitWML]] how to describe a unit
* [[AiWML]] how to describe parameters for AI
* [[EffectWML]] the construct to modify a unit
* [[AbilitiesWML]] a list of the different abilities a unit or weapon can have
* [[DescriptionWML]] the structure of WML coded menus like the difficulty chooser of campaigns

== Other ==

* [[ReferenceWMLSyntax]] how this wiki and the pages it links to should be formatted
* [[ConventionsWML]] how to make your WML more readable
* [[UsefulWMLFragments]] Various pieces of WML for various purposes. If you have some WML you're proud of that you think others can use, add it here.
* [[CommandMode]] commands are not strictly speaking part of WML, these could be a little hard to find so there's a link here.
* [[CampaignServerWML]] is used when managing contributed campaigns on the campaign server.

== See Also ==

* [[BuildingMaps]] the text-based format for Wesnoth maps
* [[TerrainLettersWML]] a list of all terrains
* [[MultiHexTutorial]] a description of the multi-hex tiling system

ReplayWML

2005-11-19T12:08:51Z

Bruno: /* The [command] tag */

== The [command] tag ==

The '''[command]''' tag is used to specify an action in a replay.

The following tags are recognized:
* '''[start]''' is used to initialize the replay so that generated random numbers can be saved.
* '''[move]''' the player moved a unit.
** '''[source]''' the location the unit moved to.
** '''[destination]''' the location the unit moved from.
* '''[recruit]''' the player recruited a unit.
** ''value'' the index number of the recruited unit. (Index numbers start at 0 and include all recruitable units in alphabetical order.)
** ''x'' and ''y'' the castle tile the unit is recruited on.
* '''[recall]''' the player recalled a unit. Same keys as [recruit], except that the index is in order of level, followed by required XP to advance.
* '''[attack]''' the player attacked.
** ''weapon'' the index number of the weapon. Weapons are indexed by the unit designer.
** '''[source]''' the location of the attacking unit.
** '''[destination]''' the location of the defending unit.
* '''[end_turn]''' the player ended his turn.
* '''[choose]''' the player was given an option by the scenario.
** ''value'' the index number of the option chosen. Index numbers are given by the scenario designer.
* '''[random]''' if the action required a random number, this describes the random number that was generated. In 1.0.x, nested '''[random]''' tags are used and only one is allowed at this level. In 1.1.x, a '''[random]''' tag is used at this level for each value.
** ''value'' list of generated random values. In 1.1.x only a single value can be used.
** '''[results]''' used for '''[attack]''' commands. Describes the results of the battle.
*** ''chance'' the percent chance that the attack had to hit.
*** ''damage'' the amount of damage that the attack would do if it hits.
*** ''dies'' whether the defender dies from the hit.
*** ''hits'' whether the attack hits.
** '''[random]''' additional lists of generated random values. '''[random]''' has the same format as the first '''[random]''' and describes the other numbers that were generated. In 1.1.x, '''[random]''' tags at this level are not used.

== See Also ==
* [[SavefileWML]]
* [[ReferenceWML]]

ReplayWML

2005-11-13T08:26:16Z

Bruno: /* The [command] tag */

== The [command] tag ==

The '''[command]''' tag is used to specify an action in a replay.

The following tags are recognized:
* '''[start]''' is used to initialize the replay so that generated random numbers can be saved.
* '''[move]''' the player moved a unit.
** '''[source]''' the location the unit moved to.
** '''[destination]''' the location the unit moved from.
* '''[recruit]''' the player recruited a unit.
** ''value'' the index number of the recruited unit. (Index numbers start at 0 and include all recruitable units in alphabetical order.)
** ''x'' and ''y'' the castle tile the unit is recruited on.
* '''[recall]''' the player recalled a unit. Same keys as [recruit], except that the index is in order of level, followed by required XP to advance.
* '''[attack]''' the player attacked.
** ''weapon'' the index number of the weapon. Weapons are indexed by the unit designer.
** '''[source]''' the location of the attacking unit.
** '''[destination]''' the location of the defending unit.
* '''[end_turn]''' the player ended his turn.
* '''[choose]''' the player was given an option by the scenario.
** ''value'' the index number of the option chosen. Index numbers are given by the scenario designer.
* '''[break]''' is used to break up deep nesting of generated random numbers. The '''[break]''' tag is not used in 1.1.x.
* '''[random]''' if the action required a random number, this describes the random number that was generated. In 1.0.x, nested '''[random]''' tags are used and only one is allowed at this level. In 1.1.x, a '''[random]''' tag is used at this level for each value.
** ''value'' list of generated random values. In 1.1.x only a single value can be used.
** '''[results]''' used for '''[attack]''' commands. Describes the results of the battle.
*** ''chance'' the percent chance that the attack had to hit.
*** ''damage'' the amount of damage that the attack would do if it hits.
*** ''dies'' whether the defender dies from the hit.
*** ''hits'' whether the attack hits.
** '''[random]''' additional lists of generated random values. '''[random]''' has the same format as the first '''[random]''' and describes the other numbers that were generated. In 1.1.x, '''[random]''' tags at this level are not used.

== See Also ==
* [[SavefileWML]]
* [[ReferenceWML]]

ReplayWML

2005-11-13T08:24:59Z

Bruno: /* The [command] tag */

== The [command] tag ==

The '''[command]''' tag is used to specify an action in a replay.

The following tags are recognized:
* '''[start]''' is used to initialize the replay so that generated random numbers can be saved.
* '''[move]''' the player moved a unit.
** '''[source]''' the location the unit moved to.
** '''[destination]''' the location the unit moved from.
* '''[recruit]''' the player recruited a unit.
** ''value'' the index number of the recruited unit. (Index numbers start at 0 and include all recruitable units in alphabetical order.)
** ''x'' and ''y'' the castle tile the unit is recruited on.
* '''[recall]''' the player recalled a unit. Same keys as [recruit], except that the index is in order of level, followed by required XP to advance.
* '''[attack]''' the player attacked.
** ''weapon'' the index number of the weapon. Weapons are indexed by the unit designer.
** '''[source]''' the location of the attacking unit.
** '''[destination]''' the location of the defending unit.
* '''[end_turn]''' the player ended his turn.
* '''[choose]''' the player was given an option by the scenario.
** ''value'' the index number of the option chosen. Index numbers are given by the scenario designer.
* '''[break]''' is used to break up deep nesting of generated random numbers. The '''[break]''' tag is not used in 1.1.x.
* '''[random]''' if the action required a random number, this describes the random number that was generated. In 1.0.x, nested [random] tags are used and only one is allowed at this level. In 1.1.x, a '''[random]''' tag is used at this level for each value.
** ''value'' list of generated random values. In 1.1.x only a single value can be used.
** '''[results]''' used for [attack] commands. Describes the results of the battle.
*** ''chance'' the percent chance that the attack had to hit.
*** ''damage'' the amount of damage that the attack would do if it hits.
*** ''dies'' whether the defender dies from the hit.
*** ''hits'' whether the attack hits.
** '''[random]''' additional lists of generated random values. '''[random]''' has the same format as the first '''[random]''' and describes the other numbers that were generated. In 1.1.x, '''[random]''' tags at this level are not used.

== See Also ==
* [[SavefileWML]]
* [[ReferenceWML]]

AbilitiesWML

2005-11-12T22:25:28Z

Bruno:

== Abilities and their effects ==

There are two types of abilities: ones that apply to units (called ''abilities'') and weapon-based (called
''specials''). A unit may have multiple abilities,
but each attack can only have at most one special.

== Normal abilities ==
* 'heals' unit will heal ''healer_heals_per_turn'' (see [[GameConfigWML]]) hp to all neighbours, up to a total of ''heal_amount''. If a neighbour is poisoned, it will prevent the poison's effect instead of healing.
* 'cures' unit will heal ''curer_heals_per_turn'' (see [[GameConfigWML]]) hp to all neighbours, up to a total of ''cure_amount''. If a neighbour is poisoned, it will cure the poison instead of healing.
* 'regenerates' the unit will heal itself 8 hp per turn. If it is poisoned, it will remove the poison instead of healing.
* 'leadership' the unit will increase the damage of all neighbouring units by +25% per level difference. (If the neighbouring unit is of a higher level, this effect is negated.)
* 'illuminates' all neighbouring hex will be "illuminated", in other words have a different time of day (See [[TimeWML]]). Typically, this will be one step brighter.
* 'teleport' the unit can move between any two allied villages for one move point
* 'skirmisher' the unit ignores zone of control when moving, but still cannot move directly through an enemy unit
* 'steadfast' the unit takes half normal damage when it did not initiate the attack.
* 'ambush' the unit becomes invisible on forest. Invisible units cannot be seen by enemies and do not possess zone of control, although if an enemy moves next to one, it becomes visible again.
* 'nightstalk' the unit becomes invisible during night.

== Attack specials ==
* 'charge' when attacking, both this weapon and defender get double damage.
* 'poison' when this weapon hits, the defender becomes poisoned (see [status], [[SingleUnitWML]]).
* 'slow' when this weapon hits, the defender becomes slowed (see [status], [[SingleUnitWML]]).
* 'stones' when this weapon hits, the defender turns to stone (see [status], [[SingleUnitWML]]).
* 'magical' this weapon always has a 70% chance of hitting.
* 'marksman' when attacking, this weapon has a minimum of 60% chance of hitting.
* 'drain' The controller of this weapon gains health equal to half the damage done (rounded down) whenever this attack hits.
* 'plague' The controller of this weapon is copied onto the tile that any unit this attack killed was on.
* 'backstab' doubles damage whenever there is a unit on the opposite side (location) of the defending unit that distracts it. In 1.0.x the distracting unit must be on the same side (player) as the attacker. In 1.1.x the distracting unit must be an enemy of the defending unit and not incapacitated (e.g. turned to stone).
* 'firststrike' when this weapon is used to defend, the battle proceeds as if it were the attacker (i.e. it attacks first).
* 'berserk' forces the combat to continue until either the attacker or the defender is killed.

== See Also ==

* [[UnitWML]]
* [[SingleUnitWML]]
* [[ReferenceWML]]

AbilitiesWML

2005-11-12T22:21:18Z

Bruno: /* Normal abilities */

== Abilities and their effects ==

There are two types of abilities: ones that apply to units (called ''abilities'') and weapon-based (called
''specials''). A unit may have multiple abilities,
but each attack can only have at most one special.

== Normal abilities ==
* ''heals'' unit will heal ''healer_heals_per_turn'' (see [[GameConfigWML]]) hp to all neighbours, up to a total of ''heal_amount''. If a neighbour is poisoned, it will prevent the poison's effect instead of healing.
* ''cures'' unit will heal ''curer_heals_per_turn'' (see [[GameConfigWML]]) hp to all neighbours, up to a total of ''cure_amount''. If a neighbour is poisoned, it will cure the poison instead of healing.
* ''regenerates'' the unit will heal itself 8 hp per turn. If it is poisoned, it will remove the poison instead of healing.
* ''leadership'' the unit will increase the damage of all neighbouring units by +25% per level difference. (If the neighbouring unit is of a higher level, this effect is negated.)
* ''illuminates'' all neighbouring hex will be "illuminated", in other words have a different time of day (See [[TimeWML]]). Typically, this will be one step brighter.
* ''teleport'' the unit can move between any two allied villages for one move point
* ''skirmisher'' the unit ignores zone of control when moving, but still cannot move directly through an enemy unit
* ''steadfast'' the unit takes half normal damage when it did not initiate the attack.
* ''ambush'' the unit becomes invisible on forest. Invisible units cannot be seen by enemies and do not possess zone of control, although if an enemy moves next to one, it becomes visible again.
* ''nightstalk'' the unit becomes invisible during night.

== Attack specials ==
* ''charge'' when attacking, both this weapon and defender get double damage.
* ''poison'' when this weapon hits, the defender becomes poisoned (see [status], [[SingleUnitWML]]).
* ''slow'' when this weapon hits, the defender becomes slowed (see [status], [[SingleUnitWML]]).
* ''stones'' when this weapon hits, the defender turns to stone (see [status], [[SingleUnitWML]]).
* ''magical'' this weapon always has a 70% chance of hitting.
* ''marksman'' when attacking, this weapon has a minimum of 60% chance of hitting.
* ''drain'' The controller of this weapon gains health equal to half the damage done (rounded down) whenever this attack hits.
* ''plague'' The controller of this weapon is copied onto the tile that any unit this attack killed was on.
* ''backstab'' doubles damage whenever there is a unit on the opposite side (location) of the defending unit that distracts it. In 1.0.x the distracting unit must be on the same side (player) as the attacker. In 1.1.x the distracting unit must be an enemy of the defending unit and not incapacitated (e.g. turned to stone).
* ''firststrike'' when this weapon is used to defend, the battle proceeds as if it were the attacker (i.e. it attacks first).
* ''berserk'' forces the combat to continue until either the attacker or the defender is killed.

== See Also ==

* [[UnitWML]]
* [[SingleUnitWML]]
* [[ReferenceWML]]

AbilitiesWML

2005-11-12T22:18:20Z

Bruno: /* Attack specials */

== Abilities and their effects ==

There are two types of abilities: ones that apply to units (called ''abilities'') and weapon-based (called
''specials''). A unit may have multiple abilities,
but each attack can only have at most one special.

== Normal abilities ==
* 'heals' unit will heal ''healer_heals_per_turn'' (see [[GameConfigWML]]) hp to all neighbours, up to a total of
''heal_amount''.
If a neighbour is poisoned, it will prevent the poison's effect instead of healing.
* 'cures' unit will heal ''curer_heals_per_turn'' (see [[GameConfigWML]]) hp to all neighbours, up to a total of
''cure_amount''.
If a neighbour is poisoned, it will cure the poison instead of healing.
* 'regenerates' the unit will heal itself 8 hp per turn.
If it is poisoned, it will remove the poison instead of healing.
* 'leadership' the unit will increase the damage of all neighbouring units by +25% per level difference.
(if the neighbouring unit is of a higher level, this effect is negated).
* 'illuminates' all neighbouring hex will be "illuminated", in other words have a different time of day (See [[TimeWML]])
* 'teleport' the unit can move between any two allied villages for one move point
* 'skirmisher' the unit ignores zone of control when moving, but still cannot move directly through an enemy unit
* 'steadfast' the unit takes half normal damage when it did not initiate the attack.
* 'ambush' the unit becomes invisible on forest. Invisible units cannot be seen by enemies and do not possess zone of
control, although if an enemy moves
next to one, it becomes visible again.
* 'nightstalk' the unit becomes invisible during night.

== Attack specials ==
* ''charge'' when attacking, both this weapon and defender get double damage.
* ''poison'' when this weapon hits, the defender becomes poisoned (see [status], [[SingleUnitWML]]).
* ''slow'' when this weapon hits, the defender becomes slowed (see [status], [[SingleUnitWML]]).
* ''stones'' when this weapon hits, the defender turns to stone (see [status], [[SingleUnitWML]]).
* ''magical'' this weapon always has a 70% chance of hitting.
* ''marksman'' when attacking, this weapon has a minimum of 60% chance of hitting.
* ''drain'' The controller of this weapon gains health equal to half the damage done (rounded down) whenever this attack hits.
* ''plague'' The controller of this weapon is copied onto the tile that any unit this attack killed was on.
* ''backstab'' doubles damage whenever there is a unit on the opposite side (location) of the defending unit that distracts it. In 1.0.x the distracting unit must be on the same side (player) as the attacker. In 1.1.x the distracting unit must be an enemy of the defending unit and not incapacitated (e.g. turned to stone).
* ''firststrike'' when this weapon is used to defend, the battle proceeds as if it were the attacker (i.e. it attacks first).
* ''berserk'' forces the combat to continue until either the attacker or the defender is killed.

== See Also ==

* [[UnitWML]]
* [[SingleUnitWML]]
* [[ReferenceWML]]

AbilitiesWML

2005-11-12T22:15:08Z

Bruno: /* Attack specials */

== Abilities and their effects ==

There are two types of abilities: ones that apply to units (called ''abilities'') and weapon-based (called
''specials''). A unit may have multiple abilities,
but each attack can only have at most one special.

== Normal abilities ==
* 'heals' unit will heal ''healer_heals_per_turn'' (see [[GameConfigWML]]) hp to all neighbours, up to a total of
''heal_amount''.
If a neighbour is poisoned, it will prevent the poison's effect instead of healing.
* 'cures' unit will heal ''curer_heals_per_turn'' (see [[GameConfigWML]]) hp to all neighbours, up to a total of
''cure_amount''.
If a neighbour is poisoned, it will cure the poison instead of healing.
* 'regenerates' the unit will heal itself 8 hp per turn.
If it is poisoned, it will remove the poison instead of healing.
* 'leadership' the unit will increase the damage of all neighbouring units by +25% per level difference.
(if the neighbouring unit is of a higher level, this effect is negated).
* 'illuminates' all neighbouring hex will be "illuminated", in other words have a different time of day (See [[TimeWML]])
* 'teleport' the unit can move between any two allied villages for one move point
* 'skirmisher' the unit ignores zone of control when moving, but still cannot move directly through an enemy unit
* 'steadfast' the unit takes half normal damage when it did not initiate the attack.
* 'ambush' the unit becomes invisible on forest. Invisible units cannot be seen by enemies and do not possess zone of
control, although if an enemy moves
next to one, it becomes visible again.
* 'nightstalk' the unit becomes invisible during night.

== Attack specials ==
* 'charge' when attacking, both this weapon and defender get double damage.
* 'poison' when this weapon hits, the defender becomes poisoned (see [status], [[SingleUnitWML]]).
* 'slow' when this weapon hits, the defender becomes slowed (see [status], [[SingleUnitWML]]).
* 'stones' when this weapon hits, the defender turns to stone (see [status], [[SingleUnitWML]]).
* 'magical' this weapon always has a 70% chance of hitting.
* 'marksman' when attacking, this weapon has a minimum of 60% chance of hitting.
* 'drain' The controller of this weapon gains health equal to half the damage done (rounded down) whenever this attack hits.
* 'plague' The controller of this weapon is copied onto the tile that any unit this attack killed was on.
* 'backstab' Whenever there is a unit on the opposite side (position) of the defending unit that distracts it then this weapon does double damage. In 1.0.x the distracting unit must be on the same side as the attacker. In 1.1.x the distracting unit must be an enemy of the defending unit and not incapacitated (e.g. turned to stone).
* 'firststrike' when this weapon is used to defend, the battle proceeds as if it were the attacker (i.e. it attacks first).
* 'berserk' Forces the combat to continue until either the attacker or the defender is killed.

== See Also ==

* [[UnitWML]]
* [[SingleUnitWML]]
* [[ReferenceWML]]

ReplayWML

2005-11-12T21:48:38Z

Bruno: /* the [command] tag */

== The [command] tag ==

The '''[command]''' tag is used to specify an action in a replay.

The following tags are recognized:
* '''[start]''' is used to initialize the replay so that generated random numbers can be saved.
* '''[move]''' the player moved a unit.
** '''[source]''' the location the unit moved to.
** '''[destination]''' the location the unit moved from.
* '''[recruit]''' the player recruited a unit.
** ''value'' the index number of the recruited unit. (Index numbers start at 0 and include all recruitable units in alphabetical order.)
** ''x'' and ''y'' the castle tile the unit is recruited on.
* '''[recall]''' the player recalled a unit. Same keys as [recruit], except that the index is in order of level, followed by required XP to advance.
* '''[attack]''' the player attacked.
** ''weapon'' the index number of the weapon. Weapons are indexed by the unit designer.
** '''[source]''' the location of the attacking unit.
** '''[destination]''' the location of the defending unit.
* '''[end_turn]''' the player ended his turn.
* '''[choose]''' the player was given an option by the scenario.
** ''value'' the index number of the option chosen. Index numbers are given by the scenario designer.
* '''[break]''' is used to break up deep nesting of generated random numbers.
* '''[random]''' if the action required a random number, this describes the random number that was generated.
** ''value'' list of generated random values.
** '''[results]''' used for [attack] commands. Describes the results of the battle.
*** ''chance'' the percent chance that the attack had to hit.
*** ''damage'' the amount of damage that the attack would do if it hits.
*** ''dies'' whether the defender dies from the hit.
*** ''hits'' whether the attack hits.
** '''[random]''' additional lists of generated random values. '''[random]''' has the same format as the first '''[random]''' and describes the other numbers that were generated.

== See Also ==
* [[SavefileWML]]
* [[ReferenceWML]]