displaycodes
Differences
This shows you the differences between two versions of the page.
Both sides previous revisionPrevious revisionNext revision | Previous revisionNext revisionBoth sides next revision | ||
displaycodes [2016/03/21 09:30] – g00r00 | displaycodes [2020/05/16 20:10] – [Screen/Cursor Related Codes] 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. | 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, | ||
+ | |||
+ | < | ||
+ | | ||
+ | $D##C - Duplicates character C ## times | ||
+ | | ||
+ | | ||
+ | | ||
+ | $X##C - Duplicate character C until column ## | ||
+ | |||
+ | $c##C - Centers the value of the next display with a width of ## using | ||
+ | | ||
+ | |||
+ | $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 | ||
+ | </ | ||
+ | |||
+ | Examples: | ||
+ | |||
+ | < | ||
+ | |UN translates to........: "User Name" | ||
+ | |||
+ | |$R30|UN translates to...: "User Name " | ||
+ | |$C30|UN translates to...: " | ||
+ | |$L30|UN translates to...: " | ||
+ | |||
+ | |$D30- translates to.....: " | ||
+ | |$X30- translates to.....: " | ||
+ | |||
+ | |UN|$X30. translates to..: "User Name....................." | ||
+ | |||
+ | |$c30.|UN translates to...: " | ||
+ | |$r30.|UN translates to..: "User Name....................." | ||
+ | |$l30.|UN translates to..: " | ||
+ | </ | ||
+ | |||
+ | 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. | ||
+ | |||
====== BBS and User Information Codes ====== | ====== BBS and User Information Codes ====== | ||
Line 22: | Line 65: | ||
AV - User's chat availability for user to user chat (Yes or No) | 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) | BD - User's baud rate (returns TELNET or LOCAL) (may be removed) | ||
- | BI - User' | + | BI - User' |
BN - BBS name from System configuration | BN - BBS name from System configuration | ||
CM - User's full screen node chat setting (On or Off) | CM - User's full screen node chat setting (On or Off) | ||
Line 35: | Line 78: | ||
FK - User's total uploads in kilobytes | FK - User's total uploads in kilobytes | ||
FO - User's first call date in their selected date format | 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) | FT - Total number of files in current file base (dynamic) | ||
FU - User's total number of files uploaded | FU - User's total number of files uploaded | ||
Line 44: | Line 88: | ||
MD - Menu description of the current menu (from menu flags) | MD - Menu description of the current menu (from menu flags) | ||
ME - User's total number of e-mails sent | 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 | MG - User's current message group name | ||
ML - User's lightbar message index setting (On or Off) | ML - User's lightbar message index setting (On or Off) | ||
MN - Network address of current message base | MN - Network address of current message base | ||
MP - User's total number of message posts | 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) | MT - Total number of messages in current message base (dynamic) | ||
ND - Current node number | ND - Current node number | ||
Line 92: | Line 138: | ||
UM - User's lightbar message index setting (On of Off) | UM - User's lightbar message index setting (On of Off) | ||
UN - User's real name | UN - User's real name | ||
+ | UO - User's country of origin (as detected by IP/Country blocking) | ||
UP - User's Home phone number | UP - User's Home phone number | ||
UQ - User's full screen editor quote mode (Standard or Lightbar) | UQ - User's full screen editor quote mode (Standard or Lightbar) | ||
Line 189: | Line 236: | ||
| | ||
| | ||
+ | | ||
| | ||
+ | | ||
| | ||
| | ||
Line 202: | Line 251: | ||
| | ||
| | ||
+ | | ||
| | ||
prompt. | prompt. | ||
Line 221: | Line 271: | ||
User and BBS data MCI codes, along with pipe color codes can be used within these boxes! | User and BBS data MCI codes, along with pipe color codes can be used within these boxes! | ||
- | **# | + | **#B< |
+ | The #B code opens a < | ||
+ | |||
+ | Example: | ||
< | < | ||
- | | + | |#B#1#12#This is a header#This is a test notification box!# |
- | | + | </code> |
- | the user pressed a key, Mystic will automatically restore the user' | + | |
- | | + | |
- | | + | **# |
- | | + | 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 " |
+ | |||
+ | Example: | ||
+ | < | ||
+ | | ||
</ | </ | ||
- | **#I< | + | **#V#< |
+ | |||
+ | 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. | ||
+ | |||
+ | Syntax: |# | ||
+ | |||
+ | < | ||
+ | |||
+ | Example: | ||
+ | |||
+ | |# | ||
+ | |||
+ | Creates a pop up lightbar box in style 2, starting at X30 Y10 that has three options: | ||
< | < | ||
- | This box is similar to the #B notification, | + | |
- | | + | |
- | wait for the user to press a key. One use for this might be during | + | |
- | a new message scan " | + | | C Selection C |
- | | + | `-----------------' |
- | Example: | + | |
- | + | ||
- | |#INew Message Scan# | + | |
</ | </ | ||
+ | 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. | ||
+ | |||
+ | |||
+ | **# | ||
+ | |||
+ | Draws a box using a specific theme style. | ||
+ | < | ||
+ | | ||
+ | | ||
+ | | ||
+ | | ||
+ | </ | ||
+ | **# | ||
+ | |||
+ | Performs a popup Yes/No box and the result will be used as the following YES/NO answer. | ||
+ | |||
+ | < | ||
+ | Syntax: | ||
+ | Example: |# | ||
+ | </ | ||
+ | |||
+ | The above example will pop up a Y/N box using style 2 with a header of " | ||
+ | |||
+ | After the YES/NO box, Mystic will restore the screen to the original state before the box was shown. | ||
+ | |||
====== Miscellaneous Codes ====== | ====== Miscellaneous Codes ====== | ||
Line 251: | Line 340: | ||
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' | 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' | ||
+ | | ||
| | ||
- | | + | |
| | ||
| | ||
Line 261: | Line 351: | ||
| | ||
RP## - Sets the internal screen pause line counter to ## | RP## - Sets the internal screen pause line counter to ## | ||
- | | + | |
- | | + | |
+ | 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 | DI## - Sets the baud rate emulation of the current display file, using the | ||
Line 292: | Line 384: | ||
Prompt Information codes can range from |& | Prompt Information codes can range from |& | ||
+ | |||
+ | ====== 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. |
displaycodes.txt · Last modified: 2024/02/29 23:26 by avon