Differences

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

--- python_functions [2018/04/01 16:23] – [Function List A to Z] g00r00
+++ python_functions [2020/09/12 17:00] – g00r00
@@ Line 17: / Line 17: @@
 ==== Output Functions ====
-^ Function                                        ^ Description                                          ^
+^ Function                                         ^ Description                                          ^
-| [[python_functions#Function: RWRITE|rwrite]]    | Send raw string to the user                          |
+| [[python_functions#Function: PWRITE|pwrite]]     | Send pipe string to the user                         |
-| [[python_functions#Function: RWRITE|rwriteln]]  | Send raw string to the user with a carriage return   |
+| [[python_functions#Function: PWRITELN|pwriteln]] | Send pipe string to the user with a carriage return  |
-| [[python_functions#Function: WRITE|write]]      | Send string to the user with MCI filtering           |
+| [[python_functions#Function: RWRITE|rwrite]]     | Send raw string to the user                          |
-| [[python_functions#Function: WRITELN|writeln]]  | Send string to the user with MCI filtering and CRLF  |
+| [[python_functions#Function: RWRITE|rwriteln]]   | Send raw string to the user with a carriage return   |
+| [[python_functions#Function: SHOWFILE|showfile]] | Display a file to the user                           |
+| [[python_functions#Function: WRITE|write]]       | Send string to the user with MCI filtering           |
+| [[python_functions#Function: WRITELN|writeln]]   | Send string to the user with MCI filtering and CRLF  |
+=== Function: PWRITE ===
+    Syntax: pwrite (string)
+    This function accepts a string parameter and will send the contents of the
+    string to the user, processing any pipe color codes properly but ignoring other
+    MCI codes.
+    Example:
+      rwrite("|12Welcome, |UH")
+    The above example will print "Welcome, |UH" to the user with a red color.  Note
+    that the MCI code containing the user name was not translated.
+=== Function: PWRITELN ===
+    Syntax: pwriteln (string)
+    This function accepts a string parameter and will send the contents of the
+    string to the user, processing any pipe color codes properly but ignoring other
+    MCI codes.  A CRLF is sent at the end, moving the cursor to the next line.
+    Example:
+      pwriteln("|12Welcome, |UH")
+    The above example will print "Welcome, |UH" to the user with a red color.  Note
+    that the MCI code containing the user name was not translated.
 === Function: RWRITE ===
@@ Line 53: / Line 88: @@
     The above example will print "|12Welcome, <UserName>" to the
     user and then move the cursor to the next line.
+=== Function: SHOWFILE ===
+    Syntax: showfile (filename, baudrate, allowpause, allowabort, onlynew) : boolean
+    This function accepts the filename string followed by several boolean
+    options represented as 1 for true or 0 for false.
+    The filename parameter can be a base filename such as "myfile" and Mystic
+    will calculate the file extension based on the user's terminal settings
+    and random display file system.  If a file extension is supplied then
+    Mystic will not attempt to do any calculation based on terminal or
+    random files.  The filename can also include a path, but if one is
+    excluded it will display from the current theme's text directory or
+    a theme that is inherited by the current theme.
+    The baudrate parameter contains the baudrate that will be emulated when
+    the file is displayed, or it can be set to zero for full speed.
+    The allowpause parameter can be set to 1 to allow screen pausing
+    The allowabort parameter can be set to 1 to allow aborting display
+    The onlynew parameter can be set to 1 to display the file only if its
+    modification date is newer than the user's last call.
+    The showfile function returns a TRUE result if the file was found and
+    displayed or false if not.
+    Example:
+      showfile("c:\myfile.txt", 0, 1, 1, 0)
+      showfile("loginansi", 19200, 0, 0, 0)
 === Function: WRITE ===
@@ Line 99: / Line 167: @@
   * access
+  * acsnogroup
   * backspace
   * charxy
+  * dated2u
+  * datestr
+  * dateu2d
   * delay
+  * fl_close
+  * fl_found
+  * fl_getdesc
+  * fl_getfile
+  * fl_open
+  * fl_prev
+  * fl_next
+  * fl_seek
+  * flush
   * getcfg
   * getfbase
@@ Line 112: / Line 193: @@
   * getmgroup
   * getmgroupid
+  * getnetaddr
   * getprompt
   * getstr
@@ Line 117: / Line 199: @@
   * getuserid
   * getyn
-  * gotoyn
+  * gotoxy
   * keypressed
+  * logerror
   * mci2str
   * menucmd
@@ Line 130: / Line 213: @@
   * msg_prev
   * msg_seek
+  * msg_stats
   * onekey
   * param_count
   * param_str
+  * purgeinput
+  * [[python_functions#Function: PWRITE|pwrite]]
+  * [[python_functions#Function: PWRITELN|pwriteln]]
   * [[python_functions#Function: RWRITE|rwrite]]
   * [[python_functions#Function: RWRITELN|rwriteln]]
-  * showfile
+  * setpinfo
+  * setprompt
+  * [[python_functions#Function: SHOWFILE|showfile]]
   * shutdown
   * stuffkey