Mercurial > repos > IBBoard.WarFoundry.API

annotate api/Savers/IWarFoundryArmySaver.cs @ 311:5434e648379c

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Re #328: Add saving of Race and System data to files * Turn IWarFoundryFileSaver into a marker interface * Add missing Army and Race saver classes * Add stub implementations to IWarFoundryFileSaver
author IBBoard <dev@ibboard.co.uk>
date Wed, 23 Feb 2011 20:44:37 +0000
parents
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
311
5434e648379c Re #328: Add saving of Race and System data to files
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
1 // This file (IWarFoundryArmySaver.cs) is a part of the IBBoard.WarFoundry.API project and is copyright 2011 IBBoard.
5434e648379c Re #328: Add saving of Race and System data to files
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
2 //
5434e648379c Re #328: Add saving of Race and System data to files
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
3 // 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.
5434e648379c Re #328: Add saving of Race and System data to files
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
4
5434e648379c Re #328: Add saving of Race and System data to files
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
5 using System;
5434e648379c Re #328: Add saving of Race and System data to files
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
6 using IBBoard.WarFoundry.API.Objects;
5434e648379c Re #328: Add saving of Race and System data to files
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
7
5434e648379c Re #328: Add saving of Race and System data to files
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
8 namespace IBBoard.WarFoundry.API.Savers
5434e648379c Re #328: Add saving of Race and System data to files
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
9 {
5434e648379c Re #328: Add saving of Race and System data to files
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
10 public interface IWarFoundryArmySaver
5434e648379c Re #328: Add saving of Race and System data to files
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
11 {
5434e648379c Re #328: Add saving of Race and System data to files
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
12 /// <summary>
5434e648379c Re #328: Add saving of Race and System data to files
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
13 /// Saves an <see cref="Army"/> to a file on disk.
5434e648379c Re #328: Add saving of Race and System data to files
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
14 /// </summary>
5434e648379c Re #328: Add saving of Race and System data to files
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
15 /// <param name="army">
5434e648379c Re #328: Add saving of Race and System data to files
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
16 /// The <see cref="Army"/> to save
5434e648379c Re #328: Add saving of Race and System data to files
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
17 /// </param>
5434e648379c Re #328: Add saving of Race and System data to files
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
18 /// <param name="path">
5434e648379c Re #328: Add saving of Race and System data to files
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
19 /// The path to save the army to
5434e648379c Re #328: Add saving of Race and System data to files
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
20 /// </param>
5434e648379c Re #328: Add saving of Race and System data to files
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
21 /// <returns>
5434e648379c Re #328: Add saving of Race and System data to files
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
22 /// TRUE if saving succedes, else FALSE
5434e648379c Re #328: Add saving of Race and System data to files
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
23 /// </returns>
5434e648379c Re #328: Add saving of Race and System data to files
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
24 bool Save(Army army, string path);
5434e648379c Re #328: Add saving of Race and System data to files
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
25 }
5434e648379c Re #328: Add saving of Race and System data to files
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
26 }
5434e648379c Re #328: Add saving of Race and System data to files
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
27