forked from iminurnamez/pyroller
-
Notifications
You must be signed in to change notification settings - Fork 1
/
tools.py
379 lines (336 loc) · 13.5 KB
/
tools.py
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
"""
This module contains the fundamental Control class and a prototype class
for States. Also contained here are resource loading functions.
"""
import os
import copy
import argparse
import pygame as pg
class Control(object):
"""
Control class for entire project. Contains the game loop, and contains
the event_loop which passes events to States as needed. Logic for flipping
states is also found here.
"""
def __init__(self, caption, render_size, resolutions):
self.screen = pg.display.get_surface()
self.screen_rect = self.screen.get_rect()
self.render_size = render_size
self.render_surf = pg.Surface(self.render_size).convert()
self.resolutions = resolutions
self.set_scale()
self.caption = caption
self.done = False
self.clock = pg.time.Clock()
self.fps = 60.0
self.show_fps = False
self.now = 0.0
self.keys = pg.key.get_pressed()
self.state_dict = {}
self.state_name = None
self.state = None
self.music_handler = None
def setup_states(self, state_dict, start_state):
"""
Given a dictionary of States and a State to start in,
builds the self.state_dict.
"""
self.state_dict = state_dict
self.state_name = start_state
self.state = self.state_dict[self.state_name]
def update(self, dt):
"""
Checks if a state is done or has called for a game quit.
State is flipped if neccessary and State.update is called.
"""
self.screen = pg.display.get_surface()
self.now = pg.time.get_ticks()
if self.state.quit:
self.done = True
elif self.state.done:
self.flip_state()
self.state.update(self.render_surf,self.keys,self.now,dt,self.scale)
if self.music_handler and self.state.use_music_handler:
self.music_handler.update(self.scale)
self.music_handler.draw(self.render_surf)
if self.render_size != self.screen_rect.size:
scale_args = (self.render_surf, self.screen_rect.size)
scaled_surf = pg.transform.smoothscale(*scale_args)
self.screen.blit(scaled_surf, (0, 0))
else:
self.screen.blit(self.render_surf, (0, 0))
def flip_state(self):
"""
When a State changes to done necessary startup and cleanup functions
are called and the current State is changed.
"""
previous,self.state_name = self.state_name, self.state.next
persist = self.state.cleanup()
self.state = self.state_dict[self.state_name]
self.state.startup(self.now, persist)
self.state.previous = previous
def event_loop(self):
"""
Process all events and pass them down to current State.
The f5 key globally turns on/off the display of FPS in the caption
"""
for event in pg.event.get():
if event.type == pg.KEYDOWN:
self.keys = pg.key.get_pressed()
self.toggle_show_fps(event.key)
if event.key == pg.K_PRINT:
#Print screen for full render-sized screencaps.
pg.image.save(self.render_surf, "screenshot.png")
elif event.type == pg.KEYUP:
self.keys = pg.key.get_pressed()
elif event.type == pg.VIDEORESIZE:
self.on_resize(event.size)
pg.event.clear(pg.VIDEORESIZE)
self.state.get_event(event, self.scale)
if self.music_handler and self.state.use_music_handler:
self.music_handler.get_event(event, self.scale)
def on_resize(self, size):
"""
If the user resized the window, change to the next available
resolution depending on if scaled up or scaled down.
"""
res_index = self.resolutions.index(self.screen_rect.size)
adjust = 1 if size > self.screen_rect.size else -1
if 0 <= res_index+adjust < len(self.resolutions):
new_size = self.resolutions[res_index+adjust]
else:
new_size = self.screen_rect.size
self.screen = pg.display.set_mode(new_size, pg.RESIZABLE)
self.screen_rect.size = new_size
self.set_scale()
def set_scale(self):
"""
Reset the ratio of render size to window size.
Used to make sure that mouse clicks are accurate on all resolutions.
"""
w_ratio = self.render_size[0]/float(self.screen_rect.w)
h_ratio = self.render_size[1]/float(self.screen_rect.h)
self.scale = (w_ratio, h_ratio)
def toggle_show_fps(self, key):
"""Press f5 to turn on/off displaying the framerate in the caption."""
if key == pg.K_F5:
self.show_fps = not self.show_fps
if not self.show_fps:
pg.display.set_caption(self.caption)
def main(self):
"""Main loop for entire program."""
while not self.done:
time_delta = self.clock.tick(self.fps)
self.event_loop()
self.update(time_delta)
pg.display.update()
if self.show_fps:
fps = self.clock.get_fps()
with_fps = "{} - {:.2f} FPS".format(self.caption, fps)
pg.display.set_caption(with_fps)
class _State(object):
"""
This is a prototype class for States. All states should inherit from it.
No direct instances of this class should be created. get_event and update
must be overloaded in the childclass. startup and cleanup need to be
overloaded when there is data that must persist between States.
"""
def __init__(self, persistant={}):
self.start_time = 0.0
self.now = 0.0
self.done = False
self.quit = False
self.next = None
self.previous = None
self.persist = persistant
self.use_music_handler = True
def get_event(self, event, scale=(1,1)):
"""
Processes events that were passed from the main event loop.
Must be overloaded in children.
"""
pass
def startup(self, now, persistent):
"""
Add variables passed in persistent to the proper attributes and
set the start time of the State to the current time.
"""
self.persist = persistent
self.start_time = now
def cleanup(self):
"""
Add variables that should persist to the self.persist dictionary.
Then reset State.done to False.
"""
self.done = False
return self.persist
def update(self, surface, keys, now, dt, scale):
"""Update function for state. Must be overloaded in children."""
pass
def render_font(self, font, msg, color, center):
"""Return the rendered font surface and its rect centered on center."""
msg = font.render(msg, 1, color)
rect = msg.get_rect(center=center)
return msg, rect
class _KwargMixin(object):
"""
Useful for classes that require a lot of keyword arguments for
customization.
"""
def process_kwargs(self, name, defaults, kwargs):
"""
Arguments are a name string (displayed in case of invalid keyword);
a dictionary of default values for all valid keywords;
and the kwarg dict.
"""
settings = copy.deepcopy(defaults)
for kwarg in kwargs:
if kwarg in settings:
if isinstance(kwargs[kwarg], dict):
settings[kwarg].update(kwargs[kwarg])
else:
settings[kwarg] = kwargs[kwarg]
else:
message = "{} has no keyword: {}"
raise AttributeError(message.format(name, kwarg))
for setting in settings:
setattr(self, setting, settings[setting])
### Mouse position functions
def scaled_mouse_pos(scale, pos=None):
"""
Return the mouse position adjusted for screen size if no pos argument is
passed and returns pos adjusted for screen size if pos is passed.
"""
x,y = pg.mouse.get_pos() if pos is None else pos
return (int(x*scale[0]), int(y*scale[1]))
### Resource loading functions.
def load_all_gfx(directory,colorkey=(0,0,0),accept=(".png",".jpg",".bmp")):
"""
Load all graphics with extensions in the accept argument. If alpha
transparency is found in the image the image will be converted using
convert_alpha(). If no alpha transparency is detected image will be
converted using convert() and colorkey will be set to colorkey.
"""
graphics = {}
for pic in os.listdir(directory):
name,ext = os.path.splitext(pic)
if ext.lower() in accept:
img = pg.image.load(os.path.join(directory, pic))
if img.get_alpha():
img = img.convert_alpha()
else:
img = img.convert()
img.set_colorkey(colorkey)
graphics[name]=img
return graphics
def load_all_music(directory, accept=(".wav", ".mp3", ".ogg", ".mdi")):
"""
Create a dictionary of paths to music files in given directory
if their extensions are in accept.
"""
songs = {}
for song in os.listdir(directory):
name,ext = os.path.splitext(song)
if ext.lower() in accept:
songs[name] = os.path.join(directory, song)
return songs
def load_all_fonts(directory, accept=(".ttf",)):
"""
Create a dictionary of paths to font files in given directory
if their extensions are in accept.
"""
return load_all_music(directory, accept)
def load_all_movies(directory, accept=(".mpg",)):
"""
Create a dictionary of paths to movie files in given directory
if their extensions are in accept.
"""
return load_all_music(directory, accept)
def load_all_sfx(directory, accept=(".wav", ".mp3", ".ogg", ".mdi")):
"""
Load all sfx of extensions found in accept. Unfortunately it is
common to need to set sfx volume on a one-by-one basis. This must be done
manually if necessary in the setup module.
"""
effects = {}
for fx in os.listdir(directory):
name,ext = os.path.splitext(fx)
if ext.lower() in accept:
effects[name] = pg.mixer.Sound(os.path.join(directory, fx))
return effects
def strip_from_sheet(sheet, start, size, columns, rows=1):
"""
Strips individual frames from a sprite sheet given a start location,
sprite size, and number of columns and rows.
"""
frames = []
for j in range(rows):
for i in range(columns):
location = (start[0]+size[0]*i, start[1]+size[1]*j)
frames.append(sheet.subsurface(pg.Rect(location, size)))
return frames
def strip_coords_from_sheet(sheet, coords, size):
"""Strip specific coordinates from a sprite sheet."""
frames = []
for coord in coords:
location = (coord[0]*size[0], coord[1]*size[1])
frames.append(sheet.subsurface(pg.Rect(location, size)))
return frames
def get_cell_coordinates(rect, point, size):
"""Find the cell of size, within rect, that point occupies."""
cell = [None, None]
point = (point[0]-rect.x, point[1]-rect.y)
cell[0] = (point[0]//size[0])*size[0]
cell[1] = (point[1]//size[1])*size[1]
return tuple(cell)
def cursor_from_image(image):
"""Take a valid image and create a mouse cursor."""
colors = {(0,0,0,255) : "X",
(255,255,255,255) : "."}
rect = image.get_rect()
icon_string = []
for j in range(rect.height):
this_row = []
for i in range(rect.width):
pixel = tuple(image.get_at((i,j)))
this_row.append(colors.get(pixel, " "))
icon_string.append("".join(this_row))
return icon_string
def get_cli_args(caption, win_pos, start_size, money):
"""
Modify prepare module globals based on command line arguments,
quickly force settings for debugging.
"""
parser = argparse.ArgumentParser(description='{} Arguments'.format(caption))
parser.add_argument('-c','--center', action='store_false',
help='position starting window at (0,0), sets SDL_VIDEO_CENTERED to false')
parser.add_argument('-w','--winpos', nargs=2, default=win_pos, metavar=('X', 'Y'),
help='position starting window at (X,Y), default is (0,0)')
parser.add_argument('-s' , '--size', nargs=2, default=start_size, metavar=('WIDTH', 'HEIGHT'),
help='set window size to WIDTH HEIGHT, defualt is {}'.format(start_size))
parser.add_argument('-f' , '--fullscreen', action='store_true',
help='start in fullscreen')
parser.add_argument('-m' , '--music_off', action='store_true',
help='start with no music')
parser.add_argument('-S', '--straight', action='store', type=str,
help='go straight to the named game')
parser.add_argument('-M', '--money', default=money, metavar='VALUE',
help='set money to value')
parser.add_argument('-d', '--debug', action='store_true',
help='run game in debug mode')
parser.add_argument('-F', '--FPS', action='store_true',
help='show FPS in title bar')
parser.add_argument('-p', '--profile', action='store_true',
help='run game with profiling')
parser.add_argument('-B', '--bots', action='store_true',
help='enable test bots')
args = vars(parser.parse_args())
#check each condition
if not args['center'] or (args['winpos'] != win_pos): #if -c or -w options
args['center'] = False
if args['size'] != start_size: # if screen size is different
args['resizable'] = False
if args['fullscreen']:
args['center'] = False
args['resizable'] = False
return args