zydronium/enigma-bbs
1
0
Fork 0
mirror of https://github.com/NuSkooler/enigma-bbs.git synced 2025-06-05 04:07:23 +02:00
Code Issues Projects Releases Packages Wiki Activity

Clean up msg_area_list module (standardize/etc.), update and add docs

Browse source
This commit is contained in:
Bryan Ashby 2018-07-22 19:06:43 -06:00
parent c3bd036509
commit c625d25e2a
6 changed files with 101 additions and 106 deletions
Download patch file Download diff file Expand all files Collapse all files

17
docs/modding/msg-area-list.md Normal file
View file

@ -0,0 +1,17 @@
---
layout: page
title: Message Area List
---
## The Message Area List Module
The built in `msg_area_list` module provides a menu to display and change between message areas in the users current conference.
### Theming
The following `itemFormat` object is provided to MCI 1 (ie: `%VM1`):
* `index`: 1-based index into list.
* `areaTag`: Area tag.
* `name` or `text`: Display name.
* `desc`: Description.
The following additional MCIs are updated as the user changes selections in the main list:
* MCI 2 (ie: `%TL2` or `%M%2`) is updated with the area description.
* MCI 10+ (ie `%TL10`...) are custom ranges updated with the same information available above in `itemFormat`.