home · contact · privacy
Fix empty portal/annotation lists counting as None, erronously triggering thing data...
[plomrogue2] / plomrogue / game.py
1 from plomrogue.errors import GameError, PlayError
2 from plomrogue.io import GameIO
3 from plomrogue.misc import quote
4 from plomrogue.mapping import YX, MapGeometrySquare, MapGeometryHex, Map
5 import string
6 import datetime
7
8
9
10 class GameBase:
11
12     def __init__(self):
13         self.turn = 0
14         self.things = []
15         self.map_geometry = MapGeometrySquare(YX(32, 32))
16         self.commands = {}
17
18     def get_thing(self, id_):
19         for thing in self.things:
20             if id_ == thing.id_:
21                 return thing
22         return None
23
24     def _register_object(self, obj, obj_type_desc, prefix):
25         if not obj.__name__.startswith(prefix):
26             raise GameError('illegal %s object name: %s' % (obj_type_desc, obj.__name__))
27         obj_name = obj.__name__[len(prefix):]
28         d = getattr(self, obj_type_desc + 's')
29         d[obj_name] = obj
30
31     def register_command(self, command):
32         self._register_object(command, 'command', 'cmd_')
33
34
35
36 class SaveableMap(Map):
37     modified = False
38
39     def __setitem__(self, *args, **kwargs):
40         super().__setitem__(*args, **kwargs)
41         self.modified = True
42
43     def set_line(self, *args, **kwargs):
44         super().set_line(*args, **kwargs)
45         self.modified = True
46
47     def inside(self, yx):
48         if yx.y < 0 or yx.x < 0 or \
49            yx.y >= self.geometry.size.y or yx.x >= self.geometry.size.x:
50             return False
51         return True
52
53     def draw_presets(self, alternate_hex=0):
54         old_modified = self.modified
55         if type(self.geometry) == MapGeometrySquare:
56             self.set_line(0, 'X' * self.geometry.size.x)
57             self.set_line(1, 'X' * self.geometry.size.x)
58             self.set_line(2, 'X' * self.geometry.size.x)
59             self.set_line(3, 'X' * self.geometry.size.x)
60             self.set_line(4, 'X' * self.geometry.size.x)
61             for y in range(self.geometry.size.y):
62                 self[YX(y, 0)] = 'X'
63                 self[YX(y, 1)] = 'X'
64                 self[YX(y, 2)] = 'X'
65                 self[YX(y, 3)] = 'X'
66                 self[YX(y, 4)] = 'X'
67         elif type(self.geometry) == MapGeometryHex:
68             # TODO: for this to work we need a map side length divisible by 6.
69
70             def draw_grid(offset=YX(0, 0)):
71                 dirs = ('DOWNRIGHT', 'RIGHT', 'UPRIGHT', 'RIGHT')
72
73                 def draw_snake(start):
74                     keep_running = True
75                     yx = start
76                     if self.inside(yx):
77                         self[yx] = 'X'
78                     while keep_running:
79                         for direction in dirs:
80                             if not keep_running:
81                                 break
82                             for dir_progress in range(distance):
83                                 mover = getattr(self.geometry, 'move__' + direction)
84                                 yx = mover(yx)
85                                 if yx.x >= self.geometry.size.x:
86                                     keep_running = False
87                                     break
88                                 if self.inside(yx):
89                                     self[yx] = 'X'
90
91                 if alternate_hex:
92                     draw_snake(offset + YX(0, 0))
93                 draw_snake(offset + YX((0 + alternate_hex) * distance,
94                            -int(1.5 * distance)))
95                 draw_snake(offset + YX((1 + alternate_hex) * distance,
96                            0))
97                 draw_snake(offset + YX((2 + alternate_hex) * distance,
98                            -int(1.5 * distance)))
99
100             distance = self.geometry.size.y // 3
101             draw_grid()
102             draw_grid(YX(2, 0))
103             draw_grid(YX(0, 2))
104             draw_grid(YX(1, 0))
105             draw_grid(YX(0, 1))
106             draw_grid(YX(-1, 0))
107             draw_grid(YX(0, -1))
108             draw_grid(YX(-2, 0))
109             draw_grid(YX(0, -2))
110         self.modified = old_modified
111
112
113
114 import os
115 class Game(GameBase):
116
117     def __init__(self, save_file, *args, **kwargs):
118         from plomrogue.misc import Terrain
119         super().__init__(*args, **kwargs)
120         self.changed = True
121         self.changed_tiles = {'fov': [], 'other': []}
122         self.io = GameIO(self, save_file)
123         self.tasks = {}
124         self.thing_types = {}
125         self.sessions = {}
126         self.faces = {}
127         self.hats = {}
128         self.maps = {}
129         self.map_controls = {}
130         self.map_control_passwords = {}
131         self.annotations = {}
132         self.spawn_point = YX(0, 0), YX(0, 0)
133         self.portals = {}
134         self.player_chars = string.digits + string.ascii_letters
135         self.players_hat_chars = {}
136         self.player_char_i = -1
137         self.admin_passwords = []
138         self.send_gamestate_interval = datetime.timedelta(seconds=0.04)
139         self.last_send_gamestate = datetime.datetime.now() -\
140             self.send_gamestate_interval
141         self.terrains = {
142             '.': Terrain('.', 'floor'),
143             'X': Terrain('X', 'wall', blocks_light=True, blocks_sound=True,
144                          blocks_movement=True),
145             '=': Terrain('=', 'glass', blocks_sound=True, blocks_movement=True),
146             'T': Terrain('T', 'table', blocks_movement=True),
147         }
148         if os.path.exists(self.io.save_file):
149             if not os.path.isfile(self.io.save_file):
150                 raise GameError('save file path refers to non-file')
151
152     def register_thing_type(self, thing_type):
153         self._register_object(thing_type, 'thing_type', 'Thing_')
154
155     def register_task(self, task):
156         self._register_object(task, 'task', 'Task_')
157
158     def read_savefile(self):
159         if os.path.exists(self.io.save_file):
160             with open(self.io.save_file, 'r') as f:
161                 lines = f.readlines()
162             for i in range(len(lines)):
163                 line = lines[i]
164                 print("FILE INPUT LINE %5s: %s" % (i, line), end='')
165                 self.io.handle_input(line, god_mode=True)
166
167     def can_do_thing_with_pw(self, thing, pw):
168         if thing.protection in self.map_control_passwords.keys():
169             if pw != self.map_control_passwords[thing.protection]:
170                 return False
171         return True
172
173     def can_do_tile_with_pw(self, big_yx, little_yx, pw):
174         map_control = self.get_map(big_yx, 'control')
175         tile_class = map_control[little_yx]
176         if tile_class in self.map_control_passwords.keys():
177             tile_pw = self.map_control_passwords[tile_class]
178             if pw != tile_pw:
179                 return False
180         return True
181
182     def get_string_options(self, string_option_type):
183         if string_option_type == 'direction':
184             return self.map_geometry.directions
185         elif string_option_type == 'direction+here':
186             return ['HERE'] + self.map_geometry.directions
187         elif string_option_type == 'char':
188             return [c for c in
189                     string.digits + string.ascii_letters + string.punctuation + ' ']
190         elif string_option_type == 'map_geometry':
191             return ['Hex', 'Square']
192         elif string_option_type == 'thing_type':
193             return self.thing_types.keys()
194         return None
195
196     def get_map_geometry_shape(self):
197         return self.map_geometry.__class__.__name__[len('MapGeometry'):]
198
199     def get_player(self, connection_id):
200         if connection_id not in self.sessions:
201             return None
202         player = self.get_thing(self.sessions[connection_id]['thing_id'])
203         return player
204
205     def get_face(self, t):
206         if t.type_ == 'Player':
207             if t.name in self.faces:
208                 return self.faces[t.name]
209             else:
210                 return '/O  O\\' + '| oo |' + '\\>--</'
211         return None
212
213     def remove_thing(self, t):
214         if t.carrying:
215             t.uncarry()
216         self.things.remove(t)
217         self.record_change(t.position, 'other')
218         if t.blocks_light:
219             self.record_change(t.position, 'fov')
220
221     def add_thing(self, type_, position, id_=0):
222         t_old = None
223         if id_ > 0:
224             t_old = self.get_thing(id_)
225         t = self.thing_types[type_](self, id_=id_, position=position)
226         if t_old:
227             self.things[self.things.index(t_old)] = t
228         else:
229             self.things += [t]
230         self.record_change(t.position, 'other')
231         if t.blocks_light:
232             self.record_change(t.position, 'fov')
233         return t
234
235     def send_gamestate(self, connection_id=None):
236         """Send out game state data relevant to clients."""
237
238         # TODO: limit to connection_id if provided
239         from plomrogue.mapping import FovMap
240         import multiprocessing
241         if connection_id:
242             c_ids = [connection_id]
243         else:
244             c_ids = [c_id for c_id in self.sessions]
245         # Only recalc FOVs for players with ._fov = None
246         player_fovs = []
247         player_ids_send_fov = []
248         player_ids_send_other = []
249         for c_id in c_ids:
250             player = self.get_player(c_id)
251             if not player._fov:
252                 player.prepare_multiprocessible_fov_stencil()
253                 player_fovs += [player._fov]
254                 player_ids_send_fov += [player.id_]
255             if None in (player._seen_things,
256                         player._seen_annotation_positions,
257                         player._seen_portal_positions):
258                 player_ids_send_other += [player.id_]
259         new_fovs = []
260         single_core_until = 16  # since multiprocess has its own overhead
261         if len(player_fovs) > single_core_until:
262             pool = multiprocessing.Pool()
263             new_fovs = pool.map(FovMap.init_terrain, [fov for fov in player_fovs])
264             pool.close()
265             pool.join()
266         elif len(player_fovs) <= single_core_until:
267             for fov in player_fovs:
268                 new_fovs += [fov.init_terrain()]
269         for i in range(len(player_ids_send_fov)):
270             id_ = player_ids_send_fov[i]
271             player = self.get_thing(id_)
272             player._fov = new_fovs[i]
273         for c_id in c_ids:
274             self.io.send('TURN ' + str(self.turn), c_id)
275             player = self.get_player(c_id)
276             self.io.send('PLAYERS_HAT_CHARS ' + quote(player.get_cookie_chars()),
277                          c_id)
278             if player.id_ in player_ids_send_fov:
279                 self.io.send('FOV %s' % quote(player.fov_stencil.terrain), c_id)
280                 self.io.send('MAP %s %s %s' % (self.get_map_geometry_shape(),
281                                                player.fov_stencil.geometry.size,
282                                                quote(player.visible_terrain)), c_id)
283                 self.io.send('MAP_CONTROL %s' % quote(player.visible_control), c_id)
284             if player.id_ in player_ids_send_other:
285                 self.io.send('OTHER_WIPE', c_id)
286                 for t in player.seen_things:
287                     target_yx = player.fov_stencil.target_yx(*t.position)
288                     self.io.send('THING %s %s %s %s %s %s'
289                                  % (target_yx, t.type_, quote(t.protection), t.id_,
290                                     int(t.portable), int(t.commandable)),
291                                  c_id)
292                     if hasattr(t, 'name'):
293                         self.io.send('THING_NAME %s %s' % (t.id_, quote(t.name)), c_id)
294                         if t.type_ == 'Player' and t.name in self.hats:
295                             hat = self.hats[t.name]
296                             self.io.send('THING_HAT %s %s' % (t.id_, quote(hat)), c_id)
297                     face = self.get_face(t)
298                     if face:
299                         self.io.send('THING_FACE %s %s' % (t.id_, quote(face)), c_id)
300                     if hasattr(t, 'thing_char'):
301                         self.io.send('THING_CHAR %s %s' % (t.id_,
302                                                            quote(t.thing_char)), c_id)
303                     if hasattr(t, 'installable') and not t.portable:
304                         self.io.send('THING_INSTALLED %s' % (t.id_), c_id)
305                     if hasattr(t, 'design'):
306                         self.io.send('THING_HAT %s %s' % (t.id_,
307                                                           quote(t.design)), c_id)
308                 for t in [t for t in player.seen_things if t.carrying]:
309                     # send this last so all carryable things are already created
310                     self.io.send('THING_CARRYING %s %s' % (t.id_, t.carrying.id_),
311                                  c_id)
312                 for position in player.seen_portal_positions:
313                     target_yx = player.fov_stencil.target_yx(position[0],
314                                                              position[1])
315                     portal = self.portals[position[0]][position[1]]
316                     self.io.send('PORTAL %s %s' % (target_yx, quote(portal)), c_id)
317                 for position in player.seen_annotation_positions:
318                     target_yx = player.fov_stencil.target_yx(position[0],
319                                                              position[1])
320                     annotation = self.annotations[position[0]][position[1]]
321                     self.io.send('ANNOTATION %s %s' % (target_yx,
322                                                        quote(annotation)), c_id)
323             self.io.send('GAME_STATE_COMPLETE', c_id)
324
325     def record_change(self, position, type_):
326         big_yx, little_yx = position
327         self.changed_tiles[type_] += [self.map_geometry.undouble_yxyx(big_yx,
328                                                                       little_yx)]
329         self.changed = True
330
331     def run_tick(self):
332         to_delete = []
333         for connection_id in self.sessions:
334             connection_id_found = False
335             for server in self.io.servers:
336                 if connection_id in server.clients:
337                     connection_id_found = True
338                     break
339             if not connection_id_found:
340                 t = self.get_player(connection_id)
341                 if hasattr(t, 'name'):
342                     self.io.send('CHAT ' + quote(t.name + ' left the map.'))
343                 self.remove_thing(t)
344                 to_delete += [connection_id]
345         for connection_id in to_delete:
346             del self.sessions[connection_id]
347             # self.changed = True  already handled by remove_thing
348         for t in [t for t in self.things]:
349             if t in self.things:
350                 try:
351                     t.proceed()
352                 except GameError as e:
353                     for connection_id in [c_id for c_id in self.sessions
354                                           if self.sessions[c_id]['thing_id'] == t.id_]:
355                         self.io.send('GAME_ERROR ' + quote(str(e)), connection_id)
356                 except PlayError as e:
357                     for connection_id in [c_id for c_id in self.sessions
358                                           if self.sessions[c_id]['thing_id'] == t.id_]:
359                         self.io.send('PLAY_ERROR ' + quote(str(e)), connection_id)
360         if self.changed:
361             self.turn += 1
362             # send_gamestate() can be rather expensive, due to among other reasons
363             # re-calculating players' FOVs, so don't send it out too often
364             if self.last_send_gamestate < \
365                datetime.datetime.now() -self.send_gamestate_interval:
366                 n_changes = 0
367                 for type_ in self.changed_tiles:
368                     n_changes += len(self.changed_tiles[type_])
369                 if n_changes > 0:
370                     for t in [t for t in self.things if t.type_ == 'Player']:
371                         fov_radius = 12  # TODO: un-hardcode
372                         absolute_position =\
373                             self.map_geometry.undouble_yxyx(t.position[0],
374                                                             t.position[1])
375                         y_range_start = absolute_position.y - fov_radius
376                         y_range_end = absolute_position.y + fov_radius
377                         x_range_start = absolute_position.x - fov_radius
378                         x_range_end = absolute_position.x + fov_radius
379                         # TODO: refactor with SourcedMap.inside?
380                         for type_ in self.changed_tiles:
381                             for position in self.changed_tiles[type_]:
382                                 if position.y < y_range_start\
383                                    or position.y > y_range_end:
384                                     continue
385                                 if position.x < x_range_start\
386                                    or position.x > x_range_end:
387                                     continue
388                                 t.invalidate(type_)
389                                 break
390                 self.send_gamestate()
391                 self.changed = False
392                 self.changed_tiles = {'fov': [], 'other': []}
393                 self.save()
394                 self.last_send_gamestate = datetime.datetime.now()
395
396     def get_command(self, command_name):
397
398         def partial_with_attrs(f, *args, **kwargs):
399             from functools import partial
400             p = partial(f, *args, **kwargs)
401             p.__dict__.update(f.__dict__)
402             return p
403
404         def cmd_TASK_colon(task_name, game, *args, connection_id):
405             t = self.get_player(connection_id)
406             if not t:
407                 raise GameError('Not registered as player.')
408             t.set_next_task(task_name, args)
409
410         def task_prefixed(command_name, task_prefix, task_command):
411             if command_name.startswith(task_prefix):
412                 task_name = command_name[len(task_prefix):]
413                 if task_name in self.tasks:
414                     f = partial_with_attrs(task_command, task_name, self)
415                     task = self.tasks[task_name]
416                     f.argtypes = task.argtypes
417                     return f
418             return None
419
420         command = task_prefixed(command_name, 'TASK:', cmd_TASK_colon)
421         if command:
422             return command
423         if command_name in self.commands:
424             f = partial_with_attrs(self.commands[command_name], self)
425             return f
426         return None
427
428     def new_thing_id(self):
429         if len(self.things) == 0:
430             return 1
431         return max([t.id_ for t in self.things]) + 1
432
433     def get_next_player_char(self):
434         self.player_char_i += 1
435         if self.player_char_i >= len(self.player_chars):
436             self.player_char_i = 0
437         return self.player_chars[self.player_char_i]
438
439     def get_foo_blockers(self, foo):
440         foo_blockers = ''
441         for t in self.terrains.values():
442             block_attr = getattr(t, 'blocks_' + foo)
443             if block_attr:
444                 foo_blockers += t.character
445         return foo_blockers
446
447     def get_sound_blockers(self):
448         return self.get_foo_blockers('sound')
449
450     def get_light_blockers(self):
451         return self.get_foo_blockers('light')
452
453     def get_movement_blockers(self):
454         return self.get_foo_blockers('movement')
455
456     def get_flatland(self):
457         for t in self.terrains.values():
458             if not t.blocks_movement:
459                 return t.character
460
461     def save(self):
462
463         def write(f, msg):
464             f.write(msg + '\n')
465
466         with open(self.io.save_file, 'w') as f:
467             write(f, 'TURN %s' % self.turn)
468             map_geometry_shape = self.get_map_geometry_shape()
469             write(f, 'MAP %s %s' % (map_geometry_shape, self.map_geometry.size,))
470             for terrain in self.terrains.values():
471                 write(f, 'TERRAIN %s %s %s %s %s' % (quote(terrain.character),
472                                                      quote(terrain.description),
473                                                      int(terrain.blocks_light),
474                                                      int(terrain.blocks_sound),
475                                                      int(terrain.blocks_movement)))
476             for big_yx in [yx for yx in self.maps if self.maps[yx].modified]:
477                 for y, line in self.maps[big_yx].lines():
478                     write(f, 'MAP_LINE %s %5s %s' % (big_yx, y, quote(line)))
479             for big_yx in self.annotations:
480                 for little_yx in self.annotations[big_yx]:
481                     write(f, 'GOD_ANNOTATE %s %s %s' %
482                           (big_yx, little_yx, quote(self.annotations[big_yx][little_yx])))
483             for big_yx in self.portals:
484                 for little_yx in self.portals[big_yx]:
485                     write(f, 'GOD_PORTAL %s %s %s' % (big_yx, little_yx,
486                                                       quote(self.portals[big_yx][little_yx])))
487             for big_yx in [yx for yx in self.map_controls
488                            if self.map_controls[yx].modified]:
489                 for y, line in self.map_controls[big_yx].lines():
490                     write(f, 'MAP_CONTROL_LINE %s %5s %s' % (big_yx, y, quote(line)))
491             for tile_class in self.map_control_passwords:
492                 write(f, 'MAP_CONTROL_PW %s %s' % (tile_class,
493                                                    self.map_control_passwords[tile_class]))
494             for pw in self.admin_passwords:
495                 write(f, 'ADMIN_PASSWORD %s' % pw)
496             for name in self.faces:
497                 write(f, 'GOD_PLAYER_FACE %s %s' % (quote(name),
498                                                     quote(self.faces[name])))
499             for name in self.hats:
500                 write(f, 'GOD_PLAYER_HAT %s %s' % (quote(name),
501                                                    quote(self.hats[name])))
502             for name in self.players_hat_chars:
503                 write(f, 'GOD_PLAYERS_HAT_CHARS %s %s' %
504                       (quote(name), quote(self.players_hat_chars[name])))
505             for t in [t for t in self.things if not t.type_ == 'Player']:
506                 write(f, 'THING %s %s %s %s' % (t.position[0],
507                                                 t.position[1], t.type_, t.id_))
508                 write(f, 'GOD_THING_PROTECTION %s %s' % (t.id_, quote(t.protection)))
509                 if hasattr(t, 'name'):
510                     write(f, 'GOD_THING_NAME %s %s' % (t.id_, quote(t.name)))
511                 if hasattr(t, 'installable') and (not t.portable):
512                     write(f, 'THING_INSTALLED %s' % t.id_)
513                 if t.type_ == 'Door' and t.blocks_movement:
514                     write(f, 'THING_DOOR_CLOSED %s' % t.id_)
515                 elif t.type_ == 'Hat':
516                     write(f, 'THING_HAT_DESIGN %s %s' % (t.id_,
517                                                          quote(t.design)))
518                 elif t.type_ == 'MusicPlayer':
519                     write(f, 'THING_MUSICPLAYER_SETTINGS %s %s %s %s' %
520                           (t.id_, int(t.playing), t.playlist_index, int(t.repeat)))
521                     for item in t.playlist:
522                         write(f, 'THING_MUSICPLAYER_PLAYLIST_ITEM %s %s %s' %
523                               (t.id_, quote(item[0]), item[1]))
524                 elif t.type_ == 'Bottle' and not t.full:
525                     write(f, 'THING_BOTTLE_EMPTY %s' % t.id_)
526             write(f, 'SPAWN_POINT %s %s' % (self.spawn_point[0],
527                                             self.spawn_point[1]))
528
529     def get_map(self, big_yx, type_='normal'):
530         if type_ == 'normal':
531             maps = self.maps
532         elif type_ == 'control':
533             maps = self.map_controls
534         if big_yx not in maps:
535             maps[big_yx] = SaveableMap(self.map_geometry)
536             if type_ == 'control':
537                 maps[big_yx].draw_presets(big_yx.y % 2)
538         return maps[big_yx]
539
540     def new_world(self, map_geometry):
541         self.maps = {}
542         self.map_controls = {}
543         self.annotations = {}
544         self.portals = {}
545         self.admin_passwords = []
546         self.spawn_point = YX(0, 0), YX(0, 0)
547         self.map_geometry = map_geometry
548         self.map_control_passwords = {'X': 'secret'}
549         self.get_map(YX(0, 0))
550         self.get_map(YX(0, 0), 'control')
551         self.annotations = {}