annotate gamelib/scenes/manual.py @ 757:8ac05c038e73 pyntnclick

Turn a FIXME around thing rect handling into a TODO entry
author Stefano Rivera <stefano@rivera.za.net>
date Sat, 26 Jan 2013 12:30:17 +0200
parents 9a61cf88e6e8
children 386475464202
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
549
098ea4ea0d0d Rename imports
Neil Muller <neil@dip.sun.ac.za>
parents: 542
diff changeset
3 from pyntnclick.state import Scene, Thing
098ea4ea0d0d Rename imports
Neil Muller <neil@dip.sun.ac.za>
parents: 542
diff changeset
4 from pyntnclick.scenewidgets import InteractNoImage, InteractImage
384
56a05ae56574 Initial manual implementation.
Jeremy Thurgood <firxen@gmail.com>
parents:
diff changeset
5
56a05ae56574 Initial manual implementation.
Jeremy Thurgood <firxen@gmail.com>
parents:
diff changeset
6
56a05ae56574 Initial manual implementation.
Jeremy Thurgood <firxen@gmail.com>
parents:
diff changeset
7 # classes related the computer detail
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
390
d9c47a9e3d84 Working manual. (Still needs arrows.)
Jeremy Thurgood <firxen@gmail.com>
parents: 384
diff changeset
10 class PageBase(Thing):
d9c47a9e3d84 Working manual. (Still needs arrows.)
Jeremy Thurgood <firxen@gmail.com>
parents: 384
diff changeset
11 "Displays manual pages"
d9c47a9e3d84 Working manual. (Still needs arrows.)
Jeremy Thurgood <firxen@gmail.com>
parents: 384
diff changeset
12
d9c47a9e3d84 Working manual. (Still needs arrows.)
Jeremy Thurgood <firxen@gmail.com>
parents: 384
diff changeset
13 def get_page_thing(self):
702
9a61cf88e6e8 Avoid crashing when using the manual
Neil Muller <neil@dip.sun.ac.za>
parents: 636
diff changeset
14 # XXX: This is ugly. better ideas?
9a61cf88e6e8 Avoid crashing when using the manual
Neil Muller <neil@dip.sun.ac.za>
parents: 636
diff changeset
15 return self.game.detail_views['manual_detail'].things['manual.page']
390
d9c47a9e3d84 Working manual. (Still needs arrows.)
Jeremy Thurgood <firxen@gmail.com>
parents: 384
diff changeset
16
d9c47a9e3d84 Working manual. (Still needs arrows.)
Jeremy Thurgood <firxen@gmail.com>
parents: 384
diff changeset
17 def get_page(self):
d9c47a9e3d84 Working manual. (Still needs arrows.)
Jeremy Thurgood <firxen@gmail.com>
parents: 384
diff changeset
18 return self.get_page_thing().get_data('page')
d9c47a9e3d84 Working manual. (Still needs arrows.)
Jeremy Thurgood <firxen@gmail.com>
parents: 384
diff changeset
19
d9c47a9e3d84 Working manual. (Still needs arrows.)
Jeremy Thurgood <firxen@gmail.com>
parents: 384
diff changeset
20 def set_page(self, page):
d9c47a9e3d84 Working manual. (Still needs arrows.)
Jeremy Thurgood <firxen@gmail.com>
parents: 384
diff changeset
21 self.get_page_thing().set_page(page)
d9c47a9e3d84 Working manual. (Still needs arrows.)
Jeremy Thurgood <firxen@gmail.com>
parents: 384
diff changeset
22
394
5cfd68beb6d3 Finished manual detail.
Jeremy Thurgood <firxen@gmail.com>
parents: 390
diff changeset
23 def set_display(self, display):
5cfd68beb6d3 Finished manual detail.
Jeremy Thurgood <firxen@gmail.com>
parents: 390
diff changeset
24 self.set_data('display', display)
5cfd68beb6d3 Finished manual detail.
Jeremy Thurgood <firxen@gmail.com>
parents: 390
diff changeset
25 self.set_interact(display)
5cfd68beb6d3 Finished manual detail.
Jeremy Thurgood <firxen@gmail.com>
parents: 390
diff changeset
26
519
8f3c82c685a4 Fix is_interactive() by adding tool param.
Jeremy Thurgood <firxen@gmail.com>
parents: 394
diff changeset
27 def is_interactive(self, tool=None):
394
5cfd68beb6d3 Finished manual detail.
Jeremy Thurgood <firxen@gmail.com>
parents: 390
diff changeset
28 return self.get_data('display') == 'on'
5cfd68beb6d3 Finished manual detail.
Jeremy Thurgood <firxen@gmail.com>
parents: 390
diff changeset
29
390
d9c47a9e3d84 Working manual. (Still needs arrows.)
Jeremy Thurgood <firxen@gmail.com>
parents: 384
diff changeset
30
d9c47a9e3d84 Working manual. (Still needs arrows.)
Jeremy Thurgood <firxen@gmail.com>
parents: 384
diff changeset
31 class PagePrior(PageBase):
384
56a05ae56574 Initial manual implementation.
Jeremy Thurgood <firxen@gmail.com>
parents:
diff changeset
32 """Prior page in the manual"""
56a05ae56574 Initial manual implementation.
Jeremy Thurgood <firxen@gmail.com>
parents:
diff changeset
33
56a05ae56574 Initial manual implementation.
Jeremy Thurgood <firxen@gmail.com>
parents:
diff changeset
34 NAME = 'manual.page_prior'
56a05ae56574 Initial manual implementation.
Jeremy Thurgood <firxen@gmail.com>
parents:
diff changeset
35
56a05ae56574 Initial manual implementation.
Jeremy Thurgood <firxen@gmail.com>
parents:
diff changeset
36 INTERACTS = {
394
5cfd68beb6d3 Finished manual detail.
Jeremy Thurgood <firxen@gmail.com>
parents: 390
diff changeset
37 'on': InteractImage(36, 351, 'arrow_left.png'),
5cfd68beb6d3 Finished manual detail.
Jeremy Thurgood <firxen@gmail.com>
parents: 390
diff changeset
38 'off': InteractNoImage(31, 351, 34, 23),
384
56a05ae56574 Initial manual implementation.
Jeremy Thurgood <firxen@gmail.com>
parents:
diff changeset
39 }
394
5cfd68beb6d3 Finished manual detail.
Jeremy Thurgood <firxen@gmail.com>
parents: 390
diff changeset
40 INITIAL = 'off'
384
56a05ae56574 Initial manual implementation.
Jeremy Thurgood <firxen@gmail.com>
parents:
diff changeset
41
394
5cfd68beb6d3 Finished manual detail.
Jeremy Thurgood <firxen@gmail.com>
parents: 390
diff changeset
42 INITIAL_DATA = {
5cfd68beb6d3 Finished manual detail.
Jeremy Thurgood <firxen@gmail.com>
parents: 390
diff changeset
43 'display': 'off',
5cfd68beb6d3 Finished manual detail.
Jeremy Thurgood <firxen@gmail.com>
parents: 390
diff changeset
44 }
384
56a05ae56574 Initial manual implementation.
Jeremy Thurgood <firxen@gmail.com>
parents:
diff changeset
45
56a05ae56574 Initial manual implementation.
Jeremy Thurgood <firxen@gmail.com>
parents:
diff changeset
46 def interact_without(self):
390
d9c47a9e3d84 Working manual. (Still needs arrows.)
Jeremy Thurgood <firxen@gmail.com>
parents: 384
diff changeset
47 self.set_page(self.get_page() - 1)
384
56a05ae56574 Initial manual implementation.
Jeremy Thurgood <firxen@gmail.com>
parents:
diff changeset
48
56a05ae56574 Initial manual implementation.
Jeremy Thurgood <firxen@gmail.com>
parents:
diff changeset
49
390
d9c47a9e3d84 Working manual. (Still needs arrows.)
Jeremy Thurgood <firxen@gmail.com>
parents: 384
diff changeset
50 class PageNext(PageBase):
384
56a05ae56574 Initial manual implementation.
Jeremy Thurgood <firxen@gmail.com>
parents:
diff changeset
51 """Next page in the manual"""
56a05ae56574 Initial manual implementation.
Jeremy Thurgood <firxen@gmail.com>
parents:
diff changeset
52
56a05ae56574 Initial manual implementation.
Jeremy Thurgood <firxen@gmail.com>
parents:
diff changeset
53 NAME = 'manual.page_next'
56a05ae56574 Initial manual implementation.
Jeremy Thurgood <firxen@gmail.com>
parents:
diff changeset
54
56a05ae56574 Initial manual implementation.
Jeremy Thurgood <firxen@gmail.com>
parents:
diff changeset
55 INTERACTS = {
394
5cfd68beb6d3 Finished manual detail.
Jeremy Thurgood <firxen@gmail.com>
parents: 390
diff changeset
56 'on': InteractImage(185, 351, 'arrow_right.png'),
5cfd68beb6d3 Finished manual detail.
Jeremy Thurgood <firxen@gmail.com>
parents: 390
diff changeset
57 'off': InteractNoImage(185, 351, 34, 23),
384
56a05ae56574 Initial manual implementation.
Jeremy Thurgood <firxen@gmail.com>
parents:
diff changeset
58 }
394
5cfd68beb6d3 Finished manual detail.
Jeremy Thurgood <firxen@gmail.com>
parents: 390
diff changeset
59 INITIAL = 'on'
384
56a05ae56574 Initial manual implementation.
Jeremy Thurgood <firxen@gmail.com>
parents:
diff changeset
60
394
5cfd68beb6d3 Finished manual detail.
Jeremy Thurgood <firxen@gmail.com>
parents: 390
diff changeset
61 INITIAL_DATA = {
5cfd68beb6d3 Finished manual detail.
Jeremy Thurgood <firxen@gmail.com>
parents: 390
diff changeset
62 'display': 'on',
5cfd68beb6d3 Finished manual detail.
Jeremy Thurgood <firxen@gmail.com>
parents: 390
diff changeset
63 }
384
56a05ae56574 Initial manual implementation.
Jeremy Thurgood <firxen@gmail.com>
parents:
diff changeset
64
56a05ae56574 Initial manual implementation.
Jeremy Thurgood <firxen@gmail.com>
parents:
diff changeset
65 def interact_without(self):
390
d9c47a9e3d84 Working manual. (Still needs arrows.)
Jeremy Thurgood <firxen@gmail.com>
parents: 384
diff changeset
66 self.set_page(self.get_page() + 1)
d9c47a9e3d84 Working manual. (Still needs arrows.)
Jeremy Thurgood <firxen@gmail.com>
parents: 384
diff changeset
67
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 class ManualPage(Thing):
d9c47a9e3d84 Working manual. (Still needs arrows.)
Jeremy Thurgood <firxen@gmail.com>
parents: 384
diff changeset
70 """Page in the manual"""
d9c47a9e3d84 Working manual. (Still needs arrows.)
Jeremy Thurgood <firxen@gmail.com>
parents: 384
diff changeset
71
d9c47a9e3d84 Working manual. (Still needs arrows.)
Jeremy Thurgood <firxen@gmail.com>
parents: 384
diff changeset
72 NAME = 'manual.page'
d9c47a9e3d84 Working manual. (Still needs arrows.)
Jeremy Thurgood <firxen@gmail.com>
parents: 384
diff changeset
73
d9c47a9e3d84 Working manual. (Still needs arrows.)
Jeremy Thurgood <firxen@gmail.com>
parents: 384
diff changeset
74 INTERACTS = {
541
Neil Muller <neil@dip.sun.ac.za>
parents: 528
diff changeset
75 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
76 1: InteractImage(0, 0, 'manual_p2.png'),
7cd79c5ae4c7 Really pep8 fix manual.py
Neil Muller <neil@dip.sun.ac.za>
parents: 541
diff changeset
77 2: InteractImage(0, 0, 'manual_p3.png'),
7cd79c5ae4c7 Really pep8 fix manual.py
Neil Muller <neil@dip.sun.ac.za>
parents: 541
diff changeset
78 3: InteractImage(0, 0, 'manual_p4.png'),
390
d9c47a9e3d84 Working manual. (Still needs arrows.)
Jeremy Thurgood <firxen@gmail.com>
parents: 384
diff changeset
79 }
d9c47a9e3d84 Working manual. (Still needs arrows.)
Jeremy Thurgood <firxen@gmail.com>
parents: 384
diff changeset
80 INITIAL = 0
d9c47a9e3d84 Working manual. (Still needs arrows.)
Jeremy Thurgood <firxen@gmail.com>
parents: 384
diff changeset
81
d9c47a9e3d84 Working manual. (Still needs arrows.)
Jeremy Thurgood <firxen@gmail.com>
parents: 384
diff changeset
82 INITIAL_DATA = {
d9c47a9e3d84 Working manual. (Still needs arrows.)
Jeremy Thurgood <firxen@gmail.com>
parents: 384
diff changeset
83 'page': 0,
d9c47a9e3d84 Working manual. (Still needs arrows.)
Jeremy Thurgood <firxen@gmail.com>
parents: 384
diff changeset
84 }
d9c47a9e3d84 Working manual. (Still needs arrows.)
Jeremy Thurgood <firxen@gmail.com>
parents: 384
diff changeset
85
519
8f3c82c685a4 Fix is_interactive() by adding tool param.
Jeremy Thurgood <firxen@gmail.com>
parents: 394
diff changeset
86 def is_interactive(self, tool=None):
390
d9c47a9e3d84 Working manual. (Still needs arrows.)
Jeremy Thurgood <firxen@gmail.com>
parents: 384
diff changeset
87 return False
d9c47a9e3d84 Working manual. (Still needs arrows.)
Jeremy Thurgood <firxen@gmail.com>
parents: 384
diff changeset
88
d9c47a9e3d84 Working manual. (Still needs arrows.)
Jeremy Thurgood <firxen@gmail.com>
parents: 384
diff changeset
89 def set_page(self, page):
d9c47a9e3d84 Working manual. (Still needs arrows.)
Jeremy Thurgood <firxen@gmail.com>
parents: 384
diff changeset
90 self.set_data('page', page)
d9c47a9e3d84 Working manual. (Still needs arrows.)
Jeremy Thurgood <firxen@gmail.com>
parents: 384
diff changeset
91 self.set_interact(page)
394
5cfd68beb6d3 Finished manual detail.
Jeremy Thurgood <firxen@gmail.com>
parents: 390
diff changeset
92 self.scene.things['manual.page_prior'].set_display('on')
5cfd68beb6d3 Finished manual detail.
Jeremy Thurgood <firxen@gmail.com>
parents: 390
diff changeset
93 self.scene.things['manual.page_next'].set_display('on')
5cfd68beb6d3 Finished manual detail.
Jeremy Thurgood <firxen@gmail.com>
parents: 390
diff changeset
94 if page == 0:
5cfd68beb6d3 Finished manual detail.
Jeremy Thurgood <firxen@gmail.com>
parents: 390
diff changeset
95 self.scene.things['manual.page_prior'].set_display('off')
5cfd68beb6d3 Finished manual detail.
Jeremy Thurgood <firxen@gmail.com>
parents: 390
diff changeset
96 if page == len(self.INTERACTS) - 1:
5cfd68beb6d3 Finished manual detail.
Jeremy Thurgood <firxen@gmail.com>
parents: 390
diff changeset
97 self.scene.things['manual.page_next'].set_display('off')
384
56a05ae56574 Initial manual implementation.
Jeremy Thurgood <firxen@gmail.com>
parents:
diff changeset
98
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 class ManualDetail(Scene):
56a05ae56574 Initial manual implementation.
Jeremy Thurgood <firxen@gmail.com>
parents:
diff changeset
101
56a05ae56574 Initial manual implementation.
Jeremy Thurgood <firxen@gmail.com>
parents:
diff changeset
102 FOLDER = 'manual'
56a05ae56574 Initial manual implementation.
Jeremy Thurgood <firxen@gmail.com>
parents:
diff changeset
103 NAME = 'manual_detail'
56a05ae56574 Initial manual implementation.
Jeremy Thurgood <firxen@gmail.com>
parents:
diff changeset
104
390
d9c47a9e3d84 Working manual. (Still needs arrows.)
Jeremy Thurgood <firxen@gmail.com>
parents: 384
diff changeset
105 BACKGROUND = 'manual_detail.png'
384
56a05ae56574 Initial manual implementation.
Jeremy Thurgood <firxen@gmail.com>
parents:
diff changeset
106
592
4e9178215e75 Introduce .setup() for GameDeveloperGizmos.
Simon Cross <hodgestar+bzr@gmail.com>
parents: 566
diff changeset
107 def setup(self):
390
d9c47a9e3d84 Working manual. (Still needs arrows.)
Jeremy Thurgood <firxen@gmail.com>
parents: 384
diff changeset
108 self.add_thing(ManualPage())
384
56a05ae56574 Initial manual implementation.
Jeremy Thurgood <firxen@gmail.com>
parents:
diff changeset
109 self.add_thing(PagePrior())
56a05ae56574 Initial manual implementation.
Jeremy Thurgood <firxen@gmail.com>
parents:
diff changeset
110 self.add_thing(PageNext())
56a05ae56574 Initial manual implementation.
Jeremy Thurgood <firxen@gmail.com>
parents:
diff changeset
111 self._scene_playlist = None
56a05ae56574 Initial manual implementation.
Jeremy Thurgood <firxen@gmail.com>
parents:
diff changeset
112
56a05ae56574 Initial manual implementation.
Jeremy Thurgood <firxen@gmail.com>
parents:
diff changeset
113 def enter(self):
566
ea9dd2b9186a Hook up sound in gamelib/scenes.
Simon Cross <hodgestar+bzr@gmail.com>
parents: 549
diff changeset
114 self._scene_playlist = self.sound.get_current_playlist()
636
2748d3afcae5 Excise albow. Really.
Stefano Rivera <stefano@rivera.za.net>
parents: 603
diff changeset
115 self.sound.change_playlist(None)
384
56a05ae56574 Initial manual implementation.
Jeremy Thurgood <firxen@gmail.com>
parents:
diff changeset
116
56a05ae56574 Initial manual implementation.
Jeremy Thurgood <firxen@gmail.com>
parents:
diff changeset
117 def leave(self):
636
2748d3afcae5 Excise albow. Really.
Stefano Rivera <stefano@rivera.za.net>
parents: 603
diff changeset
118 self.sound.change_playlist(self._scene_playlist)
384
56a05ae56574 Initial manual implementation.
Jeremy Thurgood <firxen@gmail.com>
parents:
diff changeset
119
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 SCENES = []
56a05ae56574 Initial manual implementation.
Jeremy Thurgood <firxen@gmail.com>
parents:
diff changeset
122 DETAIL_VIEWS = [ManualDetail]