~jadedctrl/gem-xwx-moe
~jadedctrl/gem-xwx-moe/gemujo_ludo/mods.niaj/fasado/subtitles/doc/modules/menu.html
..
| 0 | <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" |
| 1 | "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"> |
| 2 | <html> |
| 3 | <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/> |
| 4 | <head> |
| 5 | <title>Subtitles API Reference</title> |
| 6 | <link rel="stylesheet" href="../ldoc.css" type="text/css" /> |
| 7 | </head> |
| 8 | <body> |
| 9 | |
| 10 | <div id="container"> |
| 11 | |
| 12 | <div id="product"> |
| 13 | <div id="product_logo"></div> |
| 14 | <div id="product_name"><big><b></b></big></div> |
| 15 | <div id="product_description"></div> |
| 16 | </div> <!-- id="product" --> |
| 17 | |
| 18 | |
| 19 | <div id="main"> |
| 20 | |
| 21 | |
| 22 | <!-- Menu --> |
| 23 | |
| 24 | <div id="navigation"> |
| 25 | <br/> |
| 26 | <h1>ldoc</h1> |
| 27 | |
| 28 | <ul> |
| 29 | <li><a href="../index.html">Index</a></li> |
| 30 | </ul> |
| 31 | |
| 32 | <h2>Contents</h2> |
| 33 | <ul> |
| 34 | <li><a href="#Functions">Functions</a></li> |
| 35 | </ul> |
| 36 | |
| 37 | |
| 38 | <h2>Modules</h2> |
| 39 | <ul class="nowrap"> |
| 40 | <li><a href="../modules/Agent.html">Agent</a></li> |
| 41 | <li><a href="../modules/BaseTextSubtitleDisplay.html">BaseTextSubtitleDisplay</a></li> |
| 42 | <li><a href="../modules/ChatSubtitleDisplay.html">ChatSubtitleDisplay</a></li> |
| 43 | <li><a href="../modules/ClassicSubtitleDisplay.html">ClassicSubtitleDisplay</a></li> |
| 44 | <li><a href="../modules/CornerSubtitleDisplay.html">CornerSubtitleDisplay</a></li> |
| 45 | <li><a href="../modules/Sound.html">Sound</a></li> |
| 46 | <li><a href="../modules/SubtitleDisplay.html">SubtitleDisplay</a></li> |
| 47 | <li><a href="../modules/WaypointSubtitleDisplay.html">WaypointSubtitleDisplay</a></li> |
| 48 | <li><a href="../modules/api.html">api</a></li> |
| 49 | <li><a href="../modules/chatcommands.html">chatcommands</a></li> |
| 50 | <li><a href="../modules/descriptions.html">descriptions</a></li> |
| 51 | <li><a href="../modules/init.html">init</a></li> |
| 52 | <li><a href="../modules/listeners.html">listeners</a></li> |
| 53 | <li><strong>menu</strong></li> |
| 54 | <li><a href="../modules/util.html">util</a></li> |
| 55 | </ul> |
| 56 | |
| 57 | </div> |
| 58 | |
| 59 | <div id="content"> |
| 60 | |
| 61 | <h1>Module <code>menu</code></h1> |
| 62 | <p>Implements the subtitle menu GUI.</p> |
| 63 | <p></p> |
| 64 | |
| 65 | |
| 66 | <h2><a href="#Functions">Functions</a></h2> |
| 67 | <table class="function_list"> |
| 68 | <tr> |
| 69 | <td class="name" nowrap><a href="#subtitles.get_menu_formspec">subtitles.get_menu_formspec (player, embedded, options)</a></td> |
| 70 | <td class="summary">Creates a menu formspec for the specified player.</td> |
| 71 | </tr> |
| 72 | <tr> |
| 73 | <td class="name" nowrap><a href="#subtitles.show_menu">subtitles.show_menu (player)</a></td> |
| 74 | <td class="summary">Shows the subtitle menu to the specified player.</td> |
| 75 | </tr> |
| 76 | <tr> |
| 77 | <td class="name" nowrap><a href="#subtitles.menu_receive_fields">subtitles.menu_receive_fields (player, fields, embedded)</a></td> |
| 78 | <td class="summary">Handles receiving fields from the menu formspec.</td> |
| 79 | </tr> |
| 80 | </table> |
| 81 | |
| 82 | <br/> |
| 83 | <br/> |
| 84 | |
| 85 | |
| 86 | <h2 class="section-header "><a name="Functions"></a>Functions</h2> |
| 87 | |
| 88 | <dl class="function"> |
| 89 | <dt> |
| 90 | <a name = "subtitles.get_menu_formspec"></a> |
| 91 | <strong>subtitles.get_menu_formspec (player, embedded, options)</strong> |
| 92 | </dt> |
| 93 | <dd> |
| 94 | Creates a menu formspec for the specified player. |
| 95 | |
| 96 | |
| 97 | <h3>Parameters:</h3> |
| 98 | <ul> |
| 99 | <li><span class="parameter">player</span> |
| 100 | The username or ObjectRef of the player. |
| 101 | </li> |
| 102 | <li><span class="parameter">embedded</span> |
| 103 | This should be true if the menu is being embedded in another formspec. |
| 104 | </li> |
| 105 | <li><span class="parameter">options</span> |
| 106 | A table of extra options: width, height. |
| 107 | </li> |
| 108 | </ul> |
| 109 | |
| 110 | <h3>Returns:</h3> |
| 111 | <ol> |
| 112 | |
| 113 | A formspec string. |
| 114 | </ol> |
| 115 | |
| 116 | |
| 117 | |
| 118 | |
| 119 | </dd> |
| 120 | <dt> |
| 121 | <a name = "subtitles.show_menu"></a> |
| 122 | <strong>subtitles.show_menu (player)</strong> |
| 123 | </dt> |
| 124 | <dd> |
| 125 | Shows the subtitle menu to the specified player. |
| 126 | |
| 127 | |
| 128 | <h3>Parameters:</h3> |
| 129 | <ul> |
| 130 | <li><span class="parameter">player</span> |
| 131 | The username or ObjectRef of the player. |
| 132 | </li> |
| 133 | </ul> |
| 134 | |
| 135 | |
| 136 | |
| 137 | |
| 138 | |
| 139 | </dd> |
| 140 | <dt> |
| 141 | <a name = "subtitles.menu_receive_fields"></a> |
| 142 | <strong>subtitles.menu_receive_fields (player, fields, embedded)</strong> |
| 143 | </dt> |
| 144 | <dd> |
| 145 | Handles receiving fields from the menu formspec. |
| 146 | |
| 147 | |
| 148 | <h3>Parameters:</h3> |
| 149 | <ul> |
| 150 | <li><span class="parameter">player</span> |
| 151 | The username or ObjectRef of the player. |
| 152 | </li> |
| 153 | <li><span class="parameter">fields</span> |
| 154 | A table of fields. |
| 155 | </li> |
| 156 | <li><span class="parameter">embedded</span> |
| 157 | If this is true, the menu will not be re-shown. |
| 158 | </li> |
| 159 | </ul> |
| 160 | |
| 161 | |
| 162 | |
| 163 | |
| 164 | |
| 165 | </dd> |
| 166 | </dl> |
| 167 | |
| 168 | |
| 169 | </div> <!-- id="content" --> |
| 170 | </div> <!-- id="main" --> |
| 171 | <div id="about"> |
| 172 | <i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i> |
| 173 | <i style="float:right;">Last updated 2023-01-14 06:51:17 </i> |
| 174 | </div> <!-- id="about" --> |
| 175 | </div> <!-- id="container" --> |
| 176 | </body> |
| 177 | </html> |