annotate skaapsteker/engine.py @ 165:8d45715c587d

Rename ._game_state to game_state for consistency with engine and since everyone and their dog has access to it. :)
author Simon Cross <hodgestar@gmail.com>
date Wed, 06 Apr 2011 00:09:56 +0200
parents aca8b7456c72
children 9d08f99b5ddf
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
11
249814efa91b Create game engine. Enable quitting.
Simon Cross <hodgestar@gmail.com>
parents:
diff changeset
1 """Top-level engine for switching scenes."""
249814efa91b Create game engine. Enable quitting.
Simon Cross <hodgestar@gmail.com>
parents:
diff changeset
2
249814efa91b Create game engine. Enable quitting.
Simon Cross <hodgestar@gmail.com>
parents:
diff changeset
3 import pygame.display
249814efa91b Create game engine. Enable quitting.
Simon Cross <hodgestar@gmail.com>
parents:
diff changeset
4 import pygame.time
249814efa91b Create game engine. Enable quitting.
Simon Cross <hodgestar@gmail.com>
parents:
diff changeset
5 import pygame.event
14
fb1bd081cc86 Add scene changing.
Simon Cross <hodgestar@gmail.com>
parents: 11
diff changeset
6 from pygame.locals import QUIT, USEREVENT
11
249814efa91b Create game engine. Enable quitting.
Simon Cross <hodgestar@gmail.com>
parents:
diff changeset
7
127
e1dd3b785269 Initial game state stuff.
Jeremy Thurgood <firxen@gmail.com>
parents: 126
diff changeset
8 from skaapsteker.gamestate import GameState
e1dd3b785269 Initial game state stuff.
Jeremy Thurgood <firxen@gmail.com>
parents: 126
diff changeset
9
11
249814efa91b Create game engine. Enable quitting.
Simon Cross <hodgestar@gmail.com>
parents:
diff changeset
10 class Engine(object):
249814efa91b Create game engine. Enable quitting.
Simon Cross <hodgestar@gmail.com>
parents:
diff changeset
11
249814efa91b Create game engine. Enable quitting.
Simon Cross <hodgestar@gmail.com>
parents:
diff changeset
12 def __init__(self):
249814efa91b Create game engine. Enable quitting.
Simon Cross <hodgestar@gmail.com>
parents:
diff changeset
13 self._framerate = 60
14
fb1bd081cc86 Add scene changing.
Simon Cross <hodgestar@gmail.com>
parents: 11
diff changeset
14 self._current_scene = None
123
592477d8b09b Add fps to game
Neil Muller <drnlmuller@gmail.com>
parents: 79
diff changeset
15 self._fpss = [self._framerate] * 100
592477d8b09b Add fps to game
Neil Muller <drnlmuller@gmail.com>
parents: 79
diff changeset
16 self._cur_frame = 0
127
e1dd3b785269 Initial game state stuff.
Jeremy Thurgood <firxen@gmail.com>
parents: 126
diff changeset
17 self.game_state = GameState()
14
fb1bd081cc86 Add scene changing.
Simon Cross <hodgestar@gmail.com>
parents: 11
diff changeset
18
fb1bd081cc86 Add scene changing.
Simon Cross <hodgestar@gmail.com>
parents: 11
diff changeset
19 def change_scene(self, next_scene):
fb1bd081cc86 Add scene changing.
Simon Cross <hodgestar@gmail.com>
parents: 11
diff changeset
20 if self._current_scene is not None:
fb1bd081cc86 Add scene changing.
Simon Cross <hodgestar@gmail.com>
parents: 11
diff changeset
21 self._current_scene.leave()
fb1bd081cc86 Add scene changing.
Simon Cross <hodgestar@gmail.com>
parents: 11
diff changeset
22 self._current_scene = next_scene
fb1bd081cc86 Add scene changing.
Simon Cross <hodgestar@gmail.com>
parents: 11
diff changeset
23 self._current_scene.enter()
11
249814efa91b Create game engine. Enable quitting.
Simon Cross <hodgestar@gmail.com>
parents:
diff changeset
24
249814efa91b Create game engine. Enable quitting.
Simon Cross <hodgestar@gmail.com>
parents:
diff changeset
25 def run(self):
249814efa91b Create game engine. Enable quitting.
Simon Cross <hodgestar@gmail.com>
parents:
diff changeset
26 """Run the game loop dispatching events as necessary."""
14
fb1bd081cc86 Add scene changing.
Simon Cross <hodgestar@gmail.com>
parents: 11
diff changeset
27 assert self._current_scene is not None
11
249814efa91b Create game engine. Enable quitting.
Simon Cross <hodgestar@gmail.com>
parents:
diff changeset
28 clock = pygame.time.Clock()
14
fb1bd081cc86 Add scene changing.
Simon Cross <hodgestar@gmail.com>
parents: 11
diff changeset
29 surface = pygame.display.get_surface()
11
249814efa91b Create game engine. Enable quitting.
Simon Cross <hodgestar@gmail.com>
parents:
diff changeset
30 while True:
249814efa91b Create game engine. Enable quitting.
Simon Cross <hodgestar@gmail.com>
parents:
diff changeset
31 events = pygame.event.get()
249814efa91b Create game engine. Enable quitting.
Simon Cross <hodgestar@gmail.com>
parents:
diff changeset
32 for ev in events:
249814efa91b Create game engine. Enable quitting.
Simon Cross <hodgestar@gmail.com>
parents:
diff changeset
33 if ev.type is QUIT:
249814efa91b Create game engine. Enable quitting.
Simon Cross <hodgestar@gmail.com>
parents:
diff changeset
34 return
14
fb1bd081cc86 Add scene changing.
Simon Cross <hodgestar@gmail.com>
parents: 11
diff changeset
35 if ChangeScene.matches(ev):
fb1bd081cc86 Add scene changing.
Simon Cross <hodgestar@gmail.com>
parents: 11
diff changeset
36 self.change_scene(ev.next_scene)
fb1bd081cc86 Add scene changing.
Simon Cross <hodgestar@gmail.com>
parents: 11
diff changeset
37 break
fb1bd081cc86 Add scene changing.
Simon Cross <hodgestar@gmail.com>
parents: 11
diff changeset
38 self._current_scene.dispatch(ev)
123
592477d8b09b Add fps to game
Neil Muller <drnlmuller@gmail.com>
parents: 79
diff changeset
39 self._current_scene.draw(surface, self)
14
fb1bd081cc86 Add scene changing.
Simon Cross <hodgestar@gmail.com>
parents: 11
diff changeset
40 pygame.display.flip()
126
9cae256b91d7 Fix bug in FPS calculation. Phew -- we're still fast.
Simon Cross <hodgestar@gmail.com>
parents: 123
diff changeset
41 self._fpss[self._cur_frame] = 1000.0 / clock.tick(self._framerate)
123
592477d8b09b Add fps to game
Neil Muller <drnlmuller@gmail.com>
parents: 79
diff changeset
42 self._cur_frame = self._cur_frame + 1 if self._cur_frame < 99 else 0
592477d8b09b Add fps to game
Neil Muller <drnlmuller@gmail.com>
parents: 79
diff changeset
43
592477d8b09b Add fps to game
Neil Muller <drnlmuller@gmail.com>
parents: 79
diff changeset
44 def get_fps(self):
592477d8b09b Add fps to game
Neil Muller <drnlmuller@gmail.com>
parents: 79
diff changeset
45 return sum(self._fpss) / 100
14
fb1bd081cc86 Add scene changing.
Simon Cross <hodgestar@gmail.com>
parents: 11
diff changeset
46
fb1bd081cc86 Add scene changing.
Simon Cross <hodgestar@gmail.com>
parents: 11
diff changeset
47
fb1bd081cc86 Add scene changing.
Simon Cross <hodgestar@gmail.com>
parents: 11
diff changeset
48 class Scene(object):
fb1bd081cc86 Add scene changing.
Simon Cross <hodgestar@gmail.com>
parents: 11
diff changeset
49
127
e1dd3b785269 Initial game state stuff.
Jeremy Thurgood <firxen@gmail.com>
parents: 126
diff changeset
50 def __init__(self, game_state):
79
fe8652a060df Simple menu screen and TextChoice widget
Stefano Rivera <stefano@rivera.za.net>
parents: 14
diff changeset
51 self.widgets = []
165
8d45715c587d Rename ._game_state to game_state for consistency with engine and since everyone and their dog has access to it. :)
Simon Cross <hodgestar@gmail.com>
parents: 133
diff changeset
52 self.game_state = game_state
14
fb1bd081cc86 Add scene changing.
Simon Cross <hodgestar@gmail.com>
parents: 11
diff changeset
53
fb1bd081cc86 Add scene changing.
Simon Cross <hodgestar@gmail.com>
parents: 11
diff changeset
54 def post(self, ev):
fb1bd081cc86 Add scene changing.
Simon Cross <hodgestar@gmail.com>
parents: 11
diff changeset
55 """Post an event to pygame's event loop."""
fb1bd081cc86 Add scene changing.
Simon Cross <hodgestar@gmail.com>
parents: 11
diff changeset
56 pygame.event.post(ev)
fb1bd081cc86 Add scene changing.
Simon Cross <hodgestar@gmail.com>
parents: 11
diff changeset
57
fb1bd081cc86 Add scene changing.
Simon Cross <hodgestar@gmail.com>
parents: 11
diff changeset
58 def enter(self):
fb1bd081cc86 Add scene changing.
Simon Cross <hodgestar@gmail.com>
parents: 11
diff changeset
59 """Enter the scene."""
fb1bd081cc86 Add scene changing.
Simon Cross <hodgestar@gmail.com>
parents: 11
diff changeset
60 pass
fb1bd081cc86 Add scene changing.
Simon Cross <hodgestar@gmail.com>
parents: 11
diff changeset
61
fb1bd081cc86 Add scene changing.
Simon Cross <hodgestar@gmail.com>
parents: 11
diff changeset
62 def leave(self):
fb1bd081cc86 Add scene changing.
Simon Cross <hodgestar@gmail.com>
parents: 11
diff changeset
63 """Exit the scene."""
fb1bd081cc86 Add scene changing.
Simon Cross <hodgestar@gmail.com>
parents: 11
diff changeset
64 pass
fb1bd081cc86 Add scene changing.
Simon Cross <hodgestar@gmail.com>
parents: 11
diff changeset
65
fb1bd081cc86 Add scene changing.
Simon Cross <hodgestar@gmail.com>
parents: 11
diff changeset
66 def dispatch(self, ev):
fb1bd081cc86 Add scene changing.
Simon Cross <hodgestar@gmail.com>
parents: 11
diff changeset
67 """Dispatch an event."""
79
fe8652a060df Simple menu screen and TextChoice widget
Stefano Rivera <stefano@rivera.za.net>
parents: 14
diff changeset
68 for widget in self.widgets:
fe8652a060df Simple menu screen and TextChoice widget
Stefano Rivera <stefano@rivera.za.net>
parents: 14
diff changeset
69 widget.dispatch(ev)
14
fb1bd081cc86 Add scene changing.
Simon Cross <hodgestar@gmail.com>
parents: 11
diff changeset
70
133
aca8b7456c72 Pass engine to all Scene draw() methods
Stefano Rivera <stefano@rivera.za.net>
parents: 127
diff changeset
71 def draw(self, surface, engine):
14
fb1bd081cc86 Add scene changing.
Simon Cross <hodgestar@gmail.com>
parents: 11
diff changeset
72 """Update the scene surface."""
79
fe8652a060df Simple menu screen and TextChoice widget
Stefano Rivera <stefano@rivera.za.net>
parents: 14
diff changeset
73 for widget in self.widgets:
fe8652a060df Simple menu screen and TextChoice widget
Stefano Rivera <stefano@rivera.za.net>
parents: 14
diff changeset
74 widget.draw(surface)
14
fb1bd081cc86 Add scene changing.
Simon Cross <hodgestar@gmail.com>
parents: 11
diff changeset
75
fb1bd081cc86 Add scene changing.
Simon Cross <hodgestar@gmail.com>
parents: 11
diff changeset
76
fb1bd081cc86 Add scene changing.
Simon Cross <hodgestar@gmail.com>
parents: 11
diff changeset
77 class UserEvent(object):
fb1bd081cc86 Add scene changing.
Simon Cross <hodgestar@gmail.com>
parents: 11
diff changeset
78
fb1bd081cc86 Add scene changing.
Simon Cross <hodgestar@gmail.com>
parents: 11
diff changeset
79 utype = "UNKNOWN"
fb1bd081cc86 Add scene changing.
Simon Cross <hodgestar@gmail.com>
parents: 11
diff changeset
80
fb1bd081cc86 Add scene changing.
Simon Cross <hodgestar@gmail.com>
parents: 11
diff changeset
81 @classmethod
fb1bd081cc86 Add scene changing.
Simon Cross <hodgestar@gmail.com>
parents: 11
diff changeset
82 def post(cls, **kws):
fb1bd081cc86 Add scene changing.
Simon Cross <hodgestar@gmail.com>
parents: 11
diff changeset
83 ev = pygame.event.Event(USEREVENT, utype=cls.utype, **kws)
fb1bd081cc86 Add scene changing.
Simon Cross <hodgestar@gmail.com>
parents: 11
diff changeset
84 pygame.event.post(ev)
fb1bd081cc86 Add scene changing.
Simon Cross <hodgestar@gmail.com>
parents: 11
diff changeset
85
fb1bd081cc86 Add scene changing.
Simon Cross <hodgestar@gmail.com>
parents: 11
diff changeset
86 @classmethod
fb1bd081cc86 Add scene changing.
Simon Cross <hodgestar@gmail.com>
parents: 11
diff changeset
87 def matches(cls, ev):
fb1bd081cc86 Add scene changing.
Simon Cross <hodgestar@gmail.com>
parents: 11
diff changeset
88 return ev.type is USEREVENT and ev.utype == cls.utype
fb1bd081cc86 Add scene changing.
Simon Cross <hodgestar@gmail.com>
parents: 11
diff changeset
89
fb1bd081cc86 Add scene changing.
Simon Cross <hodgestar@gmail.com>
parents: 11
diff changeset
90 class ChangeScene(UserEvent):
fb1bd081cc86 Add scene changing.
Simon Cross <hodgestar@gmail.com>
parents: 11
diff changeset
91
fb1bd081cc86 Add scene changing.
Simon Cross <hodgestar@gmail.com>
parents: 11
diff changeset
92 utype = "CHANGE_SCENE"
fb1bd081cc86 Add scene changing.
Simon Cross <hodgestar@gmail.com>
parents: 11
diff changeset
93
fb1bd081cc86 Add scene changing.
Simon Cross <hodgestar@gmail.com>
parents: 11
diff changeset
94 @classmethod
fb1bd081cc86 Add scene changing.
Simon Cross <hodgestar@gmail.com>
parents: 11
diff changeset
95 def post(cls, next_scene):
fb1bd081cc86 Add scene changing.
Simon Cross <hodgestar@gmail.com>
parents: 11
diff changeset
96 super(ChangeScene, cls).post(next_scene=next_scene)