Difference between revisions of "UsefulWMLFragments"

From The Battle for Wesnoth Wiki
(No longer Obsolete)
m (Useful WML Fragments)
Line 6: Line 6:
 
* Don't add macros that duplicate things in [http://www.wesnoth.org/misc/macro-reference.xhtml the core macro library].
 
* Don't add macros that duplicate things in [http://www.wesnoth.org/misc/macro-reference.xhtml the core macro library].
 
* Don't add macros that are trivial syntax shortcuts.
 
* Don't add macros that are trivial syntax shortcuts.
* Don't write macros that generate unbalanced syntax fragments.
+
* Don't add macros that generate unbalanced syntax fragments.
  
 
Try to avoid adding pages here. It is better to find a category in which your code fits and add it to that page.
 
Try to avoid adding pages here. It is better to find a category in which your code fits and add it to that page.

Revision as of 16:36, 26 February 2008

Useful WML Fragments

Most of the things found here are macros (see PreprocessorRef) that must be copied into a scenario file or another file included first by the campaign, and then used in the scenario (or multiplayer map). Remember that a macro cannot be used at a point before it is defined.

Some things not to do here:

  • Don't add macros that duplicate things in the core macro library.
  • Don't add macros that are trivial syntax shortcuts.
  • Don't add macros that generate unbalanced syntax fragments.

Try to avoid adding pages here. It is better to find a category in which your code fits and add it to that page.

Logic Structure Macros

  • WML Utilities: Macros to assist other macros. Store Unit Attribute. Filter by Terrain. Iterate. Overlay with Filter. Determine Opposite Coordinates.

Campaign Tools

  • Victory Conditions: Number of Villages, Amount of Gold. Suitable for multiplayer scenarios.

Map Tools

Unit Tools

  • MoveExistingUnit: Move a unit from one place to another, displaying its movement. Move Unit 1. Move Unit 2. Move Unit 3.
  • WML Abilities: Knockback. Charm. Bloodlust. Abilities cannot currently be incorporated in the unit type definitions themselves, but must be included in the scenario file.
  • WML Buildings: Generic Buildings, Light House/Dark Tower, Wishing Well #1, Wishing Well #2.

Item Tools

  • DroppableItem: Macros to drop items. Currently only macros for dropping items on unit death including a permenant item that can be picked up, and dropped, multiple times by different units.

Advanced WML

  • Advanced WML: Branch on Village Type. Recruit from a Ship. Point Rotation Scheme.


Templates

  • WML Templates: Generic campaign, scenario and unit templates. (updated)

See Also