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.
- checksums.yaml +4 -4
- data/.rubocop.yml +22 -1
- data/.yardopts +4 -0
- data/CHANGELOG.md +6 -0
- data/Gemfile +1 -1
- data/Gemfile.lock +55 -0
- data/README.md +14 -6
- data/docs/Actor.html +2737 -0
- data/docs/Background.html +961 -0
- data/docs/Camera.html +791 -0
- data/docs/Clock.html +753 -0
- data/docs/Color.html +776 -0
- data/docs/Coordinates.html +730 -0
- data/docs/Cursor.html +752 -0
- data/docs/Disk.html +236 -0
- data/docs/Draggable.html +198 -0
- data/docs/Fantasy.html +121 -0
- data/docs/Game.html +904 -0
- data/docs/Global.html +2791 -0
- data/docs/Gravitier.html +179 -0
- data/docs/HudImage.html +979 -0
- data/docs/HudText.html +1151 -0
- data/docs/Image.html +506 -0
- data/docs/Jumper.html +189 -0
- data/docs/Mouse.html +226 -0
- data/docs/MoveByCursor.html +374 -0
- data/docs/MoveByDirection.html +179 -0
- data/docs/Mover.html +305 -0
- data/docs/Music.html +524 -0
- data/docs/Shape.html +1057 -0
- data/docs/Sound.html +374 -0
- data/docs/Tilemap.html +491 -0
- data/docs/Tween.html +186 -0
- data/docs/UserInputs.html +879 -0
- data/docs/Utils.html +345 -0
- data/docs/_index.html +346 -0
- data/docs/class_list.html +51 -0
- data/docs/css/common.css +1 -0
- data/docs/css/full_list.css +58 -0
- data/docs/css/style.css +497 -0
- data/docs/file.CHANGELOG.html +121 -0
- data/docs/file.README.html +599 -0
- data/docs/file_list.html +61 -0
- data/docs/frames.html +17 -0
- data/docs/index.html +599 -0
- data/docs/js/app.js +314 -0
- data/docs/js/full_list.js +216 -0
- data/docs/js/jquery.js +4 -0
- data/docs/method_list.html +1931 -0
- data/docs/top-level-namespace.html +978 -0
- data/lib/fantasy/actor.rb +455 -123
- data/lib/fantasy/background.rb +109 -13
- data/lib/fantasy/base.rb +113 -1
- data/lib/fantasy/camera.rb +95 -11
- data/lib/fantasy/clock.rb +4 -2
- data/lib/fantasy/color.rb +158 -153
- data/lib/fantasy/coordinates.rb +5 -9
- data/lib/fantasy/cursor.rb +2 -1
- data/lib/fantasy/disk.rb +12 -8
- data/lib/fantasy/draggable.rb +22 -1
- data/lib/fantasy/global.rb +59 -31
- data/lib/fantasy/hud_image.rb +5 -3
- data/lib/fantasy/hud_text.rb +6 -2
- data/lib/fantasy/image.rb +12 -4
- data/lib/fantasy/includes/gravitier.rb +2 -0
- data/lib/fantasy/includes/jumper.rb +3 -2
- data/lib/fantasy/includes/log.rb +12 -0
- data/lib/fantasy/includes/move_by_cursors.rb +24 -15
- data/lib/fantasy/includes/move_by_direction.rb +2 -0
- data/lib/fantasy/includes/mover.rb +3 -0
- data/lib/fantasy/includes/user_inputs.rb +6 -0
- data/lib/fantasy/loop.rb +41 -44
- data/lib/fantasy/mouse.rb +2 -0
- data/lib/fantasy/music.rb +4 -2
- data/lib/fantasy/shape.rb +11 -2
- data/lib/fantasy/sound.rb +3 -1
- data/lib/fantasy/tilemap.rb +19 -13
- data/lib/fantasy/tween.rb +3 -1
- data/lib/fantasy/utils.rb +7 -13
- data/lib/fantasy/version.rb +1 -1
- data/lib/fantasy.rb +2 -0
- metadata +90 -4
- data/fantasy.gemspec +0 -40
- data/fonts/VT323-Regular.ttf +0 -0
data/docs/Actor.html
ADDED
|
@@ -0,0 +1,2737 @@
|
|
|
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: Actor
|
|
8
|
+
|
|
9
|
+
— 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 = "Actor";
|
|
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 (A)</a> »
|
|
40
|
+
|
|
41
|
+
|
|
42
|
+
<span class="title">Actor</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: Actor
|
|
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">Actor</li>
|
|
78
|
+
|
|
79
|
+
</ul>
|
|
80
|
+
<a href="#" class="inheritanceTree">show all</a>
|
|
81
|
+
|
|
82
|
+
</dd>
|
|
83
|
+
</dl>
|
|
84
|
+
|
|
85
|
+
|
|
86
|
+
|
|
87
|
+
|
|
88
|
+
|
|
89
|
+
|
|
90
|
+
<dl>
|
|
91
|
+
<dt>Includes:</dt>
|
|
92
|
+
<dd><span class='object_link'><a href="Gravitier.html" title="Gravitier (module)">Gravitier</a></span>, <span class='object_link'><a href="Jumper.html" title="Jumper (module)">Jumper</a></span>, <span class='object_link'><a href="MoveByCursor.html" title="MoveByCursor (module)">MoveByCursor</a></span>, <span class='object_link'><a href="MoveByDirection.html" title="MoveByDirection (module)">MoveByDirection</a></span>, <span class='object_link'><a href="Mover.html" title="Mover (module)">Mover</a></span>, <span class='object_link'><a href="UserInputs.html" title="UserInputs (module)">UserInputs</a></span></dd>
|
|
93
|
+
</dl>
|
|
94
|
+
|
|
95
|
+
|
|
96
|
+
|
|
97
|
+
|
|
98
|
+
|
|
99
|
+
|
|
100
|
+
<dl>
|
|
101
|
+
<dt>Defined in:</dt>
|
|
102
|
+
<dd>lib/fantasy/actor.rb</dd>
|
|
103
|
+
</dl>
|
|
104
|
+
|
|
105
|
+
</div>
|
|
106
|
+
|
|
107
|
+
<h2>Overview</h2><div class="docstring">
|
|
108
|
+
<div class="discussion">
|
|
109
|
+
<p>Represents one active entity in the game.
|
|
110
|
+
An actor can be the Player sprite. Or one of the enemies. Or the bullet.
|
|
111
|
+
An actor can also be a tree, or a wall</p>
|
|
112
|
+
|
|
113
|
+
|
|
114
|
+
</div>
|
|
115
|
+
</div>
|
|
116
|
+
<div class="tags">
|
|
117
|
+
|
|
118
|
+
<div class="examples">
|
|
119
|
+
<p class="tag_title">Examples:</p>
|
|
120
|
+
|
|
121
|
+
|
|
122
|
+
<p class="example_title"><div class='inline'><p>Actor can be used directly</p>
|
|
123
|
+
</div></p>
|
|
124
|
+
|
|
125
|
+
<pre class="example code"><code><span class='id identifier rubyid_player'>player</span> <span class='op'>=</span> <span class='const'>Actor</span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="#initialize-instance_method" title="Actor#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>warrior</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span> <span class='comment'># ./images/warrior.png
|
|
126
|
+
</span><span class='id identifier rubyid_player'>player</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'>100</span><span class='comma'>,</span> <span class='int'>100</span><span class='rparen'>)</span>
|
|
127
|
+
<span class='id identifier rubyid_player'>player</span><span class='period'>.</span><span class='id identifier rubyid_solid'>solid</span> <span class='op'>=</span> <span class='kw'>true</span>
|
|
128
|
+
<span class='id identifier rubyid_player'>player</span><span class='period'>.</span><span class='id identifier rubyid_speed'>speed</span> <span class='op'>=</span> <span class='int'>200</span>
|
|
129
|
+
<span class='id identifier rubyid_player'>player</span><span class='period'>.</span><span class='id identifier rubyid_layer'>layer</span> <span class='op'>=</span> <span class='int'>1</span>
|
|
130
|
+
<span class='id identifier rubyid_player'>player</span><span class='period'>.</span><span class='id identifier rubyid_move_with_cursors'>move_with_cursors</span>
|
|
131
|
+
<span class='id identifier rubyid_player'>player</span><span class='period'>.</span><span class='id identifier rubyid_collision_with'>collision_with</span> <span class='op'>=</span> <span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>enemy</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>bullets</span><span class='tstring_end'>"</span></span><span class='rbracket'>]</span> <span class='comment'># default "all"
|
|
132
|
+
</span>
|
|
133
|
+
<span class='id identifier rubyid_player'>player</span><span class='period'>.</span><span class='id identifier rubyid_on_collision'>on_collision</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_other'>other</span><span class='op'>|</span>
|
|
134
|
+
<span class='kw'>if</span> <span class='id identifier rubyid_other'>other</span><span class='period'>.</span><span class='id identifier rubyid_name'>name</span> <span class='op'>==</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>enemy</span><span class='tstring_end'>"</span></span>
|
|
135
|
+
<span class='id identifier rubyid_player'>player</span><span class='period'>.</span><span class='id identifier rubyid_destroy'>destroy</span>
|
|
136
|
+
<span class='kw'>end</span>
|
|
137
|
+
<span class='kw'>end</span>
|
|
138
|
+
|
|
139
|
+
<span class='id identifier rubyid_player'>player</span><span class='period'>.</span><span class='id identifier rubyid_on_after_move'>on_after_move</span> <span class='kw'>do</span>
|
|
140
|
+
<span class='kw'>if</span> <span class='id identifier rubyid_player'>player</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='const'>SCREEN_WIDTH</span>
|
|
141
|
+
<span class='id identifier rubyid_player'>player</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='const'>SCREEN_WIDTH</span>
|
|
142
|
+
<span class='kw'>end</span>
|
|
143
|
+
|
|
144
|
+
<span class='kw'>if</span> <span class='id identifier rubyid_player'>player</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'>0</span>
|
|
145
|
+
<span class='id identifier rubyid_player'>player</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'>0</span>
|
|
146
|
+
<span class='kw'>end</span>
|
|
147
|
+
<span class='kw'>end</span></code></pre>
|
|
148
|
+
|
|
149
|
+
|
|
150
|
+
<p class="example_title"><div class='inline'><p>Or in a subclass:</p>
|
|
151
|
+
</div></p>
|
|
152
|
+
|
|
153
|
+
<pre class="example code"><code><span class='kw'>class</span> <span class='const'>Player</span> <span class='op'><</span> <span class='const'>Actor</span>
|
|
154
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span>
|
|
155
|
+
<span class='kw'>super</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>warrior</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span> <span class='comment'># ./images/warrior.png
|
|
156
|
+
</span> <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_new'>new</span><span class='lparen'>(</span><span class='int'>100</span><span class='comma'>,</span> <span class='int'>100</span><span class='rparen'>)</span>
|
|
157
|
+
<span class='ivar'>@solid</span> <span class='op'>=</span> <span class='kw'>true</span>
|
|
158
|
+
<span class='ivar'>@speed</span> <span class='op'>=</span> <span class='int'>200</span>
|
|
159
|
+
<span class='ivar'>@layer</span> <span class='op'>=</span> <span class='int'>1</span>
|
|
160
|
+
<span class='ivar'>@direction</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>
|
|
161
|
+
<span class='ivar'>@collision_with</span> <span class='op'>=</span> <span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>enemy</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>bullets</span><span class='tstring_end'>"</span></span><span class='rbracket'>]</span> <span class='comment'># default "all"
|
|
162
|
+
</span> <span class='id identifier rubyid_move_with_cursors'>move_with_cursors</span>
|
|
163
|
+
<span class='kw'>end</span>
|
|
164
|
+
|
|
165
|
+
<span class='id identifier rubyid_on_collision'>on_collision</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_other'>other</span><span class='op'>|</span>
|
|
166
|
+
<span class='kw'>if</span> <span class='id identifier rubyid_other'>other</span><span class='period'>.</span><span class='id identifier rubyid_name'>name</span> <span class='op'>==</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>enemy</span><span class='tstring_end'>"</span></span>
|
|
167
|
+
<span class='id identifier rubyid_destroy'>destroy</span>
|
|
168
|
+
<span class='kw'>end</span>
|
|
169
|
+
<span class='kw'>end</span>
|
|
170
|
+
|
|
171
|
+
<span class='id identifier rubyid_on_after_move'>on_after_move</span> <span class='kw'>do</span>
|
|
172
|
+
<span class='kw'>if</span> <span class='ivar'>@position</span><span class='period'>.</span><span class='id identifier rubyid_x'>x</span> <span class='op'>></span> <span class='const'>SCREEN_WIDTH</span>
|
|
173
|
+
<span class='ivar'>@position</span><span class='period'>.</span><span class='id identifier rubyid_x'>x</span> <span class='op'>=</span> <span class='const'>SCREEN_WIDTH</span>
|
|
174
|
+
<span class='kw'>end</span>
|
|
175
|
+
|
|
176
|
+
<span class='kw'>if</span> <span class='ivar'>@position</span><span class='period'>.</span><span class='id identifier rubyid_x'>x</span> <span class='op'><</span> <span class='int'>0</span>
|
|
177
|
+
<span class='ivar'>@position</span><span class='period'>.</span><span class='id identifier rubyid_x'>x</span> <span class='op'>=</span> <span class='int'>0</span>
|
|
178
|
+
<span class='kw'>end</span>
|
|
179
|
+
<span class='kw'>end</span>
|
|
180
|
+
<span class='kw'>end</span></code></pre>
|
|
181
|
+
|
|
182
|
+
</div>
|
|
183
|
+
|
|
184
|
+
|
|
185
|
+
</div>
|
|
186
|
+
|
|
187
|
+
|
|
188
|
+
|
|
189
|
+
<h2>Instance Attribute Summary <small><a href="#" class="summary_toggle">collapse</a></small></h2>
|
|
190
|
+
<ul class="summary">
|
|
191
|
+
|
|
192
|
+
<li class="public ">
|
|
193
|
+
<span class="summary_signature">
|
|
194
|
+
|
|
195
|
+
<a href="#collision_with-instance_method" title="#collision_with (instance method)">#<strong>collision_with</strong> ⇒ Array, String </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'><p>Array of strings (or "all").</p>
|
|
213
|
+
</div></span>
|
|
214
|
+
|
|
215
|
+
</li>
|
|
216
|
+
|
|
217
|
+
|
|
218
|
+
<li class="public ">
|
|
219
|
+
<span class="summary_signature">
|
|
220
|
+
|
|
221
|
+
<a href="#direction-instance_method" title="#direction (instance method)">#<strong>direction</strong> ⇒ Coordinates </a>
|
|
222
|
+
|
|
223
|
+
|
|
224
|
+
|
|
225
|
+
</span>
|
|
226
|
+
|
|
227
|
+
|
|
228
|
+
|
|
229
|
+
|
|
230
|
+
|
|
231
|
+
|
|
232
|
+
|
|
233
|
+
|
|
234
|
+
|
|
235
|
+
|
|
236
|
+
|
|
237
|
+
|
|
238
|
+
<span class="summary_desc"><div class='inline'><p>Controls the direction in which this Actor will move in the next frame.</p>
|
|
239
|
+
</div></span>
|
|
240
|
+
|
|
241
|
+
</li>
|
|
242
|
+
|
|
243
|
+
|
|
244
|
+
<li class="public ">
|
|
245
|
+
<span class="summary_signature">
|
|
246
|
+
|
|
247
|
+
<a href="#gravity-instance_method" title="#gravity (instance method)">#<strong>gravity</strong> ⇒ Float </a>
|
|
248
|
+
|
|
249
|
+
|
|
250
|
+
|
|
251
|
+
</span>
|
|
252
|
+
|
|
253
|
+
|
|
254
|
+
|
|
255
|
+
|
|
256
|
+
|
|
257
|
+
|
|
258
|
+
|
|
259
|
+
|
|
260
|
+
|
|
261
|
+
|
|
262
|
+
|
|
263
|
+
|
|
264
|
+
<span class="summary_desc"><div class='inline'><p>Controls constant force this Actor will receive on each frame.</p>
|
|
265
|
+
</div></span>
|
|
266
|
+
|
|
267
|
+
</li>
|
|
268
|
+
|
|
269
|
+
|
|
270
|
+
<li class="public ">
|
|
271
|
+
<span class="summary_signature">
|
|
272
|
+
|
|
273
|
+
<a href="#jump_force-instance_method" title="#jump_force (instance method)">#<strong>jump_force</strong> ⇒ Float </a>
|
|
274
|
+
|
|
275
|
+
|
|
276
|
+
|
|
277
|
+
</span>
|
|
278
|
+
|
|
279
|
+
|
|
280
|
+
|
|
281
|
+
|
|
282
|
+
|
|
283
|
+
|
|
284
|
+
|
|
285
|
+
|
|
286
|
+
|
|
287
|
+
|
|
288
|
+
|
|
289
|
+
|
|
290
|
+
<span class="summary_desc"><div class='inline'><p>Controls impulse this Actor will receive when the (see #jump) is triggered.</p>
|
|
291
|
+
</div></span>
|
|
292
|
+
|
|
293
|
+
</li>
|
|
294
|
+
|
|
295
|
+
|
|
296
|
+
<li class="public ">
|
|
297
|
+
<span class="summary_signature">
|
|
298
|
+
|
|
299
|
+
<a href="#layer-instance_method" title="#layer (instance method)">#<strong>layer</strong> ⇒ Integer </a>
|
|
300
|
+
|
|
301
|
+
|
|
302
|
+
|
|
303
|
+
</span>
|
|
304
|
+
|
|
305
|
+
|
|
306
|
+
|
|
307
|
+
|
|
308
|
+
|
|
309
|
+
|
|
310
|
+
|
|
311
|
+
|
|
312
|
+
|
|
313
|
+
|
|
314
|
+
|
|
315
|
+
|
|
316
|
+
<span class="summary_desc"><div class='inline'><p>In which layer the image of the Actor is rendered.</p>
|
|
317
|
+
</div></span>
|
|
318
|
+
|
|
319
|
+
</li>
|
|
320
|
+
|
|
321
|
+
|
|
322
|
+
<li class="public ">
|
|
323
|
+
<span class="summary_signature">
|
|
324
|
+
|
|
325
|
+
<a href="#name-instance_method" title="#name (instance method)">#<strong>name</strong> ⇒ String </a>
|
|
326
|
+
|
|
327
|
+
|
|
328
|
+
|
|
329
|
+
</span>
|
|
330
|
+
|
|
331
|
+
|
|
332
|
+
|
|
333
|
+
|
|
334
|
+
|
|
335
|
+
|
|
336
|
+
|
|
337
|
+
|
|
338
|
+
|
|
339
|
+
|
|
340
|
+
|
|
341
|
+
|
|
342
|
+
<span class="summary_desc"><div class='inline'><p>The value to internal name of this Actor.</p>
|
|
343
|
+
</div></span>
|
|
344
|
+
|
|
345
|
+
</li>
|
|
346
|
+
|
|
347
|
+
|
|
348
|
+
<li class="public ">
|
|
349
|
+
<span class="summary_signature">
|
|
350
|
+
|
|
351
|
+
<a href="#position-instance_method" title="#position (instance method)">#<strong>position</strong> ⇒ Coordinates </a>
|
|
352
|
+
|
|
353
|
+
|
|
354
|
+
|
|
355
|
+
</span>
|
|
356
|
+
|
|
357
|
+
|
|
358
|
+
|
|
359
|
+
|
|
360
|
+
|
|
361
|
+
|
|
362
|
+
|
|
363
|
+
|
|
364
|
+
|
|
365
|
+
|
|
366
|
+
|
|
367
|
+
|
|
368
|
+
<span class="summary_desc"><div class='inline'><p>Coordinates object where x and y represent the position of the Actor in the World (no necessarily in the Screen).</p>
|
|
369
|
+
</div></span>
|
|
370
|
+
|
|
371
|
+
</li>
|
|
372
|
+
|
|
373
|
+
|
|
374
|
+
<li class="public ">
|
|
375
|
+
<span class="summary_signature">
|
|
376
|
+
|
|
377
|
+
<a href="#scale-instance_method" title="#scale (instance method)">#<strong>scale</strong> ⇒ Float </a>
|
|
378
|
+
|
|
379
|
+
|
|
380
|
+
|
|
381
|
+
</span>
|
|
382
|
+
|
|
383
|
+
|
|
384
|
+
|
|
385
|
+
|
|
386
|
+
|
|
387
|
+
|
|
388
|
+
|
|
389
|
+
|
|
390
|
+
|
|
391
|
+
|
|
392
|
+
|
|
393
|
+
|
|
394
|
+
<span class="summary_desc"><div class='inline'><p>The value to scale the image of the Actor when drawn.</p>
|
|
395
|
+
</div></span>
|
|
396
|
+
|
|
397
|
+
</li>
|
|
398
|
+
|
|
399
|
+
|
|
400
|
+
<li class="public ">
|
|
401
|
+
<span class="summary_signature">
|
|
402
|
+
|
|
403
|
+
<a href="#solid-instance_method" title="#solid (instance method)">#<strong>solid</strong> ⇒ Boolean </a>
|
|
404
|
+
|
|
405
|
+
|
|
406
|
+
|
|
407
|
+
</span>
|
|
408
|
+
|
|
409
|
+
|
|
410
|
+
|
|
411
|
+
|
|
412
|
+
|
|
413
|
+
|
|
414
|
+
|
|
415
|
+
|
|
416
|
+
|
|
417
|
+
|
|
418
|
+
|
|
419
|
+
|
|
420
|
+
<span class="summary_desc"><div class='inline'><p>When <code>true</code> the Actor will cause and respond to collisions.</p>
|
|
421
|
+
</div></span>
|
|
422
|
+
|
|
423
|
+
</li>
|
|
424
|
+
|
|
425
|
+
|
|
426
|
+
<li class="public ">
|
|
427
|
+
<span class="summary_signature">
|
|
428
|
+
|
|
429
|
+
<a href="#speed-instance_method" title="#speed (instance method)">#<strong>speed</strong> ⇒ Float </a>
|
|
430
|
+
|
|
431
|
+
|
|
432
|
+
|
|
433
|
+
</span>
|
|
434
|
+
|
|
435
|
+
|
|
436
|
+
|
|
437
|
+
|
|
438
|
+
|
|
439
|
+
|
|
440
|
+
|
|
441
|
+
|
|
442
|
+
|
|
443
|
+
|
|
444
|
+
|
|
445
|
+
|
|
446
|
+
<span class="summary_desc"><div class='inline'><p>Controls the pixels per second which this Actor will move in the next frame.</p>
|
|
447
|
+
</div></span>
|
|
448
|
+
|
|
449
|
+
</li>
|
|
450
|
+
|
|
451
|
+
|
|
452
|
+
</ul>
|
|
453
|
+
|
|
454
|
+
|
|
455
|
+
|
|
456
|
+
|
|
457
|
+
|
|
458
|
+
<h2>
|
|
459
|
+
Instance Method Summary
|
|
460
|
+
<small><a href="#" class="summary_toggle">collapse</a></small>
|
|
461
|
+
</h2>
|
|
462
|
+
|
|
463
|
+
<ul class="summary">
|
|
464
|
+
|
|
465
|
+
<li class="public ">
|
|
466
|
+
<span class="summary_signature">
|
|
467
|
+
|
|
468
|
+
<a href="#destroy-instance_method" title="#destroy (instance method)">#<strong>destroy</strong> ⇒ Object </a>
|
|
469
|
+
|
|
470
|
+
|
|
471
|
+
|
|
472
|
+
</span>
|
|
473
|
+
|
|
474
|
+
|
|
475
|
+
|
|
476
|
+
|
|
477
|
+
|
|
478
|
+
|
|
479
|
+
|
|
480
|
+
|
|
481
|
+
|
|
482
|
+
<span class="summary_desc"><div class='inline'><p>Destroy this Actor is not longer, moved, or rendered, or cause any collision.</p>
|
|
483
|
+
</div></span>
|
|
484
|
+
|
|
485
|
+
</li>
|
|
486
|
+
|
|
487
|
+
|
|
488
|
+
<li class="public ">
|
|
489
|
+
<span class="summary_signature">
|
|
490
|
+
|
|
491
|
+
<a href="#height-instance_method" title="#height (instance method)">#<strong>height</strong> ⇒ Fixnum </a>
|
|
492
|
+
|
|
493
|
+
|
|
494
|
+
|
|
495
|
+
</span>
|
|
496
|
+
|
|
497
|
+
|
|
498
|
+
|
|
499
|
+
|
|
500
|
+
|
|
501
|
+
|
|
502
|
+
|
|
503
|
+
|
|
504
|
+
|
|
505
|
+
<span class="summary_desc"><div class='inline'><p>The Actor height in pixels.</p>
|
|
506
|
+
</div></span>
|
|
507
|
+
|
|
508
|
+
</li>
|
|
509
|
+
|
|
510
|
+
|
|
511
|
+
<li class="public ">
|
|
512
|
+
<span class="summary_signature">
|
|
513
|
+
|
|
514
|
+
<a href="#image=-instance_method" title="#image= (instance method)">#<strong>image=</strong>(image_name) ⇒ Object </a>
|
|
515
|
+
|
|
516
|
+
|
|
517
|
+
|
|
518
|
+
</span>
|
|
519
|
+
|
|
520
|
+
|
|
521
|
+
|
|
522
|
+
|
|
523
|
+
|
|
524
|
+
|
|
525
|
+
|
|
526
|
+
|
|
527
|
+
|
|
528
|
+
<span class="summary_desc"><div class='inline'><p>Set a new image to the Actor.</p>
|
|
529
|
+
</div></span>
|
|
530
|
+
|
|
531
|
+
</li>
|
|
532
|
+
|
|
533
|
+
|
|
534
|
+
<li class="public ">
|
|
535
|
+
<span class="summary_signature">
|
|
536
|
+
|
|
537
|
+
<a href="#initialize-instance_method" title="#initialize (instance method)">#<strong>initialize</strong>(image_name) ⇒ Actor </a>
|
|
538
|
+
|
|
539
|
+
|
|
540
|
+
|
|
541
|
+
</span>
|
|
542
|
+
|
|
543
|
+
|
|
544
|
+
<span class="note title constructor">constructor</span>
|
|
545
|
+
|
|
546
|
+
|
|
547
|
+
|
|
548
|
+
|
|
549
|
+
|
|
550
|
+
|
|
551
|
+
|
|
552
|
+
|
|
553
|
+
<span class="summary_desc"><div class='inline'><p>Generate an Actor with all the default attribute values.</p>
|
|
554
|
+
</div></span>
|
|
555
|
+
|
|
556
|
+
</li>
|
|
557
|
+
|
|
558
|
+
|
|
559
|
+
<li class="public ">
|
|
560
|
+
<span class="summary_signature">
|
|
561
|
+
|
|
562
|
+
<a href="#on_after_move-instance_method" title="#on_after_move (instance method)">#<strong>on_after_move</strong>(&block) ⇒ Object </a>
|
|
563
|
+
|
|
564
|
+
|
|
565
|
+
|
|
566
|
+
</span>
|
|
567
|
+
|
|
568
|
+
|
|
569
|
+
|
|
570
|
+
|
|
571
|
+
|
|
572
|
+
|
|
573
|
+
|
|
574
|
+
|
|
575
|
+
|
|
576
|
+
<span class="summary_desc"><div class='inline'><p>The block to be executed after each frame.</p>
|
|
577
|
+
</div></span>
|
|
578
|
+
|
|
579
|
+
</li>
|
|
580
|
+
|
|
581
|
+
|
|
582
|
+
<li class="public ">
|
|
583
|
+
<span class="summary_signature">
|
|
584
|
+
|
|
585
|
+
<a href="#on_after_move_do-instance_method" title="#on_after_move_do (instance method)">#<strong>on_after_move_do</strong> ⇒ Object </a>
|
|
586
|
+
|
|
587
|
+
|
|
588
|
+
|
|
589
|
+
</span>
|
|
590
|
+
|
|
591
|
+
|
|
592
|
+
|
|
593
|
+
|
|
594
|
+
|
|
595
|
+
|
|
596
|
+
|
|
597
|
+
|
|
598
|
+
|
|
599
|
+
<span class="summary_desc"><div class='inline'><p>This method is triggered after each frame.</p>
|
|
600
|
+
</div></span>
|
|
601
|
+
|
|
602
|
+
</li>
|
|
603
|
+
|
|
604
|
+
|
|
605
|
+
<li class="public ">
|
|
606
|
+
<span class="summary_signature">
|
|
607
|
+
|
|
608
|
+
<a href="#on_collision-instance_method" title="#on_collision (instance method)">#<strong>on_collision</strong>(&block) ⇒ Object </a>
|
|
609
|
+
|
|
610
|
+
|
|
611
|
+
|
|
612
|
+
</span>
|
|
613
|
+
|
|
614
|
+
|
|
615
|
+
|
|
616
|
+
|
|
617
|
+
|
|
618
|
+
|
|
619
|
+
|
|
620
|
+
|
|
621
|
+
|
|
622
|
+
<span class="summary_desc"><div class='inline'><p>The block to be executed when Actor collides with another Actor.</p>
|
|
623
|
+
</div></span>
|
|
624
|
+
|
|
625
|
+
</li>
|
|
626
|
+
|
|
627
|
+
|
|
628
|
+
<li class="public ">
|
|
629
|
+
<span class="summary_signature">
|
|
630
|
+
|
|
631
|
+
<a href="#on_collision_do-instance_method" title="#on_collision_do (instance method)">#<strong>on_collision_do</strong>(other) ⇒ Object </a>
|
|
632
|
+
|
|
633
|
+
|
|
634
|
+
|
|
635
|
+
</span>
|
|
636
|
+
|
|
637
|
+
|
|
638
|
+
|
|
639
|
+
|
|
640
|
+
|
|
641
|
+
|
|
642
|
+
|
|
643
|
+
|
|
644
|
+
|
|
645
|
+
<span class="summary_desc"><div class='inline'><p>This method is triggered when Actor collides with another Actor.</p>
|
|
646
|
+
</div></span>
|
|
647
|
+
|
|
648
|
+
</li>
|
|
649
|
+
|
|
650
|
+
|
|
651
|
+
<li class="public ">
|
|
652
|
+
<span class="summary_signature">
|
|
653
|
+
|
|
654
|
+
<a href="#on_destroy-instance_method" title="#on_destroy (instance method)">#<strong>on_destroy</strong>(&block) ⇒ Object </a>
|
|
655
|
+
|
|
656
|
+
|
|
657
|
+
|
|
658
|
+
</span>
|
|
659
|
+
|
|
660
|
+
|
|
661
|
+
|
|
662
|
+
|
|
663
|
+
|
|
664
|
+
|
|
665
|
+
|
|
666
|
+
|
|
667
|
+
|
|
668
|
+
<span class="summary_desc"><div class='inline'><p>The block to be executed before the Actor is destroyed.</p>
|
|
669
|
+
</div></span>
|
|
670
|
+
|
|
671
|
+
</li>
|
|
672
|
+
|
|
673
|
+
|
|
674
|
+
<li class="public ">
|
|
675
|
+
<span class="summary_signature">
|
|
676
|
+
|
|
677
|
+
<a href="#on_destroy_do-instance_method" title="#on_destroy_do (instance method)">#<strong>on_destroy_do</strong> ⇒ Object </a>
|
|
678
|
+
|
|
679
|
+
|
|
680
|
+
|
|
681
|
+
</span>
|
|
682
|
+
|
|
683
|
+
|
|
684
|
+
|
|
685
|
+
|
|
686
|
+
|
|
687
|
+
|
|
688
|
+
|
|
689
|
+
|
|
690
|
+
|
|
691
|
+
<span class="summary_desc"><div class='inline'><p>This method is triggered before the Actor is destroyed.</p>
|
|
692
|
+
</div></span>
|
|
693
|
+
|
|
694
|
+
</li>
|
|
695
|
+
|
|
696
|
+
|
|
697
|
+
<li class="public ">
|
|
698
|
+
<span class="summary_signature">
|
|
699
|
+
|
|
700
|
+
<a href="#on_floor-instance_method" title="#on_floor (instance method)">#<strong>on_floor</strong>(&block) ⇒ Object </a>
|
|
701
|
+
|
|
702
|
+
|
|
703
|
+
|
|
704
|
+
</span>
|
|
705
|
+
|
|
706
|
+
|
|
707
|
+
|
|
708
|
+
|
|
709
|
+
|
|
710
|
+
|
|
711
|
+
|
|
712
|
+
|
|
713
|
+
|
|
714
|
+
<span class="summary_desc"><div class='inline'><p>The block to be executed when the Actor touches floor.</p>
|
|
715
|
+
</div></span>
|
|
716
|
+
|
|
717
|
+
</li>
|
|
718
|
+
|
|
719
|
+
|
|
720
|
+
<li class="public ">
|
|
721
|
+
<span class="summary_signature">
|
|
722
|
+
|
|
723
|
+
<a href="#on_floor_do-instance_method" title="#on_floor_do (instance method)">#<strong>on_floor_do</strong> ⇒ Object </a>
|
|
724
|
+
|
|
725
|
+
|
|
726
|
+
|
|
727
|
+
</span>
|
|
728
|
+
|
|
729
|
+
|
|
730
|
+
|
|
731
|
+
|
|
732
|
+
|
|
733
|
+
|
|
734
|
+
|
|
735
|
+
|
|
736
|
+
|
|
737
|
+
<span class="summary_desc"><div class='inline'><p>This method is triggered when the Actor touches floor.</p>
|
|
738
|
+
</div></span>
|
|
739
|
+
|
|
740
|
+
</li>
|
|
741
|
+
|
|
742
|
+
|
|
743
|
+
<li class="public ">
|
|
744
|
+
<span class="summary_signature">
|
|
745
|
+
|
|
746
|
+
<a href="#on_jumping-instance_method" title="#on_jumping (instance method)">#<strong>on_jumping</strong>(&block) ⇒ Object </a>
|
|
747
|
+
|
|
748
|
+
|
|
749
|
+
|
|
750
|
+
</span>
|
|
751
|
+
|
|
752
|
+
|
|
753
|
+
|
|
754
|
+
|
|
755
|
+
|
|
756
|
+
|
|
757
|
+
|
|
758
|
+
|
|
759
|
+
|
|
760
|
+
<span class="summary_desc"><div class='inline'><p>The block to be executed when the Actor starts jumping.</p>
|
|
761
|
+
</div></span>
|
|
762
|
+
|
|
763
|
+
</li>
|
|
764
|
+
|
|
765
|
+
|
|
766
|
+
<li class="public ">
|
|
767
|
+
<span class="summary_signature">
|
|
768
|
+
|
|
769
|
+
<a href="#on_jumping_do-instance_method" title="#on_jumping_do (instance method)">#<strong>on_jumping_do</strong> ⇒ Object </a>
|
|
770
|
+
|
|
771
|
+
|
|
772
|
+
|
|
773
|
+
</span>
|
|
774
|
+
|
|
775
|
+
|
|
776
|
+
|
|
777
|
+
|
|
778
|
+
|
|
779
|
+
|
|
780
|
+
|
|
781
|
+
|
|
782
|
+
|
|
783
|
+
<span class="summary_desc"><div class='inline'><p>This method is triggered when the Actor starts jumping.</p>
|
|
784
|
+
</div></span>
|
|
785
|
+
|
|
786
|
+
</li>
|
|
787
|
+
|
|
788
|
+
|
|
789
|
+
<li class="public ">
|
|
790
|
+
<span class="summary_signature">
|
|
791
|
+
|
|
792
|
+
<a href="#solid%3F-instance_method" title="#solid? (instance method)">#<strong>solid?</strong> ⇒ Boolean </a>
|
|
793
|
+
|
|
794
|
+
|
|
795
|
+
|
|
796
|
+
</span>
|
|
797
|
+
|
|
798
|
+
|
|
799
|
+
|
|
800
|
+
|
|
801
|
+
|
|
802
|
+
|
|
803
|
+
|
|
804
|
+
|
|
805
|
+
|
|
806
|
+
<span class="summary_desc"><div class='inline'><p>The value of <code>@solid</code>.</p>
|
|
807
|
+
</div></span>
|
|
808
|
+
|
|
809
|
+
</li>
|
|
810
|
+
|
|
811
|
+
|
|
812
|
+
<li class="public ">
|
|
813
|
+
<span class="summary_signature">
|
|
814
|
+
|
|
815
|
+
<a href="#width-instance_method" title="#width (instance method)">#<strong>width</strong> ⇒ Fixnum </a>
|
|
816
|
+
|
|
817
|
+
|
|
818
|
+
|
|
819
|
+
</span>
|
|
820
|
+
|
|
821
|
+
|
|
822
|
+
|
|
823
|
+
|
|
824
|
+
|
|
825
|
+
|
|
826
|
+
|
|
827
|
+
|
|
828
|
+
|
|
829
|
+
<span class="summary_desc"><div class='inline'><p>The Actor width in pixels.</p>
|
|
830
|
+
</div></span>
|
|
831
|
+
|
|
832
|
+
</li>
|
|
833
|
+
|
|
834
|
+
|
|
835
|
+
</ul>
|
|
836
|
+
|
|
837
|
+
|
|
838
|
+
|
|
839
|
+
|
|
840
|
+
|
|
841
|
+
|
|
842
|
+
|
|
843
|
+
|
|
844
|
+
|
|
845
|
+
|
|
846
|
+
|
|
847
|
+
<h3 class="inherited">Methods included from <span class='object_link'><a href="UserInputs.html" title="UserInputs (module)">UserInputs</a></span></h3>
|
|
848
|
+
<p class="inherited"><span class='object_link'><a href="UserInputs.html#on_click-instance_method" title="UserInputs#on_click (method)">#on_click</a></span>, <span class='object_link'><a href="UserInputs.html#on_click_do-instance_method" title="UserInputs#on_click_do (method)">#on_click_do</a></span>, <span class='object_link'><a href="UserInputs.html#on_cursor_down-instance_method" title="UserInputs#on_cursor_down (method)">#on_cursor_down</a></span>, <span class='object_link'><a href="UserInputs.html#on_cursor_down_do-instance_method" title="UserInputs#on_cursor_down_do (method)">#on_cursor_down_do</a></span>, <span class='object_link'><a href="UserInputs.html#on_cursor_left-instance_method" title="UserInputs#on_cursor_left (method)">#on_cursor_left</a></span>, <span class='object_link'><a href="UserInputs.html#on_cursor_left_do-instance_method" title="UserInputs#on_cursor_left_do (method)">#on_cursor_left_do</a></span>, <span class='object_link'><a href="UserInputs.html#on_cursor_right-instance_method" title="UserInputs#on_cursor_right (method)">#on_cursor_right</a></span>, <span class='object_link'><a href="UserInputs.html#on_cursor_right_do-instance_method" title="UserInputs#on_cursor_right_do (method)">#on_cursor_right_do</a></span>, <span class='object_link'><a href="UserInputs.html#on_cursor_up-instance_method" title="UserInputs#on_cursor_up (method)">#on_cursor_up</a></span>, <span class='object_link'><a href="UserInputs.html#on_cursor_up_do-instance_method" title="UserInputs#on_cursor_up_do (method)">#on_cursor_up_do</a></span>, <span class='object_link'><a href="UserInputs.html#on_mouse_button_left-instance_method" title="UserInputs#on_mouse_button_left (method)">#on_mouse_button_left</a></span>, <span class='object_link'><a href="UserInputs.html#on_mouse_button_left_do-instance_method" title="UserInputs#on_mouse_button_left_do (method)">#on_mouse_button_left_do</a></span>, <span class='object_link'><a href="UserInputs.html#on_space_bar-instance_method" title="UserInputs#on_space_bar (method)">#on_space_bar</a></span>, <span class='object_link'><a href="UserInputs.html#on_space_bar_do-instance_method" title="UserInputs#on_space_bar_do (method)">#on_space_bar_do</a></span></p>
|
|
849
|
+
|
|
850
|
+
|
|
851
|
+
|
|
852
|
+
|
|
853
|
+
|
|
854
|
+
|
|
855
|
+
|
|
856
|
+
|
|
857
|
+
|
|
858
|
+
<h3 class="inherited">Methods included from <span class='object_link'><a href="Jumper.html" title="Jumper (module)">Jumper</a></span></h3>
|
|
859
|
+
<p class="inherited"><span class='object_link'><a href="Jumper.html#jump-instance_method" title="Jumper#jump (method)">#jump</a></span></p>
|
|
860
|
+
|
|
861
|
+
|
|
862
|
+
|
|
863
|
+
|
|
864
|
+
|
|
865
|
+
|
|
866
|
+
|
|
867
|
+
|
|
868
|
+
|
|
869
|
+
<h3 class="inherited">Methods included from <span class='object_link'><a href="Gravitier.html" title="Gravitier (module)">Gravitier</a></span></h3>
|
|
870
|
+
<p class="inherited"><span class='object_link'><a href="Gravitier.html#add_force_by_gravity-instance_method" title="Gravitier#add_force_by_gravity (method)">#add_force_by_gravity</a></span></p>
|
|
871
|
+
|
|
872
|
+
|
|
873
|
+
|
|
874
|
+
|
|
875
|
+
|
|
876
|
+
|
|
877
|
+
|
|
878
|
+
|
|
879
|
+
|
|
880
|
+
<h3 class="inherited">Methods included from <span class='object_link'><a href="Mover.html" title="Mover (module)">Mover</a></span></h3>
|
|
881
|
+
<p class="inherited"><span class='object_link'><a href="Mover.html#add_force-instance_method" title="Mover#add_force (method)">#add_force</a></span>, <span class='object_link'><a href="Mover.html#apply_forces-instance_method" title="Mover#apply_forces (method)">#apply_forces</a></span>, <span class='object_link'><a href="Mover.html#impulse-instance_method" title="Mover#impulse (method)">#impulse</a></span></p>
|
|
882
|
+
|
|
883
|
+
|
|
884
|
+
|
|
885
|
+
|
|
886
|
+
|
|
887
|
+
|
|
888
|
+
|
|
889
|
+
|
|
890
|
+
|
|
891
|
+
<h3 class="inherited">Methods included from <span class='object_link'><a href="MoveByDirection.html" title="MoveByDirection (module)">MoveByDirection</a></span></h3>
|
|
892
|
+
<p class="inherited"><span class='object_link'><a href="MoveByDirection.html#move_by_direction-instance_method" title="MoveByDirection#move_by_direction (method)">#move_by_direction</a></span></p>
|
|
893
|
+
|
|
894
|
+
|
|
895
|
+
|
|
896
|
+
|
|
897
|
+
|
|
898
|
+
|
|
899
|
+
|
|
900
|
+
|
|
901
|
+
|
|
902
|
+
<h3 class="inherited">Methods included from <span class='object_link'><a href="MoveByCursor.html" title="MoveByCursor (module)">MoveByCursor</a></span></h3>
|
|
903
|
+
<p class="inherited"><span class='object_link'><a href="MoveByCursor.html#move_by-instance_method" title="MoveByCursor#move_by (method)">#move_by</a></span>, <span class='object_link'><a href="MoveByCursor.html#move_by_cursors-instance_method" title="MoveByCursor#move_by_cursors (method)">#move_by_cursors</a></span>, <span class='object_link'><a href="MoveByCursor.html#move_with_cursors-instance_method" title="MoveByCursor#move_with_cursors (method)">#move_with_cursors</a></span></p>
|
|
904
|
+
<div id="constructor_details" class="method_details_list">
|
|
905
|
+
<h2>Constructor Details</h2>
|
|
906
|
+
|
|
907
|
+
<div class="method_details first">
|
|
908
|
+
<h3 class="signature first" id="initialize-instance_method">
|
|
909
|
+
|
|
910
|
+
#<strong>initialize</strong>(image_name) ⇒ <tt><span class='object_link'><a href="" title="Actor (class)">Actor</a></span></tt>
|
|
911
|
+
|
|
912
|
+
|
|
913
|
+
|
|
914
|
+
|
|
915
|
+
|
|
916
|
+
</h3><div class="docstring">
|
|
917
|
+
<div class="discussion">
|
|
918
|
+
<p>Generate an Actor with all the default attribute values</p>
|
|
919
|
+
|
|
920
|
+
|
|
921
|
+
</div>
|
|
922
|
+
</div>
|
|
923
|
+
<div class="tags">
|
|
924
|
+
|
|
925
|
+
<div class="examples">
|
|
926
|
+
<p class="tag_title">Examples:</p>
|
|
927
|
+
|
|
928
|
+
|
|
929
|
+
<p class="example_title"><div class='inline'><p>Generate an Actor</p>
|
|
930
|
+
</div></p>
|
|
931
|
+
|
|
932
|
+
<pre class="example code"><code><span class='id identifier rubyid_actor'>actor</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="" title="Actor (class)">Actor</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'>"</span><span class='tstring_content'>image</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span>
|
|
933
|
+
<span class='id identifier rubyid_actor'>actor</span><span class='period'>.</span><span class='id identifier rubyid_position'>position</span> <span class='comment'># => Coordinates.zero
|
|
934
|
+
</span><span class='id identifier rubyid_actor'>actor</span><span class='period'>.</span><span class='id identifier rubyid_direction'>direction</span> <span class='comment'># => Coordinates.zero
|
|
935
|
+
</span><span class='id identifier rubyid_actor'>actor</span><span class='period'>.</span><span class='id identifier rubyid_speed'>speed</span> <span class='comment'># => 0
|
|
936
|
+
</span><span class='id identifier rubyid_actor'>actor</span><span class='period'>.</span><span class='id identifier rubyid_scale'>scale</span> <span class='comment'># => 1
|
|
937
|
+
</span><span class='id identifier rubyid_actor'>actor</span><span class='period'>.</span><span class='id identifier rubyid_solid'>solid</span> <span class='comment'># => true
|
|
938
|
+
</span><span class='id identifier rubyid_actor'>actor</span><span class='period'>.</span><span class='id identifier rubyid_draggable_on_debug'>draggable_on_debug</span> <span class='comment'># => true
|
|
939
|
+
</span><span class='id identifier rubyid_actor'>actor</span><span class='period'>.</span><span class='id identifier rubyid_layer'>layer</span> <span class='comment'># => 0
|
|
940
|
+
</span><span class='id identifier rubyid_actor'>actor</span><span class='period'>.</span><span class='id identifier rubyid_gravity'>gravity</span> <span class='comment'># => 0
|
|
941
|
+
</span><span class='id identifier rubyid_actor'>actor</span><span class='period'>.</span><span class='id identifier rubyid_jump_force'>jump_force</span> <span class='comment'># => 0
|
|
942
|
+
</span><span class='id identifier rubyid_actor'>actor</span><span class='period'>.</span><span class='id identifier rubyid_collision_with'>collision_with</span> <span class='comment'># => "all"</span></code></pre>
|
|
943
|
+
|
|
944
|
+
</div>
|
|
945
|
+
<p class="tag_title">Parameters:</p>
|
|
946
|
+
<ul class="param">
|
|
947
|
+
|
|
948
|
+
<li>
|
|
949
|
+
|
|
950
|
+
<span class='name'>image_name</span>
|
|
951
|
+
|
|
952
|
+
|
|
953
|
+
<span class='type'>(<tt>string</tt>)</span>
|
|
954
|
+
|
|
955
|
+
|
|
956
|
+
|
|
957
|
+
—
|
|
958
|
+
<div class='inline'><p>the name of the image file from <code>./images/*</code></p>
|
|
959
|
+
</div>
|
|
960
|
+
|
|
961
|
+
</li>
|
|
962
|
+
|
|
963
|
+
</ul>
|
|
964
|
+
|
|
965
|
+
|
|
966
|
+
</div><table class="source_code">
|
|
967
|
+
<tr>
|
|
968
|
+
<td>
|
|
969
|
+
<pre class="lines">
|
|
970
|
+
|
|
971
|
+
|
|
972
|
+
236
|
|
973
|
+
237
|
|
974
|
+
238
|
|
975
|
+
239
|
|
976
|
+
240
|
|
977
|
+
241
|
|
978
|
+
242
|
|
979
|
+
243
|
|
980
|
+
244
|
|
981
|
+
245
|
|
982
|
+
246
|
|
983
|
+
247
|
|
984
|
+
248
|
|
985
|
+
249
|
|
986
|
+
250
|
|
987
|
+
251
|
|
988
|
+
252
|
|
989
|
+
253
|
|
990
|
+
254
|
|
991
|
+
255
|
|
992
|
+
256
|
|
993
|
+
257
|
|
994
|
+
258
|
|
995
|
+
259
|
|
996
|
+
260
|
|
997
|
+
261
|
|
998
|
+
262
|
|
999
|
+
263</pre>
|
|
1000
|
+
</td>
|
|
1001
|
+
<td>
|
|
1002
|
+
<pre class="code"><span class="info file"># File 'lib/fantasy/actor.rb', line 236</span>
|
|
1003
|
+
|
|
1004
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='id identifier rubyid_image_name'>image_name</span><span class='rparen'>)</span>
|
|
1005
|
+
<span class='ivar'>@image_name</span> <span class='op'>=</span> <span class='id identifier rubyid_image_name'>image_name</span>
|
|
1006
|
+
<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>
|
|
1007
|
+
<span class='ivar'>@name</span> <span class='op'>=</span> <span class='id identifier rubyid_image_name'>image_name</span>
|
|
1008
|
+
<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>
|
|
1009
|
+
<span class='ivar'>@direction</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>
|
|
1010
|
+
<span class='ivar'>@speed</span> <span class='op'>=</span> <span class='int'>0</span>
|
|
1011
|
+
<span class='ivar'>@scale</span> <span class='op'>=</span> <span class='int'>1</span>
|
|
1012
|
+
|
|
1013
|
+
<span class='ivar'>@solid</span> <span class='op'>=</span> <span class='kw'>false</span>
|
|
1014
|
+
<span class='ivar'>@draggable_on_debug</span> <span class='op'>=</span> <span class='kw'>true</span>
|
|
1015
|
+
<span class='ivar'>@dragging</span> <span class='op'>=</span> <span class='kw'>false</span>
|
|
1016
|
+
<span class='ivar'>@dragging_offset</span> <span class='op'>=</span> <span class='kw'>nil</span>
|
|
1017
|
+
<span class='ivar'>@layer</span> <span class='op'>=</span> <span class='int'>0</span>
|
|
1018
|
+
<span class='ivar'>@gravity</span> <span class='op'>=</span> <span class='int'>0</span>
|
|
1019
|
+
<span class='ivar'>@jump_force</span> <span class='op'>=</span> <span class='int'>0</span>
|
|
1020
|
+
<span class='ivar'>@collision_with</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>all</span><span class='tstring_end'>"</span></span>
|
|
1021
|
+
|
|
1022
|
+
<span class='ivar'>@on_floor</span> <span class='op'>=</span> <span class='kw'>false</span>
|
|
1023
|
+
|
|
1024
|
+
<span class='ivar'>@on_after_move_callback</span> <span class='op'>=</span> <span class='kw'>nil</span>
|
|
1025
|
+
<span class='ivar'>@on_collision_callback</span> <span class='op'>=</span> <span class='kw'>nil</span>
|
|
1026
|
+
<span class='ivar'>@on_destroy_callback</span> <span class='op'>=</span> <span class='kw'>nil</span>
|
|
1027
|
+
<span class='ivar'>@on_jumping_callback</span> <span class='op'>=</span> <span class='kw'>nil</span>
|
|
1028
|
+
<span class='ivar'>@on_floor_callback</span> <span class='op'>=</span> <span class='kw'>nil</span>
|
|
1029
|
+
|
|
1030
|
+
<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_actors'><span class='object_link'><a href="Global.html#actors-class_method" title="Global.actors (method)">actors</a></span></span> <span class='op'><<</span> <span class='kw'>self</span>
|
|
1031
|
+
<span class='kw'>end</span></pre>
|
|
1032
|
+
</td>
|
|
1033
|
+
</tr>
|
|
1034
|
+
</table>
|
|
1035
|
+
</div>
|
|
1036
|
+
|
|
1037
|
+
</div>
|
|
1038
|
+
|
|
1039
|
+
<div id="instance_attr_details" class="attr_details">
|
|
1040
|
+
<h2>Instance Attribute Details</h2>
|
|
1041
|
+
|
|
1042
|
+
|
|
1043
|
+
<span id="collision_with=-instance_method"></span>
|
|
1044
|
+
<div class="method_details first">
|
|
1045
|
+
<h3 class="signature first" id="collision_with-instance_method">
|
|
1046
|
+
|
|
1047
|
+
#<strong>collision_with</strong> ⇒ <tt>Array</tt>, <tt>String</tt>
|
|
1048
|
+
|
|
1049
|
+
|
|
1050
|
+
|
|
1051
|
+
|
|
1052
|
+
|
|
1053
|
+
</h3><div class="docstring">
|
|
1054
|
+
<div class="discussion">
|
|
1055
|
+
<p>Array of strings (or "all").
|
|
1056
|
+
Represents with which other solid Actors this Actor collide.</p>
|
|
1057
|
+
|
|
1058
|
+
<p>Default <code>"all"</code>.</p>
|
|
1059
|
+
|
|
1060
|
+
|
|
1061
|
+
</div>
|
|
1062
|
+
</div>
|
|
1063
|
+
<div class="tags">
|
|
1064
|
+
|
|
1065
|
+
<div class="examples">
|
|
1066
|
+
<p class="tag_title">Examples:</p>
|
|
1067
|
+
|
|
1068
|
+
|
|
1069
|
+
<p class="example_title"><div class='inline'><p>Set with which other Actors this Actor is colliding:</p>
|
|
1070
|
+
</div></p>
|
|
1071
|
+
|
|
1072
|
+
<pre class="example code"><code><span class='id identifier rubyid_actor'>actor</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="" title="Actor (class)">Actor</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="#initialize-instance_method" title="Actor#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>image</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span>
|
|
1073
|
+
<span class='id identifier rubyid_actor'>actor</span><span class='period'>.</span><span class='id identifier rubyid_collision_with'>collision_with</span> <span class='op'>=</span> <span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>enemy</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>bullet</span><span class='tstring_end'>"</span></span><span class='rbracket'>]</span></code></pre>
|
|
1074
|
+
|
|
1075
|
+
|
|
1076
|
+
<p class="example_title"><div class='inline'><p>Set this Actors collides with all other Actors</p>
|
|
1077
|
+
</div></p>
|
|
1078
|
+
|
|
1079
|
+
<pre class="example code"><code><span class='id identifier rubyid_actor'>actor</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="" title="Actor (class)">Actor</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="#initialize-instance_method" title="Actor#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>image</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span>
|
|
1080
|
+
<span class='id identifier rubyid_actor'>actor</span><span class='period'>.</span><span class='id identifier rubyid_collision_with'>collision_with</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>all</span><span class='tstring_end'>"</span></span></code></pre>
|
|
1081
|
+
|
|
1082
|
+
</div>
|
|
1083
|
+
|
|
1084
|
+
<p class="tag_title">Returns:</p>
|
|
1085
|
+
<ul class="return">
|
|
1086
|
+
|
|
1087
|
+
<li>
|
|
1088
|
+
|
|
1089
|
+
|
|
1090
|
+
<span class='type'>(<tt>Array</tt>, <tt>String</tt>)</span>
|
|
1091
|
+
|
|
1092
|
+
|
|
1093
|
+
|
|
1094
|
+
—
|
|
1095
|
+
<div class='inline'><p>the actual list of names of Actors to collide with</p>
|
|
1096
|
+
</div>
|
|
1097
|
+
|
|
1098
|
+
</li>
|
|
1099
|
+
|
|
1100
|
+
</ul>
|
|
1101
|
+
|
|
1102
|
+
</div><table class="source_code">
|
|
1103
|
+
<tr>
|
|
1104
|
+
<td>
|
|
1105
|
+
<pre class="lines">
|
|
1106
|
+
|
|
1107
|
+
|
|
1108
|
+
218
|
|
1109
|
+
219
|
|
1110
|
+
220</pre>
|
|
1111
|
+
</td>
|
|
1112
|
+
<td>
|
|
1113
|
+
<pre class="code"><span class="info file"># File 'lib/fantasy/actor.rb', line 218</span>
|
|
1114
|
+
|
|
1115
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_collision_with'>collision_with</span>
|
|
1116
|
+
<span class='ivar'>@collision_with</span>
|
|
1117
|
+
<span class='kw'>end</span></pre>
|
|
1118
|
+
</td>
|
|
1119
|
+
</tr>
|
|
1120
|
+
</table>
|
|
1121
|
+
</div>
|
|
1122
|
+
|
|
1123
|
+
|
|
1124
|
+
<span id="direction=-instance_method"></span>
|
|
1125
|
+
<div class="method_details ">
|
|
1126
|
+
<h3 class="signature " id="direction-instance_method">
|
|
1127
|
+
|
|
1128
|
+
#<strong>direction</strong> ⇒ <tt><span class='object_link'><a href="Coordinates.html" title="Coordinates (class)">Coordinates</a></span></tt>
|
|
1129
|
+
|
|
1130
|
+
|
|
1131
|
+
|
|
1132
|
+
|
|
1133
|
+
|
|
1134
|
+
</h3><div class="docstring">
|
|
1135
|
+
<div class="discussion">
|
|
1136
|
+
|
|
1137
|
+
<div class="note notetag">
|
|
1138
|
+
<strong>Note:</strong>
|
|
1139
|
+
<div class='inline'><p>The the pixels per second is represented by the <code>@speed</code> attribute</p>
|
|
1140
|
+
</div>
|
|
1141
|
+
</div>
|
|
1142
|
+
|
|
1143
|
+
<p>Controls the direction in which this Actor will move in the next frame.</p>
|
|
1144
|
+
|
|
1145
|
+
<p>Default <code>Coordinates.zero</code>.</p>
|
|
1146
|
+
|
|
1147
|
+
|
|
1148
|
+
</div>
|
|
1149
|
+
</div>
|
|
1150
|
+
<div class="tags">
|
|
1151
|
+
|
|
1152
|
+
<div class="examples">
|
|
1153
|
+
<p class="tag_title">Examples:</p>
|
|
1154
|
+
|
|
1155
|
+
|
|
1156
|
+
<p class="example_title"><div class='inline'><p>Set direction</p>
|
|
1157
|
+
</div></p>
|
|
1158
|
+
|
|
1159
|
+
<pre class="example code"><code><span class='id identifier rubyid_actor'>actor</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="" title="Actor (class)">Actor</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="#initialize-instance_method" title="Actor#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>image</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span>
|
|
1160
|
+
<span class='id identifier rubyid_actor'>actor</span><span class='period'>.</span><span class='id identifier rubyid_direction'>direction</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_right'><span class='object_link'><a href="Coordinates.html#right-class_method" title="Coordinates.right (method)">right</a></span></span></code></pre>
|
|
1161
|
+
|
|
1162
|
+
</div>
|
|
1163
|
+
|
|
1164
|
+
<p class="tag_title">Returns:</p>
|
|
1165
|
+
<ul class="return">
|
|
1166
|
+
|
|
1167
|
+
<li>
|
|
1168
|
+
|
|
1169
|
+
|
|
1170
|
+
<span class='type'>(<tt><span class='object_link'><a href="Coordinates.html" title="Coordinates (class)">Coordinates</a></span></tt>)</span>
|
|
1171
|
+
|
|
1172
|
+
|
|
1173
|
+
|
|
1174
|
+
—
|
|
1175
|
+
<div class='inline'><p>the actual direction</p>
|
|
1176
|
+
</div>
|
|
1177
|
+
|
|
1178
|
+
</li>
|
|
1179
|
+
|
|
1180
|
+
</ul>
|
|
1181
|
+
|
|
1182
|
+
</div><table class="source_code">
|
|
1183
|
+
<tr>
|
|
1184
|
+
<td>
|
|
1185
|
+
<pre class="lines">
|
|
1186
|
+
|
|
1187
|
+
|
|
1188
|
+
96
|
|
1189
|
+
97
|
|
1190
|
+
98</pre>
|
|
1191
|
+
</td>
|
|
1192
|
+
<td>
|
|
1193
|
+
<pre class="code"><span class="info file"># File 'lib/fantasy/actor.rb', line 96</span>
|
|
1194
|
+
|
|
1195
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_direction'>direction</span>
|
|
1196
|
+
<span class='ivar'>@direction</span>
|
|
1197
|
+
<span class='kw'>end</span></pre>
|
|
1198
|
+
</td>
|
|
1199
|
+
</tr>
|
|
1200
|
+
</table>
|
|
1201
|
+
</div>
|
|
1202
|
+
|
|
1203
|
+
|
|
1204
|
+
<span id="gravity=-instance_method"></span>
|
|
1205
|
+
<div class="method_details ">
|
|
1206
|
+
<h3 class="signature " id="gravity-instance_method">
|
|
1207
|
+
|
|
1208
|
+
#<strong>gravity</strong> ⇒ <tt>Float</tt>
|
|
1209
|
+
|
|
1210
|
+
|
|
1211
|
+
|
|
1212
|
+
|
|
1213
|
+
|
|
1214
|
+
</h3><div class="docstring">
|
|
1215
|
+
<div class="discussion">
|
|
1216
|
+
|
|
1217
|
+
<div class="note notetag">
|
|
1218
|
+
<strong>Note:</strong>
|
|
1219
|
+
<div class='inline'><p>The the direction will be <code>Coordinates.down</code></p>
|
|
1220
|
+
</div>
|
|
1221
|
+
</div>
|
|
1222
|
+
|
|
1223
|
+
<p>Controls constant force this Actor will receive on each frame.</p>
|
|
1224
|
+
|
|
1225
|
+
<p>Default <code>0</code>.</p>
|
|
1226
|
+
|
|
1227
|
+
|
|
1228
|
+
</div>
|
|
1229
|
+
</div>
|
|
1230
|
+
<div class="tags">
|
|
1231
|
+
|
|
1232
|
+
<div class="examples">
|
|
1233
|
+
<p class="tag_title">Examples:</p>
|
|
1234
|
+
|
|
1235
|
+
|
|
1236
|
+
<p class="example_title"><div class='inline'><p>Set gravity</p>
|
|
1237
|
+
</div></p>
|
|
1238
|
+
|
|
1239
|
+
<pre class="example code"><code><span class='id identifier rubyid_actor'>actor</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="" title="Actor (class)">Actor</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="#initialize-instance_method" title="Actor#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>image</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span>
|
|
1240
|
+
<span class='id identifier rubyid_actor'>actor</span><span class='period'>.</span><span class='id identifier rubyid_gravity'>gravity</span> <span class='op'>=</span> <span class='int'>10</span></code></pre>
|
|
1241
|
+
|
|
1242
|
+
</div>
|
|
1243
|
+
|
|
1244
|
+
<p class="tag_title">Returns:</p>
|
|
1245
|
+
<ul class="return">
|
|
1246
|
+
|
|
1247
|
+
<li>
|
|
1248
|
+
|
|
1249
|
+
|
|
1250
|
+
<span class='type'>(<tt>Float</tt>)</span>
|
|
1251
|
+
|
|
1252
|
+
|
|
1253
|
+
|
|
1254
|
+
—
|
|
1255
|
+
<div class='inline'><p>the actual gravity</p>
|
|
1256
|
+
</div>
|
|
1257
|
+
|
|
1258
|
+
</li>
|
|
1259
|
+
|
|
1260
|
+
</ul>
|
|
1261
|
+
|
|
1262
|
+
</div><table class="source_code">
|
|
1263
|
+
<tr>
|
|
1264
|
+
<td>
|
|
1265
|
+
<pre class="lines">
|
|
1266
|
+
|
|
1267
|
+
|
|
1268
|
+
135
|
|
1269
|
+
136
|
|
1270
|
+
137</pre>
|
|
1271
|
+
</td>
|
|
1272
|
+
<td>
|
|
1273
|
+
<pre class="code"><span class="info file"># File 'lib/fantasy/actor.rb', line 135</span>
|
|
1274
|
+
|
|
1275
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_gravity'>gravity</span>
|
|
1276
|
+
<span class='ivar'>@gravity</span>
|
|
1277
|
+
<span class='kw'>end</span></pre>
|
|
1278
|
+
</td>
|
|
1279
|
+
</tr>
|
|
1280
|
+
</table>
|
|
1281
|
+
</div>
|
|
1282
|
+
|
|
1283
|
+
|
|
1284
|
+
<span id="jump_force=-instance_method"></span>
|
|
1285
|
+
<div class="method_details ">
|
|
1286
|
+
<h3 class="signature " id="jump_force-instance_method">
|
|
1287
|
+
|
|
1288
|
+
#<strong>jump_force</strong> ⇒ <tt>Float</tt>
|
|
1289
|
+
|
|
1290
|
+
|
|
1291
|
+
|
|
1292
|
+
|
|
1293
|
+
|
|
1294
|
+
</h3><div class="docstring">
|
|
1295
|
+
<div class="discussion">
|
|
1296
|
+
|
|
1297
|
+
<div class="note notetag">
|
|
1298
|
+
<strong>Note:</strong>
|
|
1299
|
+
<div class='inline'><p>The the direction will be <code>Coordinates.up</code></p>
|
|
1300
|
+
</div>
|
|
1301
|
+
</div>
|
|
1302
|
+
|
|
1303
|
+
<p>Controls impulse this Actor will receive when the (see #jump) is triggered.</p>
|
|
1304
|
+
|
|
1305
|
+
<p>Default <code>0</code>.</p>
|
|
1306
|
+
|
|
1307
|
+
|
|
1308
|
+
</div>
|
|
1309
|
+
</div>
|
|
1310
|
+
<div class="tags">
|
|
1311
|
+
|
|
1312
|
+
<div class="examples">
|
|
1313
|
+
<p class="tag_title">Examples:</p>
|
|
1314
|
+
|
|
1315
|
+
|
|
1316
|
+
<p class="example_title"><div class='inline'><p>Set jump_force</p>
|
|
1317
|
+
</div></p>
|
|
1318
|
+
|
|
1319
|
+
<pre class="example code"><code><span class='id identifier rubyid_actor'>actor</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="" title="Actor (class)">Actor</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="#initialize-instance_method" title="Actor#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>image</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span>
|
|
1320
|
+
<span class='id identifier rubyid_actor'>actor</span><span class='period'>.</span><span class='id identifier rubyid_jump_force'>jump_force</span> <span class='op'>=</span> <span class='int'>100</span></code></pre>
|
|
1321
|
+
|
|
1322
|
+
</div>
|
|
1323
|
+
|
|
1324
|
+
<p class="tag_title">Returns:</p>
|
|
1325
|
+
<ul class="return">
|
|
1326
|
+
|
|
1327
|
+
<li>
|
|
1328
|
+
|
|
1329
|
+
|
|
1330
|
+
<span class='type'>(<tt>Float</tt>)</span>
|
|
1331
|
+
|
|
1332
|
+
|
|
1333
|
+
|
|
1334
|
+
—
|
|
1335
|
+
<div class='inline'><p>the actual jump_force</p>
|
|
1336
|
+
</div>
|
|
1337
|
+
|
|
1338
|
+
</li>
|
|
1339
|
+
|
|
1340
|
+
</ul>
|
|
1341
|
+
|
|
1342
|
+
</div><table class="source_code">
|
|
1343
|
+
<tr>
|
|
1344
|
+
<td>
|
|
1345
|
+
<pre class="lines">
|
|
1346
|
+
|
|
1347
|
+
|
|
1348
|
+
122
|
|
1349
|
+
123
|
|
1350
|
+
124</pre>
|
|
1351
|
+
</td>
|
|
1352
|
+
<td>
|
|
1353
|
+
<pre class="code"><span class="info file"># File 'lib/fantasy/actor.rb', line 122</span>
|
|
1354
|
+
|
|
1355
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_jump_force'>jump_force</span>
|
|
1356
|
+
<span class='ivar'>@jump_force</span>
|
|
1357
|
+
<span class='kw'>end</span></pre>
|
|
1358
|
+
</td>
|
|
1359
|
+
</tr>
|
|
1360
|
+
</table>
|
|
1361
|
+
</div>
|
|
1362
|
+
|
|
1363
|
+
|
|
1364
|
+
<span id="layer=-instance_method"></span>
|
|
1365
|
+
<div class="method_details ">
|
|
1366
|
+
<h3 class="signature " id="layer-instance_method">
|
|
1367
|
+
|
|
1368
|
+
#<strong>layer</strong> ⇒ <tt>Integer</tt>
|
|
1369
|
+
|
|
1370
|
+
|
|
1371
|
+
|
|
1372
|
+
|
|
1373
|
+
|
|
1374
|
+
</h3><div class="docstring">
|
|
1375
|
+
<div class="discussion">
|
|
1376
|
+
<p>In which layer the image of the Actor is rendered.
|
|
1377
|
+
Smaller numbers are rendered behind higher numbers.</p>
|
|
1378
|
+
|
|
1379
|
+
<p>Default <code>0</code>.</p>
|
|
1380
|
+
|
|
1381
|
+
|
|
1382
|
+
</div>
|
|
1383
|
+
</div>
|
|
1384
|
+
<div class="tags">
|
|
1385
|
+
|
|
1386
|
+
<div class="examples">
|
|
1387
|
+
<p class="tag_title">Examples:</p>
|
|
1388
|
+
|
|
1389
|
+
|
|
1390
|
+
<p class="example_title"><div class='inline'><p>Set layer</p>
|
|
1391
|
+
</div></p>
|
|
1392
|
+
|
|
1393
|
+
<pre class="example code"><code><span class='id identifier rubyid_actor'>actor</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="" title="Actor (class)">Actor</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="#initialize-instance_method" title="Actor#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>image</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span>
|
|
1394
|
+
<span class='id identifier rubyid_actor'>actor</span><span class='period'>.</span><span class='id identifier rubyid_layer'>layer</span> <span class='op'>=</span> <span class='op'>-</span><span class='int'>1</span></code></pre>
|
|
1395
|
+
|
|
1396
|
+
</div>
|
|
1397
|
+
|
|
1398
|
+
<p class="tag_title">Returns:</p>
|
|
1399
|
+
<ul class="return">
|
|
1400
|
+
|
|
1401
|
+
<li>
|
|
1402
|
+
|
|
1403
|
+
|
|
1404
|
+
<span class='type'>(<tt>Integer</tt>)</span>
|
|
1405
|
+
|
|
1406
|
+
|
|
1407
|
+
|
|
1408
|
+
—
|
|
1409
|
+
<div class='inline'><p>the actual layer</p>
|
|
1410
|
+
</div>
|
|
1411
|
+
|
|
1412
|
+
</li>
|
|
1413
|
+
|
|
1414
|
+
</ul>
|
|
1415
|
+
|
|
1416
|
+
</div><table class="source_code">
|
|
1417
|
+
<tr>
|
|
1418
|
+
<td>
|
|
1419
|
+
<pre class="lines">
|
|
1420
|
+
|
|
1421
|
+
|
|
1422
|
+
202
|
|
1423
|
+
203
|
|
1424
|
+
204</pre>
|
|
1425
|
+
</td>
|
|
1426
|
+
<td>
|
|
1427
|
+
<pre class="code"><span class="info file"># File 'lib/fantasy/actor.rb', line 202</span>
|
|
1428
|
+
|
|
1429
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_layer'>layer</span>
|
|
1430
|
+
<span class='ivar'>@layer</span>
|
|
1431
|
+
<span class='kw'>end</span></pre>
|
|
1432
|
+
</td>
|
|
1433
|
+
</tr>
|
|
1434
|
+
</table>
|
|
1435
|
+
</div>
|
|
1436
|
+
|
|
1437
|
+
|
|
1438
|
+
<span id="name=-instance_method"></span>
|
|
1439
|
+
<div class="method_details ">
|
|
1440
|
+
<h3 class="signature " id="name-instance_method">
|
|
1441
|
+
|
|
1442
|
+
#<strong>name</strong> ⇒ <tt>String</tt>
|
|
1443
|
+
|
|
1444
|
+
|
|
1445
|
+
|
|
1446
|
+
|
|
1447
|
+
|
|
1448
|
+
</h3><div class="docstring">
|
|
1449
|
+
<div class="discussion">
|
|
1450
|
+
<p>The value to internal name of this Actor.</p>
|
|
1451
|
+
|
|
1452
|
+
<p>It is useful for collision management for example.</p>
|
|
1453
|
+
|
|
1454
|
+
<p>Default (same as <code>image_name</code>).</p>
|
|
1455
|
+
|
|
1456
|
+
|
|
1457
|
+
</div>
|
|
1458
|
+
</div>
|
|
1459
|
+
<div class="tags">
|
|
1460
|
+
|
|
1461
|
+
<div class="examples">
|
|
1462
|
+
<p class="tag_title">Examples:</p>
|
|
1463
|
+
|
|
1464
|
+
|
|
1465
|
+
<p class="example_title"><div class='inline'><p>Set name</p>
|
|
1466
|
+
</div></p>
|
|
1467
|
+
|
|
1468
|
+
<pre class="example code"><code><span class='id identifier rubyid_actor'>actor</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="" title="Actor (class)">Actor</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="#initialize-instance_method" title="Actor#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>image</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span>
|
|
1469
|
+
<span class='id identifier rubyid_actor'>actor</span><span class='period'>.</span><span class='id identifier rubyid_name'>name</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>spaceship</span><span class='tstring_end'>"</span></span></code></pre>
|
|
1470
|
+
|
|
1471
|
+
|
|
1472
|
+
<p class="example_title"><div class='inline'><p>Used in collision trigger</p>
|
|
1473
|
+
</div></p>
|
|
1474
|
+
|
|
1475
|
+
<pre class="example code"><code><span class='id identifier rubyid_actor'>actor</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="" title="Actor (class)">Actor</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="#initialize-instance_method" title="Actor#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>image</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span>
|
|
1476
|
+
<span class='id identifier rubyid_actor'>actor</span><span class='period'>.</span><span class='id identifier rubyid_on_collision'>on_collision</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_other'>other</span><span class='op'>|</span>
|
|
1477
|
+
<span class='kw'>if</span> <span class='id identifier rubyid_other'>other</span><span class='period'>.</span><span class='id identifier rubyid_name'>name</span> <span class='op'>==</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>enemy</span><span class='tstring_end'>"</span></span>
|
|
1478
|
+
<span class='comment'># damage
|
|
1479
|
+
</span> <span class='kw'>end</span>
|
|
1480
|
+
<span class='kw'>end</span></code></pre>
|
|
1481
|
+
|
|
1482
|
+
|
|
1483
|
+
<p class="example_title"><div class='inline'><p>Used with <code>collision_with</code></p>
|
|
1484
|
+
</div></p>
|
|
1485
|
+
|
|
1486
|
+
<pre class="example code"><code><span class='id identifier rubyid_actor'>actor</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="" title="Actor (class)">Actor</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="#initialize-instance_method" title="Actor#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>image</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span>
|
|
1487
|
+
<span class='id identifier rubyid_actor'>actor</span><span class='period'>.</span><span class='id identifier rubyid_collision_with'>collision_with</span> <span class='op'>=</span> <span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>enemy</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>bullet</span><span class='tstring_end'>"</span></span><span class='rbracket'>]</span></code></pre>
|
|
1488
|
+
|
|
1489
|
+
</div>
|
|
1490
|
+
|
|
1491
|
+
<p class="tag_title">Returns:</p>
|
|
1492
|
+
<ul class="return">
|
|
1493
|
+
|
|
1494
|
+
<li>
|
|
1495
|
+
|
|
1496
|
+
|
|
1497
|
+
<span class='type'>(<tt>String</tt>)</span>
|
|
1498
|
+
|
|
1499
|
+
|
|
1500
|
+
|
|
1501
|
+
—
|
|
1502
|
+
<div class='inline'><p>the actual name</p>
|
|
1503
|
+
</div>
|
|
1504
|
+
|
|
1505
|
+
</li>
|
|
1506
|
+
|
|
1507
|
+
</ul>
|
|
1508
|
+
|
|
1509
|
+
</div><table class="source_code">
|
|
1510
|
+
<tr>
|
|
1511
|
+
<td>
|
|
1512
|
+
<pre class="lines">
|
|
1513
|
+
|
|
1514
|
+
|
|
1515
|
+
190
|
|
1516
|
+
191
|
|
1517
|
+
192</pre>
|
|
1518
|
+
</td>
|
|
1519
|
+
<td>
|
|
1520
|
+
<pre class="code"><span class="info file"># File 'lib/fantasy/actor.rb', line 190</span>
|
|
1521
|
+
|
|
1522
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_name'>name</span>
|
|
1523
|
+
<span class='ivar'>@name</span>
|
|
1524
|
+
<span class='kw'>end</span></pre>
|
|
1525
|
+
</td>
|
|
1526
|
+
</tr>
|
|
1527
|
+
</table>
|
|
1528
|
+
</div>
|
|
1529
|
+
|
|
1530
|
+
|
|
1531
|
+
<span id="position=-instance_method"></span>
|
|
1532
|
+
<div class="method_details ">
|
|
1533
|
+
<h3 class="signature " id="position-instance_method">
|
|
1534
|
+
|
|
1535
|
+
#<strong>position</strong> ⇒ <tt><span class='object_link'><a href="Coordinates.html" title="Coordinates (class)">Coordinates</a></span></tt>
|
|
1536
|
+
|
|
1537
|
+
|
|
1538
|
+
|
|
1539
|
+
|
|
1540
|
+
|
|
1541
|
+
</h3><div class="docstring">
|
|
1542
|
+
<div class="discussion">
|
|
1543
|
+
<p>Coordinates object where x and y represent the position of the Actor in the World (no necessarily in the Screen).</p>
|
|
1544
|
+
|
|
1545
|
+
<p>Default <code>Coordinates.zero</code>.</p>
|
|
1546
|
+
|
|
1547
|
+
|
|
1548
|
+
</div>
|
|
1549
|
+
</div>
|
|
1550
|
+
<div class="tags">
|
|
1551
|
+
|
|
1552
|
+
<div class="examples">
|
|
1553
|
+
<p class="tag_title">Examples:</p>
|
|
1554
|
+
|
|
1555
|
+
|
|
1556
|
+
<p class="example_title"><div class='inline'><p>Setting position</p>
|
|
1557
|
+
</div></p>
|
|
1558
|
+
|
|
1559
|
+
<pre class="example code"><code><span class='id identifier rubyid_actor'>actor</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="" title="Actor (class)">Actor</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="#initialize-instance_method" title="Actor#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>image</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span>
|
|
1560
|
+
<span class='id identifier rubyid_actor'>actor</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>
|
|
1561
|
+
<span class='id identifier rubyid_actor'>actor</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'># => 10</span></code></pre>
|
|
1562
|
+
|
|
1563
|
+
|
|
1564
|
+
<p class="example_title"><div class='inline'><p>Modify position</p>
|
|
1565
|
+
</div></p>
|
|
1566
|
+
|
|
1567
|
+
<pre class="example code"><code><span class='id identifier rubyid_actor'>actor</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>
|
|
1568
|
+
<span class='id identifier rubyid_actor'>actor</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'># => 11</span></code></pre>
|
|
1569
|
+
|
|
1570
|
+
</div>
|
|
1571
|
+
|
|
1572
|
+
<p class="tag_title">Returns:</p>
|
|
1573
|
+
<ul class="return">
|
|
1574
|
+
|
|
1575
|
+
<li>
|
|
1576
|
+
|
|
1577
|
+
|
|
1578
|
+
<span class='type'>(<tt><span class='object_link'><a href="Coordinates.html" title="Coordinates (class)">Coordinates</a></span></tt>)</span>
|
|
1579
|
+
|
|
1580
|
+
|
|
1581
|
+
|
|
1582
|
+
—
|
|
1583
|
+
<div class='inline'><p>the actual position</p>
|
|
1584
|
+
</div>
|
|
1585
|
+
|
|
1586
|
+
</li>
|
|
1587
|
+
|
|
1588
|
+
</ul>
|
|
1589
|
+
|
|
1590
|
+
</div><table class="source_code">
|
|
1591
|
+
<tr>
|
|
1592
|
+
<td>
|
|
1593
|
+
<pre class="lines">
|
|
1594
|
+
|
|
1595
|
+
|
|
1596
|
+
83
|
|
1597
|
+
84
|
|
1598
|
+
85</pre>
|
|
1599
|
+
</td>
|
|
1600
|
+
<td>
|
|
1601
|
+
<pre class="code"><span class="info file"># File 'lib/fantasy/actor.rb', line 83</span>
|
|
1602
|
+
|
|
1603
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_position'>position</span>
|
|
1604
|
+
<span class='ivar'>@position</span>
|
|
1605
|
+
<span class='kw'>end</span></pre>
|
|
1606
|
+
</td>
|
|
1607
|
+
</tr>
|
|
1608
|
+
</table>
|
|
1609
|
+
</div>
|
|
1610
|
+
|
|
1611
|
+
|
|
1612
|
+
<span id="scale=-instance_method"></span>
|
|
1613
|
+
<div class="method_details ">
|
|
1614
|
+
<h3 class="signature " id="scale-instance_method">
|
|
1615
|
+
|
|
1616
|
+
#<strong>scale</strong> ⇒ <tt>Float</tt>
|
|
1617
|
+
|
|
1618
|
+
|
|
1619
|
+
|
|
1620
|
+
|
|
1621
|
+
|
|
1622
|
+
</h3><div class="docstring">
|
|
1623
|
+
<div class="discussion">
|
|
1624
|
+
|
|
1625
|
+
<div class="note notetag">
|
|
1626
|
+
<strong>Note:</strong>
|
|
1627
|
+
<div class='inline'><p>this value affects the attributes <code>width</code> and <code>height</code></p>
|
|
1628
|
+
</div>
|
|
1629
|
+
</div>
|
|
1630
|
+
|
|
1631
|
+
<p>The value to scale the image of the Actor when drawn.
|
|
1632
|
+
If the value is <code>2</code> the image will rendered at double of size.
|
|
1633
|
+
If the value is <code>0.5</code> the image will rendered at half of size.</p>
|
|
1634
|
+
|
|
1635
|
+
<p>Default <code>1</code>.</p>
|
|
1636
|
+
|
|
1637
|
+
|
|
1638
|
+
</div>
|
|
1639
|
+
</div>
|
|
1640
|
+
<div class="tags">
|
|
1641
|
+
|
|
1642
|
+
<div class="examples">
|
|
1643
|
+
<p class="tag_title">Examples:</p>
|
|
1644
|
+
|
|
1645
|
+
|
|
1646
|
+
<p class="example_title"><div class='inline'><p>Set scale</p>
|
|
1647
|
+
</div></p>
|
|
1648
|
+
|
|
1649
|
+
<pre class="example code"><code><span class='id identifier rubyid_actor'>actor</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="" title="Actor (class)">Actor</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="#initialize-instance_method" title="Actor#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>image</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span>
|
|
1650
|
+
<span class='id identifier rubyid_actor'>actor</span><span class='period'>.</span><span class='id identifier rubyid_scale'>scale</span> <span class='op'>=</span> <span class='int'>6</span></code></pre>
|
|
1651
|
+
|
|
1652
|
+
</div>
|
|
1653
|
+
|
|
1654
|
+
<p class="tag_title">Returns:</p>
|
|
1655
|
+
<ul class="return">
|
|
1656
|
+
|
|
1657
|
+
<li>
|
|
1658
|
+
|
|
1659
|
+
|
|
1660
|
+
<span class='type'>(<tt>Float</tt>)</span>
|
|
1661
|
+
|
|
1662
|
+
|
|
1663
|
+
|
|
1664
|
+
—
|
|
1665
|
+
<div class='inline'><p>the actual scale</p>
|
|
1666
|
+
</div>
|
|
1667
|
+
|
|
1668
|
+
</li>
|
|
1669
|
+
|
|
1670
|
+
</ul>
|
|
1671
|
+
|
|
1672
|
+
</div><table class="source_code">
|
|
1673
|
+
<tr>
|
|
1674
|
+
<td>
|
|
1675
|
+
<pre class="lines">
|
|
1676
|
+
|
|
1677
|
+
|
|
1678
|
+
165
|
|
1679
|
+
166
|
|
1680
|
+
167</pre>
|
|
1681
|
+
</td>
|
|
1682
|
+
<td>
|
|
1683
|
+
<pre class="code"><span class="info file"># File 'lib/fantasy/actor.rb', line 165</span>
|
|
1684
|
+
|
|
1685
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_scale'>scale</span>
|
|
1686
|
+
<span class='ivar'>@scale</span>
|
|
1687
|
+
<span class='kw'>end</span></pre>
|
|
1688
|
+
</td>
|
|
1689
|
+
</tr>
|
|
1690
|
+
</table>
|
|
1691
|
+
</div>
|
|
1692
|
+
|
|
1693
|
+
|
|
1694
|
+
<span id="solid=-instance_method"></span>
|
|
1695
|
+
<div class="method_details ">
|
|
1696
|
+
<h3 class="signature " id="solid-instance_method">
|
|
1697
|
+
|
|
1698
|
+
#<strong>solid</strong> ⇒ <tt>Boolean</tt>
|
|
1699
|
+
|
|
1700
|
+
|
|
1701
|
+
|
|
1702
|
+
|
|
1703
|
+
|
|
1704
|
+
</h3><div class="docstring">
|
|
1705
|
+
<div class="discussion">
|
|
1706
|
+
<p>When <code>true</code> the Actor will cause and respond to collisions.</p>
|
|
1707
|
+
|
|
1708
|
+
<p>When <code>false</code> the Actor won't cause neither respond to collisions.</p>
|
|
1709
|
+
|
|
1710
|
+
<p>Default <code>true</code>.</p>
|
|
1711
|
+
|
|
1712
|
+
|
|
1713
|
+
</div>
|
|
1714
|
+
</div>
|
|
1715
|
+
<div class="tags">
|
|
1716
|
+
|
|
1717
|
+
<div class="examples">
|
|
1718
|
+
<p class="tag_title">Examples:</p>
|
|
1719
|
+
|
|
1720
|
+
|
|
1721
|
+
<p class="example_title"><div class='inline'><p>Set solid</p>
|
|
1722
|
+
</div></p>
|
|
1723
|
+
|
|
1724
|
+
<pre class="example code"><code><span class='id identifier rubyid_actor'>actor</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="" title="Actor (class)">Actor</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="#initialize-instance_method" title="Actor#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>image</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span>
|
|
1725
|
+
<span class='id identifier rubyid_actor'>actor</span><span class='period'>.</span><span class='id identifier rubyid_solid'>solid</span> <span class='op'>=</span> <span class='kw'>false</span></code></pre>
|
|
1726
|
+
|
|
1727
|
+
</div>
|
|
1728
|
+
<p class="tag_title">Parameters:</p>
|
|
1729
|
+
<ul class="param">
|
|
1730
|
+
|
|
1731
|
+
<li>
|
|
1732
|
+
|
|
1733
|
+
<span class='name'>solid</span>
|
|
1734
|
+
|
|
1735
|
+
|
|
1736
|
+
<span class='type'>(<tt>true</tt>, <tt>false</tt>)</span>
|
|
1737
|
+
|
|
1738
|
+
|
|
1739
|
+
|
|
1740
|
+
—
|
|
1741
|
+
<div class='inline'><p>only true or false</p>
|
|
1742
|
+
</div>
|
|
1743
|
+
|
|
1744
|
+
</li>
|
|
1745
|
+
|
|
1746
|
+
</ul>
|
|
1747
|
+
|
|
1748
|
+
<p class="tag_title">Returns:</p>
|
|
1749
|
+
<ul class="return">
|
|
1750
|
+
|
|
1751
|
+
<li>
|
|
1752
|
+
|
|
1753
|
+
|
|
1754
|
+
<span class='type'>(<tt>Boolean</tt>)</span>
|
|
1755
|
+
|
|
1756
|
+
|
|
1757
|
+
|
|
1758
|
+
—
|
|
1759
|
+
<div class='inline'><p>the actual solid value</p>
|
|
1760
|
+
</div>
|
|
1761
|
+
|
|
1762
|
+
</li>
|
|
1763
|
+
|
|
1764
|
+
</ul>
|
|
1765
|
+
|
|
1766
|
+
</div><table class="source_code">
|
|
1767
|
+
<tr>
|
|
1768
|
+
<td>
|
|
1769
|
+
<pre class="lines">
|
|
1770
|
+
|
|
1771
|
+
|
|
1772
|
+
150
|
|
1773
|
+
151
|
|
1774
|
+
152</pre>
|
|
1775
|
+
</td>
|
|
1776
|
+
<td>
|
|
1777
|
+
<pre class="code"><span class="info file"># File 'lib/fantasy/actor.rb', line 150</span>
|
|
1778
|
+
|
|
1779
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_solid'>solid</span>
|
|
1780
|
+
<span class='ivar'>@solid</span>
|
|
1781
|
+
<span class='kw'>end</span></pre>
|
|
1782
|
+
</td>
|
|
1783
|
+
</tr>
|
|
1784
|
+
</table>
|
|
1785
|
+
</div>
|
|
1786
|
+
|
|
1787
|
+
|
|
1788
|
+
<span id="speed=-instance_method"></span>
|
|
1789
|
+
<div class="method_details ">
|
|
1790
|
+
<h3 class="signature " id="speed-instance_method">
|
|
1791
|
+
|
|
1792
|
+
#<strong>speed</strong> ⇒ <tt>Float</tt>
|
|
1793
|
+
|
|
1794
|
+
|
|
1795
|
+
|
|
1796
|
+
|
|
1797
|
+
|
|
1798
|
+
</h3><div class="docstring">
|
|
1799
|
+
<div class="discussion">
|
|
1800
|
+
|
|
1801
|
+
<div class="note notetag">
|
|
1802
|
+
<strong>Note:</strong>
|
|
1803
|
+
<div class='inline'><p>The the direction is represented by the <code>@direction</code> attribute</p>
|
|
1804
|
+
</div>
|
|
1805
|
+
</div>
|
|
1806
|
+
|
|
1807
|
+
<p>Controls the pixels per second which this Actor will move in the next frame.</p>
|
|
1808
|
+
|
|
1809
|
+
<p>Default <code>0</code>.</p>
|
|
1810
|
+
|
|
1811
|
+
|
|
1812
|
+
</div>
|
|
1813
|
+
</div>
|
|
1814
|
+
<div class="tags">
|
|
1815
|
+
|
|
1816
|
+
<div class="examples">
|
|
1817
|
+
<p class="tag_title">Examples:</p>
|
|
1818
|
+
|
|
1819
|
+
|
|
1820
|
+
<p class="example_title"><div class='inline'><p>Set speed</p>
|
|
1821
|
+
</div></p>
|
|
1822
|
+
|
|
1823
|
+
<pre class="example code"><code><span class='id identifier rubyid_actor'>actor</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="" title="Actor (class)">Actor</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="#initialize-instance_method" title="Actor#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>image</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span>
|
|
1824
|
+
<span class='id identifier rubyid_actor'>actor</span><span class='period'>.</span><span class='id identifier rubyid_speed'>speed</span> <span class='op'>=</span> <span class='int'>10</span></code></pre>
|
|
1825
|
+
|
|
1826
|
+
</div>
|
|
1827
|
+
|
|
1828
|
+
<p class="tag_title">Returns:</p>
|
|
1829
|
+
<ul class="return">
|
|
1830
|
+
|
|
1831
|
+
<li>
|
|
1832
|
+
|
|
1833
|
+
|
|
1834
|
+
<span class='type'>(<tt>Float</tt>)</span>
|
|
1835
|
+
|
|
1836
|
+
|
|
1837
|
+
|
|
1838
|
+
—
|
|
1839
|
+
<div class='inline'><p>the actual speed</p>
|
|
1840
|
+
</div>
|
|
1841
|
+
|
|
1842
|
+
</li>
|
|
1843
|
+
|
|
1844
|
+
</ul>
|
|
1845
|
+
|
|
1846
|
+
</div><table class="source_code">
|
|
1847
|
+
<tr>
|
|
1848
|
+
<td>
|
|
1849
|
+
<pre class="lines">
|
|
1850
|
+
|
|
1851
|
+
|
|
1852
|
+
109
|
|
1853
|
+
110
|
|
1854
|
+
111</pre>
|
|
1855
|
+
</td>
|
|
1856
|
+
<td>
|
|
1857
|
+
<pre class="code"><span class="info file"># File 'lib/fantasy/actor.rb', line 109</span>
|
|
1858
|
+
|
|
1859
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_speed'>speed</span>
|
|
1860
|
+
<span class='ivar'>@speed</span>
|
|
1861
|
+
<span class='kw'>end</span></pre>
|
|
1862
|
+
</td>
|
|
1863
|
+
</tr>
|
|
1864
|
+
</table>
|
|
1865
|
+
</div>
|
|
1866
|
+
|
|
1867
|
+
</div>
|
|
1868
|
+
|
|
1869
|
+
|
|
1870
|
+
<div id="instance_method_details" class="method_details_list">
|
|
1871
|
+
<h2>Instance Method Details</h2>
|
|
1872
|
+
|
|
1873
|
+
|
|
1874
|
+
<div class="method_details first">
|
|
1875
|
+
<h3 class="signature first" id="destroy-instance_method">
|
|
1876
|
+
|
|
1877
|
+
#<strong>destroy</strong> ⇒ <tt>Object</tt>
|
|
1878
|
+
|
|
1879
|
+
|
|
1880
|
+
|
|
1881
|
+
|
|
1882
|
+
|
|
1883
|
+
</h3><div class="docstring">
|
|
1884
|
+
<div class="discussion">
|
|
1885
|
+
<p>Destroy this Actor is not longer, moved, or rendered, or cause any collision.</p>
|
|
1886
|
+
|
|
1887
|
+
|
|
1888
|
+
</div>
|
|
1889
|
+
</div>
|
|
1890
|
+
<div class="tags">
|
|
1891
|
+
|
|
1892
|
+
<div class="examples">
|
|
1893
|
+
<p class="tag_title">Examples:</p>
|
|
1894
|
+
|
|
1895
|
+
|
|
1896
|
+
<p class="example_title"><div class='inline'><p>Destroy an Actor</p>
|
|
1897
|
+
</div></p>
|
|
1898
|
+
|
|
1899
|
+
<pre class="example code"><code><span class='id identifier rubyid_actor'>actor</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="" title="Actor (class)">Actor</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="#initialize-instance_method" title="Actor#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>image</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span>
|
|
1900
|
+
<span class='id identifier rubyid_actor'>actor</span><span class='period'>.</span><span class='id identifier rubyid_destroy'>destroy</span></code></pre>
|
|
1901
|
+
|
|
1902
|
+
</div>
|
|
1903
|
+
|
|
1904
|
+
|
|
1905
|
+
</div><table class="source_code">
|
|
1906
|
+
<tr>
|
|
1907
|
+
<td>
|
|
1908
|
+
<pre class="lines">
|
|
1909
|
+
|
|
1910
|
+
|
|
1911
|
+
386
|
|
1912
|
+
387
|
|
1913
|
+
388
|
|
1914
|
+
389</pre>
|
|
1915
|
+
</td>
|
|
1916
|
+
<td>
|
|
1917
|
+
<pre class="code"><span class="info file"># File 'lib/fantasy/actor.rb', line 386</span>
|
|
1918
|
+
|
|
1919
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_destroy'>destroy</span>
|
|
1920
|
+
<span class='id identifier rubyid_on_destroy_do'>on_destroy_do</span>
|
|
1921
|
+
<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_actors'><span class='object_link'><a href="Global.html#actors-class_method" title="Global.actors (method)">actors</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>
|
|
1922
|
+
<span class='kw'>end</span></pre>
|
|
1923
|
+
</td>
|
|
1924
|
+
</tr>
|
|
1925
|
+
</table>
|
|
1926
|
+
</div>
|
|
1927
|
+
|
|
1928
|
+
<div class="method_details ">
|
|
1929
|
+
<h3 class="signature " id="height-instance_method">
|
|
1930
|
+
|
|
1931
|
+
#<strong>height</strong> ⇒ <tt>Fixnum</tt>
|
|
1932
|
+
|
|
1933
|
+
|
|
1934
|
+
|
|
1935
|
+
|
|
1936
|
+
|
|
1937
|
+
</h3><div class="docstring">
|
|
1938
|
+
<div class="discussion">
|
|
1939
|
+
<p>Returns the Actor height in pixels.</p>
|
|
1940
|
+
|
|
1941
|
+
|
|
1942
|
+
</div>
|
|
1943
|
+
</div>
|
|
1944
|
+
<div class="tags">
|
|
1945
|
+
|
|
1946
|
+
<p class="tag_title">Returns:</p>
|
|
1947
|
+
<ul class="return">
|
|
1948
|
+
|
|
1949
|
+
<li>
|
|
1950
|
+
|
|
1951
|
+
|
|
1952
|
+
<span class='type'>(<tt>Fixnum</tt>)</span>
|
|
1953
|
+
|
|
1954
|
+
|
|
1955
|
+
|
|
1956
|
+
—
|
|
1957
|
+
<div class='inline'><p>the Actor height in pixels</p>
|
|
1958
|
+
</div>
|
|
1959
|
+
|
|
1960
|
+
</li>
|
|
1961
|
+
|
|
1962
|
+
</ul>
|
|
1963
|
+
|
|
1964
|
+
</div><table class="source_code">
|
|
1965
|
+
<tr>
|
|
1966
|
+
<td>
|
|
1967
|
+
<pre class="lines">
|
|
1968
|
+
|
|
1969
|
+
|
|
1970
|
+
282
|
|
1971
|
+
283
|
|
1972
|
+
284</pre>
|
|
1973
|
+
</td>
|
|
1974
|
+
<td>
|
|
1975
|
+
<pre class="code"><span class="info file"># File 'lib/fantasy/actor.rb', line 282</span>
|
|
1976
|
+
|
|
1977
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_height'>height</span>
|
|
1978
|
+
<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>
|
|
1979
|
+
<span class='kw'>end</span></pre>
|
|
1980
|
+
</td>
|
|
1981
|
+
</tr>
|
|
1982
|
+
</table>
|
|
1983
|
+
</div>
|
|
1984
|
+
|
|
1985
|
+
<div class="method_details ">
|
|
1986
|
+
<h3 class="signature " id="image=-instance_method">
|
|
1987
|
+
|
|
1988
|
+
#<strong>image=</strong>(image_name) ⇒ <tt>Object</tt>
|
|
1989
|
+
|
|
1990
|
+
|
|
1991
|
+
|
|
1992
|
+
|
|
1993
|
+
|
|
1994
|
+
</h3><div class="docstring">
|
|
1995
|
+
<div class="discussion">
|
|
1996
|
+
<p>Set a new image to the Actor.</p>
|
|
1997
|
+
|
|
1998
|
+
|
|
1999
|
+
</div>
|
|
2000
|
+
</div>
|
|
2001
|
+
<div class="tags">
|
|
2002
|
+
|
|
2003
|
+
<div class="examples">
|
|
2004
|
+
<p class="tag_title">Examples:</p>
|
|
2005
|
+
|
|
2006
|
+
|
|
2007
|
+
<p class="example_title"><div class='inline'><p>Set a new image</p>
|
|
2008
|
+
</div></p>
|
|
2009
|
+
|
|
2010
|
+
<pre class="example code"><code><span class='id identifier rubyid_actor'>actor</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="" title="Actor (class)">Actor</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="#initialize-instance_method" title="Actor#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>player_walk</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span>
|
|
2011
|
+
<span class='id identifier rubyid_actor'>actor</span><span class='period'>.</span><span class='id identifier rubyid_image_name'>image_name</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>player_jump</span><span class='tstring_end'>"</span></span></code></pre>
|
|
2012
|
+
|
|
2013
|
+
</div>
|
|
2014
|
+
<p class="tag_title">Parameters:</p>
|
|
2015
|
+
<ul class="param">
|
|
2016
|
+
|
|
2017
|
+
<li>
|
|
2018
|
+
|
|
2019
|
+
<span class='name'>image_name</span>
|
|
2020
|
+
|
|
2021
|
+
|
|
2022
|
+
<span class='type'>(<tt>String</tt>)</span>
|
|
2023
|
+
|
|
2024
|
+
|
|
2025
|
+
|
|
2026
|
+
—
|
|
2027
|
+
<div class='inline'><p>The image file from <code>./images/*</code></p>
|
|
2028
|
+
</div>
|
|
2029
|
+
|
|
2030
|
+
</li>
|
|
2031
|
+
|
|
2032
|
+
</ul>
|
|
2033
|
+
|
|
2034
|
+
|
|
2035
|
+
</div><table class="source_code">
|
|
2036
|
+
<tr>
|
|
2037
|
+
<td>
|
|
2038
|
+
<pre class="lines">
|
|
2039
|
+
|
|
2040
|
+
|
|
2041
|
+
272
|
|
2042
|
+
273
|
|
2043
|
+
274</pre>
|
|
2044
|
+
</td>
|
|
2045
|
+
<td>
|
|
2046
|
+
<pre class="code"><span class="info file"># File 'lib/fantasy/actor.rb', line 272</span>
|
|
2047
|
+
|
|
2048
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_image='>image=</span><span class='lparen'>(</span><span class='id identifier rubyid_image_name'>image_name</span><span class='rparen'>)</span>
|
|
2049
|
+
<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>
|
|
2050
|
+
<span class='kw'>end</span></pre>
|
|
2051
|
+
</td>
|
|
2052
|
+
</tr>
|
|
2053
|
+
</table>
|
|
2054
|
+
</div>
|
|
2055
|
+
|
|
2056
|
+
<div class="method_details ">
|
|
2057
|
+
<h3 class="signature " id="on_after_move-instance_method">
|
|
2058
|
+
|
|
2059
|
+
#<strong>on_after_move</strong>(&block) ⇒ <tt>Object</tt>
|
|
2060
|
+
|
|
2061
|
+
|
|
2062
|
+
|
|
2063
|
+
|
|
2064
|
+
|
|
2065
|
+
</h3><div class="docstring">
|
|
2066
|
+
<div class="discussion">
|
|
2067
|
+
<p>The block to be executed after each frame</p>
|
|
2068
|
+
|
|
2069
|
+
|
|
2070
|
+
</div>
|
|
2071
|
+
</div>
|
|
2072
|
+
<div class="tags">
|
|
2073
|
+
|
|
2074
|
+
<div class="examples">
|
|
2075
|
+
<p class="tag_title">Examples:</p>
|
|
2076
|
+
|
|
2077
|
+
|
|
2078
|
+
<p class="example_title"><div class='inline'><p>Limit Actor movement horizontally</p>
|
|
2079
|
+
</div></p>
|
|
2080
|
+
|
|
2081
|
+
<pre class="example code"><code><span class='id identifier rubyid_actor'>actor</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="" title="Actor (class)">Actor</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="#initialize-instance_method" title="Actor#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>image</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span>
|
|
2082
|
+
<span class='id identifier rubyid_actor'>actor</span><span class='period'>.</span><span class='id identifier rubyid_on_after_move'>on_after_move</span> <span class='kw'>do</span>
|
|
2083
|
+
<span class='kw'>if</span> <span class='id identifier rubyid_actor'>actor</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'>100</span>
|
|
2084
|
+
<span class='id identifier rubyid_actor'>actor</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'>100</span>
|
|
2085
|
+
<span class='kw'>end</span>
|
|
2086
|
+
<span class='kw'>end</span></code></pre>
|
|
2087
|
+
|
|
2088
|
+
</div>
|
|
2089
|
+
|
|
2090
|
+
|
|
2091
|
+
</div><table class="source_code">
|
|
2092
|
+
<tr>
|
|
2093
|
+
<td>
|
|
2094
|
+
<pre class="lines">
|
|
2095
|
+
|
|
2096
|
+
|
|
2097
|
+
441
|
|
2098
|
+
442
|
|
2099
|
+
443</pre>
|
|
2100
|
+
</td>
|
|
2101
|
+
<td>
|
|
2102
|
+
<pre class="code"><span class="info file"># File 'lib/fantasy/actor.rb', line 441</span>
|
|
2103
|
+
|
|
2104
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_on_after_move'>on_after_move</span><span class='lparen'>(</span><span class='op'>&</span><span class='id identifier rubyid_block'>block</span><span class='rparen'>)</span>
|
|
2105
|
+
<span class='ivar'>@on_after_move_callback</span> <span class='op'>=</span> <span class='id identifier rubyid_block'>block</span>
|
|
2106
|
+
<span class='kw'>end</span></pre>
|
|
2107
|
+
</td>
|
|
2108
|
+
</tr>
|
|
2109
|
+
</table>
|
|
2110
|
+
</div>
|
|
2111
|
+
|
|
2112
|
+
<div class="method_details ">
|
|
2113
|
+
<h3 class="signature " id="on_after_move_do-instance_method">
|
|
2114
|
+
|
|
2115
|
+
#<strong>on_after_move_do</strong> ⇒ <tt>Object</tt>
|
|
2116
|
+
|
|
2117
|
+
|
|
2118
|
+
|
|
2119
|
+
|
|
2120
|
+
|
|
2121
|
+
</h3><div class="docstring">
|
|
2122
|
+
<div class="discussion">
|
|
2123
|
+
<p>This method is triggered after each frame</p>
|
|
2124
|
+
|
|
2125
|
+
|
|
2126
|
+
</div>
|
|
2127
|
+
</div>
|
|
2128
|
+
<div class="tags">
|
|
2129
|
+
|
|
2130
|
+
<div class="examples">
|
|
2131
|
+
<p class="tag_title">Examples:</p>
|
|
2132
|
+
|
|
2133
|
+
|
|
2134
|
+
<p class="example_title"><div class='inline'><p>Limit Actor movement horizontally</p>
|
|
2135
|
+
</div></p>
|
|
2136
|
+
|
|
2137
|
+
<pre class="example code"><code><span class='kw'>class</span> <span class='const'>Player</span> <span class='op'><</span> <span class='const'><span class='object_link'><a href="" title="Actor (class)">Actor</a></span></span>
|
|
2138
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_on_after_move_do'>on_after_move_do</span>
|
|
2139
|
+
<span class='kw'>if</span> <span class='ivar'>@position</span><span class='period'>.</span><span class='id identifier rubyid_x'>x</span> <span class='op'>></span> <span class='int'>100</span>
|
|
2140
|
+
<span class='ivar'>@position</span><span class='period'>.</span><span class='id identifier rubyid_x'>x</span> <span class='op'>=</span> <span class='int'>100</span>
|
|
2141
|
+
<span class='kw'>end</span>
|
|
2142
|
+
<span class='kw'>end</span>
|
|
2143
|
+
<span class='kw'>end</span></code></pre>
|
|
2144
|
+
|
|
2145
|
+
</div>
|
|
2146
|
+
|
|
2147
|
+
|
|
2148
|
+
</div><table class="source_code">
|
|
2149
|
+
<tr>
|
|
2150
|
+
<td>
|
|
2151
|
+
<pre class="lines">
|
|
2152
|
+
|
|
2153
|
+
|
|
2154
|
+
504
|
|
2155
|
+
505
|
|
2156
|
+
506</pre>
|
|
2157
|
+
</td>
|
|
2158
|
+
<td>
|
|
2159
|
+
<pre class="code"><span class="info file"># File 'lib/fantasy/actor.rb', line 504</span>
|
|
2160
|
+
|
|
2161
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_on_after_move_do'>on_after_move_do</span>
|
|
2162
|
+
<span class='id identifier rubyid_instance_exec'>instance_exec</span><span class='lparen'>(</span><span class='op'>&</span><span class='ivar'>@on_after_move_callback</span><span class='rparen'>)</span> <span class='kw'>unless</span> <span class='ivar'>@on_after_move_callback</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span>
|
|
2163
|
+
<span class='kw'>end</span></pre>
|
|
2164
|
+
</td>
|
|
2165
|
+
</tr>
|
|
2166
|
+
</table>
|
|
2167
|
+
</div>
|
|
2168
|
+
|
|
2169
|
+
<div class="method_details ">
|
|
2170
|
+
<h3 class="signature " id="on_collision-instance_method">
|
|
2171
|
+
|
|
2172
|
+
#<strong>on_collision</strong>(&block) ⇒ <tt>Object</tt>
|
|
2173
|
+
|
|
2174
|
+
|
|
2175
|
+
|
|
2176
|
+
|
|
2177
|
+
|
|
2178
|
+
</h3><div class="docstring">
|
|
2179
|
+
<div class="discussion">
|
|
2180
|
+
<p>The block to be executed when Actor collides with another Actor</p>
|
|
2181
|
+
|
|
2182
|
+
|
|
2183
|
+
</div>
|
|
2184
|
+
</div>
|
|
2185
|
+
<div class="tags">
|
|
2186
|
+
|
|
2187
|
+
<div class="examples">
|
|
2188
|
+
<p class="tag_title">Examples:</p>
|
|
2189
|
+
|
|
2190
|
+
|
|
2191
|
+
<p class="example_title"><div class='inline'><p>Collision detected with <em>"bullet"</em></p>
|
|
2192
|
+
</div></p>
|
|
2193
|
+
|
|
2194
|
+
<pre class="example code"><code><span class='id identifier rubyid_actor'>actor</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="" title="Actor (class)">Actor</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="#initialize-instance_method" title="Actor#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>image</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span>
|
|
2195
|
+
<span class='id identifier rubyid_actor'>actor</span><span class='period'>.</span><span class='id identifier rubyid_on_collision'>on_collision</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_other'>other</span><span class='op'>|</span>
|
|
2196
|
+
<span class='kw'>if</span> <span class='id identifier rubyid_other'>other</span><span class='period'>.</span><span class='id identifier rubyid_name'>name</span> <span class='op'>==</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>bullet</span><span class='tstring_end'>"</span></span>
|
|
2197
|
+
<span class='id identifier rubyid_actor'>actor</span><span class='period'>.</span><span class='id identifier rubyid_destroy'>destroy</span>
|
|
2198
|
+
<span class='kw'>end</span>
|
|
2199
|
+
<span class='kw'>end</span></code></pre>
|
|
2200
|
+
|
|
2201
|
+
</div>
|
|
2202
|
+
|
|
2203
|
+
|
|
2204
|
+
</div><table class="source_code">
|
|
2205
|
+
<tr>
|
|
2206
|
+
<td>
|
|
2207
|
+
<pre class="lines">
|
|
2208
|
+
|
|
2209
|
+
|
|
2210
|
+
454
|
|
2211
|
+
455
|
|
2212
|
+
456</pre>
|
|
2213
|
+
</td>
|
|
2214
|
+
<td>
|
|
2215
|
+
<pre class="code"><span class="info file"># File 'lib/fantasy/actor.rb', line 454</span>
|
|
2216
|
+
|
|
2217
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_on_collision'>on_collision</span><span class='lparen'>(</span><span class='op'>&</span><span class='id identifier rubyid_block'>block</span><span class='rparen'>)</span>
|
|
2218
|
+
<span class='ivar'>@on_collision_callback</span> <span class='op'>=</span> <span class='id identifier rubyid_block'>block</span>
|
|
2219
|
+
<span class='kw'>end</span></pre>
|
|
2220
|
+
</td>
|
|
2221
|
+
</tr>
|
|
2222
|
+
</table>
|
|
2223
|
+
</div>
|
|
2224
|
+
|
|
2225
|
+
<div class="method_details ">
|
|
2226
|
+
<h3 class="signature " id="on_collision_do-instance_method">
|
|
2227
|
+
|
|
2228
|
+
#<strong>on_collision_do</strong>(other) ⇒ <tt>Object</tt>
|
|
2229
|
+
|
|
2230
|
+
|
|
2231
|
+
|
|
2232
|
+
|
|
2233
|
+
|
|
2234
|
+
</h3><div class="docstring">
|
|
2235
|
+
<div class="discussion">
|
|
2236
|
+
<p>This method is triggered when Actor collides with another Actor</p>
|
|
2237
|
+
|
|
2238
|
+
|
|
2239
|
+
</div>
|
|
2240
|
+
</div>
|
|
2241
|
+
<div class="tags">
|
|
2242
|
+
|
|
2243
|
+
<div class="examples">
|
|
2244
|
+
<p class="tag_title">Examples:</p>
|
|
2245
|
+
|
|
2246
|
+
|
|
2247
|
+
<p class="example_title"><div class='inline'><p>Limit Actor movement horizontally</p>
|
|
2248
|
+
</div></p>
|
|
2249
|
+
|
|
2250
|
+
<pre class="example code"><code><span class='kw'>class</span> <span class='const'>Player</span> <span class='op'><</span> <span class='const'><span class='object_link'><a href="" title="Actor (class)">Actor</a></span></span>
|
|
2251
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_on_collision_do'>on_collision_do</span><span class='lparen'>(</span><span class='id identifier rubyid_other'>other</span><span class='rparen'>)</span>
|
|
2252
|
+
<span class='kw'>if</span> <span class='id identifier rubyid_other'>other</span><span class='period'>.</span><span class='id identifier rubyid_name'>name</span> <span class='op'>==</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>bullet</span><span class='tstring_end'>"</span></span>
|
|
2253
|
+
<span class='id identifier rubyid_destroy'>destroy</span>
|
|
2254
|
+
<span class='kw'>end</span>
|
|
2255
|
+
<span class='kw'>end</span>
|
|
2256
|
+
<span class='kw'>end</span></code></pre>
|
|
2257
|
+
|
|
2258
|
+
</div>
|
|
2259
|
+
|
|
2260
|
+
|
|
2261
|
+
</div><table class="source_code">
|
|
2262
|
+
<tr>
|
|
2263
|
+
<td>
|
|
2264
|
+
<pre class="lines">
|
|
2265
|
+
|
|
2266
|
+
|
|
2267
|
+
518
|
|
2268
|
+
519
|
|
2269
|
+
520</pre>
|
|
2270
|
+
</td>
|
|
2271
|
+
<td>
|
|
2272
|
+
<pre class="code"><span class="info file"># File 'lib/fantasy/actor.rb', line 518</span>
|
|
2273
|
+
|
|
2274
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_on_collision_do'>on_collision_do</span><span class='lparen'>(</span><span class='id identifier rubyid_other'>other</span><span class='rparen'>)</span>
|
|
2275
|
+
<span class='id identifier rubyid_instance_exec'>instance_exec</span><span class='lparen'>(</span><span class='id identifier rubyid_other'>other</span><span class='comma'>,</span> <span class='op'>&</span><span class='ivar'>@on_collision_callback</span><span class='rparen'>)</span> <span class='kw'>unless</span> <span class='ivar'>@on_collision_callback</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span>
|
|
2276
|
+
<span class='kw'>end</span></pre>
|
|
2277
|
+
</td>
|
|
2278
|
+
</tr>
|
|
2279
|
+
</table>
|
|
2280
|
+
</div>
|
|
2281
|
+
|
|
2282
|
+
<div class="method_details ">
|
|
2283
|
+
<h3 class="signature " id="on_destroy-instance_method">
|
|
2284
|
+
|
|
2285
|
+
#<strong>on_destroy</strong>(&block) ⇒ <tt>Object</tt>
|
|
2286
|
+
|
|
2287
|
+
|
|
2288
|
+
|
|
2289
|
+
|
|
2290
|
+
|
|
2291
|
+
</h3><div class="docstring">
|
|
2292
|
+
<div class="discussion">
|
|
2293
|
+
<p>The block to be executed before the Actor is destroyed</p>
|
|
2294
|
+
|
|
2295
|
+
|
|
2296
|
+
</div>
|
|
2297
|
+
</div>
|
|
2298
|
+
<div class="tags">
|
|
2299
|
+
|
|
2300
|
+
<div class="examples">
|
|
2301
|
+
<p class="tag_title">Examples:</p>
|
|
2302
|
+
|
|
2303
|
+
|
|
2304
|
+
<p class="example_title"><div class='inline'><p>Executes when destroyed</p>
|
|
2305
|
+
</div></p>
|
|
2306
|
+
|
|
2307
|
+
<pre class="example code"><code><span class='id identifier rubyid_actor'>actor</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="" title="Actor (class)">Actor</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="#initialize-instance_method" title="Actor#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>image</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span>
|
|
2308
|
+
<span class='id identifier rubyid_actor'>actor</span><span class='period'>.</span><span class='id identifier rubyid_on_destroy'>on_destroy</span> <span class='kw'>do</span>
|
|
2309
|
+
<span class='const'><span class='object_link'><a href="Sound.html" title="Sound (module)">Sound</a></span></span><span class='period'>.</span><span class='id identifier rubyid_play'><span class='object_link'><a href="Sound.html#play-class_method" title="Sound.play (method)">play</a></span></span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>explosion</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span>
|
|
2310
|
+
<span class='kw'>end</span></code></pre>
|
|
2311
|
+
|
|
2312
|
+
</div>
|
|
2313
|
+
|
|
2314
|
+
|
|
2315
|
+
</div><table class="source_code">
|
|
2316
|
+
<tr>
|
|
2317
|
+
<td>
|
|
2318
|
+
<pre class="lines">
|
|
2319
|
+
|
|
2320
|
+
|
|
2321
|
+
465
|
|
2322
|
+
466
|
|
2323
|
+
467</pre>
|
|
2324
|
+
</td>
|
|
2325
|
+
<td>
|
|
2326
|
+
<pre class="code"><span class="info file"># File 'lib/fantasy/actor.rb', line 465</span>
|
|
2327
|
+
|
|
2328
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_on_destroy'>on_destroy</span><span class='lparen'>(</span><span class='op'>&</span><span class='id identifier rubyid_block'>block</span><span class='rparen'>)</span>
|
|
2329
|
+
<span class='ivar'>@on_destroy_callback</span> <span class='op'>=</span> <span class='id identifier rubyid_block'>block</span>
|
|
2330
|
+
<span class='kw'>end</span></pre>
|
|
2331
|
+
</td>
|
|
2332
|
+
</tr>
|
|
2333
|
+
</table>
|
|
2334
|
+
</div>
|
|
2335
|
+
|
|
2336
|
+
<div class="method_details ">
|
|
2337
|
+
<h3 class="signature " id="on_destroy_do-instance_method">
|
|
2338
|
+
|
|
2339
|
+
#<strong>on_destroy_do</strong> ⇒ <tt>Object</tt>
|
|
2340
|
+
|
|
2341
|
+
|
|
2342
|
+
|
|
2343
|
+
|
|
2344
|
+
|
|
2345
|
+
</h3><div class="docstring">
|
|
2346
|
+
<div class="discussion">
|
|
2347
|
+
<p>This method is triggered before the Actor is destroyed</p>
|
|
2348
|
+
|
|
2349
|
+
|
|
2350
|
+
</div>
|
|
2351
|
+
</div>
|
|
2352
|
+
<div class="tags">
|
|
2353
|
+
|
|
2354
|
+
<div class="examples">
|
|
2355
|
+
<p class="tag_title">Examples:</p>
|
|
2356
|
+
|
|
2357
|
+
|
|
2358
|
+
<p class="example_title"><div class='inline'><p>Executes when destroyed</p>
|
|
2359
|
+
</div></p>
|
|
2360
|
+
|
|
2361
|
+
<pre class="example code"><code><span class='kw'>class</span> <span class='const'>Player</span> <span class='op'><</span> <span class='const'><span class='object_link'><a href="" title="Actor (class)">Actor</a></span></span>
|
|
2362
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_on_destroy_do'>on_destroy_do</span>
|
|
2363
|
+
<span class='const'><span class='object_link'><a href="Sound.html" title="Sound (module)">Sound</a></span></span><span class='period'>.</span><span class='id identifier rubyid_play'><span class='object_link'><a href="Sound.html#play-class_method" title="Sound.play (method)">play</a></span></span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>explosion</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span>
|
|
2364
|
+
<span class='kw'>end</span>
|
|
2365
|
+
<span class='kw'>end</span></code></pre>
|
|
2366
|
+
|
|
2367
|
+
</div>
|
|
2368
|
+
|
|
2369
|
+
|
|
2370
|
+
</div><table class="source_code">
|
|
2371
|
+
<tr>
|
|
2372
|
+
<td>
|
|
2373
|
+
<pre class="lines">
|
|
2374
|
+
|
|
2375
|
+
|
|
2376
|
+
530
|
|
2377
|
+
531
|
|
2378
|
+
532</pre>
|
|
2379
|
+
</td>
|
|
2380
|
+
<td>
|
|
2381
|
+
<pre class="code"><span class="info file"># File 'lib/fantasy/actor.rb', line 530</span>
|
|
2382
|
+
|
|
2383
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_on_destroy_do'>on_destroy_do</span>
|
|
2384
|
+
<span class='id identifier rubyid_instance_exec'>instance_exec</span><span class='lparen'>(</span><span class='op'>&</span><span class='ivar'>@on_destroy_callback</span><span class='rparen'>)</span> <span class='kw'>unless</span> <span class='ivar'>@on_destroy_callback</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span>
|
|
2385
|
+
<span class='kw'>end</span></pre>
|
|
2386
|
+
</td>
|
|
2387
|
+
</tr>
|
|
2388
|
+
</table>
|
|
2389
|
+
</div>
|
|
2390
|
+
|
|
2391
|
+
<div class="method_details ">
|
|
2392
|
+
<h3 class="signature " id="on_floor-instance_method">
|
|
2393
|
+
|
|
2394
|
+
#<strong>on_floor</strong>(&block) ⇒ <tt>Object</tt>
|
|
2395
|
+
|
|
2396
|
+
|
|
2397
|
+
|
|
2398
|
+
|
|
2399
|
+
|
|
2400
|
+
</h3><div class="docstring">
|
|
2401
|
+
<div class="discussion">
|
|
2402
|
+
<p>The block to be executed when the Actor touches floor</p>
|
|
2403
|
+
|
|
2404
|
+
|
|
2405
|
+
</div>
|
|
2406
|
+
</div>
|
|
2407
|
+
<div class="tags">
|
|
2408
|
+
|
|
2409
|
+
<div class="examples">
|
|
2410
|
+
<p class="tag_title">Examples:</p>
|
|
2411
|
+
|
|
2412
|
+
|
|
2413
|
+
<p class="example_title"><div class='inline'><p>Change image when jumping</p>
|
|
2414
|
+
</div></p>
|
|
2415
|
+
|
|
2416
|
+
<pre class="example code"><code><span class='id identifier rubyid_actor'>actor</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="" title="Actor (class)">Actor</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="#initialize-instance_method" title="Actor#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>walk</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span>
|
|
2417
|
+
<span class='id identifier rubyid_actor'>actor</span><span class='period'>.</span><span class='id identifier rubyid_on_floor'>on_floor</span> <span class='kw'>do</span>
|
|
2418
|
+
<span class='id identifier rubyid_actor'>actor</span><span class='period'>.</span><span class='id identifier rubyid_image_name'>image_name</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>land</span><span class='tstring_end'>"</span></span>
|
|
2419
|
+
<span class='const'><span class='object_link'><a href="Clock.html" title="Clock (class)">Clock</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="Clock.html#initialize-instance_method" title="Clock#initialize (method)">new</a></span></span> <span class='lbrace'>{</span> <span class='id identifier rubyid_actor'>actor</span><span class='period'>.</span><span class='id identifier rubyid_image_name'>image_name</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>walk</span><span class='tstring_end'>"</span></span> <span class='rbrace'>}</span><span class='period'>.</span><span class='id identifier rubyid_run_on'>run_on</span><span class='lparen'>(</span><span class='label'>seconds:</span> <span class='float'>0.8</span><span class='rparen'>)</span>
|
|
2420
|
+
<span class='kw'>end</span></code></pre>
|
|
2421
|
+
|
|
2422
|
+
</div>
|
|
2423
|
+
|
|
2424
|
+
|
|
2425
|
+
</div><table class="source_code">
|
|
2426
|
+
<tr>
|
|
2427
|
+
<td>
|
|
2428
|
+
<pre class="lines">
|
|
2429
|
+
|
|
2430
|
+
|
|
2431
|
+
488
|
|
2432
|
+
489
|
|
2433
|
+
490</pre>
|
|
2434
|
+
</td>
|
|
2435
|
+
<td>
|
|
2436
|
+
<pre class="code"><span class="info file"># File 'lib/fantasy/actor.rb', line 488</span>
|
|
2437
|
+
|
|
2438
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_on_floor'>on_floor</span><span class='lparen'>(</span><span class='op'>&</span><span class='id identifier rubyid_block'>block</span><span class='rparen'>)</span>
|
|
2439
|
+
<span class='ivar'>@on_floor_callback</span> <span class='op'>=</span> <span class='id identifier rubyid_block'>block</span>
|
|
2440
|
+
<span class='kw'>end</span></pre>
|
|
2441
|
+
</td>
|
|
2442
|
+
</tr>
|
|
2443
|
+
</table>
|
|
2444
|
+
</div>
|
|
2445
|
+
|
|
2446
|
+
<div class="method_details ">
|
|
2447
|
+
<h3 class="signature " id="on_floor_do-instance_method">
|
|
2448
|
+
|
|
2449
|
+
#<strong>on_floor_do</strong> ⇒ <tt>Object</tt>
|
|
2450
|
+
|
|
2451
|
+
|
|
2452
|
+
|
|
2453
|
+
|
|
2454
|
+
|
|
2455
|
+
</h3><div class="docstring">
|
|
2456
|
+
<div class="discussion">
|
|
2457
|
+
<p>This method is triggered when the Actor touches floor</p>
|
|
2458
|
+
|
|
2459
|
+
|
|
2460
|
+
</div>
|
|
2461
|
+
</div>
|
|
2462
|
+
<div class="tags">
|
|
2463
|
+
|
|
2464
|
+
<div class="examples">
|
|
2465
|
+
<p class="tag_title">Examples:</p>
|
|
2466
|
+
|
|
2467
|
+
|
|
2468
|
+
<p class="example_title"><div class='inline'><p>Change image when jumping</p>
|
|
2469
|
+
</div></p>
|
|
2470
|
+
|
|
2471
|
+
<pre class="example code"><code>class Player < Actor
|
|
2472
|
+
def.on_floor_do
|
|
2473
|
+
self.image_name = "land"
|
|
2474
|
+
Clock.new { self.image_name = "walk" }.run_on(seconds: 0.8)
|
|
2475
|
+
end
|
|
2476
|
+
end</code></pre>
|
|
2477
|
+
|
|
2478
|
+
</div>
|
|
2479
|
+
|
|
2480
|
+
|
|
2481
|
+
</div><table class="source_code">
|
|
2482
|
+
<tr>
|
|
2483
|
+
<td>
|
|
2484
|
+
<pre class="lines">
|
|
2485
|
+
|
|
2486
|
+
|
|
2487
|
+
555
|
|
2488
|
+
556
|
|
2489
|
+
557</pre>
|
|
2490
|
+
</td>
|
|
2491
|
+
<td>
|
|
2492
|
+
<pre class="code"><span class="info file"># File 'lib/fantasy/actor.rb', line 555</span>
|
|
2493
|
+
|
|
2494
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_on_floor_do'>on_floor_do</span>
|
|
2495
|
+
<span class='id identifier rubyid_instance_exec'>instance_exec</span><span class='lparen'>(</span><span class='op'>&</span><span class='ivar'>@on_floor_callback</span><span class='rparen'>)</span> <span class='kw'>unless</span> <span class='ivar'>@on_floor_callback</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span>
|
|
2496
|
+
<span class='kw'>end</span></pre>
|
|
2497
|
+
</td>
|
|
2498
|
+
</tr>
|
|
2499
|
+
</table>
|
|
2500
|
+
</div>
|
|
2501
|
+
|
|
2502
|
+
<div class="method_details ">
|
|
2503
|
+
<h3 class="signature " id="on_jumping-instance_method">
|
|
2504
|
+
|
|
2505
|
+
#<strong>on_jumping</strong>(&block) ⇒ <tt>Object</tt>
|
|
2506
|
+
|
|
2507
|
+
|
|
2508
|
+
|
|
2509
|
+
|
|
2510
|
+
|
|
2511
|
+
</h3><div class="docstring">
|
|
2512
|
+
<div class="discussion">
|
|
2513
|
+
<p>The block to be executed when the Actor starts jumping</p>
|
|
2514
|
+
|
|
2515
|
+
|
|
2516
|
+
</div>
|
|
2517
|
+
</div>
|
|
2518
|
+
<div class="tags">
|
|
2519
|
+
|
|
2520
|
+
<div class="examples">
|
|
2521
|
+
<p class="tag_title">Examples:</p>
|
|
2522
|
+
|
|
2523
|
+
|
|
2524
|
+
<p class="example_title"><div class='inline'><p>Change image when jumping</p>
|
|
2525
|
+
</div></p>
|
|
2526
|
+
|
|
2527
|
+
<pre class="example code"><code><span class='id identifier rubyid_actor'>actor</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="" title="Actor (class)">Actor</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="#initialize-instance_method" title="Actor#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>walk</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span>
|
|
2528
|
+
<span class='id identifier rubyid_actor'>actor</span><span class='period'>.</span><span class='id identifier rubyid_on_jumping'>on_jumping</span> <span class='kw'>do</span>
|
|
2529
|
+
<span class='id identifier rubyid_actor'>actor</span><span class='period'>.</span><span class='id identifier rubyid_image_name'>image_name</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>jump</span><span class='tstring_end'>"</span></span>
|
|
2530
|
+
<span class='kw'>end</span></code></pre>
|
|
2531
|
+
|
|
2532
|
+
</div>
|
|
2533
|
+
|
|
2534
|
+
|
|
2535
|
+
</div><table class="source_code">
|
|
2536
|
+
<tr>
|
|
2537
|
+
<td>
|
|
2538
|
+
<pre class="lines">
|
|
2539
|
+
|
|
2540
|
+
|
|
2541
|
+
476
|
|
2542
|
+
477
|
|
2543
|
+
478</pre>
|
|
2544
|
+
</td>
|
|
2545
|
+
<td>
|
|
2546
|
+
<pre class="code"><span class="info file"># File 'lib/fantasy/actor.rb', line 476</span>
|
|
2547
|
+
|
|
2548
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_on_jumping'>on_jumping</span><span class='lparen'>(</span><span class='op'>&</span><span class='id identifier rubyid_block'>block</span><span class='rparen'>)</span>
|
|
2549
|
+
<span class='ivar'>@on_jumping_callback</span> <span class='op'>=</span> <span class='id identifier rubyid_block'>block</span>
|
|
2550
|
+
<span class='kw'>end</span></pre>
|
|
2551
|
+
</td>
|
|
2552
|
+
</tr>
|
|
2553
|
+
</table>
|
|
2554
|
+
</div>
|
|
2555
|
+
|
|
2556
|
+
<div class="method_details ">
|
|
2557
|
+
<h3 class="signature " id="on_jumping_do-instance_method">
|
|
2558
|
+
|
|
2559
|
+
#<strong>on_jumping_do</strong> ⇒ <tt>Object</tt>
|
|
2560
|
+
|
|
2561
|
+
|
|
2562
|
+
|
|
2563
|
+
|
|
2564
|
+
|
|
2565
|
+
</h3><div class="docstring">
|
|
2566
|
+
<div class="discussion">
|
|
2567
|
+
<p>This method is triggered when the Actor starts jumping</p>
|
|
2568
|
+
|
|
2569
|
+
|
|
2570
|
+
</div>
|
|
2571
|
+
</div>
|
|
2572
|
+
<div class="tags">
|
|
2573
|
+
|
|
2574
|
+
<div class="examples">
|
|
2575
|
+
<p class="tag_title">Examples:</p>
|
|
2576
|
+
|
|
2577
|
+
|
|
2578
|
+
<p class="example_title"><div class='inline'><p>Change image when jumping</p>
|
|
2579
|
+
</div></p>
|
|
2580
|
+
|
|
2581
|
+
<pre class="example code"><code><span class='kw'>class</span> <span class='const'>Player</span> <span class='op'><</span> <span class='const'><span class='object_link'><a href="" title="Actor (class)">Actor</a></span></span>
|
|
2582
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_on_jumping_do'>on_jumping_do</span>
|
|
2583
|
+
<span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_image_name'>image_name</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>jump</span><span class='tstring_end'>"</span></span>
|
|
2584
|
+
<span class='kw'>end</span>
|
|
2585
|
+
<span class='kw'>end</span></code></pre>
|
|
2586
|
+
|
|
2587
|
+
</div>
|
|
2588
|
+
|
|
2589
|
+
|
|
2590
|
+
</div><table class="source_code">
|
|
2591
|
+
<tr>
|
|
2592
|
+
<td>
|
|
2593
|
+
<pre class="lines">
|
|
2594
|
+
|
|
2595
|
+
|
|
2596
|
+
542
|
|
2597
|
+
543
|
|
2598
|
+
544</pre>
|
|
2599
|
+
</td>
|
|
2600
|
+
<td>
|
|
2601
|
+
<pre class="code"><span class="info file"># File 'lib/fantasy/actor.rb', line 542</span>
|
|
2602
|
+
|
|
2603
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_on_jumping_do'>on_jumping_do</span>
|
|
2604
|
+
<span class='id identifier rubyid_instance_exec'>instance_exec</span><span class='lparen'>(</span><span class='op'>&</span><span class='ivar'>@on_jumping_callback</span><span class='rparen'>)</span> <span class='kw'>unless</span> <span class='ivar'>@on_jumping_callback</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span>
|
|
2605
|
+
<span class='kw'>end</span></pre>
|
|
2606
|
+
</td>
|
|
2607
|
+
</tr>
|
|
2608
|
+
</table>
|
|
2609
|
+
</div>
|
|
2610
|
+
|
|
2611
|
+
<div class="method_details ">
|
|
2612
|
+
<h3 class="signature " id="solid?-instance_method">
|
|
2613
|
+
|
|
2614
|
+
#<strong>solid?</strong> ⇒ <tt>Boolean</tt>
|
|
2615
|
+
|
|
2616
|
+
|
|
2617
|
+
|
|
2618
|
+
|
|
2619
|
+
|
|
2620
|
+
</h3><div class="docstring">
|
|
2621
|
+
<div class="discussion">
|
|
2622
|
+
<p>Returns the value of <code>@solid</code>.</p>
|
|
2623
|
+
|
|
2624
|
+
|
|
2625
|
+
</div>
|
|
2626
|
+
</div>
|
|
2627
|
+
<div class="tags">
|
|
2628
|
+
|
|
2629
|
+
<p class="tag_title">Returns:</p>
|
|
2630
|
+
<ul class="return">
|
|
2631
|
+
|
|
2632
|
+
<li>
|
|
2633
|
+
|
|
2634
|
+
|
|
2635
|
+
<span class='type'>(<tt>Boolean</tt>)</span>
|
|
2636
|
+
|
|
2637
|
+
|
|
2638
|
+
|
|
2639
|
+
—
|
|
2640
|
+
<div class='inline'><p>the value of <code>@solid</code></p>
|
|
2641
|
+
</div>
|
|
2642
|
+
|
|
2643
|
+
</li>
|
|
2644
|
+
|
|
2645
|
+
</ul>
|
|
2646
|
+
|
|
2647
|
+
</div><table class="source_code">
|
|
2648
|
+
<tr>
|
|
2649
|
+
<td>
|
|
2650
|
+
<pre class="lines">
|
|
2651
|
+
|
|
2652
|
+
|
|
2653
|
+
287
|
|
2654
|
+
288
|
|
2655
|
+
289</pre>
|
|
2656
|
+
</td>
|
|
2657
|
+
<td>
|
|
2658
|
+
<pre class="code"><span class="info file"># File 'lib/fantasy/actor.rb', line 287</span>
|
|
2659
|
+
|
|
2660
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_solid?'>solid?</span>
|
|
2661
|
+
<span class='ivar'>@solid</span>
|
|
2662
|
+
<span class='kw'>end</span></pre>
|
|
2663
|
+
</td>
|
|
2664
|
+
</tr>
|
|
2665
|
+
</table>
|
|
2666
|
+
</div>
|
|
2667
|
+
|
|
2668
|
+
<div class="method_details ">
|
|
2669
|
+
<h3 class="signature " id="width-instance_method">
|
|
2670
|
+
|
|
2671
|
+
#<strong>width</strong> ⇒ <tt>Fixnum</tt>
|
|
2672
|
+
|
|
2673
|
+
|
|
2674
|
+
|
|
2675
|
+
|
|
2676
|
+
|
|
2677
|
+
</h3><div class="docstring">
|
|
2678
|
+
<div class="discussion">
|
|
2679
|
+
<p>Returns the Actor width in pixels.</p>
|
|
2680
|
+
|
|
2681
|
+
|
|
2682
|
+
</div>
|
|
2683
|
+
</div>
|
|
2684
|
+
<div class="tags">
|
|
2685
|
+
|
|
2686
|
+
<p class="tag_title">Returns:</p>
|
|
2687
|
+
<ul class="return">
|
|
2688
|
+
|
|
2689
|
+
<li>
|
|
2690
|
+
|
|
2691
|
+
|
|
2692
|
+
<span class='type'>(<tt>Fixnum</tt>)</span>
|
|
2693
|
+
|
|
2694
|
+
|
|
2695
|
+
|
|
2696
|
+
—
|
|
2697
|
+
<div class='inline'><p>the Actor width in pixels</p>
|
|
2698
|
+
</div>
|
|
2699
|
+
|
|
2700
|
+
</li>
|
|
2701
|
+
|
|
2702
|
+
</ul>
|
|
2703
|
+
|
|
2704
|
+
</div><table class="source_code">
|
|
2705
|
+
<tr>
|
|
2706
|
+
<td>
|
|
2707
|
+
<pre class="lines">
|
|
2708
|
+
|
|
2709
|
+
|
|
2710
|
+
277
|
|
2711
|
+
278
|
|
2712
|
+
279</pre>
|
|
2713
|
+
</td>
|
|
2714
|
+
<td>
|
|
2715
|
+
<pre class="code"><span class="info file"># File 'lib/fantasy/actor.rb', line 277</span>
|
|
2716
|
+
|
|
2717
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_width'>width</span>
|
|
2718
|
+
<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>
|
|
2719
|
+
<span class='kw'>end</span></pre>
|
|
2720
|
+
</td>
|
|
2721
|
+
</tr>
|
|
2722
|
+
</table>
|
|
2723
|
+
</div>
|
|
2724
|
+
|
|
2725
|
+
</div>
|
|
2726
|
+
|
|
2727
|
+
</div>
|
|
2728
|
+
|
|
2729
|
+
<div id="footer">
|
|
2730
|
+
Generated on Sat Apr 2 14:24:12 2022 by
|
|
2731
|
+
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
|
2732
|
+
0.9.27 (ruby-3.0.2).
|
|
2733
|
+
</div>
|
|
2734
|
+
|
|
2735
|
+
</div>
|
|
2736
|
+
</body>
|
|
2737
|
+
</html>
|