Differences

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

--- python_functions [2023/01/20 01:41] – [Input Functions] g00r00
+++ python_functions [2023/01/20 01:57] (current) – [Function List A to Z] g00r00
@@ Line 166: / Line 166: @@
 | [[python_functions#Function: GETSTR|getstr]]         | Get string input from the user                   |
 | [[python_functions#Function: KEYPRESSED|keypressed]] | Check if input is available from user            |
+| [[python_functions#Function: ONEKEY|onekey]]         | Get constrained single character input from user |
 === Function: GETSTR ===
@@ Line 212: / Line 213: @@
       if keypressed is True:
         writeln("A key is waiting!")
+=== Function: ONEKEY ===
+    Syntax: onekey (keylist, echo) : string
+    This function asks the user to input a character but accepts only input
+    from the user that matches a character in the keylist.  If echo is True
+    the function will print the character to the terminal.
+    Example:
+      ch = onekey(chr(13) + "APQ", True);
+      if ch == 'A':
+           writeln("User pressed A")
+     The above example prompts the user to enter one of the keys A, P, Q or
+     the ENTER key (ASCII #13).  Because echo is True, it will prompt the
+     character to the terminal before returning the key that was pressed.
+     User input for this function is not case sensitive.
 ----
@@ Line 301: / Line 323: @@
   * isuserpw
   * isvalidpw
-  * keypressed
+  * [[python_functions#Function: KEYPRESSED|keypressed]]
   * logerror
   * mci2str
@@ Line 315: / Line 337: @@
   * msg_seek
   * msg_stats
-  * onekey
+  * [[python_functions#Function: ONEKEY|onekey]]
   * [[python_functions#Function: PARAM_COUNT|param_count]]
   * [[python_functions#Function: PARAM_STR|param_str]]