motion-game 1.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +7 -0
- data/build/android/armeabi/libchipmunk.a +0 -0
- data/build/android/armeabi/libcrypto.a +0 -0
- data/build/android/armeabi/libcurl.a +0 -0
- data/build/android/armeabi/libfreetype.a +0 -0
- data/build/android/armeabi/libjpeg.a +0 -0
- data/build/android/armeabi/libmotion-cocos.a +0 -0
- data/build/android/armeabi/libpng.a +0 -0
- data/build/android/armeabi/libssl.a +0 -0
- data/build/android/armeabi/libtiff.a +0 -0
- data/build/android/armeabi/libwebp.a +0 -0
- data/build/android/armeabi/libwebsockets.a +0 -0
- data/build/android/motion-cocos.jar +0 -0
- data/build/android/x86/libchipmunk.a +0 -0
- data/build/android/x86/libcrypto.a +0 -0
- data/build/android/x86/libcurl.a +0 -0
- data/build/android/x86/libfreetype.a +0 -0
- data/build/android/x86/libjpeg.a +0 -0
- data/build/android/x86/libmotion-cocos.a +0 -0
- data/build/android/x86/libpng.a +0 -0
- data/build/android/x86/libssl.a +0 -0
- data/build/android/x86/libtiff.a +0 -0
- data/build/android/x86/libwebp.a +0 -0
- data/build/android/x86/libwebsockets.a +0 -0
- data/build/ios/libchipmunk.a +0 -0
- data/build/ios/libcurl.a +0 -0
- data/build/ios/libfreetype.a +0 -0
- data/build/ios/libjpeg.a +0 -0
- data/build/ios/libmotion-cocos.a +0 -0
- data/build/ios/libpng.a +0 -0
- data/build/ios/libtiff.a +0 -0
- data/build/ios/libwebp.a +0 -0
- data/build/ios/libwebsockets.a +0 -0
- data/doc/MG.html +129 -0
- data/doc/MG/Application.html +332 -0
- data/doc/MG/Audio.html +1049 -0
- data/doc/MG/Button.html +722 -0
- data/doc/MG/Color.html +528 -0
- data/doc/MG/Director.html +1140 -0
- data/doc/MG/Draw.html +437 -0
- data/doc/MG/Events.html +127 -0
- data/doc/MG/Events/Acceleration.html +502 -0
- data/doc/MG/Events/Touch.html +232 -0
- data/doc/MG/Layout.html +513 -0
- data/doc/MG/List.html +1050 -0
- data/doc/MG/Node.html +1752 -0
- data/doc/MG/Parallax.html +294 -0
- data/doc/MG/Particle.html +1221 -0
- data/doc/MG/Point.html +540 -0
- data/doc/MG/Scene.html +1250 -0
- data/doc/MG/Scroll.html +530 -0
- data/doc/MG/Size.html +737 -0
- data/doc/MG/Slider.html +335 -0
- data/doc/MG/Sprite.html +2066 -0
- data/doc/MG/Text.html +918 -0
- data/doc/MG/Web.html +828 -0
- data/doc/MG/Widget.html +460 -0
- data/doc/_index.html +362 -0
- data/doc/class_list.html +58 -0
- data/doc/css/common.css +1 -0
- data/doc/css/full_list.css +57 -0
- data/doc/css/style.css +339 -0
- data/doc/file.README.html +114 -0
- data/doc/file_list.html +60 -0
- data/doc/frames.html +26 -0
- data/doc/index.html +114 -0
- data/doc/js/app.js +219 -0
- data/doc/js/full_list.js +181 -0
- data/doc/js/jquery.js +4 -0
- data/doc/method_list.html +933 -0
- data/doc/top-level-namespace.html +112 -0
- data/lib/motion-game.rb +1 -0
- data/lib/motion-game/android.rb +23 -0
- data/lib/motion-game/android/main_activity.rb +2 -0
- data/lib/motion-game/ios.rb +14 -0
- data/lib/motion-game/ios/app_delegate.rb +20 -0
- data/lib/motion-game/ios/root_view_controller.rb +14 -0
- data/lib/motion-game/project.rb +1 -0
- data/lib/motion-game/shortcuts.rb +177 -0
- data/template/motion-game/files/Gemfile +5 -0
- data/template/motion-game/files/Rakefile +12 -0
- data/template/motion-game/files/app/application.rb +5 -0
- data/template/motion-game/files/app/main_scene.rb +7 -0
- data/template/motion-game/files/config/android.rb.erb +6 -0
- data/template/motion-game/files/config/ios.rb.erb +6 -0
- metadata +130 -0
data/doc/MG/Audio.html
ADDED
@@ -0,0 +1,1049 @@
|
|
1
|
+
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
|
2
|
+
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
3
|
+
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
|
4
|
+
<head>
|
5
|
+
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
6
|
+
<title>
|
7
|
+
Class: MG::Audio
|
8
|
+
|
9
|
+
— Documentation by YARD 0.8.7.6
|
10
|
+
|
11
|
+
</title>
|
12
|
+
|
13
|
+
<link rel="stylesheet" href="../css/style.css" type="text/css" charset="utf-8" />
|
14
|
+
|
15
|
+
<link rel="stylesheet" href="../css/common.css" type="text/css" charset="utf-8" />
|
16
|
+
|
17
|
+
<script type="text/javascript" charset="utf-8">
|
18
|
+
hasFrames = window.top.frames.main ? true : false;
|
19
|
+
relpath = '../';
|
20
|
+
framesUrl = "../frames.html#!MG/Audio.html";
|
21
|
+
</script>
|
22
|
+
|
23
|
+
|
24
|
+
<script type="text/javascript" charset="utf-8" src="../js/jquery.js"></script>
|
25
|
+
|
26
|
+
<script type="text/javascript" charset="utf-8" src="../js/app.js"></script>
|
27
|
+
|
28
|
+
|
29
|
+
</head>
|
30
|
+
<body>
|
31
|
+
<div id="header">
|
32
|
+
<div id="menu">
|
33
|
+
|
34
|
+
<a href="../_index.html">Index (A)</a> »
|
35
|
+
<span class='title'><span class='object_link'><a href="../MG.html" title="MG (module)">MG</a></span></span>
|
36
|
+
»
|
37
|
+
<span class="title">Audio</span>
|
38
|
+
|
39
|
+
|
40
|
+
<div class="noframes"><span class="title">(</span><a href="." target="_top">no frames</a><span class="title">)</span></div>
|
41
|
+
</div>
|
42
|
+
|
43
|
+
<div id="search">
|
44
|
+
|
45
|
+
<a class="full_list_link" id="class_list_link"
|
46
|
+
href="../class_list.html">
|
47
|
+
Class List
|
48
|
+
</a>
|
49
|
+
|
50
|
+
<a class="full_list_link" id="method_list_link"
|
51
|
+
href="../method_list.html">
|
52
|
+
Method List
|
53
|
+
</a>
|
54
|
+
|
55
|
+
<a class="full_list_link" id="file_list_link"
|
56
|
+
href="../file_list.html">
|
57
|
+
File List
|
58
|
+
</a>
|
59
|
+
|
60
|
+
</div>
|
61
|
+
<div class="clear"></div>
|
62
|
+
</div>
|
63
|
+
|
64
|
+
<iframe id="search_frame"></iframe>
|
65
|
+
|
66
|
+
<div id="content"><h1>Class: MG::Audio
|
67
|
+
|
68
|
+
|
69
|
+
|
70
|
+
</h1>
|
71
|
+
|
72
|
+
<dl class="box">
|
73
|
+
|
74
|
+
<dt class="r1">Inherits:</dt>
|
75
|
+
<dd class="r1">
|
76
|
+
<span class="inheritName">Object</span>
|
77
|
+
|
78
|
+
<ul class="fullTree">
|
79
|
+
<li>Object</li>
|
80
|
+
|
81
|
+
<li class="next">MG::Audio</li>
|
82
|
+
|
83
|
+
</ul>
|
84
|
+
<a href="#" class="inheritanceTree">show all</a>
|
85
|
+
|
86
|
+
</dd>
|
87
|
+
|
88
|
+
|
89
|
+
|
90
|
+
|
91
|
+
|
92
|
+
|
93
|
+
|
94
|
+
|
95
|
+
|
96
|
+
<dt class="r2 last">Defined in:</dt>
|
97
|
+
<dd class="r2 last">motion-game</dd>
|
98
|
+
|
99
|
+
</dl>
|
100
|
+
<div class="clear"></div>
|
101
|
+
|
102
|
+
|
103
|
+
|
104
|
+
|
105
|
+
|
106
|
+
<h2>Properties <small>(<a href="#" class="summary_toggle">collapse</a>)</small></h2>
|
107
|
+
<ul class="summary">
|
108
|
+
|
109
|
+
<li class="public ">
|
110
|
+
<span class="summary_signature">
|
111
|
+
|
112
|
+
<a href="#current_position-instance_method" title="#current_position (instance method)">- (Float) <strong>current_position</strong> </a>
|
113
|
+
|
114
|
+
|
115
|
+
|
116
|
+
</span>
|
117
|
+
|
118
|
+
|
119
|
+
|
120
|
+
|
121
|
+
|
122
|
+
|
123
|
+
|
124
|
+
|
125
|
+
|
126
|
+
|
127
|
+
|
128
|
+
|
129
|
+
<span class="summary_desc"><div class='inline'>
|
130
|
+
<p>The position where to play the sound file.</p>
|
131
|
+
</div></span>
|
132
|
+
|
133
|
+
</li>
|
134
|
+
|
135
|
+
|
136
|
+
<li class="public ">
|
137
|
+
<span class="summary_signature">
|
138
|
+
|
139
|
+
<a href="#duration-instance_method" title="#duration (instance method)">- (Float) <strong>duration</strong> </a>
|
140
|
+
|
141
|
+
|
142
|
+
|
143
|
+
</span>
|
144
|
+
|
145
|
+
|
146
|
+
|
147
|
+
|
148
|
+
<span class="note title readonly">readonly</span>
|
149
|
+
|
150
|
+
|
151
|
+
|
152
|
+
|
153
|
+
|
154
|
+
|
155
|
+
|
156
|
+
|
157
|
+
|
158
|
+
<span class="summary_desc"><div class='inline'>
|
159
|
+
<p>The duration left in the sound file.</p>
|
160
|
+
</div></span>
|
161
|
+
|
162
|
+
</li>
|
163
|
+
|
164
|
+
|
165
|
+
<li class="public ">
|
166
|
+
<span class="summary_signature">
|
167
|
+
|
168
|
+
<a href="#loop%3F-instance_method" title="#loop? (instance method)">- (Boolean) <strong>loop?</strong> </a>
|
169
|
+
|
170
|
+
|
171
|
+
|
172
|
+
</span>
|
173
|
+
|
174
|
+
|
175
|
+
|
176
|
+
|
177
|
+
|
178
|
+
|
179
|
+
|
180
|
+
|
181
|
+
|
182
|
+
|
183
|
+
|
184
|
+
|
185
|
+
<span class="summary_desc"><div class='inline'>
|
186
|
+
<p>Whether the sound file should loop.</p>
|
187
|
+
</div></span>
|
188
|
+
|
189
|
+
</li>
|
190
|
+
|
191
|
+
|
192
|
+
<li class="public ">
|
193
|
+
<span class="summary_signature">
|
194
|
+
|
195
|
+
<a href="#volume-instance_method" title="#volume (instance method)">- (Float) <strong>volume</strong> </a>
|
196
|
+
|
197
|
+
|
198
|
+
|
199
|
+
</span>
|
200
|
+
|
201
|
+
|
202
|
+
|
203
|
+
|
204
|
+
|
205
|
+
|
206
|
+
|
207
|
+
|
208
|
+
|
209
|
+
|
210
|
+
|
211
|
+
|
212
|
+
<span class="summary_desc"><div class='inline'>
|
213
|
+
<p>The volume of the sound file, from a 0.0 to 1.0 Float range.</p>
|
214
|
+
</div></span>
|
215
|
+
|
216
|
+
</li>
|
217
|
+
|
218
|
+
|
219
|
+
</ul>
|
220
|
+
|
221
|
+
|
222
|
+
|
223
|
+
|
224
|
+
|
225
|
+
<h2>
|
226
|
+
Constructors
|
227
|
+
<small>(<a href="#" class="summary_toggle">collapse</a>)</small>
|
228
|
+
</h2>
|
229
|
+
|
230
|
+
<ul class="summary">
|
231
|
+
|
232
|
+
<li class="public ">
|
233
|
+
<span class="summary_signature">
|
234
|
+
|
235
|
+
<a href="#play-class_method" title="play (class method)">+ (Audio) <strong>play</strong>(path, loop = false, volume = 1.0) </a>
|
236
|
+
|
237
|
+
|
238
|
+
|
239
|
+
</span>
|
240
|
+
|
241
|
+
|
242
|
+
|
243
|
+
|
244
|
+
|
245
|
+
|
246
|
+
|
247
|
+
|
248
|
+
|
249
|
+
<span class="summary_desc"><div class='inline'>
|
250
|
+
<p>Creates a new Audio object based on a sound file at the given path and
|
251
|
+
immediately plays it.</p>
|
252
|
+
</div></span>
|
253
|
+
|
254
|
+
</li>
|
255
|
+
|
256
|
+
|
257
|
+
</ul>
|
258
|
+
|
259
|
+
<h2>
|
260
|
+
Playback
|
261
|
+
<small>(<a href="#" class="summary_toggle">collapse</a>)</small>
|
262
|
+
</h2>
|
263
|
+
|
264
|
+
<ul class="summary">
|
265
|
+
|
266
|
+
<li class="public ">
|
267
|
+
<span class="summary_signature">
|
268
|
+
|
269
|
+
<a href="#pause-instance_method" title="#pause (instance method)">- (Audio) <strong>pause</strong> </a>
|
270
|
+
|
271
|
+
|
272
|
+
|
273
|
+
</span>
|
274
|
+
|
275
|
+
|
276
|
+
|
277
|
+
|
278
|
+
|
279
|
+
|
280
|
+
|
281
|
+
|
282
|
+
|
283
|
+
<span class="summary_desc"><div class='inline'>
|
284
|
+
<p>Pauses the sound file.</p>
|
285
|
+
</div></span>
|
286
|
+
|
287
|
+
</li>
|
288
|
+
|
289
|
+
|
290
|
+
<li class="public ">
|
291
|
+
<span class="summary_signature">
|
292
|
+
|
293
|
+
<a href="#paused%3F-instance_method" title="#paused? (instance method)">- (Boolean) <strong>paused?</strong> </a>
|
294
|
+
|
295
|
+
|
296
|
+
|
297
|
+
</span>
|
298
|
+
|
299
|
+
|
300
|
+
|
301
|
+
|
302
|
+
|
303
|
+
|
304
|
+
|
305
|
+
|
306
|
+
|
307
|
+
<span class="summary_desc"><div class='inline'>
|
308
|
+
<p>Whether the sound file is being paused.</p>
|
309
|
+
</div></span>
|
310
|
+
|
311
|
+
</li>
|
312
|
+
|
313
|
+
|
314
|
+
<li class="public ">
|
315
|
+
<span class="summary_signature">
|
316
|
+
|
317
|
+
<a href="#playing%3F-instance_method" title="#playing? (instance method)">- (Boolean) <strong>playing?</strong> </a>
|
318
|
+
|
319
|
+
|
320
|
+
|
321
|
+
</span>
|
322
|
+
|
323
|
+
|
324
|
+
|
325
|
+
|
326
|
+
|
327
|
+
|
328
|
+
|
329
|
+
|
330
|
+
|
331
|
+
<span class="summary_desc"><div class='inline'>
|
332
|
+
<p>Whether the sound file is being played.</p>
|
333
|
+
</div></span>
|
334
|
+
|
335
|
+
</li>
|
336
|
+
|
337
|
+
|
338
|
+
<li class="public ">
|
339
|
+
<span class="summary_signature">
|
340
|
+
|
341
|
+
<a href="#resume-instance_method" title="#resume (instance method)">- (Audio) <strong>resume</strong> </a>
|
342
|
+
|
343
|
+
|
344
|
+
|
345
|
+
</span>
|
346
|
+
|
347
|
+
|
348
|
+
|
349
|
+
|
350
|
+
|
351
|
+
|
352
|
+
|
353
|
+
|
354
|
+
|
355
|
+
<span class="summary_desc"><div class='inline'>
|
356
|
+
<p>Resumes playing the sound file.</p>
|
357
|
+
</div></span>
|
358
|
+
|
359
|
+
</li>
|
360
|
+
|
361
|
+
|
362
|
+
<li class="public ">
|
363
|
+
<span class="summary_signature">
|
364
|
+
|
365
|
+
<a href="#stop-instance_method" title="#stop (instance method)">- (Audio) <strong>stop</strong> </a>
|
366
|
+
|
367
|
+
|
368
|
+
|
369
|
+
</span>
|
370
|
+
|
371
|
+
|
372
|
+
|
373
|
+
|
374
|
+
|
375
|
+
|
376
|
+
|
377
|
+
|
378
|
+
|
379
|
+
<span class="summary_desc"><div class='inline'>
|
380
|
+
<p>Stops the sound file.</p>
|
381
|
+
</div></span>
|
382
|
+
|
383
|
+
</li>
|
384
|
+
|
385
|
+
|
386
|
+
</ul>
|
387
|
+
|
388
|
+
|
389
|
+
|
390
|
+
<div id="instance_attr_details" class="attr_details">
|
391
|
+
<h2>Instance Attribute Details</h2>
|
392
|
+
|
393
|
+
|
394
|
+
<span id="current_position=-instance_method"></span>
|
395
|
+
<div class="method_details first">
|
396
|
+
<h3 class="signature first" id="current_position-instance_method">
|
397
|
+
|
398
|
+
- (<tt>Float</tt>) <strong>current_position</strong>
|
399
|
+
|
400
|
+
|
401
|
+
|
402
|
+
|
403
|
+
|
404
|
+
</h3><div class="docstring">
|
405
|
+
<div class="discussion">
|
406
|
+
|
407
|
+
<p>Returns the position where to play the sound file.</p>
|
408
|
+
|
409
|
+
|
410
|
+
</div>
|
411
|
+
</div>
|
412
|
+
<div class="tags">
|
413
|
+
|
414
|
+
<p class="tag_title">Returns:</p>
|
415
|
+
<ul class="return">
|
416
|
+
|
417
|
+
<li>
|
418
|
+
|
419
|
+
|
420
|
+
<span class='type'>(<tt>Float</tt>)</span>
|
421
|
+
|
422
|
+
|
423
|
+
|
424
|
+
—
|
425
|
+
<div class='inline'>
|
426
|
+
<p>the position where to play the sound file.</p>
|
427
|
+
</div>
|
428
|
+
|
429
|
+
</li>
|
430
|
+
|
431
|
+
</ul>
|
432
|
+
|
433
|
+
</div><table class="source_code">
|
434
|
+
<tr>
|
435
|
+
<td>
|
436
|
+
<pre class="lines">
|
437
|
+
|
438
|
+
|
439
|
+
54
|
440
|
+
55
|
441
|
+
56</pre>
|
442
|
+
</td>
|
443
|
+
<td>
|
444
|
+
<pre class="code"><span class="info file"># File 'motion-game', line 54</span>
|
445
|
+
|
446
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_current_position'>current_position</span>
|
447
|
+
<span class='ivar'>@current_position</span>
|
448
|
+
<span class='kw'>end</span></pre>
|
449
|
+
</td>
|
450
|
+
</tr>
|
451
|
+
</table>
|
452
|
+
</div>
|
453
|
+
|
454
|
+
|
455
|
+
<span id=""></span>
|
456
|
+
<div class="method_details ">
|
457
|
+
<h3 class="signature " id="duration-instance_method">
|
458
|
+
|
459
|
+
- (<tt>Float</tt>) <strong>duration</strong> <span class="extras">(readonly)</span>
|
460
|
+
|
461
|
+
|
462
|
+
|
463
|
+
|
464
|
+
|
465
|
+
</h3><div class="docstring">
|
466
|
+
<div class="discussion">
|
467
|
+
|
468
|
+
<p>Returns the duration left in the sound file.</p>
|
469
|
+
|
470
|
+
|
471
|
+
</div>
|
472
|
+
</div>
|
473
|
+
<div class="tags">
|
474
|
+
|
475
|
+
<p class="tag_title">Returns:</p>
|
476
|
+
<ul class="return">
|
477
|
+
|
478
|
+
<li>
|
479
|
+
|
480
|
+
|
481
|
+
<span class='type'>(<tt>Float</tt>)</span>
|
482
|
+
|
483
|
+
|
484
|
+
|
485
|
+
—
|
486
|
+
<div class='inline'>
|
487
|
+
<p>the duration left in the sound file.</p>
|
488
|
+
</div>
|
489
|
+
|
490
|
+
</li>
|
491
|
+
|
492
|
+
</ul>
|
493
|
+
|
494
|
+
</div><table class="source_code">
|
495
|
+
<tr>
|
496
|
+
<td>
|
497
|
+
<pre class="lines">
|
498
|
+
|
499
|
+
|
500
|
+
57
|
501
|
+
58
|
502
|
+
59</pre>
|
503
|
+
</td>
|
504
|
+
<td>
|
505
|
+
<pre class="code"><span class="info file"># File 'motion-game', line 57</span>
|
506
|
+
|
507
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_duration'>duration</span>
|
508
|
+
<span class='ivar'>@duration</span>
|
509
|
+
<span class='kw'>end</span></pre>
|
510
|
+
</td>
|
511
|
+
</tr>
|
512
|
+
</table>
|
513
|
+
</div>
|
514
|
+
|
515
|
+
|
516
|
+
<span id="loop?=-instance_method"></span>
|
517
|
+
<div class="method_details ">
|
518
|
+
<h3 class="signature " id="loop?-instance_method">
|
519
|
+
|
520
|
+
- (<tt>Boolean</tt>) <strong>loop?</strong>
|
521
|
+
|
522
|
+
|
523
|
+
|
524
|
+
|
525
|
+
|
526
|
+
</h3><div class="docstring">
|
527
|
+
<div class="discussion">
|
528
|
+
|
529
|
+
<p>Returns whether the sound file should loop.</p>
|
530
|
+
|
531
|
+
|
532
|
+
</div>
|
533
|
+
</div>
|
534
|
+
<div class="tags">
|
535
|
+
|
536
|
+
<p class="tag_title">Returns:</p>
|
537
|
+
<ul class="return">
|
538
|
+
|
539
|
+
<li>
|
540
|
+
|
541
|
+
|
542
|
+
<span class='type'>(<tt>Boolean</tt>)</span>
|
543
|
+
|
544
|
+
|
545
|
+
|
546
|
+
—
|
547
|
+
<div class='inline'>
|
548
|
+
<p>whether the sound file should loop.</p>
|
549
|
+
</div>
|
550
|
+
|
551
|
+
</li>
|
552
|
+
|
553
|
+
</ul>
|
554
|
+
|
555
|
+
</div><table class="source_code">
|
556
|
+
<tr>
|
557
|
+
<td>
|
558
|
+
<pre class="lines">
|
559
|
+
|
560
|
+
|
561
|
+
48
|
562
|
+
49
|
563
|
+
50</pre>
|
564
|
+
</td>
|
565
|
+
<td>
|
566
|
+
<pre class="code"><span class="info file"># File 'motion-game', line 48</span>
|
567
|
+
|
568
|
+
def loop?
|
569
|
+
@loop?
|
570
|
+
end</pre>
|
571
|
+
</td>
|
572
|
+
</tr>
|
573
|
+
</table>
|
574
|
+
</div>
|
575
|
+
|
576
|
+
|
577
|
+
<span id="volume=-instance_method"></span>
|
578
|
+
<div class="method_details ">
|
579
|
+
<h3 class="signature " id="volume-instance_method">
|
580
|
+
|
581
|
+
- (<tt>Float</tt>) <strong>volume</strong>
|
582
|
+
|
583
|
+
|
584
|
+
|
585
|
+
|
586
|
+
|
587
|
+
</h3><div class="docstring">
|
588
|
+
<div class="discussion">
|
589
|
+
|
590
|
+
<p>Returns the volume of the sound file, from a 0.0 to 1.0 Float range.</p>
|
591
|
+
|
592
|
+
|
593
|
+
</div>
|
594
|
+
</div>
|
595
|
+
<div class="tags">
|
596
|
+
|
597
|
+
<p class="tag_title">Returns:</p>
|
598
|
+
<ul class="return">
|
599
|
+
|
600
|
+
<li>
|
601
|
+
|
602
|
+
|
603
|
+
<span class='type'>(<tt>Float</tt>)</span>
|
604
|
+
|
605
|
+
|
606
|
+
|
607
|
+
—
|
608
|
+
<div class='inline'>
|
609
|
+
<p>the volume of the sound file, from a 0.0 to 1.0 Float range.</p>
|
610
|
+
</div>
|
611
|
+
|
612
|
+
</li>
|
613
|
+
|
614
|
+
</ul>
|
615
|
+
|
616
|
+
</div><table class="source_code">
|
617
|
+
<tr>
|
618
|
+
<td>
|
619
|
+
<pre class="lines">
|
620
|
+
|
621
|
+
|
622
|
+
51
|
623
|
+
52
|
624
|
+
53</pre>
|
625
|
+
</td>
|
626
|
+
<td>
|
627
|
+
<pre class="code"><span class="info file"># File 'motion-game', line 51</span>
|
628
|
+
|
629
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_volume'>volume</span>
|
630
|
+
<span class='ivar'>@volume</span>
|
631
|
+
<span class='kw'>end</span></pre>
|
632
|
+
</td>
|
633
|
+
</tr>
|
634
|
+
</table>
|
635
|
+
</div>
|
636
|
+
|
637
|
+
</div>
|
638
|
+
|
639
|
+
|
640
|
+
<div id="class_method_details" class="method_details_list">
|
641
|
+
<h2>Class Method Details</h2>
|
642
|
+
|
643
|
+
|
644
|
+
<div class="method_details first">
|
645
|
+
<h3 class="signature first" id="play-class_method">
|
646
|
+
|
647
|
+
+ (<tt><span class='object_link'><a href="" title="MG::Audio (class)">Audio</a></span></tt>) <strong>play</strong>(path, loop = false, volume = 1.0)
|
648
|
+
|
649
|
+
|
650
|
+
|
651
|
+
|
652
|
+
|
653
|
+
</h3><div class="docstring">
|
654
|
+
<div class="discussion">
|
655
|
+
|
656
|
+
<p>Creates a new Audio object based on a sound file at the given path and
|
657
|
+
immediately plays it.</p>
|
658
|
+
|
659
|
+
|
660
|
+
</div>
|
661
|
+
</div>
|
662
|
+
<div class="tags">
|
663
|
+
<p class="tag_title">Parameters:</p>
|
664
|
+
<ul class="param">
|
665
|
+
|
666
|
+
<li>
|
667
|
+
|
668
|
+
<span class='name'>path</span>
|
669
|
+
|
670
|
+
|
671
|
+
<span class='type'>(<tt>String</tt>)</span>
|
672
|
+
|
673
|
+
|
674
|
+
|
675
|
+
—
|
676
|
+
<div class='inline'>
|
677
|
+
<p>the path of the sound file that should be played.</p>
|
678
|
+
</div>
|
679
|
+
|
680
|
+
</li>
|
681
|
+
|
682
|
+
<li>
|
683
|
+
|
684
|
+
<span class='name'>loop</span>
|
685
|
+
|
686
|
+
|
687
|
+
<span class='type'>(<tt>Boolean</tt>)</span>
|
688
|
+
|
689
|
+
|
690
|
+
<em class="default">(defaults to: <tt>false</tt>)</em>
|
691
|
+
|
692
|
+
|
693
|
+
—
|
694
|
+
<div class='inline'>
|
695
|
+
<p>whether the sound file playback should loop.</p>
|
696
|
+
</div>
|
697
|
+
|
698
|
+
</li>
|
699
|
+
|
700
|
+
<li>
|
701
|
+
|
702
|
+
<span class='name'>volume</span>
|
703
|
+
|
704
|
+
|
705
|
+
<span class='type'>(<tt>Float</tt>)</span>
|
706
|
+
|
707
|
+
|
708
|
+
<em class="default">(defaults to: <tt>1.0</tt>)</em>
|
709
|
+
|
710
|
+
|
711
|
+
—
|
712
|
+
<div class='inline'>
|
713
|
+
<p>the audio volume that should be used to play this this sound file, as a
|
714
|
+
<code>0.0</code> to <code>1.0</code> Float range.</p>
|
715
|
+
</div>
|
716
|
+
|
717
|
+
</li>
|
718
|
+
|
719
|
+
</ul>
|
720
|
+
|
721
|
+
<p class="tag_title">Returns:</p>
|
722
|
+
<ul class="return">
|
723
|
+
|
724
|
+
<li>
|
725
|
+
|
726
|
+
|
727
|
+
<span class='type'>(<tt><span class='object_link'><a href="" title="MG::Audio (class)">Audio</a></span></tt>)</span>
|
728
|
+
|
729
|
+
|
730
|
+
|
731
|
+
—
|
732
|
+
<div class='inline'>
|
733
|
+
<p>an Audio instance.</p>
|
734
|
+
</div>
|
735
|
+
|
736
|
+
</li>
|
737
|
+
|
738
|
+
</ul>
|
739
|
+
|
740
|
+
</div><table class="source_code">
|
741
|
+
<tr>
|
742
|
+
<td>
|
743
|
+
<pre class="lines">
|
744
|
+
|
745
|
+
|
746
|
+
42</pre>
|
747
|
+
</td>
|
748
|
+
<td>
|
749
|
+
<pre class="code"><span class="info file"># File 'motion-game', line 42</span>
|
750
|
+
|
751
|
+
<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_play'>play</span><span class='lparen'>(</span><span class='id identifier rubyid_path'>path</span><span class='comma'>,</span> <span class='id identifier rubyid_loop'>loop</span><span class='op'>=</span><span class='kw'>false</span><span class='comma'>,</span> <span class='id identifier rubyid_volume'>volume</span><span class='op'>=</span><span class='float'>1.0</span><span class='rparen'>)</span><span class='semicolon'>;</span> <span class='kw'>end</span></pre>
|
752
|
+
</td>
|
753
|
+
</tr>
|
754
|
+
</table>
|
755
|
+
</div>
|
756
|
+
|
757
|
+
</div>
|
758
|
+
|
759
|
+
<div id="instance_method_details" class="method_details_list">
|
760
|
+
<h2>Instance Method Details</h2>
|
761
|
+
|
762
|
+
|
763
|
+
<div class="method_details first">
|
764
|
+
<h3 class="signature first" id="pause-instance_method">
|
765
|
+
|
766
|
+
- (<tt><span class='object_link'><a href="" title="MG::Audio (class)">Audio</a></span></tt>) <strong>pause</strong>
|
767
|
+
|
768
|
+
|
769
|
+
|
770
|
+
|
771
|
+
|
772
|
+
</h3><div class="docstring">
|
773
|
+
<div class="discussion">
|
774
|
+
|
775
|
+
<p>Pauses the sound file.</p>
|
776
|
+
|
777
|
+
|
778
|
+
</div>
|
779
|
+
</div>
|
780
|
+
<div class="tags">
|
781
|
+
|
782
|
+
<p class="tag_title">Returns:</p>
|
783
|
+
<ul class="return">
|
784
|
+
|
785
|
+
<li>
|
786
|
+
|
787
|
+
|
788
|
+
<span class='type'>(<tt><span class='object_link'><a href="" title="MG::Audio (class)">Audio</a></span></tt>)</span>
|
789
|
+
|
790
|
+
|
791
|
+
|
792
|
+
—
|
793
|
+
<div class='inline'>
|
794
|
+
<p>the receiver.</p>
|
795
|
+
</div>
|
796
|
+
|
797
|
+
</li>
|
798
|
+
|
799
|
+
</ul>
|
800
|
+
|
801
|
+
</div><table class="source_code">
|
802
|
+
<tr>
|
803
|
+
<td>
|
804
|
+
<pre class="lines">
|
805
|
+
|
806
|
+
|
807
|
+
68</pre>
|
808
|
+
</td>
|
809
|
+
<td>
|
810
|
+
<pre class="code"><span class="info file"># File 'motion-game', line 68</span>
|
811
|
+
|
812
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_pause'>pause</span><span class='semicolon'>;</span> <span class='kw'>end</span></pre>
|
813
|
+
</td>
|
814
|
+
</tr>
|
815
|
+
</table>
|
816
|
+
</div>
|
817
|
+
|
818
|
+
<div class="method_details ">
|
819
|
+
<h3 class="signature " id="paused?-instance_method">
|
820
|
+
|
821
|
+
- (<tt>Boolean</tt>) <strong>paused?</strong>
|
822
|
+
|
823
|
+
|
824
|
+
|
825
|
+
|
826
|
+
|
827
|
+
</h3><div class="docstring">
|
828
|
+
<div class="discussion">
|
829
|
+
|
830
|
+
<p>Returns whether the sound file is being paused.</p>
|
831
|
+
|
832
|
+
|
833
|
+
</div>
|
834
|
+
</div>
|
835
|
+
<div class="tags">
|
836
|
+
|
837
|
+
<p class="tag_title">Returns:</p>
|
838
|
+
<ul class="return">
|
839
|
+
|
840
|
+
<li>
|
841
|
+
|
842
|
+
|
843
|
+
<span class='type'>(<tt>Boolean</tt>)</span>
|
844
|
+
|
845
|
+
|
846
|
+
|
847
|
+
—
|
848
|
+
<div class='inline'>
|
849
|
+
<p>whether the sound file is being paused.</p>
|
850
|
+
</div>
|
851
|
+
|
852
|
+
</li>
|
853
|
+
|
854
|
+
</ul>
|
855
|
+
|
856
|
+
</div><table class="source_code">
|
857
|
+
<tr>
|
858
|
+
<td>
|
859
|
+
<pre class="lines">
|
860
|
+
|
861
|
+
|
862
|
+
78</pre>
|
863
|
+
</td>
|
864
|
+
<td>
|
865
|
+
<pre class="code"><span class="info file"># File 'motion-game', line 78</span>
|
866
|
+
|
867
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_paused?'>paused?</span><span class='semicolon'>;</span> <span class='kw'>end</span></pre>
|
868
|
+
</td>
|
869
|
+
</tr>
|
870
|
+
</table>
|
871
|
+
</div>
|
872
|
+
|
873
|
+
<div class="method_details ">
|
874
|
+
<h3 class="signature " id="playing?-instance_method">
|
875
|
+
|
876
|
+
- (<tt>Boolean</tt>) <strong>playing?</strong>
|
877
|
+
|
878
|
+
|
879
|
+
|
880
|
+
|
881
|
+
|
882
|
+
</h3><div class="docstring">
|
883
|
+
<div class="discussion">
|
884
|
+
|
885
|
+
<p>Returns whether the sound file is being played.</p>
|
886
|
+
|
887
|
+
|
888
|
+
</div>
|
889
|
+
</div>
|
890
|
+
<div class="tags">
|
891
|
+
|
892
|
+
<p class="tag_title">Returns:</p>
|
893
|
+
<ul class="return">
|
894
|
+
|
895
|
+
<li>
|
896
|
+
|
897
|
+
|
898
|
+
<span class='type'>(<tt>Boolean</tt>)</span>
|
899
|
+
|
900
|
+
|
901
|
+
|
902
|
+
—
|
903
|
+
<div class='inline'>
|
904
|
+
<p>whether the sound file is being played.</p>
|
905
|
+
</div>
|
906
|
+
|
907
|
+
</li>
|
908
|
+
|
909
|
+
</ul>
|
910
|
+
|
911
|
+
</div><table class="source_code">
|
912
|
+
<tr>
|
913
|
+
<td>
|
914
|
+
<pre class="lines">
|
915
|
+
|
916
|
+
|
917
|
+
75</pre>
|
918
|
+
</td>
|
919
|
+
<td>
|
920
|
+
<pre class="code"><span class="info file"># File 'motion-game', line 75</span>
|
921
|
+
|
922
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_playing?'>playing?</span><span class='semicolon'>;</span> <span class='kw'>end</span></pre>
|
923
|
+
</td>
|
924
|
+
</tr>
|
925
|
+
</table>
|
926
|
+
</div>
|
927
|
+
|
928
|
+
<div class="method_details ">
|
929
|
+
<h3 class="signature " id="resume-instance_method">
|
930
|
+
|
931
|
+
- (<tt><span class='object_link'><a href="" title="MG::Audio (class)">Audio</a></span></tt>) <strong>resume</strong>
|
932
|
+
|
933
|
+
|
934
|
+
|
935
|
+
|
936
|
+
|
937
|
+
</h3><div class="docstring">
|
938
|
+
<div class="discussion">
|
939
|
+
|
940
|
+
<p>Resumes playing the sound file.</p>
|
941
|
+
|
942
|
+
|
943
|
+
</div>
|
944
|
+
</div>
|
945
|
+
<div class="tags">
|
946
|
+
|
947
|
+
<p class="tag_title">Returns:</p>
|
948
|
+
<ul class="return">
|
949
|
+
|
950
|
+
<li>
|
951
|
+
|
952
|
+
|
953
|
+
<span class='type'>(<tt><span class='object_link'><a href="" title="MG::Audio (class)">Audio</a></span></tt>)</span>
|
954
|
+
|
955
|
+
|
956
|
+
|
957
|
+
—
|
958
|
+
<div class='inline'>
|
959
|
+
<p>the receiver.</p>
|
960
|
+
</div>
|
961
|
+
|
962
|
+
</li>
|
963
|
+
|
964
|
+
</ul>
|
965
|
+
|
966
|
+
</div><table class="source_code">
|
967
|
+
<tr>
|
968
|
+
<td>
|
969
|
+
<pre class="lines">
|
970
|
+
|
971
|
+
|
972
|
+
64</pre>
|
973
|
+
</td>
|
974
|
+
<td>
|
975
|
+
<pre class="code"><span class="info file"># File 'motion-game', line 64</span>
|
976
|
+
|
977
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_resume'>resume</span><span class='semicolon'>;</span> <span class='kw'>end</span></pre>
|
978
|
+
</td>
|
979
|
+
</tr>
|
980
|
+
</table>
|
981
|
+
</div>
|
982
|
+
|
983
|
+
<div class="method_details ">
|
984
|
+
<h3 class="signature " id="stop-instance_method">
|
985
|
+
|
986
|
+
- (<tt><span class='object_link'><a href="" title="MG::Audio (class)">Audio</a></span></tt>) <strong>stop</strong>
|
987
|
+
|
988
|
+
|
989
|
+
|
990
|
+
|
991
|
+
|
992
|
+
</h3><div class="docstring">
|
993
|
+
<div class="discussion">
|
994
|
+
|
995
|
+
<p>Stops the sound file.</p>
|
996
|
+
|
997
|
+
|
998
|
+
</div>
|
999
|
+
</div>
|
1000
|
+
<div class="tags">
|
1001
|
+
|
1002
|
+
<p class="tag_title">Returns:</p>
|
1003
|
+
<ul class="return">
|
1004
|
+
|
1005
|
+
<li>
|
1006
|
+
|
1007
|
+
|
1008
|
+
<span class='type'>(<tt><span class='object_link'><a href="" title="MG::Audio (class)">Audio</a></span></tt>)</span>
|
1009
|
+
|
1010
|
+
|
1011
|
+
|
1012
|
+
—
|
1013
|
+
<div class='inline'>
|
1014
|
+
<p>the receiver.</p>
|
1015
|
+
</div>
|
1016
|
+
|
1017
|
+
</li>
|
1018
|
+
|
1019
|
+
</ul>
|
1020
|
+
|
1021
|
+
</div><table class="source_code">
|
1022
|
+
<tr>
|
1023
|
+
<td>
|
1024
|
+
<pre class="lines">
|
1025
|
+
|
1026
|
+
|
1027
|
+
72</pre>
|
1028
|
+
</td>
|
1029
|
+
<td>
|
1030
|
+
<pre class="code"><span class="info file"># File 'motion-game', line 72</span>
|
1031
|
+
|
1032
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_stop'>stop</span><span class='semicolon'>;</span> <span class='kw'>end</span></pre>
|
1033
|
+
</td>
|
1034
|
+
</tr>
|
1035
|
+
</table>
|
1036
|
+
</div>
|
1037
|
+
|
1038
|
+
</div>
|
1039
|
+
|
1040
|
+
</div>
|
1041
|
+
|
1042
|
+
<div id="footer">
|
1043
|
+
Generated on Thu Sep 3 15:12:07 2015 by
|
1044
|
+
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
1045
|
+
0.8.7.6 (ruby-2.0.0).
|
1046
|
+
</div>
|
1047
|
+
|
1048
|
+
</body>
|
1049
|
+
</html>
|