The Battle for Wesnoth Wiki - User contributions [en]

MultiplayerContent

2007-02-21T02:07:10Z

NeoPhile: /* Scenarios */

== Building multiplayer campaigns ==

Both the stable and development versions of wesnoth have basic support for campaigns that can be played in multiplayer mode, with your friends, or even with an AI. Since version 1.1.8, more features and support have been added so we recommend a versions 1.1.8+. There will still be some things that don't work as expected as multiplayer campaigns are an area for exploration. While you can and should test your work in hotseat mode, there are a number of things that might behave differently under real network conditions (mostly affecting scenario and side parameters). Keep this in mind and make sure to test your campaign over the net, too.
This page only documents the differences between writing multiplayer campaigns and single player campaigns, so you might want to read up on [[BuildingCampaigns]] and [[BuildingMultiplayer]] first.

=== The campaign file ===

Multiplayer campaigns do not use the [campaign] tag. As a result of this, multiplayer campaigns only support one difficulty level, though you could support more with enough WML, if you're feeling ambitious. The "campaign file" should look something like this:

#ifdef MULTIPLAYER
{@campaigns/My_Campaign/scenarios}
#endif

Anything that you would normally put in the campaign tag now goes into the first scenario, if it's supported there. The order of scenarios is determined by next_scenario tags, just like in single player.

=== Scenarios ===

A scenario in a multiplayer campaign is almost identical to a scenario in a single player campaign. You only need to change the following:

* The [scenario] tag should be replaced with a [multiplayer] tag.
* The '''next_scenario''' key points to the id of the next scenario.
* Every scenario after the first should have '''allow_new_game=no''' inside the [multiplayer] tag. This will prevent it from showing up in the map selection menu. ''This does not work in v1.1'', but it causes no harm, and it will work in the future.
* In v1.1, every scenario in the campaign will appear on the map selection menu, so be sure to include your campaign's name in the [multiplayer] tag's name key. Alternatively, include a warning like "DO NOT PLAY".
* Each human-controlled side needs to have a '''controller=human''' key defined in their [side] tag to work in network mode.
* Each human-controlled side also needs to have a '''save_id''' defined inside their [side] tag. Each side's save_id should be unique, and it should be the same in every scenario. Without this, your recall lists and leaders will not carry over from one scenario to the next.
* Each AI-controlled side should have '''allow_player=no''' in their [side] tag.
* The [story] tag will only display for the first player (or maybe it's the host player). You'll have to use [message] tags in the start event if you want everyone to read the story.
* If you have a file containing macros, it must be referenced by every scenario, since there is no proper campaign file to include it from.

=== The first scenario ===

The first scenario might need some extra work, because the settings from the multiplayer dialog will override the settings in the scenario. However, most of the multiplayer settings can be overridden in the prestart event.

Use a macro like this to force a side to have a particular type of leader.
#define MP_SIDE SIDENO TYPE DESC
[store_unit]
variable=oldunit
kill=yes
[filter]
side={SIDENO}
[/filter]
[/store_unit]

[unit]
type={TYPE}
description={DESC}
unrenameable=yes
side={SIDENO}
x,y=$oldunit.x,$oldunit.y
canrecruit=1
[/unit]

[clear_variable]
name=oldunit
[/clear_variable]
#enddef

Other useful tags include [set_recruit], [modify_side], [modify_turns] and [remove_shroud]. There is currently no way to remove fog. You might also want to use ''experience_modifier=100'' in the [multiplayer] tag.

=== Custom units ===

Since there is no [campaign] tag, there is no natural way to include custom units in a multiplayer campaign. However, there are two workarounds. One way is to use [[EffectWML]] or [store_unit] to modify a mainline unit. The other way is to make your custom units available via an [[EraWML|era]], or by dropping them into ~wesnoth/data/units. If you go this route, using an era is better, because you can keep the units in your campaign directory.

== See Also ==

* [http://www.wesnoth.org/forum/viewtopic.php?t=11349 Multiplayer Campaigns HOWTO forum post]
* [[BuildingScenarios]]
* [[BuildingMultiplayer]]

CodingStandards

2007-01-25T19:05:50Z

NeoPhile: /* Do not use sprintf */ spelling

Wesnoth uses modern/advanced C++ that is portable to Visual C++ 6 and GNU G++ 3.0+

== End Non-Public Members of Classes with an Underscore ==

All non-public data members of classes should have their names terminated with an underscore, to show that they are a
class member. This makes for more readable code, once one is familiar with the convention.

== Use References when a value may not be NULL ==

If a value passed to a function can never be NULL, use a reference instead of a pointer. I.e.

void myfunction(Object& obj);

rather than

void myfunction(Object* obj);

This more clearly shows the user of the function that obj may never be NULL, without them having to consult
documentation or the implementation of the function.

== Use Const ==

The 'const' feature of C++ allows interfaces to more clearly specify how they treat objects. Always use const when you
are not going to modify an object.

I.e.

void myfunction(const Object& obj);

demonstrates to the caller of myfunction() that obj will not be modified. If myfunction may modify obj, then use

void myfunction(Object& obj);

likewise, if a variable is not changed after initialization, make it const.

== Write Exception-Safe Code ==

Wesnoth code should be exception-safe, even if you do not use exceptions directly. That is, you should be able to assume that an exception is thrown almost anywhere from within the code, with well-defined results (i.e. no resource leaks).

Code that uses a pattern like,

{
SDL_Surface* image = IMG_Load("image.bmp");
...some code, which uses 'image'...
SDL_FreeSurface(image);
}

is bad, because the code may throw an exception, and 'image' will never be freed. Instead, use wrapper objects which free the object in their destructor.

For SDL_Surface objects, use the <tt>surface</tt> class. So you could rewrite the above code,

{
surface image(IMG_Load("image.bmp"));
...some code, which uses 'image'...
} ''the image is automatically freed here when 'image' is destroyed

Instead of allocating memory directly using new[] or malloc(), use language-provided containers, such as vector.

== Respect for loop scoping of different platforms ==

In the code,

for(int i = 0; i != 100; ++i) {...}

the variable 'i' is scoped within the for loop according to ISO/ANSI C++ and GNU G++. However it is scoped within the
surrounding scope according to Visual C++ 6.

This means that the code,

for(int i = 0; i != 100; ++i) {}
for(int i = 0; i != 100; ++i) {}

is illegal on VC++6, because i is defined twice, although it is legal according to the standard, and GNU G++.

On VC++6, the legal way to write it would be,

for(int i = 0; i != 100; ++i) {}
for(i = 0; i != 100; ++i) {}

But this is illegal according to the standard, because 'i' is not defined in the second loop. The correct way to write
this code to conform to the standard and work on all platforms is to simply abandon declaring variables in the
initialization statement of a for loop when the variable must be reused in the same scope,

int i;
for(i = 0; i != 100; ++i) {}
for(i = 0; i != 100; ++i) {}

== Use the function templates minimum and maximum ==

Standard C++ offers the function templates min and max to find the minimum and maximum of two values on which operator
<
is defined. Unfortunately, many hoops must be leapt through to get this working on VC++. So, we do not use standard
min
and max. Instead, we use minimum and maximum, defined in utils.hpp.

Usage is fairly natural:

int i = minimum(x,y);

Note that in the above example, if x is an unsigned integer, and y is a signed integer, VC++ will have problems. You
must explicitly specify the version of minimum being called in such cases:

int i = minimum<int>(x,y);

== Do not use wstring ==

The standard C++ wstring class, defined as a basic_string< wchar_t >, does not exist in some platforms supported
by
Wesnoth. Use wide_string, defined in language.hpp, instead. wide_string is actually defined as a vector< wchar_t >

== Use util::array instead of C-style Arrays ==

C-style arrays are very efficient, but their interface is ugly. Use util::array defined in array.hpp. It is a wrapper
for an array which has a C++ container-style interface. If you need to, extend it to make it fit your needs.

== Do not use sprintf ==

Sprintf does not check whether or not it is writing past the end of the space allocated. This is a security problem if someone other than the person running the game can cause sprintf to write very long strings. In Wesnoth this untrusted data could come potentially from other players in a multiplayer game or from downloaded campaigns. Instead you should use snprintf with the second argument being sizeof of the buffer that will hold the result.

== Do not use C-style casts ==

The following code,

if(i->second.side() == (size_t)player_number_) {

is considered bad practice in C++ since a C-style cast is overpowered -- if types change around it could end up casting away constness, or performing an implementation-defined data reinterpretation (basically a C-style cast is a compiler generated combination of static_cast, reinterpret_cast, and const_cast).

Good programming style is to use the least powerful tool available that does what you want. For example,

if(i->second.side() == static_cast<size_t>(player_number_)) {

Alternatively, a constructor call may be used for non-builtin types.

Note: there may be some obscure cases where a C-style cast is desirable, such as converting a pointer to an integer type of unspecified size.

== Document "config" preconditions and postconditions ==

In the Wesnoth code you will commonly encounter a data container known as the "config," which contains heirarchical string data (such as WML contents or game settings). The tagged "children" of the config and their string "attributes" are arranged in an ordered and mapped format internally using STL.

Because config data is utilized in so many ways and places, it can be difficult to track across the scope of the entire program. You should document all public functions that take/return a config, specifying config content expectations. In particular, if your function requires a config parameter, specify where/how the config should be created. This will be a great help to any future coders who need to call or modify your function.

SingleUnitWML

2007-01-25T00:53:56Z

NeoPhile: /* how to describe a single unit */ Speeling and grammer

{{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'' '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.

* ''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.
** "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.
** ''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'' 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]]

BuildingUnits

2007-01-25T00:44:30Z

NeoPhile: /* Using your new unit */ Corrected/clarified info, fixed double-spaces after periods.

Making new units is fairly easy. Unit configuration files are plain text files that you can edit with any editor such as Notepad, TextEdit, gedit, pico, vi, emacs, etc. You will need to become familiar with [[UnitWML|WML]] in order to make a new unit. This page contains a more in-depth discussion of Unit WML syntax and will walk you through the creation of a new unit and discuss how you can use it in-game.

== Recommended procedure ==
The easiest way to make a new unit is to copy and paste an existing unit, then modify it. Navigate to the game's data/units directory and copy any unit. When you are editing the unit, attention to detail is key. If you forget to modify each key (for example, the unique id key), problems will result.

P.S. Make sure you use gimp to create a blank background.

== Using your new unit ==
Any unit in the game's ./data/units directory or ''userdata''/data/units will be recognized by the game. If you only want to put use it once or twice as a special unit, that's all you need to do. However, just because you made a new unit does NOT mean that it can be recruited. Each scenario and multiplayer era has a specific recruit list. If your unit is not on the list, you can't recruit it. This means you need to modify the ''recruit='' key in the appropriate configuration file. [[BuildingMultiplayer]] describes different ways you do this for multiplayer. To add a unit to a campaign, read about scenarios, sides, and recruit lists in [[BuildingScenarios]].
[[Image:paladin_605.jpg]]

== Distributing your unit ==
If you made a single unit, post it on the [http://www.wesnoth.org/forum forum]. If you made a whole group of units, you can make them into a multiplayer faction or you can upload a unit pack.

If you want to make a faction, follow the instructions in the [[BuildingFactions]] article. You should create a new era and add your units as one of the factions. You will not be able to add your units to any era that ships with the game.

If you want to make a unit pack, the procedure is easier. Unit packs are distributed for campaign writers who want to use your units in their campaigns/eras. They download your unit pack and copy/paste the units and images into their campaign/era.
* Navigate to the ''userdata''/data/campaigns directory. Everything from now on will occur relative to here. The era we'll use as an example will be called MyUnitPack
* Create a text file called MyUnitPack.cfg. Add the following lines:
# #define USE_MYUNITS #<- replace MYUNITS with something descriptive
# #enddef
# #ifdef USE_MYUNITS #<- replace MYUNITS with something descriptive
# {@campaigns/MyUnitPack/}
# #endif
:* These lines are commented out (with the #). That way when the unit pack ships it won't affect the game. If someone wants the game to be able to see these units, he can uncomment those lines and it will work. However, this usually causes problems in multiplayer (you will be using units no one else has), but it can be fun for campaigns.
:* NOTE: the commenting/uncommenting trick will only work if the units branch off of an existing unit. Custom L1 units will NOT show up in game automatically without editing another configuration file somewhere (scenario config file or multiplayer.cfg)
* Create another text file called MyUnitPack.pbl. (See [[PblWML]] for more details about *.pbl files.) Add the following lines to it:
author="''your name''"
icon="''any image file in the game's ./images directory''"
version="1.0"
title="My Awesome Unit Pack"
description="New race of lizard men."
* Create a folder called MyUnitPack. Navigate to it.
* Create two subdirectories: units and images. Place your unit cfg files and artwork into those subdirectories
* Create a text file called MyUnitPack.cfg (or another name of your choosing). Add the following lines:
[binary_path]
path=data/campaigns/MyUnitPack
[/binary_path]
[+units]
{@campaigns/MyUnitPack/units}
[/units]
* You should be ready to distribute your unit pack on the campaign server now
* PLEASE change the names to something unique before you publish

== Unit WML discussion ==

Units are enclosed in '''[unit]''' tags.

This section only provides some tips and pointers in making a unit. Feel free to add pointers of your own. For the full, current, complete WML reference on what to put in your [unit], see and frequently revisit [[UnitWML|The Unit WML reference page]].
* The first attribute of a unit is the ''id'' key, which is a unique identifier for the unit. As value of the ''type'' attribute for these units, the ''id'' key is used. (See [[BuildingScenarios]]).
* When referencing the unit in a ''type'' key, the id must be reproduced verbatim, without typos, and in a case-sensitive manner. If you don't do this, the key won't work. If you can't recruit in a scenario, it's probably because you have a typo in one of the unit ids and the ''recruit'' key was invalidated.
* It also has a ''name'' key, which is the (translatable) name of the unit, and is displayed on the Status Table when a unit of this type is selected. It does not need to be unique (but it helps).
* Do not set movement to 0. It creates weird infinite movement behavior. This might be fixed in the future. For now, to make an immobile unit, set movement to 1 use [movement_costs] to make it unable to move onto any terrain.
* Also, make sure you give the unit at least one [attack]. If not, there is a bug in the game code that will cause the game to crash when it attempts to find attacks. This may also be fixed in the future.
* See [[BuildingScenariosIntermediate]] for more information on attacks.

== See Also ==

* [[Create]]
* [[EditingWesnoth]]
* [[Creating Unit Art]]
* [[CampaignServerWML]]
* [[PblWML]]
* [[BuildingCampaignsThePBLFile]]
* [[Team_Color_Shifting]]

{{Create}}

Template:WML Tags

2006-08-07T07:42:55Z

NeoPhile: Added map label (as opposed to theme label)

{| class="gallery" style="width:175px;float: right;border: 1px solid #B48648; color:#B48648; font-size: 7pt;margin-left;10px;"
|-
|
<span style="float: right;"><small class="editlink noprint plainlinksneverexpand">[{{SERVER}}{{localurl:Template:WML Tags|action=edit}} edit ]</small></span>
'''WML Tags'''

|-
|''A:''
[[AbilitiesWMLTechnical1.1.3|abilities]],
[[CampaignWML#The_.5Babout.5D_tag|about]],
[[StatisticalScenarioWML|advances]],
[[UnitWML|advancefrom]],
[[AiWML|ai]],
[[DirectActionsWML|allow_recruit]],
[[VariablesWML|array]],
[[AttackWML|attack]],
[[StatisticalScenarioWML|attacks]],
[[AiWML|avoid]];
|-
|''B:''
[[CampaignWML#The_.5Bbinary_path.5D_tag|binary_path]],[[HelpWML|bold]];
|-
|''C:''
[[CampaignWML#The_.5Bcampaign.5D_tag|campaign]], [[DirectActionsWML|capture_village]], [[ReplayWML|choose]],
[[InternalActionsWML|clear_variable]],
[[InterfaceActionsWML|colour_adjust]],
[[ReplayWML|command]];
|-
|''D:''
[[StatisticalScenarioWML|deaths]],[[UnitWML|defend]],[[StatisticalScenarioWML|defends]],
[[UnitWML|defense]],
[[InterfaceActionsWML|delay]],
[[ReplayWML|destination]],
[[DirectActionsWML|disallow_recruit]],
[[InternalActionsWML|do]];
|-
|''E:''
[[UnitsWML|effect]],[[InternalActionsWML|else]],[[ReplayWML|end_turn]],
[[DirectActionsWML|endlevel]],
[[EraWML|era]],
[[EventWML|event]],
[[ThemeWML|expenses]];
|-
|''F:''
[[FilterWML|filter]], [[FilterWML|filter_second]], [[HelpWML|format]], [[AttackWML|frame]];
|-
|''G:''
[[GameConfigWML|game_config]], [[ScenarioWML|generator]], [[DirectActionsWML|gold]], [[ThemeWML|gold]];
|-
|''H:''
[[InternalActionsWML|have_unit]], [[HelpWML|header]], [[InterfaceActionsWML|hide_unit]];
|-
|''I:''
[[InternalActionsWML|if]], [[TimeWML|illuminated_time]], [[TerrainGraphicsWML|image]],
[[HelpWML|img]], [[ThemeWML|income]], [[HelpWML|italic]], [[InterfaceActionsWML|item]];
|-
|''J:''
[[HelpWML|jump]];
|-
|''K:''
[[DirectActionsWML|kill]], [[StatisticalScenarioWML|killed]];
|-
|''L:''
label ([[InterfaceActionsWML|map]], [[ThemeWML|theme]]), [[LanguageWML|language]], [[AiWML|leader_goal]];
|-
|''M:''
[[ThemeWML|main_map]],[[ThemeWML|menu]], [[InterfaceActionsWML|message]], [[ThemeWML|mini_map]],
[[AttackWML|missile_frame]], [[SingleUnitWML|modifications]], [[DirectActionsWML|modify_side]],
[[DirectActionsWML|modify_turns]], [[ReplayWML|move]], [[InterfaceActionsWML|move_unit_fake]], [[UnitWML|movement costs]],
[[UnitsWML|movetype]], [[ScenarioWML|multiplayer]], [[EraWML|multiplayer_side]], [[InterfaceActionsWML|music]];
|-
|''N:''
[[FilterWML|not]], [[ThemeWML|num_units]];
|-
|''O:''
[[DirectActionsWML|object]], [[InterfaceActionsWML|objectives]], [[InterfaceActionsWML|objective]],
[[ThemeWML|observers]], [[InterfaceActionsWML|option]], [[InternalActionsWML|or]];
|-
|''P:''
[[ThemeWML|panel]], [[IntroWML|part]], [[DirectActionsWML|place_shroud]], [[ThemeWML|position]],
[[InterfaceActionsWML|print]], [[AiWML|protect_location]], [[AiWML|protect_unit]];
|-
|''R:''
[[UnitsWML|race]], [[ReplayWML|random]], [[ReplayWML|recall]], [[StatisticalScenarioWML|recalls]],
[[ReplayWML|recruit]], [[StatisticalScenarioWML|recruits]], [[InterfaceActionsWML|redraw]],
[[HelpWML|ref]], [[DirectActionsWML|remove_shroud]], [[InterfaceActionsWML|remove_unit_overlay]],
[[InterfaceActionsWML|removeitem]], [[SavefileWML|replay]], [[SavefileWML|replay_start]],
[[UnitWML|resistance]], [[ThemeWML|resolution]], [[ReplayWML|results]], [[InternalActionsWML|role]];
|-
|''S:''
[[SavefileWML|save]], [[ScenarioWML|scenario]],
[[InterfaceActionsWML|scroll]], [[InterfaceActionsWML|scroll_to]],
[[InterfaceActionsWML|scroll_to_unit]], [[HelpWML|section]], [[DirectActionsWML|set_recruit]],
[[InternalActionsWML|set_variable]], [[SideWML|side]], [[ThemeWML|side_playing]], [[SavefileWML|snapshot]],
[[InterfaceActionsWML|sound]], [[ReplayWML|source]], [[AbilitiesWMLTechnical1.1.3|specials]]
[[StatisticalScenarioWML#The_.5Bstatistics.5D_tag|statistics]],
[[ThemeWML|status]], [[DirectActionsWML|stone]], [[InternalActionsWML|store_gold]], [[InternalActionsWML|store_locations]],
[[InternalActionsWML|store_starting_location]], [[InternalActionsWML|store_unit]], [[IntroWML|story]];
|-
|''T:''
[[AiWML|target]],
[[StatisticalScenarioWML#The_.5Bteam.5D_tag|team]],
[[DirectActionsWML|teleport]], [[UnitWML|teleport_anim]],
[[TerrainWML|terrain]], [[DirectActionsWML|terrain]], [[TerrainGraphicsWML|terrain_graphics]], [[ScenarioWML#Test_scenario|test]],
[[CampaignWML#The_.5Btextdomain.5D_tag|textdomain]], [[ThemeWML|theme]], [[InternalActionsWML|then]],
[[TerrainGraphicsWML|tile]], [[TimeWML|time]], [[ScenarioWML|time_area]], [[ThemeWML|time_of_day]],
[[HelpWML|topic]], [[HelpWML|toplevel]], [[SingleUnitWML|trait]], [[ThemeWML|turn]], [[ScenarioWML|tutorial]];
|-
|''U:''
[[InterfaceActionsWML|unhide_unit]], unit ([[UnitWML|define]], [[SingleUnitWML|create]]),
[[ThemeWML|unit_abilities]], [[ThemeWML|unit_alignment]], [[ThemeWML|unit_description]],
[[ThemeWML|unit_hp]], [[ThemeWML|unit_image]], [[ThemeWML|unit_level]], [[ThemeWML|unit_moves]],
[[InterfaceActionsWML|unit_overlay]], [[ThemeWML|unit_profile]], [[ThemeWML|unit_status]],
[[ThemeWML|unit_traits]], [[ThemeWML|unit_type]], [[ThemeWML|unit_weapons]], [[ThemeWML|unit_xp]],
[[UnitsWML|units]], [[DirectActionsWML|unstone]], [[DirectActionsWML|unstore_unit]], [[ThemeWML|upkeep]];
|-
| ''V:''
[[InternalActionsWML|variable]], [[VariablesWML|variables]], [[SideWML|village]], [[ThemeWML|villages]];
|-
| ''W:''
[[InternalActionsWML|while]]
|}

InterfaceActionsWML

2006-08-07T07:39:41Z

NeoPhile: /* Other interface tags */ added [label]

{{WML Tags}}
== Interface actions ==

Interface actions are actions that do not have an effect on gameplay;
instead, they show something to the player. The main interface tags
are '''[message]''' and '''[objectives]''', but several other tags affect
the interface also.

== [message] ==
The most commonly used interface action is [message], which displays a message to the user in a dialog box. It can also be used to take input from the user.

The following key/tags are accepted for [message]:
* standard unit filter - the unit whose profile and name are displayed. If no unit matching this filter is found, the message is not displayed (The unit has probably been killed).<br>'''[message]''' elements should be constructed so that it is either guaranteed that a certain unit is alive, or so that dialog flows smoothly even if the message isn't displayed.

* ''speaker'' an alternative to standard unit filter
** 'narrator' the dialog box is displayed without a caption for the unit speaking or a unit image
** 'unit' the primary unit for the event is speaking
** 'second_unit' the secondary unit for the event is speaking

* ''message'' (translatable) the text to display to the right of the image. ''message'' is sometimes multiple lines; if it is, be sure to use quotes(''' ' ''' or ''' " ''')
* ''image'' (default: profile image of speaker) the image to display next to the message.
* ''caption'' (default: name of speaker) the caption to display under the image. Name to be displayed.
* ''sound'' a sound effect (wav file) to play as the message is displayed. {{DevFeature}} This can be a comma-separated list, from which one will be randomly chosen.
* '''[option]''' zero or more '''[option]''' elements may be present. If '''[option]''' elements are present, then each option will be displayed in a menu for the user to select one option.
** ''message'' (translatable) the text displayed for the option (see [[DescriptionWML]])
** '''[command]''' an element containing actions which are executed if the option is selected.

Text formatting options for '''[message]'''
* An asterisk (*) as the first character causes the line to be boldfaced.
* An at symbol (@) as the first character causes the line to be green, as done with victory conditions.
* A pound symbol (#) as the first character causes the line to be red, as done with defeat conditions.
* A backquote (`) as the first character causes the line to be smaller.
* If used, the caption key text is boldfaced.

== [objectives] ==
The other tag used for plot development is '''[objectives]'''.
The '''[objectives]''' tag overwrites any previously set objectives,
and displays text which should describe the objectives of the scenario.
Scenario objectives are displayed on the player's first turn after the tag is used,
or as part of the event if it triggers during that player's turn.
Objectives can also be accessed at any time in a scenario using the
"Scenario Objectives" game menu option, making this tag useful for
scenario-specific information that the player may need to refer to during play.

This tag renders the ''objectives'' attribute of [scenario] obsolete (see ''objectives'', [[ScenarioWML]]).
Instead of using ''objectives'', use '''[objectives]''' to set scenario objectives inside a prestart event.
It can also be used to overwrite the starting objectives mid-scenario.

Attributes of '''[objectives]''':
* ''side'' Default '0'. The side to set the objectives for. A value of 0 sets objectives for all sides.
* ''summary'' Displayed first in the objectives text, this should describe the basic objective for the overall scenario. Can be omitted.
* ''note'' Displayed last in the objectives text, this is sometimes used for hints or additional information. Can be omitted.
* ''victory_string'' Default ' _ "Victory:"', this text precedes the victory objectives.
* ''defeat_string'' Default ' _ "Defeat:"', this text precedes the defeat objectives.
* ''silent'' Default: not present. If set to "yes", the objectives are silently changed. Else, they will be shown to the user when appropriate.

Tags of '''[objectives]''':
* '''[objective]''' describes a win or loss condition. Most scenarios have multiple win or loss conditions, so use a separate [objective] subtag for each line; this helps with translations.
** ''description'' text for the specific win or loss condition.
** ''condition'' The color and placement of the text. Values are 'win'(colored green, placed after ''victory_string'') and 'lose'(colored red, placed after ''defeat_string'')

== Other interface tags ==

The following tags are also action tags:
* '''[item]''' makes a graphical item appear on a certain hex. Note this only places the graphics for an item. It does not make the item do anything. Use a moveto event to make moving onto the item do something.
** ''x'', ''y'' the location to place the item.
** ''image'' the image (in ''images/ ''as .png) to place on the hex.
** ''halo'' an image to place centered on the hex. Use this instead of ''image'' if the image is bigger than the hex.
* '''[removeitem]''' removes any graphical items on a given hex
** ''x'', ''y'' the hex to remove items off
* '''[print]''' displays a message across the screen. The message will disappear after a certain time.
** ''text'' (translatable) the text to display.
** ''size'' (default=12) the pointsize of the font to use
** ''duration'' (default=50) the length of time to display the text for. This is measured in the number of 'frames'. A frame in Wesnoth is usually displayed for around 30ms.
** ''red'', ''green'', ''blue'' (default=0,0,0) the color to display the text in. Values vary from 0-255.
* '''[move_unit_fake]''' moves an image of a unit along a certain path on the map. The path does not need to be a continuous list of adjacent hexes, so for example only the start and end points can be given, in which case the straightest line between those points will be calculated and used.
** ''type'' the type of the unit whose image to use
** ''x'' a comma-seperated list of x locations to move along
** ''y'' a comma-seperated list of y locations to move along (x and y values are matched pairs)
** ''side'' {{DevFeature}} the side of the fake unit, used for team colouring the fake unit
* '''[hide_unit]''' makes the given unit become invisible. Useful in conjunction with '''[move_unit_fake]''' to move a leader unit into position on-screen. Only one unit may be hidden at a time.
** ''x'', ''y'' location of the unit to be hidden. (NOT a standard unit filter! Just x and y.)
* '''[unhide_unit]''' stops the currently hidden unit from being hidden.
* '''[scroll]''' Scroll a certain number of pixels in a given direction. Useful for earthquake/shaking effects.
** ''x'', ''y'' the number of pixels to scroll along the x and y axis
* '''[scroll_to]''' Scroll to a given hex
** ''x'', ''y'' the hex to scroll to
* '''[scroll_to_unit]''' Scroll to a given unit
** standard unit filter
* '''[sound]''' Plays a sound
** ''name'' the filename of the sound to play (in ''sounds/'' as .wav or .ogg)
* '''[music]''' Switches to playing different music
** ''name'' the filename of the music to play (in ''music/'' as .ogg)
** {{DevFeature}} see [[MusicListWML]] for the correct syntax
* '''[colour_adjust]''' tints the colour of the screen.
** ''red'', ''green'', ''blue'' values from -255 to 255, the amount to tint by for each colour
* '''[delay]''' pauses the game
** ''time'' the time to pause in milliseconds
* '''[redraw]''' redraws the screen (this normally isn't done during events, although some of the other interface actions cause the screen or parts of it to be redrawn).
** ''side'' {{DevFeature}} if used, recalculates fog and shroud for that side. Useful if you for example spawn friendly units in the middle of an event and want the shroud to update accordingly (otherwise units that spawn inside fog would remain invisible for the duration of the event, since the fog would not automatically get cleared around them).
* '''[unit_overlay]''' sets an image that will be drawn over a particular unit, and follow it around
** ''x'', ''y'' the location of the unit to overlay on
** ''image'' the image to place on the unit
* '''[remove_unit_overlay]''' removes a particular overlayed image from a unit
** ''x'', ''y'' the location of the unit to remove an overlay from
** ''image'' the image to remove from the unit
* '''[animate_unit]''' uses the custom animation of a unit to animate it on screen (if the unit has the corresponding animation)
** ''flag'' the key to find the good custom animation in the unit description see the '''[extra_anim]''' description in [[AnimationWML]]
** '''[filter]''' a standard unit filter see [[FilterWML]] by default, the unit at the event location will be animated. You can use this tag to choose what unit to animate
* '''[label]''' places a label on the map.
** ''x'', ''y'' the location of the label
** ''text'' what the label should say

== See Also ==
* [[DirectActionsWML]]
* [[InternalActionsWML]]
* [[EventWML]]
* [[ReferenceWML]]

Template:WML Tags

2006-08-07T07:34:26Z

NeoPhile: Added [modify_turns]

{| class="gallery" style="width:175px;float: right;border: 1px solid #B48648; color:#B48648; font-size: 7pt;margin-left;10px;"
|-
|
<span style="float: right;"><small class="editlink noprint plainlinksneverexpand">[{{SERVER}}{{localurl:Template:WML Tags|action=edit}} edit ]</small></span>
'''WML Tags'''

|-
|''A:''
[[AbilitiesWMLTechnical1.1.3|abilities]],
[[CampaignWML#The_.5Babout.5D_tag|about]],
[[StatisticalScenarioWML|advances]],
[[UnitWML|advancefrom]],
[[AiWML|ai]],
[[DirectActionsWML|allow_recruit]],
[[VariablesWML|array]],
[[AttackWML|attack]],
[[StatisticalScenarioWML|attacks]],
[[AiWML|avoid]];
|-
|''B:''
[[CampaignWML#The_.5Bbinary_path.5D_tag|binary_path]],[[HelpWML|bold]];
|-
|''C:''
[[CampaignWML#The_.5Bcampaign.5D_tag|campaign]], [[DirectActionsWML|capture_village]], [[ReplayWML|choose]],
[[InternalActionsWML|clear_variable]],
[[InterfaceActionsWML|colour_adjust]],
[[ReplayWML|command]];
|-
|''D:''
[[StatisticalScenarioWML|deaths]],[[UnitWML|defend]],[[StatisticalScenarioWML|defends]],
[[UnitWML|defense]],
[[InterfaceActionsWML|delay]],
[[ReplayWML|destination]],
[[DirectActionsWML|disallow_recruit]],
[[InternalActionsWML|do]];
|-
|''E:''
[[UnitsWML|effect]],[[InternalActionsWML|else]],[[ReplayWML|end_turn]],
[[DirectActionsWML|endlevel]],
[[EraWML|era]],
[[EventWML|event]],
[[ThemeWML|expenses]];
|-
|''F:''
[[FilterWML|filter]], [[FilterWML|filter_second]], [[HelpWML|format]], [[AttackWML|frame]];
|-
|''G:''
[[GameConfigWML|game_config]], [[ScenarioWML|generator]], [[DirectActionsWML|gold]], [[ThemeWML|gold]];
|-
|''H:''
[[InternalActionsWML|have_unit]], [[HelpWML|header]], [[InterfaceActionsWML|hide_unit]];
|-
|''I:''
[[InternalActionsWML|if]], [[TimeWML|illuminated_time]], [[TerrainGraphicsWML|image]],
[[HelpWML|img]], [[ThemeWML|income]], [[HelpWML|italic]], [[InterfaceActionsWML|item]];
|-
|''J:''
[[HelpWML|jump]];
|-
|''K:''
[[DirectActionsWML|kill]], [[StatisticalScenarioWML|killed]];
|-
|''L:''
[[ThemeWML|label]], [[LanguageWML|language]], [[AiWML|leader_goal]];
|-
|''M:''
[[ThemeWML|main_map]],[[ThemeWML|menu]], [[InterfaceActionsWML|message]], [[ThemeWML|mini_map]],
[[AttackWML|missile_frame]], [[SingleUnitWML|modifications]], [[DirectActionsWML|modify_side]],
[[DirectActionsWML|modify_turns]], [[ReplayWML|move]], [[InterfaceActionsWML|move_unit_fake]], [[UnitWML|movement costs]],
[[UnitsWML|movetype]], [[ScenarioWML|multiplayer]], [[EraWML|multiplayer_side]], [[InterfaceActionsWML|music]];
|-
|''N:''
[[FilterWML|not]], [[ThemeWML|num_units]];
|-
|''O:''
[[DirectActionsWML|object]], [[InterfaceActionsWML|objectives]], [[InterfaceActionsWML|objective]],
[[ThemeWML|observers]], [[InterfaceActionsWML|option]], [[InternalActionsWML|or]];
|-
|''P:''
[[ThemeWML|panel]], [[IntroWML|part]], [[DirectActionsWML|place_shroud]], [[ThemeWML|position]],
[[InterfaceActionsWML|print]], [[AiWML|protect_location]], [[AiWML|protect_unit]];
|-
|''R:''
[[UnitsWML|race]], [[ReplayWML|random]], [[ReplayWML|recall]], [[StatisticalScenarioWML|recalls]],
[[ReplayWML|recruit]], [[StatisticalScenarioWML|recruits]], [[InterfaceActionsWML|redraw]],
[[HelpWML|ref]], [[DirectActionsWML|remove_shroud]], [[InterfaceActionsWML|remove_unit_overlay]],
[[InterfaceActionsWML|removeitem]], [[SavefileWML|replay]], [[SavefileWML|replay_start]],
[[UnitWML|resistance]], [[ThemeWML|resolution]], [[ReplayWML|results]], [[InternalActionsWML|role]];
|-
|''S:''
[[SavefileWML|save]], [[ScenarioWML|scenario]],
[[InterfaceActionsWML|scroll]], [[InterfaceActionsWML|scroll_to]],
[[InterfaceActionsWML|scroll_to_unit]], [[HelpWML|section]], [[DirectActionsWML|set_recruit]],
[[InternalActionsWML|set_variable]], [[SideWML|side]], [[ThemeWML|side_playing]], [[SavefileWML|snapshot]],
[[InterfaceActionsWML|sound]], [[ReplayWML|source]], [[AbilitiesWMLTechnical1.1.3|specials]]
[[StatisticalScenarioWML#The_.5Bstatistics.5D_tag|statistics]],
[[ThemeWML|status]], [[DirectActionsWML|stone]], [[InternalActionsWML|store_gold]], [[InternalActionsWML|store_locations]],
[[InternalActionsWML|store_starting_location]], [[InternalActionsWML|store_unit]], [[IntroWML|story]];
|-
|''T:''
[[AiWML|target]],
[[StatisticalScenarioWML#The_.5Bteam.5D_tag|team]],
[[DirectActionsWML|teleport]], [[UnitWML|teleport_anim]],
[[TerrainWML|terrain]], [[DirectActionsWML|terrain]], [[TerrainGraphicsWML|terrain_graphics]], [[ScenarioWML#Test_scenario|test]],
[[CampaignWML#The_.5Btextdomain.5D_tag|textdomain]], [[ThemeWML|theme]], [[InternalActionsWML|then]],
[[TerrainGraphicsWML|tile]], [[TimeWML|time]], [[ScenarioWML|time_area]], [[ThemeWML|time_of_day]],
[[HelpWML|topic]], [[HelpWML|toplevel]], [[SingleUnitWML|trait]], [[ThemeWML|turn]], [[ScenarioWML|tutorial]];
|-
|''U:''
[[InterfaceActionsWML|unhide_unit]], unit ([[UnitWML|define]], [[SingleUnitWML|create]]),
[[ThemeWML|unit_abilities]], [[ThemeWML|unit_alignment]], [[ThemeWML|unit_description]],
[[ThemeWML|unit_hp]], [[ThemeWML|unit_image]], [[ThemeWML|unit_level]], [[ThemeWML|unit_moves]],
[[InterfaceActionsWML|unit_overlay]], [[ThemeWML|unit_profile]], [[ThemeWML|unit_status]],
[[ThemeWML|unit_traits]], [[ThemeWML|unit_type]], [[ThemeWML|unit_weapons]], [[ThemeWML|unit_xp]],
[[UnitsWML|units]], [[DirectActionsWML|unstone]], [[DirectActionsWML|unstore_unit]], [[ThemeWML|upkeep]];
|-
| ''V:''
[[InternalActionsWML|variable]], [[VariablesWML|variables]], [[SideWML|village]], [[ThemeWML|villages]];
|-
| ''W:''
[[InternalActionsWML|while]]
|}

MultiplayerContent

2006-08-04T20:49:05Z

NeoPhile: /* Scenarios */ Added item for [story] tags

== Building multiplayer campaigns ==

Both the stable and development versions of wesnoth have basic support for campaigns that can be played in multiplayer mode, with your friends, or even with an AI. Since version 1.1.8, more features and support have been added so we recommend a versions 1.1.8+. There will still be some things that don't work as expected as multiplayer campaigns are an area for exploration. While you can and should test your work in hotseat mode, there are a number of things that might behave differently under real network conditions (mostly affecting scenario and side parameters). Keep this in mind and make sure to test your campaign over the net, too.
This page only documents the differences between writing multiplayer campaigns and single player campaigns, so you might want to read up on [[BuildingCampaigns]] and [[BuildingMultiplayer]] first.

=== The campaign file ===

Multiplayer campaigns do not use the [campaign] tag. As a result of this, multiplayer campaigns only support one difficulty level, though you could support more with enough WML, if you're feeling ambitious. The "campaign file" should look something like this:

#ifdef MULTIPLAYER
{@campaigns/My_Campaign/scenarios}
#endif

Anything that you would normally put in the campaign tag now goes into the first scenario, if it's supported there. The order of scenarios is determined by next_scenario tags, just like in single player.

=== Scenarios ===

A scenario in a multiplayer campaign is almost identical to a scenario in a single player campaign. You only need to change the following:

* The [scenario] tag should be replaced with a [multiplayer] tag.
* The '''next_scenario''' key points to the id of the next scenario.
* Every scenario after the first should have '''allow_new_game=no''' inside the [multiplayer] tag. This will prevent it from showing up in the map selection menu. ''This does not work in v1.1'', but it causes no harm, and it will work in the future.
* In v1.1, Every scenario in the campaign will appear on the map selection menu, so be sure to include your campaign's name in the [multiplayer] tag's name key. Alternatively, include a warning like "DO NOT PLAY".
* Each human-controlled side needs to have a '''controller=human''' key defined in their [side] tag to work in network mode.
* Each human-controlled side also needs to have a '''save_id''' defined inside their [side] tag. Each side's save_id should be unique, and it should be the same in every scenario. Without this, your recall lists and leaders will not carry over from one scenario to the next.
* Each AI-controlled side should have '''allow_player=no''' in their [side] tag.
* The [story] tag will only display for the first player (or maybe it's the host player). You'll have to use [message] tags in the start event if you want everyone to read the story.

=== The first scenario ===

The first scenario might need some extra work, because the settings from the multiplayer dialog will override the settings in the scenario. However, most of the multiplayer settings can be overridden in the prestart event.

Use a macro like this to force a side to have a particular type of leader.
#define MP_SIDE SIDENO TYPE DESC
[store_unit]
variable=oldunit
kill=yes
[filter]
side={SIDENO}
[/filter]
[/store_unit]

[unit]
type={TYPE}
description={DESC}
unrenameable=yes
side={SIDENO}
x,y=$oldunit.x,$oldunit.y
canrecruit=1
[/unit]

[clear_variable]
name=oldunit
[/clear_variable]
#enddef

Other useful tags include [set_recruit], [modify_side], [modify_turns] and [remove_shroud]. There is currently no way to remove fog. You might also want to use ''experience_modifier=100'' in the [multiplayer] tag.

=== Custom units ===

Since there is no [campaign] tag, there is no natural way to include custom units in a multiplayer campaign. However, there are two workarounds. One way is to use [[EffectWML]] or [store_unit] to modify a mainline unit. The other way is to make your custom units available via an [[EraWML|era]], or by dropping them into ~wesnoth/data/units. If you go this route, using an era is better, because you can keep the units in your campaign directory.

== See Also ==

* [http://www.wesnoth.org/forum/viewtopic.php?t=11349 Multiplayer Campaigns HOWTO forum post]
* [[BuildingScenarios]]
* [[BuildingMultiplayer]]

Create

2006-08-03T06:13:52Z

NeoPhile: /* What can I create, and how? */ - Added link to MultiplayerCampaigns

{| style="float:right"
|
__TOC__
|}
Interested in creating your own scenarios and campaigns? One of Wesnoth's best features is its extensibility. Players can create new maps, units, races, scenarios, art, music, and even entire campaigns. Access to the "guts" of the game is both simple and difficult; if you have an ASCII text editor you have everything you need to build your own world. However, learning the Wesnoth Markup Language (WML) takes some effort. This section will guide you through the process of creating and distributing your own content.

It should also be noted that '''we need a lot of help creating artwork for the core of the game.''' The current projects we are working on are [http://www.wesnoth.org/forum/viewtopic.php?t=9162 listed here]. We'll happily help you out, if you take a swing at them.

== Read this first! ==
Before you modify or add anything, it is important to understand how the game stores and organizes its data. This article will explain the game's directory structure and introduce the ''userdata'' directory.
* [[EditingWesnoth]]

== What can I create, and how? ==

<div class="thumb tright"><div>
[http://www.wesnoth.org/images/sshots/wesnoth_editor-1.jpg http://www.wesnoth.org/images/sshots/wesnoth_editor-1-175.jpg]
<div class="thumbcaption">Battle for Wesnoth Map editor</div></div>
</div>

* [[BuildingMaps|Maps]] - the layout of terrain tiles
* [[BuildingScenarios|Scenarios]] - a scenario makes things happen on a map, making it playable
* [[BuildingCampaigns|Campaigns]] - how to put it all together into a campaign
* [[BuildingMultiplayer|Multiplayer Maps and Scenarios]] - a specialized look at maps and scenarios
* [[MultiplayerCampaigns|Multiplayer Campaigns]] - making a campaign accessible in multiplayer
* [[BuildingUnits|Units]]
* [[BuildingFactions|Multiplayer factions and eras]]
* '''[[Create Art|Art]]''' - complete with '''tutorials!'''
* [[Create Music|Music]]
* [[Distributing content]] - all about the campaign server
* [[WesnothTranslations|Translations]] - work on translating Wesnoth

== What have others done? ==
Quick descriptions of the campaigns and scenarios that have been published on the campaign server.
* [[UserScenarios|User contributed campaigns]]
This there are a multitude multiplayer maps and discussion of the campaigns on the [http://www.wesnoth.org/forum Wesnoth forum]
* [http://www.wesnoth.org/forum/viewforum.php?f=15 Multiplayer development forum]
* [http://www.wesnoth.org/forum/viewforum.php?f=8 Scenario and campaign development forum]
* [[Complete Faction List (unfinished)|Complete Faction List]]

== The world of Wesnoth ==
Many campaigns do not take place in Wesnoth, but many do. There is definitely a certain flavor to campaigns that are intended to take place somewhere in the world of Wesnoth. Stake out a time period or a map locale and tell a story.
* [[WesnothHistory|The history of Wesnoth]]
* [[WesnothGeography|The geography of Wesnoth]]
* [[RaceDescriptions|The races of creatures in Wesnoth]]
* [[WesnothPoetry|Wesnothian poetry]]

== Miscellaneous ==
* [[ExternalUtilities| External Utilities]] - some extra tools for easier creating stuff
* [[ReferenceWML|WML Reference]] - a quicklink
* [[FAQ#Scenario_and_Campaigns|FAQ]] - if you have a question, post it
* Campaign server [http://wolff.to/campaigns/list.html web interface] - An alternate way to download user campaigns
* [[Status_of_User_Scenarios| Status of User Scenarios]] - Lists which usercampaigns are working and which ones are broken
{{Home}}

StartingPoints

2006-08-03T06:10:05Z

NeoPhile: /* Tweaking the Game (Create) */ - Added topic MultiplayerCampaigns

__NOTOC__
Battle for Wesnoth is a turn-based fantasy strategy game.

Defeat all enemy leaders using a well-chosen cadre of troops,
taking care to manage your resources of gold and villages.
All units have their own strengths and weaknesses; to win,
deploy your forces to their best advantage while
denying your foes the chance to do the same. As units gain
experience, they acquire new abilities and become more
powerful. Play in your own language and test your skill
against a smart computer opponent, or join Wesnoth's large
community of on-line players.
Create your own custom units, scenarios or campaigns,
and share them with others.

Battle for Wesnoth is released under the
[http://www.gnu.org/licenses/licenses.html#GPL GPL].
Prebuilt packages are available for most operating systems,
including Windows, Mac OS X, and GNU/Linux, or you can build
your own from source code.

== Getting the Game ==
==== Downloading ====
* [[Download]] - get the most recent source-files and many binaries
** [[WesnothBinaries]] - precompiled for GNU/Linux, BeOS, PDAs, ...
** [[WesnothBinariesLinux]] - precompiled for many GNU/Linux distributions

==== Compiling ====
* [[CompilingWesnoth]] - on Unix, Mac, Windows, GNU/Linux, PDAs, ...
* [[DebuggingWesnoth]] - on GNU/Linux and Unix-like systems
* [[WesnothOnLinuxPDAs]] - on the Qtopia/OPIE and thepdaXrom/Zaurus C series

== Playing the Game ([[Play]]) ==

==== For New Players ====
* [[GettingStarted]] - read me first!
* [[WesnothManual]] - the rules
* [[MainlineScenarios]] - walkthroughs for the game-supplied campaigns

==== For Not-So-New Players ====
* [[AdvancedTactics]] - beating the AI and other people
* [[MultiplayerServers]] - where to play against other people online

==== Reference ====
* [[HotKeysSystem]] - keyboard shortcuts
* [[CommandMode]] - commands you can use in-game
* [[ServerAdministration]] - commands that authenticated users can use to administer the server
* [http://wesnoth.slack.it/units.cgi Units] - Units advancement trees and stats
** [http://wesnoth.slack.it/units.cgi?page=frames Wesnoth Unit List] ([http://wesnoth.slack.it/units.cgi?page=list without frames])
** [http://wesnoth.slack.it/units.cgi?movetypes Movement, defense and resistance tables]
* [[RaceDescriptions]] - Elves, Humans, Dwarves, Orcs, Drakes, Undead, Others
** [[Complete_Faction_List_%28unfinished%29]] - list all user made factions
* [[WesnothAcronyms|Wesnoth Acronyms (by category)]] - common wesnothian acronyms explained
* [[WesnothAcronyms(alphabetic)|Wesnoth Acronyms (alphabetic)]] - common wesnothian acronyms explained

== Tweaking the Game ([[Create]]) ==

* [[UserScenarios]] - user-written scenarios, campaigns and game modifications
* [[ReferenceWML]] and [[AlphabeticalWML]] - all about Wesnoth Markup Language
* [[ReferencePythonAPI]] - upcoming Python interface for AI
* [[BuildingCampaigns]] - how to make your own single player campaigns
* [[MultiplayerCampaigns]] - how to make your own multiplayer campaigns
* [[BuildingScenarios]] - how to make your own scenarios
* [[BuildingUnits]] - how to make your own units
* [[UnitAnalysis]] - tool to analyze units
* [[WesnothMapEditor]] - summary of controls
* [[ExternalUtilities]] - scripts to help create scenarios, campaigns, and graphics
* [[Create_Art#Art_Tutorials|Art Tutorials]] - help in creating art
* [[GraphicLibrary]] - unit and terrain images posted on the forums
* [[Tiles_Status]] - terrain tiles: proposed and in progress.

== Improving the Game ==
* [[ReportingBugs]] - use Gna
* To submit a feature request, use http://bugs.wesnoth.org
* [[FrequentlyProposedIdeas]] - before you propose an idea, check here!
==== Developer information ====
* [[DeveloperResources]] - useful links
* [http://changelog.wesnoth.org Changelog] - the most recent changes made to the game
* [[WesnothSVN]] - accessing the source code
* [[HackingWesnoth]] - guide for programmers
* [[CodingStandards]] - for programmers
* [[UnitDescriptionRewriting]] - coordinating the revision
* [http://wesnoth.slack.it/missing.cgi Missing unit animations and sounds] - what's available and what's missing
* [[WritingYourOwnAI]] - write a C++ plugin
* [[ThemeSystem]] - customizing the screen layout for the game and the editor
* [[ReleasingWesnoth]] - steps to follow to release a new version
* [[WesnothPackagersGuide]] - guidelines for packaging Wesnoth for different platforms
* [[WesnothPreferences]]

==== Game translations ====
* [[GettextForTranslators]] - how to translate Wesnoth under [[GetText]]
* [[WesnothTranslations]] - 11 complete, 2 almost complete, 7 more than halfway, 10 partial
* [[WesCamp]] - a project for translating user-made campaigns

== About the Game ==
* [[WesnothPhilosophy]] - Dave on Wesnoth
* [[WesnothHistory]] - the Ages of Wesnoth
* [[WesnothGeography]] - description of Wesnoth and surrounding lands
* [[WesnothReviews]] - third party reviews of Wesnoth
* [irc://irc.wesnoth.org/wesnoth #wesnoth] - our IRC channel
* [[Donate]] or [http://cafepress.com/wesnoth buy Wesnoth merchandise].
* [[Trailer]] - the Wesnoth trailer

== Other ==
* [[UsefulLinks]]
* [[WesnothLSM]] - presentation at LSM
* [http://wesnoth.slack.it/?WesnothPlayerMap Map of Wesnoth player locations] - add yourself to the map!
* [http://en.wikipedia.org/wiki/Battle_for_Wesnoth Wikipedia entry for Wesnoth]

== About this Wiki ==
* [[Help:Editing|Editing]] - learn how to edit pages
* [[Sandbox]] - experiment with the wiki
* [[WikiMigration]] - we were looking for a replacement for our old wiki (and ended up using Mediawiki)

MultiplayerContent

2006-08-03T06:03:51Z

NeoPhile: New page

== Building multiplayer campaigns ==

Recent versions of wesnoth (which ones?) have support for campaigns that can be played in multiplayer mode, with your friends, or even with an AI. The support is pretty basic at this point, so there will be some things that don't work as expected. This page only documents the differences between writing multiplayer campaigns and single player campaigns, so you might want to read up on [[BuildingCampaigns]] and [[BuildingMultiplayer]] first.

=== The campaign file ===

Multiplayer campaigns do not use the [campaign] tag. As a result of this, multiplayer campaigns only support one difficulty level, though you could support more with enough WML, if you're feeling ambitious. The "campaign file" should look something like this:

#ifdef MULTIPLAYER
{@campaigns/My_Campaign/scenarios}
#endif

Anything that you would normally put in the campaign tag now goes into the first scenario, if it's supported there. The order of scenarios is determined by next_scenario tags, just like in single player.

=== Scenarios ===

A scenario in a multiplayer campaign is almost identical to a scenario in a single player campaign. You only need to change the following:

* The [scenario] tag should be replaced with a [multiplayer] tag.
* Every scenario after the first should have '''allow_new_game=no''' inside the [multiplayer] tag. This will prevent it from showing up in the map selection menu. ''This does not work in v1.1'', but it causes no harm, and it will work in the future.
* In v1.1, Every scenario in the campaign will appear on the map selection menu, so be sure to include your campaign's name in the [multiplayer] tag's name key. Alternatively, include a warning like "DO NOT PLAY".
* Each human-controlled side needs to have a '''save_id''' defined inside their [side] tag. Each side's save_id should be unique, and it should be the same in every scenario. Without this, your recall lists and leaders will not carry over from one scenario to the next.
* Each AI-controlled side should have '''allow_player=no''' in their [side] tag.

=== The first scenario ===

The first scenario might need some extra work, because the settings from the multiplayer dialog will override the settings in the scenario. However, most of the multiplayer settings can be overridden in the prestart event.

Use a macro like this to force a side to have a particular type of leader.
#define MP_SIDE SIDENO TYPE DESC
[store_unit]
variable=oldunit
kill=yes
[filter]
side={SIDENO}
[/filter]
[/store_unit]

[unit]
type={TYPE}
description={DESC}
unrenameable=yes
side={SIDENO}
x,y=$oldunit.x,$oldunit.y
canrecruit=1
[/unit]

[clear_variable]
name=oldunit
[/clear_variable]
#enddef

Other useful tags include [set_recruit], [modify_side], [modify_turns] and [remove_shroud]. There is currently no way to remove fog. You might also want to use ''experience_modifier=100'' in the [multiplayer] tag.

=== Custom units ===

Since there is no [campaign] tag, there is no natural way to include custom units in a multiplayer campaign. However, there are two workarounds. One way is to use [[EffectWML]] or [store_unit] to modify a mainline unit. The other way is to make your custom units available via an [[EraWML|era]], or by dropping them into ~wesnoth/data/units. If you go this route, using an era is better, because you can keep the units in your campaign directory.

== See Also ==

* [http://www.wesnoth.org/forum/viewtopic.php?t=11349 Multiplayer Campaigns HOWTO forum post]
* [[BuildingScenarios]]
* [[BuildingMultiplayer]]

Template:WML Tags

2006-07-25T22:59:13Z

NeoPhile: Added [specials]

{| class="gallery" style="width:175px;float: right;border: 1px solid #B48648; color:#B48648; font-size: 7pt;margin-left;10px;"
|-
|
<span style="float: right;"><small class="editlink noprint plainlinksneverexpand">[{{SERVER}}{{localurl:Template:WML Tags|action=edit}} edit ]</small></span>
'''WML Tags'''

|-
|''A:''
[[AbilitiesWMLTechnical1.1.3|abilities]],
[[CampaignWML#The_.5Babout.5D_tag|about]],
[[StatisticalScenarioWML|advances]],
[[UnitWML|advancefrom]],
[[AiWML|ai]],
[[DirectActionsWML|allow_recruit]],
[[VariablesWML|array]],
[[AttackWML|attack]],
[[StatisticalScenarioWML|attacks]],
[[AiWML|avoid]];
|-
|''B:''
[[CampaignWML#The_.5Bbinary_path.5D_tag|binary_path]],[[HelpWML|bold]];
|-
|''C:''
[[CampaignWML#The_.5Bcampaign.5D_tag|campaign]], [[DirectActionsWML|capture_village]], [[ReplayWML|choose]],
[[InternalActionsWML|clear_variable]],
[[InterfaceActionsWML|colour_adjust]],
[[ReplayWML|command]];
|-
|''D:''
[[StatisticalScenarioWML|deaths]],[[UnitWML|defend]],[[StatisticalScenarioWML|defends]],
[[UnitWML|defense]],
[[InterfaceActionsWML|delay]],
[[ReplayWML|destination]],
[[DirectActionsWML|disallow_recruit]],
[[InternalActionsWML|do]];
|-
|''E:''
[[UnitsWML|effect]],[[InternalActionsWML|else]],[[ReplayWML|end_turn]],
[[DirectActionsWML|endlevel]],
[[EraWML|era]],
[[EventWML|event]],
[[ThemeWML|expenses]];
|-
|''F:''
[[FilterWML|filter]], [[FilterWML|filter_second]], [[HelpWML|format]], [[AttackWML|frame]];
|-
|''G:''
[[GameConfigWML|game_config]], [[ScenarioWML|generator]], [[DirectActionsWML|gold]], [[ThemeWML|gold]];
|-
|''H:''
[[InternalActionsWML|have_unit]], [[HelpWML|header]], [[InterfaceActionsWML|hide_unit]];
|-
|''I:''
[[InternalActionsWML|if]], [[TimeWML|illuminated_time]], [[TerrainGraphicsWML|image]],
[[HelpWML|img]], [[ThemeWML|income]], [[HelpWML|italic]], [[InterfaceActionsWML|item]];
|-
|''J:''
[[HelpWML|jump]];
|-
|''K:''
[[DirectActionsWML|kill]], [[StatisticalScenarioWML|killed]];
|-
|''L:''
[[ThemeWML|label]], [[LanguageWML|language]], [[AiWML|leader_goal]];
|-
|''M:''
[[ThemeWML|main_map]],[[ThemeWML|menu]], [[InterfaceActionsWML|message]], [[ThemeWML|mini_map]],
[[AttackWML|missile_frame]], [[SingleUnitWML|modifications]], [[DirectActionsWML|modify_side]],
[[ReplayWML|move]], [[InterfaceActionsWML|move_unit_fake]], [[UnitWML|movement costs]],
[[UnitsWML|movetype]], [[ScenarioWML|multiplayer]], [[EraWML|multiplayer_side]], [[InterfaceActionsWML|music]];
|-
|''N:''
[[FilterWML|not]], [[ThemeWML|num_units]];
|-
|''O:''
[[DirectActionsWML|object]], [[InterfaceActionsWML|objectives]], [[InterfaceActionsWML|objective]],
[[ThemeWML|observers]], [[InterfaceActionsWML|option]], [[InternalActionsWML|or]];
|-
|''P:''
[[ThemeWML|panel]], [[IntroWML|part]], [[DirectActionsWML|place_shroud]], [[ThemeWML|position]],
[[InterfaceActionsWML|print]], [[AiWML|protect_location]], [[AiWML|protect_unit]];
|-
|''R:''
[[UnitsWML|race]], [[ReplayWML|random]], [[ReplayWML|recall]], [[StatisticalScenarioWML|recalls]],
[[ReplayWML|recruit]], [[StatisticalScenarioWML|recruits]], [[InterfaceActionsWML|redraw]],
[[HelpWML|ref]], [[DirectActionsWML|remove_shroud]], [[InterfaceActionsWML|remove_unit_overlay]],
[[InterfaceActionsWML|removeitem]], [[SavefileWML|replay]], [[SavefileWML|replay_start]],
[[UnitWML|resistance]], [[ThemeWML|resolution]], [[ReplayWML|results]], [[InternalActionsWML|role]];
|-
|''S:''
[[SavefileWML|save]], [[ScenarioWML|scenario]],
[[InterfaceActionsWML|scroll]], [[InterfaceActionsWML|scroll_to]],
[[InterfaceActionsWML|scroll_to_unit]], [[HelpWML|section]], [[DirectActionsWML|set_recruit]],
[[InternalActionsWML|set_variable]], [[SideWML|side]], [[ThemeWML|side_playing]], [[SavefileWML|snapshot]],
[[InterfaceActionsWML|sound]], [[ReplayWML|source]], [[AbilitiesWMLTechnical1.1.3|specials]]
[[StatisticalScenarioWML#The_.5Bstatistics.5D_tag|statistics]],
[[ThemeWML|status]], [[DirectActionsWML|stone]], [[InternalActionsWML|store_gold]], [[InternalActionsWML|store_locations]],
[[InternalActionsWML|store_starting_location]], [[InternalActionsWML|store_unit]], [[IntroWML|story]];
|-
|''T:''
[[AiWML|target]],
[[StatisticalScenarioWML#The_.5Bteam.5D_tag|team]],
[[DirectActionsWML|teleport]], [[UnitWML|teleport_anim]],
[[TerrainWML|terrain]], [[DirectActionsWML|terrain]], [[TerrainGraphicsWML|terrain_graphics]], [[ScenarioWML#Test_scenario|test]],
[[CampaignWML#The_.5Btextdomain.5D_tag|textdomain]], [[ThemeWML|theme]], [[InternalActionsWML|then]],
[[TerrainGraphicsWML|tile]], [[TimeWML|time]], [[ScenarioWML|time_area]], [[ThemeWML|time_of_day]],
[[HelpWML|topic]], [[HelpWML|toplevel]], [[SingleUnitWML|trait]], [[ThemeWML|turn]], [[ScenarioWML|tutorial]];
|-
|''U:''
[[InterfaceActionsWML|unhide_unit]], unit ([[UnitWML|define]], [[SingleUnitWML|create]]),
[[ThemeWML|unit_abilities]], [[ThemeWML|unit_alignment]], [[ThemeWML|unit_description]],
[[ThemeWML|unit_hp]], [[ThemeWML|unit_image]], [[ThemeWML|unit_level]], [[ThemeWML|unit_moves]],
[[InterfaceActionsWML|unit_overlay]], [[ThemeWML|unit_profile]], [[ThemeWML|unit_status]],
[[ThemeWML|unit_traits]], [[ThemeWML|unit_type]], [[ThemeWML|unit_weapons]], [[ThemeWML|unit_xp]],
[[UnitsWML|units]], [[DirectActionsWML|unstone]], [[DirectActionsWML|unstore_unit]], [[ThemeWML|upkeep]];
|-
| ''V:''
[[InternalActionsWML|variable]], [[VariablesWML|variables]], [[SideWML|village]], [[ThemeWML|villages]];
|-
| ''W:''
[[InternalActionsWML|while]]
|}

UnitTypeWML

2006-07-25T17:33:12Z

NeoPhile: /* Attacks */ added [abilities] tag and changed title

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

Each '''[unit]''' tag defines one unit type. (for the use of [unit] to create a unit, see [[SingleUnitWML]])

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:<br> ** ''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.<br>** [[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:<br> ** 'scout' Fast,<br> ** 'fighter' Melee fighter,<br> ** 'archer' Ranged fighter,<br> ** 'mixed fighter' Melee and ranged fighter, and<br> ** '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.
** ''strict_amla'' {{DevFeature}} (yes|no) default=no. Disable the AMLA if the unit can advance to another unit.
** ''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]]

==== Other tags ====
* '''[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.

* '''[abilities]''' {{DevFeature}} Defines the abilities of a unit. See [[AbilitiesWMLTechnical1.1.3]]

== See Also ==

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

[[Category: WML Reference]]

Template:WML Tags

2006-07-25T17:18:52Z

NeoPhile: Added [abilities] tag

{| class="gallery" style="width:175px;float: right;border: 1px solid #B48648; color:#B48648; font-size: 7pt;margin-left;10px;"
|-
|
<span style="float: right;"><small class="editlink noprint plainlinksneverexpand">[{{SERVER}}{{localurl:Template:WML Tags|action=edit}} edit ]</small></span>
'''WML Tags'''

|-
|''A:''
[[AbilitiesWMLTechnical1.1.3|abilities]],
[[CampaignWML#The_.5Babout.5D_tag|about]],
[[StatisticalScenarioWML|advances]],
[[UnitWML|advancefrom]],
[[AiWML|ai]],
[[DirectActionsWML|allow_recruit]],
[[VariablesWML|array]],
[[AttackWML|attack]],
[[StatisticalScenarioWML|attacks]],
[[AiWML|avoid]];
|-
|''B:''
[[CampaignWML#The_.5Bbinary_path.5D_tag|binary_path]],[[HelpWML|bold]];
|-
|''C:''
[[CampaignWML#The_.5Bcampaign.5D_tag|campaign]], [[DirectActionsWML|capture_village]], [[ReplayWML|choose]],
[[InternalActionsWML|clear_variable]],
[[InterfaceActionsWML|colour_adjust]],
[[ReplayWML|command]];
|-
|''D:''
[[StatisticalScenarioWML|deaths]],[[UnitWML|defend]],[[StatisticalScenarioWML|defends]],
[[UnitWML|defense]],
[[InterfaceActionsWML|delay]],
[[ReplayWML|destination]],
[[DirectActionsWML|disallow_recruit]],
[[InternalActionsWML|do]];
|-
|''E:''
[[UnitsWML|effect]],[[InternalActionsWML|else]],[[ReplayWML|end_turn]],
[[DirectActionsWML|endlevel]],
[[EraWML|era]],
[[EventWML|event]],
[[ThemeWML|expenses]];
|-
|''F:''
[[FilterWML|filter]], [[FilterWML|filter_second]], [[HelpWML|format]], [[AttackWML|frame]];
|-
|''G:''
[[GameConfigWML|game_config]], [[ScenarioWML|generator]], [[DirectActionsWML|gold]], [[ThemeWML|gold]];
|-
|''H:''
[[InternalActionsWML|have_unit]], [[HelpWML|header]], [[InterfaceActionsWML|hide_unit]];
|-
|''I:''
[[InternalActionsWML|if]], [[TimeWML|illuminated_time]], [[TerrainGraphicsWML|image]],
[[HelpWML|img]], [[ThemeWML|income]], [[HelpWML|italic]], [[InterfaceActionsWML|item]];
|-
|''J:''
[[HelpWML|jump]];
|-
|''K:''
[[DirectActionsWML|kill]], [[StatisticalScenarioWML|killed]];
|-
|''L:''
[[ThemeWML|label]], [[LanguageWML|language]], [[AiWML|leader_goal]];
|-
|''M:''
[[ThemeWML|main_map]],[[ThemeWML|menu]], [[InterfaceActionsWML|message]], [[ThemeWML|mini_map]],
[[AttackWML|missile_frame]], [[SingleUnitWML|modifications]], [[DirectActionsWML|modify_side]],
[[ReplayWML|move]], [[InterfaceActionsWML|move_unit_fake]], [[UnitWML|movement costs]],
[[UnitsWML|movetype]], [[ScenarioWML|multiplayer]], [[EraWML|multiplayer_side]], [[InterfaceActionsWML|music]];
|-
|''N:''
[[FilterWML|not]], [[ThemeWML|num_units]];
|-
|''O:''
[[DirectActionsWML|object]], [[InterfaceActionsWML|objectives]], [[InterfaceActionsWML|objective]],
[[ThemeWML|observers]], [[InterfaceActionsWML|option]], [[InternalActionsWML|or]];
|-
|''P:''
[[ThemeWML|panel]], [[IntroWML|part]], [[DirectActionsWML|place_shroud]], [[ThemeWML|position]],
[[InterfaceActionsWML|print]], [[AiWML|protect_location]], [[AiWML|protect_unit]];
|-
|''R:''
[[UnitsWML|race]], [[ReplayWML|random]], [[ReplayWML|recall]], [[StatisticalScenarioWML|recalls]],
[[ReplayWML|recruit]], [[StatisticalScenarioWML|recruits]], [[InterfaceActionsWML|redraw]],
[[HelpWML|ref]], [[DirectActionsWML|remove_shroud]], [[InterfaceActionsWML|remove_unit_overlay]],
[[InterfaceActionsWML|removeitem]], [[SavefileWML|replay]], [[SavefileWML|replay_start]],
[[UnitWML|resistance]], [[ThemeWML|resolution]], [[ReplayWML|results]], [[InternalActionsWML|role]];
|-
|''S:''
[[SavefileWML|save]], [[ScenarioWML|scenario]],
[[InterfaceActionsWML|scroll]], [[InterfaceActionsWML|scroll_to]],
[[InterfaceActionsWML|scroll_to_unit]], [[HelpWML|section]], [[DirectActionsWML|set_recruit]],
[[InternalActionsWML|set_variable]], [[SideWML|side]], [[ThemeWML|side_playing]], [[SavefileWML|snapshot]],
[[InterfaceActionsWML|sound]], [[ReplayWML|source]],
[[StatisticalScenarioWML#The_.5Bstatistics.5D_tag|statistics]],
[[ThemeWML|status]], [[DirectActionsWML|stone]], [[InternalActionsWML|store_gold]], [[InternalActionsWML|store_locations]],
[[InternalActionsWML|store_starting_location]], [[InternalActionsWML|store_unit]], [[IntroWML|story]];
|-
|''T:''
[[AiWML|target]],
[[StatisticalScenarioWML#The_.5Bteam.5D_tag|team]],
[[DirectActionsWML|teleport]], [[UnitWML|teleport_anim]],
[[TerrainWML|terrain]], [[DirectActionsWML|terrain]], [[TerrainGraphicsWML|terrain_graphics]], [[ScenarioWML#Test_scenario|test]],
[[CampaignWML#The_.5Btextdomain.5D_tag|textdomain]], [[ThemeWML|theme]], [[InternalActionsWML|then]],
[[TerrainGraphicsWML|tile]], [[TimeWML|time]], [[ScenarioWML|time_area]], [[ThemeWML|time_of_day]],
[[HelpWML|topic]], [[HelpWML|toplevel]], [[SingleUnitWML|trait]], [[ThemeWML|turn]], [[ScenarioWML|tutorial]];
|-
|''U:''
[[InterfaceActionsWML|unhide_unit]], unit ([[UnitWML|define]], [[SingleUnitWML|create]]),
[[ThemeWML|unit_abilities]], [[ThemeWML|unit_alignment]], [[ThemeWML|unit_description]],
[[ThemeWML|unit_hp]], [[ThemeWML|unit_image]], [[ThemeWML|unit_level]], [[ThemeWML|unit_moves]],
[[InterfaceActionsWML|unit_overlay]], [[ThemeWML|unit_profile]], [[ThemeWML|unit_status]],
[[ThemeWML|unit_traits]], [[ThemeWML|unit_type]], [[ThemeWML|unit_weapons]], [[ThemeWML|unit_xp]],
[[UnitsWML|units]], [[DirectActionsWML|unstone]], [[DirectActionsWML|unstore_unit]], [[ThemeWML|upkeep]];
|-
| ''V:''
[[InternalActionsWML|variable]], [[VariablesWML|variables]], [[SideWML|village]], [[ThemeWML|villages]];
|-
| ''W:''
[[InternalActionsWML|while]]
|}