SavefileWML

From The Battle for Wesnoth Wiki

[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, array, aspect, attack, attack_anim, attacks, avoid;

B:

base_unit, berserk, binary_path, break, brush;

C:

campaign, candidate_action, capture_village, case, chance_to_hit, change_theme, chat, choose, clear_global_variable, clear_menu_item, clear_variable, color_adjust, 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, era, event, extra_anim;

F:

facet, facing, fake_unit, false, female, filter, 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, for, foreach, frame, full_heal;

G:

game_config, get_global_variable, goal, gold, gold_carryover;

H:

harm_unit, 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), illuminates, image, init_side, insert_tag, inspect, item, item_group;

J:

jamming_costs, join;

K:

kill, killed;

L:

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

M:

male, menu_item, message, micro_ai, missile_frame, modification, modifications, modify_ai, modify_side, modify_turns, modify_unit, 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, 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, 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, slow, snapshot, sound, sound_source, source (replay, teleport), 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_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, 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;

V:

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

W:

while, wml_message;

Z:

zoom;

The format for Wesnoth savegames

A Wesnoth savegame is a file stored in ~saves/ (See "user data directory", PreprocessorRef). In order to view or modify these files, the option Compressed Saves (Advanced Preferences) must be set to "No". Also, since they are not config(.cfg) files the normal coloring will not be generated. To generate coloring, simply save the file as .cfg, then open it again.

There are 3 types of savegames: Start-of-scenario, replay and in-game (including autosave and out-of-sync save). The information included in a save depends on its type.

Start-of-scenario Replay In-game
General info and statistics Yes Yes Yes
[snapshot] No No Yes
[replay] No Yes Yes
[replay_start] No Yes Yes
[carryover_sides] No Yes Yes
[carryover_sides_start] Yes Yes Yes

(Version 1.13.0 and later only) There are 4 types of savegames: Start-of-scenario, replay and in-game (including autosave and out-of-sync save). The information included in a save depends on its type.

Start-of-scenario Expanded Start-of-scenario Replay In-game
General info and statistics Yes Yes Yes Yes
[snapshot] No No No Yes
[replay] No No Yes Yes
[replay_start] No No Yes Yes
[carryover_sides] No No Yes Yes
[carryover_sides_start] Yes Yes No No
[scenario] No Yes No No

(Version 1.13.0 and later only) There are also 2 types of Server generated replays

Fresh game Start-of-scenario Reloaded game
General info and statistics Yes Yes Yes
[snapshot] No No Yes
[replay] Yes Yes Yes
[replay_start] No No Yes
[carryover_sides] No No Yes
[carryover_sides_start] Yes Yes No
[scenario] Yes Yes No


General info and statistics

Contains general information about the scenario, campaign and version of Battle for Wesnoth the savegame is from. This information is included in all savegames. Not all tags of this section are explained here.

  • version: The version of Wesnoth this game was saved by. If the savegame is from a different version of Wesnoth than the one currently running, the message "This save is from a different version of the game. Do you want to try to load it?" is displayed
  • campaign_type: Whether the scenario is a scenario or multiplayer.
  • campaign_define: When this replay is loaded, the symbol campaign_define will be stored. See also "#ifdef", PreprocessorRef
  • difficulty: The difficulty level of the savegame. Normal values are "EASY", "NORMAL", and "HARD".
  • label: heading of the save
  • next_scenario: Name of the next scenario in a campaign
  • scenario: Name of the current scenario
  • [multiplayer]: If the game is a multiplayer game, multiplayer information is inculded here
  • [statistics]: Describes previous scenarios
    • mid_scenario: If "false", the scenario will be reloaded and any modifications will be played with.
    • [scenario]: Describes basic statistics of a previous scenario. See StatisticalScenarioWML for a description of [scenario]


[snapshot]

The [snapshot] describes the current state of the game in an in-game save. It has the same format as the rest of the savefile and holds the map of the scenario. The snapshot is loaded when “Show replay” is not selected.

  • playing_team: the number of the team whose turn it is, starting with 0
  • turn_at: The number of the current turn
  • map_data: The data for the map. The mini-map generated by this data is displayed to the right


[replay_start]

[replay_start] is a full snapshot of the start of the first turn of a scenario. It describes the position the player was in when the game started and is used as starting point for replays.


[replay]

The [replay] contains everything that happened in the scenario since it started.

  • [command]: Describes one action. Syntax for [command] is described in ReplayWML


[carryover_sides_start]

[carryover_sides_start] contains the carryover data from the previous scenario, like retained gold and units. It is also used to store in-game data required in the next level, such as variables, the random seed and menu items. [carryover_sides_start] retains the data throughout the scenario.

  • random_calls and random_seed: Used to determine and synchronize random events in the game
  • [side]: Player information, retained gold, recruits and recalls for all sides in the game
  • [end_level_data]: Contains the information how the carryover data should be used.*
  • [variables]: a list of the current values of all variables. The attribute variable//=//value// means that the variable variable has the value value. The tag [array//]describes a unit stored in the array array (see SingleUnitWML). See also VariablesWML
  • [menu_item]: Custom WML menu items


[carryover_sides]

[carryover_sides] is a copy of the data in [carryover_sides_start]. Anything to be used in the new scenario is removed from [carryover_sides]. At the end of the scenario the carryover for the next scenario is added to what is left in [carryover_sides].

[scenario]

(Version 1.13.0 and later only) Expanded Start-of-scenario saves are almost the same as normal start-of-scenario saves, except that they also contain the start [scenario] so it doesnt need to be read from the game config This type of savegame is mostly used internally, especialy this type of save is used at the beginning of a fresh networked mp game, where this host sends this type of savefile to the other clients, which is then loaded by them.

But in theory the game can also read an expanded start-of-scenario save from disk.

See Also

This page was last modified on 7 December 2016, at 00:22.