IBDev-IBBoard.WarFoundry.API: api/Factories/IWarFoundryFactory.cs annotate

annotate api/Factories/IWarFoundryFactory.cs @ 252:a54da5a8b5bb

Re #268: Restructure stats for re-use * Add "Member Type" class * Add member type setting and getting to Race * Load member types from XML files * Make unit type pull stat line from stats or first member type, or fall back to a blank stat line * Change Stats object to initialise blank values * Change schema * Make stats optional * Add member type list to race * Add optional member type references to units

author	IBBoard <dev@ibboard.co.uk>
date	Sun, 25 Apr 2010 15:07:08 +0000
parents	2f3cafb69799
children	f00a57369aaa

rev	line source
104 2f3cafb69799 Re #121: Migrate to AGPL license IBBoard <dev@ibboard.co.uk> parents: 19 diff changeset	1 // This file (IWarFoundryFactory.cs) is a part of the IBBoard.WarFoundry.API project and is copyright 2007, 2008, 2009 IBBoard.
0 520818033bb6 Initial commit of WarFoundry code IBBoard <dev@ibboard.co.uk> parents: diff changeset	2 //
104 2f3cafb69799 Re #121: Migrate to AGPL license IBBoard <dev@ibboard.co.uk> parents: 19 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.
0 520818033bb6 Initial commit of WarFoundry code IBBoard <dev@ibboard.co.uk> parents: diff changeset	4
520818033bb6 Initial commit of WarFoundry code IBBoard <dev@ibboard.co.uk> parents: diff changeset	5 using System;
520818033bb6 Initial commit of WarFoundry code IBBoard <dev@ibboard.co.uk> parents: diff changeset	6 using System.IO;
520818033bb6 Initial commit of WarFoundry code IBBoard <dev@ibboard.co.uk> parents: diff changeset	7 using System.Collections.Generic;
520818033bb6 Initial commit of WarFoundry code IBBoard <dev@ibboard.co.uk> parents: diff changeset	8 using IBBoard.WarFoundry.API.Objects;
520818033bb6 Initial commit of WarFoundry code IBBoard <dev@ibboard.co.uk> parents: diff changeset	9
520818033bb6 Initial commit of WarFoundry code IBBoard <dev@ibboard.co.uk> parents: diff changeset	10 namespace IBBoard.WarFoundry.API.Factories
520818033bb6 Initial commit of WarFoundry code IBBoard <dev@ibboard.co.uk> parents: diff changeset	11 {
520818033bb6 Initial commit of WarFoundry code IBBoard <dev@ibboard.co.uk> parents: diff changeset	12 public interface IWarFoundryFactory
520818033bb6 Initial commit of WarFoundry code IBBoard <dev@ibboard.co.uk> parents: diff changeset	13 {
520818033bb6 Initial commit of WarFoundry code IBBoard <dev@ibboard.co.uk> parents: diff changeset	14 /// <summary>
8 613bc5eaac59 Re #9 - Make WarFoundry loading granular IBBoard <dev@ibboard.co.uk> parents: 0 diff changeset	15 /// 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	16 /// </summary>
613bc5eaac59 Re #9 - Make WarFoundry loading granular IBBoard <dev@ibboard.co.uk> parents: 0 diff changeset	17 /// <param name="obj">
613bc5eaac59 Re #9 - Make WarFoundry loading granular IBBoard <dev@ibboard.co.uk> parents: 0 diff changeset	18 /// 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	19 /// </param>
613bc5eaac59 Re #9 - Make WarFoundry loading granular IBBoard <dev@ibboard.co.uk> parents: 0 diff changeset	20 void CompleteLoading(IWarFoundryStagedLoadObject obj);
613bc5eaac59 Re #9 - Make WarFoundry loading granular IBBoard <dev@ibboard.co.uk> parents: 0 diff changeset	21
613bc5eaac59 Re #9 - Make WarFoundry loading granular IBBoard <dev@ibboard.co.uk> parents: 0 diff changeset	22 /// <summary>
0 520818033bb6 Initial commit of WarFoundry code IBBoard <dev@ibboard.co.uk> parents: diff changeset	23 /// 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.
520818033bb6 Initial commit of WarFoundry code IBBoard <dev@ibboard.co.uk> parents: diff changeset	24 /// </summary>
520818033bb6 Initial commit of WarFoundry code IBBoard <dev@ibboard.co.uk> parents: diff changeset	25 /// <param name="file">
520818033bb6 Initial commit of WarFoundry code IBBoard <dev@ibboard.co.uk> parents: diff changeset	26 /// A <see cref="FileInfo"/> for the file to check support for.
520818033bb6 Initial commit of WarFoundry code IBBoard <dev@ibboard.co.uk> parents: diff changeset	27 /// </param>
520818033bb6 Initial commit of WarFoundry code IBBoard <dev@ibboard.co.uk> parents: diff changeset	28 /// <returns>
520818033bb6 Initial commit of WarFoundry code IBBoard <dev@ibboard.co.uk> parents: diff changeset	29 /// <code>true</code> if the file appears to be supported for loading by this factory, else returns <code>false</code>
520818033bb6 Initial commit of WarFoundry code IBBoard <dev@ibboard.co.uk> parents: diff changeset	30 /// </returns>
14 0770e5cbba7c Closes #21 - File loading in order IBBoard <dev@ibboard.co.uk> parents: 8 diff changeset	31 bool CanHandleFileFormat(FileInfo file);
0770e5cbba7c Closes #21 - File loading in order IBBoard <dev@ibboard.co.uk> parents: 8 diff changeset	32
0770e5cbba7c Closes #21 - File loading in order IBBoard <dev@ibboard.co.uk> parents: 8 diff changeset	33 /// <summary>
0770e5cbba7c Closes #21 - File loading in order IBBoard <dev@ibboard.co.uk> parents: 8 diff changeset	34 /// Checks if the factory thinks it can handle the supplied file as a Race. Checks can be performed on file extension or some basic check of file content, or some other method.
0770e5cbba7c Closes #21 - File loading in order IBBoard <dev@ibboard.co.uk> parents: 8 diff changeset	35 /// </summary>
0770e5cbba7c Closes #21 - File loading in order IBBoard <dev@ibboard.co.uk> parents: 8 diff changeset	36 /// <param name="file">
0770e5cbba7c Closes #21 - File loading in order IBBoard <dev@ibboard.co.uk> parents: 8 diff changeset	37 /// A <see cref="FileInfo"/> for the file to check support for as a file containing Race information.
0770e5cbba7c Closes #21 - File loading in order IBBoard <dev@ibboard.co.uk> parents: 8 diff changeset	38 /// </param>
0770e5cbba7c Closes #21 - File loading in order IBBoard <dev@ibboard.co.uk> parents: 8 diff changeset	39 /// <returns>
0770e5cbba7c Closes #21 - File loading in order IBBoard <dev@ibboard.co.uk> parents: 8 diff changeset	40 /// <code>true</code> if the file appears to be supported for loading by this factory as a Race, else returns <code>false</code>
0770e5cbba7c Closes #21 - File loading in order IBBoard <dev@ibboard.co.uk> parents: 8 diff changeset	41 /// </returns>
0770e5cbba7c Closes #21 - File loading in order IBBoard <dev@ibboard.co.uk> parents: 8 diff changeset	42 bool CanHandleFileAsRace(FileInfo file);
0770e5cbba7c Closes #21 - File loading in order IBBoard <dev@ibboard.co.uk> parents: 8 diff changeset	43
0770e5cbba7c Closes #21 - File loading in order IBBoard <dev@ibboard.co.uk> parents: 8 diff changeset	44 /// <summary>
0770e5cbba7c Closes #21 - File loading in order IBBoard <dev@ibboard.co.uk> parents: 8 diff changeset	45 /// Checks if the factory thinks it can handle the supplied file as a GameSystem. Checks can be performed on file extension or some basic check of file content, or some other method.
0770e5cbba7c Closes #21 - File loading in order IBBoard <dev@ibboard.co.uk> parents: 8 diff changeset	46 /// </summary>
0770e5cbba7c Closes #21 - File loading in order IBBoard <dev@ibboard.co.uk> parents: 8 diff changeset	47 /// <param name="file">
0770e5cbba7c Closes #21 - File loading in order IBBoard <dev@ibboard.co.uk> parents: 8 diff changeset	48 /// A <see cref="FileInfo"/> for the file to check support for as a file containing GameSystem information.
0770e5cbba7c Closes #21 - File loading in order IBBoard <dev@ibboard.co.uk> parents: 8 diff changeset	49 /// </param>
0770e5cbba7c Closes #21 - File loading in order IBBoard <dev@ibboard.co.uk> parents: 8 diff changeset	50 /// <returns>
0770e5cbba7c Closes #21 - File loading in order IBBoard <dev@ibboard.co.uk> parents: 8 diff changeset	51 /// <code>true</code> if the file appears to be supported for loading by this factory as a GameSystem, else returns <code>false</code>
0770e5cbba7c Closes #21 - File loading in order IBBoard <dev@ibboard.co.uk> parents: 8 diff changeset	52 /// </returns>
0770e5cbba7c Closes #21 - File loading in order IBBoard <dev@ibboard.co.uk> parents: 8 diff changeset	53 bool CanHandleFileAsGameSystem(FileInfo file);
0770e5cbba7c Closes #21 - File loading in order IBBoard <dev@ibboard.co.uk> parents: 8 diff changeset	54
0770e5cbba7c Closes #21 - File loading in order IBBoard <dev@ibboard.co.uk> parents: 8 diff changeset	55 /// <summary>
0770e5cbba7c Closes #21 - File loading in order IBBoard <dev@ibboard.co.uk> parents: 8 diff changeset	56 /// Checks if the factory thinks it can handle the supplied file as a Army. Checks can be performed on file extension or some basic check of file content, or some other method.
0770e5cbba7c Closes #21 - File loading in order IBBoard <dev@ibboard.co.uk> parents: 8 diff changeset	57 /// </summary>
0770e5cbba7c Closes #21 - File loading in order IBBoard <dev@ibboard.co.uk> parents: 8 diff changeset	58 /// <param name="file">
0770e5cbba7c Closes #21 - File loading in order IBBoard <dev@ibboard.co.uk> parents: 8 diff changeset	59 /// A <see cref="FileInfo"/> for the file to check support for as a file containing Army information.
0770e5cbba7c Closes #21 - File loading in order IBBoard <dev@ibboard.co.uk> parents: 8 diff changeset	60 /// </param>
0770e5cbba7c Closes #21 - File loading in order IBBoard <dev@ibboard.co.uk> parents: 8 diff changeset	61 /// <returns>
0770e5cbba7c Closes #21 - File loading in order IBBoard <dev@ibboard.co.uk> parents: 8 diff changeset	62 /// <code>true</code> if the file appears to be supported for loading by this factory as a Army, else returns <code>false</code>
0770e5cbba7c Closes #21 - File loading in order IBBoard <dev@ibboard.co.uk> parents: 8 diff changeset	63 /// </returns>
0770e5cbba7c Closes #21 - File loading in order IBBoard <dev@ibboard.co.uk> parents: 8 diff changeset	64 bool CanHandleFileAsArmy(FileInfo file);
0 520818033bb6 Initial commit of WarFoundry code IBBoard <dev@ibboard.co.uk> parents: diff changeset	65
520818033bb6 Initial commit of WarFoundry code IBBoard <dev@ibboard.co.uk> parents: diff changeset	66 /// <summary>
520818033bb6 Initial commit of WarFoundry code IBBoard <dev@ibboard.co.uk> parents: diff changeset	67 /// Reads the data from the supplied file and returns it as a collection of loadable objects.
19 57451981545c Re #10 and re #11 - Refactor code and document code IBBoard <dev@ibboard.co.uk> parents: 15 diff changeset	68 /// May throw a <see cref=" IBBoard.IO.InvalidFileException"/> if the file is supported by the Factory but the content is invalid.
0 520818033bb6 Initial commit of WarFoundry code IBBoard <dev@ibboard.co.uk> parents: diff changeset	69 /// </summary>
520818033bb6 Initial commit of WarFoundry code IBBoard <dev@ibboard.co.uk> parents: diff changeset	70 /// <param name="file">
520818033bb6 Initial commit of WarFoundry code IBBoard <dev@ibboard.co.uk> parents: diff changeset	71 /// A <see cref="FileInfo"/> for the file to load data from
520818033bb6 Initial commit of WarFoundry code IBBoard <dev@ibboard.co.uk> parents: diff changeset	72 /// </param>
520818033bb6 Initial commit of WarFoundry code IBBoard <dev@ibboard.co.uk> parents: diff changeset	73 /// <returns>
520818033bb6 Initial commit of WarFoundry code IBBoard <dev@ibboard.co.uk> parents: diff changeset	74 /// A <see cref="ICollection`1"/> of <see cref="IWarFoundryObject"/>s that were loaded from the file
520818033bb6 Initial commit of WarFoundry code IBBoard <dev@ibboard.co.uk> parents: diff changeset	75 /// </returns>
520818033bb6 Initial commit of WarFoundry code IBBoard <dev@ibboard.co.uk> parents: diff changeset	76 ICollection<IWarFoundryObject> CreateObjectsFromFile(FileInfo file);
520818033bb6 Initial commit of WarFoundry code IBBoard <dev@ibboard.co.uk> parents: diff changeset	77 }
520818033bb6 Initial commit of WarFoundry code IBBoard <dev@ibboard.co.uk> parents: diff changeset	78 }

Mercurial > repos > IBDev-IBBoard.WarFoundry.API

annotate api/Factories/IWarFoundryFactory.cs @ 252:a54da5a8b5bb