Mercurial > repos > IBBoard.WarFoundry.API

comparison api/Savers/IWarFoundryFileSaver.cs @ 0:520818033bb6

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Initial commit of WarFoundry code
author IBBoard <dev@ibboard.co.uk>
date Fri, 19 Dec 2008 15:57:51 +0000
parents
children 306558904c2a
comparison
equal deleted inserted replaced
-1:000000000000 0:520818033bb6
1 // IWarFoundryFileSaver.cs
2 //
3 // Copyright (C) 2008 IBBoard
4 //
5 // This library is free software; you can redistribute it and/or
6 // modify it under the terms of the GNU Lesser General Public
7 // License as published by the Free Software Foundation; either
8 // version 2.1 of the License, or (at your option) any later version.
9 //
10 // This library is distributed in the hope that it will be useful,
11 // but WITHOUT ANY WARRANTY; without even the implied warranty of
12 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 // Lesser General Public License for more details.
14 //
15 // You should have received a copy of the GNU Lesser General Public
16 // License along with this library; if not, write to the Free Software
17 // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
18 //
19 //
20
21 using System;
22 using IBBoard.WarFoundry.API.Objects;
23
24 namespace IBBoard.WarFoundry.API.Savers
25 {
26 public interface IWarFoundryFileSaver
27 {
28 /// <summary>
29 /// Saves an <see cref="Army"/> to a file on disk.
30 /// </summary>
31 /// <param name="army">
32 /// The <see cref="Army"/> to save
33 /// </param>
34 /// <param name="path">
35 /// The path to save the army to
36 /// </param>
37 /// <returns>
38 /// TRUE if saving succedes, else FALSE
39 /// </returns>
40 bool Save(Army army, string path);
41 }
42 }