| Both sides previous revisionPrevious revisionNext revision | Previous revisionNext revisionBoth sides next revision |
| custom:atcodes [2020/04/30 14:16] – [@-codes] These codes were called "Message Variables" in the sysop manual digital man | custom:atcodes [2020/09/27 22:03] – Added NETMAIL, LASTIP, FWD, TMP, and NOTE digital man |
|---|
| ====== @-codes ====== | ====== Message Variables (@-codes) ====== |
| |
| Synchronet sysop-posted messages, text and menu files, and some lines in the ''[[dir:ctrl]]/[[text.dat]]'' file may contain special //Message Variables//, also called //@-codes// ("at codes", some BBS authors and sysops refer to these types of codes as "MCI codes"((and not because of the defunct phone company))). @-codes may also be displayed using the ''bbs.atcode()'' JavaScript method. | Synchronet sysop-posted messages, text and menu files, and some lines in the ''[[dir:ctrl]]/[[text.dat]]'' file may contain special //Message Variables//, also called //@-codes// ("at codes", some BBS authors and sysops refer to these types of codes as "@ Macros" or "MCI codes"((and not because of the defunct phone company))). @-codes may also be displayed using the ''bbs.atcode()'' JavaScript method. |
| |
| @-codes are called such because they begin and end with the ''@'' (ASCII 64) ("at") character. The code names themselves (sandwiched between the @'s) must be entered using only ''UPPERCASE'' letters. Some additional symbols and numbers may also be included in the @-code, but never a space. | @-codes are called such because they begin and end with the ''@'' (ASCII 64) ("at") character. The code names themselves (sandwiched between the @'s) must be entered using only ''UPPERCASE'' letters. Some additional symbols and numbers may also be included in the @-code, but never a space. |
| |SR |SN-R | " " padded and right justified (4 chars wide) | | |SR |SN-R | " " padded and right justified (4 chars wide) | |
| |SYSOP | |Name of System Operator | | |SYSOP | |Name of System Operator | |
| | |SYSAVAIL | |Sysop availability for chat (e.g. "Available" or "Not Available")| |
| |TFILE | |Total number of files on system | | |TFILE | |Total number of files on system | |
| |TIME |SYSTIME |Current system time | | |TIME |SYSTIME |Current system time | |
| |FROM | |User's location (e.g. "City, State") | | |FROM | |User's location (e.g. "City, State") | |
| |FREECDT | |User's remaining freely-awarded (unearned) credits for today | | |FREECDT | |User's remaining freely-awarded (unearned) credits for today | |
| | |FWD | |User's netmail forward status (e.g. "On" or "Off")| |
| |HANDLE | |User's chat handle | | |HANDLE | |User's chat handle | |
| |HOST |CPU |Client's hostname | | |HOST |CPU |Client's hostname | |
| |IP |CID, MEMO1 |Client's IP address or Caller-ID information | | |IP |CID |Client's IP address or Caller-ID information | |
| |LAST | |Last word of user's alias | | |LAST | |Last word of user's alias | |
| |LASTDATEON | |Date of user's last logon (in "MM/DD/YY" or "DD/MM/YY" format) | | |LASTDATEON | |Date of user's last logon (in "MM/DD/YY" or "DD/MM/YY" format) | |
| | |LASTIP | |IP address of user's last logoff | |
| |LASTNEW | |Date of user's last new file scan (in "MM/DD/YY" or "DD/MM/YY" format) | | |LASTNEW | |Date of user's last new file scan (in "MM/DD/YY" or "DD/MM/YY" format) | |
| |LASTON | |Date and time of user's last logon | | |LASTON | |Date and time of user's last logon | |
| |MTOTAL | |Total minutes used during all previous logons | | |MTOTAL | |Total minutes used during all previous logons | |
| |NEWFILETIME | |Date and time of user's last new file scan (see LASTNEW) | | |NEWFILETIME | |Date and time of user's last new file scan (see LASTNEW) | |
| | |NETMAIL | |User's personal email or netmail address | |
| | |NOTE |MEMO1 |User's note | |
| |PAGER | |Chat pager enabled status (e.g. "On" or "Off")| | |PAGER | |Chat pager enabled status (e.g. "On" or "Off")| |
| |PCR | |User's post/call ratio (0-100) | | |PCR | |User's post/call ratio (0-100) | |
| |TIMEON |TIMEUSED |Time used this call in minutes| | |TIMEON |TIMEUSED |Time used this call in minutes| |
| |TLEFT | |Time left (in "H:MM:SS" format)| | |TLEFT | |Time left (in "H:MM:SS" format)| |
| | |TMP | |Temporary file type chosen by user (e.g. "ZIP") | |
| |TPERC | |Time allowed per call (in "H:MM:SS" format) | | |TPERC | |Time allowed per call (in "H:MM:SS" format) | |
| |TPERD | |Time allowed per day (in "H:MM:SS" format) | | |TPERD | |Time allowed per day (in "H:MM:SS" format) | |
| |BEEP |BELL |Generate a beep sound on the user's terminal | | |BEEP |BELL |Generate a beep sound on the user's terminal | |
| |CLS | |Clear the screen | | |CLS | |Clear the screen | |
| |CLEAR | |Clear the screen and eat the next newline sequence | | |CLEAR | |Clear the screen, all existing mouse hot-spots and eat the next newline sequence | |
| | |CLEAR_HOT | |Clear all existing mouse hot-spots | |
| | |HOT | |Define a new mouse hot-spot color (the color of the @-code defines the hot-spot attributes) | |
| | |HOT:HUNGRY | |Define a new mouse hot-spot color for defining hungry hot-spots (hungry hot-spots are the default type) | |
| | |HOT:STRICT | |Define a new mouse hot-spot color for defining strict hot-spots | |
| | |HOT:OFF | |Disable hot-spot by color/attribute definitions for the remainder of the file (or until re-enabled) | |
| | |~//text// | |Define a single hungry hot-spot (where the displayed text and command keys are the same) | |
| | |~//text//~//cmd// | |Define a single hungry hot-spot with an alternate command to stuff in the keyboard input buffer | |
| | |`//text// | |Define a single strict hot-spot (where the displayed text and command keys are the same) | |
| | |`//text//`//cmd// | |Define a single strict hot-spot with an alternate command to stuff in the keyboard input buffer | |
| |CRLF | |Send a carriage return/line-feed pair | | |CRLF | |Send a carriage return/line-feed pair | |
| |CHECKMARK | |Send a check mark symbol appropriate for the user's terminal | | |CHECKMARK | |Send a check mark symbol appropriate for the user's terminal | |
| |GOTOXY://x,y// | |Move cursor to //x/////y// coordinate (1-based) | | |GOTOXY://x,y// | |Move cursor to //x/////y// coordinate (1-based) | |
| |POS://x// | |Move cursor to column //x// (1-based) | | |POS://x// | |Move cursor to column //x// (1-based) | |
| |HOME | |Home cursor (to upper left), don't clear| | |HOME | |Home cursor (to upper left), don't clear the screen | |
| |CLRLINE | |Clear the current line (cursor to first column)| | |CLRLINE | |Clear the current line (cursor to first column)| |
| |CLR2EOL | |Clear to end of line (cursor doesn't move)| | |CLR2EOL | |Clear to end of line (cursor doesn't move)| |
| * [[custom:menu_files|Menu Files]] | * [[custom:menu_files|Menu Files]] |
| * [[custom:|Customization]] | * [[custom:|Customization]] |
| | * [[custom:ctrl-a_codes|ctrl-a (Attribute) codes]] |
| * [[http://synchro.net/docs/customization.html#MessageVariables|Old documentation of this feature (stale)]] | * [[http://synchro.net/docs/customization.html#MessageVariables|Old documentation of this feature (stale)]] |
| |
| {{tag>customization}} | {{tag>customization}} |
| |
