summaryrefslogtreecommitdiffhomepage
path: root/dragon/runtime_docs.rb
diff options
context:
space:
mode:
authorKetan Patel <[email protected]>2021-04-15 21:44:44 +0100
committerAmir Rajan <[email protected]>2021-04-19 14:27:29 -0500
commit8a29791f01d8b7d88bf9d53522e1fd9051564945 (patch)
tree3b3e4ecd4f8e77c5f1e5f6fa4528e45e5b700d76 /dragon/runtime_docs.rb
parentc835abd4653c2041586e93a25b5e2e2b9f6e0342 (diff)
downloaddragonruby-game-toolkit-contrib-8a29791f01d8b7d88bf9d53522e1fd9051564945.tar.gz
dragonruby-game-toolkit-contrib-8a29791f01d8b7d88bf9d53522e1fd9051564945.zip
Fix typos in description for .up_down
Diffstat (limited to 'dragon/runtime_docs.rb')
-rw-r--r--dragon/runtime_docs.rb9
1 files changed, 6 insertions, 3 deletions
diff --git a/dragon/runtime_docs.rb b/dragon/runtime_docs.rb
index 5b4d660..90addff 100644
--- a/dragon/runtime_docs.rb
+++ b/dragon/runtime_docs.rb
@@ -3,6 +3,9 @@
# MIT License
# runtime_docs.rb has been released under MIT (*only this file*).
+# Contributors outside of DragonRuby who also hold Copyright:
+# Ketan Patel: https://github.com/cookieoverflow
+
module RuntimeDocs
def docs_method_sort_order
[
@@ -82,7 +85,7 @@ Returns ~true~ if: the ~right~ arrow or ~d~ key is pressed or held on the ~keybo
*** ~.left_right~
Returns ~-1~ (left), ~0~ (neutral), or ~+1~ (right) depending on results of ~args.inputs.left~ and ~args.inputs.right~.
*** ~.up_down~
-Returns ~-1~ (down), ~0~ (neutral), or ~+1~ (right) depending on results of ~args.inputs.up~ and ~args.inputs.down~.
+Returns ~-1~ (down), ~0~ (neutral), or ~+1~ (up) depending on results of ~args.inputs.down~ and ~args.inputs.up~.
*** ~.text~ OR ~.history~
Returns a string that represents the last key that was pressed on the keyboard.
*** ~.mouse~
@@ -127,7 +130,7 @@ Returns ~true~ if ~right~ is pressed or held on the directional or left analog.
**** ~.left_right
Returns ~-1~ (left), ~0~ (neutral), or ~+1~ (right) depending on results of ~args.inputs.controller_(one|two).left~ and ~args.inputs.controller_(one|two).right~.
**** ~.up_down
-Returns ~-1~ (down), ~0~ (neutral), or ~+1~ (up) depending on results of ~args.inputs.controller_(one|two).up~ and ~args.inputs.controller_(one|two).down~.
+Returns ~-1~ (down), ~0~ (neutral), or ~+1~ (up) depending on results of ~args.inputs.controller_(one|two).down~ and ~args.inputs.controller_(one|two).up~.
**** ~.(left_analog_x_raw|right_analog_x_raw)~
Returns the raw integer value for the analog's horizontal movement (~-32,000 to +32,000~).
**** ~.left_analog_y_raw|right_analog_y_raw)~
@@ -167,7 +170,7 @@ Returns ~true~ if ~right~ or ~d~ is pressed or held on the keyboard.
**** ~.left_right~
Returns ~-1~ (left), ~0~ (neutral), or ~+1~ (right) depending on results of ~args.inputs.keyboard.left~ and ~args.inputs.keyboard.right~.
**** ~.up_down~
-Returns ~-1~ (left), ~0~ (neutral), or ~+1~ (right) depending on results of ~args.inputs.keyboard.up~ and ~args.inputs.keyboard.up~.
+Returns ~-1~ (down), ~0~ (neutral), or ~+1~ (up) depending on results of ~args.inputs.keyboard.down~ and ~args.inputs.keyboard.up~.
**** keyboard properties
The following properties represent keys on the keyboard and are available on ~args.inputs.keyboard.KEY~, ~args.inputs.keyboard.key_down.KEY~, ~args.inputs.keyboard.key_held.KEY~, and ~args.inputs.keyboard.key_up.KEY~:
- ~alt~