annotate api/Savers/IWarFoundryGameSystemSaver.cs @ 308:e1438fb9024c

Re #99: Define "points" values in GameSystem * Update to make sure that we don't return null
author IBBoard <dev@ibboard.co.uk>
date Sun, 13 Feb 2011 21:03:12 +0000
parents 349e521785c1
children 5434e648379c
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
297
349e521785c1 Re #338: WarFoundry.API - Save System Data
Tsudico
parents:
diff changeset
1 // This file (IWarFoundrySystemSaver.cs) is a part of the IBBoard.WarFoundry.API project and is copyright 2008, 2009 IBBoard.
349e521785c1 Re #338: WarFoundry.API - Save System Data
Tsudico
parents:
diff changeset
2 //
349e521785c1 Re #338: WarFoundry.API - Save System Data
Tsudico
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.
349e521785c1 Re #338: WarFoundry.API - Save System Data
Tsudico
parents:
diff changeset
4
349e521785c1 Re #338: WarFoundry.API - Save System Data
Tsudico
parents:
diff changeset
5 using System;
349e521785c1 Re #338: WarFoundry.API - Save System Data
Tsudico
parents:
diff changeset
6 using IBBoard.WarFoundry.API.Objects;
349e521785c1 Re #338: WarFoundry.API - Save System Data
Tsudico
parents:
diff changeset
7
349e521785c1 Re #338: WarFoundry.API - Save System Data
Tsudico
parents:
diff changeset
8 namespace IBBoard.WarFoundry.API.Savers
349e521785c1 Re #338: WarFoundry.API - Save System Data
Tsudico
parents:
diff changeset
9 {
349e521785c1 Re #338: WarFoundry.API - Save System Data
Tsudico
parents:
diff changeset
10 public interface IWarFoundryGameSystemSaver
349e521785c1 Re #338: WarFoundry.API - Save System Data
Tsudico
parents:
diff changeset
11 {
349e521785c1 Re #338: WarFoundry.API - Save System Data
Tsudico
parents:
diff changeset
12 /// <summary>
349e521785c1 Re #338: WarFoundry.API - Save System Data
Tsudico
parents:
diff changeset
13 /// Saves a <see cref="GameSystem"/> to a file on disk.
349e521785c1 Re #338: WarFoundry.API - Save System Data
Tsudico
parents:
diff changeset
14 /// </summary>
349e521785c1 Re #338: WarFoundry.API - Save System Data
Tsudico
parents:
diff changeset
15 /// <param name="system">
349e521785c1 Re #338: WarFoundry.API - Save System Data
Tsudico
parents:
diff changeset
16 /// The <see cref="GameSystem"/> to save
349e521785c1 Re #338: WarFoundry.API - Save System Data
Tsudico
parents:
diff changeset
17 /// </param>
349e521785c1 Re #338: WarFoundry.API - Save System Data
Tsudico
parents:
diff changeset
18 /// <param name="path">
349e521785c1 Re #338: WarFoundry.API - Save System Data
Tsudico
parents:
diff changeset
19 /// The path to save the system to
349e521785c1 Re #338: WarFoundry.API - Save System Data
Tsudico
parents:
diff changeset
20 /// </param>
349e521785c1 Re #338: WarFoundry.API - Save System Data
Tsudico
parents:
diff changeset
21 /// <returns>
349e521785c1 Re #338: WarFoundry.API - Save System Data
Tsudico
parents:
diff changeset
22 /// TRUE if saving succedes, else FALSE
349e521785c1 Re #338: WarFoundry.API - Save System Data
Tsudico
parents:
diff changeset
23 /// </returns>
349e521785c1 Re #338: WarFoundry.API - Save System Data
Tsudico
parents:
diff changeset
24 bool Save(GameSystem system, string path);
349e521785c1 Re #338: WarFoundry.API - Save System Data
Tsudico
parents:
diff changeset
25 }
349e521785c1 Re #338: WarFoundry.API - Save System Data
Tsudico
parents:
diff changeset
26 }