group__MessageBox.html 4.7 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112
  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  2. <html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
  3. <head>
  4. <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
  5. <meta http-equiv="X-UA-Compatible" content="IE=11"/>
  6. <meta name="generator" content="Doxygen 1.9.8"/>
  7. <meta name="viewport" content="width=device-width, initial-scale=1"/>
  8. <title>TorqueScript Reference: Message Box</title>
  9. <link href="tabs.css" rel="stylesheet" type="text/css"/>
  10. <script type="text/javascript" src="jquery.js"></script>
  11. <script type="text/javascript" src="dynsections.js"></script>
  12. <link href="doxygen.css" rel="stylesheet" type="text/css" />
  13. <link href="t2d-stylesheet-extra.css" rel="stylesheet" type="text/css"/>
  14. </head>
  15. <body>
  16. <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  17. <div id="titlearea">
  18. <table cellspacing="0" cellpadding="0">
  19. <tbody>
  20. <tr id="projectrow">
  21. <td id="projectalign">
  22. <div id="projectname">TorqueScript Reference
  23. </div>
  24. </td>
  25. </tr>
  26. </tbody>
  27. </table>
  28. </div>
  29. <!-- end header part -->
  30. <!-- Generated by Doxygen 1.9.8 -->
  31. <script type="text/javascript" src="menudata.js"></script>
  32. <script type="text/javascript" src="menu.js"></script>
  33. <script type="text/javascript">
  34. /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
  35. $(function() {
  36. initMenu('',false,false,'search.php','Search');
  37. });
  38. /* @license-end */
  39. </script>
  40. <div id="main-nav"></div>
  41. </div><!-- top -->
  42. <div class="header">
  43. <div class="summary">
  44. <a href="#func-members">Functions</a> </div>
  45. <div class="headertitle"><div class="title">Message Box<div class="ingroups"><a class="el" href="group__TorqueScriptFunctions.html">Function Categories</a></div></div></div>
  46. </div><!--header-->
  47. <div class="contents">
  48. <table class="memberdecls">
  49. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="func-members" name="func-members"></a>
  50. Functions</h2></td></tr>
  51. <tr class="memitem:gabc69bc782276762f856f69f334a000d6" id="r_gabc69bc782276762f856f69f334a000d6"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#ga85be84504cf913ad90b8ee4f264195d3">Integer</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__MessageBox.html#gabc69bc782276762f856f69f334a000d6">messageBox</a> (title, message, [buttons]?, [icon]?)</td></tr>
  52. <tr class="separator:gabc69bc782276762f856f69f334a000d6"><td class="memSeparator" colspan="2">&#160;</td></tr>
  53. </table>
  54. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  55. <h2 class="groupheader">Function Documentation</h2>
  56. <a id="gabc69bc782276762f856f69f334a000d6" name="gabc69bc782276762f856f69f334a000d6"></a>
  57. <h2 class="memtitle"><span class="permalink"><a href="#gabc69bc782276762f856f69f334a000d6">&#9670;&#160;</a></span>messageBox()</h2>
  58. <div class="memitem">
  59. <div class="memproto">
  60. <table class="memname">
  61. <tr>
  62. <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#ga85be84504cf913ad90b8ee4f264195d3">Integer</a> messageBox </td>
  63. <td>(</td>
  64. <td class="paramtype">title&#160;</td>
  65. <td class="paramname">, </td>
  66. </tr>
  67. <tr>
  68. <td class="paramkey"></td>
  69. <td></td>
  70. <td class="paramtype">message&#160;</td>
  71. <td class="paramname">, </td>
  72. </tr>
  73. <tr>
  74. <td class="paramkey"></td>
  75. <td></td>
  76. <td class="paramtype">[buttons] ?&#160;</td>
  77. <td class="paramname">, </td>
  78. </tr>
  79. <tr>
  80. <td class="paramkey"></td>
  81. <td></td>
  82. <td class="paramtype">[icon] ?&#160;</td>
  83. <td class="paramname">&#160;</td>
  84. </tr>
  85. <tr>
  86. <td></td>
  87. <td>)</td>
  88. <td></td><td></td>
  89. </tr>
  90. </table>
  91. </div><div class="memdoc">
  92. <p>Pops up a message box </p><dl class="params"><dt>Parameters</dt><dd>
  93. <table class="params">
  94. <tr><td class="paramname">title</td><td>The message box's title to display </td></tr>
  95. <tr><td class="paramname">message</td><td>The message to display in the box </td></tr>
  96. <tr><td class="paramname">buttons</td><td>The buttons to include on box (default MBOkCancel) </td></tr>
  97. <tr><td class="paramname">icon</td><td>The displayed icon (default MIInformation) </td></tr>
  98. </table>
  99. </dd>
  100. </dl>
  101. <dl class="section return"><dt>Returns</dt><dd>Returns the ID of the box </dd></dl>
  102. </div>
  103. </div>
  104. </div><!-- contents -->
  105. <!-- start footer part -->
  106. <hr class="footer"/><address class="footer"><small>
  107. Generated by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.8
  108. </small></address>
  109. </body>
  110. </html>