annotate src/parpg/components/equip.py @ 100:853ec1b277c7

Functions in equip.py will now correctly set the equipable's attributes.
author KarstenBock@gmx.net
date Wed, 21 Sep 2011 17:39:07 +0200
parents c4c940fcbc83
children 3d9b6405bd86
rev   line source
92
0f659c7675f6 Changed "import bGrease" to "import parpg.bGrease".
KarstenBock@gmx.net
parents: 91
diff changeset
1 # This program is free software: you can redistribute it and/or modify
0f659c7675f6 Changed "import bGrease" to "import parpg.bGrease".
KarstenBock@gmx.net
parents: 91
diff changeset
2 # it under the terms of the GNU General Public License as published by
0f659c7675f6 Changed "import bGrease" to "import parpg.bGrease".
KarstenBock@gmx.net
parents: 91
diff changeset
3 # the Free Software Foundation, either version 3 of the License, or
0f659c7675f6 Changed "import bGrease" to "import parpg.bGrease".
KarstenBock@gmx.net
parents: 91
diff changeset
4 # (at your option) any later version.
0f659c7675f6 Changed "import bGrease" to "import parpg.bGrease".
KarstenBock@gmx.net
parents: 91
diff changeset
5 #
0f659c7675f6 Changed "import bGrease" to "import parpg.bGrease".
KarstenBock@gmx.net
parents: 91
diff changeset
6 # This program is distributed in the hope that it will be useful,
0f659c7675f6 Changed "import bGrease" to "import parpg.bGrease".
KarstenBock@gmx.net
parents: 91
diff changeset
7 # but WITHOUT ANY WARRANTY; without even the implied warranty of
0f659c7675f6 Changed "import bGrease" to "import parpg.bGrease".
KarstenBock@gmx.net
parents: 91
diff changeset
8 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
0f659c7675f6 Changed "import bGrease" to "import parpg.bGrease".
KarstenBock@gmx.net
parents: 91
diff changeset
9 # GNU General Public License for more details.
0f659c7675f6 Changed "import bGrease" to "import parpg.bGrease".
KarstenBock@gmx.net
parents: 91
diff changeset
10 #
0f659c7675f6 Changed "import bGrease" to "import parpg.bGrease".
KarstenBock@gmx.net
parents: 91
diff changeset
11 # You should have received a copy of the GNU General Public License
0f659c7675f6 Changed "import bGrease" to "import parpg.bGrease".
KarstenBock@gmx.net
parents: 91
diff changeset
12 # along with this program. If not, see <http://www.gnu.org/licenses/>.
0f659c7675f6 Changed "import bGrease" to "import parpg.bGrease".
KarstenBock@gmx.net
parents: 91
diff changeset
13
0f659c7675f6 Changed "import bGrease" to "import parpg.bGrease".
KarstenBock@gmx.net
parents: 91
diff changeset
14 from parpg.bGrease.component import Component
0f659c7675f6 Changed "import bGrease" to "import parpg.bGrease".
KarstenBock@gmx.net
parents: 91
diff changeset
15
0f659c7675f6 Changed "import bGrease" to "import parpg.bGrease".
KarstenBock@gmx.net
parents: 91
diff changeset
16 class Equip(Component):
0f659c7675f6 Changed "import bGrease" to "import parpg.bGrease".
KarstenBock@gmx.net
parents: 91
diff changeset
17 """
0f659c7675f6 Changed "import bGrease" to "import parpg.bGrease".
KarstenBock@gmx.net
parents: 91
diff changeset
18 Component that stores the equipment (what is being worn/wieled).
0f659c7675f6 Changed "import bGrease" to "import parpg.bGrease".
KarstenBock@gmx.net
parents: 91
diff changeset
19 """
0f659c7675f6 Changed "import bGrease" to "import parpg.bGrease".
KarstenBock@gmx.net
parents: 91
diff changeset
20
0f659c7675f6 Changed "import bGrease" to "import parpg.bGrease".
KarstenBock@gmx.net
parents: 91
diff changeset
21 def __init__(self):
0f659c7675f6 Changed "import bGrease" to "import parpg.bGrease".
KarstenBock@gmx.net
parents: 91
diff changeset
22 Component.__init__(self, head=object, body=object, leg=object, feet=object, l_arm=object, r_arm=object)
0f659c7675f6 Changed "import bGrease" to "import parpg.bGrease".
KarstenBock@gmx.net
parents: 91
diff changeset
23
0f659c7675f6 Changed "import bGrease" to "import parpg.bGrease".
KarstenBock@gmx.net
parents: 91
diff changeset
24 class SlotInvalidError(Exception):
0f659c7675f6 Changed "import bGrease" to "import parpg.bGrease".
KarstenBock@gmx.net
parents: 91
diff changeset
25 """Error that gets raised when the slot is invalid."""
0f659c7675f6 Changed "import bGrease" to "import parpg.bGrease".
KarstenBock@gmx.net
parents: 91
diff changeset
26
0f659c7675f6 Changed "import bGrease" to "import parpg.bGrease".
KarstenBock@gmx.net
parents: 91
diff changeset
27 def __init__(self, slot):
0f659c7675f6 Changed "import bGrease" to "import parpg.bGrease".
KarstenBock@gmx.net
parents: 91
diff changeset
28 self.slot = slot
0f659c7675f6 Changed "import bGrease" to "import parpg.bGrease".
KarstenBock@gmx.net
parents: 91
diff changeset
29
0f659c7675f6 Changed "import bGrease" to "import parpg.bGrease".
KarstenBock@gmx.net
parents: 91
diff changeset
30 def __str__(self):
0f659c7675f6 Changed "import bGrease" to "import parpg.bGrease".
KarstenBock@gmx.net
parents: 91
diff changeset
31 return "\"%s\" is not a valid slot." % self.slot
0f659c7675f6 Changed "import bGrease" to "import parpg.bGrease".
KarstenBock@gmx.net
parents: 91
diff changeset
32
0f659c7675f6 Changed "import bGrease" to "import parpg.bGrease".
KarstenBock@gmx.net
parents: 91
diff changeset
33 def equip(wearer, equipable, slot):
0f659c7675f6 Changed "import bGrease" to "import parpg.bGrease".
KarstenBock@gmx.net
parents: 91
diff changeset
34 """Equip the wearer with the given equipable.
0f659c7675f6 Changed "import bGrease" to "import parpg.bGrease".
KarstenBock@gmx.net
parents: 91
diff changeset
35 @returns The equipable that was at the given slot, or None"""
0f659c7675f6 Changed "import bGrease" to "import parpg.bGrease".
KarstenBock@gmx.net
parents: 91
diff changeset
36 if slot in equipable.possible_slots:
0f659c7675f6 Changed "import bGrease" to "import parpg.bGrease".
KarstenBock@gmx.net
parents: 91
diff changeset
37 try:
0f659c7675f6 Changed "import bGrease" to "import parpg.bGrease".
KarstenBock@gmx.net
parents: 91
diff changeset
38 old_item = getattr(wearer, slot)
0f659c7675f6 Changed "import bGrease" to "import parpg.bGrease".
KarstenBock@gmx.net
parents: 91
diff changeset
39 setattr(wearer, slot, equipable)
100
853ec1b277c7 Functions in equip.py will now correctly set the equipable's attributes.
KarstenBock@gmx.net
parents: 98
diff changeset
40 equipable.in_slot = slot
853ec1b277c7 Functions in equip.py will now correctly set the equipable's attributes.
KarstenBock@gmx.net
parents: 98
diff changeset
41 equipable.wearer = wearer
92
0f659c7675f6 Changed "import bGrease" to "import parpg.bGrease".
KarstenBock@gmx.net
parents: 91
diff changeset
42 return old_item
0f659c7675f6 Changed "import bGrease" to "import parpg.bGrease".
KarstenBock@gmx.net
parents: 91
diff changeset
43 except AttributeError:
0f659c7675f6 Changed "import bGrease" to "import parpg.bGrease".
KarstenBock@gmx.net
parents: 91
diff changeset
44 raise SlotInvalidError(slot)
0f659c7675f6 Changed "import bGrease" to "import parpg.bGrease".
KarstenBock@gmx.net
parents: 91
diff changeset
45 return None
98
c4c940fcbc83 Added get_equipable and take_equipable functions.
KarstenBock@gmx.net
parents: 92
diff changeset
46
c4c940fcbc83 Added get_equipable and take_equipable functions.
KarstenBock@gmx.net
parents: 92
diff changeset
47 def get_equipable(wearer, slot):
c4c940fcbc83 Added get_equipable and take_equipable functions.
KarstenBock@gmx.net
parents: 92
diff changeset
48 """Return the equipable in the given slot"""
c4c940fcbc83 Added get_equipable and take_equipable functions.
KarstenBock@gmx.net
parents: 92
diff changeset
49 try:
c4c940fcbc83 Added get_equipable and take_equipable functions.
KarstenBock@gmx.net
parents: 92
diff changeset
50 item = getattr(wearer, slot)
c4c940fcbc83 Added get_equipable and take_equipable functions.
KarstenBock@gmx.net
parents: 92
diff changeset
51 return item
c4c940fcbc83 Added get_equipable and take_equipable functions.
KarstenBock@gmx.net
parents: 92
diff changeset
52 except AttributeError:
c4c940fcbc83 Added get_equipable and take_equipable functions.
KarstenBock@gmx.net
parents: 92
diff changeset
53 raise SlotInvalidError(slot)
c4c940fcbc83 Added get_equipable and take_equipable functions.
KarstenBock@gmx.net
parents: 92
diff changeset
54
c4c940fcbc83 Added get_equipable and take_equipable functions.
KarstenBock@gmx.net
parents: 92
diff changeset
55 def take_equipable(wearer, slot):
c4c940fcbc83 Added get_equipable and take_equipable functions.
KarstenBock@gmx.net
parents: 92
diff changeset
56 """Remove equipable from the given slot and return it"""
c4c940fcbc83 Added get_equipable and take_equipable functions.
KarstenBock@gmx.net
parents: 92
diff changeset
57 item = get_equipable(wearer, slot)
100
853ec1b277c7 Functions in equip.py will now correctly set the equipable's attributes.
KarstenBock@gmx.net
parents: 98
diff changeset
58 setattr(wearer, slot, None)
853ec1b277c7 Functions in equip.py will now correctly set the equipable's attributes.
KarstenBock@gmx.net
parents: 98
diff changeset
59 if item:
853ec1b277c7 Functions in equip.py will now correctly set the equipable's attributes.
KarstenBock@gmx.net
parents: 98
diff changeset
60 item.in_slot = None
853ec1b277c7 Functions in equip.py will now correctly set the equipable's attributes.
KarstenBock@gmx.net
parents: 98
diff changeset
61 item.wearer = None
98
c4c940fcbc83 Added get_equipable and take_equipable functions.
KarstenBock@gmx.net
parents: 92
diff changeset
62 return item
c4c940fcbc83 Added get_equipable and take_equipable functions.
KarstenBock@gmx.net
parents: 92
diff changeset
63
91
1bd609af9329 Added equip function.
KarstenBock@gmx.net
parents: 90
diff changeset
64