group__AssertFunctions.html 3.6 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596
  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  2. <html xmlns="http://www.w3.org/1999/xhtml">
  3. <head>
  4. <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
  5. <meta http-equiv="X-UA-Compatible" content="IE=9"/>
  6. <meta name="generator" content="Doxygen 1.8.3.1"/>
  7. <title>TorqueScript Reference: Assert</title>
  8. <link href="tabs.css" rel="stylesheet" type="text/css"/>
  9. <script type="text/javascript" src="jquery.js"></script>
  10. <script type="text/javascript" src="dynsections.js"></script>
  11. <link href="doxygen.css" rel="stylesheet" type="text/css" />
  12. <link href="t2d-stylesheet-extra.css" rel="stylesheet" type="text/css"/>
  13. </head>
  14. <body>
  15. <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  16. <div id="titlearea">
  17. <table cellspacing="0" cellpadding="0">
  18. <tbody>
  19. <tr style="height: 56px;">
  20. <td style="padding-left: 0.5em;">
  21. <div id="projectname">TorqueScript Reference
  22. </div>
  23. </td>
  24. </tr>
  25. </tbody>
  26. </table>
  27. </div>
  28. <!-- end header part -->
  29. <!-- Generated by Doxygen 1.8.3.1 -->
  30. <div id="navrow1" class="tabs">
  31. <ul class="tablist">
  32. <li><a href="index.html"><span>Main&#160;Page</span></a></li>
  33. <li><a href="pages.html"><span>Related&#160;Pages</span></a></li>
  34. <li><a href="modules.html"><span>Modules</span></a></li>
  35. <li><a href="annotated.html"><span>Classes</span></a></li>
  36. </ul>
  37. </div>
  38. </div><!-- top -->
  39. <div class="header">
  40. <div class="summary">
  41. <a href="#func-members">Functions</a> </div>
  42. <div class="headertitle">
  43. <div class="title">Assert<div class="ingroups"><a class="el" href="group__TorqueScriptFunctions.html">Function Categories</a></div></div> </div>
  44. </div><!--header-->
  45. <div class="contents">
  46. <table class="memberdecls">
  47. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
  48. Functions</h2></td></tr>
  49. <tr class="memitem:ga357bbe9fcdf01f0ca7595069fa339da7"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__AssertFunctions.html#ga357bbe9fcdf01f0ca7595069fa339da7">Assert</a> (condition, message)</td></tr>
  50. <tr class="separator:ga357bbe9fcdf01f0ca7595069fa339da7"><td class="memSeparator" colspan="2">&#160;</td></tr>
  51. </table>
  52. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  53. <h2 class="groupheader">Function Documentation</h2>
  54. <a class="anchor" id="ga357bbe9fcdf01f0ca7595069fa339da7"></a>
  55. <div class="memitem">
  56. <div class="memproto">
  57. <table class="memname">
  58. <tr>
  59. <td class="memname">void Assert </td>
  60. <td>(</td>
  61. <td class="paramtype">condition&#160;</td>
  62. <td class="paramname">, </td>
  63. </tr>
  64. <tr>
  65. <td class="paramkey"></td>
  66. <td></td>
  67. <td class="paramtype">message&#160;</td>
  68. <td class="paramname">&#160;</td>
  69. </tr>
  70. <tr>
  71. <td></td>
  72. <td>)</td>
  73. <td></td><td></td>
  74. </tr>
  75. </table>
  76. </div><div class="memdoc">
  77. <p>Fatal Script Assertion </p>
  78. <dl class="params"><dt>Parameters</dt><dd>
  79. <table class="params">
  80. <tr><td class="paramname">condition</td><td>if false, exit the program </td></tr>
  81. <tr><td class="paramname">message</td><td>message to print on assertion </td></tr>
  82. </table>
  83. </dd>
  84. </dl>
  85. </div>
  86. </div>
  87. </div><!-- contents -->
  88. <!-- start footer part -->
  89. <hr class="footer"/><address class="footer"><small>
  90. Generated by &#160;<a href="http://www.doxygen.org/index.html">
  91. <img class="footer" src="doxygen.png" alt="doxygen"/>
  92. </a> 1.8.3.1
  93. </small></address>
  94. </body>
  95. </html>