annotate gamelib/scenes/manual.py @ 592:4e9178215e75 pyntnclick

Introduce .setup() for GameDeveloperGizmos.
author Simon Cross <hodgestar+bzr@gmail.com>
date Sat, 11 Feb 2012 17:38:57 +0200
parents ea9dd2b9186a
children 3ce19d33b51f
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
384
56a05ae56574 Initial manual implementation.
Jeremy Thurgood <firxen@gmail.com>
parents:
diff changeset
1 """The inside of the maintenance manual."""
56a05ae56574 Initial manual implementation.
Jeremy Thurgood <firxen@gmail.com>
parents:
diff changeset
2
528
0ce08d5e2acb pyflakes-induced cleanup.
Jeremy Thurgood <firxen@gmail.com>
parents: 525
diff changeset
3 from albow.music import change_playlist
384
56a05ae56574 Initial manual implementation.
Jeremy Thurgood <firxen@gmail.com>
parents:
diff changeset
4
549
098ea4ea0d0d Rename imports
Neil Muller <neil@dip.sun.ac.za>
parents: 542
diff changeset
5 from pyntnclick.state import Scene, Thing
098ea4ea0d0d Rename imports
Neil Muller <neil@dip.sun.ac.za>
parents: 542
diff changeset
6 from pyntnclick.scenewidgets import InteractNoImage, InteractImage
384
56a05ae56574 Initial manual implementation.
Jeremy Thurgood <firxen@gmail.com>
parents:
diff changeset
7
56a05ae56574 Initial manual implementation.
Jeremy Thurgood <firxen@gmail.com>
parents:
diff changeset
8
56a05ae56574 Initial manual implementation.
Jeremy Thurgood <firxen@gmail.com>
parents:
diff changeset
9 # classes related the computer detail
56a05ae56574 Initial manual implementation.
Jeremy Thurgood <firxen@gmail.com>
parents:
diff changeset
10
56a05ae56574 Initial manual implementation.
Jeremy Thurgood <firxen@gmail.com>
parents:
diff changeset
11
390
d9c47a9e3d84 Working manual. (Still needs arrows.)
Jeremy Thurgood <firxen@gmail.com>
parents: 384
diff changeset
12 class PageBase(Thing):
d9c47a9e3d84 Working manual. (Still needs arrows.)
Jeremy Thurgood <firxen@gmail.com>
parents: 384
diff changeset
13 "Displays manual pages"
d9c47a9e3d84 Working manual. (Still needs arrows.)
Jeremy Thurgood <firxen@gmail.com>
parents: 384
diff changeset
14
d9c47a9e3d84 Working manual. (Still needs arrows.)
Jeremy Thurgood <firxen@gmail.com>
parents: 384
diff changeset
15 def get_page_thing(self):
d9c47a9e3d84 Working manual. (Still needs arrows.)
Jeremy Thurgood <firxen@gmail.com>
parents: 384
diff changeset
16 return self.state.current_detail.things['manual.page']
d9c47a9e3d84 Working manual. (Still needs arrows.)
Jeremy Thurgood <firxen@gmail.com>
parents: 384
diff changeset
17
d9c47a9e3d84 Working manual. (Still needs arrows.)
Jeremy Thurgood <firxen@gmail.com>
parents: 384
diff changeset
18 def get_page(self):
d9c47a9e3d84 Working manual. (Still needs arrows.)
Jeremy Thurgood <firxen@gmail.com>
parents: 384
diff changeset
19 return self.get_page_thing().get_data('page')
d9c47a9e3d84 Working manual. (Still needs arrows.)
Jeremy Thurgood <firxen@gmail.com>
parents: 384
diff changeset
20
d9c47a9e3d84 Working manual. (Still needs arrows.)
Jeremy Thurgood <firxen@gmail.com>
parents: 384
diff changeset
21 def set_page(self, page):
d9c47a9e3d84 Working manual. (Still needs arrows.)
Jeremy Thurgood <firxen@gmail.com>
parents: 384
diff changeset
22 self.get_page_thing().set_page(page)
d9c47a9e3d84 Working manual. (Still needs arrows.)
Jeremy Thurgood <firxen@gmail.com>
parents: 384
diff changeset
23
394
5cfd68beb6d3 Finished manual detail.
Jeremy Thurgood <firxen@gmail.com>
parents: 390
diff changeset
24 def set_display(self, display):
5cfd68beb6d3 Finished manual detail.
Jeremy Thurgood <firxen@gmail.com>
parents: 390
diff changeset
25 self.set_data('display', display)
5cfd68beb6d3 Finished manual detail.
Jeremy Thurgood <firxen@gmail.com>
parents: 390
diff changeset
26 self.set_interact(display)
5cfd68beb6d3 Finished manual detail.
Jeremy Thurgood <firxen@gmail.com>
parents: 390
diff changeset
27
519
8f3c82c685a4 Fix is_interactive() by adding tool param.
Jeremy Thurgood <firxen@gmail.com>
parents: 394
diff changeset
28 def is_interactive(self, tool=None):
394
5cfd68beb6d3 Finished manual detail.
Jeremy Thurgood <firxen@gmail.com>
parents: 390
diff changeset
29 return self.get_data('display') == 'on'
5cfd68beb6d3 Finished manual detail.
Jeremy Thurgood <firxen@gmail.com>
parents: 390
diff changeset
30
390
d9c47a9e3d84 Working manual. (Still needs arrows.)
Jeremy Thurgood <firxen@gmail.com>
parents: 384
diff changeset
31
d9c47a9e3d84 Working manual. (Still needs arrows.)
Jeremy Thurgood <firxen@gmail.com>
parents: 384
diff changeset
32 class PagePrior(PageBase):
384
56a05ae56574 Initial manual implementation.
Jeremy Thurgood <firxen@gmail.com>
parents:
diff changeset
33 """Prior page in the manual"""
56a05ae56574 Initial manual implementation.
Jeremy Thurgood <firxen@gmail.com>
parents:
diff changeset
34
56a05ae56574 Initial manual implementation.
Jeremy Thurgood <firxen@gmail.com>
parents:
diff changeset
35 NAME = 'manual.page_prior'
56a05ae56574 Initial manual implementation.
Jeremy Thurgood <firxen@gmail.com>
parents:
diff changeset
36
56a05ae56574 Initial manual implementation.
Jeremy Thurgood <firxen@gmail.com>
parents:
diff changeset
37 INTERACTS = {
394
5cfd68beb6d3 Finished manual detail.
Jeremy Thurgood <firxen@gmail.com>
parents: 390
diff changeset
38 'on': InteractImage(36, 351, 'arrow_left.png'),
5cfd68beb6d3 Finished manual detail.
Jeremy Thurgood <firxen@gmail.com>
parents: 390
diff changeset
39 'off': InteractNoImage(31, 351, 34, 23),
384
56a05ae56574 Initial manual implementation.
Jeremy Thurgood <firxen@gmail.com>
parents:
diff changeset
40 }
394
5cfd68beb6d3 Finished manual detail.
Jeremy Thurgood <firxen@gmail.com>
parents: 390
diff changeset
41 INITIAL = 'off'
384
56a05ae56574 Initial manual implementation.
Jeremy Thurgood <firxen@gmail.com>
parents:
diff changeset
42
394
5cfd68beb6d3 Finished manual detail.
Jeremy Thurgood <firxen@gmail.com>
parents: 390
diff changeset
43 INITIAL_DATA = {
5cfd68beb6d3 Finished manual detail.
Jeremy Thurgood <firxen@gmail.com>
parents: 390
diff changeset
44 'display': 'off',
5cfd68beb6d3 Finished manual detail.
Jeremy Thurgood <firxen@gmail.com>
parents: 390
diff changeset
45 }
384
56a05ae56574 Initial manual implementation.
Jeremy Thurgood <firxen@gmail.com>
parents:
diff changeset
46
56a05ae56574 Initial manual implementation.
Jeremy Thurgood <firxen@gmail.com>
parents:
diff changeset
47 def interact_without(self):
390
d9c47a9e3d84 Working manual. (Still needs arrows.)
Jeremy Thurgood <firxen@gmail.com>
parents: 384
diff changeset
48 self.set_page(self.get_page() - 1)
384
56a05ae56574 Initial manual implementation.
Jeremy Thurgood <firxen@gmail.com>
parents:
diff changeset
49
56a05ae56574 Initial manual implementation.
Jeremy Thurgood <firxen@gmail.com>
parents:
diff changeset
50
390
d9c47a9e3d84 Working manual. (Still needs arrows.)
Jeremy Thurgood <firxen@gmail.com>
parents: 384
diff changeset
51 class PageNext(PageBase):
384
56a05ae56574 Initial manual implementation.
Jeremy Thurgood <firxen@gmail.com>
parents:
diff changeset
52 """Next page in the manual"""
56a05ae56574 Initial manual implementation.
Jeremy Thurgood <firxen@gmail.com>
parents:
diff changeset
53
56a05ae56574 Initial manual implementation.
Jeremy Thurgood <firxen@gmail.com>
parents:
diff changeset
54 NAME = 'manual.page_next'
56a05ae56574 Initial manual implementation.
Jeremy Thurgood <firxen@gmail.com>
parents:
diff changeset
55
56a05ae56574 Initial manual implementation.
Jeremy Thurgood <firxen@gmail.com>
parents:
diff changeset
56 INTERACTS = {
394
5cfd68beb6d3 Finished manual detail.
Jeremy Thurgood <firxen@gmail.com>
parents: 390
diff changeset
57 'on': InteractImage(185, 351, 'arrow_right.png'),
5cfd68beb6d3 Finished manual detail.
Jeremy Thurgood <firxen@gmail.com>
parents: 390
diff changeset
58 'off': InteractNoImage(185, 351, 34, 23),
384
56a05ae56574 Initial manual implementation.
Jeremy Thurgood <firxen@gmail.com>
parents:
diff changeset
59 }
394
5cfd68beb6d3 Finished manual detail.
Jeremy Thurgood <firxen@gmail.com>
parents: 390
diff changeset
60 INITIAL = 'on'
384
56a05ae56574 Initial manual implementation.
Jeremy Thurgood <firxen@gmail.com>
parents:
diff changeset
61
394
5cfd68beb6d3 Finished manual detail.
Jeremy Thurgood <firxen@gmail.com>
parents: 390
diff changeset
62 INITIAL_DATA = {
5cfd68beb6d3 Finished manual detail.
Jeremy Thurgood <firxen@gmail.com>
parents: 390
diff changeset
63 'display': 'on',
5cfd68beb6d3 Finished manual detail.
Jeremy Thurgood <firxen@gmail.com>
parents: 390
diff changeset
64 }
384
56a05ae56574 Initial manual implementation.
Jeremy Thurgood <firxen@gmail.com>
parents:
diff changeset
65
56a05ae56574 Initial manual implementation.
Jeremy Thurgood <firxen@gmail.com>
parents:
diff changeset
66 def interact_without(self):
390
d9c47a9e3d84 Working manual. (Still needs arrows.)
Jeremy Thurgood <firxen@gmail.com>
parents: 384
diff changeset
67 self.set_page(self.get_page() + 1)
d9c47a9e3d84 Working manual. (Still needs arrows.)
Jeremy Thurgood <firxen@gmail.com>
parents: 384
diff changeset
68
d9c47a9e3d84 Working manual. (Still needs arrows.)
Jeremy Thurgood <firxen@gmail.com>
parents: 384
diff changeset
69
d9c47a9e3d84 Working manual. (Still needs arrows.)
Jeremy Thurgood <firxen@gmail.com>
parents: 384
diff changeset
70 class ManualPage(Thing):
d9c47a9e3d84 Working manual. (Still needs arrows.)
Jeremy Thurgood <firxen@gmail.com>
parents: 384
diff changeset
71 """Page in the manual"""
d9c47a9e3d84 Working manual. (Still needs arrows.)
Jeremy Thurgood <firxen@gmail.com>
parents: 384
diff changeset
72
d9c47a9e3d84 Working manual. (Still needs arrows.)
Jeremy Thurgood <firxen@gmail.com>
parents: 384
diff changeset
73 NAME = 'manual.page'
d9c47a9e3d84 Working manual. (Still needs arrows.)
Jeremy Thurgood <firxen@gmail.com>
parents: 384
diff changeset
74
d9c47a9e3d84 Working manual. (Still needs arrows.)
Jeremy Thurgood <firxen@gmail.com>
parents: 384
diff changeset
75 INTERACTS = {
541
Neil Muller <neil@dip.sun.ac.za>
parents: 528
diff changeset
76 0: InteractImage(0, 0, 'manual_p1.png'),
542
7cd79c5ae4c7 Really pep8 fix manual.py
Neil Muller <neil@dip.sun.ac.za>
parents: 541
diff changeset
77 1: InteractImage(0, 0, 'manual_p2.png'),
7cd79c5ae4c7 Really pep8 fix manual.py
Neil Muller <neil@dip.sun.ac.za>
parents: 541
diff changeset
78 2: InteractImage(0, 0, 'manual_p3.png'),
7cd79c5ae4c7 Really pep8 fix manual.py
Neil Muller <neil@dip.sun.ac.za>
parents: 541
diff changeset
79 3: InteractImage(0, 0, 'manual_p4.png'),
390
d9c47a9e3d84 Working manual. (Still needs arrows.)
Jeremy Thurgood <firxen@gmail.com>
parents: 384
diff changeset
80 }
d9c47a9e3d84 Working manual. (Still needs arrows.)
Jeremy Thurgood <firxen@gmail.com>
parents: 384
diff changeset
81 INITIAL = 0
d9c47a9e3d84 Working manual. (Still needs arrows.)
Jeremy Thurgood <firxen@gmail.com>
parents: 384
diff changeset
82
d9c47a9e3d84 Working manual. (Still needs arrows.)
Jeremy Thurgood <firxen@gmail.com>
parents: 384
diff changeset
83 INITIAL_DATA = {
d9c47a9e3d84 Working manual. (Still needs arrows.)
Jeremy Thurgood <firxen@gmail.com>
parents: 384
diff changeset
84 'page': 0,
d9c47a9e3d84 Working manual. (Still needs arrows.)
Jeremy Thurgood <firxen@gmail.com>
parents: 384
diff changeset
85 }
d9c47a9e3d84 Working manual. (Still needs arrows.)
Jeremy Thurgood <firxen@gmail.com>
parents: 384
diff changeset
86
519
8f3c82c685a4 Fix is_interactive() by adding tool param.
Jeremy Thurgood <firxen@gmail.com>
parents: 394
diff changeset
87 def is_interactive(self, tool=None):
390
d9c47a9e3d84 Working manual. (Still needs arrows.)
Jeremy Thurgood <firxen@gmail.com>
parents: 384
diff changeset
88 return False
d9c47a9e3d84 Working manual. (Still needs arrows.)
Jeremy Thurgood <firxen@gmail.com>
parents: 384
diff changeset
89
d9c47a9e3d84 Working manual. (Still needs arrows.)
Jeremy Thurgood <firxen@gmail.com>
parents: 384
diff changeset
90 def set_page(self, page):
d9c47a9e3d84 Working manual. (Still needs arrows.)
Jeremy Thurgood <firxen@gmail.com>
parents: 384
diff changeset
91 self.set_data('page', page)
d9c47a9e3d84 Working manual. (Still needs arrows.)
Jeremy Thurgood <firxen@gmail.com>
parents: 384
diff changeset
92 self.set_interact(page)
394
5cfd68beb6d3 Finished manual detail.
Jeremy Thurgood <firxen@gmail.com>
parents: 390
diff changeset
93 self.scene.things['manual.page_prior'].set_display('on')
5cfd68beb6d3 Finished manual detail.
Jeremy Thurgood <firxen@gmail.com>
parents: 390
diff changeset
94 self.scene.things['manual.page_next'].set_display('on')
5cfd68beb6d3 Finished manual detail.
Jeremy Thurgood <firxen@gmail.com>
parents: 390
diff changeset
95 if page == 0:
5cfd68beb6d3 Finished manual detail.
Jeremy Thurgood <firxen@gmail.com>
parents: 390
diff changeset
96 self.scene.things['manual.page_prior'].set_display('off')
5cfd68beb6d3 Finished manual detail.
Jeremy Thurgood <firxen@gmail.com>
parents: 390
diff changeset
97 if page == len(self.INTERACTS) - 1:
5cfd68beb6d3 Finished manual detail.
Jeremy Thurgood <firxen@gmail.com>
parents: 390
diff changeset
98 self.scene.things['manual.page_next'].set_display('off')
384
56a05ae56574 Initial manual implementation.
Jeremy Thurgood <firxen@gmail.com>
parents:
diff changeset
99
56a05ae56574 Initial manual implementation.
Jeremy Thurgood <firxen@gmail.com>
parents:
diff changeset
100
56a05ae56574 Initial manual implementation.
Jeremy Thurgood <firxen@gmail.com>
parents:
diff changeset
101 class ManualDetail(Scene):
56a05ae56574 Initial manual implementation.
Jeremy Thurgood <firxen@gmail.com>
parents:
diff changeset
102
56a05ae56574 Initial manual implementation.
Jeremy Thurgood <firxen@gmail.com>
parents:
diff changeset
103 FOLDER = 'manual'
56a05ae56574 Initial manual implementation.
Jeremy Thurgood <firxen@gmail.com>
parents:
diff changeset
104 NAME = 'manual_detail'
56a05ae56574 Initial manual implementation.
Jeremy Thurgood <firxen@gmail.com>
parents:
diff changeset
105
390
d9c47a9e3d84 Working manual. (Still needs arrows.)
Jeremy Thurgood <firxen@gmail.com>
parents: 384
diff changeset
106 BACKGROUND = 'manual_detail.png'
384
56a05ae56574 Initial manual implementation.
Jeremy Thurgood <firxen@gmail.com>
parents:
diff changeset
107
592
4e9178215e75 Introduce .setup() for GameDeveloperGizmos.
Simon Cross <hodgestar+bzr@gmail.com>
parents: 566
diff changeset
108 def setup(self):
390
d9c47a9e3d84 Working manual. (Still needs arrows.)
Jeremy Thurgood <firxen@gmail.com>
parents: 384
diff changeset
109 self.add_thing(ManualPage())
384
56a05ae56574 Initial manual implementation.
Jeremy Thurgood <firxen@gmail.com>
parents:
diff changeset
110 self.add_thing(PagePrior())
56a05ae56574 Initial manual implementation.
Jeremy Thurgood <firxen@gmail.com>
parents:
diff changeset
111 self.add_thing(PageNext())
56a05ae56574 Initial manual implementation.
Jeremy Thurgood <firxen@gmail.com>
parents:
diff changeset
112 self._scene_playlist = None
56a05ae56574 Initial manual implementation.
Jeremy Thurgood <firxen@gmail.com>
parents:
diff changeset
113
56a05ae56574 Initial manual implementation.
Jeremy Thurgood <firxen@gmail.com>
parents:
diff changeset
114 def enter(self):
566
ea9dd2b9186a Hook up sound in gamelib/scenes.
Simon Cross <hodgestar+bzr@gmail.com>
parents: 549
diff changeset
115 self._scene_playlist = self.sound.get_current_playlist()
384
56a05ae56574 Initial manual implementation.
Jeremy Thurgood <firxen@gmail.com>
parents:
diff changeset
116 change_playlist(None)
56a05ae56574 Initial manual implementation.
Jeremy Thurgood <firxen@gmail.com>
parents:
diff changeset
117
56a05ae56574 Initial manual implementation.
Jeremy Thurgood <firxen@gmail.com>
parents:
diff changeset
118 def leave(self):
56a05ae56574 Initial manual implementation.
Jeremy Thurgood <firxen@gmail.com>
parents:
diff changeset
119 change_playlist(self._scene_playlist)
56a05ae56574 Initial manual implementation.
Jeremy Thurgood <firxen@gmail.com>
parents:
diff changeset
120
56a05ae56574 Initial manual implementation.
Jeremy Thurgood <firxen@gmail.com>
parents:
diff changeset
121
56a05ae56574 Initial manual implementation.
Jeremy Thurgood <firxen@gmail.com>
parents:
diff changeset
122 SCENES = []
56a05ae56574 Initial manual implementation.
Jeremy Thurgood <firxen@gmail.com>
parents:
diff changeset
123 DETAIL_VIEWS = [ManualDetail]