Overrideable messages
[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
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_text(self, location=None):
20         substitutions = self.data.copy()
21
22         if 'shift' in self.data:
23             substitutions['shift'] = self.data['shift']
24             substitutions['shift_glyph'] = ('{SHIFT_%s}'
25                                             % self.data['direction'].upper())
26         elif 'direction' in self.data:
27             substitutions['rowcol'] = {
28                 'NORTH': 'column',
29                 'SOUTH': 'column',
30                 'EAST': 'row',
31                 'WEST': 'row',
32             }[self.data['direction']]
33             substitutions['direction'] = '{%s}' % (substitutions['direction'],)
34
35         if 'chesspiece' in self.data:
36             substitutions['chesspiece_name'] = move_glyph(
37                 self.data['chesspiece'])
38
39         if 'rot_direction' in self.data:
40             substitutions['rot_direction_name'] = '{%s}' % (
41                 substitutions['rot_direction'],)
42
43         if location is None:
44             substitutions['location_bits'] = 'bits specified by this tile'
45         else:
46             substitutions['location_bits'] = bit_glyphs(
47                 location.bitwise_operand)
48
49         text = self.TEXT
50         if self.data.get('message', None) is not None:
51             text = self.data['message']
52
53         return text % substitutions
54
55     def check_available(self, player):
56         return player.bits.check_bits(self.required_bits)
57
58     def perform_action(self, board, location):
59         raise NotImplementedError(
60             "%s does not implement perform_action()." % (type(self).__name__,))
61
62     def check_and_clear_MSB(self, player):
63         if player.bits.check_bit(BITS.MSB):
64             player.bits.clear_bit(BITS.MSB)
65             return True
66         else:
67             return False
68
69     def export(self):
70         return {'required_bits': list(self.required_bits),
71                 'data': self.data,
72                 'action_class': self.__class__.__name__}
73
74
75 class DoNothing(LocationAction):
76     TEXT = "No effect."
77     GLYPHS = (ACTION_GLYPHS.NOTHING,)
78
79     def perform_action(self, board, location):
80         pass
81
82
83 class LoseHealthOrMSB(LocationAction):
84     TEXT = "Lose {HEALTH} or {MSB}."
85     MSB_GLYPH = ACTION_GLYPHS.DAMAGE
86
87     def perform_action(self, board, location):
88         if not self.check_and_clear_MSB(board.player):
89             sound.play_sound('awwww.ogg')
90             board.lose_health()
91
92
93 class SetBits(LocationAction):
94     TEXT = "Set %(location_bits)s."
95     GLYPHS = (ACTION_GLYPHS.SET_BITS,)
96
97     def perform_action(self, board, location):
98         board.player.bits.set_bits(location.bitwise_operand)
99
100
101 class ToggleBits(LocationAction):
102     TEXT = "Toggle %(location_bits)s."
103     GLYPHS = (ACTION_GLYPHS.TOGGLE_BITS,)
104
105     def perform_action(self, board, location):
106         board.player.bits.toggle_bits(location.bitwise_operand)
107
108
109 class ShiftBits(LocationAction):
110     TEXT = "Barrel-shift player bits %(shift_glyph)s %(shift)s."
111     GLYPHS = (ACTION_GLYPHS.SHIFT_LEFT,)
112
113     def perform_action(self, board, location):
114         shift = self.data['shift']
115         if self.data['direction'] == 'left':
116             board.player.bits.shift_bits_left(shift)
117         else:
118             board.player.bits.shift_bits_right(shift)
119
120
121 class LoseHealthOrMSBAndSetBits(LocationAction):
122     TEXT = "Lose {HEALTH} or {MSB}, then set %(location_bits)s."
123     GLYPHS = (ACTION_GLYPHS.SET_BITS,)
124     MSB_GLYPH = ACTION_GLYPHS.DAMAGE
125
126     def perform_action(self, board, location):
127         if not self.check_and_clear_MSB(board.player):
128             sound.play_sound('awwww.ogg')
129             board.lose_health()
130         board.player.bits.set_bits(location.bitwise_operand)
131
132
133 class AcquireWinToken(LocationAction):
134     TEXT = "Gain {WINTOKEN}, then clear {RED,GREEN,BLUE}."
135     GLYPHS = (ACTION_GLYPHS.WINTOKEN,)
136
137     def perform_action(self, board, location):
138         sound.play_sound('yipee.ogg')
139         board.acquire_win_token()
140         board.player.bits.clear_bits(set([
141             BITS.RED, BITS.GREEN, BITS.BLUE,
142         ]))
143
144
145 class GainHealth(LocationAction):
146     TEXT = "Gain {HEALTH}."
147     GLYPHS = (ACTION_GLYPHS.HEAL,)
148
149     def perform_action(self, board, location):
150         sound.play_sound('aha.ogg')
151         board.gain_health()
152
153
154 class GainHealthAndClearBitsOrMSB(LocationAction):
155     TEXT = "Gain {HEALTH}, then clear %(location_bits)s or {MSB}."
156     GLYPHS = (ACTION_GLYPHS.HEAL,)
157     MSB_GLYPH = ACTION_GLYPHS.CLEAR_BITS
158
159     def perform_action(self, board, location):
160         sound.play_sound('aha.ogg')
161         board.gain_health()
162         if not self.check_and_clear_MSB(board.player):
163             board.player.bits.clear_bits(location.bitwise_operand)
164
165
166 class ShiftLocations(LocationAction):
167     TEXT = "Shift current %(rowcol)s %(direction)s."
168     GLYPHS = (ACTION_GLYPHS.CHANGE_BOARD,)
169
170     def perform_action(self, board, location):
171         sound.play_sound('grind.ogg')
172         board.shift_locations(self.data['direction'])
173
174
175 class RotateLocations(LocationAction):
176     TEXT = "Rotate adjacent tiles %(rot_direction_name)s."
177     GLYPHS = (ACTION_GLYPHS.CHANGE_BOARD,)
178
179     def perform_action(self, board, location):
180         sound.play_sound('grind.ogg')
181         board.rotate_locations(self.data['rot_direction'])
182
183
184 class AllowChessMove(LocationAction):
185     TEXT = "Move like a %(chesspiece_name)s for one turn."
186     GLYPHS = (ACTION_GLYPHS.MOVEMENT,)
187
188     def perform_action(self, board, location):
189         if self.data['chesspiece'] in CHESS_PIECES:
190             chesspiece = CHESS_PIECES[self.data['chesspiece']]
191             board.allow_chess_move(chesspiece)
192
193
194 class AllowChessMoveIfMSB(LocationAction):
195     TEXT = "Clear {MSB} and move like a %(chesspiece_name)s for one turn."
196     MSB_GLYPH = ACTION_GLYPHS.MOVEMENT
197
198     def perform_action(self, board, location):
199         if self.data['chesspiece'] in CHESS_PIECES:
200             if self.check_and_clear_MSB(board.player):
201                 chesspiece = CHESS_PIECES[self.data['chesspiece']]
202                 board.allow_chess_move(chesspiece)
203
204
205 class GainMSB(LocationAction):
206     TEXT = "Set {MSB}."
207     GLYPHS = (ACTION_GLYPHS.MSB,)
208
209     def perform_action(self, board, location):
210         board.player.bits.set_bit(BITS.MSB)