// This file (IWarFoundryFileSaver.cs) is a part of the IBBoard.WarFoundry.API project and is copyright 2009 IBBoard.
//
// The file and the library/program it is in are licensed under the GNU LGPL license, either version 3 of the License or (at your option) any later version. Please see COPYING.LGPL 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);
	}
}