Differences

This shows you the differences between two versions of the page.

--- en:key [2016/08/12 12:51]
admin
+++ en:key [2020/06/29 17:41] (current)
admin
@@ Line 2: / Line 2: @@
 ==== Format ====
 key\\
-key()
+key()\\
+key([[booleanexpressions|getUnicode]])
 returns [[integerexpressions|integer_expression]]
 ==== Description ====
-Immediately returns an integer value corresponding to the currently pressed keyboard key.  If no key has been pressed since the last call to the **key** function then the number zero (0) will be returned.  This function returns the code for the key pressed not always the ASCII value of the character.
+Immediately returns an integer value corresponding to the currently pressed keyboard key (if the argument is omitted or false), returns the Unicode character number if the argument is true.  If no key has been pressed since the last call to the **key** function then the number zero (0) will be returned.
+In Unicoide mode the key function will not return keypresses like backspace, escape, arrows, shift, alt, or the control keys.  It will return upper/lowercase letters.
 ==== Note ====
@@ Line 39: / Line 42: @@
 print a+"  "+chr(a)
 goto loop
+</code>
+====Example====
+<code>
+# get unicode letters until you press a control x
+while true
+	k = key(true)
+	if k <> 0 then
+		print k, chr(k)
+		if k = 24 then exit while
+	endif
+	pause .1
+end while
 </code>
 ==== See Also ====
 {{page>en:start#Keyboard and User Input&noheader}}
+==== History ====
+|2.0.0.11|added optional Unicode character argument|

DokuWiki