Make action.MSB_GLYPH a function, action.get_msb_glyph.
[naja.git] / naja / actions.py
1 from naja.constants import ACTION_GLYPHS, BITS, CHESS_PIECES
2 from naja.sound import sound
3 from naja.utils import bit_glyphs, move_glyph, parse_bits
4
5
6 class LocationAction(object):
7     """
8     An action that may be performed on a location.
9     """
10
11     TEXT = None
12     GLYPHS = tuple()
13     MSB_GLYPH = None
14
15     def __init__(self, required_bits, **data):
16         self.required_bits = required_bits
17         self.data = data
18
19     def get_glyphs(self):
20         return self.GLYPHS
21
22     def get_msb_glyph(self):
23         return self.MSB_GLYPH
24
25     def get_text(self, location=None):
26         substitutions = self.data.copy()
27
28         if 'shift' in self.data:
29             substitutions['shift'] = self.data['shift']
30             substitutions['shift_glyph'] = ('{SHIFT_%s}'
31                                             % self.data['direction'].upper())
32         elif 'direction' in self.data:
33             substitutions['rowcol'] = {
34                 'NORTH': 'column',
35                 'SOUTH': 'column',
36                 'EAST': 'row',
37                 'WEST': 'row',
38             }[self.data['direction']]
39             substitutions['direction'] = '{%s}' % (substitutions['direction'],)
40
41         if 'chesspiece' in self.data:
42             substitutions['chesspiece_name'] = move_glyph(
43                 self.data['chesspiece'])
44
45         if 'rot_direction' in self.data:
46             substitutions['rot_direction_name'] = '{%s}' % (
47                 substitutions['rot_direction'],)
48
49         if location is None:
50             substitutions['location_bits'] = 'bits specified by this tile'
51         else:
52             substitutions['location_bits'] = bit_glyphs(
53                 location.bitwise_operand)
54
55         text = self.TEXT
56         if self.data.get('message', None) is not None:
57             text = self.data['message']
58
59         return text % substitutions
60
61     def check_available(self, player):
62         return player.bits.check_bits(self.required_bits)
63
64     def perform_action(self, board, location):
65         raise NotImplementedError(
66             "%s does not implement perform_action()." % (type(self).__name__,))
67
68     def check_and_clear_MSB(self, player):
69         if player.bits.check_bit(BITS.MSB):
70             player.bits.clear_bit(BITS.MSB)
71             return True
72         else:
73             return False
74
75     def export(self):
76         return {'required_bits': list(self.required_bits),
77                 'data': self.data,
78                 'action_class': self.__class__.__name__}
79
80
81 class DoNothing(LocationAction):
82     TEXT = "No effect."
83     GLYPHS = (ACTION_GLYPHS.NOTHING,)
84
85     def perform_action(self, board, location):
86         pass
87
88
89 class LoseHealthOrMSB(LocationAction):
90     TEXT = "Lose {HEALTH} or {MSB}."
91     MSB_GLYPH = ACTION_GLYPHS.DAMAGE
92
93     def perform_action(self, board, location):
94         if not self.check_and_clear_MSB(board.player):
95             sound.play_sound('awwww.ogg')
96             board.lose_health()
97
98
99 class SetBits(LocationAction):
100     TEXT = "Set %(location_bits)s."
101     GLYPHS = (ACTION_GLYPHS.SET_BITS,)
102
103     def perform_action(self, board, location):
104         board.player.bits.set_bits(location.bitwise_operand)
105
106
107 class ClearBits(LocationAction):
108     TEXT = "Clear %(location_bits)s."
109     GLYPHS = (ACTION_GLYPHS.CLEAR_BITS,)
110
111     def perform_action(self, board, location):
112         board.player.bits.clear_bits(location.bitwise_operand)
113
114
115 class ToggleBits(LocationAction):
116     TEXT = "Toggle %(location_bits)s."
117     GLYPHS = (ACTION_GLYPHS.TOGGLE_BITS,)
118
119     def perform_action(self, board, location):
120         board.player.bits.toggle_bits(location.bitwise_operand)
121
122
123 class GenericBits(LocationAction):
124     GLYPHS = (ACTION_GLYPHS.SET_BITS, ACTION_GLYPHS.CLEAR_BITS)
125
126     def __init__(self, *args, **kw):
127         super(GenericBits, self).__init__(*args, **kw)
128         self.set_bits = parse_bits(self.data.get('set', []))
129         self.clear_bits = parse_bits(self.data.get('clear', []))
130         self.toggle_bits = parse_bits(self.data.get('toggle', []))
131
132     def perform_action(self, board, location):
133         bits = board.player.bits
134         bits.set_bits(self.set_bits)
135         bits.toggle_bits(self.toggle_bits)
136         bits.clear_bits(self.clear_bits)
137
138     def get_text(self, location=None):
139         if 'message' in self.data:
140             return super(GenericBits, self).get_text()
141         parts = []
142         for template, bits in [
143                 ('Set %s.', self.set_bits), ('Clear %s.', self.clear_bits),
144                 ('Toggle %s', self.toggle_bits)]:
145             if bits:
146                 parts.append(template % (bit_glyphs(bits)))
147         return " ".join(parts)
148
149
150 class ShiftBits(LocationAction):
151     TEXT = "Barrel-shift player bits %(shift_glyph)s %(shift)s."
152     GLYPHS = (ACTION_GLYPHS.SHIFT_LEFT,)
153
154     def perform_action(self, board, location):
155         shift = self.data['shift']
156         if self.data['direction'] == 'left':
157             board.player.bits.shift_bits_left(shift)
158         else:
159             board.player.bits.shift_bits_right(shift)
160
161
162 class LoseHealthOrMSBAndSetBits(LocationAction):
163     TEXT = "Lose {HEALTH} or {MSB}, then set %(location_bits)s."
164     GLYPHS = (ACTION_GLYPHS.SET_BITS,)
165     MSB_GLYPH = ACTION_GLYPHS.DAMAGE
166
167     def perform_action(self, board, location):
168         if not self.check_and_clear_MSB(board.player):
169             sound.play_sound('awwww.ogg')
170             board.lose_health()
171         board.player.bits.set_bits(location.bitwise_operand)
172
173
174 class AcquireWinToken(LocationAction):
175     TEXT = "Gain {WINTOKEN}, then clear {RED,GREEN,BLUE}."
176     GLYPHS = (ACTION_GLYPHS.WINTOKEN,)
177
178     def perform_action(self, board, location):
179         sound.play_sound('yipee.ogg')
180         board.acquire_win_token()
181         board.player.bits.clear_bits(set([
182             BITS.RED, BITS.GREEN, BITS.BLUE,
183         ]))
184         if self.data.get('once', False):
185             location.actions.remove(self)
186
187
188 class GainHealth(LocationAction):
189     TEXT = "Gain {HEALTH}."
190     GLYPHS = (ACTION_GLYPHS.HEAL,)
191
192     def perform_action(self, board, location):
193         sound.play_sound('aha.ogg')
194         board.gain_health()
195
196
197 class GainHealthAndClearBitsOrMSB(LocationAction):
198     TEXT = "Gain {HEALTH}, then clear %(location_bits)s or {MSB}."
199     GLYPHS = (ACTION_GLYPHS.HEAL,)
200     MSB_GLYPH = ACTION_GLYPHS.CLEAR_BITS
201
202     def perform_action(self, board, location):
203         sound.play_sound('aha.ogg')
204         board.gain_health()
205         if not self.check_and_clear_MSB(board.player):
206             board.player.bits.clear_bits(location.bitwise_operand)
207
208
209 class ShiftLocations(LocationAction):
210     TEXT = "Shift current %(rowcol)s %(direction)s."
211     GLYPHS = (ACTION_GLYPHS.CHANGE_BOARD,)
212
213     def perform_action(self, board, location):
214         sound.play_sound('grind.ogg')
215         board.shift_locations(self.data['direction'])
216
217
218 class RotateLocations(LocationAction):
219     TEXT = "Rotate adjacent tiles %(rot_direction_name)s."
220     GLYPHS = (ACTION_GLYPHS.CHANGE_BOARD,)
221
222     def perform_action(self, board, location):
223         sound.play_sound('grind.ogg')
224         board.rotate_locations(self.data['rot_direction'])
225
226
227 class AllowChessMove(LocationAction):
228     TEXT = "Move like a %(chesspiece_name)s for one turn."
229     GLYPHS = (ACTION_GLYPHS.MOVEMENT,)
230
231     def perform_action(self, board, location):
232         if self.data['chesspiece'] in CHESS_PIECES:
233             chesspiece = CHESS_PIECES[self.data['chesspiece']]
234             board.allow_chess_move(chesspiece)
235
236
237 class AllowChessMoveIfMSB(LocationAction):
238     TEXT = (
239         "Clear {MSB} and move like a %(chesspiece_name)s for one turn if it "
240         "was set.")
241     MSB_GLYPH = ACTION_GLYPHS.MOVEMENT
242
243     def perform_action(self, board, location):
244         if self.data['chesspiece'] in CHESS_PIECES:
245             if self.check_and_clear_MSB(board.player):
246                 chesspiece = CHESS_PIECES[self.data['chesspiece']]
247                 board.allow_chess_move(chesspiece)
248
249
250 class GainMSB(LocationAction):
251     TEXT = "Set {MSB}."
252     GLYPHS = (ACTION_GLYPHS.MSB,)
253
254     def perform_action(self, board, location):
255         board.player.bits.set_bit(BITS.MSB)