Mercurial > repos > IBDev-IBBoard.WarFoundry.API
annotate api/Factories/IWarFoundryFactory.cs @ 8:613bc5eaac59
Re #9 - Make WarFoundry loading granular
* Remove specific staged loading classes
* Rework category loading for GameSystem and Race to make it use AddCategory(Category) method
* Promote staged loading from Native Factory to all Factories level
* Refactor XML Factory to use smaller methods
Also removed some commented code that isn't used any more
author | IBBoard <dev@ibboard.co.uk> |
---|---|
date | Sun, 04 Jan 2009 19:24:13 +0000 |
parents | 520818033bb6 |
children | 0770e5cbba7c |
rev | line source |
---|---|
0 | 1 // IWarFoundryFactory.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 System.IO; | |
23 using System.Collections.Generic; | |
24 using IBBoard.WarFoundry.API.Objects; | |
25 | |
26 namespace IBBoard.WarFoundry.API.Factories | |
27 { | |
28 public interface IWarFoundryFactory | |
29 { | |
30 /// <summary> | |
8
613bc5eaac59
Re #9 - Make WarFoundry loading granular
IBBoard <dev@ibboard.co.uk>
parents:
0
diff
changeset
|
31 /// Completes the loading of an object if it is loaded in stages. |
613bc5eaac59
Re #9 - Make WarFoundry loading granular
IBBoard <dev@ibboard.co.uk>
parents:
0
diff
changeset
|
32 /// </summary> |
613bc5eaac59
Re #9 - Make WarFoundry loading granular
IBBoard <dev@ibboard.co.uk>
parents:
0
diff
changeset
|
33 /// <param name="obj"> |
613bc5eaac59
Re #9 - Make WarFoundry loading granular
IBBoard <dev@ibboard.co.uk>
parents:
0
diff
changeset
|
34 /// The <see cref="IWarFoundryStagedLoadObject"/> that should be fully loaded. |
613bc5eaac59
Re #9 - Make WarFoundry loading granular
IBBoard <dev@ibboard.co.uk>
parents:
0
diff
changeset
|
35 /// </param> |
613bc5eaac59
Re #9 - Make WarFoundry loading granular
IBBoard <dev@ibboard.co.uk>
parents:
0
diff
changeset
|
36 void CompleteLoading(IWarFoundryStagedLoadObject obj); |
613bc5eaac59
Re #9 - Make WarFoundry loading granular
IBBoard <dev@ibboard.co.uk>
parents:
0
diff
changeset
|
37 |
613bc5eaac59
Re #9 - Make WarFoundry loading granular
IBBoard <dev@ibboard.co.uk>
parents:
0
diff
changeset
|
38 /// <summary> |
0 | 39 /// Checks if the factory thinks it can handle the supplied file. Checks can be performed on file extension or some basic check of file content, or some other method. |
40 /// </summary> | |
41 /// <param name="file"> | |
42 /// A <see cref="FileInfo"/> for the file to check support for. | |
43 /// </param> | |
44 /// <returns> | |
45 /// <code>true</code> if the file appears to be supported for loading by this factory, else returns <code>false</code> | |
46 /// </returns> | |
47 bool CanHandleFileFormat(FileInfo file); | |
48 | |
49 /// <summary> | |
50 /// Reads the data from the supplied file and returns it as a collection of loadable objects. | |
51 /// </summary> | |
52 /// <param name="file"> | |
53 /// A <see cref="FileInfo"/> for the file to load data from | |
54 /// </param> | |
55 /// <returns> | |
56 /// A <see cref="ICollection`1"/> of <see cref="IWarFoundryObject"/>s that were loaded from the file | |
57 /// </returns> | |
58 ICollection<IWarFoundryObject> CreateObjectsFromFile(FileInfo file); | |
59 } | |
60 } |