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

WFC documentation updates

Browse Source
This commit is contained in:
Bryan Ashby
2022-05-07 17:13:10 -06:00
parent bd28de9a69
commit f7788fc01c
4 changed files with 54 additions and 22 deletions
Download Patch File Download Diff File Expand all files Collapse all files

5
docs/_docs/modding/whos-online.md
View File

@@ -8,6 +8,7 @@ The built in `whos_online` module provides a basic who's online mod.
### Theming
The following `itemFormat` object is provided to MCI 1 (ie: `%VM1`):
* `userId`: User ID.
* `authenticated`: boolean if the client has a logged in user or not.
* `userName`: Login username.
* `node`: Node ID the user is connected to.
* `timeOn`: A human friendly amount of time the user has been online.
@@ -15,4 +16,8 @@ The following `itemFormat` object is provided to MCI 1 (ie: `%VM1`):
* `location`: User's location.
* `affiliation` or `affils`: Users affiliations.
* `action`: Current action/view in the system taken from the `desc` field of the current MenuModule they are interacting with. For example, "Playing L.O.R.D".
* `isSecure`: Is the client securely connected?
* `serverName`: Name of connected server such as "Telnet" or "SSH".
:information_source: These properties are available via the `client_connections.js` `getActiveConnectionList()` API.