Differences

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

--- python_functions [2023/01/20 01:31] – g00r00
+++ python_functions [2023/01/20 01:55] – [Input Functions] g00r00
@@ Line 163: / Line 163: @@
 ==== Input Functions ====
-^ Function                                         ^ Description                                          ^
+^ Function                                             ^ Description                                          ^
-| [[python_functions#Function: GETSTR|getstr]]     | Get string input from the user                       |
+| [[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 199: / Line 201: @@
       input = getstr(11, 40, 120, "Default")
+=== Function: KEYPRESSED ===
+    Syntax: keypressed : boolean
+    Returns a true if a there is input waiting to be read in from the user
+    and false if there is no input waiting.
+    Example:
+      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 288: / Line 323: @@
   * isuserpw
   * isvalidpw
-  * keypressed
+  * [[python_functions#Function: KEYPRESSED|keypressed]]
   * logerror
   * mci2str