Difference between revisions of "UsefulWMLFragments"

From The Battle for Wesnoth Wiki
(Junk removal.)
(Add some caveats)
Line 6: Line 6:
  
 
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.
 
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 [http://www.wesnoth.org/misc/macro-reference.xhtml the core macro library].
 +
* Don't add macros that are trivial syntax shortcuts.
 +
* Don't write macros that generate unbalanced syntax fragments.
  
 
=== Logic Structure Macros ===
 
=== Logic Structure Macros ===

Revision as of 16:20, 26 February 2008


Attention: This page has been marked for review for version 1.4. The information contained here appears to be outdated or obsolete.

If you can, please take the time to review and edit it to bring it up to date (if needed) for the lastest version of Wesnoth. For more information and discussion, check the appropriate thread in the fora.

Once this is done, remove this notice


Useful WML Fragments

NOTES ABOUT ADDING PAGES: try not to add new pages here. Find a category in which your code fits and add it to that page.

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 write macros that generate unbalanced syntax fragments.

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