User Tools

Site Tools


Sidebar

Overview

Installation

MYSTIC -CFG

Visual Customization

Mystic Utilities (MUTIL)

Scripting Custom Modules

Quick Reference

What's New

python_functions

Python Functions

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.

Optionally maybe these 4 main sections should be their own page I am open to suggestion, although I worked hard to come up with a system where all of this information could be viewed and accessed quickly as it grows within a single page.

MPL documentation should follow this same layout for consistency.

1234567890123456789012345678901234567890123456789012345678901234567890123456789


Output Functions

Function Description
rwrite Send raw string to the user
rwriteln Send raw string to the user with a carriage return
write Send string to the user with MCI filtering
writeln Send string to the user with MCI filtering and CRLF

Function: RWRITE

  Syntax: rwrite (string)
  
  Raw write. This function accepts a string parameter and will send the
  contents of the string to the user.  This function does NOT filter
  out color or MCI codes nor does it move to the next line.

  Example:

    rwrite("|12Welcome, |UH")
  
  The above example will print "|12Welcome, <UserName>" to the user.
  Note that the color code was untouched.

Function: RWRITELN

  Syntax: rwriteln (string)
  
  This function accepts a string parameter and will send the contents
  of the string to the user followed by a carrage return to move the
  cursor to the next line.  This function will NOT decode color codes
  or MCI codes.
  Example:

    rwriteln("|12Welcome, |UH")
  
  The above example will print "|12Welcome, <UserName>" to the
  user and then move the cursor to the next line.

Function: WRITE

  Syntax: write (string)
  
  This function accepts a string parameter and will send the contents
  of the string to the user.  This function will decode all pipe color
  codes and MCI codes in the process.  Note that this function does not
  move the cursor to the next line.

  Example:

    write("|12Welcome, |UH")
  
  The above example will print "Welcome, <UserName>" in Red to the
  user.

Function: WRITELN

  Syntax: writeln (string)
  
  This function accepts a string parameter and will send the contents
  of the string to the user followed by a carrage return to move the
  cursor to the next line.  This function will decode all pipe color
  codes and MCI codes in the process.

  Example:

    writeln("|12Welcome, |UH")
  
  The above example will print "Welcome, <UserName>" in Red to the
  user and then move the cursor to the next line.

Input Functions


BBS Data Access Functions


Miscellaneous Functions


Function List A to Z

  • access
  • backspace
  • charxy
  • delay
  • getcfg
  • getfbase
  • getfbaseid
  • getfgroup
  • getfgroupid
  • getkey
  • getmbase
  • getmbaseid
  • getmgroup
  • getmgroupid
  • getprompt
  • getstr
  • getuser
  • getuserid
  • getyn
  • gotoyn
  • keypressed
  • mci2str
  • menucmd
  • msg_close
  • msg_delete
  • msg_found
  • msg_gethdr
  • msg_gettxt
  • msg_next
  • msg_open
  • msg_prev
  • msg_seek
  • onekey
  • param_count
  • param_str
  • showfile
  • shutdown
  • stuffkey
  • sysoplog
  • textattr
  • textcolor
  • upuser
  • wherex
  • wherey
python_functions.txt · Last modified: 2018/04/01 17:23 by g00r00