Differences

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

--- displaycodes [2016/07/12 13:33] – [Text Box Codes] gryphon
+++ displaycodes [2024/02/29 23:26] (current) – [BBS and User Information Codes] added DN MCI code avon
@@ Line 30: / Line 30: @@
    $T##  - Trim a value to ## length. Do nothing if its less than ## length
    $X##C - Duplicate character C until column ##
    $c##C - Centers the value of the next display with a width of ## using
            character C
    $l##C - Left pad the next display code with character <C> to ## characters
    $r##C - Right pad the next display code with character <C> to ## chars
+   PD    - Pad the next MCI code value with a single space ie |PD|MB
 </code>
@@ Line 65: / Line 64: @@
    AV - User's chat availability for user to user chat (Yes or No)
    BD - User's baud rate (returns TELNET or LOCAL) (may be removed)
-   BI - User's birthdate in their selected date format
+   BI - User's birth date in their selected date format
+   BL - BBS location as set in System Configuration
    BN - BBS name from System configuration
    CM - User's full screen node chat setting (On or Off)
@@ Line 73: / Line 73: @@
    DK - User's total downloads in kilobytes
    DL - User's total number of downloaded files
+   DN - Returns the configured BBS domain name
+   DP - User's default protocol or blank if one is not set
    DT - User's total number of downloads today
    FB - User's current file base name
+   FDxx Returns the flag description where xx defines the set and the flag.
+        For example FD1A would return the description for flag set 1, flag A.
    FG - User's current file group name
    FK - User's total uploads in kilobytes
+   FLxx Returns the ON/OFF prompt depending on the user flag state. The xx
+        defines the set and the flag, for example: FL1A would return on/off
+        state of the user's A flag in flag set 1.
    FO - User's first call date in their selected date format
+   FS - User's file group (short name)
    FT - Total number of files in current file base (dynamic)
    FU - User's total number of files uploaded
@@ Line 87: / Line 95: @@
    MD - Menu description of the current menu (from menu flags)
    ME - User's total number of e-mails sent
+   MF - Shows number of draft messages saved for the current user
    MG - User's current message group name
    ML - User's lightbar message index setting (On or Off)
-   MN - Network address of current message base
+   MN - Network description of the current message base
    MP - User's total number of message posts
+   MS - User's message group (short name)
    MT - Total number of messages in current message base (dynamic)
+   MU - Total unread personal messages *
+   MW - Total personal messages *
+   NA - number of active users currently logged in
    ND - Current node number
    NE - Minutes until next BBS-type event
+   NT - maximum number of allowed nodes/terminal connections
    OS - Operating system (Windows, Linux, Raspberry Pi, etc)
    PC - User's current post to calls ratio
@@ Line 112: / Line 126: @@
    SX - User's max allowed downloaded files per day for current security level
    TB - User's timebank minutes
-   TC - Total number of calls to the BBS system
+   TC - Total number of calls to the BBS system (as of your call)
    TE - User's terminal emulation (Ansi or Ascii)
    TI - Current time of day in 12 hour format
    TL - User's time left in minutes
    TO - User's time spent online this session (in minutes)
+   TM - Displays current time in HH:MM 24-hour format
+   TS - Displays current time in HH:MM:SS 24-hour format
    U# - User's number (aka permanent user index)
    U1 - User's optional data answer for question #1
-   U2 - User's optional data answer for question #1
+   U2 - User's optional data answer for question #2
-   U3 - User's optional data answer for question #1
+   U3 - User's optional data answer for question #3
    UA - User's address
    UB - User's file listing type (Normal or Lightbar)
@@ Line 135: / Line 151: @@
    UM - User's lightbar message index setting (On of Off)
    UN - User's real name
+   UO - User's country of origin (as detected by IP/Country blocking)
    UP - User's Home phone number
    UQ - User's full screen editor quote mode (Standard or Lightbar)
@@ Line 144: / Line 161: @@
    XD - Days left before the user's account expires (or 0 if none)
    XS - Security level in which the user's account will expire to
+  * The MW/MU code values are only populated after the MC menu command is executed.
 ====== Color Codes (Pipe Colors) ======
@@ Line 222: / Line 241: @@
 Note: ## should be replaced by the number noted in the description, and must always be two characters.  For example, to move to column 1 on the current line you would use "|[X01" (without the quotation marks, of course).
+   [0   - Sends terminal hide cursor (support will depend on terminal)
+   [1   - Sends terminal show cursor (support will depend on terminal)
    [A## - Move the cursor up ## lines
    [B## - Move the cursor down ## lines
@@ Line 231: / Line 252: @@
    [Y## - Move cursor to Y coordinate ##
    BS   - Sends 1 destructive backspace sequence (ASCII 8-32-8)
+   CD   - Resets the remote terminal color mode to the theme default
    CL   - Clears the screen (ANSI 1,1 locate and [2J or ASCII 12)
+   CN   - Turns iCE colors OFF (if terminal supports it)
    CR   - Send a carrage return and line feed (move to next line)
+   CY   - Turns iCE colors ON (if terminal supports it)
+   LC   - Loads the last color mode (ICE/Blinking)
+   LF   - Loads the last font
    RA   - Restore the saved text attribute color
    RS   - Restore the saved user's terminal screen
    SA   - Save the current text attribute color
-   SS   - Save the entire user's terminal screen
+   SS   - Save the entire user's terminal screen'
+Each theme can optionally have a font type defined for it.  When a theme
+font type is defined, Mystic will swap to that font when the theme is
+loaded (support depends on the terminal used).  There are also a few codes
+that can be used for font manipulation:
+   SF## - Set the current terminal font where ## is:
+- Default      > Sends the "set default font" sequence
+- IBM CP437    > Switch to IBM CP437 font
+- Topaz        > Switch to Amiga Topaz
+- Topaz+       > Switch to Amiga Topaz Plus
+- MicroKnight  > Switch to Amiga MicroKnight
+- MicroKnight+ > Switch to Amiga MicroKnight+
+- mo'sOul      > Switch to Amiga mo'sOul
+- p0t NOoDLE   > Switch to Amiga p0t NOoDLE
+   TF - Resets terminal font to theme's default (if one has been configured)
 ====== Input Field Manipulation Codes ======
@@ Line 245: / Line 289: @@
    -N   - Forces the next Yes/No prompt to default to a No answer
    -Y   - Forces the next Yes/No prompt to default to a Yes answer
+   IB   - Turns off input barrier for the next string input
    IF   - Turns off the input field background color for the next input
           prompt.
@@ Line 256: / Line 301: @@
 </code>
-====== Text Box Codes ======
+====== Text Box / Pick List Codes ======
-Text Box codes are used to pop up a quick notification box, using the configured ANSI box style which is configured in each theme.
+Text Box codes are used to pop up a quick notification box, using the configured ANSI box style which is configured in each theme.  Pick lists create a horizontal or vertical list of options that are presented to the user to select via hotkey or lightbars.
 In addition to just displaying a box, Mystic is able to use its remote screen imaging to save what the user's screen looks like before displaying the box, and then restore the user's screen after the box is closed.  This screen restoration prevents the user's screen from being "corrupted" regardless of what they are doing when the box is displayed.
@@ Line 272: / Line 317: @@
          |#B#1#12#This is a header#This is a test notification box!#
 </code>
+**#H#<color>#<high_Color>#<desc_color>#<selected>#<options#**
+  Create a horizontal menu with an optional description line below it
+  similar to the "Lightbar/Prompt" style menus in Mystic or prompts
+  similar to what might be found in Searchlight BBS.
+  The <color> represents the text color attribute for the standard text
+  of the selection.  The <high_color> represents the highlighted color when
+  the item is selected.  <desc_color> is used only when a description is
+  assigned to a selection and represents the color of the description text.
+  As with other places where an attribute number is defined the value can
+  be calculated be the following formulate FG + (BG * 16) so FG color of white
+  (16) or a blue (1) background would be 15 + (1 * 16) which is 31.
+  <options> consists of a comma-separated list of key/text pairs defined as
+  key-text where key is the hotkey and text is what is lightbar selectable.
+  A horizontal lightbar menu with two light bar options would look like this:
+     <pipe>#H#7#31#14#2A-Option A,B-Option B#
+  The above would create a horizontal lightbar menu with two options called
+  "Option A" and "Option B" with the first having a hotkey of A and the second
+  a hotkey of B.  The text would be attribute 7 (grey) and the highlighted
+  text would be white on blue background (attr 31).  The third field would
+  not be used because there is no description defined for any of the options
+  and the fourth option is says to default to the second option (Option B)
+  when opening the menu.
+  Descriptions can be applied to each option by putting those values in
+  brackets in the item name.  The description will be displayed on the line
+  under the lightbar menu:
+     <pipe>#H#7#31#14#2A-Option A[Option A description here],B-Option B#
+  Pipe color codes can be used in the option names and will be rendered as
+  expected when the item is not highlighted.
 **#I#<style>#<Y position>#<header>#<text>#**
@@ Line 315: / Line 399: @@
                header " My Header "
 </code>
+**#Y#<style #>#<Y position>#<header>#<text>#**
+Performs a popup Yes/No box and the result will be used as the following YES/NO answer.  Mostly to be used in the "prompt" of a yes/no question.  The format is:
+<code>
+Syntax:  |#Y#<style #>#<Y position>#<header>#<text>#
+Example: |#Y#2#10#Confirm#Do you want to do this?#
+</code>
+The above example will pop up a Y/N box using style 2 with a header of "Confirm" and a message box text of "Do you want to do this?".
+After the YES/NO box, Mystic will restore the screen to the original state before the box was shown.  This function only works with ANSI graphics.
@@ Line 321: / Line 417: @@
 This section contains codes that are the special snowflakes of Mystic BBS!  They do not fit well into any of the other categories of codes, so they find a home here.  While they may be different, it does not mean that they're any less capable!
+   AA   - Used in display files to enable aborting of the display file
    AO   - Used in display files to disable aborting of the display file
    BE   - Sends a ^G character (causes some but not all terminals to beep)
+   CHx  - Sends character x for example |CH| would send a pipe character
    DE   - Delay for half a second
+   HXxx - Sends a hex byte. For example ASCII 254 is FE in hex so HXFE would send
+          out ASCII 254.
    PA   - Send the pause prompt and wait for a key to be pressed
    PB   - Purge the current input buffer
+   PE   - Pause and wait for the ENTER button (no prompt)
    PI   - Display a pipe symbol (|)
    PN   - Wait for a key to be pressed without prompting
    PO   - Used in display files to disable pausing for that display file
-   QO   - Replaced with a randomly generated Quote of the Day
    RP## - Sets the internal screen pause line counter to ##
+   SI   - returns the "ID" of the server that the user connected through
+          (as defined in the Server Configuration) or blank if the connection did
+          not source through MIS.
    XX   - Returns no value.  Seriously.  None.
-   DF<file>| - Send display file <file>.  Note the trailing pipe code which must be
+   DF<file>| Send display file <file>.  Note the trailing pipe code which must be
-               used if there is any text to be parsed after the DF code is encountered.
+             used if there is any text to be parsed after the DF code is encountered.
-               Example: |DFmyansi|
+             Example: |DFmyansi|
    DI## - Sets the baud rate emulation of the current display file, using the
@@ Line 351: / Line 454: @@
 - 89 = 57600 baud
 - 99 = 115200 baud
+   QO - Replaced with a randomly generated Quote of the Day
+   Mystic will select and display a random chunk of text from quotes.dat in the DATA
+   directory.  The format of quotes.dat is a text file which contains lines of text
+   separated by a single asterisk before each quote.  For example:
+     *
+     This is sample Mystic BBS quote #1.
+     This is also quote #1
+     *
+     This is sample Mystic BBS quote #2.
+     *
+     This is sample Mystic BBS quote #3.
 ====== Prompt Information Codes ======
@@ Line 370: / Line 487: @@
 These codes are not going to be documented here, as they have been depreciated.  Each template that uses these types of codes is slowly being removed in favor of the "newer" style of template, which uses an .INI file to define screen locations, attributes, prompts, and other options specific to that BBS function.
+In other words they are still used in the old-style templates but moving forward they will no longer be used in any new functions added into Mystic BBS.