Mercurial > repos > IBDev-IBBoard.WarFoundry.API
view API/Objects/IWarFoundryStagedLoadObject.cs @ 431:c8002429ab45
Re #366: Rewrite equipment handling and limits
* Remove code added for #356 and work without limiting
* Move "Calculate number taken" method to util class
author | IBBoard <dev@ibboard.co.uk> |
---|---|
date | Sat, 12 Nov 2011 20:35:15 +0000 |
parents | 3c4a6403a88c |
children |
line wrap: on
line source
// This file (IWarFoundryStagedLoadObject.cs) is a part of the IBBoard.WarFoundry.API project and is copyright 2007, 2008, 2009 IBBoard. // // 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. using System; using ICSharpCode.SharpZipLib.Zip; using IBBoard.WarFoundry.API.Factories; namespace IBBoard.WarFoundry.API.Objects { public interface IWarFoundryStagedLoadObject : IWarFoundryObject { /// <summary> /// Checks whether the object has been fully loaded or whether only the first stage of loading has been performed. /// If the object is not fully loaded then the method must finish loading the object. /// </summary> void EnsureFullyLoaded(); /// <value> /// Gets the <code>AbstractNativeWarFoundryFactory</code> that created the object. /// </value> IWarFoundryFactory Factory { get; } /// <value> /// Returns <code>true</code> if the object has been fully loaded with all data, else returns <code>false</code> /// </value> bool IsFullyLoaded { get; } /// <value> /// Returns <code>true</code> if the object is in the process of being fully loaded with all data, else returns <code>false</code> /// </value> bool IsLoading { get; } /// <summary> /// Marks the object as fully loaded so that no more load checking is required. /// </summary> void SetAsFullyLoaded(); /// <summary> /// Markes the object as being in the process of being fully loaded. /// </summary> void SetAsLoading(); } }