Difference between revisions of "ReferenceWMLSyntax"

From The Battle for Wesnoth Wiki
 
(Version Control: This section is obviously outdated. Instead link to DevFeature.)
 
(10 intermediate revisions by 6 users not shown)
Line 1: Line 1:
 +
{{WML Tags}}
 
== Wiki Syntax ==
 
== Wiki Syntax ==
 +
 +
==== Formatting ====
  
 
This page is an example of how these wikis should be formatted:
 
This page is an example of how these wikis should be formatted:
Line 6: Line 9:
  
 
* '''[tag]''' description of [tag]
 
* '''[tag]''' description of [tag]
** ''key'' description of ''key''.
+
** '''key''': description of ''key''.
"''key//" can refer either to the key ''key'' or the value of ''key''
+
"'''key'''" can refer either to the key ''key'' or the value of ''key''
* ''key2'' description of ''key2''
+
* '''key2''': description of ''key2''
** 'value' what happens when the attribute '''key2=value''' is set
+
** '''value''': what happens when the attribute '''key2=value''' is set
  
 
Example:
 
Example:
 
  [tag]
 
  [tag]
key=0
+
        key=0
 
  [/tag]
 
  [/tag]
 
  key2=value
 
  key2=value
 +
 +
==== Version Control ====
 +
 +
This wiki describes the stable version of Wesnoth, but also has marked notes about the development version. See [[DevFeature]].
 +
 +
==== Categorization ====
 +
 +
WML reference pages should be placed into the category "WML reference."  This allows someone to easily bring up all the WML-related pages at once.
 +
 +
To do this, add the text <nowiki>[[Category: WML Reference]]</nowiki> at the bottom of the page under the "See Also" section.
  
 
== See Also ==
 
== See Also ==
Line 21: Line 34:
 
* [[ReferenceWML]]
 
* [[ReferenceWML]]
  
 
+
[[Category: WML Reference]]
 
 

Latest revision as of 21:24, 31 December 2011

[edit]WML Tags

A:

abilities, about, add_ai_behavior, advance, advanced_preference, advancefrom, advancement, advances, affect_adjacent, ai, allied_with, allow_end_turn, allow_extra_recruit, allow_recruit, allow_undo, and, animate, animate_unit, animation, aspect, attack, attack_anim, attacks, avoid;

B:

base_unit, berserk, binary_path, break, brush;

C:

campaign, cancel_action, candidate_action, capture_village, case, chance_to_hit, change_theme, chat, checkbox, choice, choose, clear_global_variable, clear_menu_item, clear_variable, color_adjust, color_range, command (action, replay), continue, criteria;

D:

damage, death, deaths, default, defend, defends, defense, delay, deprecated_message, destination, difficulty, disable, disallow_end_turn, disallow_extra_recruit, disallow_recruit, do, do_command, drains, draw_weapon_anim;

E:

editor_group, editor_music, editor_times, effect, else (action, animation), elseif, endlevel, end_turn (action, replay), enemy_of, engine, entry (credits, options), era, event, extra_anim;

F:

facet, facing, fake_unit, false, feedback, female, filter (concept, event), filter_adjacent, filter_adjacent_location, filter_attack, filter_attacker, filter_base_value, filter_condition, filter_defender, filter_enemy, filter_location, filter_opponent, filter_own, filter_owner, filter_radius, filter_recall, filter_second, filter_second_attack, filter_self, filter_side, filter_vision, filter_weapon, filter_wml, find_path, fire_event, firststrike, floating_text, found_item, for, foreach, frame;

G:

game_config, get_global_variable, goal, gold, gold_carryover;

H:

harm_unit, has_ally, has_attack, has_unit, have_location, have_unit, heal_on_hit, heal_unit, healed_anim, healing_anim, heals, hide_help, hide_unit, hides;

I:

idle_anim, if (action, animation, intro), illuminates, image (gui2, intro, terrain), init_side, insert_tag, inspect, item, item_group;

J:

jamming_costs, join;

K:

kill, killed;

L:

label, language, leader, leader_goal, leadership, leading_anim, levelin_anim, levelout_anim, lift_fog, limit, literal, load_resource, locale, lock_view, lua;

M:

male, menu_item, message, micro_ai, missile_frame, modification, modifications, modify_ai, modify_side, modify_turns, modify_unit, modify_unit_type, move, move_unit, move_unit_fake, move_units_fake, movement_anim, movement costs, movetype, multiplayer, multiplayer_side, music;

N:

not, note;

O:

object, objective, objectives, on_undo, open_help, option, options, or;

P:

part, petrifies, petrify, place_shroud, plague, poison, portrait, post_movement_anim, pre_movement_anim, primary_attack, primary_unit, print, put_to_recall_list;

R:

race, random_placement, recall (action, replay), recalls, recruit, recruit_anim, recruiting_anim, recruits, redraw, regenerate, remove_event, remove_item, remove_object, remove_shroud, remove_sound_source, remove_time_area, remove_unit_overlay, repeat, replace_map, replace_schedule, replay, replay_start, reset_fog, resistance (ability, unit), resistance_defaults, resource, return, role, rule;

S:

save, scenario, scroll, scroll_to, scroll_to_unit, secondary_attack, secondary_unit, section, select_unit, sequence, set_extra_recruit, set_global_variable, set_menu_item, set_recruit, set_specials, set_variable, set_variables, sheath_weapon_anim, show_if (message, set_menu_item), show_objectives, side, skirmisher, slider, slow, snapshot, sound, sound_source, source (replay, teleport), special_note, specials, split, stage, standing_anim, statistics, status, store_gold, store_items, store_locations, store_map_dimensions, store_reachable_locations, store_relative_direction, store_side, store_starting_location, store_time_of_day, store_turns, store_unit, store_unit_defense, store_unit_defense_on, store_unit_type, store_unit_type_ids, store_villages, story, swarm, switch, sync_variable;

T:

target, team, teleport (ability, action), teleport_anim, terrain, terrain_defaults, terrain_graphics, terrain_mask, terrain_type, test, test_condition, text_input, textdomain, theme, then, tile, time, time_area, topic, toplevel, trait, transform_unit, traveler, true, tunnel, tutorial;

U:

unhide_unit, unit, unit_overlay, unit_type, unit_worth, units, unlock_view, unpetrify, unstore_unit, unsynced;

V:

value, variable, variables, variant, variation, victory_anim, village, vision_costs, volume;

W:

while, wml_message, wml_schema;

Z:

zoom;

Wiki Syntax

Formatting

This page is an example of how these wikis should be formatted:

Description of the page

  • [tag] description of [tag]
    • key: description of key.

"key" can refer either to the key key or the value of key

  • key2: description of key2
    • value: what happens when the attribute key2=value is set

Example:

[tag]
        key=0
[/tag]
key2=value

Version Control

This wiki describes the stable version of Wesnoth, but also has marked notes about the development version. See DevFeature.

Categorization

WML reference pages should be placed into the category "WML reference." This allows someone to easily bring up all the WML-related pages at once.

To do this, add the text [[Category: WML Reference]] at the bottom of the page under the "See Also" section.

See Also

This page was last edited on 31 December 2011, at 21:24.