Mercurial > repos > IBBoard.WarFoundry.API
diff api/Savers/IWarFoundryFileSaver.cs @ 0:520818033bb6
Initial commit of WarFoundry code
author | IBBoard <dev@ibboard.co.uk> |
---|---|
date | Fri, 19 Dec 2008 15:57:51 +0000 |
parents | |
children | 306558904c2a |
line wrap: on
line diff
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/api/Savers/IWarFoundryFileSaver.cs Fri Dec 19 15:57:51 2008 +0000 @@ -0,0 +1,42 @@ +// IWarFoundryFileSaver.cs +// +// Copyright (C) 2008 IBBoard +// +// This library is free software; you can redistribute it and/or +// modify it under the terms of the GNU Lesser General Public +// License as published by the Free Software Foundation; either +// version 2.1 of the License, or (at your option) any later version. +// +// This library is distributed in the hope that it will be useful, +// but WITHOUT ANY WARRANTY; without even the implied warranty of +// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU +// Lesser General Public License for more details. +// +// You should have received a copy of the GNU Lesser General Public +// License along with this library; if not, write to the Free Software +// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA +// +// + +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); + } +}