Differences

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

--- displaycodes [2016/03/21 09:25] – [Prompt Information Codes] g00r00
+++ displaycodes [2020/04/07 14:33] – g00r00
@@ Line 16: / Line 16: @@
 The additional data required for these types of codes will vary and will be documented specifically within the sections that follow.
+====== Display Code Formatting ======
+Text formatting codes are most often used within the prompts file to create aligned lists of data, for things such as the user list or who's online, etc.  These codes, like many other display codes, set up the circumstances in which the display code after it are displayed.
+Note: ## should be replaced by the number noted in the description, and must always be two characters.
+<code>
+   $C##  - Centers the value of the next display code with a width of ##
+   $D##C - Duplicates character C ## times
+   $L##  - Left pad the next display code with spaces to ## characters
+   $R##  - Right pad the next display code with spaces to ## characters
+   $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
+</code>
+Examples:
+<code>
+      |UN translates to........: "User Name"
+      |$R30|UN translates to...: "User Name                     "
+      |$C30|UN translates to...: "          User Name           "
+      |$L30|UN translates to...: "                     User Name"
+      |$D30- translates to.....: "------------------------------"
+      |$X30- translates to.....: "------------------------------"
+      |UN|$X30. translates to..: "User Name....................."
+      |$c30.|UN translates to...: ".........User Name..........."
+      |$r30.|UN translates to..: "User Name....................."
+      |$l30.|UN translates to..: ".....................User Name"
+</code>
+The difference between $D and $X is that D duplicates a set number of characters, while $X duplicates that character until a certain column is reached.  If you use $X30- on column 10, it will create 20 characters so it is dependent on the current location of the cursor, while $D will always create the same length of data regardless.
 ====== BBS and User Information Codes ======
@@ Line 22: / Line 65: @@
    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
    BN - BBS name from System configuration
    CM - User's full screen node chat setting (On or Off)
@@ Line 35: / Line 78: @@
    FK - User's total uploads in kilobytes
    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 44: / Line 88: @@
    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
    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)
    ND - Current node number
@@ Line 92: / Line 138: @@
    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 202: / Line 249: @@
    -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 221: / Line 269: @@
 User and BBS data MCI codes, along with pipe color codes can be used within these boxes!
-**#B<header>#<notification>#**
+**#B<style>#<Y position>#<header>#<text>#**
+The #B code opens a <style> notification box with a <header> and <text> string, at <Y position> following by an "OK" prompt for the user to press a key.  After the user pressed a key, Mystic will automatically restore the user's original screen content that was overwritten by the box.  The <style> option is one of the four different styles found in the themes menu.
+Example:
 <code>
-       The #B code opens a notification box with a <header> and <notification>
+         |#B#1#12#This is a header#This is a test notification box!#
-       string, following by an "OK" prompt for the user to press a key.  After
+</code>
-       the user pressed a key, Mystic will automatically restore the user's
-       original screen content that was overwritten by the box.
-       Example:
+**#I#<style>#<Y position>#<header>#<text>#**
-         |#BThis is a header#This is a test notification box!#
+This box is similar to the #B notification, except that it does not restore the user's screen content after displaying, and it does not wait for the user to press a key.  One use for this might be during a new message scan "Scanning" prompt, for example.
+Example:
+<code>
+         |#I#1#12#New Message Scan#Scanning: |&1...#
 </code>
-**#I<header>#<notification>#**
+**#V#<style#>#<X position>#<Y pos>#<header>#<commands>#**
+Performs a pop up vertical selection box, with the selected item hotkey being pushed into the input buffer, and the screen restored to its original state after selection.  This only works with ANSI graphics. The format is:
+  Syntax: |#V#<style#>#<X position>#<Y pos>#<header>#<commands>#
+<Commands> is a comma separated list of commands in the format of <hotkey>-<text>.  If <text> is blank, the hotkey will be allowed by not shown in the list.  If the entire entry is blank a blank line will be inserted into the list.
+Example:
+  |#V#2#30#10# Header #A-Selection A,B-Selection B,C-Selection C#
+Creates a pop up lightbar box in style 2, starting at X30 Y10 that has three options:
 <code>
-       This box is similar to the #B notification, except that it does not
+        .----- Header ----.
-       restore the user's screen content after displaying, and it does not
+        |  A Selection A  |
-       wait for the user to press a key.  One use for this might be during
+        |  B Selection B  |
-       a new message scan "Scanning" prompt, for example.
+        |  C Selection C  |
+        `-----------------'
-       Example:
-         |#INew Message Scan#Scanning: |&1...#
 </code>
+When an item is selected, Mystic sets the color to black on black and pushes the hotkey into the input buffer, so that the prompt it replaced gets the input key.
+**#X#<style>#<header>#<x1>#<y1>#<x2>#<y2>#**
+Draws a box using a specific theme style.  It does not take input or erase itself at all.
+<code>
+     Format  : |#X#<style>#<header>#<x1>#<y1>#<x2>#<y2>#
+     Example : |#X#2# My Header #20#10#60#16#
+     Result  : Opens a box at X20 Y10 to X60 Y16 using style 2 and
+               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.
+====== Miscellaneous Codes ======
+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)
+   DE   - Delay for half a second
+   PA   - Send the pause prompt and wait for a key to be pressed
+   PB   - Purge the current input buffer
+   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 ##
+   XX   - Returns no value.  Seriously.  None.
+   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.
+             Example: |DFmyansi|
+   DI## - Sets the baud rate emulation of the current display file, using the
+          following scale:
+      = No baud emulation (full speed)
+- 09 = 300 baud
+- 19 = 1200 baud
+- 29 = 2400 baud
+- 39 = 4800 baud
+- 49 = 9600 baud
+- 59 = 19200 baud
+- 69 = 28800 baud
+- 79 = 38460 baud
+- 89 = 57600 baud
+- 99 = 115200 baud
 ====== Prompt Information Codes ======
@@ Line 259: / Line 382: @@
 Prompt Information codes can range from |&0-|&9, and from |&A-|&Z
+====== Screen Info Codes (Depreciated) ======
+Screen Info codes follow the format of |!# where # is a number between 0 and 9.  These codes are found in the old style of ANSI templates used within various "full screen ANSI" functions of Mystic BBS, and they are used to define screen location and attributes used within that specific function.
+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.