crichardson/enigma-bbs
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Add MCI codes, helpers, and format keys for user availability and visibility

Browse Source 
* New MCI codes: IA and IV
* availInicator and visIndicator to WFC format keys
* New helpers for availalbe and visible indicators (see themes)
This commit is contained in:
Bryan Ashby
2022-05-24 19:46:39 -06:00
parent 868e14aa8e
commit 2b3d5be3d9
8 changed files with 57 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
docs/_docs/art/mci.md
View File

@@ -107,6 +107,8 @@ There are many predefined MCI codes that can be used anywhere on the system (pla
| `NT` | Total *new* users *today* |
| `NM` | Count of new messages **address to the current user** across all message areas in which they have access |
| `NP` | Count of new private mail to the current user |
| `IA` | Indicator as to rather the current user is **available** or not. See also `getStatusAvailIndicators()` in [Themes](themes.md) |
| `IV` | Indicator as to rather the curent user is **visible** or not. See also `getStatusVisibleIndicators()` in [Themes](themes.md) |
Some additional special case codes also exist:

2
docs/_docs/art/themes.md
View File

@@ -51,6 +51,8 @@ Override system defaults.
| `dateFormat` | Sets the [moment.js](https://momentjs.com/docs/#/displaying/) style `short` and/or `long` format for dates. |
| `timeFormat` | Sets the [moment.js](https://momentjs.com/docs/#/displaying/) style `short` and/or `long` format for times. |
| `dateTimeFormat` | Sets the [moment.js](https://momentjs.com/docs/#/displaying/) style `short` and/or `long` format for date/time combinations. |
| `getStatusAvailIndicators` | An array[2] of **availability** status indicators. Defaults to `[ 'Y', 'N' ]`. |
| `getStatusVisibleIndicators` | An array[2] of **visibility** status indicators. Defaults to `[ 'Y', 'N' ]`. |
Example:
```hjson

5
docs/_docs/modding/wfc.md
View File

@@ -80,4 +80,7 @@ The following MCI codes are available:
* `systemAvgLoad`: System average load.
* `systemCurrentLoad`: System current load.
* `newPrivateMail`: Number of new **privae** mail for current user.
* `newMessagesAddrTo`: Number of new messages **addressed to the current user**.
* `newMessagesAddrTo`: Number of new messages **addressed to the current user**.
:information_source: While [Standard MCI](../art/mci.md) codes work on any menu, they will **not** refresh. For values that may change over time, please use the custom format values above.