zydronium/enigma-bbs
1
0
Fork 0
mirror of https://github.com/NuSkooler/enigma-bbs.git synced 2025-07-22 10:45:56 +02:00
Code Issues Projects Releases Packages Wiki Activity

User interrupts & node module ready to rock. ...maybe with bugs?

Browse source
This commit is contained in:
Bryan Ashby 2018-11-30 23:20:44 -07:00
parent d9238ee6a5
commit fe44f2c4d6
9 changed files with 198 additions and 68 deletions
Download patch file Download diff file Expand all files Collapse all files

17
docs/misc/user-interrupt.md Normal file
View file

@ -0,0 +1,17 @@
---
layout: page
title: User Interruptions
---
## User Interruptions
ENiGMA½ provides functionality to "interrupt" a user for various purposes such as a [node-to-node message](/docs/modding/node-msg.md). User interruptions can be queued and displayed at the next opportune time such as when switching to a new menu, or realtime if appropriate.
## Standard Menu Behavior
Standard menus control interruption by the `interrupt` config block option, which may be set to one of the following values:
* `never`: Never interrupt the user when on this menu.
* `queued`: Queue interrupts for the next opportune time. Any queued message(s) will then be shown. This is the default.
* `realtime`: If possible, display messages in realtime. That is, show them right away. Standard menus that do not override default behavior will show the message then reload.
## See Also
See [user_interrupt_queue.js](/core/user_interrupt_queue.js) as well as usage within [menu_module.js](/core/menu_module.js).