The Battle for Wesnoth Wiki - User contributions [en]

Wesnoth Acronyms and Slang

2009-04-17T16:16:58Z

Jequ: /* Unit Names */ added pyro

Use the following list to demystify the various (mostly wesnoth specific) acronyms you may run into at the forum.



== Names of Mainline Campaigns and Scenarios ==

*AoI - "An Orcish Incursion"
*DiD - "Descent into Darkness"
*EI - "The Eastern Invasion"
*HttT - "Heir to the Throne"
** BoP - "Bay of Pearls"
** DD - "Dwarven Doors"
** HotNE - "Home of the North Elves"
** IotD - "Isle of the Damned"
** RtW - "Return to Wesnoth"
** SoE - "Siege of Elensefar"
** SoF - "Scepter of Fire"
** TotC - "Test of the Clans"
** VoD - "Valley of Death"
*LoW - "Legend of Wesmere"
*NR - "Northern Rebirth"
*SoF - "Sceptre of Fire"
*SotBE - "Son of the Black Eye"
*TB - "A Tale of Two Brothers"
*THoT - "The Hammer of Thursagan"
*TRoW - "The Rise of Wesnoth"
*TSG - "The South Guard"
*UtBS - "Under the Burning Suns"

== Unofficial Campaigns ==

*FtF - "Flight to Freedom" (campaign name)
*IftU - "Invasion from the Unknown" (campaign name)
*SE - "Saving Elensefar" (campaign name)

== Unit Names ==

*bird - usually Gryphon Rider/Master (knaglans), or occasionally a Falcon or Eagle Rider from the [[Extended Era]] Aragwaith and Kalifa factions.
*DA - Dark Adept (undead)
*fish - Merman (loyalists or rebels) or Naga Fighter (northerners)
*gobo - An affectionate, if somewhat derogatory term for the Goblin Spearman
*gunner - Dwarvish Thunderer/Thunderguard/Dragonguard (knaglans)
*HI - Heavy Infantryman (loyalists)
*MoL - Mage of Light (loyalists or rebels)
*pyro - Unit in the Drake Burner line
*Ulf - Dwarvish Ulfserker (knaglans)
*WC - Walking Corpse (undead)
*zombie - Walking Corpse

== Other, Wesnoth-specific ==

*AMLA - After Maximum Level Advancement
*AoH - Age of Heroes
*BfW - Battle for Wesnoth (the name of the game)
*BWH - Been suggested before. We think it's a good idea. Hope to add it eventually.
*CABD - Can Already Be Done, e.g., you can already create custom unit abilities via WML.
*CtH - Chance to Hit (also C2H)
*CtBH - Chance to Be Hit (also C2BH)
*CtK - Chance to Kill (also C2K)
*CtBK - Chance to Be Killed (also C2BK)
*EP - Elvish Pillager, moderator and great man :) at forum
*FoW - Fog of War (i.e. fog)
*FFA - Free For All (playing a map with >2 players without teams)
*FPI - Frequently Posted Idea (read the [http://www.wesnoth.org/forum/viewtopic.php?t=1158|FPI Post] from the Ideas Forum)
*HANE—EtH - Hexes Are Not Evil - Embrace the Hex
*HAPMA - Hexes Are Possibly Miles Across - http://www.wesnoth.org/forum/viewtopic.php?t=1882
*HP - Hit points
*IIRWIIR - It Is Ready When It Is Ready
*KISS - Keep It Simple, Stupid: Applies to coding, not game rules (although indirectly it does): see [[WesnothPhilosophy]]
*MP - Multiplayer or Movement Points
*N3T - No 3-Teams; A belief stating that contests between three equal and opposing forces are inherently unbalanced
*OAB - Options Are Bad; In reference to gameplay, not user interface options. Mostly used by Turin. See also [[FrequentlyProposedIdeas]] (idea #1)
*OFWRA - Old Flame War Revival Alert; In other words, we have discussed this before and have no interest in discussing it again, especially if it got ugly
* OOS - Out Of Synch - an error generated by Wesnoth. OOS errors occur when game data for one player is different/incompatible from the others
* PoD - Paths of Daggers, the name of a 2v2 multiplayer map.
*RiPLIB - Reduction in Power when Levelling Is Bad: means that when a unit upgrades, at least one of its options should be strictly superior to the original unit. [http://www.wesnoth.org/forum/viewtopic.php?t=1423 Reference 1] / [http://www.wesnoth.org/forum/viewtopic.php?t=7205 Reference 2]
*RPG - Role Playing Game - [http://www.wesnoth.org/forum/viewtopic.php?t=4385 1)] Wesnoth's experience system. <nowiki>2)</nowiki> An "RPG-style" game on the MP server means the primary focus will be walking your leader-units through a scripted storyline involving map exploration and lots of WML.
*SLF - [[StandardLocationFilter]]
*SP - Single Player (Campaigns)
*SUF - [[StandardUnitFilter]]
*ToD - Time of Day
*TWP - The Wesnoth Philosophy: [[WesnothPhilosophy]]
*UMC - User Made Campaign or User Made Content (any add-on not packaged with Wesnoth)
*WICOT - WML is capable of this (the requested feature is already possible to script, so no need to hard-code it in C++)
*WINR - Wesnoth Is Not Realistic
*WIN_ - Wesnoth Is Not... (Warcraft, Lord of the Rings, medieval Europe, an RPG, a wargame, a war simulation, etc.)
*WML - Wesnoth Markup Language: [[ReferenceWML]]
*XP - Experience
*ZoC - Zone of Control

== General Acronyms ==

*AFaICT - As Far as I Can Tell (A statement with a disclaimer on truthfulness)
*AFaIK - As Far as I Know (A statement with a disclaimer on truthfulness)
*AfK - Away from the Keyboard
*ASaP - As Soon as Possible
*BRB - Be Right Back
*BtW - By the Way (A statement with a disclaimer on relevance)
*EV - Expected Value
*FYI - For Your Information
*GtG - Got to Go
*IIRC - If I Recall Correctly (A statement with a disclaimer on truthfulness)
*IMHO - In My Humble Opinion (A statement with a disclaimer on objectiveness)
*IMO - In My Opinion
*IYSWIM - If You See What I Mean (A statement seeking agreement)
*LTNS - Long Time No See
*OMG - Oh My God
*OT - Off Topic: can refer either to the forum category (http://www.wesnoth.org/forum/viewforum.php?f=11) or to spam
*OtOH - On the Other Hand (A contrast)
*RotFL - Rolling on the Floor Laughing; also RoFL
*RNG - Random Number Generator
*RtFM - Read the F***ing Manual
*RTS - Real Time Strategy Game - as opposed to a turn-based game like Wesnoth
*SVN - Subversion -- the bleeding-edge up-to-the-minute current version of Wesnoth [[WesnothSVN]] ([[What_Is_SVN]])
*TBS - Turn Based Strategy Game, like Wesnoth

[[Category:World of Wesnoth]]

Template:WML Tags

2009-01-12T18:35:21Z

Jequ:

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

|-
|''A:''
[[AbilitiesWML|abilities]],
[[CampaignWML#The_.5Babout.5D_tag|about]],
[[UnitWML|advancefrom]],
[[UnitWML|advancement]],
[[StatisticalScenarioWML|advances]],
[[AiWML|ai]],
[[DirectActionsWML|allow_recruit]],
[[DirectActionsWML|allow_undo]],
[[InterfaceActionsWML|animate_unit]],
[[AnimationWML|animation]],
[[VariablesWML|array]],
[[UnitWML|attack]],
[[AnimationWML|attack_filter]],
[[StatisticalScenarioWML|attacks]],
[[AiWML|avoid]];
|-
|''B:''
[[UnitWML|base_unit]],[[CampaignWML#The_.5Bbinary_path.5D_tag|binary_path]],[[HelpWML|bold]], [[EditorWML|brush]];
|-
|''C:''
[[CampaignWML#The_.5Bcampaign.5D_tag|campaign]], [[DirectActionsWML|capture_village]], [[ReplayWML|choose]],
[[InternalActionsWML|clear_variable]],
[[InterfaceActionsWML|colour_adjust]],
command([[InterfaceActionsWML|action]], [[ReplayWML|replay]]);
|-
|''D:''
[[AbilitiesWML|damage]],[[StatisticalScenarioWML|deaths]],[[InterfaceActionsWML|debug_message]],[[UnitWML|defend]],[[StatisticalScenarioWML|defends]],
[[UnitWML|defense]],
[[InterfaceActionsWML|delay]],
[[ReplayWML|destination]],
[[DirectActionsWML|disallow_recruit]],
[[InternalActionsWML|do]];
|-
|''E:''
[[EditorWML|editor_group]], [[EditorWML|editor_music]],
[[EditorWML|editor_times]], [[EditorWML|editor_tool_hint]],
[[EffectWML|effect]],[[InternalActionsWML|else]],[[ReplayWML|end_turn]],
[[DirectActionsWML|endlevel]],
end_turn ([[DirectActionsWML|action]], [[ReplayWML|replay]]),
[[EraWML|era]],
[[EventWML|event]],
[[ThemeWML|expenses]];
|-
|''F:''
[[FilterWML|filter]], [[FilterWML|filter_location]], [[FilterWML|filter_second]], [[FilterWML|filter_vision]], [[InternalActionsWML|fire_event]], [[HelpWML|format]], [[AnimationWML|frame]];
|-
|''G:''
[[GameConfigWML|game_config]], [[ScenarioWML|generator]], [[DirectActionsWML|gold]], [[ThemeWML|gold]];
|-
|''H:''
[[InternalActionsWML|have_unit]], [[HelpWML|header]], [[DirectActionsWML|heal_unit]],[[InterfaceActionsWML|hide_unit]];
|-
|''I:''
[[InternalActionsWML|if]], [[TimeWML|illuminated_time]], [[TerrainGraphicsWML|image]],
[[HelpWML|img]], [[ThemeWML|income]], [[InternalActionsWML|insert_tag]], [[HelpWML|italic]], [[InterfaceActionsWML|item]];
|-
|''J:''
[[HelpWML|jump]], [[InternalActionsWML|join]];
|-
|''K:''
[[DirectActionsWML|kill]], [[StatisticalScenarioWML|killed]];
|-
|''L:''
[[LabelWML|label]] ([[InterfaceActionsWML|map]], [[ThemeWML|theme]]), [[LanguageWML|language]], [[AiWML|leader_goal]];
|-
|''M:''
[[ThemeWML|main_map]],[[ThemeWML|menu]], [[InterfaceActionsWML|message]], [[ThemeWML|mini_map]],
[[AnimationWML|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:''
[[AnimationWML|neighbour_unit_filter]], [[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]], recall ([[DirectActionsWML|action]], [[ReplayWML|replay]]), [[StatisticalScenarioWML|recalls]],
[[ReplayWML|recruit]], [[StatisticalScenarioWML|recruits]], [[InterfaceActionsWML|redraw]],
[[HelpWML|ref]], [[DirectActionsWML|remove_shroud]], [[InterfaceActionsWML|remove_unit_overlay]],
[[InterfaceActionsWML|removeitem]], [[InterfaceActionsWML|remove_sound_source]], [[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]], [[AnimationWML|secondary_attack_filter]], [[AnimationWML|secondary_unit_filter]], [[HelpWML|section]],
[[InterfaceActionsWML#.5Bset_menu_item.5D_.28SVN_trunk_only.29|set_menu_item]], [[DirectActionsWML|set_recruit]],
[[InternalActionsWML|set_variable]], [[InternalActionsWML|set_variables]],
[[SideWML|side]], [[ThemeWML|side_playing]], [[SavefileWML|snapshot]],
[[InterfaceActionsWML|sound]], [[InterfaceActionsWML|sound_source]], [[ReplayWML|source]], [[EventWML|special_filter]], [[EventWML|special_filter_second]],
[[InternalActionsWML|split]],
[[StatisticalScenarioWML#The_.5Bstatistics.5D_tag|statistics]],
[[ThemeWML|status]], [[DirectActionsWML|stone]], [[InternalActionsWML|store_gold]], [[InternalActionsWML|store_locations]],
[[InternalActionsWML|store_map_dimensions]],
[[InternalActionsWML|store_starting_location]], [[InternalActionsWML|store_side]], [[InternalActionsWML|store_time_of_day]], [[InternalActionsWML|store_unit]], [[InternalActionsWML|store_villages]] [[IntroWML|story]];
|-
|''T:''
[[AiWML|target]],
[[StatisticalScenarioWML#The_.5Bteam.5D_tag|team]],
[[DirectActionsWML|teleport]], [[UnitWML|teleport_anim]],
terrain([[TerrainWML|define]], [[DirectActionsWML|create]]), [[TerrainGraphicsWML|terrain_graphics]], [[TerrainMaskWML|terrain_mask]], [[ScenarioWML#Test_scenario|test]],
[[WesCamp|textdomain]], [[InterfaceActionsWML|text_input]], [[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]], [[AnimationWML|unit_filter]], [[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]], [[FilterWML|wml_filter]]
|}

TerrainMaskWML

2009-01-12T18:30:55Z

Jequ: Tag list and some little fixes

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

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

* '''x,y''': the x,y location in the scenario map to place the top-left corner of the mask onto
* '''mask''': a Wesnoth map; see [[BuildingMaps]].
* {{DevFeature}} '''border''': (default=no) Overlay on the border as well as the playable map area. The mask used must have a border_size equal to the map's border size (i.e. it must be a normal map), otherwise it will be ignored
* '''[rule]''': specifies a rule for blending the mask with the scenario.
The terrain on each hex fitting the rule will be changed to the terrain specified in the rule.
** '''old''': a comma-separated list of terrain codes. The rule fits only those hexes that have one of these terrains in the scenario.
** '''new''': a list of terrain letters. The rule fits only those hexes with this terrain specified in the mask.
** '''terrain''': the letter of the terrain to change hexes which fit this rule (i.e. for which the '''new''' terrain code in the mask falls on top of the '''old''' terrain in the scenario) into.
** {{DevFeature}} '''layer''': (overlay|base|both, default=both) only change the specified layer.
** {{DevFeature}} '''replace_if_failed''': (default=no) When replacing just one layer failed, try to replace the whole terrain. If '''terrain''' is an overlay only terrain, use the default_base as base layer. If the terrain has no default base, do nothing.

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

<pre>
[terrain_mask]
x,y=12,10
mask="border_size=1
usage=map

Re, Re, _f, _f, _f, _f, _f, _f, _f, _f, _f, _f
Re, Re, _f, _f, _f, _f, _f, _f, _f, _f, _f, _f
Re, Re, _f, _f, _f, _f, _f, _f, _f, _f, _f, _f
_f, _f, Re, _f, _f, _f, _f, _f, _f, _f, _f, _f
_f, _f, Re, _f, _f, _f, _f, _f, _f, _f, _f, _f
Re, Re, _f, _f, _f, _f, _f, _f, _f, _f, _f, _f
_f, _f, Re, _f, _f, Re, Re, _f, _f, _f, _f, _f
_f, _f, _f, Re, Re, Re, _f, Re, Re, _f, _f, _f
_f, _f, _f, _f, _f, _f, _f, Re, _f, _f, _f, _f
_f, _f, _f, _f, _f, _f, _f, Re, Re, _f, _f, _f
_f, _f, _f, _f, _f, _f, _f, Re, Re, Re, Re, Re
_f, _f, _f, _f, _f, _f, _f, Re, Re, Re, Re, Re
"
[/terrain_mask]
</pre>

For instance, suppose you want snow to fall in an area. You want villages (v) to turn into snowed-villages (V), forest
(f) to turn into snowed-forest (F), hills
(h) to turn into snowed-hills (H), and grassland (g) and roads (r) to turn into snow (S), while other terrain remains
untouched. You could look over your
destination map and work out which terrain type is which and draw your mask, but that's alot of effort, you want to just
draw a simple mask which has
areas of snow and areas of no snow, and make the game work out the rest.

You can do it like this:

[terrain_mask]
x,y=1,1
mask="border_size=1
usage=map

_f, _f, Aa, _f, _f, _f, Aa, _f, _f
_f, _f, Aa, _f, _f, _f, Aa, _f, _f
_f, _f, Aa, _f, Aa, _f, Aa, _f, _f
Aa, Aa, _f, _f, Aa, Aa, Aa, _f, _f
_f, _f, Aa, Aa, Aa, Aa, Aa, Aa, Aa
_f, _f, _f, Aa, Aa, Aa, Aa, Aa, Aa
_f, _f, _f, _f, Aa, Aa, _f, _f, _f
_f, _f, _f, _f, Aa, Aa, _f, _f, _f"
[rule]
old=Gg^Vh
new=Aa
terrain=Aa^Vha
[/rule]
[rule]
old=Gs^Fp
new=Aa
terrain=Aa^Fpa
[/rule]
[rule]
old=Hh
new=Aa
terrain=Ha
[/rule]

[rule]
old=Gg,Re
new=Aa
#don't specify terrain and it just uses the new terrain
[/rule]

#default: Will match everything, since 'old' and 'new' aren't
#specified. Set 'use_old=yes' to signal no change.
[rule]
use_old=yes
[/rule]
[/terrain_mask]

WML Abilities

2009-01-10T15:56:01Z

Jequ: works ability

Remember that you must include the WML ability code in every scenario where you intend them to work. Or include them in the unit file inside the [unit] tag.

Some abilities require macros from [[WML_Utilities|Utilities]].

=== Knockback ===

When a unit is hit with a ''knockback'' attack, it is immediately pushed one hex away from the attacker, at which point the combat ends. Exception: units in villages can't be knocked out of them.

Examples that give ''knockback'' for every Drake Glider on their slam attack, and for the Shock Trooper named Jane:
{KNOCKBACK (type=Drake Glider) slam}
{KNOCKBACK description=Jane mace}

Requires the macro ''OPPOSITE_SIDE''.

#define KNOCKBACK FILTER WEAPON
[event]
name=attacker_hits
first_time_only=no

[filter]
{FILTER}
[/filter]

[special_filter]
weapon={WEAPON}
[/special_filter]

[sound]
name=ghoul-hit.wav
[/sound]

{OPPOSITE_SIDE $x2 $y2 $x1 $y1 target_hex}

[store_locations]
x,y=$x2,$y2
terrain=AaBbDeLptUVvYZ
variable=defender_in_village
[/store_locations]
[if]
[have_unit]
x,y=$target_hex.x,$target_hex.y
[/have_unit]
[else]
{IF_VAR defender_in_village.length not_equals 1 (
[then]
{STORE_UNIT_VAR x,y=$x2,$y2 side side_of_defender}

[teleport]
[filter]
x,y=$x2,$y2
[/filter]

x,y=$target_hex.x,$target_hex.y
[/teleport]

[capture_village]
side=$side_of_defender
x,y=$target_hex.x,$target_hex.y
[/capture_village]

{CLEAR_VARIABLE side_of_defender}
[/then]
)}
[/else]
[/if]

{CLEAR_VARIABLE target_hex}
{CLEAR_VARIABLE defender_in_village}
[/event]
#enddef

=== Charm ===

When a unit is hit with a ''charm'' attack, it instantly jumps to the attacker's side, and returns to it's original side at the beginning of that side's turn. A charmed unit has 1 movement point and can attack.

Example that makes all Troll Whelps have charm on their attack:

{CHARM (type=Troll Whelp) fist}

#define CHARM FILTER WEAPON
[event]
name=attacker_hits
first_time_only=no

[filter]
{FILTER}
[/filter]

[special_filter]
weapon={WEAPON}
[/special_filter]

{STORE_UNIT_VAR x,y=$x1,$y1 side charmer_side}
{STORE_UNIT_VAR x,y=$x2,$y2 side charmed_side}

{IF_VAR charmer_side not_equals $charmed_side (
[then]
{MODIFY_UNIT x,y=$x2,$y2 variables.real_side $charmed_side}
{MODIFY_UNIT x,y=$x2,$y2 side $charmer_side}
{MODIFY_UNIT x,y=$x2,$y2 moves 1}
{MODIFY_UNIT x,y=$x2,$y2 attacks_left 1}

{VARIABLE_OP varname format "side_$charmed_side|_units_charmed"}
{VARIABLE $varname yes}

{CLEAR_VARIABLE varname}
[/then]
)}

{CLEAR_VARIABLE charmer_side}
{CLEAR_VARIABLE charmed_side}
[/event]

[event]
name=side turn
first_time_only=no

{VARIABLE_OP this_side_charmed to_variable "side_$side_number|_units_charmed"}

{IF_VAR this_side_charmed equals yes (
[then]
[store_unit]
[filter]
[not]
side=$side_number
[/not]
[/filter]

variable=possibly_charmed
kill=no
[/store_unit]

{FOREACH possibly_charmed i}
{VARIABLE_OP real_side format "0$possibly_charmed[$i].variables.real_side"}

{IF_VAR real_side not_equals "0" (
[then]
{IF_VAR side_number equals $possibly_charmed[$i].variables.real_side (
[then]
{CLEAR_VARIABLE possibly_charmed[$i].variables.real_side}
{VARIABLE possibly_charmed[$i].side $side_number}

[unstore_unit]
variable=possibly_charmed[$i]
find_vacant=no
[/unstore_unit]
[/then]
)}
[/then]
)}
{NEXT i}

{CLEAR_VARIABLE possibly_charmed}
[/then]
)}
[/event]
#enddef

=== Bloodlust ===

Bloodlust is a very simple ability. If a unit that has bloodlust kills an enemy unit when attacking, it may attack again, provided that there are more enemy units adjacent to it.

This would give the bloodlust ability to all Dwarvish Ulfserkers (making them insanely powerful):

{BLOODLUST (type=Dwarvish Ulfserker)}

#define BLOODLUST FILTER
[event]
name=die
first_time_only=no

[filter_second]
{FILTER}
[/filter_second]

{MODIFY_UNIT x,y=$x2,$y2 moves 0}
{MODIFY_UNIT x,y=$x2,$y2 attacks_left 1}
[/event]
#enddef

=== Pickpocket ===

This special could also be called loot. When a unit with this attack special sucessfully hits an enemy unit, it gains a certain amount of gold - say 10.

To do this, use this code:

#define WEAPON_SPECIAL_PICKPOCKET
[damage]
id=pickpocket
name="Pickpocket"
description="When used offensively, this attack gives 10 gold to the attacker on every successful hit."
multiply=1
[/damage]
#enddef

Then put this event in your scenario:

[event]
name=attacker_hits
first_time_only=no
[filter]
side=$side_number
canrecruit=yes
[/filter]
[special_filter]
weapon=pickpocket gloves
[/special_filter]
[gold]
side=$side_number
amount=10
[/gold]
[/event]

Then give the unit you want to have the "pickpocket" special something like this:

[object]
silent=yes
[effect]
apply_to=new_attack
name=pickpocket gloves
type=impact
range=melee
damage=3
number=3
[specials]
{WEAPON_SPECIAL_PICKPOCKET}
[/specials]
[/effect]
[/object]

===Soultaker===

Any unit with this ability will gain an additional point of damage per strike every time it kills an enemy. Coder(s) unknown, made for Melon's Youkai faction (http://www.wesnoth.org/forum/viewtopic.php?f=19&t=20100).

To give a unit the ability, place the following in any .cfg file loaded by the campaign or era:

#define ABILITY_SOULTAKER
[dummy]
id=soultaker
name= _ "soultaker"
description=_ "Soultaker:
This unit gains an additional point added to its maximum damage whenever it kills a living unit."
[/dummy]

[/abilities]
[event]
name=die
first_time_only=no
[filter]
[not]
[wml_filter]
[status]
not_living="yes"
[/status]
[/wml_filter]
[/not]
[/filter]

[filter_second]
ability=soultaker
[/filter_second]

[unstore_unit]
variable=second_unit
{COLOR_HEAL}
text= _ "+1 damage"
find_vacant=no
[/unstore_unit]

[object]
silent=yes
duration=forever
[filter]
x,y=$x2,$y2
[/filter]

[effect]
apply_to=attack
range=melee
increase_damage=1
increase=1
[/effect]
[/object]
[/event]

[+abilities]
#enddef

And the following in the unit's [abilities] tag:

{ABILITY_SOULTAKER}

===Charm (Type 2)===

An attack special. If the attack hits, and the target is level 0 or 1, the target is converted to the attacker's side. However, if it misses, the attacker is converted to the defender's side. Maintainer is krotop, using 1.4.X syntax, made for Melon's Youkai faction (http://www.wesnoth.org/forum/viewtopic.php?f=21&t=22539)

#define ABILITY_CHARM WEAPON
# dummy ability, defining the ability id for the next filters
[dummy]
id=charm_attack
[/dummy]

[/abilities]

# event that creates a variable at the beginning of the fight to check if the attacker hit at least once by the end.
[event]
name=attack
first_time_only=no

[filter]
ability=charm_attack
[/filter]
[special_filter]
weapon={WEAPON}
[/special_filter]

[store_unit]
[filter]
x,y=$x1,$y1
[/filter]
variable=unit_att_with_charm
mode=append
[/store_unit]
[set_variable]
name=unit_att_with_charm.variables.charm_has_worked
value=no
[/set_variable]
[unstore_unit]
variable=unit_att_with_charm
[/unstore_unit]

{CLEAR_VARIABLE unit_att_with_charm}

[/event]

# event that creates a "charm has worked" variable
# and sets it to "yes" if the attacker hits at least once.
[event]
name=attacker_hits
first_time_only=no

[filter]
ability=charm_attack
[/filter]
[special_filter]
weapon={WEAPON}
[/special_filter]

[store_unit]
[filter]
x,y=$x1,$y1
[/filter]
variable=unit_att_with_charm
mode=append
[/store_unit]
[set_variable]
name=unit_att_with_charm.variables.charm_has_worked
value=yes
[/set_variable]
[unstore_unit]
variable=unit_att_with_charm
[/unstore_unit]

{CLEAR_VARIABLE unit_att_with_charm}

[/event]

# event that shifts a unit to the other side
# if the defending unit
# - was not lvl1 or lvl0
# - and was not a recruiting unit
# - and was a not a "non-living" creature
# then :
# -> if the attacker missed all attacks, it goes to the defender side.
# -> if the attacker hit once at least, the defender goes to the attacker side.
[event]
name=attack_end
first_time_only=no

[filter]
ability=charm_attack
[/filter]
[special_filter]
weapon={WEAPON}
[/special_filter]
[filter_second]
canrecruit=no
[and]
level=0
[or]
level=1
[/or]
[/and]
[and]
[not]
[wml_filter]
[status]
not_living=yes
[/status]
[/wml_filter]
[/not]
[/and]
[/filter_second]

[store_unit]
[filter]
x,y=$x1,$y1
[/filter]
variable=charmer
mode=append
[/store_unit]

[store_unit]
[filter]
x,y=$x2,$y2
[/filter]
variable=charmed
mode=append
[/store_unit]

[if]
[variable]
name=charmer.variables.charm_has_worked
equals=no
[/variable]
[then]
[set_variable]
name=charmer.side
value=$charmed.side
[/set_variable]
[/then]
[else]
[set_variable]
name=charmed.side
value=$charmer.side
[/set_variable]
[/else]
[/if]

[unstore_unit]
variable=charmer
[/unstore_unit]
[unstore_unit]
variable=charmed
[/unstore_unit]

{CLEAR_VARIABLE charmer}
{CLEAR_VARIABLE charmed}

[/event]

[+abilities]

#enddef

#define WEAPON_SPECIAL_CHARM
# dummy weapon special used to describe the effect to the user

[damage]
id=weapon_charm
name= _ "charm"
name_inactive= _ "charm"
description= _ "Charm :
Turns a living level 1 or level 0 unit to your side. Beware if all of your attacks miss, the charm user turns to the defender side, even if it is your leader. You can not charm an ennemy leader or a non-living creature."
description_inactive= _ "Charm :
Turns a living level 1 or level 0 unit to your side. Beware if all of your attacks miss, the charm user turns to the defender side, even if it is your leader. You can not charm an ennemy leader or a non-living creature."
apply_to=opponent
[/damage]

#enddef

== Works ==

Unit with ability ''works'' will produce 1 gold per turn.

Put this macro into you code before the last piece of code.
<pre>
#define ABILITY_WORKS
[leadership]
value=0
id=peasant_works
cumulative=no
name="works"
description= _ "Works:
This unit produces 1 gold per turn."
[/leadership]
#enddef
</pre>

Put this event into your code.
<pre>
[event]
name=side turn
first_time_only=no
[store_unit]
[filter]
#your filter here... for example type=Peasant
[/filter]
variable=worker
kill=no
[/store_unit]

{FOREACH worker i}

[gold]
side=$side_number
amount=1
[/gold]
[unstore_unit]
variable=worker[$i]
text="1"
red,green,blue=255,255,0
[/unstore_unit]

{NEXT i}

{CLEAR_VARIABLE worker}
[/event]
</pre>

And give the unit the ability like this
<pre>
[object]
silent=yes
[effect]
apply_to=new_ability
[abilities]
{ABILITY_WORKS}
[/abilities]
[/effect]
[/object]
</pre>

== See Also ==

* [[UsefulWMLFragments]]
* [[ReferenceWML]]

[[Category: UsefulWMLFragments]]

Template:WML Tags

2009-01-08T14:52:56Z

Jequ: recall tag

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

|-
|''A:''
[[AbilitiesWML|abilities]],
[[CampaignWML#The_.5Babout.5D_tag|about]],
[[UnitWML|advancefrom]],
[[UnitWML|advancement]],
[[StatisticalScenarioWML|advances]],
[[AiWML|ai]],
[[DirectActionsWML|allow_recruit]],
[[DirectActionsWML|allow_undo]],
[[InterfaceActionsWML|animate_unit]],
[[AnimationWML|animation]],
[[VariablesWML|array]],
[[UnitWML|attack]],
[[AnimationWML|attack_filter]],
[[StatisticalScenarioWML|attacks]],
[[AiWML|avoid]];
|-
|''B:''
[[UnitWML|base_unit]],[[CampaignWML#The_.5Bbinary_path.5D_tag|binary_path]],[[HelpWML|bold]], [[EditorWML|brush]];
|-
|''C:''
[[CampaignWML#The_.5Bcampaign.5D_tag|campaign]], [[DirectActionsWML|capture_village]], [[ReplayWML|choose]],
[[InternalActionsWML|clear_variable]],
[[InterfaceActionsWML|colour_adjust]],
[[ReplayWML|command]];
|-
|''D:''
[[AbilitiesWML|damage]],[[StatisticalScenarioWML|deaths]],[[InterfaceActionsWML|debug_message]],[[UnitWML|defend]],[[StatisticalScenarioWML|defends]],
[[UnitWML|defense]],
[[InterfaceActionsWML|delay]],
[[ReplayWML|destination]],
[[DirectActionsWML|disallow_recruit]],
[[InternalActionsWML|do]];
|-
|''E:''
[[EditorWML|editor_group]], [[EditorWML|editor_music]],
[[EditorWML|editor_times]], [[EditorWML|editor_tool_hint]],
[[EffectWML|effect]],[[InternalActionsWML|else]],[[ReplayWML|end_turn]],
[[DirectActionsWML|endlevel]],
end_turn ([[DirectActionsWML|action]], [[ReplayWML|replay]]),
[[EraWML|era]],
[[EventWML|event]],
[[ThemeWML|expenses]];
|-
|''F:''
[[FilterWML|filter]], [[FilterWML|filter_location]], [[FilterWML|filter_second]], [[FilterWML|filter_vision]], [[InternalActionsWML|fire_event]], [[HelpWML|format]], [[AnimationWML|frame]];
|-
|''G:''
[[GameConfigWML|game_config]], [[ScenarioWML|generator]], [[DirectActionsWML|gold]], [[ThemeWML|gold]];
|-
|''H:''
[[InternalActionsWML|have_unit]], [[HelpWML|header]], [[DirectActionsWML|heal_unit]],[[InterfaceActionsWML|hide_unit]];
|-
|''I:''
[[InternalActionsWML|if]], [[TimeWML|illuminated_time]], [[TerrainGraphicsWML|image]],
[[HelpWML|img]], [[ThemeWML|income]], [[InternalActionsWML|insert_tag]], [[HelpWML|italic]], [[InterfaceActionsWML|item]];
|-
|''J:''
[[HelpWML|jump]], [[InternalActionsWML|join]];
|-
|''K:''
[[DirectActionsWML|kill]], [[StatisticalScenarioWML|killed]];
|-
|''L:''
[[LabelWML|label]] ([[InterfaceActionsWML|map]], [[ThemeWML|theme]]), [[LanguageWML|language]], [[AiWML|leader_goal]];
|-
|''M:''
[[ThemeWML|main_map]],[[ThemeWML|menu]], [[InterfaceActionsWML|message]], [[ThemeWML|mini_map]],
[[AnimationWML|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:''
[[AnimationWML|neighbour_unit_filter]], [[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]], recall ([[DirectActionsWML|action]], [[ReplayWML|replay]]), [[StatisticalScenarioWML|recalls]],
[[ReplayWML|recruit]], [[StatisticalScenarioWML|recruits]], [[InterfaceActionsWML|redraw]],
[[HelpWML|ref]], [[DirectActionsWML|remove_shroud]], [[InterfaceActionsWML|remove_unit_overlay]],
[[InterfaceActionsWML|removeitem]], [[InterfaceActionsWML|remove_sound_source]], [[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]], [[AnimationWML|secondary_attack_filter]], [[AnimationWML|secondary_unit_filter]], [[HelpWML|section]],
[[InterfaceActionsWML#.5Bset_menu_item.5D_.28SVN_trunk_only.29|set_menu_item]], [[DirectActionsWML|set_recruit]],
[[InternalActionsWML|set_variable]], [[InternalActionsWML|set_variables]],
[[SideWML|side]], [[ThemeWML|side_playing]], [[SavefileWML|snapshot]],
[[InterfaceActionsWML|sound]], [[InterfaceActionsWML|sound_source]], [[ReplayWML|source]], [[EventWML|special_filter]], [[EventWML|special_filter_second]],
[[InternalActionsWML|split]],
[[StatisticalScenarioWML#The_.5Bstatistics.5D_tag|statistics]],
[[ThemeWML|status]], [[DirectActionsWML|stone]], [[InternalActionsWML|store_gold]], [[InternalActionsWML|store_locations]],
[[InternalActionsWML|store_map_dimensions]],
[[InternalActionsWML|store_starting_location]], [[InternalActionsWML|store_side]], [[InternalActionsWML|store_time_of_day]], [[InternalActionsWML|store_unit]], [[InternalActionsWML|store_villages]] [[IntroWML|story]];
|-
|''T:''
[[AiWML|target]],
[[StatisticalScenarioWML#The_.5Bteam.5D_tag|team]],
[[DirectActionsWML|teleport]], [[UnitWML|teleport_anim]],
terrain([[TerrainWML|define]], [[DirectActionsWML|create]]), [[TerrainGraphicsWML|terrain_graphics]], [[TerrainMaskWML|terrain_mask]], [[ScenarioWML#Test_scenario|test]],
[[WesCamp|textdomain]], [[InterfaceActionsWML|text_input]], [[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]], [[AnimationWML|unit_filter]], [[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]], [[FilterWML|wml_filter]]
|}