Mercurial > repos > IBDev-IBBoard.WarFoundry.API
view api/Requirements/AbstractUnitRequirement.cs @ 29:d7899f462d8c
Re #11 - Document methods
* Document FileLoadFailure and rationalise constructors
Also added parameter for holding the Exception that caused the failure
author | IBBoard <dev@ibboard.co.uk> |
---|---|
date | Sat, 14 Mar 2009 20:14:07 +0000 |
parents | 306558904c2a |
children | 2f3cafb69799 |
line wrap: on
line source
// This file (AbstractUnitRequirement.cs) is a part of the IBBoard.WarFoundry.API project and is copyright 2009 IBBoard. // // The file and the library/program it is in are licensed under the GNU LGPL license, either version 3 of the License or (at your option) any later version. Please see COPYING.LGPL for more information and the full license. using System; using IBBoard.WarFoundry.API.Objects; namespace IBBoard.WarFoundry.API.Requirements { /// <summary> /// Base abstract class for all requirements related to adding/removing something from a Unit (e.g. adding equipment or abilities) /// </summary> public abstract class AbstractUnitRequirement : AbstractRequirement { protected abstract AbstractFailedRequirement CanAddToUnit(Unit unit); protected abstract AbstractFailedRequirement CanRemoveFromUnit(Unit unit); public override AbstractFailedRequirement CanAddToWarFoundryObject (WarFoundryObject obj) { AbstractFailedRequirement fail = null; if (obj is Unit) { fail = CanAddToUnit((Unit)obj); } else { fail = new FailedRequirement(this); } return fail; } public override AbstractFailedRequirement CanRemoveFromWarFoundryObject (WarFoundryObject obj) { AbstractFailedRequirement fail = null; if (obj is Unit) { fail = CanRemoveFromUnit((Unit)obj); } else { fail = new FailedRequirement(this); } return fail; } } }