annotate pyntnclick/state.py @ 723:4203fbf11b86 pyntnclick

Remove unused close_detail flag
author Neil Muller <neil@dip.sun.ac.za>
date Tue, 15 Jan 2013 21:25:16 +0200
parents 9c1cb8a8bc1c
children efa58c92b304
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
7
d7c9d8273d7f Start of base classes for game state.
Simon Cross <hodgestar+bzr@gmail.com>
parents:
diff changeset
1 """Utilities and base classes for dealing with scenes."""
d7c9d8273d7f Start of base classes for game state.
Simon Cross <hodgestar+bzr@gmail.com>
parents:
diff changeset
2
498
168e9424fe91 Perform a deepcopy of INITIAL_DATA to allow mutable initial data to be used safely.
Simon Cross <hodgestar+bzr@gmail.com>
parents: 484
diff changeset
3 import copy
168e9424fe91 Perform a deepcopy of INITIAL_DATA to allow mutable initial data to be used safely.
Simon Cross <hodgestar+bzr@gmail.com>
parents: 484
diff changeset
4
644
1faced4e343a LabelWidget
Stefano Rivera <stefano@rivera.za.net>
parents: 642
diff changeset
5 from widgets.text import LabelWidget
68
158a13a48d48 Show interact rectangles when constants.DEBUG is True.
Simon Cross <hodgestar+bzr@gmail.com>
parents: 65
diff changeset
6 from pygame.color import Color
158a13a48d48 Show interact rectangles when constants.DEBUG is True.
Simon Cross <hodgestar+bzr@gmail.com>
parents: 65
diff changeset
7
677
a8c42709a689 Event-driven inventory management magic. No more inventory recreation every frame!
Jeremy Thurgood <firxen@gmail.com>
parents: 668
diff changeset
8 from pyntnclick.engine import ScreenEvent
a8c42709a689 Event-driven inventory management magic. No more inventory recreation every frame!
Jeremy Thurgood <firxen@gmail.com>
parents: 668
diff changeset
9
529
a6f9b6edb6c7 PEP-8 gamescreen and state.
Jeremy Thurgood <firxen@gmail.com>
parents: 528
diff changeset
10
655
c77d6aa29bee Some code to kinda demonstrate the ever so cunning state handling plan
Neil Muller <neil@dip.sun.ac.za>
parents: 651
diff changeset
11 def frame_rect(surface, color, rect, thick=1):
636
2748d3afcae5 Excise albow. Really.
Stefano Rivera <stefano@rivera.za.net>
parents: 625
diff changeset
12 # FIXME: Stolen from albow
2748d3afcae5 Excise albow. Really.
Stefano Rivera <stefano@rivera.za.net>
parents: 625
diff changeset
13 surface.fill(color, (rect.left, rect.top, rect.width, thick))
2748d3afcae5 Excise albow. Really.
Stefano Rivera <stefano@rivera.za.net>
parents: 625
diff changeset
14 surface.fill(color, (rect.left, rect.bottom - thick, rect.width, thick))
2748d3afcae5 Excise albow. Really.
Stefano Rivera <stefano@rivera.za.net>
parents: 625
diff changeset
15 surface.fill(color, (rect.left, rect.top, thick, rect.height))
2748d3afcae5 Excise albow. Really.
Stefano Rivera <stefano@rivera.za.net>
parents: 625
diff changeset
16 surface.fill(color, (rect.right - thick, rect.top, thick, rect.height))
2748d3afcae5 Excise albow. Really.
Stefano Rivera <stefano@rivera.za.net>
parents: 625
diff changeset
17
2748d3afcae5 Excise albow. Really.
Stefano Rivera <stefano@rivera.za.net>
parents: 625
diff changeset
18
78
6bfebfbce42e Partial message support
Neil Muller <neil@dip.sun.ac.za>
parents: 77
diff changeset
19 class Result(object):
6bfebfbce42e Partial message support
Neil Muller <neil@dip.sun.ac.za>
parents: 77
diff changeset
20 """Result of interacting with a thing"""
6bfebfbce42e Partial message support
Neil Muller <neil@dip.sun.ac.za>
parents: 77
diff changeset
21
529
a6f9b6edb6c7 PEP-8 gamescreen and state.
Jeremy Thurgood <firxen@gmail.com>
parents: 528
diff changeset
22 def __init__(self, message=None, soundfile=None, detail_view=None,
723
4203fbf11b86 Remove unused close_detail flag
Neil Muller <neil@dip.sun.ac.za>
parents: 714
diff changeset
23 widget=None, end_game=False):
78
6bfebfbce42e Partial message support
Neil Muller <neil@dip.sun.ac.za>
parents: 77
diff changeset
24 self.message = message
567
b84534a1bd2e Lazily load Result sounds.
Simon Cross <hodgestar+bzr@gmail.com>
parents: 560
diff changeset
25 self.soundfile = soundfile
133
0530547a131f Better map handling, detail_view stuff in Result.
Jeremy Thurgood <firxen@gmail.com>
parents: 132
diff changeset
26 self.detail_view = detail_view
681
497b6d7c55e7 Reimplement JIM-style in gamelib
Neil Muller <neil@dip.sun.ac.za>
parents: 679
diff changeset
27 self.widget = widget
443
3dab4984cbd7 Redo way of reaching end screen
Neil Muller <neil@dip.sun.ac.za>
parents: 435
diff changeset
28 self.end_game = end_game
78
6bfebfbce42e Partial message support
Neil Muller <neil@dip.sun.ac.za>
parents: 77
diff changeset
29
693
c8b683dd56d3 Better modal message and result handling.
Jeremy Thurgood <firxen@gmail.com>
parents: 692
diff changeset
30 def play_sound(self, screen):
567
b84534a1bd2e Lazily load Result sounds.
Simon Cross <hodgestar+bzr@gmail.com>
parents: 560
diff changeset
31 if self.soundfile:
693
c8b683dd56d3 Better modal message and result handling.
Jeremy Thurgood <firxen@gmail.com>
parents: 692
diff changeset
32 sound = screen.gd.sound.get_sound(self.soundfile)
567
b84534a1bd2e Lazily load Result sounds.
Simon Cross <hodgestar+bzr@gmail.com>
parents: 560
diff changeset
33 sound.play()
b84534a1bd2e Lazily load Result sounds.
Simon Cross <hodgestar+bzr@gmail.com>
parents: 560
diff changeset
34
693
c8b683dd56d3 Better modal message and result handling.
Jeremy Thurgood <firxen@gmail.com>
parents: 692
diff changeset
35 def process(self, screen):
126
f125bb60d7de Move result handling to result object
Neil Muller <neil@dip.sun.ac.za>
parents: 125
diff changeset
36 """Helper function to do the right thing with a result object"""
693
c8b683dd56d3 Better modal message and result handling.
Jeremy Thurgood <firxen@gmail.com>
parents: 692
diff changeset
37 self.play_sound(screen)
681
497b6d7c55e7 Reimplement JIM-style in gamelib
Neil Muller <neil@dip.sun.ac.za>
parents: 679
diff changeset
38 if self.widget:
693
c8b683dd56d3 Better modal message and result handling.
Jeremy Thurgood <firxen@gmail.com>
parents: 692
diff changeset
39 screen.queue_widget(self.widget)
126
f125bb60d7de Move result handling to result object
Neil Muller <neil@dip.sun.ac.za>
parents: 125
diff changeset
40 if self.message:
693
c8b683dd56d3 Better modal message and result handling.
Jeremy Thurgood <firxen@gmail.com>
parents: 692
diff changeset
41 screen.show_message(self.message)
133
0530547a131f Better map handling, detail_view stuff in Result.
Jeremy Thurgood <firxen@gmail.com>
parents: 132
diff changeset
42 if self.detail_view:
693
c8b683dd56d3 Better modal message and result handling.
Jeremy Thurgood <firxen@gmail.com>
parents: 692
diff changeset
43 screen.game.show_detail(self.detail_view)
443
3dab4984cbd7 Redo way of reaching end screen
Neil Muller <neil@dip.sun.ac.za>
parents: 435
diff changeset
44 if self.end_game:
693
c8b683dd56d3 Better modal message and result handling.
Jeremy Thurgood <firxen@gmail.com>
parents: 692
diff changeset
45 screen.end_game()
201
9531a22721d1 Add support for lists of results
Neil Muller <neil@dip.sun.ac.za>
parents: 193
diff changeset
46
313
40dd77f71e11 Computer typeface for JIM.
Jeremy Thurgood <firxen@gmail.com>
parents: 311
diff changeset
47
655
c77d6aa29bee Some code to kinda demonstrate the ever so cunning state handling plan
Neil Muller <neil@dip.sun.ac.za>
parents: 651
diff changeset
48 class GameState(dict):
c77d6aa29bee Some code to kinda demonstrate the ever so cunning state handling plan
Neil Muller <neil@dip.sun.ac.za>
parents: 651
diff changeset
49 """This holds the serializable game state.
c77d6aa29bee Some code to kinda demonstrate the ever so cunning state handling plan
Neil Muller <neil@dip.sun.ac.za>
parents: 651
diff changeset
50
c77d6aa29bee Some code to kinda demonstrate the ever so cunning state handling plan
Neil Muller <neil@dip.sun.ac.za>
parents: 651
diff changeset
51 Games wanting to do fancier stuff with the state should
c77d6aa29bee Some code to kinda demonstrate the ever so cunning state handling plan
Neil Muller <neil@dip.sun.ac.za>
parents: 651
diff changeset
52 sub-class this and feed the subclass into
c77d6aa29bee Some code to kinda demonstrate the ever so cunning state handling plan
Neil Muller <neil@dip.sun.ac.za>
parents: 651
diff changeset
53 GameDescription via the custom_data parameter."""
c77d6aa29bee Some code to kinda demonstrate the ever so cunning state handling plan
Neil Muller <neil@dip.sun.ac.za>
parents: 651
diff changeset
54
c77d6aa29bee Some code to kinda demonstrate the ever so cunning state handling plan
Neil Muller <neil@dip.sun.ac.za>
parents: 651
diff changeset
55 def get_all_gizmo_data(self, state_key):
c77d6aa29bee Some code to kinda demonstrate the ever so cunning state handling plan
Neil Muller <neil@dip.sun.ac.za>
parents: 651
diff changeset
56 """Get all state for a gizmo - returns a dict"""
c77d6aa29bee Some code to kinda demonstrate the ever so cunning state handling plan
Neil Muller <neil@dip.sun.ac.za>
parents: 651
diff changeset
57 return self[state_key]
c77d6aa29bee Some code to kinda demonstrate the ever so cunning state handling plan
Neil Muller <neil@dip.sun.ac.za>
parents: 651
diff changeset
58
c77d6aa29bee Some code to kinda demonstrate the ever so cunning state handling plan
Neil Muller <neil@dip.sun.ac.za>
parents: 651
diff changeset
59 def get_data(self, state_key, data_key):
c77d6aa29bee Some code to kinda demonstrate the ever so cunning state handling plan
Neil Muller <neil@dip.sun.ac.za>
parents: 651
diff changeset
60 """Get a single entry"""
c77d6aa29bee Some code to kinda demonstrate the ever so cunning state handling plan
Neil Muller <neil@dip.sun.ac.za>
parents: 651
diff changeset
61 return self[state_key].get(data_key, None)
c77d6aa29bee Some code to kinda demonstrate the ever so cunning state handling plan
Neil Muller <neil@dip.sun.ac.za>
parents: 651
diff changeset
62
c77d6aa29bee Some code to kinda demonstrate the ever so cunning state handling plan
Neil Muller <neil@dip.sun.ac.za>
parents: 651
diff changeset
63 def set_data(self, state_key, data_key, value):
c77d6aa29bee Some code to kinda demonstrate the ever so cunning state handling plan
Neil Muller <neil@dip.sun.ac.za>
parents: 651
diff changeset
64 """Set a single value"""
c77d6aa29bee Some code to kinda demonstrate the ever so cunning state handling plan
Neil Muller <neil@dip.sun.ac.za>
parents: 651
diff changeset
65 self[state_key][data_key] = value
c77d6aa29bee Some code to kinda demonstrate the ever so cunning state handling plan
Neil Muller <neil@dip.sun.ac.za>
parents: 651
diff changeset
66
c77d6aa29bee Some code to kinda demonstrate the ever so cunning state handling plan
Neil Muller <neil@dip.sun.ac.za>
parents: 651
diff changeset
67 def initialize_state(self, state_key, initial_data):
c77d6aa29bee Some code to kinda demonstrate the ever so cunning state handling plan
Neil Muller <neil@dip.sun.ac.za>
parents: 651
diff changeset
68 """Initialize a gizmo entry"""
c77d6aa29bee Some code to kinda demonstrate the ever so cunning state handling plan
Neil Muller <neil@dip.sun.ac.za>
parents: 651
diff changeset
69 if state_key not in self:
c77d6aa29bee Some code to kinda demonstrate the ever so cunning state handling plan
Neil Muller <neil@dip.sun.ac.za>
parents: 651
diff changeset
70 self[state_key] = {}
c77d6aa29bee Some code to kinda demonstrate the ever so cunning state handling plan
Neil Muller <neil@dip.sun.ac.za>
parents: 651
diff changeset
71 if initial_data:
c77d6aa29bee Some code to kinda demonstrate the ever so cunning state handling plan
Neil Muller <neil@dip.sun.ac.za>
parents: 651
diff changeset
72 # deep copy of INITIAL_DATA allows lists, sets and
c77d6aa29bee Some code to kinda demonstrate the ever so cunning state handling plan
Neil Muller <neil@dip.sun.ac.za>
parents: 651
diff changeset
73 # other mutable types to safely be used in INITIAL_DATA
c77d6aa29bee Some code to kinda demonstrate the ever so cunning state handling plan
Neil Muller <neil@dip.sun.ac.za>
parents: 651
diff changeset
74 self[state_key].update(copy.deepcopy(initial_data))
c77d6aa29bee Some code to kinda demonstrate the ever so cunning state handling plan
Neil Muller <neil@dip.sun.ac.za>
parents: 651
diff changeset
75
c77d6aa29bee Some code to kinda demonstrate the ever so cunning state handling plan
Neil Muller <neil@dip.sun.ac.za>
parents: 651
diff changeset
76
603
3ce19d33b51f Rename state to game to not cause confusion with the other state
Neil Muller <neil@dip.sun.ac.za>
parents: 595
diff changeset
77 class Game(object):
7
d7c9d8273d7f Start of base classes for game state.
Simon Cross <hodgestar+bzr@gmail.com>
parents:
diff changeset
78 """Complete game state.
d7c9d8273d7f Start of base classes for game state.
Simon Cross <hodgestar+bzr@gmail.com>
parents:
diff changeset
79
d7c9d8273d7f Start of base classes for game state.
Simon Cross <hodgestar+bzr@gmail.com>
parents:
diff changeset
80 Game state consists of:
d7c9d8273d7f Start of base classes for game state.
Simon Cross <hodgestar+bzr@gmail.com>
parents:
diff changeset
81
d7c9d8273d7f Start of base classes for game state.
Simon Cross <hodgestar+bzr@gmail.com>
parents:
diff changeset
82 * items
d7c9d8273d7f Start of base classes for game state.
Simon Cross <hodgestar+bzr@gmail.com>
parents:
diff changeset
83 * scenes
d7c9d8273d7f Start of base classes for game state.
Simon Cross <hodgestar+bzr@gmail.com>
parents:
diff changeset
84 """
560
28f03563f4db Provide stubby access to sound and resource object from GameDescription on state and scene objects.
Simon Cross <hodgestar+bzr@gmail.com>
parents: 554
diff changeset
85 def __init__(self, gd):
28f03563f4db Provide stubby access to sound and resource object from GameDescription on state and scene objects.
Simon Cross <hodgestar+bzr@gmail.com>
parents: 554
diff changeset
86 # game description
28f03563f4db Provide stubby access to sound and resource object from GameDescription on state and scene objects.
Simon Cross <hodgestar+bzr@gmail.com>
parents: 554
diff changeset
87 self.gd = gd
7
d7c9d8273d7f Start of base classes for game state.
Simon Cross <hodgestar+bzr@gmail.com>
parents:
diff changeset
88 # map of scene name -> Scene object
d7c9d8273d7f Start of base classes for game state.
Simon Cross <hodgestar+bzr@gmail.com>
parents:
diff changeset
89 self.scenes = {}
93
350ce4ebe122 Detail view without any functionality.
Jeremy Thurgood <firxen@gmail.com>
parents: 88
diff changeset
90 # map of detail view name -> DetailView object
350ce4ebe122 Detail view without any functionality.
Jeremy Thurgood <firxen@gmail.com>
parents: 88
diff changeset
91 self.detail_views = {}
7
d7c9d8273d7f Start of base classes for game state.
Simon Cross <hodgestar+bzr@gmail.com>
parents:
diff changeset
92 # map of item name -> Item object
d7c9d8273d7f Start of base classes for game state.
Simon Cross <hodgestar+bzr@gmail.com>
parents:
diff changeset
93 self.items = {}
33
f8e02d02c782 Convert inventory to list of item objects.
Simon Cross <hodgestar+bzr@gmail.com>
parents: 32
diff changeset
94 # list of item objects in inventory
f8e02d02c782 Convert inventory to list of item objects.
Simon Cross <hodgestar+bzr@gmail.com>
parents: 32
diff changeset
95 self.inventory = []
73
932b0956e77a Make tools usable.
Simon Cross <hodgestar+bzr@gmail.com>
parents: 72
diff changeset
96 # currently selected tool (item)
932b0956e77a Make tools usable.
Simon Cross <hodgestar+bzr@gmail.com>
parents: 72
diff changeset
97 self.tool = None
603
3ce19d33b51f Rename state to game to not cause confusion with the other state
Neil Muller <neil@dip.sun.ac.za>
parents: 595
diff changeset
98 # Global game data
655
c77d6aa29bee Some code to kinda demonstrate the ever so cunning state handling plan
Neil Muller <neil@dip.sun.ac.za>
parents: 651
diff changeset
99 self.data = GameState()
28
0f25f7b9b37a Add loading of initial state.
Simon Cross <hodgestar+bzr@gmail.com>
parents: 23
diff changeset
100 # current scene
0f25f7b9b37a Add loading of initial state.
Simon Cross <hodgestar+bzr@gmail.com>
parents: 23
diff changeset
101 self.current_scene = None
553
ebb2efcb4ea7 Create a re-usable main function.
Simon Cross <hodgestar+bzr@gmail.com>
parents: 551
diff changeset
102 # debug rects
ebb2efcb4ea7 Create a re-usable main function.
Simon Cross <hodgestar+bzr@gmail.com>
parents: 551
diff changeset
103 self.debug_rects = False
ebb2efcb4ea7 Create a re-usable main function.
Simon Cross <hodgestar+bzr@gmail.com>
parents: 551
diff changeset
104
655
c77d6aa29bee Some code to kinda demonstrate the ever so cunning state handling plan
Neil Muller <neil@dip.sun.ac.za>
parents: 651
diff changeset
105 def set_custom_data(self, data_object):
c77d6aa29bee Some code to kinda demonstrate the ever so cunning state handling plan
Neil Muller <neil@dip.sun.ac.za>
parents: 651
diff changeset
106 self.data = data_object
c77d6aa29bee Some code to kinda demonstrate the ever so cunning state handling plan
Neil Muller <neil@dip.sun.ac.za>
parents: 651
diff changeset
107
553
ebb2efcb4ea7 Create a re-usable main function.
Simon Cross <hodgestar+bzr@gmail.com>
parents: 551
diff changeset
108 def set_debug_rects(self, value=True):
ebb2efcb4ea7 Create a re-usable main function.
Simon Cross <hodgestar+bzr@gmail.com>
parents: 551
diff changeset
109 self.debug_rects = value
28
0f25f7b9b37a Add loading of initial state.
Simon Cross <hodgestar+bzr@gmail.com>
parents: 23
diff changeset
110
0f25f7b9b37a Add loading of initial state.
Simon Cross <hodgestar+bzr@gmail.com>
parents: 23
diff changeset
111 def add_scene(self, scene):
603
3ce19d33b51f Rename state to game to not cause confusion with the other state
Neil Muller <neil@dip.sun.ac.za>
parents: 595
diff changeset
112 scene.set_game(self)
28
0f25f7b9b37a Add loading of initial state.
Simon Cross <hodgestar+bzr@gmail.com>
parents: 23
diff changeset
113 self.scenes[scene.name] = scene
0f25f7b9b37a Add loading of initial state.
Simon Cross <hodgestar+bzr@gmail.com>
parents: 23
diff changeset
114
93
350ce4ebe122 Detail view without any functionality.
Jeremy Thurgood <firxen@gmail.com>
parents: 88
diff changeset
115 def add_detail_view(self, detail_view):
603
3ce19d33b51f Rename state to game to not cause confusion with the other state
Neil Muller <neil@dip.sun.ac.za>
parents: 595
diff changeset
116 detail_view.set_game(self)
93
350ce4ebe122 Detail view without any functionality.
Jeremy Thurgood <firxen@gmail.com>
parents: 88
diff changeset
117 self.detail_views[detail_view.name] = detail_view
350ce4ebe122 Detail view without any functionality.
Jeremy Thurgood <firxen@gmail.com>
parents: 88
diff changeset
118
32
18cb1af411ef Add helper for adding items. Give items names. Make things take a rectangle.
Simon Cross <hodgestar+bzr@gmail.com>
parents: 30
diff changeset
119 def add_item(self, item):
603
3ce19d33b51f Rename state to game to not cause confusion with the other state
Neil Muller <neil@dip.sun.ac.za>
parents: 595
diff changeset
120 item.set_game(self)
35
ebc76bc0c067 First item!
Simon Cross <hodgestar+bzr@gmail.com>
parents: 34
diff changeset
121 self.items[item.name] = item
32
18cb1af411ef Add helper for adding items. Give items names. Make things take a rectangle.
Simon Cross <hodgestar+bzr@gmail.com>
parents: 30
diff changeset
122
612
cfc16ded7b34 Fix scene/screen confusion
Neil Muller <neil@dip.sun.ac.za>
parents: 608
diff changeset
123 def load_scenes(self, modname):
28
0f25f7b9b37a Add loading of initial state.
Simon Cross <hodgestar+bzr@gmail.com>
parents: 23
diff changeset
124 mod = __import__("gamelib.scenes.%s" % (modname,), fromlist=[modname])
0f25f7b9b37a Add loading of initial state.
Simon Cross <hodgestar+bzr@gmail.com>
parents: 23
diff changeset
125 for scene_cls in mod.SCENES:
608
a25cd1c6335a Pass screens through engine by name
Neil Muller <neil@dip.sun.ac.za>
parents: 603
diff changeset
126 scene = scene_cls(self)
a25cd1c6335a Pass screens through engine by name
Neil Muller <neil@dip.sun.ac.za>
parents: 603
diff changeset
127 self.add_scene(scene)
119
d5f7cccfdb6c Hook up "detail view" scenes.
Jeremy Thurgood <firxen@gmail.com>
parents: 117
diff changeset
128 if hasattr(mod, 'DETAIL_VIEWS'):
d5f7cccfdb6c Hook up "detail view" scenes.
Jeremy Thurgood <firxen@gmail.com>
parents: 117
diff changeset
129 for scene_cls in mod.DETAIL_VIEWS:
608
a25cd1c6335a Pass screens through engine by name
Neil Muller <neil@dip.sun.ac.za>
parents: 603
diff changeset
130 scene = scene_cls(self)
a25cd1c6335a Pass screens through engine by name
Neil Muller <neil@dip.sun.ac.za>
parents: 603
diff changeset
131 self.add_detail_view(scene)
28
0f25f7b9b37a Add loading of initial state.
Simon Cross <hodgestar+bzr@gmail.com>
parents: 23
diff changeset
132
692
d6ded808cc33 Much scene management refactoring.
Jeremy Thurgood <firxen@gmail.com>
parents: 684
diff changeset
133 def change_scene(self, name):
d6ded808cc33 Much scene management refactoring.
Jeremy Thurgood <firxen@gmail.com>
parents: 684
diff changeset
134 ScreenEvent.post('game', 'change_scene',
d6ded808cc33 Much scene management refactoring.
Jeremy Thurgood <firxen@gmail.com>
parents: 684
diff changeset
135 {'name': name, 'detail': False})
28
0f25f7b9b37a Add loading of initial state.
Simon Cross <hodgestar+bzr@gmail.com>
parents: 23
diff changeset
136
692
d6ded808cc33 Much scene management refactoring.
Jeremy Thurgood <firxen@gmail.com>
parents: 684
diff changeset
137 def show_detail(self, name):
d6ded808cc33 Much scene management refactoring.
Jeremy Thurgood <firxen@gmail.com>
parents: 684
diff changeset
138 ScreenEvent.post('game', 'change_scene',
d6ded808cc33 Much scene management refactoring.
Jeremy Thurgood <firxen@gmail.com>
parents: 684
diff changeset
139 {'name': name, 'detail': True})
119
d5f7cccfdb6c Hook up "detail view" scenes.
Jeremy Thurgood <firxen@gmail.com>
parents: 117
diff changeset
140
677
a8c42709a689 Event-driven inventory management magic. No more inventory recreation every frame!
Jeremy Thurgood <firxen@gmail.com>
parents: 668
diff changeset
141 def _update_inventory(self):
a8c42709a689 Event-driven inventory management magic. No more inventory recreation every frame!
Jeremy Thurgood <firxen@gmail.com>
parents: 668
diff changeset
142 ScreenEvent.post('game', 'inventory', None)
a8c42709a689 Event-driven inventory management magic. No more inventory recreation every frame!
Jeremy Thurgood <firxen@gmail.com>
parents: 668
diff changeset
143
30
daf9eecb670f Add inventory manipulation methods.
Simon Cross <hodgestar+bzr@gmail.com>
parents: 29
diff changeset
144 def add_inventory_item(self, name):
33
f8e02d02c782 Convert inventory to list of item objects.
Simon Cross <hodgestar+bzr@gmail.com>
parents: 32
diff changeset
145 self.inventory.append(self.items[name])
677
a8c42709a689 Event-driven inventory management magic. No more inventory recreation every frame!
Jeremy Thurgood <firxen@gmail.com>
parents: 668
diff changeset
146 self._update_inventory()
30
daf9eecb670f Add inventory manipulation methods.
Simon Cross <hodgestar+bzr@gmail.com>
parents: 29
diff changeset
147
331
a1ffc919d0c1 Add is_in_inventory helper
Neil Muller <neil@dip.sun.ac.za>
parents: 326
diff changeset
148 def is_in_inventory(self, name):
340
185eca15a42a Don't crash if the item doesn't exist
Neil Muller <neil@dip.sun.ac.za>
parents: 336
diff changeset
149 if name in self.items:
185eca15a42a Don't crash if the item doesn't exist
Neil Muller <neil@dip.sun.ac.za>
parents: 336
diff changeset
150 return self.items[name] in self.inventory
185eca15a42a Don't crash if the item doesn't exist
Neil Muller <neil@dip.sun.ac.za>
parents: 336
diff changeset
151 return False
331
a1ffc919d0c1 Add is_in_inventory helper
Neil Muller <neil@dip.sun.ac.za>
parents: 326
diff changeset
152
30
daf9eecb670f Add inventory manipulation methods.
Simon Cross <hodgestar+bzr@gmail.com>
parents: 29
diff changeset
153 def remove_inventory_item(self, name):
34
e5c043aeed65 Inventory and items. And stuff.
Jeremy Thurgood <firxen@gmail.com>
parents: 33
diff changeset
154 self.inventory.remove(self.items[name])
117
139864ce8bdb removed items can't be the current tool
Neil Muller <neil@dip.sun.ac.za>
parents: 107
diff changeset
155 # Unselect tool if it's removed
139864ce8bdb removed items can't be the current tool
Neil Muller <neil@dip.sun.ac.za>
parents: 107
diff changeset
156 if self.tool == self.items[name]:
139864ce8bdb removed items can't be the current tool
Neil Muller <neil@dip.sun.ac.za>
parents: 107
diff changeset
157 self.set_tool(None)
677
a8c42709a689 Event-driven inventory management magic. No more inventory recreation every frame!
Jeremy Thurgood <firxen@gmail.com>
parents: 668
diff changeset
158 self._update_inventory()
30
daf9eecb670f Add inventory manipulation methods.
Simon Cross <hodgestar+bzr@gmail.com>
parents: 29
diff changeset
159
305
75783238f73d Make replace_inventory_item use names for consisency
Neil Muller <neil@dip.sun.ac.za>
parents: 282
diff changeset
160 def replace_inventory_item(self, old_item_name, new_item_name):
167
5845a3ed4dad Inventory interaction can (surprisingly) affect the inventory
Neil Muller <neil@dip.sun.ac.za>
parents: 166
diff changeset
161 """Try to replace an item in the inventory with a new one"""
5845a3ed4dad Inventory interaction can (surprisingly) affect the inventory
Neil Muller <neil@dip.sun.ac.za>
parents: 166
diff changeset
162 try:
305
75783238f73d Make replace_inventory_item use names for consisency
Neil Muller <neil@dip.sun.ac.za>
parents: 282
diff changeset
163 index = self.inventory.index(self.items[old_item_name])
75783238f73d Make replace_inventory_item use names for consisency
Neil Muller <neil@dip.sun.ac.za>
parents: 282
diff changeset
164 self.inventory[index] = self.items[new_item_name]
75783238f73d Make replace_inventory_item use names for consisency
Neil Muller <neil@dip.sun.ac.za>
parents: 282
diff changeset
165 if self.tool == self.items[old_item_name]:
75783238f73d Make replace_inventory_item use names for consisency
Neil Muller <neil@dip.sun.ac.za>
parents: 282
diff changeset
166 self.set_tool(self.items[new_item_name])
167
5845a3ed4dad Inventory interaction can (surprisingly) affect the inventory
Neil Muller <neil@dip.sun.ac.za>
parents: 166
diff changeset
167 except ValueError:
5845a3ed4dad Inventory interaction can (surprisingly) affect the inventory
Neil Muller <neil@dip.sun.ac.za>
parents: 166
diff changeset
168 return False
677
a8c42709a689 Event-driven inventory management magic. No more inventory recreation every frame!
Jeremy Thurgood <firxen@gmail.com>
parents: 668
diff changeset
169 self._update_inventory()
167
5845a3ed4dad Inventory interaction can (surprisingly) affect the inventory
Neil Muller <neil@dip.sun.ac.za>
parents: 166
diff changeset
170 return True
5845a3ed4dad Inventory interaction can (surprisingly) affect the inventory
Neil Muller <neil@dip.sun.ac.za>
parents: 166
diff changeset
171
73
932b0956e77a Make tools usable.
Simon Cross <hodgestar+bzr@gmail.com>
parents: 72
diff changeset
172 def set_tool(self, item):
932b0956e77a Make tools usable.
Simon Cross <hodgestar+bzr@gmail.com>
parents: 72
diff changeset
173 self.tool = item
932b0956e77a Make tools usable.
Simon Cross <hodgestar+bzr@gmail.com>
parents: 72
diff changeset
174
7
d7c9d8273d7f Start of base classes for game state.
Simon Cross <hodgestar+bzr@gmail.com>
parents:
diff changeset
175
592
4e9178215e75 Introduce .setup() for GameDeveloperGizmos.
Simon Cross <hodgestar+bzr@gmail.com>
parents: 588
diff changeset
176 class GameDeveloperGizmo(object):
4e9178215e75 Introduce .setup() for GameDeveloperGizmos.
Simon Cross <hodgestar+bzr@gmail.com>
parents: 588
diff changeset
177 """Base class for objects game developers see."""
4e9178215e75 Introduce .setup() for GameDeveloperGizmos.
Simon Cross <hodgestar+bzr@gmail.com>
parents: 588
diff changeset
178
4e9178215e75 Introduce .setup() for GameDeveloperGizmos.
Simon Cross <hodgestar+bzr@gmail.com>
parents: 588
diff changeset
179 def __init__(self):
4e9178215e75 Introduce .setup() for GameDeveloperGizmos.
Simon Cross <hodgestar+bzr@gmail.com>
parents: 588
diff changeset
180 """Set """
603
3ce19d33b51f Rename state to game to not cause confusion with the other state
Neil Muller <neil@dip.sun.ac.za>
parents: 595
diff changeset
181 self.game = None
592
4e9178215e75 Introduce .setup() for GameDeveloperGizmos.
Simon Cross <hodgestar+bzr@gmail.com>
parents: 588
diff changeset
182 self.gd = None
4e9178215e75 Introduce .setup() for GameDeveloperGizmos.
Simon Cross <hodgestar+bzr@gmail.com>
parents: 588
diff changeset
183 self.resource = None
4e9178215e75 Introduce .setup() for GameDeveloperGizmos.
Simon Cross <hodgestar+bzr@gmail.com>
parents: 588
diff changeset
184 self.sound = None
4e9178215e75 Introduce .setup() for GameDeveloperGizmos.
Simon Cross <hodgestar+bzr@gmail.com>
parents: 588
diff changeset
185
603
3ce19d33b51f Rename state to game to not cause confusion with the other state
Neil Muller <neil@dip.sun.ac.za>
parents: 595
diff changeset
186 def set_game(self, game):
3ce19d33b51f Rename state to game to not cause confusion with the other state
Neil Muller <neil@dip.sun.ac.za>
parents: 595
diff changeset
187 self.game = game
3ce19d33b51f Rename state to game to not cause confusion with the other state
Neil Muller <neil@dip.sun.ac.za>
parents: 595
diff changeset
188 self.gd = game.gd
592
4e9178215e75 Introduce .setup() for GameDeveloperGizmos.
Simon Cross <hodgestar+bzr@gmail.com>
parents: 588
diff changeset
189 self.resource = self.gd.resource
4e9178215e75 Introduce .setup() for GameDeveloperGizmos.
Simon Cross <hodgestar+bzr@gmail.com>
parents: 588
diff changeset
190 self.sound = self.gd.sound
4e9178215e75 Introduce .setup() for GameDeveloperGizmos.
Simon Cross <hodgestar+bzr@gmail.com>
parents: 588
diff changeset
191 self.setup()
4e9178215e75 Introduce .setup() for GameDeveloperGizmos.
Simon Cross <hodgestar+bzr@gmail.com>
parents: 588
diff changeset
192
4e9178215e75 Introduce .setup() for GameDeveloperGizmos.
Simon Cross <hodgestar+bzr@gmail.com>
parents: 588
diff changeset
193 def setup(self):
4e9178215e75 Introduce .setup() for GameDeveloperGizmos.
Simon Cross <hodgestar+bzr@gmail.com>
parents: 588
diff changeset
194 """Game developers should override this to do their setup.
4e9178215e75 Introduce .setup() for GameDeveloperGizmos.
Simon Cross <hodgestar+bzr@gmail.com>
parents: 588
diff changeset
195
4e9178215e75 Introduce .setup() for GameDeveloperGizmos.
Simon Cross <hodgestar+bzr@gmail.com>
parents: 588
diff changeset
196 It will be called after all the useful state functions have been
4e9178215e75 Introduce .setup() for GameDeveloperGizmos.
Simon Cross <hodgestar+bzr@gmail.com>
parents: 588
diff changeset
197 set.
4e9178215e75 Introduce .setup() for GameDeveloperGizmos.
Simon Cross <hodgestar+bzr@gmail.com>
parents: 588
diff changeset
198 """
4e9178215e75 Introduce .setup() for GameDeveloperGizmos.
Simon Cross <hodgestar+bzr@gmail.com>
parents: 588
diff changeset
199 pass
4e9178215e75 Introduce .setup() for GameDeveloperGizmos.
Simon Cross <hodgestar+bzr@gmail.com>
parents: 588
diff changeset
200
4e9178215e75 Introduce .setup() for GameDeveloperGizmos.
Simon Cross <hodgestar+bzr@gmail.com>
parents: 588
diff changeset
201
4e9178215e75 Introduce .setup() for GameDeveloperGizmos.
Simon Cross <hodgestar+bzr@gmail.com>
parents: 588
diff changeset
202 class StatefulGizmo(GameDeveloperGizmo):
55
2e2f6ff54780 Part of the cryo door puzzle.
Jeremy Thurgood <firxen@gmail.com>
parents: 47
diff changeset
203
2e2f6ff54780 Part of the cryo door puzzle.
Jeremy Thurgood <firxen@gmail.com>
parents: 47
diff changeset
204 # initial data (optional, defaults to none)
2e2f6ff54780 Part of the cryo door puzzle.
Jeremy Thurgood <firxen@gmail.com>
parents: 47
diff changeset
205 INITIAL_DATA = None
603
3ce19d33b51f Rename state to game to not cause confusion with the other state
Neil Muller <neil@dip.sun.ac.za>
parents: 595
diff changeset
206 STATE_KEY = None
55
2e2f6ff54780 Part of the cryo door puzzle.
Jeremy Thurgood <firxen@gmail.com>
parents: 47
diff changeset
207
2e2f6ff54780 Part of the cryo door puzzle.
Jeremy Thurgood <firxen@gmail.com>
parents: 47
diff changeset
208 def __init__(self):
592
4e9178215e75 Introduce .setup() for GameDeveloperGizmos.
Simon Cross <hodgestar+bzr@gmail.com>
parents: 588
diff changeset
209 GameDeveloperGizmo.__init__(self)
603
3ce19d33b51f Rename state to game to not cause confusion with the other state
Neil Muller <neil@dip.sun.ac.za>
parents: 595
diff changeset
210 self.state_key = self.STATE_KEY
3ce19d33b51f Rename state to game to not cause confusion with the other state
Neil Muller <neil@dip.sun.ac.za>
parents: 595
diff changeset
211 self.state = None # set this with set_state if required
3ce19d33b51f Rename state to game to not cause confusion with the other state
Neil Muller <neil@dip.sun.ac.za>
parents: 595
diff changeset
212
3ce19d33b51f Rename state to game to not cause confusion with the other state
Neil Muller <neil@dip.sun.ac.za>
parents: 595
diff changeset
213 def set_state(self, state):
3ce19d33b51f Rename state to game to not cause confusion with the other state
Neil Muller <neil@dip.sun.ac.za>
parents: 595
diff changeset
214 """Set the state object and initialize if needed"""
3ce19d33b51f Rename state to game to not cause confusion with the other state
Neil Muller <neil@dip.sun.ac.za>
parents: 595
diff changeset
215 self.state = state
655
c77d6aa29bee Some code to kinda demonstrate the ever so cunning state handling plan
Neil Muller <neil@dip.sun.ac.za>
parents: 651
diff changeset
216 self.state.initialize_state(self.state_key, self.INITIAL_DATA)
55
2e2f6ff54780 Part of the cryo door puzzle.
Jeremy Thurgood <firxen@gmail.com>
parents: 47
diff changeset
217
2e2f6ff54780 Part of the cryo door puzzle.
Jeremy Thurgood <firxen@gmail.com>
parents: 47
diff changeset
218 def set_data(self, key, value):
603
3ce19d33b51f Rename state to game to not cause confusion with the other state
Neil Muller <neil@dip.sun.ac.za>
parents: 595
diff changeset
219 if self.state:
655
c77d6aa29bee Some code to kinda demonstrate the ever so cunning state handling plan
Neil Muller <neil@dip.sun.ac.za>
parents: 651
diff changeset
220 self.state.set_data(self.state_key, key, value)
55
2e2f6ff54780 Part of the cryo door puzzle.
Jeremy Thurgood <firxen@gmail.com>
parents: 47
diff changeset
221
2e2f6ff54780 Part of the cryo door puzzle.
Jeremy Thurgood <firxen@gmail.com>
parents: 47
diff changeset
222 def get_data(self, key):
603
3ce19d33b51f Rename state to game to not cause confusion with the other state
Neil Muller <neil@dip.sun.ac.za>
parents: 595
diff changeset
223 if self.state:
655
c77d6aa29bee Some code to kinda demonstrate the ever so cunning state handling plan
Neil Muller <neil@dip.sun.ac.za>
parents: 651
diff changeset
224 return self.state.get_data(self.state_key, key)
55
2e2f6ff54780 Part of the cryo door puzzle.
Jeremy Thurgood <firxen@gmail.com>
parents: 47
diff changeset
225
2e2f6ff54780 Part of the cryo door puzzle.
Jeremy Thurgood <firxen@gmail.com>
parents: 47
diff changeset
226
2e2f6ff54780 Part of the cryo door puzzle.
Jeremy Thurgood <firxen@gmail.com>
parents: 47
diff changeset
227 class Scene(StatefulGizmo):
7
d7c9d8273d7f Start of base classes for game state.
Simon Cross <hodgestar+bzr@gmail.com>
parents:
diff changeset
228 """Base class for scenes."""
d7c9d8273d7f Start of base classes for game state.
Simon Cross <hodgestar+bzr@gmail.com>
parents:
diff changeset
229
28
0f25f7b9b37a Add loading of initial state.
Simon Cross <hodgestar+bzr@gmail.com>
parents: 23
diff changeset
230 # sub-folder to look for resources in
22
8e709824306d Add items and things.
Simon Cross <hodgestar+bzr@gmail.com>
parents: 18
diff changeset
231 FOLDER = None
28
0f25f7b9b37a Add loading of initial state.
Simon Cross <hodgestar+bzr@gmail.com>
parents: 23
diff changeset
232
0f25f7b9b37a Add loading of initial state.
Simon Cross <hodgestar+bzr@gmail.com>
parents: 23
diff changeset
233 # name of background image resource
22
8e709824306d Add items and things.
Simon Cross <hodgestar+bzr@gmail.com>
parents: 18
diff changeset
234 BACKGROUND = None
8e709824306d Add items and things.
Simon Cross <hodgestar+bzr@gmail.com>
parents: 18
diff changeset
235
28
0f25f7b9b37a Add loading of initial state.
Simon Cross <hodgestar+bzr@gmail.com>
parents: 23
diff changeset
236 # name of scene (optional, defaults to folder)
0f25f7b9b37a Add loading of initial state.
Simon Cross <hodgestar+bzr@gmail.com>
parents: 23
diff changeset
237 NAME = None
0f25f7b9b37a Add loading of initial state.
Simon Cross <hodgestar+bzr@gmail.com>
parents: 23
diff changeset
238
278
8e27efd331aa Offset support for scenes
Neil Muller <neil@dip.sun.ac.za>
parents: 266
diff changeset
239 # Offset of the background image
8e27efd331aa Offset support for scenes
Neil Muller <neil@dip.sun.ac.za>
parents: 266
diff changeset
240 OFFSET = (0, 0)
8e27efd331aa Offset support for scenes
Neil Muller <neil@dip.sun.ac.za>
parents: 266
diff changeset
241
28
0f25f7b9b37a Add loading of initial state.
Simon Cross <hodgestar+bzr@gmail.com>
parents: 23
diff changeset
242 def __init__(self, state):
55
2e2f6ff54780 Part of the cryo door puzzle.
Jeremy Thurgood <firxen@gmail.com>
parents: 47
diff changeset
243 StatefulGizmo.__init__(self)
28
0f25f7b9b37a Add loading of initial state.
Simon Cross <hodgestar+bzr@gmail.com>
parents: 23
diff changeset
244 # scene name
0f25f7b9b37a Add loading of initial state.
Simon Cross <hodgestar+bzr@gmail.com>
parents: 23
diff changeset
245 self.name = self.NAME if self.NAME is not None else self.FOLDER
603
3ce19d33b51f Rename state to game to not cause confusion with the other state
Neil Muller <neil@dip.sun.ac.za>
parents: 595
diff changeset
246 self.state_key = self.name
22
8e709824306d Add items and things.
Simon Cross <hodgestar+bzr@gmail.com>
parents: 18
diff changeset
247 # map of thing names -> Thing objects
8e709824306d Add items and things.
Simon Cross <hodgestar+bzr@gmail.com>
parents: 18
diff changeset
248 self.things = {}
692
d6ded808cc33 Much scene management refactoring.
Jeremy Thurgood <firxen@gmail.com>
parents: 684
diff changeset
249 self.current_thing = None
526
a984cf27b527 Defer some resource loading until it's actually necessary.
Jeremy Thurgood <firxen@gmail.com>
parents: 520
diff changeset
250 self._background = None
7
d7c9d8273d7f Start of base classes for game state.
Simon Cross <hodgestar+bzr@gmail.com>
parents:
diff changeset
251
603
3ce19d33b51f Rename state to game to not cause confusion with the other state
Neil Muller <neil@dip.sun.ac.za>
parents: 595
diff changeset
252 def set_game(self, game):
3ce19d33b51f Rename state to game to not cause confusion with the other state
Neil Muller <neil@dip.sun.ac.za>
parents: 595
diff changeset
253 super(Scene, self).set_game(game)
3ce19d33b51f Rename state to game to not cause confusion with the other state
Neil Muller <neil@dip.sun.ac.za>
parents: 595
diff changeset
254 self.set_state(game.data)
3ce19d33b51f Rename state to game to not cause confusion with the other state
Neil Muller <neil@dip.sun.ac.za>
parents: 595
diff changeset
255
35
ebc76bc0c067 First item!
Simon Cross <hodgestar+bzr@gmail.com>
parents: 34
diff changeset
256 def add_item(self, item):
603
3ce19d33b51f Rename state to game to not cause confusion with the other state
Neil Muller <neil@dip.sun.ac.za>
parents: 595
diff changeset
257 self.game.add_item(item)
35
ebc76bc0c067 First item!
Simon Cross <hodgestar+bzr@gmail.com>
parents: 34
diff changeset
258
39
088a101f5b94 Add an example Thing to cryo scene.
Simon Cross <hodgestar+bzr@gmail.com>
parents: 35
diff changeset
259 def add_thing(self, thing):
088a101f5b94 Add an example Thing to cryo scene.
Simon Cross <hodgestar+bzr@gmail.com>
parents: 35
diff changeset
260 self.things[thing.name] = thing
603
3ce19d33b51f Rename state to game to not cause confusion with the other state
Neil Muller <neil@dip.sun.ac.za>
parents: 595
diff changeset
261 thing.set_game(self.game)
41
ad6f56bfa8b7 Cryo door, titanium leg and some interaction prototypes.
Jeremy Thurgood <firxen@gmail.com>
parents: 39
diff changeset
262 thing.set_scene(self)
ad6f56bfa8b7 Cryo door, titanium leg and some interaction prototypes.
Jeremy Thurgood <firxen@gmail.com>
parents: 39
diff changeset
263
ad6f56bfa8b7 Cryo door, titanium leg and some interaction prototypes.
Jeremy Thurgood <firxen@gmail.com>
parents: 39
diff changeset
264 def remove_thing(self, thing):
ad6f56bfa8b7 Cryo door, titanium leg and some interaction prototypes.
Jeremy Thurgood <firxen@gmail.com>
parents: 39
diff changeset
265 del self.things[thing.name]
692
d6ded808cc33 Much scene management refactoring.
Jeremy Thurgood <firxen@gmail.com>
parents: 684
diff changeset
266 if thing is self.current_thing:
d6ded808cc33 Much scene management refactoring.
Jeremy Thurgood <firxen@gmail.com>
parents: 684
diff changeset
267 self.current_thing.leave()
d6ded808cc33 Much scene management refactoring.
Jeremy Thurgood <firxen@gmail.com>
parents: 684
diff changeset
268 self.current_thing = None
39
088a101f5b94 Add an example Thing to cryo scene.
Simon Cross <hodgestar+bzr@gmail.com>
parents: 35
diff changeset
269
668
387b4288d357 Centre labels
Stefano Rivera <stefano@rivera.za.net>
parents: 655
diff changeset
270 def _get_description(self, dest_rect):
692
d6ded808cc33 Much scene management refactoring.
Jeremy Thurgood <firxen@gmail.com>
parents: 684
diff changeset
271 text = (self.current_thing and
d6ded808cc33 Much scene management refactoring.
Jeremy Thurgood <firxen@gmail.com>
parents: 684
diff changeset
272 self.current_thing.get_description())
76
1a5fdc225939 Add description rendering to scene rendering.
Simon Cross <hodgestar+bzr@gmail.com>
parents: 75
diff changeset
273 if text is None:
1a5fdc225939 Add description rendering to scene rendering.
Simon Cross <hodgestar+bzr@gmail.com>
parents: 75
diff changeset
274 return None
668
387b4288d357 Centre labels
Stefano Rivera <stefano@rivera.za.net>
parents: 655
diff changeset
275 label = LabelWidget((0, 10), self.gd, text)
387b4288d357 Centre labels
Stefano Rivera <stefano@rivera.za.net>
parents: 655
diff changeset
276 label.rect.left += (dest_rect.width - label.rect.width) / 2
76
1a5fdc225939 Add description rendering to scene rendering.
Simon Cross <hodgestar+bzr@gmail.com>
parents: 75
diff changeset
277 return label
1a5fdc225939 Add description rendering to scene rendering.
Simon Cross <hodgestar+bzr@gmail.com>
parents: 75
diff changeset
278
651
122204fb6eb1 Defer drawing description to StateWidget
Neil Muller <neil@dip.sun.ac.za>
parents: 644
diff changeset
279 def draw_description(self, surface):
668
387b4288d357 Centre labels
Stefano Rivera <stefano@rivera.za.net>
parents: 655
diff changeset
280 description = self._get_description(surface.get_rect())
319
fd849354be58 Mouse handling refactorings.
Jeremy Thurgood <firxen@gmail.com>
parents: 314
diff changeset
281 if description is not None:
642
143c67501c79 Make descriptions work (kinda, sorta, maybe if you squint at it just right)
Neil Muller <neil@dip.sun.ac.za>
parents: 640
diff changeset
282 description.draw(surface)
76
1a5fdc225939 Add description rendering to scene rendering.
Simon Cross <hodgestar+bzr@gmail.com>
parents: 75
diff changeset
283
526
a984cf27b527 Defer some resource loading until it's actually necessary.
Jeremy Thurgood <firxen@gmail.com>
parents: 520
diff changeset
284 def _cache_background(self):
a984cf27b527 Defer some resource loading until it's actually necessary.
Jeremy Thurgood <firxen@gmail.com>
parents: 520
diff changeset
285 if self.BACKGROUND and not self._background:
592
4e9178215e75 Introduce .setup() for GameDeveloperGizmos.
Simon Cross <hodgestar+bzr@gmail.com>
parents: 588
diff changeset
286 self._background = self.resource.get_image(
625
85153f422522 Differently yuck get_image().
Jeremy Thurgood <firxen@gmail.com>
parents: 612
diff changeset
287 self.FOLDER, self.BACKGROUND)
526
a984cf27b527 Defer some resource loading until it's actually necessary.
Jeremy Thurgood <firxen@gmail.com>
parents: 520
diff changeset
288
22
8e709824306d Add items and things.
Simon Cross <hodgestar+bzr@gmail.com>
parents: 18
diff changeset
289 def draw_background(self, surface):
526
a984cf27b527 Defer some resource loading until it's actually necessary.
Jeremy Thurgood <firxen@gmail.com>
parents: 520
diff changeset
290 self._cache_background()
130
11afefc4aeaf InteractText for mocking up scenes. Allow backgrounds to be None. Mock up map.
Simon Cross <hodgestar+bzr@gmail.com>
parents: 129
diff changeset
291 if self._background is not None:
278
8e27efd331aa Offset support for scenes
Neil Muller <neil@dip.sun.ac.za>
parents: 266
diff changeset
292 surface.blit(self._background, self.OFFSET, None)
130
11afefc4aeaf InteractText for mocking up scenes. Allow backgrounds to be None. Mock up map.
Simon Cross <hodgestar+bzr@gmail.com>
parents: 129
diff changeset
293 else:
11afefc4aeaf InteractText for mocking up scenes. Allow backgrounds to be None. Mock up map.
Simon Cross <hodgestar+bzr@gmail.com>
parents: 129
diff changeset
294 surface.fill((200, 200, 200))
18
c9b124c2f5c6 Start of scene drawing framework.
Simon Cross <hodgestar+bzr@gmail.com>
parents: 11
diff changeset
295
23
1e90a3e4618e Add code for blitting Scene.
Simon Cross <hodgestar+bzr@gmail.com>
parents: 22
diff changeset
296 def draw_things(self, surface):
1e90a3e4618e Add code for blitting Scene.
Simon Cross <hodgestar+bzr@gmail.com>
parents: 22
diff changeset
297 for thing in self.things.itervalues():
1e90a3e4618e Add code for blitting Scene.
Simon Cross <hodgestar+bzr@gmail.com>
parents: 22
diff changeset
298 thing.draw(surface)
18
c9b124c2f5c6 Start of scene drawing framework.
Simon Cross <hodgestar+bzr@gmail.com>
parents: 11
diff changeset
299
682
0749438e325e Unified Scene widgetry.
Jeremy Thurgood <firxen@gmail.com>
parents: 681
diff changeset
300 def draw(self, surface):
22
8e709824306d Add items and things.
Simon Cross <hodgestar+bzr@gmail.com>
parents: 18
diff changeset
301 self.draw_background(surface)
23
1e90a3e4618e Add code for blitting Scene.
Simon Cross <hodgestar+bzr@gmail.com>
parents: 22
diff changeset
302 self.draw_things(surface)
18
c9b124c2f5c6 Start of scene drawing framework.
Simon Cross <hodgestar+bzr@gmail.com>
parents: 11
diff changeset
303
71
99c5506de7ea Start of interact handling.
Simon Cross <hodgestar+bzr@gmail.com>
parents: 68
diff changeset
304 def interact(self, item, pos):
99c5506de7ea Start of interact handling.
Simon Cross <hodgestar+bzr@gmail.com>
parents: 68
diff changeset
305 """Interact with a particular position.
99c5506de7ea Start of interact handling.
Simon Cross <hodgestar+bzr@gmail.com>
parents: 68
diff changeset
306
99c5506de7ea Start of interact handling.
Simon Cross <hodgestar+bzr@gmail.com>
parents: 68
diff changeset
307 Item may be an item in the list of items or None for the hand.
78
6bfebfbce42e Partial message support
Neil Muller <neil@dip.sun.ac.za>
parents: 77
diff changeset
308
6bfebfbce42e Partial message support
Neil Muller <neil@dip.sun.ac.za>
parents: 77
diff changeset
309 Returns a Result object to provide feedback to the player.
71
99c5506de7ea Start of interact handling.
Simon Cross <hodgestar+bzr@gmail.com>
parents: 68
diff changeset
310 """
692
d6ded808cc33 Much scene management refactoring.
Jeremy Thurgood <firxen@gmail.com>
parents: 684
diff changeset
311 if self.current_thing is not None:
d6ded808cc33 Much scene management refactoring.
Jeremy Thurgood <firxen@gmail.com>
parents: 684
diff changeset
312 return self.current_thing.interact(item)
71
99c5506de7ea Start of interact handling.
Simon Cross <hodgestar+bzr@gmail.com>
parents: 68
diff changeset
313
105
65976205fc2d Rough Stab at basic animation support
Neil Muller <neil@dip.sun.ac.za>
parents: 101
diff changeset
314 def animate(self):
65976205fc2d Rough Stab at basic animation support
Neil Muller <neil@dip.sun.ac.za>
parents: 101
diff changeset
315 """Animate all the things in the scene.
65976205fc2d Rough Stab at basic animation support
Neil Muller <neil@dip.sun.ac.za>
parents: 101
diff changeset
316
65976205fc2d Rough Stab at basic animation support
Neil Muller <neil@dip.sun.ac.za>
parents: 101
diff changeset
317 Return true if any of them need to queue a redraw"""
65976205fc2d Rough Stab at basic animation support
Neil Muller <neil@dip.sun.ac.za>
parents: 101
diff changeset
318 result = False
65976205fc2d Rough Stab at basic animation support
Neil Muller <neil@dip.sun.ac.za>
parents: 101
diff changeset
319 for thing in self.things.itervalues():
65976205fc2d Rough Stab at basic animation support
Neil Muller <neil@dip.sun.ac.za>
parents: 101
diff changeset
320 if thing.animate():
65976205fc2d Rough Stab at basic animation support
Neil Muller <neil@dip.sun.ac.za>
parents: 101
diff changeset
321 result = True
65976205fc2d Rough Stab at basic animation support
Neil Muller <neil@dip.sun.ac.za>
parents: 101
diff changeset
322 return result
65976205fc2d Rough Stab at basic animation support
Neil Muller <neil@dip.sun.ac.za>
parents: 101
diff changeset
323
120
48d24a48d0ce Enter and leave hooks
Neil Muller <neil@dip.sun.ac.za>
parents: 119
diff changeset
324 def enter(self):
48d24a48d0ce Enter and leave hooks
Neil Muller <neil@dip.sun.ac.za>
parents: 119
diff changeset
325 return None
48d24a48d0ce Enter and leave hooks
Neil Muller <neil@dip.sun.ac.za>
parents: 119
diff changeset
326
48d24a48d0ce Enter and leave hooks
Neil Muller <neil@dip.sun.ac.za>
parents: 119
diff changeset
327 def leave(self):
48d24a48d0ce Enter and leave hooks
Neil Muller <neil@dip.sun.ac.za>
parents: 119
diff changeset
328 return None
48d24a48d0ce Enter and leave hooks
Neil Muller <neil@dip.sun.ac.za>
parents: 119
diff changeset
329
324
3476e8f3b100 Fixed mouse and cursor handling.
Jeremy Thurgood <firxen@gmail.com>
parents: 319
diff changeset
330 def update_current_thing(self, pos):
692
d6ded808cc33 Much scene management refactoring.
Jeremy Thurgood <firxen@gmail.com>
parents: 684
diff changeset
331 if self.current_thing is not None:
d6ded808cc33 Much scene management refactoring.
Jeremy Thurgood <firxen@gmail.com>
parents: 684
diff changeset
332 if not self.current_thing.contains(pos):
d6ded808cc33 Much scene management refactoring.
Jeremy Thurgood <firxen@gmail.com>
parents: 684
diff changeset
333 self.current_thing.leave()
d6ded808cc33 Much scene management refactoring.
Jeremy Thurgood <firxen@gmail.com>
parents: 684
diff changeset
334 self.current_thing = None
324
3476e8f3b100 Fixed mouse and cursor handling.
Jeremy Thurgood <firxen@gmail.com>
parents: 319
diff changeset
335 for thing in self.things.itervalues():
3476e8f3b100 Fixed mouse and cursor handling.
Jeremy Thurgood <firxen@gmail.com>
parents: 319
diff changeset
336 if thing.contains(pos):
603
3ce19d33b51f Rename state to game to not cause confusion with the other state
Neil Muller <neil@dip.sun.ac.za>
parents: 595
diff changeset
337 thing.enter(self.game.tool)
692
d6ded808cc33 Much scene management refactoring.
Jeremy Thurgood <firxen@gmail.com>
parents: 684
diff changeset
338 self.current_thing = thing
324
3476e8f3b100 Fixed mouse and cursor handling.
Jeremy Thurgood <firxen@gmail.com>
parents: 319
diff changeset
339 break
3476e8f3b100 Fixed mouse and cursor handling.
Jeremy Thurgood <firxen@gmail.com>
parents: 319
diff changeset
340
3476e8f3b100 Fixed mouse and cursor handling.
Jeremy Thurgood <firxen@gmail.com>
parents: 319
diff changeset
341 def mouse_move(self, pos):
71
99c5506de7ea Start of interact handling.
Simon Cross <hodgestar+bzr@gmail.com>
parents: 68
diff changeset
342 """Call to check whether the cursor has entered / exited a thing.
99c5506de7ea Start of interact handling.
Simon Cross <hodgestar+bzr@gmail.com>
parents: 68
diff changeset
343
99c5506de7ea Start of interact handling.
Simon Cross <hodgestar+bzr@gmail.com>
parents: 68
diff changeset
344 Item may be an item in the list of items or None for the hand.
99c5506de7ea Start of interact handling.
Simon Cross <hodgestar+bzr@gmail.com>
parents: 68
diff changeset
345 """
324
3476e8f3b100 Fixed mouse and cursor handling.
Jeremy Thurgood <firxen@gmail.com>
parents: 319
diff changeset
346 self.update_current_thing(pos)
71
99c5506de7ea Start of interact handling.
Simon Cross <hodgestar+bzr@gmail.com>
parents: 68
diff changeset
347
125
d3ca34a664fd Some detail view and data cleanup.
Jeremy Thurgood <firxen@gmail.com>
parents: 124
diff changeset
348 def get_detail_size(self):
526
a984cf27b527 Defer some resource loading until it's actually necessary.
Jeremy Thurgood <firxen@gmail.com>
parents: 520
diff changeset
349 self._cache_background()
127
9646e7c8bb97 Size detail window based on the Scene background image.
Jeremy Thurgood <firxen@gmail.com>
parents: 126
diff changeset
350 return self._background.get_size()
125
d3ca34a664fd Some detail view and data cleanup.
Jeremy Thurgood <firxen@gmail.com>
parents: 124
diff changeset
351
595
59f1ee3f5632 Remove albow.resources in a few more places.
Jeremy Thurgood <firxen@gmail.com>
parents: 592
diff changeset
352 def get_image(self, *image_name_fragments, **kw):
625
85153f422522 Differently yuck get_image().
Jeremy Thurgood <firxen@gmail.com>
parents: 612
diff changeset
353 return self.resource.get_image(*image_name_fragments, **kw)
595
59f1ee3f5632 Remove albow.resources in a few more places.
Jeremy Thurgood <firxen@gmail.com>
parents: 592
diff changeset
354
7
d7c9d8273d7f Start of base classes for game state.
Simon Cross <hodgestar+bzr@gmail.com>
parents:
diff changeset
355
488
d8087848722d Factor Thing interactive stuff out into a mixing. (Items to follow.)
Jeremy Thurgood <firxen@gmail.com>
parents: 487
diff changeset
356 class InteractiveMixin(object):
519
8f3c82c685a4 Fix is_interactive() by adding tool param.
Jeremy Thurgood <firxen@gmail.com>
parents: 518
diff changeset
357 def is_interactive(self, tool=None):
488
d8087848722d Factor Thing interactive stuff out into a mixing. (Items to follow.)
Jeremy Thurgood <firxen@gmail.com>
parents: 487
diff changeset
358 return True
d8087848722d Factor Thing interactive stuff out into a mixing. (Items to follow.)
Jeremy Thurgood <firxen@gmail.com>
parents: 487
diff changeset
359
492
c1f4f9149349 Unify Thing and Item interaction handling.
Jeremy Thurgood <firxen@gmail.com>
parents: 491
diff changeset
360 def interact(self, tool):
519
8f3c82c685a4 Fix is_interactive() by adding tool param.
Jeremy Thurgood <firxen@gmail.com>
parents: 518
diff changeset
361 if not self.is_interactive(tool):
492
c1f4f9149349 Unify Thing and Item interaction handling.
Jeremy Thurgood <firxen@gmail.com>
parents: 491
diff changeset
362 return None
c1f4f9149349 Unify Thing and Item interaction handling.
Jeremy Thurgood <firxen@gmail.com>
parents: 491
diff changeset
363 if tool is None:
488
d8087848722d Factor Thing interactive stuff out into a mixing. (Items to follow.)
Jeremy Thurgood <firxen@gmail.com>
parents: 487
diff changeset
364 return self.interact_without()
492
c1f4f9149349 Unify Thing and Item interaction handling.
Jeremy Thurgood <firxen@gmail.com>
parents: 491
diff changeset
365 handler = getattr(self, 'interact_with_' + tool.tool_name, None)
c1f4f9149349 Unify Thing and Item interaction handling.
Jeremy Thurgood <firxen@gmail.com>
parents: 491
diff changeset
366 inverse_handler = self.get_inverse_interact(tool)
c1f4f9149349 Unify Thing and Item interaction handling.
Jeremy Thurgood <firxen@gmail.com>
parents: 491
diff changeset
367 if handler is not None:
c1f4f9149349 Unify Thing and Item interaction handling.
Jeremy Thurgood <firxen@gmail.com>
parents: 491
diff changeset
368 return handler(tool)
c1f4f9149349 Unify Thing and Item interaction handling.
Jeremy Thurgood <firxen@gmail.com>
parents: 491
diff changeset
369 elif inverse_handler is not None:
c1f4f9149349 Unify Thing and Item interaction handling.
Jeremy Thurgood <firxen@gmail.com>
parents: 491
diff changeset
370 return inverse_handler(self)
488
d8087848722d Factor Thing interactive stuff out into a mixing. (Items to follow.)
Jeremy Thurgood <firxen@gmail.com>
parents: 487
diff changeset
371 else:
492
c1f4f9149349 Unify Thing and Item interaction handling.
Jeremy Thurgood <firxen@gmail.com>
parents: 491
diff changeset
372 return self.interact_default(tool)
c1f4f9149349 Unify Thing and Item interaction handling.
Jeremy Thurgood <firxen@gmail.com>
parents: 491
diff changeset
373
c1f4f9149349 Unify Thing and Item interaction handling.
Jeremy Thurgood <firxen@gmail.com>
parents: 491
diff changeset
374 def get_inverse_interact(self, tool):
c1f4f9149349 Unify Thing and Item interaction handling.
Jeremy Thurgood <firxen@gmail.com>
parents: 491
diff changeset
375 return None
488
d8087848722d Factor Thing interactive stuff out into a mixing. (Items to follow.)
Jeremy Thurgood <firxen@gmail.com>
parents: 487
diff changeset
376
d8087848722d Factor Thing interactive stuff out into a mixing. (Items to follow.)
Jeremy Thurgood <firxen@gmail.com>
parents: 487
diff changeset
377 def interact_without(self):
d8087848722d Factor Thing interactive stuff out into a mixing. (Items to follow.)
Jeremy Thurgood <firxen@gmail.com>
parents: 487
diff changeset
378 return self.interact_default(None)
d8087848722d Factor Thing interactive stuff out into a mixing. (Items to follow.)
Jeremy Thurgood <firxen@gmail.com>
parents: 487
diff changeset
379
d8087848722d Factor Thing interactive stuff out into a mixing. (Items to follow.)
Jeremy Thurgood <firxen@gmail.com>
parents: 487
diff changeset
380 def interact_default(self, item=None):
d8087848722d Factor Thing interactive stuff out into a mixing. (Items to follow.)
Jeremy Thurgood <firxen@gmail.com>
parents: 487
diff changeset
381 return None
d8087848722d Factor Thing interactive stuff out into a mixing. (Items to follow.)
Jeremy Thurgood <firxen@gmail.com>
parents: 487
diff changeset
382
d8087848722d Factor Thing interactive stuff out into a mixing. (Items to follow.)
Jeremy Thurgood <firxen@gmail.com>
parents: 487
diff changeset
383
d8087848722d Factor Thing interactive stuff out into a mixing. (Items to follow.)
Jeremy Thurgood <firxen@gmail.com>
parents: 487
diff changeset
384 class Thing(StatefulGizmo, InteractiveMixin):
22
8e709824306d Add items and things.
Simon Cross <hodgestar+bzr@gmail.com>
parents: 18
diff changeset
385 """Base class for things in a scene that you can interact with."""
7
d7c9d8273d7f Start of base classes for game state.
Simon Cross <hodgestar+bzr@gmail.com>
parents:
diff changeset
386
86
593bddfacf18 Refactor Things a bit to render images.
Simon Cross <hodgestar+bzr@gmail.com>
parents: 79
diff changeset
387 # name of thing
593bddfacf18 Refactor Things a bit to render images.
Simon Cross <hodgestar+bzr@gmail.com>
parents: 79
diff changeset
388 NAME = None
593bddfacf18 Refactor Things a bit to render images.
Simon Cross <hodgestar+bzr@gmail.com>
parents: 79
diff changeset
389
593bddfacf18 Refactor Things a bit to render images.
Simon Cross <hodgestar+bzr@gmail.com>
parents: 79
diff changeset
390 # sub-folder to look for resources in (defaults to scenes folder)
41
ad6f56bfa8b7 Cryo door, titanium leg and some interaction prototypes.
Jeremy Thurgood <firxen@gmail.com>
parents: 39
diff changeset
391 FOLDER = None
ad6f56bfa8b7 Cryo door, titanium leg and some interaction prototypes.
Jeremy Thurgood <firxen@gmail.com>
parents: 39
diff changeset
392
86
593bddfacf18 Refactor Things a bit to render images.
Simon Cross <hodgestar+bzr@gmail.com>
parents: 79
diff changeset
393 # list of Interact objects
593bddfacf18 Refactor Things a bit to render images.
Simon Cross <hodgestar+bzr@gmail.com>
parents: 79
diff changeset
394 INTERACTS = {}
593bddfacf18 Refactor Things a bit to render images.
Simon Cross <hodgestar+bzr@gmail.com>
parents: 79
diff changeset
395
593bddfacf18 Refactor Things a bit to render images.
Simon Cross <hodgestar+bzr@gmail.com>
parents: 79
diff changeset
396 # name first interact
593bddfacf18 Refactor Things a bit to render images.
Simon Cross <hodgestar+bzr@gmail.com>
parents: 79
diff changeset
397 INITIAL = None
41
ad6f56bfa8b7 Cryo door, titanium leg and some interaction prototypes.
Jeremy Thurgood <firxen@gmail.com>
parents: 39
diff changeset
398
68
158a13a48d48 Show interact rectangles when constants.DEBUG is True.
Simon Cross <hodgestar+bzr@gmail.com>
parents: 65
diff changeset
399 # Interact rectangle hi-light color (for debugging)
158a13a48d48 Show interact rectangles when constants.DEBUG is True.
Simon Cross <hodgestar+bzr@gmail.com>
parents: 65
diff changeset
400 # (set to None to turn off)
282
fe899fb63866 Add option for turning off debugging rects while debugging.
Simon Cross <hodgestar+bzr@gmail.com>
parents: 280
diff changeset
401 _interact_hilight_color = Color('red')
68
158a13a48d48 Show interact rectangles when constants.DEBUG is True.
Simon Cross <hodgestar+bzr@gmail.com>
parents: 65
diff changeset
402
86
593bddfacf18 Refactor Things a bit to render images.
Simon Cross <hodgestar+bzr@gmail.com>
parents: 79
diff changeset
403 def __init__(self):
55
2e2f6ff54780 Part of the cryo door puzzle.
Jeremy Thurgood <firxen@gmail.com>
parents: 47
diff changeset
404 StatefulGizmo.__init__(self)
86
593bddfacf18 Refactor Things a bit to render images.
Simon Cross <hodgestar+bzr@gmail.com>
parents: 79
diff changeset
405 # name of the thing
593bddfacf18 Refactor Things a bit to render images.
Simon Cross <hodgestar+bzr@gmail.com>
parents: 79
diff changeset
406 self.name = self.NAME
593bddfacf18 Refactor Things a bit to render images.
Simon Cross <hodgestar+bzr@gmail.com>
parents: 79
diff changeset
407 # folder for resource (None is overridden by scene folder)
593bddfacf18 Refactor Things a bit to render images.
Simon Cross <hodgestar+bzr@gmail.com>
parents: 79
diff changeset
408 self.folder = self.FOLDER
603
3ce19d33b51f Rename state to game to not cause confusion with the other state
Neil Muller <neil@dip.sun.ac.za>
parents: 595
diff changeset
409 self.state_key = self.NAME
86
593bddfacf18 Refactor Things a bit to render images.
Simon Cross <hodgestar+bzr@gmail.com>
parents: 79
diff changeset
410 # interacts
593bddfacf18 Refactor Things a bit to render images.
Simon Cross <hodgestar+bzr@gmail.com>
parents: 79
diff changeset
411 self.interacts = self.INTERACTS
39
088a101f5b94 Add an example Thing to cryo scene.
Simon Cross <hodgestar+bzr@gmail.com>
parents: 35
diff changeset
412 # these are set by set_scene
088a101f5b94 Add an example Thing to cryo scene.
Simon Cross <hodgestar+bzr@gmail.com>
parents: 35
diff changeset
413 self.scene = None
86
593bddfacf18 Refactor Things a bit to render images.
Simon Cross <hodgestar+bzr@gmail.com>
parents: 79
diff changeset
414 self.current_interact = None
593bddfacf18 Refactor Things a bit to render images.
Simon Cross <hodgestar+bzr@gmail.com>
parents: 79
diff changeset
415 self.rect = None
280
d9b19449436f The flying fish fix (take 1)
Neil Muller <neil@dip.sun.ac.za>
parents: 278
diff changeset
416 self.orig_rect = None
7
d7c9d8273d7f Start of base classes for game state.
Simon Cross <hodgestar+bzr@gmail.com>
parents:
diff changeset
417
278
8e27efd331aa Offset support for scenes
Neil Muller <neil@dip.sun.ac.za>
parents: 266
diff changeset
418 def _fix_rect(self):
8e27efd331aa Offset support for scenes
Neil Muller <neil@dip.sun.ac.za>
parents: 266
diff changeset
419 """Fix rects to compensate for scene offset"""
280
d9b19449436f The flying fish fix (take 1)
Neil Muller <neil@dip.sun.ac.za>
parents: 278
diff changeset
420 # Offset logic is to always work with copies, to avoid
d9b19449436f The flying fish fix (take 1)
Neil Muller <neil@dip.sun.ac.za>
parents: 278
diff changeset
421 # flying effects from multiple calls to _fix_rect
d9b19449436f The flying fish fix (take 1)
Neil Muller <neil@dip.sun.ac.za>
parents: 278
diff changeset
422 # See footwork in draw
278
8e27efd331aa Offset support for scenes
Neil Muller <neil@dip.sun.ac.za>
parents: 266
diff changeset
423 if hasattr(self.rect, 'collidepoint'):
280
d9b19449436f The flying fish fix (take 1)
Neil Muller <neil@dip.sun.ac.za>
parents: 278
diff changeset
424 self.rect = self.rect.move(self.scene.OFFSET)
278
8e27efd331aa Offset support for scenes
Neil Muller <neil@dip.sun.ac.za>
parents: 266
diff changeset
425 else:
280
d9b19449436f The flying fish fix (take 1)
Neil Muller <neil@dip.sun.ac.za>
parents: 278
diff changeset
426 self.rect = [x.move(self.scene.OFFSET) for x in self.rect]
278
8e27efd331aa Offset support for scenes
Neil Muller <neil@dip.sun.ac.za>
parents: 266
diff changeset
427
39
088a101f5b94 Add an example Thing to cryo scene.
Simon Cross <hodgestar+bzr@gmail.com>
parents: 35
diff changeset
428 def set_scene(self, scene):
088a101f5b94 Add an example Thing to cryo scene.
Simon Cross <hodgestar+bzr@gmail.com>
parents: 35
diff changeset
429 assert self.scene is None
088a101f5b94 Add an example Thing to cryo scene.
Simon Cross <hodgestar+bzr@gmail.com>
parents: 35
diff changeset
430 self.scene = scene
86
593bddfacf18 Refactor Things a bit to render images.
Simon Cross <hodgestar+bzr@gmail.com>
parents: 79
diff changeset
431 if self.folder is None:
593bddfacf18 Refactor Things a bit to render images.
Simon Cross <hodgestar+bzr@gmail.com>
parents: 79
diff changeset
432 self.folder = scene.FOLDER
603
3ce19d33b51f Rename state to game to not cause confusion with the other state
Neil Muller <neil@dip.sun.ac.za>
parents: 595
diff changeset
433 self.game = scene.game
3ce19d33b51f Rename state to game to not cause confusion with the other state
Neil Muller <neil@dip.sun.ac.za>
parents: 595
diff changeset
434 self.set_state(self.game.data)
86
593bddfacf18 Refactor Things a bit to render images.
Simon Cross <hodgestar+bzr@gmail.com>
parents: 79
diff changeset
435 for interact in self.interacts.itervalues():
593bddfacf18 Refactor Things a bit to render images.
Simon Cross <hodgestar+bzr@gmail.com>
parents: 79
diff changeset
436 interact.set_thing(self)
593bddfacf18 Refactor Things a bit to render images.
Simon Cross <hodgestar+bzr@gmail.com>
parents: 79
diff changeset
437 self.set_interact(self.INITIAL)
593bddfacf18 Refactor Things a bit to render images.
Simon Cross <hodgestar+bzr@gmail.com>
parents: 79
diff changeset
438
593bddfacf18 Refactor Things a bit to render images.
Simon Cross <hodgestar+bzr@gmail.com>
parents: 79
diff changeset
439 def set_interact(self, name):
593bddfacf18 Refactor Things a bit to render images.
Simon Cross <hodgestar+bzr@gmail.com>
parents: 79
diff changeset
440 self.current_interact = self.interacts[name]
593bddfacf18 Refactor Things a bit to render images.
Simon Cross <hodgestar+bzr@gmail.com>
parents: 79
diff changeset
441 self.rect = self.current_interact.interact_rect
278
8e27efd331aa Offset support for scenes
Neil Muller <neil@dip.sun.ac.za>
parents: 266
diff changeset
442 if self.scene:
8e27efd331aa Offset support for scenes
Neil Muller <neil@dip.sun.ac.za>
parents: 266
diff changeset
443 self._fix_rect()
86
593bddfacf18 Refactor Things a bit to render images.
Simon Cross <hodgestar+bzr@gmail.com>
parents: 79
diff changeset
444 assert self.rect is not None, name
39
088a101f5b94 Add an example Thing to cryo scene.
Simon Cross <hodgestar+bzr@gmail.com>
parents: 35
diff changeset
445
94
ce23fad8ecb3 More complex shaped interactables
Neil Muller <neil@dip.sun.ac.za>
parents: 93
diff changeset
446 def contains(self, pos):
ce23fad8ecb3 More complex shaped interactables
Neil Muller <neil@dip.sun.ac.za>
parents: 93
diff changeset
447 if hasattr(self.rect, 'collidepoint'):
ce23fad8ecb3 More complex shaped interactables
Neil Muller <neil@dip.sun.ac.za>
parents: 93
diff changeset
448 return self.rect.collidepoint(pos)
ce23fad8ecb3 More complex shaped interactables
Neil Muller <neil@dip.sun.ac.za>
parents: 93
diff changeset
449 else:
ce23fad8ecb3 More complex shaped interactables
Neil Muller <neil@dip.sun.ac.za>
parents: 93
diff changeset
450 # FIXME: add sanity check
ce23fad8ecb3 More complex shaped interactables
Neil Muller <neil@dip.sun.ac.za>
parents: 93
diff changeset
451 for rect in list(self.rect):
ce23fad8ecb3 More complex shaped interactables
Neil Muller <neil@dip.sun.ac.za>
parents: 93
diff changeset
452 if rect.collidepoint(pos):
ce23fad8ecb3 More complex shaped interactables
Neil Muller <neil@dip.sun.ac.za>
parents: 93
diff changeset
453 return True
ce23fad8ecb3 More complex shaped interactables
Neil Muller <neil@dip.sun.ac.za>
parents: 93
diff changeset
454 return False
ce23fad8ecb3 More complex shaped interactables
Neil Muller <neil@dip.sun.ac.za>
parents: 93
diff changeset
455
63
3087be3463e0 Some framework support for better message handling
Neil Muller <neil@dip.sun.ac.za>
parents: 56
diff changeset
456 def get_description(self):
3087be3463e0 Some framework support for better message handling
Neil Muller <neil@dip.sun.ac.za>
parents: 56
diff changeset
457 return None
3087be3463e0 Some framework support for better message handling
Neil Muller <neil@dip.sun.ac.za>
parents: 56
diff changeset
458
71
99c5506de7ea Start of interact handling.
Simon Cross <hodgestar+bzr@gmail.com>
parents: 68
diff changeset
459 def enter(self, item):
99c5506de7ea Start of interact handling.
Simon Cross <hodgestar+bzr@gmail.com>
parents: 68
diff changeset
460 """Called when the cursor enters the Thing."""
139
a5972444ad1e Improve cursor state handling, disable highlights on modal dialogs
Stefano Rivera <stefano@rivera.za.net>
parents: 137
diff changeset
461 pass
71
99c5506de7ea Start of interact handling.
Simon Cross <hodgestar+bzr@gmail.com>
parents: 68
diff changeset
462
99c5506de7ea Start of interact handling.
Simon Cross <hodgestar+bzr@gmail.com>
parents: 68
diff changeset
463 def leave(self):
99c5506de7ea Start of interact handling.
Simon Cross <hodgestar+bzr@gmail.com>
parents: 68
diff changeset
464 """Called when the cursr leaves the Thing."""
139
a5972444ad1e Improve cursor state handling, disable highlights on modal dialogs
Stefano Rivera <stefano@rivera.za.net>
parents: 137
diff changeset
465 pass
71
99c5506de7ea Start of interact handling.
Simon Cross <hodgestar+bzr@gmail.com>
parents: 68
diff changeset
466
105
65976205fc2d Rough Stab at basic animation support
Neil Muller <neil@dip.sun.ac.za>
parents: 101
diff changeset
467 def animate(self):
65976205fc2d Rough Stab at basic animation support
Neil Muller <neil@dip.sun.ac.za>
parents: 101
diff changeset
468 return self.current_interact.animate()
65976205fc2d Rough Stab at basic animation support
Neil Muller <neil@dip.sun.ac.za>
parents: 101
diff changeset
469
23
1e90a3e4618e Add code for blitting Scene.
Simon Cross <hodgestar+bzr@gmail.com>
parents: 22
diff changeset
470 def draw(self, surface):
280
d9b19449436f The flying fish fix (take 1)
Neil Muller <neil@dip.sun.ac.za>
parents: 278
diff changeset
471 old_rect = self.current_interact.rect
d9b19449436f The flying fish fix (take 1)
Neil Muller <neil@dip.sun.ac.za>
parents: 278
diff changeset
472 if old_rect:
d9b19449436f The flying fish fix (take 1)
Neil Muller <neil@dip.sun.ac.za>
parents: 278
diff changeset
473 self.current_interact.rect = old_rect.move(self.scene.OFFSET)
86
593bddfacf18 Refactor Things a bit to render images.
Simon Cross <hodgestar+bzr@gmail.com>
parents: 79
diff changeset
474 self.current_interact.draw(surface)
280
d9b19449436f The flying fish fix (take 1)
Neil Muller <neil@dip.sun.ac.za>
parents: 278
diff changeset
475 self.current_interact.rect = old_rect
603
3ce19d33b51f Rename state to game to not cause confusion with the other state
Neil Muller <neil@dip.sun.ac.za>
parents: 595
diff changeset
476 if self.game.debug_rects and self._interact_hilight_color:
94
ce23fad8ecb3 More complex shaped interactables
Neil Muller <neil@dip.sun.ac.za>
parents: 93
diff changeset
477 if hasattr(self.rect, 'collidepoint'):
ce23fad8ecb3 More complex shaped interactables
Neil Muller <neil@dip.sun.ac.za>
parents: 93
diff changeset
478 frame_rect(surface, self._interact_hilight_color,
ce23fad8ecb3 More complex shaped interactables
Neil Muller <neil@dip.sun.ac.za>
parents: 93
diff changeset
479 self.rect.inflate(1, 1), 1)
ce23fad8ecb3 More complex shaped interactables
Neil Muller <neil@dip.sun.ac.za>
parents: 93
diff changeset
480 else:
ce23fad8ecb3 More complex shaped interactables
Neil Muller <neil@dip.sun.ac.za>
parents: 93
diff changeset
481 for rect in self.rect:
ce23fad8ecb3 More complex shaped interactables
Neil Muller <neil@dip.sun.ac.za>
parents: 93
diff changeset
482 frame_rect(surface, self._interact_hilight_color,
ce23fad8ecb3 More complex shaped interactables
Neil Muller <neil@dip.sun.ac.za>
parents: 93
diff changeset
483 rect.inflate(1, 1), 1)
23
1e90a3e4618e Add code for blitting Scene.
Simon Cross <hodgestar+bzr@gmail.com>
parents: 22
diff changeset
484
22
8e709824306d Add items and things.
Simon Cross <hodgestar+bzr@gmail.com>
parents: 18
diff changeset
485
592
4e9178215e75 Introduce .setup() for GameDeveloperGizmos.
Simon Cross <hodgestar+bzr@gmail.com>
parents: 588
diff changeset
486 class Item(GameDeveloperGizmo, InteractiveMixin):
22
8e709824306d Add items and things.
Simon Cross <hodgestar+bzr@gmail.com>
parents: 18
diff changeset
487 """Base class for inventory items."""
8e709824306d Add items and things.
Simon Cross <hodgestar+bzr@gmail.com>
parents: 18
diff changeset
488
35
ebc76bc0c067 First item!
Simon Cross <hodgestar+bzr@gmail.com>
parents: 34
diff changeset
489 # image for inventory
ebc76bc0c067 First item!
Simon Cross <hodgestar+bzr@gmail.com>
parents: 34
diff changeset
490 INVENTORY_IMAGE = None
32
18cb1af411ef Add helper for adding items. Give items names. Make things take a rectangle.
Simon Cross <hodgestar+bzr@gmail.com>
parents: 30
diff changeset
491
490
2e784f978d1a Add state to Items.
Jeremy Thurgood <firxen@gmail.com>
parents: 489
diff changeset
492 # name of item
2e784f978d1a Add state to Items.
Jeremy Thurgood <firxen@gmail.com>
parents: 489
diff changeset
493 NAME = None
2e784f978d1a Add state to Items.
Jeremy Thurgood <firxen@gmail.com>
parents: 489
diff changeset
494
336
72e4d0c5dfe9 Clean-up two old TODOs.
Simon Cross <hodgestar+bzr@gmail.com>
parents: 331
diff changeset
495 # name for interactions (i.e. def interact_with_<TOOL_NAME>)
226
a5325919342e Tubes, pipes and ducts.
Jeremy Thurgood <firxen@gmail.com>
parents: 210
diff changeset
496 TOOL_NAME = None
a5325919342e Tubes, pipes and ducts.
Jeremy Thurgood <firxen@gmail.com>
parents: 210
diff changeset
497
336
72e4d0c5dfe9 Clean-up two old TODOs.
Simon Cross <hodgestar+bzr@gmail.com>
parents: 331
diff changeset
498 # set to instance of CursorSprite
72e4d0c5dfe9 Clean-up two old TODOs.
Simon Cross <hodgestar+bzr@gmail.com>
parents: 331
diff changeset
499 CURSOR = None
72e4d0c5dfe9 Clean-up two old TODOs.
Simon Cross <hodgestar+bzr@gmail.com>
parents: 331
diff changeset
500
487
efb34a6cd2a1 Make name param to an Item optional and use NAME if present.
Jeremy Thurgood <firxen@gmail.com>
parents: 484
diff changeset
501 def __init__(self, name=None):
592
4e9178215e75 Introduce .setup() for GameDeveloperGizmos.
Simon Cross <hodgestar+bzr@gmail.com>
parents: 588
diff changeset
502 GameDeveloperGizmo.__init__(self)
487
efb34a6cd2a1 Make name param to an Item optional and use NAME if present.
Jeremy Thurgood <firxen@gmail.com>
parents: 484
diff changeset
503 self.name = self.NAME
efb34a6cd2a1 Make name param to an Item optional and use NAME if present.
Jeremy Thurgood <firxen@gmail.com>
parents: 484
diff changeset
504 if name is not None:
efb34a6cd2a1 Make name param to an Item optional and use NAME if present.
Jeremy Thurgood <firxen@gmail.com>
parents: 484
diff changeset
505 self.name = name
193
738608e90e9c CloneableItem tweaks and a usable laser welder. zOMG!
Jeremy Thurgood <firxen@gmail.com>
parents: 191
diff changeset
506 self.tool_name = name
226
a5325919342e Tubes, pipes and ducts.
Jeremy Thurgood <firxen@gmail.com>
parents: 210
diff changeset
507 if self.TOOL_NAME is not None:
a5325919342e Tubes, pipes and ducts.
Jeremy Thurgood <firxen@gmail.com>
parents: 210
diff changeset
508 self.tool_name = self.TOOL_NAME
526
a984cf27b527 Defer some resource loading until it's actually necessary.
Jeremy Thurgood <firxen@gmail.com>
parents: 520
diff changeset
509 self.inventory_image = None
a984cf27b527 Defer some resource loading until it's actually necessary.
Jeremy Thurgood <firxen@gmail.com>
parents: 520
diff changeset
510
a984cf27b527 Defer some resource loading until it's actually necessary.
Jeremy Thurgood <firxen@gmail.com>
parents: 520
diff changeset
511 def _cache_inventory_image(self):
a984cf27b527 Defer some resource loading until it's actually necessary.
Jeremy Thurgood <firxen@gmail.com>
parents: 520
diff changeset
512 if not self.inventory_image:
592
4e9178215e75 Introduce .setup() for GameDeveloperGizmos.
Simon Cross <hodgestar+bzr@gmail.com>
parents: 588
diff changeset
513 self.inventory_image = self.resource.get_image(
625
85153f422522 Differently yuck get_image().
Jeremy Thurgood <firxen@gmail.com>
parents: 612
diff changeset
514 'items', self.INVENTORY_IMAGE)
22
8e709824306d Add items and things.
Simon Cross <hodgestar+bzr@gmail.com>
parents: 18
diff changeset
515
34
e5c043aeed65 Inventory and items. And stuff.
Jeremy Thurgood <firxen@gmail.com>
parents: 33
diff changeset
516 def get_inventory_image(self):
526
a984cf27b527 Defer some resource loading until it's actually necessary.
Jeremy Thurgood <firxen@gmail.com>
parents: 520
diff changeset
517 self._cache_inventory_image()
34
e5c043aeed65 Inventory and items. And stuff.
Jeremy Thurgood <firxen@gmail.com>
parents: 33
diff changeset
518 return self.inventory_image
e5c043aeed65 Inventory and items. And stuff.
Jeremy Thurgood <firxen@gmail.com>
parents: 33
diff changeset
519
492
c1f4f9149349 Unify Thing and Item interaction handling.
Jeremy Thurgood <firxen@gmail.com>
parents: 491
diff changeset
520 def get_inverse_interact(self, tool):
c1f4f9149349 Unify Thing and Item interaction handling.
Jeremy Thurgood <firxen@gmail.com>
parents: 491
diff changeset
521 return getattr(tool, 'interact_with_' + self.tool_name, None)
166
0db92b3b5833 Add inventory interactions
Neil Muller <neil@dip.sun.ac.za>
parents: 161
diff changeset
522
519
8f3c82c685a4 Fix is_interactive() by adding tool param.
Jeremy Thurgood <firxen@gmail.com>
parents: 518
diff changeset
523 def is_interactive(self, tool=None):
8f3c82c685a4 Fix is_interactive() by adding tool param.
Jeremy Thurgood <firxen@gmail.com>
parents: 518
diff changeset
524 if tool:
8f3c82c685a4 Fix is_interactive() by adding tool param.
Jeremy Thurgood <firxen@gmail.com>
parents: 518
diff changeset
525 return True
512
b10dae40dc32 Fix items.
Jeremy Thurgood <firxen@gmail.com>
parents: 511
diff changeset
526 return False
b10dae40dc32 Fix items.
Jeremy Thurgood <firxen@gmail.com>
parents: 511
diff changeset
527
191
278774b31d3c CloneableItems.
Jeremy Thurgood <firxen@gmail.com>
parents: 187
diff changeset
528
278774b31d3c CloneableItems.
Jeremy Thurgood <firxen@gmail.com>
parents: 187
diff changeset
529 class CloneableItem(Item):
278774b31d3c CloneableItems.
Jeremy Thurgood <firxen@gmail.com>
parents: 187
diff changeset
530 _counter = 0
278774b31d3c CloneableItems.
Jeremy Thurgood <firxen@gmail.com>
parents: 187
diff changeset
531
252
dfc89bc64fdb Start of walkthrough "unit test" and associated fixes and tweaks.
Jeremy Thurgood <firxen@gmail.com>
parents: 241
diff changeset
532 @classmethod
dfc89bc64fdb Start of walkthrough "unit test" and associated fixes and tweaks.
Jeremy Thurgood <firxen@gmail.com>
parents: 241
diff changeset
533 def _get_new_id(cls):
dfc89bc64fdb Start of walkthrough "unit test" and associated fixes and tweaks.
Jeremy Thurgood <firxen@gmail.com>
parents: 241
diff changeset
534 cls._counter += 1
dfc89bc64fdb Start of walkthrough "unit test" and associated fixes and tweaks.
Jeremy Thurgood <firxen@gmail.com>
parents: 241
diff changeset
535 return cls._counter - 1
dfc89bc64fdb Start of walkthrough "unit test" and associated fixes and tweaks.
Jeremy Thurgood <firxen@gmail.com>
parents: 241
diff changeset
536
487
efb34a6cd2a1 Make name param to an Item optional and use NAME if present.
Jeremy Thurgood <firxen@gmail.com>
parents: 484
diff changeset
537 def __init__(self, name=None):
490
2e784f978d1a Add state to Items.
Jeremy Thurgood <firxen@gmail.com>
parents: 489
diff changeset
538 super(CloneableItem, self).__init__(name)
252
dfc89bc64fdb Start of walkthrough "unit test" and associated fixes and tweaks.
Jeremy Thurgood <firxen@gmail.com>
parents: 241
diff changeset
539 my_count = self._get_new_id()
490
2e784f978d1a Add state to Items.
Jeremy Thurgood <firxen@gmail.com>
parents: 489
diff changeset
540 self.name = "%s.%s" % (self.name, my_count)