Skip to content

Commit 0aed2c9

Browse files
ShadowMarioShadowMario
committed
Added loadMultipleFrames and grammar corrections
1 parent 2709a54 commit 0aed2c9

File tree

6 files changed

+37
-23
lines changed

6 files changed

+37
-23
lines changed

‎pages/input.html‎

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ <h1>Input Functions</h1>
4242
<hr>
4343
<h2 id="mouseClicked">mouseClicked</h2>
4444
<p class="methodbox">mouseClicked(<span class="isoptional"?></span><span class="variablemarkup">button</span>:String = 'left'):Bool</p>
45-
<p>Returns if the Mouse button just got clicked in this frame.</p>
45+
<p>Returns whether the Mouse button just got clicked in this frame.</p>
4646
<ul>
4747
<li><b><span class="variablemarkup">button</span></b> - Can be: "left", "middle" or "right". Defaults to "left"</li>
4848
</ul>
@@ -55,15 +55,15 @@ <h4>Examples:</h4>
5555

5656
<h2 id="mousePressed">mousePressed</h2>
5757
<p class="methodbox">mousePressed(<span class="isoptional"?></span><span class="variablemarkup">button</span>:String = 'left'):Bool</p>
58-
<p>Returns if the Mouse button is being held currently.</p>
58+
<p>Returns whether the Mouse button is being held currently.</p>
5959
<ul>
6060
<li><b><span class="variablemarkup">button</span></b> - Can be: "left", "middle" or "right". Defaults to "left"</li>
6161
</ul>
6262
<hr>
6363

6464
<h2 id="mouseReleased">mouseReleased</h2>
6565
<p class="methodbox">mouseReleased(<span class="isoptional"?></span><span class="variablemarkup">button</span>:String = 'left'):Bool</p>
66-
<p>Returns if the Mouse button was just released in this frame.</p>
66+
<p>Returns whether the Mouse button was just released in this frame.</p>
6767
<ul>
6868
<li><b><span class="variablemarkup">button</span></b> - Can be: "left", "middle" or "right". Defaults to "left"</li>
6969
</ul>
@@ -92,7 +92,7 @@ <h2 id="getMouseY">getMouseY</h2>
9292

9393
<h2 id="keyJustPressed">keyJustPressed</h2>
9494
<p class="methodbox">keyJustPressed(<span class="variablemarkup">button</span>:String):Bool</p>
95-
<p>Returns if a keybind button just got pressed on a controller or keyboard.</p>
95+
<p>Returns whether a keybind button just got pressed on a controller or keyboard.</p>
9696
<ul>
9797
<li><b><span class="variablemarkup">button</span></b> - Buttons: "left", "down", "up", "right", "ui_left", "ui_down", "ui_up", "ui_right", "accept", "back", "pause", "reset", "volume_mute", "volume_up_down", "debug_1", "debug_2".</li>
9898
</ul>
@@ -105,23 +105,23 @@ <h4>Examples:</h4>
105105

106106
<h2 id="keyJustPressed">keyPressed</h2>
107107
<p class="methodbox">keyPressed(<span class="variablemarkup">button</span>:String):Bool</p>
108-
<p>Returns if a keybind button is being held on a controller or keyboard.</p>
108+
<p>Returns whether a keybind button is being held on a controller or keyboard.</p>
109109
<ul>
110110
<li><b><span class="variablemarkup">button</span></b> - Same as <a href="#keyJustPressed">"keyJustPressed"</a>.</li>
111111
</ul>
112112
<hr>
113113

114114
<h2 id="keyReleased">keyReleased</h2>
115115
<p class="methodbox">keyReleased(<span class="variablemarkup">button</span>:String):Bool</p>
116-
<p>Returns if a keybind button was just released on a controller or keyboard.</p>
116+
<p>Returns whether a keybind button was just released on a controller or keyboard.</p>
117117
<ul>
118118
<li><b><span class="variablemarkup">button</span></b> - Same as <a href="#keyJustPressed">"keyJustPressed"</a>.</li>
119119
</ul>
120120
<hr>
121121

122122
<h2 id="keyboardJustPressed">keyboardJustPressed</h2>
123123
<p class="methodbox">keyboardJustPressed(<span class="variablemarkup">button</span>:String):Bool</p>
124-
<p>Returns if a specific keyboard button just got pressed.</p>
124+
<p>Returns whether a specific keyboard button just got pressed.</p>
125125
<ul>
126126
<li><b><span class="variablemarkup">button</span></b> - <a href="https://api.haxeflixel.com/flixel/input/keyboard/FlxKey.html">Click here for the full list of buttons</a>.</li>
127127
</ul>
@@ -134,23 +134,23 @@ <h4>Examples:</h4>
134134

135135
<h2 id="keyboardPressed">keyboardPressed</h2>
136136
<p class="methodbox">keyboardPressed(<span class="variablemarkup">button</span>:String):Bool</p>
137-
<p>Returns if a specific keyboard button is being pressed.</p>
137+
<p>Returns whether a specific keyboard button is being pressed.</p>
138138
<ul>
139139
<li><b><span class="variablemarkup">button</span></b> - <a href="https://api.haxeflixel.com/flixel/input/keyboard/FlxKey.html">Click here for the full list of buttons</a>.</li>
140140
</ul>
141141
<hr>
142142

143143
<h2 id="keyboardReleased">keyboardReleased</h2>
144144
<p class="methodbox">keyboardReleased(<span class="variablemarkup">button</span>:String):Bool</p>
145-
<p>Returns if a specific keyboard button was just released.</p>
145+
<p>Returns whether a specific keyboard button was just released.</p>
146146
<ul>
147147
<li><b><span class="variablemarkup">button</span></b> - <a href="https://api.haxeflixel.com/flixel/input/keyboard/FlxKey.html">Click here for the full list of buttons</a>.</li>
148148
</ul>
149149
<hr>
150150

151151
<h2 id="anyGamepadJustPressed">anyGamepadJustPressed</h2>
152152
<p class="methodbox">anyGamepadJustPressed(<span class="variablemarkup">button</span>:String):Bool</p>
153-
<p>Returns if a specific gamepad button just got pressed in any controllers.</p>
153+
<p>Returns whether a specific gamepad button just got pressed in any controllers.</p>
154154
<ul>
155155
<li><b><span class="variablemarkup">button</span></b> - <a href="https://api.haxeflixel.com/flixel/input/gamepad/FlxGamepadInputID.html">Click here for the full list of buttons</a>.</li>
156156
</ul>
@@ -163,23 +163,23 @@ <h4>Examples:</h4>
163163

164164
<h2 id="anyGamepadPressed">anyGamepadPressed</h2>
165165
<p class="methodbox">anyGamepadPressed(<span class="variablemarkup">button</span>:String):Bool</p>
166-
<p>Returns if a specific gamepad button is being pressed in any controllers.</p>
166+
<p>Returns whether a specific gamepad button is being pressed in any controllers.</p>
167167
<ul>
168168
<li><b><span class="variablemarkup">button</span></b> - <a href="https://api.haxeflixel.com/flixel/input/gamepad/FlxGamepadInputID.html">Click here for the full list of buttons</a>.</li>
169169
</ul>
170170
<hr>
171171

172172
<h2 id="anyGamepadReleased">anyGamepadReleased</h2>
173173
<p class="methodbox">anyGamepadReleased(<span class="variablemarkup">button</span>:String):Bool</p>
174-
<p>Returns if a specific gamepad button was just released in any controllers.</p>
174+
<p>Returns whether a specific gamepad button was just released in any controllers.</p>
175175
<ul>
176176
<li><b><span class="variablemarkup">button</span></b> - <a href="https://api.haxeflixel.com/flixel/input/gamepad/FlxGamepadInputID.html">Click here for the full list of buttons</a>.</li>
177177
</ul>
178178
<hr>
179179

180180
<h2 id="gamepadJustPressed">gamepadJustPressed</h2>
181181
<p class="methodbox">gamepadJustPressed(<span class="variablemarkup">id</span>:Int, <span class="variablemarkup">button</span>:String):Bool</p>
182-
<p>Returns if a specific gamepad button just got pressed in a specific controller.</p>
182+
<p>Returns whether a specific gamepad button just got pressed in a specific controller.</p>
183183
<ul>
184184
<li><b><span class="variablemarkup">id</span></b> - Controller ID, by detection order.</li>
185185
<li><b><span class="variablemarkup">button</span></b> - <a href="https://api.haxeflixel.com/flixel/input/gamepad/FlxGamepadInputID.html">Click here for the full list of buttons</a>.</li>
@@ -193,7 +193,7 @@ <h4>Examples:</h4>
193193

194194
<h2 id="gamepadPressed">gamepadPressed</h2>
195195
<p class="methodbox">gamepadPressed(<span class="variablemarkup">id</span>:Int, <span class="variablemarkup">button</span>:String):Bool</p>
196-
<p>Returns if a specific gamepad button is being pressed in a specific controller.</p>
196+
<p>Returns whether a specific gamepad button is being pressed in a specific controller.</p>
197197
<ul>
198198
<li><b><span class="variablemarkup">id</span></b> - Controller ID, by detection order.</li>
199199
<li><b><span class="variablemarkup">button</span></b> - <a href="https://api.haxeflixel.com/flixel/input/gamepad/FlxGamepadInputID.html">Click here for the full list of buttons</a>.</li>
@@ -202,7 +202,7 @@ <h2 id="gamepadPressed">gamepadPressed</h2>
202202

203203
<h2 id="gamepadReleased">gamepadReleased</h2>
204204
<p class="methodbox">gamepadReleased(<span class="variablemarkup">id</span>:Int, <span class="variablemarkup">button</span>:String):Bool</p>
205-
<p>Returns if a specific gamepad button was just released in a specific controller.</p>
205+
<p>Returns whether a specific gamepad button was just released in a specific controller.</p>
206206
<ul>
207207
<li><b><span class="variablemarkup">id</span></b> - Controller ID, by detection order.</li>
208208
<li><b><span class="variablemarkup">button</span></b> - <a href="https://api.haxeflixel.com/flixel/input/gamepad/FlxGamepadInputID.html">Click here for the full list of buttons</a>.</li>

‎pages/reflection.html‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -294,7 +294,7 @@ <h2 id="setObjectCamera">setObjectCamera</h2>
294294
<p class="methodbox">setObjectCamera(<span class="variablemarkup">tag</span>:String,
295295
<span class="isoptional">?</span><span class="variablemarkup">camera</span>:String = 'game'):Bool</p>
296296
<p>Changes the Object's Draw Camera.
297-
<br>Returns if the operation was successful.<p>
297+
<br>Returns whether the operation was successful.<p>
298298
<ul>
299299
<li><b><span class="variablemarkup">tag</span></b> - Variable name of the instance or Lua Object nametag.</li>
300300
<li><b><span class="variablemarkup">camera</span> (Optional)</b> - Can be "game", "hud" or "other", defaults to "game".</li>
@@ -386,7 +386,7 @@ <h2 id="setBlendMode">setBlendMode</h2>
386386
<p class="methodbox">setBlendMode(<span class="variablemarkup">tag</span>:String,
387387
<span class="isoptional">?</span><span class="variablemarkup">blend</span>:String = ''):Bool</p>
388388
<p>Changes the Blend Mode of an object, similarly to Photoshop and other image editors.
389-
<br>Returns if the operation was successful.<p>
389+
<br>Returns whether the operation was successful.<p>
390390
<ul>
391391
<li><b><span class="variablemarkup">tag</span></b> - Variable name of the instance or Lua Object nametag.</li>
392392
<li><b><span class="variablemarkup">blend</span></b> - <a href="https://api.haxeflixel.com/flash/display/BlendMode.html">Blend mode name</a>, leave empty for using the default blend mode.</li>
@@ -472,7 +472,7 @@ <h2 id="getPixelColor">getPixelColor</h2>
472472

473473
<h2 id="objectsOverlap">objectsOverlap</h2>
474474
<p class="methodbox">objectsOverlap(<span class="variablemarkup">obj1</span>:String, <span class="variablemarkup">obj2</span>:String):Bool</p>
475-
<p>Returns if two Object hitboxes are overlapping each other, useful for collision checking.<p>
475+
<p>Returns whether two Object hitboxes are overlapping each other, useful for collision checking.<p>
476476
<ul>
477477
<li><b><span class="variablemarkup">obj1</span></b> - Variable name of the instance or Lua Object nametag of the first object.</li>
478478
<li><b><span class="variablemarkup">obj2</span></b> - Variable name of the instance or Lua Object nametag of the second object.</li>

‎pages/shaders.html‎

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -41,12 +41,11 @@ <h1>Shaders Functions</h1>
4141
<p><b>Functions to add Shaders to sprites and change their properties.</b></p>
4242
<hr>
4343
<h2 id="initLuaShader">initLuaShader</h2>
44-
<p class="methodbox">initLuaShader(<span class="variablemarkup">name</span>:String, <span class="isoptional">?</span><span class="variablemarkup">glslVersion</span>:Int = 120):Bool</p>
44+
<p class="methodbox">initLuaShader(<span class="variablemarkup">name</span>:String):Bool</p>
4545
<p>Preloads a Shader .vert/.frag inside "shaders/" folder, might be good for intensive shaders but it's generally not needed.
4646
<br>Returns "true" if the operation was successful.</p>
4747
<ul>
4848
<li><b><span class="variablemarkup">name</span></b> - Shader .vert/.frag name, don't include the extension!</li>
49-
<li><b><span class="variablemarkup">glslVersion</span> (Optional)</b> - GLSL Version Integer, defaults to 120 (GLSL 1.20, OpenGL 2.1).</li>
5049
</ul>
5150
<h4>Examples:</h4>
5251
<ul class="methoddiv">

‎pages/sound.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -142,7 +142,7 @@ <h2 id="resumeSound">resumeSound</h2>
142142

143143
<h2 id="luaSoundExists">luaSoundExists</h2>
144144
<p class="methodbox">luaSoundExists(<span class="variablemarkup">tag</span>:String):Bool</p>
145-
<p>Returns if a Lua Sound with a specific tag exists.</p>
145+
<p>Returns whether a Lua Sound with a specific tag exists.</p>
146146
<ul>
147147
<li><b><span class="variablemarkup">tag</span></b> - Lua Sound nametag.</li>
148148
</ul>

‎pages/spritesheet.html‎

Lines changed: 16 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -121,6 +121,21 @@ <h4>Examples:</h4>
121121
</ul>
122122
<hr>
123123

124+
<h2 id="loadFrames">loadMultipleFrames</h2>
125+
<p class="methodbox">loadMultipleFrames(<span class="variablemarkup">tag</span>:String,
126+
<span class="variablemarkup">images</span>:Array&lt;String&gt;):Void
127+
<p>Loads multiple spritesheets to a Lua Sprite.</p>
128+
<ul>
129+
<li><b><span class="variablemarkup">tag</span></b> - Sprite variable name or Lua Sprite nametag.</li>
130+
<li><b><span class="variablemarkup">images</span></b> - Table with spritesheet list, don't include the extension in the file names!</li>
131+
</ul>
132+
<h4>Examples:</h4>
133+
<ul class="methoddiv">
134+
<li class="exampleitem"><span class="methodexample">loadMultipleFrames('mySprite', {'spritesheet1', 'spritesheet2', 'spritesheet3'})</span> - Loads 3 spritesheets in a single Lua Sprite named "mySprite".</li>
135+
<li class="exampleitem"><a href="https://pastebin.com/raw/GTTkxV2R">Click here for a detailed use explanation.</a></li>
136+
</ul>
137+
<hr>
138+
124139
<h2 id="loadFrames">loadFrames</h2>
125140
<p class="methodbox">loadFrames(<span class="variablemarkup">tag</span>:String,
126141
<span class="variablemarkup">image</span>:String,
@@ -276,7 +291,7 @@ <h4>Examples:</h4>
276291

277292
<h2 id="luaSpriteExists">luaSpriteExists</h2>
278293
<p class="methodbox">luaSpriteExists(<span class="variablemarkup">tag</span>:String):Bool</p>
279-
<p>Returns if a Lua Sprite with a specific tag exists.</p>
294+
<p>Returns whether a Lua Sprite with a specific tag exists.</p>
280295
<ul>
281296
<li><b><span class="variablemarkup">tag</span></b> - Lua Sprite nametag.</li>
282297
</ul>

‎pages/text.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -277,7 +277,7 @@ <h2 id="getTextWidth">getTextWidth</h2>
277277

278278
<h2 id="luaTextExists">luaTextExists</h2>
279279
<p class="methodbox">luaTextExists(<span class="variablemarkup">tag</span>:String):Bool</p>
280-
<p>Returns if a Lua Text with a specific tag exists.</p>
280+
<p>Returns whether a Lua Text with a specific tag exists.</p>
281281
<ul>
282282
<li><b><span class="variablemarkup">tag</span></b> - Lua Text nametag.</li>
283283
</ul>

0 commit comments

Comments
 (0)