Difference between revisions of "LanguageWML"

From The Battle for Wesnoth Wiki
(Made the '1.9.3 aand earlier only' stuff mimic the contents of DevFeature.1.9)
(Cleaning up documentation for 1.10)
(10 intermediate revisions by one other user not shown)
Line 2: Line 2:
 
== The toplevel [language] tag ==
 
== The toplevel [language] tag ==
  
The contents of the [language] tag associate strings with certain keywords used by the engine and some WML, such as attack types and ranges. This tag used to only be recognized in data/hardwired/english.cfg, {{DevFeature1.9}} but it can now be placed anywhere.
+
The contents of the [language] tag associate strings with certain keywords used by the engine and some WML, such as attack types and ranges.
  
 
The following keys and tags are recognized in [language] tags:
 
The following keys and tags are recognized in [language] tags:
Line 10: Line 10:
 
* '''HARD''': string to associate with the HARD difficulty keyword.
 
* '''HARD''': string to associate with the HARD difficulty keyword.
 
* '''NIGHTMARE''': string to associate with the NIGHTMARE difficulty keyword.
 
* '''NIGHTMARE''': string to associate with the NIGHTMARE difficulty keyword.
* '''liminal_description''': {{DevFeature1.9}} string for the liminal alignment's description.
+
* '''liminal_description''': string for the liminal alignment's description.
 
* '''lawful_description''': string for the lawful alignment's description.
 
* '''lawful_description''': string for the lawful alignment's description.
 
* '''neutral_description''': string for the neutral alignment's description.
 
* '''neutral_description''': string for the neutral alignment's description.
 
* '''chaotic_description''': string for the chaotic alignment's description.
 
* '''chaotic_description''': string for the chaotic alignment's description.
 +
* '''bridge_name''': comma-separated list of names to be used by the feature-labeling function for bridges.
 +
* '''road_name''': comma-separated list of names to be used by the feature-labeling function for roads.
 +
* '''river_name''': comma-separated list of names to be used by the feature-labeling function for rivers.
 +
* '''forest_name''': comma-separated list of names to be used by the feature-labeling function for forests.
 +
* '''lake_name''': comma-separated list of names to be used by the feature-labeling function for lakes.
 +
* '''mountain_name''': comma-separated list of names to be used by the feature-labeling function for mountains.
 +
* '''swamp_name''': comma-separated list of names to be used by the feature-labeling function for rivers.
 +
* '''village_name''': comma-separated list of names to be used by the feature-labeling function for villages.
 
* '''range_melee''': string to associate with the melee range keyword.
 
* '''range_melee''': string to associate with the melee range keyword.
 
* '''range_ranged''': string to associate with the ranged range keyword.
 
* '''range_ranged''': string to associate with the ranged range keyword.
* '''blade''': '''''(Version 1.9.3 and earlier only)''''' string to associate with the blade type keyword.
+
* '''range_$RANGE''': string to associate with whatever range $RANGE is in actual use. Refer to the [[LanguageWML#Examples|examples section]] for actual uses and examples.
* '''pierce''': '''''(Version 1.9.3 and earlier only)''''' string to associate with the pierce type keyword.
+
* '''type_$TYPE''': string to associate with whatever type $TYPE is in actual use. Refer to the the [[LanguageWML#Examples|examples section]] for actual uses and examples.
* '''impact''': '''''(Version 1.9.3 and earlier only)''''' string to associate with the impact type keyword.
 
* '''fire''': '''''(Version 1.9.3 and earlier only)''''' string to associate with the fire type keyword.
 
* '''cold''': '''''(Version 1.9.3 and earlier only)''''' string to associate with the cold type keyword.
 
* '''arcane''': '''''(Version 1.9.3 and earlier only)''''' string to associate with the arcane type keyword.
 
* '''range_$RANGE''': {{DevFeature1.9}} string to associate with whatever range $RANGE is in actual use. Refer to the [[LanguageWML#Examples|examples section]] for actual uses and examples.
 
* '''type_$TYPE''': {{DevFeature1.9}} string to associate with whatever $TYPE is in actual use. Refer to the the [[LanguageWML#Examples|examples section]] for actual uses and examples.
 
  
 
== Examples ==
 
== Examples ==
Line 35: Line 37:
 
  [/language]
 
  [/language]
  
Example of an association of a string with the keyword for a '''very long''' range in UMC:
+
Example of an association of a string with the keyword for a '''very_long''' range in UMC:
 
   
 
   
  [+language]
+
  [language]
 
     range_very_long= _ "very long"
 
     range_very_long= _ "very long"
 
  [/language]
 
  [/language]
Line 46: Line 48:
 
   
 
   
 
  [language]
 
  [language]
     type_arcane=_ "arcane"
+
     type_arcane= _ "arcane"
 
  [/language]
 
  [/language]
  
 
Example of an association of a string with the keyword for an '''electric''' type in UMC:
 
Example of an association of a string with the keyword for an '''electric''' type in UMC:
 
   
 
   
  [+language]
+
  [language]
 
     type_electric= _ "electric"
 
     type_electric= _ "electric"
 
  [/language]
 
  [/language]

Revision as of 15:36, 29 January 2012

[edit]WML Tags

A:

abilities, about, achievement, achievement_group, add_ai_behavior, 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 (replay, weapon), attack_anim, attacks (special, stats), avoid;

B:

base_unit, background_layer, 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_palette, color_range, command (action, replay), continue, credits_group, 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, experimental_filter_ability, experimental_filter_ability_active, experimental_filter_specials, 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_student, 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, has_achievement, 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 (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, post_movement_anim, pre_movement_anim, primary_attack, primary_unit, print, progress_achievement, 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_trait, 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, screen_fade, scroll, scroll_to, scroll_to_unit, secondary_attack, secondary_unit, section, select_unit, sequence, set_achievement, set_extra_recruit, set_global_variable, set_menu_item, set_recruit, set_specials, set_variable, set_variables, sheath_weapon_anim, show_if (message, objective, 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, sub_achievement, switch, sync_variable;

T:

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

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;

The toplevel [language] tag

The contents of the [language] tag associate strings with certain keywords used by the engine and some WML, such as attack types and ranges.

The following keys and tags are recognized in [language] tags:

  • EASY: string to associate with the EASY difficulty keyword.
  • NORMAL: string to associate with the NORMAL difficulty keyword.
  • HARD: string to associate with the HARD difficulty keyword.
  • NIGHTMARE: string to associate with the NIGHTMARE difficulty keyword.
  • liminal_description: string for the liminal alignment's description.
  • lawful_description: string for the lawful alignment's description.
  • neutral_description: string for the neutral alignment's description.
  • chaotic_description: string for the chaotic alignment's description.
  • bridge_name: comma-separated list of names to be used by the feature-labeling function for bridges.
  • road_name: comma-separated list of names to be used by the feature-labeling function for roads.
  • river_name: comma-separated list of names to be used by the feature-labeling function for rivers.
  • forest_name: comma-separated list of names to be used by the feature-labeling function for forests.
  • lake_name: comma-separated list of names to be used by the feature-labeling function for lakes.
  • mountain_name: comma-separated list of names to be used by the feature-labeling function for mountains.
  • swamp_name: comma-separated list of names to be used by the feature-labeling function for rivers.
  • village_name: comma-separated list of names to be used by the feature-labeling function for villages.
  • range_melee: string to associate with the melee range keyword.
  • range_ranged: string to associate with the ranged range keyword.
  • range_$RANGE: string to associate with whatever range $RANGE is in actual use. Refer to the examples section for actual uses and examples.
  • type_$TYPE: string to associate with whatever type $TYPE is in actual use. Refer to the the examples section for actual uses and examples.

Examples

Examples and actual uses of range_$RANGE

Example of an actual use in mainline:

[language]
    range_melee= _ "melee"
[/language]

Example of an association of a string with the keyword for a very_long range in UMC:

[language]
    range_very_long= _ "very long"
[/language]

Examples and actual uses of type_$TYPE

Example of an actual use in mainline:

[language]
    type_arcane= _ "arcane"
[/language]

Example of an association of a string with the keyword for an electric type in UMC:

[language]
    type_electric= _ "electric"
[/language]

See Also