Skip to content

Commit 36b6ccf

Browse files
authored
Fix punctuation and wording in mobile documentation (#1)
1 parent 8c0300f commit 36b6ccf

File tree

1 file changed

+17
-17
lines changed

1 file changed

+17
-17
lines changed

pages/mobile.html

Lines changed: 17 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -54,44 +54,44 @@ <h2 id="mobileControlsMode">mobileControlsMode</h2>
5454
<p class="methodbox">mobileControlsMode():String</p>
5555
<p>Returns the current mobile controls mode as a string.</p>
5656
<ul>
57-
<li><b>Possible returns:</b> "left", "right", "custom", "hitbox", "none", or "unknown"</li>
57+
<li><b>Possible returns:</b> "left", "right", "custom", "hitbox", "none", or "unknown."</li>
5858
</ul>
5959
<hr>
6060

6161
<h2 id="extraButtonPressed">extraButtonPressed</h2>
6262
<p class="methodbox">extraButtonPressed(<span class="variablemarkup">button</span>:String = 'first'):Bool</p>
6363
<p>Returns whether an extra mobile control button is currently being held.</p>
6464
<ul>
65-
<li><b><span class="variablemarkup">button</span></b> - Can be "first" or "second". Defaults to "first"</li>
65+
<li><b><span class="variablemarkup">button</span></b> - Can be "first" or "second". Defaults to "first."</li>
6666
</ul>
6767
<h4>Examples:</h4>
6868
<ul class="methoddiv">
69-
<li class="exampleitem"><span class="methodexample">extraButtonPressed()</span> - Checks first extra button.</li>
70-
<li class="exampleitem"><span class="methodexample">extraButtonPressed('second')</span> - Checks second extra button.</li>
69+
<li class="exampleitem"><span class="methodexample">extraButtonPressed()</span> - Checks the first extra button.</li>
70+
<li class="exampleitem"><span class="methodexample">extraButtonPressed('second')</span> - Checks the second extra button.</li>
7171
</ul>
7272
<hr>
7373

7474
<h2 id="extraButtonJustPressed">extraButtonJustPressed</h2>
7575
<p class="methodbox">extraButtonJustPressed(<span class="variablemarkup">button</span>:String = 'first'):Bool</p>
7676
<p>Returns whether an extra mobile control button was just pressed in this frame.</p>
7777
<ul>
78-
<li><b><span class="variablemarkup">button</span></b> - Can be "first" or "second". Defaults to "first"</li>
78+
<li><b><span class="variablemarkup">button</span></b> - Can be "first" or "second". Defaults to "first."</li>
7979
</ul>
8080
<hr>
8181

8282
<h2 id="extraButtonJustReleased">extraButtonJustReleased</h2>
8383
<p class="methodbox">extraButtonJustReleased(<span class="variablemarkup">button</span>:String = 'first'):Bool</p>
8484
<p>Returns whether an extra mobile control button was just released in this frame.</p>
8585
<ul>
86-
<li><b><span class="variablemarkup">button</span></b> - Can be "first" or "second". Defaults to "first"</li>
86+
<li><b><span class="variablemarkup">button</span></b> - Can be "first" or "second". Defaults to "first."</li>
8787
</ul>
8888
<hr>
8989

9090
<h2 id="extraButtonReleased">extraButtonReleased</h2>
9191
<p class="methodbox">extraButtonReleased(<span class="variablemarkup">button</span>:String = 'first'):Bool</p>
9292
<p>Returns whether an extra mobile control button is not being pressed (released).</p>
9393
<ul>
94-
<li><b><span class="variablemarkup">button</span></b> - Can be "first" or "second". Defaults to "first"</li>
94+
<li><b><span class="variablemarkup">button</span></b> - Can be "first" or "second". Defaults to "first."</li>
9595
</ul>
9696
<hr>
9797

@@ -111,7 +111,7 @@ <h4>Examples:</h4>
111111

112112
<h2 id="addTouchPad">addTouchPad</h2>
113113
<p class="methodbox">addTouchPad(<span class="variablemarkup">DPadMode</span>:String, <span class="variablemarkup">ActionMode</span>:String, <span class="isoptional">?</span><span class="variablemarkup">addToCustomSubstate</span>:Bool = false, <span class="isoptional">?</span><span class="variablemarkup">posAtCustomSubstate</span>:Int = -1):Void</p>
114-
<p>Adds a customizable touch pad to the screen.</p>
114+
<p>Adds a customizable touchpad to the screen.</p>
115115
<ul>
116116
<li><b><span class="variablemarkup">DPadMode</span></b> - D-pad mode (e.g., "left", "right", "custom")</li>
117117
<li><b><span class="variablemarkup">ActionMode</span></b> - Action button mode</li>
@@ -122,44 +122,44 @@ <h2 id="addTouchPad">addTouchPad</h2>
122122

123123
<h2 id="removeTouchPad">removeTouchPad</h2>
124124
<p class="methodbox">removeTouchPad():Void</p>
125-
<p>Removes the currently active touch pad.</p>
125+
<p>Removes the currently active touchpad.</p>
126126
<hr>
127127

128128
<h2 id="addTouchPadCamera">addTouchPadCamera</h2>
129129
<p class="methodbox">addTouchPadCamera(<span class="isoptional">?</span><span class="variablemarkup">defaultDrawTarget</span>:Bool = false):Void</p>
130-
<p>Adds a camera specifically for the touch pad.</p>
130+
<p>Adds a camera specifically for the touchpad.</p>
131131
<ul>
132132
<li><b><span class="variablemarkup">defaultDrawTarget</span></b> - Whether to use as default draw target (optional)</li>
133133
</ul>
134134
<hr>
135135

136136
<h2 id="touchPadJustPressed">touchPadJustPressed</h2>
137137
<p class="methodbox">touchPadJustPressed(<span class="variablemarkup">button</span>:Dynamic):Bool</p>
138-
<p>Returns whether a touch pad button was just pressed in this frame.</p>
138+
<p>Returns whether a touchpad button was just pressed in this frame.</p>
139139
<ul>
140140
<li><b><span class="variablemarkup">button</span></b> - Button ID or name</li>
141141
</ul>
142142
<hr>
143143

144144
<h2 id="touchPadPressed">touchPadPressed</h2>
145145
<p class="methodbox">touchPadPressed(<span class="variablemarkup">button</span>:Dynamic):Bool</p>
146-
<p>Returns whether a touch pad button is currently being held.</p>
146+
<p>Returns whether a touchpad button is currently being held.</p>
147147
<ul>
148148
<li><b><span class="variablemarkup">button</span></b> - Button ID or name</li>
149149
</ul>
150150
<hr>
151151

152152
<h2 id="touchPadJustReleased">touchPadJustReleased</h2>
153153
<p class="methodbox">touchPadJustReleased(<span class="variablemarkup">button</span>:Dynamic):Bool</p>
154-
<p>Returns whether a touch pad button was just released in this frame.</p>
154+
<p>Returns whether a touchpad button was just released in this frame.</p>
155155
<ul>
156156
<li><b><span class="variablemarkup">button</span></b> - Button ID or name</li>
157157
</ul>
158158
<hr>
159159

160160
<h2 id="touchPadReleased">touchPadReleased</h2>
161161
<p class="methodbox">touchPadReleased(<span class="variablemarkup">button</span>:Dynamic):Bool</p>
162-
<p>Returns whether a touch pad button is not being pressed (released).</p>
162+
<p>Returns whether a touchpad button is not being pressed (released).</p>
163163
<ul>
164164
<li><b><span class="variablemarkup">button</span></b> - Button ID or name</li>
165165
</ul>
@@ -293,15 +293,15 @@ <h2 id="getCurrentOrientation">getCurrentOrientation</h2>
293293
<p class="methodbox">getCurrentOrientation():String</p>
294294
<p>Returns the current screen orientation as a string.</p>
295295
<ul>
296-
<li><b>Possible returns:</b> "Portrait", "PortraitUpsideDown", "LandscapeLeft", or "LandscapeRight"</li>
296+
<li><b>Possible returns:</b> "Portrait", "PortraitUpsideDown", "LandscapeLeft", or "LandscapeRight."</li>
297297
</ul>
298298
<hr>
299299

300300
<h2 id="setOrientation">setOrientation</h2>
301301
<p class="methodbox">setOrientation(<span class="variablemarkup">hint</span>:String):Void</p>
302302
<p>Sets the screen orientation.</p>
303303
<ul>
304-
<li><b><span class="variablemarkup">hint</span></b> - Can be: "portrait", "upsidedown", "landscapeleft", "landscape", or "landscaperight"</li>
304+
<li><b><span class="variablemarkup">hint</span></b> - Can be: "portrait", "upsidedown", "landscapeleft", "landscape", or "landscaperight."</li>
305305
</ul>
306306
<h4>Examples:</h4>
307307
<ul class="methoddiv">
@@ -362,7 +362,7 @@ <h2 id="setActivityTitle">setActivityTitle</h2>
362362
<p class="methodbox">setActivityTitle(<span class="variablemarkup">text</span>:String):Void</p>
363363
<p>Sets the Android activity/window title.</p>
364364
<ul>
365-
<li><b><span class="variablemarkup">text</span></b> - New title text</li>
365+
<li><b><span class="variablemarkup">text</span></b> - New title to set the Android activity/window as.</li>
366366
</ul>
367367
</div>
368368
</body>

0 commit comments

Comments
 (0)