annotate src/parpg/components/equip.py @ 99:c045f97b7dbc

Renamed container to wearer in the equipable component.
author KarstenBock@gmx.net
date Wed, 21 Sep 2011 17:37:30 +0200
parents c4c940fcbc83
children 853ec1b277c7
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)
0f659c7675f6 Changed "import bGrease" to "import parpg.bGrease".
KarstenBock@gmx.net
parents: 91
diff changeset
40 return old_item
0f659c7675f6 Changed "import bGrease" to "import parpg.bGrease".
KarstenBock@gmx.net
parents: 91
diff changeset
41 except AttributeError:
0f659c7675f6 Changed "import bGrease" to "import parpg.bGrease".
KarstenBock@gmx.net
parents: 91
diff changeset
42 raise SlotInvalidError(slot)
0f659c7675f6 Changed "import bGrease" to "import parpg.bGrease".
KarstenBock@gmx.net
parents: 91
diff changeset
43 return None
98
c4c940fcbc83 Added get_equipable and take_equipable functions.
KarstenBock@gmx.net
parents: 92
diff changeset
44
c4c940fcbc83 Added get_equipable and take_equipable functions.
KarstenBock@gmx.net
parents: 92
diff changeset
45 def get_equipable(wearer, slot):
c4c940fcbc83 Added get_equipable and take_equipable functions.
KarstenBock@gmx.net
parents: 92
diff changeset
46 """Return the equipable in the given slot"""
c4c940fcbc83 Added get_equipable and take_equipable functions.
KarstenBock@gmx.net
parents: 92
diff changeset
47 try:
c4c940fcbc83 Added get_equipable and take_equipable functions.
KarstenBock@gmx.net
parents: 92
diff changeset
48 item = getattr(wearer, slot)
c4c940fcbc83 Added get_equipable and take_equipable functions.
KarstenBock@gmx.net
parents: 92
diff changeset
49 return item
c4c940fcbc83 Added get_equipable and take_equipable functions.
KarstenBock@gmx.net
parents: 92
diff changeset
50 except AttributeError:
c4c940fcbc83 Added get_equipable and take_equipable functions.
KarstenBock@gmx.net
parents: 92
diff changeset
51 raise SlotInvalidError(slot)
c4c940fcbc83 Added get_equipable and take_equipable functions.
KarstenBock@gmx.net
parents: 92
diff changeset
52
c4c940fcbc83 Added get_equipable and take_equipable functions.
KarstenBock@gmx.net
parents: 92
diff changeset
53 def take_equipable(wearer, slot):
c4c940fcbc83 Added get_equipable and take_equipable functions.
KarstenBock@gmx.net
parents: 92
diff changeset
54 """Remove equipable from the given slot and return it"""
c4c940fcbc83 Added get_equipable and take_equipable functions.
KarstenBock@gmx.net
parents: 92
diff changeset
55 item = get_equipable(wearer, slot)
c4c940fcbc83 Added get_equipable and take_equipable functions.
KarstenBock@gmx.net
parents: 92
diff changeset
56 setattr(wearer, slot, None)
c4c940fcbc83 Added get_equipable and take_equipable functions.
KarstenBock@gmx.net
parents: 92
diff changeset
57 return item
c4c940fcbc83 Added get_equipable and take_equipable functions.
KarstenBock@gmx.net
parents: 92
diff changeset
58
91
1bd609af9329 Added equip function.
KarstenBock@gmx.net
parents: 90
diff changeset
59