view api/Savers/IWarFoundryFileSaver.cs @ 115:d0c60b3204c1

Re #53: Add XML army saving * Make file identifiers public * Add army identifier to comment no-open-ticket
author IBBoard <>
date Sat, 22 Aug 2009 19:41:15 +0000
parents 2f3cafb69799
children 5434e648379c
line wrap: on
line source

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