annotate api/Commands/CreateAndAddUnitCommand.cs @ 298:483b491d18f4

Fixes #337: Merge API v0.1.1 changes into v0.2 * Merge translation-related changes from v0.1.1 branch
author IBBoard <dev@ibboard.co.uk>
date Mon, 17 Jan 2011 20:02:41 +0000
parents 391446c9b250
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
104
2f3cafb69799 Re #121: Migrate to AGPL license
IBBoard <dev@ibboard.co.uk>
parents: 89
diff changeset
1 // This file (CreateAndAddUnitCommand.cs) is a part of the IBBoard.WarFoundry.API project and is copyright 2007, 2008, 2009 IBBoard.
15
306558904c2a Re #1 - LGPL license all code
IBBoard <dev@ibboard.co.uk>
parents: 0
diff changeset
2 //
104
2f3cafb69799 Re #121: Migrate to AGPL license
IBBoard <dev@ibboard.co.uk>
parents: 89
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.
82
3ea0ab04352b * Fix line terminators
IBBoard <dev@ibboard.co.uk>
parents: 58
diff changeset
4
3ea0ab04352b * Fix line terminators
IBBoard <dev@ibboard.co.uk>
parents: 58
diff changeset
5 using System;
0
520818033bb6 Initial commit of WarFoundry code
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
6 using IBBoard.Commands;
520818033bb6 Initial commit of WarFoundry code
IBBoard <dev@ibboard.co.uk>
parents:
diff changeset
7 using IBBoard.Lang;
82
3ea0ab04352b * Fix line terminators
IBBoard <dev@ibboard.co.uk>
parents: 58
diff changeset
8 using IBBoard.WarFoundry.API.Objects;
3ea0ab04352b * Fix line terminators
IBBoard <dev@ibboard.co.uk>
parents: 58
diff changeset
9
3ea0ab04352b * Fix line terminators
IBBoard <dev@ibboard.co.uk>
parents: 58
diff changeset
10 namespace IBBoard.WarFoundry.API.Commands
3ea0ab04352b * Fix line terminators
IBBoard <dev@ibboard.co.uk>
parents: 58
diff changeset
11 {
3ea0ab04352b * Fix line terminators
IBBoard <dev@ibboard.co.uk>
parents: 58
diff changeset
12 public class CreateAndAddUnitCommand : Command
3ea0ab04352b * Fix line terminators
IBBoard <dev@ibboard.co.uk>
parents: 58
diff changeset
13 {
3ea0ab04352b * Fix line terminators
IBBoard <dev@ibboard.co.uk>
parents: 58
diff changeset
14 private UnitType addedUnitType;
83
89cc29b4c012 Re #90: Stop new units showing up twice
IBBoard <dev@ibboard.co.uk>
parents: 82
diff changeset
15 private ArmyCategory armyCat;
58
e53ed2d613a1 Re #61 - Complete structure of WarFoundry API objects
IBBoard <dev@ibboard.co.uk>
parents: 15
diff changeset
16 private Unit addedUnit;
298
483b491d18f4 Fixes #337: Merge API v0.1.1 changes into v0.2
IBBoard <dev@ibboard.co.uk>
parents: 215
diff changeset
17
83
89cc29b4c012 Re #90: Stop new units showing up twice
IBBoard <dev@ibboard.co.uk>
parents: 82
diff changeset
18 public CreateAndAddUnitCommand(UnitType toAdd, ArmyCategory armyCatTo)
58
e53ed2d613a1 Re #61 - Complete structure of WarFoundry API objects
IBBoard <dev@ibboard.co.uk>
parents: 15
diff changeset
19 {
e53ed2d613a1 Re #61 - Complete structure of WarFoundry API objects
IBBoard <dev@ibboard.co.uk>
parents: 15
diff changeset
20 addedUnitType = toAdd;
83
89cc29b4c012 Re #90: Stop new units showing up twice
IBBoard <dev@ibboard.co.uk>
parents: 82
diff changeset
21 armyCat = armyCatTo;
82
3ea0ab04352b * Fix line terminators
IBBoard <dev@ibboard.co.uk>
parents: 58
diff changeset
22 }
3ea0ab04352b * Fix line terminators
IBBoard <dev@ibboard.co.uk>
parents: 58
diff changeset
23
3ea0ab04352b * Fix line terminators
IBBoard <dev@ibboard.co.uk>
parents: 58
diff changeset
24 public override bool CanExecute()
3ea0ab04352b * Fix line terminators
IBBoard <dev@ibboard.co.uk>
parents: 58
diff changeset
25 {
298
483b491d18f4 Fixes #337: Merge API v0.1.1 changes into v0.2
IBBoard <dev@ibboard.co.uk>
parents: 215
diff changeset
26 return (addedUnitType != null && armyCat != null);
82
3ea0ab04352b * Fix line terminators
IBBoard <dev@ibboard.co.uk>
parents: 58
diff changeset
27 }
3ea0ab04352b * Fix line terminators
IBBoard <dev@ibboard.co.uk>
parents: 58
diff changeset
28
3ea0ab04352b * Fix line terminators
IBBoard <dev@ibboard.co.uk>
parents: 58
diff changeset
29 public override string Description
3ea0ab04352b * Fix line terminators
IBBoard <dev@ibboard.co.uk>
parents: 58
diff changeset
30 {
215
391446c9b250 Re #223: Use translations within the API
IBBoard <dev@ibboard.co.uk>
parents: 145
diff changeset
31 get
391446c9b250 Re #223: Use translations within the API
IBBoard <dev@ibboard.co.uk>
parents: 145
diff changeset
32 {
298
483b491d18f4 Fixes #337: Merge API v0.1.1 changes into v0.2
IBBoard <dev@ibboard.co.uk>
parents: 215
diff changeset
33 return Translation.GetTranslation("createAndAddUnitCommandDescription", "add unit of {0} to the army", addedUnitType.Name);
215
391446c9b250 Re #223: Use translations within the API
IBBoard <dev@ibboard.co.uk>
parents: 145
diff changeset
34 }
82
3ea0ab04352b * Fix line terminators
IBBoard <dev@ibboard.co.uk>
parents: 58
diff changeset
35 }
58
e53ed2d613a1 Re #61 - Complete structure of WarFoundry API objects
IBBoard <dev@ibboard.co.uk>
parents: 15
diff changeset
36
82
3ea0ab04352b * Fix line terminators
IBBoard <dev@ibboard.co.uk>
parents: 58
diff changeset
37 public override string UndoDescription
3ea0ab04352b * Fix line terminators
IBBoard <dev@ibboard.co.uk>
parents: 58
diff changeset
38 {
215
391446c9b250 Re #223: Use translations within the API
IBBoard <dev@ibboard.co.uk>
parents: 145
diff changeset
39 get
391446c9b250 Re #223: Use translations within the API
IBBoard <dev@ibboard.co.uk>
parents: 145
diff changeset
40 {
298
483b491d18f4 Fixes #337: Merge API v0.1.1 changes into v0.2
IBBoard <dev@ibboard.co.uk>
parents: 215
diff changeset
41 return Translation.GetTranslation("createAndAddUnitCommandUndoDescription", "remove unit of {0} from army", addedUnitType.Name);
215
391446c9b250 Re #223: Use translations within the API
IBBoard <dev@ibboard.co.uk>
parents: 145
diff changeset
42 }
82
3ea0ab04352b * Fix line terminators
IBBoard <dev@ibboard.co.uk>
parents: 58
diff changeset
43 }
3ea0ab04352b * Fix line terminators
IBBoard <dev@ibboard.co.uk>
parents: 58
diff changeset
44
3ea0ab04352b * Fix line terminators
IBBoard <dev@ibboard.co.uk>
parents: 58
diff changeset
45 public override bool Execute()
3ea0ab04352b * Fix line terminators
IBBoard <dev@ibboard.co.uk>
parents: 58
diff changeset
46 {
83
89cc29b4c012 Re #90: Stop new units showing up twice
IBBoard <dev@ibboard.co.uk>
parents: 82
diff changeset
47 addedUnit = new Unit(addedUnitType, armyCat);
82
3ea0ab04352b * Fix line terminators
IBBoard <dev@ibboard.co.uk>
parents: 58
diff changeset
48 this.Redo();
3ea0ab04352b * Fix line terminators
IBBoard <dev@ibboard.co.uk>
parents: 58
diff changeset
49 return true;
3ea0ab04352b * Fix line terminators
IBBoard <dev@ibboard.co.uk>
parents: 58
diff changeset
50 }
3ea0ab04352b * Fix line terminators
IBBoard <dev@ibboard.co.uk>
parents: 58
diff changeset
51
3ea0ab04352b * Fix line terminators
IBBoard <dev@ibboard.co.uk>
parents: 58
diff changeset
52 public override void Redo()
3ea0ab04352b * Fix line terminators
IBBoard <dev@ibboard.co.uk>
parents: 58
diff changeset
53 {
83
89cc29b4c012 Re #90: Stop new units showing up twice
IBBoard <dev@ibboard.co.uk>
parents: 82
diff changeset
54 armyCat.AddUnit(addedUnit);
82
3ea0ab04352b * Fix line terminators
IBBoard <dev@ibboard.co.uk>
parents: 58
diff changeset
55 }
3ea0ab04352b * Fix line terminators
IBBoard <dev@ibboard.co.uk>
parents: 58
diff changeset
56
3ea0ab04352b * Fix line terminators
IBBoard <dev@ibboard.co.uk>
parents: 58
diff changeset
57 public override void Undo()
89
cb3759c3ea19 * Code clean-up (line endings)
IBBoard <dev@ibboard.co.uk>
parents: 83
diff changeset
58 {
83
89cc29b4c012 Re #90: Stop new units showing up twice
IBBoard <dev@ibboard.co.uk>
parents: 82
diff changeset
59 armyCat.RemoveUnit(addedUnit);
82
3ea0ab04352b * Fix line terminators
IBBoard <dev@ibboard.co.uk>
parents: 58
diff changeset
60 }
3ea0ab04352b * Fix line terminators
IBBoard <dev@ibboard.co.uk>
parents: 58
diff changeset
61
3ea0ab04352b * Fix line terminators
IBBoard <dev@ibboard.co.uk>
parents: 58
diff changeset
62 public override string Name
3ea0ab04352b * Fix line terminators
IBBoard <dev@ibboard.co.uk>
parents: 58
diff changeset
63 {
3ea0ab04352b * Fix line terminators
IBBoard <dev@ibboard.co.uk>
parents: 58
diff changeset
64 get { return "Add new unit"; }
145
57517f472ab5 * Line ending cleanup
IBBoard <dev@ibboard.co.uk>
parents: 142
diff changeset
65 }
57517f472ab5 * Line ending cleanup
IBBoard <dev@ibboard.co.uk>
parents: 142
diff changeset
66
57517f472ab5 * Line ending cleanup
IBBoard <dev@ibboard.co.uk>
parents: 142
diff changeset
67 public Unit Unit
57517f472ab5 * Line ending cleanup
IBBoard <dev@ibboard.co.uk>
parents: 142
diff changeset
68 {
57517f472ab5 * Line ending cleanup
IBBoard <dev@ibboard.co.uk>
parents: 142
diff changeset
69 get { return addedUnit; }
82
3ea0ab04352b * Fix line terminators
IBBoard <dev@ibboard.co.uk>
parents: 58
diff changeset
70 }
3ea0ab04352b * Fix line terminators
IBBoard <dev@ibboard.co.uk>
parents: 58
diff changeset
71 }
3ea0ab04352b * Fix line terminators
IBBoard <dev@ibboard.co.uk>
parents: 58
diff changeset
72 }