view api/Savers/IWarFoundryRaceSaver.cs @ 315:6cb0fb78b9a6

Re #324: Add saving of Race and System data to files * Convert IWarFoundryFileSaver from a marker interface into an interface with a purpose of its own so that we can support multiple data files in one zip * Repurpose WarFoundryXmlSaver to be just an Army saver - we still need to make it usable as part of a larger whole * Add a WarFoundryLoadedObject class for objects loaded from files and make Race/Army/GameSystem inherit from it
author IBBoard <dev@ibboard.co.uk>
date Mon, 28 Feb 2011 21:09:20 +0000
parents 5434e648379c
children
line wrap: on
line source

// This file (IWarFoundryRaceSaver.cs) is a part of the IBBoard.WarFoundry.API project and is copyright 2011 IBBoard.
//
// The file and the library/program it is in are licensed and distributed, without warranty, under the GNU Affero GPL license, either version 3 of the License or (at your option) any later version. Please see COPYING for more information and the full license.

using System;
using IBBoard.WarFoundry.API.Objects;

namespace IBBoard.WarFoundry.API
{
	public interface IWarFoundryRaceSaver
	{
		/// <summary>
		/// Saves an <see cref="Race"/> to a file on disk.
		/// </summary>
		/// <param name="race">
		/// The <see cref="Race"/> to save
		/// </param>
		/// <param name="path">
		/// The path to save the army to
		/// </param>
		/// <returns>
		/// TRUE if saving succedes, else FALSE
		/// </returns>
		bool Save(Race race, string path);
	}
}