fantasy 0.1.13 → 0.1.17

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (84) hide show
  1. checksums.yaml +4 -4
  2. data/.rubocop.yml +22 -1
  3. data/.yardopts +4 -0
  4. data/CHANGELOG.md +6 -0
  5. data/Gemfile +1 -1
  6. data/Gemfile.lock +55 -0
  7. data/README.md +14 -6
  8. data/docs/Actor.html +2737 -0
  9. data/docs/Background.html +961 -0
  10. data/docs/Camera.html +791 -0
  11. data/docs/Clock.html +753 -0
  12. data/docs/Color.html +776 -0
  13. data/docs/Coordinates.html +730 -0
  14. data/docs/Cursor.html +752 -0
  15. data/docs/Disk.html +236 -0
  16. data/docs/Draggable.html +198 -0
  17. data/docs/Fantasy.html +121 -0
  18. data/docs/Game.html +904 -0
  19. data/docs/Global.html +2791 -0
  20. data/docs/Gravitier.html +179 -0
  21. data/docs/HudImage.html +979 -0
  22. data/docs/HudText.html +1151 -0
  23. data/docs/Image.html +506 -0
  24. data/docs/Jumper.html +189 -0
  25. data/docs/Mouse.html +226 -0
  26. data/docs/MoveByCursor.html +374 -0
  27. data/docs/MoveByDirection.html +179 -0
  28. data/docs/Mover.html +305 -0
  29. data/docs/Music.html +524 -0
  30. data/docs/Shape.html +1057 -0
  31. data/docs/Sound.html +374 -0
  32. data/docs/Tilemap.html +491 -0
  33. data/docs/Tween.html +186 -0
  34. data/docs/UserInputs.html +879 -0
  35. data/docs/Utils.html +345 -0
  36. data/docs/_index.html +346 -0
  37. data/docs/class_list.html +51 -0
  38. data/docs/css/common.css +1 -0
  39. data/docs/css/full_list.css +58 -0
  40. data/docs/css/style.css +497 -0
  41. data/docs/file.CHANGELOG.html +121 -0
  42. data/docs/file.README.html +599 -0
  43. data/docs/file_list.html +61 -0
  44. data/docs/frames.html +17 -0
  45. data/docs/index.html +599 -0
  46. data/docs/js/app.js +314 -0
  47. data/docs/js/full_list.js +216 -0
  48. data/docs/js/jquery.js +4 -0
  49. data/docs/method_list.html +1931 -0
  50. data/docs/top-level-namespace.html +978 -0
  51. data/lib/fantasy/actor.rb +455 -123
  52. data/lib/fantasy/background.rb +109 -13
  53. data/lib/fantasy/base.rb +113 -1
  54. data/lib/fantasy/camera.rb +95 -11
  55. data/lib/fantasy/clock.rb +4 -2
  56. data/lib/fantasy/color.rb +158 -153
  57. data/lib/fantasy/coordinates.rb +5 -9
  58. data/lib/fantasy/cursor.rb +2 -1
  59. data/lib/fantasy/disk.rb +12 -8
  60. data/lib/fantasy/draggable.rb +22 -1
  61. data/lib/fantasy/global.rb +59 -31
  62. data/lib/fantasy/hud_image.rb +5 -3
  63. data/lib/fantasy/hud_text.rb +6 -2
  64. data/lib/fantasy/image.rb +12 -4
  65. data/lib/fantasy/includes/gravitier.rb +2 -0
  66. data/lib/fantasy/includes/jumper.rb +3 -2
  67. data/lib/fantasy/includes/log.rb +12 -0
  68. data/lib/fantasy/includes/move_by_cursors.rb +24 -15
  69. data/lib/fantasy/includes/move_by_direction.rb +2 -0
  70. data/lib/fantasy/includes/mover.rb +3 -0
  71. data/lib/fantasy/includes/user_inputs.rb +6 -0
  72. data/lib/fantasy/loop.rb +41 -44
  73. data/lib/fantasy/mouse.rb +2 -0
  74. data/lib/fantasy/music.rb +4 -2
  75. data/lib/fantasy/shape.rb +11 -2
  76. data/lib/fantasy/sound.rb +3 -1
  77. data/lib/fantasy/tilemap.rb +19 -13
  78. data/lib/fantasy/tween.rb +3 -1
  79. data/lib/fantasy/utils.rb +7 -13
  80. data/lib/fantasy/version.rb +1 -1
  81. data/lib/fantasy.rb +2 -0
  82. metadata +90 -4
  83. data/fantasy.gemspec +0 -40
  84. data/fonts/VT323-Regular.ttf +0 -0
data/docs/Background.html ADDED
@@ -0,0 +1,961 @@
1
+ <!DOCTYPE html>
2
+ <html>
3
+ <head>
4
+ <meta charset="utf-8">
5
+ <meta name="viewport" content="width=device-width, initial-scale=1.0">
6
+ <title>
7
+ Class: Background
8
+
9
+ &mdash; Documentation by YARD 0.9.27
10
+
11
+ </title>
12
+
13
+ <link rel="stylesheet" href="css/style.css" type="text/css" />
14
+
15
+ <link rel="stylesheet" href="css/common.css" type="text/css" />
16
+
17
+ <script type="text/javascript">
18
+ pathId = "Background";
19
+ relpath = '';
20
+ </script>
21
+
22
+
23
+ <script type="text/javascript" charset="utf-8" src="js/jquery.js"></script>
24
+
25
+ <script type="text/javascript" charset="utf-8" src="js/app.js"></script>
26
+
27
+
28
+ </head>
29
+ <body>
30
+ <div class="nav_wrap">
31
+ <iframe id="nav" src="class_list.html?1"></iframe>
32
+ <div id="resizer"></div>
33
+ </div>
34
+
35
+ <div id="main" tabindex="-1">
36
+ <div id="header">
37
+ <div id="menu">
38
+
39
+ <a href="_index.html">Index (B)</a> &raquo;
40
+
41
+
42
+ <span class="title">Background</span>
43
+
44
+ </div>
45
+
46
+ <div id="search">
47
+
48
+ <a class="full_list_link" id="class_list_link"
49
+ href="class_list.html">
50
+
51
+ <svg width="24" height="24">
52
+ <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
53
+ <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
54
+ <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
55
+ </svg>
56
+ </a>
57
+
58
+ </div>
59
+ <div class="clear"></div>
60
+ </div>
61
+
62
+ <div id="content"><h1>Class: Background
63
+
64
+
65
+
66
+ </h1>
67
+ <div class="box_info">
68
+
69
+ <dl>
70
+ <dt>Inherits:</dt>
71
+ <dd>
72
+ <span class="inheritName">Object</span>
73
+
74
+ <ul class="fullTree">
75
+ <li>Object</li>
76
+
77
+ <li class="next">Background</li>
78
+
79
+ </ul>
80
+ <a href="#" class="inheritanceTree">show all</a>
81
+
82
+ </dd>
83
+ </dl>
84
+
85
+
86
+
87
+
88
+
89
+
90
+
91
+
92
+
93
+
94
+
95
+ <dl>
96
+ <dt>Defined in:</dt>
97
+ <dd>lib/fantasy/background.rb</dd>
98
+ </dl>
99
+
100
+ </div>
101
+
102
+ <h2>Overview</h2><div class="docstring">
103
+ <div class="discussion">
104
+ <p>Represents on static image that will be rendered on every frame.
105
+ Replicable (by default).
106
+ The position is relative to <code>Camera.main</code>.</p>
107
+
108
+ <pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_on_game'><span class='object_link'><a href="top-level-namespace.html#on_game-instance_method" title="#on_game (method)">on_game</a></span></span> <span class='kw'>do</span>
109
+ <span class='id identifier rubyid_background'>background</span> <span class='op'>=</span> <span class='const'>Background</span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="#initialize-instance_method" title="Background#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>image_name:</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>beach</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span>
110
+ <span class='comment'># background.replicable = false # if you don&#39;t want the image to replicate
111
+ </span> <span class='id identifier rubyid_background'>background</span><span class='period'>.</span><span class='id identifier rubyid_scale'>scale</span> <span class='op'>=</span> <span class='int'>6</span>
112
+ <span class='kw'>end</span>
113
+ </code></pre>
114
+
115
+
116
+ </div>
117
+ </div>
118
+ <div class="tags">
119
+
120
+
121
+ </div>
122
+
123
+
124
+
125
+ <h2>Instance Attribute Summary <small><a href="#" class="summary_toggle">collapse</a></small></h2>
126
+ <ul class="summary">
127
+
128
+ <li class="public ">
129
+ <span class="summary_signature">
130
+
131
+ <a href="#layer-instance_method" title="#layer (instance method)">#<strong>layer</strong> &#x21d2; Object </a>
132
+
133
+
134
+
135
+ </span>
136
+
137
+
138
+
139
+
140
+
141
+
142
+
143
+
144
+
145
+
146
+
147
+
148
+ <span class="summary_desc"><div class='inline'><p>In which layer the image of the Background is rendered.</p>
149
+ </div></span>
150
+
151
+ </li>
152
+
153
+
154
+ <li class="public ">
155
+ <span class="summary_signature">
156
+
157
+ <a href="#position-instance_method" title="#position (instance method)">#<strong>position</strong> &#x21d2; Object </a>
158
+
159
+
160
+
161
+ </span>
162
+
163
+
164
+
165
+
166
+
167
+
168
+
169
+
170
+
171
+
172
+
173
+
174
+ <span class="summary_desc"><div class='inline'><p>Coordinates object where x and y represent the position of the Background in the World (no necessarily in the Screen).</p>
175
+ </div></span>
176
+
177
+ </li>
178
+
179
+
180
+ <li class="public ">
181
+ <span class="summary_signature">
182
+
183
+ <a href="#replicable-instance_method" title="#replicable (instance method)">#<strong>replicable</strong> &#x21d2; Object </a>
184
+
185
+
186
+
187
+ </span>
188
+
189
+
190
+
191
+
192
+
193
+
194
+
195
+
196
+
197
+
198
+
199
+
200
+ <span class="summary_desc"><div class='inline'><p>[Boolean] When <code>true</code> the image will replicate itself to cover all the screen.</p>
201
+ </div></span>
202
+
203
+ </li>
204
+
205
+
206
+ <li class="public ">
207
+ <span class="summary_signature">
208
+
209
+ <a href="#scale-instance_method" title="#scale (instance method)">#<strong>scale</strong> &#x21d2; Object </a>
210
+
211
+
212
+
213
+ </span>
214
+
215
+
216
+
217
+
218
+
219
+
220
+
221
+
222
+
223
+
224
+
225
+
226
+ <span class="summary_desc"><div class='inline'><p>The value to scale the image of the Background when drawn.</p>
227
+ </div></span>
228
+
229
+ </li>
230
+
231
+
232
+ <li class="public ">
233
+ <span class="summary_signature">
234
+
235
+ <a href="#visible-instance_method" title="#visible (instance method)">#<strong>visible</strong> &#x21d2; Object </a>
236
+
237
+
238
+
239
+ </span>
240
+
241
+
242
+
243
+
244
+
245
+
246
+
247
+
248
+
249
+
250
+
251
+
252
+ <span class="summary_desc"><div class='inline'><p>When <code>false</code> the Background won&#39;t be rendered in the next frame.</p>
253
+ </div></span>
254
+
255
+ </li>
256
+
257
+
258
+ </ul>
259
+
260
+
261
+
262
+
263
+
264
+ <h2>
265
+ Instance Method Summary
266
+ <small><a href="#" class="summary_toggle">collapse</a></small>
267
+ </h2>
268
+
269
+ <ul class="summary">
270
+
271
+ <li class="public ">
272
+ <span class="summary_signature">
273
+
274
+ <a href="#destroy-instance_method" title="#destroy (instance method)">#<strong>destroy</strong> &#x21d2; Object </a>
275
+
276
+
277
+
278
+ </span>
279
+
280
+
281
+
282
+
283
+
284
+
285
+
286
+
287
+
288
+ <span class="summary_desc"><div class='inline'><p>Destroy this Background and it will not longer be rendered.</p>
289
+ </div></span>
290
+
291
+ </li>
292
+
293
+
294
+ <li class="public ">
295
+ <span class="summary_signature">
296
+
297
+ <a href="#height-instance_method" title="#height (instance method)">#<strong>height</strong> &#x21d2; Fixnum </a>
298
+
299
+
300
+
301
+ </span>
302
+
303
+
304
+
305
+
306
+
307
+
308
+
309
+
310
+
311
+ <span class="summary_desc"><div class='inline'><p>The Background height in pixels.</p>
312
+ </div></span>
313
+
314
+ </li>
315
+
316
+
317
+ <li class="public ">
318
+ <span class="summary_signature">
319
+
320
+ <a href="#initialize-instance_method" title="#initialize (instance method)">#<strong>initialize</strong>(image_name:) &#x21d2; Background </a>
321
+
322
+
323
+
324
+ </span>
325
+
326
+
327
+ <span class="note title constructor">constructor</span>
328
+
329
+
330
+
331
+
332
+
333
+
334
+
335
+
336
+ <span class="summary_desc"><div class='inline'><p>Generates an Background with all the below default values: - <strong>position</strong>: <code>Coordinates.zero</code>.</p>
337
+ </div></span>
338
+
339
+ </li>
340
+
341
+
342
+ <li class="public ">
343
+ <span class="summary_signature">
344
+
345
+ <a href="#width-instance_method" title="#width (instance method)">#<strong>width</strong> &#x21d2; Fixnum </a>
346
+
347
+
348
+
349
+ </span>
350
+
351
+
352
+
353
+
354
+
355
+
356
+
357
+
358
+
359
+ <span class="summary_desc"><div class='inline'><p>The Background width in pixels.</p>
360
+ </div></span>
361
+
362
+ </li>
363
+
364
+
365
+ </ul>
366
+
367
+
368
+ <div id="constructor_details" class="method_details_list">
369
+ <h2>Constructor Details</h2>
370
+
371
+ <div class="method_details first">
372
+ <h3 class="signature first" id="initialize-instance_method">
373
+
374
+ #<strong>initialize</strong>(image_name:) &#x21d2; <tt><span class='object_link'><a href="" title="Background (class)">Background</a></span></tt>
375
+
376
+
377
+
378
+
379
+
380
+ </h3><div class="docstring">
381
+ <div class="discussion">
382
+ <p>Generates an Background with all the below default values:</p>
383
+
384
+ <ul>
385
+ <li><strong>position</strong>: <code>Coordinates.zero</code>.</li>
386
+ <li><strong>scale</strong>: <code>1</code>.</li>
387
+ <li><strong>draggable_on_debug</strong>: <code>true</code>.</li>
388
+ <li><strong>layer</strong>: <code>-100</code>.</li>
389
+ <li><strong>image</strong>: The Image generated by <code>image_name</code></li>
390
+ <li><strong>name</strong>: Same as <code>image_name</code></li>
391
+ <li><strong>visible</strong>: <code>true</code></li>
392
+ <li><strong>replicable</strong>: <code>true</code></li>
393
+ </ul>
394
+
395
+
396
+ </div>
397
+ </div>
398
+ <div class="tags">
399
+
400
+ <div class="examples">
401
+ <p class="tag_title">Examples:</p>
402
+
403
+
404
+ <p class="example_title"><div class='inline'><p>Instantiate a new Background</p>
405
+ </div></p>
406
+
407
+ <pre class="example code"><code><span class='id identifier rubyid_background'>background</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="" title="Background (class)">Background</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>background</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span></code></pre>
408
+
409
+ </div>
410
+ <p class="tag_title">Parameters:</p>
411
+ <ul class="param">
412
+
413
+ <li>
414
+
415
+ <span class='name'>image_name</span>
416
+
417
+
418
+ <span class='type'>(<tt>string</tt>)</span>
419
+
420
+
421
+
422
+ &mdash;
423
+ <div class='inline'><p>the name of the image file from <code>./images/*</code></p>
424
+ </div>
425
+
426
+ </li>
427
+
428
+ </ul>
429
+
430
+
431
+ </div><table class="source_code">
432
+ <tr>
433
+ <td>
434
+ <pre class="lines">
435
+
436
+
437
+ 86
438
+ 87
439
+ 88
440
+ 89
441
+ 90
442
+ 91
443
+ 92
444
+ 93
445
+ 94
446
+ 95
447
+ 96
448
+ 97
449
+ 98</pre>
450
+ </td>
451
+ <td>
452
+ <pre class="code"><span class="info file"># File 'lib/fantasy/background.rb', line 86</span>
453
+
454
+ <span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='label'>image_name:</span><span class='rparen'>)</span>
455
+ <span class='ivar'>@image</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="Image.html" title="Image (class)">Image</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="Image.html#initialize-instance_method" title="Image#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='id identifier rubyid_image_name'>image_name</span><span class='rparen'>)</span>
456
+ <span class='ivar'>@name</span> <span class='op'>=</span> <span class='id identifier rubyid_image_name'>image_name</span>
457
+ <span class='ivar'>@position</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="Coordinates.html" title="Coordinates (class)">Coordinates</a></span></span><span class='period'>.</span><span class='id identifier rubyid_zero'><span class='object_link'><a href="Coordinates.html#zero-class_method" title="Coordinates.zero (method)">zero</a></span></span>
458
+ <span class='ivar'>@scale</span> <span class='op'>=</span> <span class='int'>1</span>
459
+ <span class='ivar'>@visible</span> <span class='op'>=</span> <span class='kw'>true</span>
460
+ <span class='ivar'>@draggable_on_debug</span> <span class='op'>=</span> <span class='kw'>true</span>
461
+ <span class='ivar'>@dragging</span> <span class='op'>=</span> <span class='kw'>false</span>
462
+ <span class='ivar'>@layer</span> <span class='op'>=</span> <span class='op'>-</span><span class='int'>100</span>
463
+ <span class='ivar'>@replicable</span> <span class='op'>=</span> <span class='kw'>true</span>
464
+
465
+ <span class='const'><span class='object_link'><a href="Global.html" title="Global (module)">Global</a></span></span><span class='period'>.</span><span class='id identifier rubyid_backgrounds'><span class='object_link'><a href="Global.html#backgrounds-class_method" title="Global.backgrounds (method)">backgrounds</a></span></span><span class='period'>.</span><span class='id identifier rubyid_push'>push</span><span class='lparen'>(</span><span class='kw'>self</span><span class='rparen'>)</span>
466
+ <span class='kw'>end</span></pre>
467
+ </td>
468
+ </tr>
469
+ </table>
470
+ </div>
471
+
472
+ </div>
473
+
474
+ <div id="instance_attr_details" class="attr_details">
475
+ <h2>Instance Attribute Details</h2>
476
+
477
+
478
+ <span id="layer=-instance_method"></span>
479
+ <div class="method_details first">
480
+ <h3 class="signature first" id="layer-instance_method">
481
+
482
+ #<strong>layer</strong> &#x21d2; <tt>Object</tt>
483
+
484
+
485
+
486
+
487
+
488
+ </h3><div class="docstring">
489
+ <div class="discussion">
490
+ <p>In which layer the image of the Background is rendered.
491
+ Smaller numbers are rendered behind higher numbers.</p>
492
+
493
+ <p>Default <code>-100</code>.</p>
494
+
495
+
496
+ </div>
497
+ </div>
498
+ <div class="tags">
499
+
500
+ <div class="examples">
501
+ <p class="tag_title">Examples:</p>
502
+
503
+
504
+ <p class="example_title"><div class='inline'><p>Set layer</p>
505
+ </div></p>
506
+
507
+ <pre class="example code"><code><span class='id identifier rubyid_background'>background</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="" title="Background (class)">Background</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="#initialize-instance_method" title="Background#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>image</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span>
508
+ <span class='id identifier rubyid_background'>background</span><span class='period'>.</span><span class='id identifier rubyid_layer'>layer</span> <span class='op'>=</span> <span class='op'>-</span><span class='int'>50</span></code></pre>
509
+
510
+ </div>
511
+
512
+
513
+ </div><table class="source_code">
514
+ <tr>
515
+ <td>
516
+ <pre class="lines">
517
+
518
+
519
+ 23
520
+ 24
521
+ 25</pre>
522
+ </td>
523
+ <td>
524
+ <pre class="code"><span class="info file"># File 'lib/fantasy/background.rb', line 23</span>
525
+
526
+ <span class='kw'>def</span> <span class='id identifier rubyid_layer'>layer</span>
527
+ <span class='ivar'>@layer</span>
528
+ <span class='kw'>end</span></pre>
529
+ </td>
530
+ </tr>
531
+ </table>
532
+ </div>
533
+
534
+
535
+ <span id="position=-instance_method"></span>
536
+ <div class="method_details ">
537
+ <h3 class="signature " id="position-instance_method">
538
+
539
+ #<strong>position</strong> &#x21d2; <tt>Object</tt>
540
+
541
+
542
+
543
+
544
+
545
+ </h3><div class="docstring">
546
+ <div class="discussion">
547
+ <p>Coordinates object where x and y represent the position of the Background in the World
548
+ (no necessarily in the Screen).</p>
549
+
550
+ <p>Default <code>Coordinates.zero</code>.</p>
551
+
552
+
553
+ </div>
554
+ </div>
555
+ <div class="tags">
556
+
557
+ <div class="examples">
558
+ <p class="tag_title">Examples:</p>
559
+
560
+
561
+ <p class="example_title"><div class='inline'><p>Setting position</p>
562
+ </div></p>
563
+
564
+ <pre class="example code"><code><span class='id identifier rubyid_background'>background</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="" title="Background (class)">Background</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="#initialize-instance_method" title="Background#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>image</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span>
565
+ <span class='id identifier rubyid_background'>background</span><span class='period'>.</span><span class='id identifier rubyid_position'>position</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="Coordinates.html" title="Coordinates (class)">Coordinates</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='int'>10</span><span class='comma'>,</span> <span class='int'>20</span><span class='rparen'>)</span>
566
+ <span class='id identifier rubyid_background'>background</span><span class='period'>.</span><span class='id identifier rubyid_position'>position</span><span class='period'>.</span><span class='id identifier rubyid_x'>x</span> <span class='comment'># =&gt; 10</span></code></pre>
567
+
568
+
569
+ <p class="example_title"><div class='inline'><p>Modify position</p>
570
+ </div></p>
571
+
572
+ <pre class="example code"><code><span class='id identifier rubyid_background'>background</span><span class='period'>.</span><span class='id identifier rubyid_position'>position</span><span class='period'>.</span><span class='id identifier rubyid_x'>x</span> <span class='op'>+=</span> <span class='int'>1</span>
573
+ <span class='id identifier rubyid_background'>background</span><span class='period'>.</span><span class='id identifier rubyid_position'>position</span><span class='period'>.</span><span class='id identifier rubyid_x'>x</span> <span class='comment'># =&gt; 11</span></code></pre>
574
+
575
+ </div>
576
+
577
+
578
+ </div><table class="source_code">
579
+ <tr>
580
+ <td>
581
+ <pre class="lines">
582
+
583
+
584
+ 39
585
+ 40
586
+ 41</pre>
587
+ </td>
588
+ <td>
589
+ <pre class="code"><span class="info file"># File 'lib/fantasy/background.rb', line 39</span>
590
+
591
+ <span class='kw'>def</span> <span class='id identifier rubyid_position'>position</span>
592
+ <span class='ivar'>@position</span>
593
+ <span class='kw'>end</span></pre>
594
+ </td>
595
+ </tr>
596
+ </table>
597
+ </div>
598
+
599
+
600
+ <span id="replicable=-instance_method"></span>
601
+ <div class="method_details ">
602
+ <h3 class="signature " id="replicable-instance_method">
603
+
604
+ #<strong>replicable</strong> &#x21d2; <tt>Object</tt>
605
+
606
+
607
+
608
+
609
+
610
+ </h3><div class="docstring">
611
+ <div class="discussion">
612
+ <p>[Boolean] When <code>true</code> the image will replicate itself to cover all the screen. Default <code>true</code>.</p>
613
+
614
+ <p>Default <code>true</code>.</p>
615
+
616
+
617
+ </div>
618
+ </div>
619
+ <div class="tags">
620
+
621
+ <div class="examples">
622
+ <p class="tag_title">Examples:</p>
623
+
624
+
625
+ <p class="example_title"><div class='inline'><p>Setting replicable</p>
626
+ </div></p>
627
+
628
+ <pre class="example code"><code><span class='id identifier rubyid_background'>background</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="" title="Background (class)">Background</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="#initialize-instance_method" title="Background#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>image</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span>
629
+ <span class='id identifier rubyid_background'>background</span><span class='period'>.</span><span class='id identifier rubyid_replicable'>replicable</span> <span class='op'>=</span> <span class='kw'>false</span></code></pre>
630
+
631
+ </div>
632
+
633
+
634
+ </div><table class="source_code">
635
+ <tr>
636
+ <td>
637
+ <pre class="lines">
638
+
639
+
640
+ 48
641
+ 49
642
+ 50</pre>
643
+ </td>
644
+ <td>
645
+ <pre class="code"><span class="info file"># File 'lib/fantasy/background.rb', line 48</span>
646
+
647
+ <span class='kw'>def</span> <span class='id identifier rubyid_replicable'>replicable</span>
648
+ <span class='ivar'>@replicable</span>
649
+ <span class='kw'>end</span></pre>
650
+ </td>
651
+ </tr>
652
+ </table>
653
+ </div>
654
+
655
+
656
+ <span id="scale=-instance_method"></span>
657
+ <div class="method_details ">
658
+ <h3 class="signature " id="scale-instance_method">
659
+
660
+ #<strong>scale</strong> &#x21d2; <tt>Object</tt>
661
+
662
+
663
+
664
+
665
+
666
+ </h3><div class="docstring">
667
+ <div class="discussion">
668
+
669
+ <div class="note notetag">
670
+ <strong>Note:</strong>
671
+ <div class='inline'><p>this value affects the attributes <code>width</code> and <code>height</code></p>
672
+ </div>
673
+ </div>
674
+
675
+ <p>The value to scale the image of the Background when drawn.
676
+ If the value is <code>2</code> the image will rendered at double of size.
677
+ If the value is <code>0.5</code> the image will rendered at half of size.</p>
678
+
679
+ <p>Default <code>1</code>.</p>
680
+
681
+
682
+ </div>
683
+ </div>
684
+ <div class="tags">
685
+
686
+ <div class="examples">
687
+ <p class="tag_title">Examples:</p>
688
+
689
+
690
+ <p class="example_title"><div class='inline'><p>Set scale</p>
691
+ </div></p>
692
+
693
+ <pre class="example code"><code><span class='id identifier rubyid_background'>background</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="" title="Background (class)">Background</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="#initialize-instance_method" title="Background#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>image</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span>
694
+ <span class='id identifier rubyid_background'>background</span><span class='period'>.</span><span class='id identifier rubyid_scale'>scale</span> <span class='op'>=</span> <span class='int'>6</span></code></pre>
695
+
696
+ </div>
697
+
698
+
699
+ </div><table class="source_code">
700
+ <tr>
701
+ <td>
702
+ <pre class="lines">
703
+
704
+
705
+ 61
706
+ 62
707
+ 63</pre>
708
+ </td>
709
+ <td>
710
+ <pre class="code"><span class="info file"># File 'lib/fantasy/background.rb', line 61</span>
711
+
712
+ <span class='kw'>def</span> <span class='id identifier rubyid_scale'>scale</span>
713
+ <span class='ivar'>@scale</span>
714
+ <span class='kw'>end</span></pre>
715
+ </td>
716
+ </tr>
717
+ </table>
718
+ </div>
719
+
720
+
721
+ <span id="visible=-instance_method"></span>
722
+ <div class="method_details ">
723
+ <h3 class="signature " id="visible-instance_method">
724
+
725
+ #<strong>visible</strong> &#x21d2; <tt>Object</tt>
726
+
727
+
728
+
729
+
730
+
731
+ </h3><div class="docstring">
732
+ <div class="discussion">
733
+ <p>When <code>false</code> the Background won&#39;t be rendered in the next frame.</p>
734
+
735
+ <p>Default <code>true</code>.</p>
736
+
737
+
738
+ </div>
739
+ </div>
740
+ <div class="tags">
741
+
742
+ <div class="examples">
743
+ <p class="tag_title">Examples:</p>
744
+
745
+
746
+ <p class="example_title"><div class='inline'><p>Set visible</p>
747
+ </div></p>
748
+
749
+ <pre class="example code"><code><span class='id identifier rubyid_background'>background</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="" title="Background (class)">Background</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="#initialize-instance_method" title="Background#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>image</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span>
750
+ <span class='id identifier rubyid_background'>background</span><span class='period'>.</span><span class='id identifier rubyid_visible'>visible</span> <span class='op'>=</span> <span class='kw'>false</span></code></pre>
751
+
752
+ </div>
753
+
754
+
755
+ </div><table class="source_code">
756
+ <tr>
757
+ <td>
758
+ <pre class="lines">
759
+
760
+
761
+ 70
762
+ 71
763
+ 72</pre>
764
+ </td>
765
+ <td>
766
+ <pre class="code"><span class="info file"># File 'lib/fantasy/background.rb', line 70</span>
767
+
768
+ <span class='kw'>def</span> <span class='id identifier rubyid_visible'>visible</span>
769
+ <span class='ivar'>@visible</span>
770
+ <span class='kw'>end</span></pre>
771
+ </td>
772
+ </tr>
773
+ </table>
774
+ </div>
775
+
776
+ </div>
777
+
778
+
779
+ <div id="instance_method_details" class="method_details_list">
780
+ <h2>Instance Method Details</h2>
781
+
782
+
783
+ <div class="method_details first">
784
+ <h3 class="signature first" id="destroy-instance_method">
785
+
786
+ #<strong>destroy</strong> &#x21d2; <tt>Object</tt>
787
+
788
+
789
+
790
+
791
+
792
+ </h3><div class="docstring">
793
+ <div class="discussion">
794
+ <p>Destroy this Background and it will not longer be rendered</p>
795
+
796
+
797
+ </div>
798
+ </div>
799
+ <div class="tags">
800
+
801
+ <div class="examples">
802
+ <p class="tag_title">Examples:</p>
803
+
804
+
805
+ <p class="example_title"><div class='inline'><p>Destroy a Background</p>
806
+ </div></p>
807
+
808
+ <pre class="example code"><code><span class='id identifier rubyid_background'>background</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="" title="Background (class)">Background</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="#initialize-instance_method" title="Background#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>background</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span>
809
+ <span class='id identifier rubyid_background'>background</span><span class='period'>.</span><span class='id identifier rubyid_destroy'>destroy</span></code></pre>
810
+
811
+ </div>
812
+
813
+
814
+ </div><table class="source_code">
815
+ <tr>
816
+ <td>
817
+ <pre class="lines">
818
+
819
+
820
+ 129
821
+ 130
822
+ 131</pre>
823
+ </td>
824
+ <td>
825
+ <pre class="code"><span class="info file"># File 'lib/fantasy/background.rb', line 129</span>
826
+
827
+ <span class='kw'>def</span> <span class='id identifier rubyid_destroy'>destroy</span>
828
+ <span class='const'><span class='object_link'><a href="Global.html" title="Global (module)">Global</a></span></span><span class='period'>.</span><span class='id identifier rubyid_backgrounds'><span class='object_link'><a href="Global.html#backgrounds-class_method" title="Global.backgrounds (method)">backgrounds</a></span></span><span class='period'>.</span><span class='id identifier rubyid_delete'>delete</span><span class='lparen'>(</span><span class='kw'>self</span><span class='rparen'>)</span>
829
+ <span class='kw'>end</span></pre>
830
+ </td>
831
+ </tr>
832
+ </table>
833
+ </div>
834
+
835
+ <div class="method_details ">
836
+ <h3 class="signature " id="height-instance_method">
837
+
838
+ #<strong>height</strong> &#x21d2; <tt>Fixnum</tt>
839
+
840
+
841
+
842
+
843
+
844
+ </h3><div class="docstring">
845
+ <div class="discussion">
846
+ <p>Returns the Background height in pixels.</p>
847
+
848
+
849
+ </div>
850
+ </div>
851
+ <div class="tags">
852
+
853
+ <p class="tag_title">Returns:</p>
854
+ <ul class="return">
855
+
856
+ <li>
857
+
858
+
859
+ <span class='type'>(<tt>Fixnum</tt>)</span>
860
+
861
+
862
+
863
+ &mdash;
864
+ <div class='inline'><p>the Background height in pixels</p>
865
+ </div>
866
+
867
+ </li>
868
+
869
+ </ul>
870
+
871
+ </div><table class="source_code">
872
+ <tr>
873
+ <td>
874
+ <pre class="lines">
875
+
876
+
877
+ 106
878
+ 107
879
+ 108</pre>
880
+ </td>
881
+ <td>
882
+ <pre class="code"><span class="info file"># File 'lib/fantasy/background.rb', line 106</span>
883
+
884
+ <span class='kw'>def</span> <span class='id identifier rubyid_height'>height</span>
885
+ <span class='ivar'>@image</span><span class='period'>.</span><span class='id identifier rubyid_height'>height</span> <span class='op'>*</span> <span class='ivar'>@scale</span>
886
+ <span class='kw'>end</span></pre>
887
+ </td>
888
+ </tr>
889
+ </table>
890
+ </div>
891
+
892
+ <div class="method_details ">
893
+ <h3 class="signature " id="width-instance_method">
894
+
895
+ #<strong>width</strong> &#x21d2; <tt>Fixnum</tt>
896
+
897
+
898
+
899
+
900
+
901
+ </h3><div class="docstring">
902
+ <div class="discussion">
903
+ <p>Returns the Background width in pixels.</p>
904
+
905
+
906
+ </div>
907
+ </div>
908
+ <div class="tags">
909
+
910
+ <p class="tag_title">Returns:</p>
911
+ <ul class="return">
912
+
913
+ <li>
914
+
915
+
916
+ <span class='type'>(<tt>Fixnum</tt>)</span>
917
+
918
+
919
+
920
+ &mdash;
921
+ <div class='inline'><p>the Background width in pixels</p>
922
+ </div>
923
+
924
+ </li>
925
+
926
+ </ul>
927
+
928
+ </div><table class="source_code">
929
+ <tr>
930
+ <td>
931
+ <pre class="lines">
932
+
933
+
934
+ 101
935
+ 102
936
+ 103</pre>
937
+ </td>
938
+ <td>
939
+ <pre class="code"><span class="info file"># File 'lib/fantasy/background.rb', line 101</span>
940
+
941
+ <span class='kw'>def</span> <span class='id identifier rubyid_width'>width</span>
942
+ <span class='ivar'>@image</span><span class='period'>.</span><span class='id identifier rubyid_width'>width</span> <span class='op'>*</span> <span class='ivar'>@scale</span>
943
+ <span class='kw'>end</span></pre>
944
+ </td>
945
+ </tr>
946
+ </table>
947
+ </div>
948
+
949
+ </div>
950
+
951
+ </div>
952
+
953
+ <div id="footer">
954
+ Generated on Sat Apr 2 14:24:12 2022 by
955
+ <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
956
+ 0.9.27 (ruby-3.0.2).
957
+ </div>
958
+
959
+ </div>
960
+ </body>
961
+ </html>