view api/Savers/IWarFoundryGameSystemSaver.cs @ 323:8a64b36d36b8

Re #324: Add saving of Race and System data to files * As per GameSystem changes for using existing code: * Make XML creation method public * Make sure we're encoding in UTF-8 * Implement saving method for Army
author IBBoard <dev@ibboard.co.uk>
date Wed, 09 Mar 2011 20:59:34 +0000
parents 5434e648379c
children
line wrap: on
line source

// This file (IWarFoundryGameSystemSaver.cs) is a part of the IBBoard.WarFoundry.API project and is copyright 2008, 2009, 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.Savers
{
	public interface IWarFoundryGameSystemSaver
	{
		/// <summary>
		/// Saves a <see cref="GameSystem"/> to a file on disk.
		/// </summary>
		/// <param name="system">
		/// The <see cref="GameSystem"/> to save
		/// </param>
		/// <param name="path">
		/// The path to save the system to
		/// </param>
		/// <returns>
		/// TRUE if saving succedes, else FALSE
		/// </returns>
		bool Save(GameSystem system, string path);
	}
}