felecs 5.0.0 → 5.0.1

Sign up to get free protection for your applications and to get access to all the features.
@@ -1,765 +0,0 @@
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: FelFlame::Scenes
8
-
9
- &mdash; Documentation by YARD 0.9.26
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 = "FelFlame::Scenes";
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 (S)</a> &raquo;
40
- <span class='title'><span class='object_link'><a href="../FelFlame.html" title="FelFlame (module)">FelFlame</a></span></span>
41
- &raquo;
42
- <span class="title">Scenes</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: FelFlame::Scenes
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">FelFlame::Scenes</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/felflame.rb<span class="defines">,<br />
98
- lib/felflame/scene_manager.rb</span>
99
- </dd>
100
- </dl>
101
-
102
- </div>
103
-
104
- <h2>Overview</h2><div class="docstring">
105
- <div class="discussion">
106
-
107
- <p>Creates and manages Scenes. Scenes are collections of Systems, and execute all the Systems when called upon. Any scenes you create are accessable under the <span class='object_link'><a href="" title="FelFlame::Scenes (class)">Scenes</a></span> namespace as Constants.</p>
108
-
109
-
110
- </div>
111
- </div>
112
- <div class="tags">
113
-
114
-
115
- </div>
116
-
117
-
118
-
119
- <h2>Instance Attribute Summary <small><a href="#" class="summary_toggle">collapse</a></small></h2>
120
- <ul class="summary">
121
-
122
- <li class="public ">
123
- <span class="summary_signature">
124
-
125
- <a href="#priority-instance_method" title="#priority (instance method)">#<strong>priority</strong> &#x21d2; Object </a>
126
-
127
-
128
-
129
- </span>
130
-
131
-
132
-
133
-
134
-
135
-
136
-
137
-
138
-
139
-
140
-
141
-
142
- <span class="summary_desc"><div class='inline'>
143
- <p>How early this Scene should be executed in a list of Scenes.</p>
144
- </div></span>
145
-
146
- </li>
147
-
148
-
149
- <li class="public ">
150
- <span class="summary_signature">
151
-
152
- <a href="#systems-instance_method" title="#systems (instance method)">#<strong>systems</strong> &#x21d2; Array&lt;System&gt; </a>
153
-
154
-
155
-
156
- </span>
157
-
158
-
159
-
160
-
161
- <span class="note title readonly">readonly</span>
162
-
163
-
164
-
165
-
166
-
167
-
168
-
169
-
170
-
171
- <span class="summary_desc"><div class='inline'>
172
- <p>The list of Systems this Scene contains.</p>
173
- </div></span>
174
-
175
- </li>
176
-
177
-
178
- </ul>
179
-
180
-
181
-
182
-
183
-
184
- <h2>
185
- Instance Method Summary
186
- <small><a href="#" class="summary_toggle">collapse</a></small>
187
- </h2>
188
-
189
- <ul class="summary">
190
-
191
- <li class="public ">
192
- <span class="summary_signature">
193
-
194
- <a href="#add-instance_method" title="#add (instance method)">#<strong>add</strong>(*systems_to_add) &#x21d2; Boolean </a>
195
-
196
-
197
-
198
- </span>
199
-
200
-
201
-
202
-
203
-
204
-
205
-
206
-
207
-
208
- <span class="summary_desc"><div class='inline'>
209
- <p>Adds any number of Systems to this Scene.</p>
210
- </div></span>
211
-
212
- </li>
213
-
214
-
215
- <li class="public ">
216
- <span class="summary_signature">
217
-
218
- <a href="#call-instance_method" title="#call (instance method)">#<strong>call</strong> &#x21d2; Boolean </a>
219
-
220
-
221
-
222
- </span>
223
-
224
-
225
-
226
-
227
-
228
-
229
-
230
-
231
-
232
- <span class="summary_desc"><div class='inline'>
233
- <p>Execute all systems in this Scene, in the order of their priority.</p>
234
- </div></span>
235
-
236
- </li>
237
-
238
-
239
- <li class="public ">
240
- <span class="summary_signature">
241
-
242
- <a href="#clear-instance_method" title="#clear (instance method)">#<strong>clear</strong> &#x21d2; Boolean </a>
243
-
244
-
245
-
246
- </span>
247
-
248
-
249
-
250
-
251
-
252
-
253
-
254
-
255
-
256
- <span class="summary_desc"><div class='inline'>
257
- <p>Removes all Systems from this Scene.</p>
258
- </div></span>
259
-
260
- </li>
261
-
262
-
263
- <li class="public ">
264
- <span class="summary_signature">
265
-
266
- <a href="#initialize-instance_method" title="#initialize (instance method)">#<strong>initialize</strong>(name, priority: 0) &#x21d2; Scenes </a>
267
-
268
-
269
-
270
- </span>
271
-
272
-
273
- <span class="note title constructor">constructor</span>
274
-
275
-
276
-
277
-
278
-
279
-
280
-
281
-
282
- <span class="summary_desc"><div class='inline'>
283
- <p>Create a new Scene using the name given.</p>
284
- </div></span>
285
-
286
- </li>
287
-
288
-
289
- <li class="public ">
290
- <span class="summary_signature">
291
-
292
- <a href="#remove-instance_method" title="#remove (instance method)">#<strong>remove</strong>(*systems_to_remove) &#x21d2; Boolean </a>
293
-
294
-
295
-
296
- </span>
297
-
298
-
299
-
300
-
301
-
302
-
303
-
304
-
305
-
306
- <span class="summary_desc"><div class='inline'>
307
- <p>Removes any number of Systems from this Scene.</p>
308
- </div></span>
309
-
310
- </li>
311
-
312
-
313
- </ul>
314
-
315
-
316
- <div id="constructor_details" class="method_details_list">
317
- <h2>Constructor Details</h2>
318
-
319
- <div class="method_details first">
320
- <h3 class="signature first" id="initialize-instance_method">
321
-
322
- #<strong>initialize</strong>(name, priority: 0) &#x21d2; <tt><span class='object_link'><a href="" title="FelFlame::Scenes (class)">Scenes</a></span></tt>
323
-
324
-
325
-
326
-
327
-
328
- </h3><div class="docstring">
329
- <div class="discussion">
330
-
331
- <p>Create a new Scene using the name given</p>
332
-
333
-
334
- </div>
335
- </div>
336
- <div class="tags">
337
- <p class="tag_title">Parameters:</p>
338
- <ul class="param">
339
-
340
- <li>
341
-
342
- <span class='name'>name</span>
343
-
344
-
345
- <span class='type'>(<tt>String</tt>)</span>
346
-
347
-
348
-
349
- &mdash;
350
- <div class='inline'>
351
- <p>String format must follow requirements of a constant</p>
352
- </div>
353
-
354
- </li>
355
-
356
- </ul>
357
-
358
-
359
- </div><table class="source_code">
360
- <tr>
361
- <td>
362
- <pre class="lines">
363
-
364
-
365
- 22
366
- 23
367
- 24
368
- 25</pre>
369
- </td>
370
- <td>
371
- <pre class="code"><span class="info file"># File 'lib/felflame/scene_manager.rb', line 22</span>
372
-
373
- <span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='id identifier rubyid_name'>name</span><span class='comma'>,</span> <span class='label'>priority:</span> <span class='int'>0</span><span class='rparen'>)</span>
374
- <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_priority'>priority</span> <span class='op'>=</span> <span class='id identifier rubyid_priority'>priority</span>
375
- <span class='const'><span class='object_link'><a href="../FelFlame.html" title="FelFlame (module)">FelFlame</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="" title="FelFlame::Scenes (class)">Scenes</a></span></span><span class='period'>.</span><span class='id identifier rubyid_const_set'>const_set</span><span class='lparen'>(</span><span class='id identifier rubyid_name'>name</span><span class='comma'>,</span> <span class='kw'>self</span><span class='rparen'>)</span>
376
- <span class='kw'>end</span></pre>
377
- </td>
378
- </tr>
379
- </table>
380
- </div>
381
-
382
- </div>
383
-
384
- <div id="instance_attr_details" class="attr_details">
385
- <h2>Instance Attribute Details</h2>
386
-
387
-
388
- <span id="priority=-instance_method"></span>
389
- <div class="method_details first">
390
- <h3 class="signature first" id="priority-instance_method">
391
-
392
- #<strong>priority</strong> &#x21d2; <tt>Object</tt>
393
-
394
-
395
-
396
-
397
-
398
- </h3><div class="docstring">
399
- <div class="discussion">
400
-
401
- <p>How early this Scene should be executed in a list of Scenes</p>
402
-
403
-
404
- </div>
405
- </div>
406
- <div class="tags">
407
-
408
-
409
- </div><table class="source_code">
410
- <tr>
411
- <td>
412
- <pre class="lines">
413
-
414
-
415
- 12
416
- 13
417
- 14</pre>
418
- </td>
419
- <td>
420
- <pre class="code"><span class="info file"># File 'lib/felflame/scene_manager.rb', line 12</span>
421
-
422
- <span class='kw'>def</span> <span class='id identifier rubyid_priority'>priority</span>
423
- <span class='ivar'>@priority</span>
424
- <span class='kw'>end</span></pre>
425
- </td>
426
- </tr>
427
- </table>
428
- </div>
429
-
430
-
431
- <span id="systems=-instance_method"></span>
432
- <div class="method_details ">
433
- <h3 class="signature " id="systems-instance_method">
434
-
435
- #<strong>systems</strong> &#x21d2; <tt>Array&lt;System&gt;</tt>
436
-
437
-
438
-
439
-
440
-
441
- </h3><div class="docstring">
442
- <div class="discussion">
443
-
444
- <p>The list of Systems this Scene contains</p>
445
-
446
-
447
- </div>
448
- </div>
449
- <div class="tags">
450
-
451
- <p class="tag_title">Returns:</p>
452
- <ul class="return">
453
-
454
- <li>
455
-
456
-
457
- <span class='type'>(<tt>Array&lt;System&gt;</tt>)</span>
458
-
459
-
460
-
461
- </li>
462
-
463
- </ul>
464
-
465
- </div><table class="source_code">
466
- <tr>
467
- <td>
468
- <pre class="lines">
469
-
470
-
471
- 29
472
- 30
473
- 31</pre>
474
- </td>
475
- <td>
476
- <pre class="code"><span class="info file"># File 'lib/felflame/scene_manager.rb', line 29</span>
477
-
478
- <span class='kw'>def</span> <span class='id identifier rubyid_systems'>systems</span>
479
- <span class='ivar'>@systems</span> <span class='op'>||=</span> <span class='lbracket'>[</span><span class='rbracket'>]</span>
480
- <span class='kw'>end</span></pre>
481
- </td>
482
- </tr>
483
- </table>
484
- </div>
485
-
486
- </div>
487
-
488
-
489
- <div id="instance_method_details" class="method_details_list">
490
- <h2>Instance Method Details</h2>
491
-
492
-
493
- <div class="method_details first">
494
- <h3 class="signature first" id="add-instance_method">
495
-
496
- #<strong>add</strong>(*systems_to_add) &#x21d2; <tt>Boolean</tt>
497
-
498
-
499
-
500
-
501
-
502
- </h3><div class="docstring">
503
- <div class="discussion">
504
-
505
- <p>Adds any number of Systems to this Scene</p>
506
-
507
-
508
- </div>
509
- </div>
510
- <div class="tags">
511
-
512
- <p class="tag_title">Returns:</p>
513
- <ul class="return">
514
-
515
- <li>
516
-
517
-
518
- <span class='type'>(<tt>Boolean</tt>)</span>
519
-
520
-
521
-
522
- &mdash;
523
- <div class='inline'>
524
- <p><code>true</code></p>
525
- </div>
526
-
527
- </li>
528
-
529
- </ul>
530
-
531
- </div><table class="source_code">
532
- <tr>
533
- <td>
534
- <pre class="lines">
535
-
536
-
537
- 42
538
- 43
539
- 44
540
- 45
541
- 46
542
- 47
543
- 48
544
- 49</pre>
545
- </td>
546
- <td>
547
- <pre class="code"><span class="info file"># File 'lib/felflame/scene_manager.rb', line 42</span>
548
-
549
- <span class='kw'>def</span> <span class='id identifier rubyid_add'>add</span><span class='lparen'>(</span><span class='op'>*</span><span class='id identifier rubyid_systems_to_add'>systems_to_add</span><span class='rparen'>)</span>
550
- <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_systems'>systems</span> <span class='op'>|=</span> <span class='id identifier rubyid_systems_to_add'>systems_to_add</span>
551
- <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_systems'>systems</span> <span class='op'>=</span> <span class='id identifier rubyid_systems'>systems</span><span class='period'>.</span><span class='id identifier rubyid_sort_by'>sort_by</span><span class='lparen'>(</span><span class='op'>&amp;</span><span class='symbol'>:priority</span><span class='rparen'>)</span>
552
- <span class='id identifier rubyid_systems_to_add'>systems_to_add</span><span class='period'>.</span><span class='id identifier rubyid_each'>each</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_system'>system</span><span class='op'>|</span>
553
- <span class='id identifier rubyid_system'>system</span><span class='period'>.</span><span class='id identifier rubyid_scenes'>scenes</span> <span class='op'>|=</span> <span class='lbracket'>[</span><span class='kw'>self</span><span class='rbracket'>]</span>
554
- <span class='kw'>end</span>
555
- <span class='kw'>true</span>
556
- <span class='kw'>end</span></pre>
557
- </td>
558
- </tr>
559
- </table>
560
- </div>
561
-
562
- <div class="method_details ">
563
- <h3 class="signature " id="call-instance_method">
564
-
565
- #<strong>call</strong> &#x21d2; <tt>Boolean</tt>
566
-
567
-
568
-
569
-
570
-
571
- </h3><div class="docstring">
572
- <div class="discussion">
573
-
574
- <p>Execute all systems in this Scene, in the order of their priority</p>
575
-
576
-
577
- </div>
578
- </div>
579
- <div class="tags">
580
-
581
- <p class="tag_title">Returns:</p>
582
- <ul class="return">
583
-
584
- <li>
585
-
586
-
587
- <span class='type'>(<tt>Boolean</tt>)</span>
588
-
589
-
590
-
591
- &mdash;
592
- <div class='inline'>
593
- <p><code>true</code></p>
594
- </div>
595
-
596
- </li>
597
-
598
- </ul>
599
-
600
- </div><table class="source_code">
601
- <tr>
602
- <td>
603
- <pre class="lines">
604
-
605
-
606
- 35
607
- 36
608
- 37
609
- 38</pre>
610
- </td>
611
- <td>
612
- <pre class="code"><span class="info file"># File 'lib/felflame/scene_manager.rb', line 35</span>
613
-
614
- <span class='kw'>def</span> <span class='id identifier rubyid_call'>call</span>
615
- <span class='id identifier rubyid_systems'>systems</span><span class='period'>.</span><span class='id identifier rubyid_each'>each</span><span class='lparen'>(</span><span class='op'>&amp;</span><span class='symbol'>:call</span><span class='rparen'>)</span>
616
- <span class='kw'>true</span>
617
- <span class='kw'>end</span></pre>
618
- </td>
619
- </tr>
620
- </table>
621
- </div>
622
-
623
- <div class="method_details ">
624
- <h3 class="signature " id="clear-instance_method">
625
-
626
- #<strong>clear</strong> &#x21d2; <tt>Boolean</tt>
627
-
628
-
629
-
630
-
631
-
632
- </h3><div class="docstring">
633
- <div class="discussion">
634
-
635
- <p>Removes all Systems from this Scene</p>
636
-
637
-
638
- </div>
639
- </div>
640
- <div class="tags">
641
-
642
- <p class="tag_title">Returns:</p>
643
- <ul class="return">
644
-
645
- <li>
646
-
647
-
648
- <span class='type'>(<tt>Boolean</tt>)</span>
649
-
650
-
651
-
652
- &mdash;
653
- <div class='inline'>
654
- <p><code>true</code></p>
655
- </div>
656
-
657
- </li>
658
-
659
- </ul>
660
-
661
- </div><table class="source_code">
662
- <tr>
663
- <td>
664
- <pre class="lines">
665
-
666
-
667
- 60
668
- 61
669
- 62
670
- 63
671
- 64
672
- 65
673
- 66
674
- 67</pre>
675
- </td>
676
- <td>
677
- <pre class="code"><span class="info file"># File 'lib/felflame/scene_manager.rb', line 60</span>
678
-
679
- <span class='kw'>def</span> <span class='id identifier rubyid_clear'>clear</span>
680
- <span class='id identifier rubyid_systems'>systems</span><span class='period'>.</span><span class='id identifier rubyid_each'>each</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_system'>system</span><span class='op'>|</span>
681
- <span class='id identifier rubyid_system'>system</span><span class='period'>.</span><span class='id identifier rubyid_scenes'>scenes</span><span class='period'>.</span><span class='id identifier rubyid_delete'>delete</span> <span class='kw'>self</span>
682
- <span class='kw'>end</span>
683
- <span class='id identifier rubyid_systems'>systems</span><span class='period'>.</span><span class='id identifier rubyid_clear'>clear</span>
684
- <span class='comment'># FelFlame::Stage.update_systems_list if FelFlame::Stage.scenes.include? self
685
- </span> <span class='kw'>true</span>
686
- <span class='kw'>end</span></pre>
687
- </td>
688
- </tr>
689
- </table>
690
- </div>
691
-
692
- <div class="method_details ">
693
- <h3 class="signature " id="remove-instance_method">
694
-
695
- #<strong>remove</strong>(*systems_to_remove) &#x21d2; <tt>Boolean</tt>
696
-
697
-
698
-
699
-
700
-
701
- </h3><div class="docstring">
702
- <div class="discussion">
703
-
704
- <p>Removes any number of Systems from this Scene</p>
705
-
706
-
707
- </div>
708
- </div>
709
- <div class="tags">
710
-
711
- <p class="tag_title">Returns:</p>
712
- <ul class="return">
713
-
714
- <li>
715
-
716
-
717
- <span class='type'>(<tt>Boolean</tt>)</span>
718
-
719
-
720
-
721
- &mdash;
722
- <div class='inline'>
723
- <p><code>true</code></p>
724
- </div>
725
-
726
- </li>
727
-
728
- </ul>
729
-
730
- </div><table class="source_code">
731
- <tr>
732
- <td>
733
- <pre class="lines">
734
-
735
-
736
- 53
737
- 54
738
- 55
739
- 56</pre>
740
- </td>
741
- <td>
742
- <pre class="code"><span class="info file"># File 'lib/felflame/scene_manager.rb', line 53</span>
743
-
744
- <span class='kw'>def</span> <span class='id identifier rubyid_remove'>remove</span><span class='lparen'>(</span><span class='op'>*</span><span class='id identifier rubyid_systems_to_remove'>systems_to_remove</span><span class='rparen'>)</span>
745
- <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_systems'>systems</span> <span class='op'>-=</span> <span class='id identifier rubyid_systems_to_remove'>systems_to_remove</span>
746
- <span class='kw'>true</span>
747
- <span class='kw'>end</span></pre>
748
- </td>
749
- </tr>
750
- </table>
751
- </div>
752
-
753
- </div>
754
-
755
- </div>
756
-
757
- <div id="footer">
758
- Generated on Mon Jan 3 08:23:04 2022 by
759
- <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
760
- 0.9.26 (ruby-2.7.3).
761
- </div>
762
-
763
- </div>
764
- </body>
765
- </html>