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:23] – g00r00 | displaycodes [2019/03/16 18:26] – added MF MCI code avon | ||
---|---|---|---|
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 44: | Line 87: | ||
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) | ||
Line 92: | Line 136: | ||
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 202: | Line 247: | ||
| | ||
| | ||
+ | | ||
| | ||
prompt. | prompt. | ||
Line 221: | Line 267: | ||
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 ====== | ||
+ | |||
+ | 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' | ||
+ | |||
+ | | ||
+ | | ||
+ | | ||
+ | | ||
+ | | ||
+ | | ||
+ | | ||
+ | | ||
+ | | ||
+ | RP## - Sets the internal screen pause line counter to ## | ||
+ | | ||
+ | |||
+ | | ||
+ | used if there is any text to be parsed after the DF code is encountered. | ||
+ | | ||
+ | |||
+ | DI## - Sets the baud rate emulation of the current display file, using the | ||
+ | following scale: | ||
+ | | ||
+ | 00 = No baud emulation (full speed) | ||
+ | 01 - 09 = 300 baud | ||
+ | 10 - 19 = 1200 baud | ||
+ | 20 - 29 = 2400 baud | ||
+ | 30 - 39 = 4800 baud | ||
+ | 40 - 49 = 9600 baud | ||
+ | 50 - 59 = 19200 baud | ||
+ | 60 - 69 = 28800 baud | ||
+ | 70 - 79 = 38460 baud | ||
+ | 80 - 89 = 57600 baud | ||
+ | 90 - 99 = 115200 baud | ||
====== Prompt Information Codes ====== | ====== Prompt Information Codes ====== | ||
- | Prompt Information codes are used within the prompts found in a theme' | + | Prompt Information codes are used within the prompts found in a theme' |
- | The prompt editor and the prompt file itself will have comments that show what each Prompt Info code's value means for that particular prompt. | + | The prompt editor and the prompt file itself will have comments that show what each code translates to for that particular prompt. |
+ | ; &1 = Current message number | ||
334 Jump to which message? (1-|& | 334 Jump to which message? (1-|& | ||
- | In this prompt, &1 is replaced by the current message number, and &2 is replaced by the total number of messages in the message base. These values are noted in the comments for that particular prompt in both the prompt editor and the text-based prompt file itself. | + | In this prompt, |
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