Differences

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

--- python_functions [2022/05/05 14:02] – g00r00
+++ python_functions [2023/01/20 01:57] (current) – [Function List A to Z] g00r00
@@ Line 3: / Line 3: @@
 This page is a work in progress.  Please follow this format closely if
 making changes, and be sure to include anchors from the A-Z list at the
-bottom as well as the table at each section.
+bottom as well as the table at each section.  MPL documentation should follow
+a similar format.
-Optionally maybe these 4 main sections should be their own page I am open
+If you are looking for documentation for a function from the A-Z function
-to suggestion, although I worked hard to come up with a system where all of
+list at the bottom and it is not yet documented here, do a search at the top
-this information could be viewed and accessed quickly as it grows within a
+of the site for the function name.  All functions should be documented in
-single page.
+the Whats new sections, and the search may find it for you.
-MPL documentation should follow this same layout for consistency.
+If you have a specific request for something to be added here, please ask and
+the documentation can be prioritized.  If you have a specific request for an
+enhancement, please request it!
-1234567890123456789012345678901234567890123456789012345678901234567890123456789
+The examples section, and included example scripts with a new installation of
+Mystic can also be useful when learning the functions.
 ----
@@ Line 158: / Line 162: @@
 ----
 ==== Input Functions ====
+^ Function                                             ^ Description                                          ^
+| [[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 185: / Line 194: @@
     MaxInput defines the total number of bytes allowed in this
     input field.
+    DefaultText defines the value that will be put into the input
+    field by default.
     Example:
       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 247: / Line 292: @@
   * dateu2d
   * delay
+  * find_config
+  * find_display
   * fl_close
   * fl_found
@@ Line 268: / Line 315: @@
   * getnetaddr
   * getprompt
-  * getstr
+  * [[python_functions#Function: GETSTR|getstr]]
   * getuser
   * getuserid
@@ Line 274: / Line 321: @@
   * gotoxy
   * isuser
-  * keypressed
+  * isuserpw
+  * isvalidpw
+  * [[python_functions#Function: KEYPRESSED|keypressed]]
   * logerror
   * mci2str
@@ Line 288: / 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]]
@@ Line 296: / Line 345: @@
   * [[python_functions#Function: RWRITE|rwrite]]
   * [[python_functions#Function: RWRITELN|rwriteln]]
+  * setlogininfo
   * setpinfo
   * setprompt