2022-02-05 06:30:33 +00:00
<!DOCTYPE html>
< html lang = "en-US" >
< head >
< meta charset = 'utf-8' >
< meta http-equiv = "X-UA-Compatible" content = "chrome=1" >
< meta name = "viewport" content = "width=device-width, initial-scale=1" >
< link rel = "icon" type = "image/png" sizes = "16x16" href = "/enigma-bbs/assets/images/favicon-16x16.png" >
< link rel = "icon" type = "image/png" sizes = "32x32" href = "/enigma-bbs/assets/images/favicon-32x32.png" >
< link rel = "icon" type = "image/png" sizes = "32x32" href = "/enigma-bbs/assets/images/favicon-32x32.png" >
< link rel = "stylesheet" href = "/enigma-bbs/assets/css/style.css?v=" >
<!-- Begin Jekyll SEO tag v2.7.1 -->
< title > Menu Modules | ENiGMA½ BBS Software< / title >
< meta name = "generator" content = "Jekyll v4.2.1" / >
< meta property = "og:title" content = "Menu Modules" / >
< meta property = "og:locale" content = "en_US" / >
2022-08-07 19:07:11 +00:00
< meta name = "description" content = "Menu Modules All menu entries found within menu.hjson are backed by menu modules. Menus are any screen or sectionin within the system. A main menu, a door launcher, and MRC chat are all examples of menus. For basic menus, a standard handler is implemented requiring no code. However, if you would like to create a menu that has custom handling, simply inherit from MenuModule. More on this below." / >
< meta property = "og:description" content = "Menu Modules All menu entries found within menu.hjson are backed by menu modules. Menus are any screen or sectionin within the system. A main menu, a door launcher, and MRC chat are all examples of menus. For basic menus, a standard handler is implemented requiring no code. However, if you would like to create a menu that has custom handling, simply inherit from MenuModule. More on this below." / >
2022-02-05 06:30:33 +00:00
< meta property = "og:site_name" content = "ENiGMA½ BBS Software" / >
< meta property = "og:type" content = "article" / >
2022-08-09 02:15:53 +00:00
< meta property = "article:published_time" content = "2022-08-09T02:15:50+00:00" / >
2022-02-05 06:30:33 +00:00
< meta name = "twitter:card" content = "summary" / >
< meta property = "twitter:title" content = "Menu Modules" / >
< script type = "application/ld+json" >
2022-08-09 02:15:53 +00:00
{"mainEntityOfPage":{"@type":"WebPage","@id":"/enigma-bbs/modding/menu-modules.html"},"description":"Menu Modules All menu entries found within menu.hjson are backed by menu modules. Menus are any screen or sectionin within the system. A main menu, a door launcher, and MRC chat are all examples of menus. For basic menus, a standard handler is implemented requiring no code. However, if you would like to create a menu that has custom handling, simply inherit from MenuModule. More on this below.","url":"/enigma-bbs/modding/menu-modules.html","@type":"BlogPosting","publisher":{"@type":"Organization","logo":{"@type":"ImageObject","url":"/enigma-bbs/assets/images/enigma-logo.png"}},"headline":"Menu Modules","dateModified":"2022-08-09T02:15:50+00:00","datePublished":"2022-08-09T02:15:50+00:00","@context":"https://schema.org"}< / script >
2022-02-05 06:30:33 +00:00
<!-- End Jekyll SEO tag -->
< / head >
< body >
< div id = "container" >
< div class = "sidebar" id = "sidebar" >
2022-08-07 19:07:11 +00:00
< hr class = "mobile-divide" >
2022-02-05 06:30:33 +00:00
< div class = "container" >
2022-08-07 19:07:11 +00:00
< a href = "/enigma-bbs/" > < img src = "/enigma-bbs/assets/images/enigma-logo.png" class = "logo" alt = "Enigma logo" > < / a >
2022-02-05 06:30:33 +00:00
< / div >
< ul >
< li > Installation< / li >
< ul >
< li > < a href = "/enigma-bbs/installation/installation-methods.html" > Installation Methods< / a > < / li >
< li > < a href = "/enigma-bbs/installation/install-script.html" > Install Script< / a > < / li >
< li > < a href = "/enigma-bbs/installation/docker.html" > Docker< / a > < / li >
< li > < a href = "/enigma-bbs/installation/manual.html" > Manual Installation< / a > < / li >
< li > OS / Hardware Specific< / li >
< ul >
< li > < a href = "/enigma-bbs/installation/hardware/rpi.html" > Raspberry Pi< / a > < / li >
< li > < a href = "/enigma-bbs/installation/hardware/windows.html" > Installation Under Windows< / a > < / li >
< / ul >
< li > < a href = "/enigma-bbs/installation/network.html" > Network Setup< / a > < / li >
< li > < a href = "/enigma-bbs/installation/testing.html" > Testing Your Installation< / a > < / li >
< li > < a href = "/enigma-bbs/installation/production.html" > Production Installation< / a > < / li >
< / ul >
< li > Configuration< / li >
< ul >
< li > < a href = "/enigma-bbs/configuration/creating-config.html" > Creating Initial Config Files< / a > < / li >
< li > < a href = "/enigma-bbs/configuration/sysop-setup.html" > SysOp Setup< / a > < / li >
< li > < a href = "/enigma-bbs/configuration/config-files.html" > Configuration Files< / a > < / li >
< li > < a href = "/enigma-bbs/configuration/config-hjson.html" > System Configuration< / a > < / li >
< li > < a href = "/enigma-bbs/configuration/hjson.html" > HJSON Config Files< / a > < / li >
< li > < a href = "/enigma-bbs/configuration/menu-hjson.html" > Menu HSJON< / a > < / li >
< li > < a href = "/enigma-bbs/configuration/directory-structure.html" > Directory Structure< / a > < / li >
< li > < a href = "/enigma-bbs/configuration/external-binaries.html" > External Support Binaries< / a > < / li >
< li > < a href = "/enigma-bbs/configuration/archivers.html" > Archivers< / a > < / li >
< li > < a href = "/enigma-bbs/configuration/file-transfer-protocols.html" > File Transfer Protocols< / a > < / li >
< li > < a href = "/enigma-bbs/configuration/email.html" > Email< / a > < / li >
< li > < a href = "/enigma-bbs/configuration/colour-codes.html" > Colour Codes< / a > < / li >
< li > < a href = "/enigma-bbs/configuration/event-scheduler.html" > Event Scheduler< / a > < / li >
< li > < a href = "/enigma-bbs/configuration/acs.html" > Access Condition System (ACS)< / a > < / li >
< li > < a href = "/enigma-bbs/configuration/security.html" > Security< / a > < / li >
< / ul >
< li > Miscellaneous< / li >
< ul >
< li > < a href = "/enigma-bbs/misc/user-interrupt.html" > User Interruptions< / a > < / li >
< / ul >
< li > File Base< / li >
< ul >
< li > < a href = "/enigma-bbs/filebase/index.html" > About File Areas< / a > < / li >
< li > < a href = "/enigma-bbs/filebase/first-file-area.html" > Configuring a File Base< / a > < / li >
< li > < a href = "/enigma-bbs/filebase/acs.html" > ACS< / a > < / li >
< li > < a href = "/enigma-bbs/filebase/uploads.html" > Uploads< / a > < / li >
< li > < a href = "/enigma-bbs/filebase/web-access.html" > Web Access< / a > < / li >
< li > < a href = "/enigma-bbs/filebase/tic-support.html" > TIC Support< / a > < / li >
< li > < a href = "/enigma-bbs/filebase/network-mounts-and-symlinks.html" > Network Mounts & Symlinks< / a > < / li >
< / ul >
< li > Message Areas< / li >
< ul >
< li > < a href = "/enigma-bbs/messageareas/configuring-a-message-area.html" > Message Base< / a > < / li >
< li > < a href = "/enigma-bbs/messageareas/message-networks.html" > Message Networks< / a > < / li >
< li > < a href = "/enigma-bbs/messageareas/bso-import-export.html" > BSO Import / Export< / a > < / li >
< li > < a href = "/enigma-bbs/messageareas/netmail.html" > Netmail< / a > < / li >
< li > < a href = "/enigma-bbs/messageareas/qwk.html" > QWK Support< / a > < / li >
< li > < a href = "/enigma-bbs/messageareas/ftn.html" > FidoNet-Style Networks (FTN)< / a > < / li >
< / ul >
< li > Art< / li >
< ul >
< li > < a href = "/enigma-bbs/art/general.html" > General Art Information< / a > < / li >
< li > < a href = "/enigma-bbs/art/themes.html" > Themes< / a > < / li >
< li > < a href = "/enigma-bbs/art/mci.html" > MCI Codes< / a > < / li >
< li > Views< / li >
< ul >
< li > < a href = "/enigma-bbs/art/views/button_view.html" > Button View< / a > < / li >
< li > < a href = "/enigma-bbs/art/views/edit_text_view.html" > Edit Text View< / a > < / li >
< li > < a href = "/enigma-bbs/art/views/full_menu_view.html" > Full Menu View< / a > < / li >
< li > < a href = "/enigma-bbs/art/views/horizontal_menu_view.html" > Horizontal Menu View< / a > < / li >
< li > < a href = "/enigma-bbs/art/views/mask_edit_text_view.html" > Mask Edit Text View< / a > < / li >
< li > < a href = "/enigma-bbs/art/views/multi_line_edit_text_view.html" > Multi Line Edit Text View< / a > < / li >
< li > < a href = "/enigma-bbs/art/views/predefined_label_view.html" > Predefined Label View< / a > < / li >
< li > < a href = "/enigma-bbs/art/views/spinner_menu_view.html" > Spinner Menu View< / a > < / li >
< li > < a href = "/enigma-bbs/art/views/text_view.html" > Text View< / a > < / li >
< li > < a href = "/enigma-bbs/art/views/toggle_menu_view.html" > Toggle Menu View< / a > < / li >
< li > < a href = "/enigma-bbs/art/views/vertical_menu_view.html" > Vertical Menu View< / a > < / li >
< / ul >
< / ul >
< li > Servers< / li >
< ul >
< li > Login Servers< / li >
< ul >
< li > < a href = "/enigma-bbs/servers/loginservers/telnet.html" > Telnet Server< / a > < / li >
< li > < a href = "/enigma-bbs/servers/loginservers/ssh.html" > SSH Server< / a > < / li >
< li > < a href = "/enigma-bbs/servers/loginservers/websocket.html" > Web Socket / Web Interface Server< / a > < / li >
< / ul >
< li > Content Servers< / li >
< ul >
< li > < a href = "/enigma-bbs/servers/contentservers/web-server.html" > Web Server< / a > < / li >
< li > < a href = "/enigma-bbs/servers/contentservers/gopher.html" > Gopher Server< / a > < / li >
< li > < a href = "/enigma-bbs/servers/contentservers/nntp.html" > NNTP Server< / a > < / li >
< / ul >
< / ul >
< li > Modding< / li >
< ul >
< li > < a href = "/enigma-bbs/modding/local-doors.html" > Local Doors< / a > < / li >
< li > < a href = "/enigma-bbs/modding/door-servers.html" > Door Servers< / a > < / li >
< li > < a href = "/enigma-bbs/modding/telnet-bridge.html" > Telnet Bridge< / a > < / li >
< li > < a href = "/enigma-bbs/modding/existing-mods.html" > Existing Mods< / a > < / li >
< li > < a href = "/enigma-bbs/modding/file-area-list.html" > File Area List< / a > < / li >
< li > < a href = "/enigma-bbs/modding/last-callers.html" > Last Callers< / a > < / li >
< li > < a href = "/enigma-bbs/modding/whos-online.html" > Who's Online< / a > < / li >
< li > < a href = "/enigma-bbs/modding/user-list.html" > User List< / a > < / li >
< li > < a href = "/enigma-bbs/modding/msg-conf-list.html" > Message Conference List< / a > < / li >
< li > < a href = "/enigma-bbs/modding/msg-area-list.html" > Message Area List< / a > < / li >
< li > < a href = "/enigma-bbs/modding/bbs-list.html" > BBS List< / a > < / li >
< li > < a href = "/enigma-bbs/modding/rumorz.html" > Rumorz< / a > < / li >
< li > < a href = "/enigma-bbs/modding/file-transfer-protocol-select.html" > File Transfer Protocol Select< / a > < / li >
< li > < a href = "/enigma-bbs/modding/onelinerz.html" > Onelinerz< / a > < / li >
< li > < a href = "/enigma-bbs/modding/show-art.html" > The Show Art Module< / a > < / li >
< li > < a href = "/enigma-bbs/modding/file-base-download-manager.html" > File Base Download Manager< / a > < / li >
< li > < a href = "/enigma-bbs/modding/file-base-web-download-manager.html" > File Base Web Download Manager< / a > < / li >
< li > < a href = "/enigma-bbs/modding/set-newscan-date.html" > Set Newscan Date Module< / a > < / li >
< li > < a href = "/enigma-bbs/modding/node-msg.html" > Node to Node Messaging< / a > < / li >
< li > < a href = "/enigma-bbs/modding/top-x.html" > TopX< / a > < / li >
< li > < a href = "/enigma-bbs/modding/user-2fa-otp-config.html" > 2FA/OTP Config< / a > < / li >
< li > < a href = "/enigma-bbs/modding/autosig-edit.html" > Auto Signature Editor< / a > < / li >
< li class = "active-nav" > Menu Modules< / li >
< / ul >
< li > Administration< / li >
< ul >
< li > < a href = "/enigma-bbs/admin/administration.html" > Administration< / a > < / li >
< li > < a href = "/enigma-bbs/admin/oputil.html" > oputil< / a > < / li >
< li > < a href = "/enigma-bbs/admin/updating.html" > Updating< / a > < / li >
< / ul >
< li > Troubleshooting< / li >
< ul >
< li > < a href = "/enigma-bbs/troubleshooting/monitoring-logs.html" > Monitoring Logs< / a > < / li >
2022-08-04 18:38:39 +00:00
< / ul >
< li > Modding< / li >
< ul >
< li > < a href = "/enigma-bbs/modding/wfc.html" > Waiting For Caller (WFC)< / a > < / li >
2022-02-05 06:30:33 +00:00
< / ul >
< / ul >
< / div >
< div class = "main_area" >
< div class = "container" >
< section id = "main_content" >
< div class = "PageNavigation" >
2022-08-07 19:07:11 +00:00
< a class = "btn" style = "float:left;margin-right: 20px;" href = "/enigma-bbs/modding/autosig-edit.html" > « Auto Signature Editor< / a >
2022-02-05 06:30:33 +00:00
< a href = "#sidebar" class = "btn menu_button" > MENU< / a >
2022-08-07 19:07:11 +00:00
< a class = "btn" style = "float: right;margin-left: 20px" href = "/enigma-bbs/admin/administration.html" > Administration »< / a >
2022-02-05 06:30:33 +00:00
2022-08-07 19:07:11 +00:00
< br clear = "both" >
2022-02-05 06:30:33 +00:00
< / div >
< div class = "page" >
< h1 class = "page-title" > Menu Modules< / h1 >
< h2 id = "menu-modules" > Menu Modules< / h2 >
2022-08-07 19:07:11 +00:00
< p > All menu entries found within < code class = "language-plaintext highlighter-rouge" > menu.hjson< / code > are backed by < em > menu modules< / em > . Menus are any screen or sectionin within the system. A main menu, a door launcher, and MRC chat are all examples of menus. For basic menus, a standard handler is implemented requiring no code. However, if you would like to create a menu that has custom handling, simply inherit from < code class = "language-plaintext highlighter-rouge" > MenuModule< / code > . More on this below.< / p >
2022-02-05 06:30:33 +00:00
2022-08-07 19:07:11 +00:00
< blockquote >
< p > < img class = "emoji" title = ":information_source:" alt = ":information_source:" src = "https://github.githubassets.com/images/icons/emoji/unicode/2139.png" height = "20" width = "20" > Remember that ENiGMA does not impose any stucture to your system! The “flow” of all < code class = "language-plaintext highlighter-rouge" > menu.hjson< / code > entries is up to you!< / p >
< / blockquote >
2022-02-05 06:30:33 +00:00
2022-08-07 19:07:11 +00:00
< h2 id = "creating-a-new-module" > Creating a New Module< / h2 >
< p > At the highest level, to create a new custom menu or mod, inherit from < code class = "language-plaintext highlighter-rouge" > MenuModule< / code > and expose it via the < code class = "language-plaintext highlighter-rouge" > getModule< / code > exported method:< / p >
< div class = "language-javascript highlighter-rouge" > < div class = "highlight" > < pre class = "highlight" > < code > < span class = "c1" > // my_fancy_module.js< / span >
< span class = "nx" > exports< / span > < span class = "p" > .< / span > < span class = "nx" > getModule< / span > < span class = "o" > =< / span > < span class = "kd" > class< / span > < span class = "nx" > MyFancyModule< / span > < span class = "kd" > extends< / span > < span class = "nx" > MenuModule< / span > < span class = "p" > {< / span >
< span class = "kd" > constructor< / span > < span class = "p" > (< / span > < span class = "nx" > options< / span > < span class = "p" > )< / span > < span class = "p" > {< / span >
< span class = "k" > super< / span > < span class = "p" > (< / span > < span class = "nx" > options< / span > < span class = "p" > );< / span >
< span class = "p" > }< / span >
< span class = "p" > };< / span >
< / code > < / pre > < / div > < / div >
< h2 id = "lifecycle" > Lifecycle< / h2 >
< p > Below is a very high level diagram showing the basic lifecycle of a menu.< / p >
< p > < img src = "/enigma-bbs/assets/images/basic_menu_lifecycle.png" alt = "Basic Menu Lifecycle" > < / p >
< p > Methods indicated above with < code class = "language-plaintext highlighter-rouge" > ()< / code > in their name such as < code class = "language-plaintext highlighter-rouge" > enter()< / code > are overridable when inheriting form < code class = "language-plaintext highlighter-rouge" > MenuModule< / code > .< / p >
< h2 id = "menumodule-helper-methods" > MenuModule Helper Methods< / h2 >
< p > Many helper methods exist and are available to code inheriting from < code class = "language-plaintext highlighter-rouge" > MenuModule< / code > . Below are some examples. Poke around at < a href = "../../../core/menu_module.js" > menu_module.js< / a > to discover more!< / p >
2022-08-09 02:15:53 +00:00
< h3 id = "views--view-controller" > Views & View Controller< / h3 >
2022-08-07 19:07:11 +00:00
< ul >
< li > < code class = "language-plaintext highlighter-rouge" > displayAsset()< / code > < / li >
< li > < code class = "language-plaintext highlighter-rouge" > prepViewController()< / code > < / li >
< li > < code class = "language-plaintext highlighter-rouge" > prepViewControllerWithArt()< / code > < / li >
< li > < code class = "language-plaintext highlighter-rouge" > displayArtAndPrepViewController()< / code > < / li >
< li > < code class = "language-plaintext highlighter-rouge" > setViewText()< / code > < / li >
< li > < code class = "language-plaintext highlighter-rouge" > getView()< / code > < / li >
< li > < code class = "language-plaintext highlighter-rouge" > updateCustomViewTextsWithFilter()< / code > < / li >
< li > < code class = "language-plaintext highlighter-rouge" > refreshPredefinedMciViewsByCode()< / code > < / li >
2022-08-09 02:15:53 +00:00
< / ul >
< h3 id = "validation" > Validation< / h3 >
< ul >
2022-08-07 19:07:11 +00:00
< li > < code class = "language-plaintext highlighter-rouge" > validateMCIByViewIds()< / code > < / li >
< li > < code class = "language-plaintext highlighter-rouge" > validateConfigFields()< / code > < / li >
2022-08-09 02:15:53 +00:00
< / ul >
< h3 id = "datetime-helpers" > Date/Time Helpers< / h3 >
< p > The following methods take a single input to specify style, defaulting to < code class = "language-plaintext highlighter-rouge" > short< / code > :< / p >
< ul >
2022-08-07 19:07:11 +00:00
< li > < code class = "language-plaintext highlighter-rouge" > getDateFormat()< / code > < / li >
< li > < code class = "language-plaintext highlighter-rouge" > getTimeFormat()< / code > < / li >
< li > < code class = "language-plaintext highlighter-rouge" > getDateTimeFormat()< / code > < / li >
< / ul >
2022-02-05 06:30:33 +00:00
2022-08-09 02:15:53 +00:00
< h3 id = "misc" > Misc< / h3 >
< ul >
< li > < code class = "language-plaintext highlighter-rouge" > promptForInput()< / code > < / li >
< / ul >
2022-08-07 19:07:11 +00:00
< blockquote >
< p > < img class = "emoji" title = ":information_source:" alt = ":information_source:" src = "https://github.githubassets.com/images/icons/emoji/unicode/2139.png" height = "20" width = "20" > Search the code for the above methods to see how they are used in the base system!< / p >
< / blockquote >
2022-02-05 06:30:33 +00:00
< / div >
< div class = "PageNavigation" >
2022-08-07 19:07:11 +00:00
< a class = "btn" style = "float:left;margin-right: 20px;" href = "/enigma-bbs/modding/autosig-edit.html" > « Auto Signature Editor< / a >
2022-02-05 06:30:33 +00:00
2022-08-07 19:07:11 +00:00
< a class = "btn" style = "float: right;margin-left: 20px" href = "/enigma-bbs/admin/administration.html" > Administration »< / a >
2022-02-05 06:30:33 +00:00
2022-08-07 19:07:11 +00:00
< br clear = "both" >
2022-02-05 06:30:33 +00:00
< / div >
< / section >
< / div >
< / div >
< / div >
< / body >
< / html >
