struct_console_log_entry.html 14 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220
  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>Torque2D Reference: ConsoleLogEntry Struct Reference</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="search/search.css" rel="stylesheet" type="text/css"/>
  13. <script type="text/javascript" src="search/searchdata.js"></script>
  14. <script type="text/javascript" src="search/search.js"></script>
  15. <link href="doxygen.css" rel="stylesheet" type="text/css" />
  16. <link href="t2d-stylesheet-extra.css" rel="stylesheet" type="text/css"/>
  17. </head>
  18. <body>
  19. <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  20. <div id="titlearea">
  21. <table cellspacing="0" cellpadding="0">
  22. <tbody>
  23. <tr id="projectrow">
  24. <td id="projectalign">
  25. <div id="projectname">Torque2D Reference
  26. </div>
  27. </td>
  28. </tr>
  29. </tbody>
  30. </table>
  31. </div>
  32. <!-- end header part -->
  33. <!-- Generated by Doxygen 1.9.8 -->
  34. <script type="text/javascript">
  35. /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
  36. var searchBox = new SearchBox("searchBox", "search/",'.html');
  37. /* @license-end */
  38. </script>
  39. <script type="text/javascript" src="menudata.js"></script>
  40. <script type="text/javascript" src="menu.js"></script>
  41. <script type="text/javascript">
  42. /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
  43. $(function() {
  44. initMenu('',true,false,'search.php','Search');
  45. $(document).ready(function() { init_search(); });
  46. });
  47. /* @license-end */
  48. </script>
  49. <div id="main-nav"></div>
  50. <!-- window showing the filter options -->
  51. <div id="MSearchSelectWindow"
  52. onmouseover="return searchBox.OnSearchSelectShow()"
  53. onmouseout="return searchBox.OnSearchSelectHide()"
  54. onkeydown="return searchBox.OnSearchSelectKey(event)">
  55. </div>
  56. <!-- iframe showing the search results (closed by default) -->
  57. <div id="MSearchResultsWindow">
  58. <div id="MSearchResults">
  59. <div class="SRPage">
  60. <div id="SRIndex">
  61. <div id="SRResults"></div>
  62. <div class="SRStatus" id="Loading">Loading...</div>
  63. <div class="SRStatus" id="Searching">Searching...</div>
  64. <div class="SRStatus" id="NoMatches">No Matches</div>
  65. </div>
  66. </div>
  67. </div>
  68. </div>
  69. </div><!-- top -->
  70. <div class="header">
  71. <div class="summary">
  72. <a href="#pub-types">Public Types</a> &#124;
  73. <a href="#pub-attribs">Public Attributes</a> &#124;
  74. <a href="struct_console_log_entry-members.html">List of all members</a> </div>
  75. <div class="headertitle"><div class="title">ConsoleLogEntry Struct Reference</div></div>
  76. </div><!--header-->
  77. <div class="contents">
  78. <p>Represents an entry in the log.
  79. <a href="struct_console_log_entry.html#details">More...</a></p>
  80. <p><code>#include &lt;console.h&gt;</code></p>
  81. <table class="memberdecls">
  82. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-types" name="pub-types"></a>
  83. Public Types</h2></td></tr>
  84. <tr class="memitem:a221b779e6bb7b8d40677d7642bfefac5" id="r_a221b779e6bb7b8d40677d7642bfefac5"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_console_log_entry.html#a221b779e6bb7b8d40677d7642bfefac5">Level</a> { <a class="el" href="struct_console_log_entry.html#a221b779e6bb7b8d40677d7642bfefac5a5ecbcf0afce98b042f35ec71ba03fa4b">Normal</a> = 0
  85. , <a class="el" href="struct_console_log_entry.html#a221b779e6bb7b8d40677d7642bfefac5a48f2bb70fceb692a2dedd8cea496c44b">Warning</a>
  86. , <a class="el" href="struct_console_log_entry.html#a221b779e6bb7b8d40677d7642bfefac5a4dfd42ec49d09d8c6555c218301cc30f">Error</a>
  87. , <a class="el" href="struct_console_log_entry.html#a221b779e6bb7b8d40677d7642bfefac5aa2bed2ac9a354fa43a1a5faba3514041">NUM_CLASS</a>
  88. }</td></tr>
  89. <tr class="separator:a221b779e6bb7b8d40677d7642bfefac5"><td class="memSeparator" colspan="2">&#160;</td></tr>
  90. <tr class="memitem:a1d1cfd8ffb84e947f82999c682b666a7" id="r_a1d1cfd8ffb84e947f82999c682b666a7"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_console_log_entry.html#a1d1cfd8ffb84e947f82999c682b666a7">Type</a> { <br />
  91. &#160;&#160;<a class="el" href="struct_console_log_entry.html#a1d1cfd8ffb84e947f82999c682b666a7aa7889cca9fe9bf8ce79bc8188b5171d4">General</a> = 0
  92. , <a class="el" href="struct_console_log_entry.html#a1d1cfd8ffb84e947f82999c682b666a7a22a0d96e3c0f9b98fb568c695fa25f97">Assert</a>
  93. , <a class="el" href="struct_console_log_entry.html#a1d1cfd8ffb84e947f82999c682b666a7a66280b4663cd505335c6dcfed94e5729">Script</a>
  94. , <a class="el" href="struct_console_log_entry.html#a1d1cfd8ffb84e947f82999c682b666a7a73c6901c7c648a6a735770bc038bb26a">GUI</a>
  95. , <br />
  96. &#160;&#160;<a class="el" href="struct_console_log_entry.html#a1d1cfd8ffb84e947f82999c682b666a7a80537b922c8f6fc87c728e968f548334">Network</a>
  97. , <a class="el" href="struct_console_log_entry.html#a1d1cfd8ffb84e947f82999c682b666a7a596e9592fd80cd27b3635c81ad8054a7">NUM_TYPE</a>
  98. <br />
  99. }</td></tr>
  100. <tr class="separator:a1d1cfd8ffb84e947f82999c682b666a7"><td class="memSeparator" colspan="2">&#160;</td></tr>
  101. </table><table class="memberdecls">
  102. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-attribs" name="pub-attribs"></a>
  103. Public Attributes</h2></td></tr>
  104. <tr class="memitem:a65304270325b15ad9bdfc1a25ce372e0" id="r_a65304270325b15ad9bdfc1a25ce372e0"><td class="memItemLeft" align="right" valign="top">enum <a class="el" href="struct_console_log_entry.html#a221b779e6bb7b8d40677d7642bfefac5">ConsoleLogEntry::Level</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_console_log_entry.html#a65304270325b15ad9bdfc1a25ce372e0">mLevel</a></td></tr>
  105. <tr class="separator:a65304270325b15ad9bdfc1a25ce372e0"><td class="memSeparator" colspan="2">&#160;</td></tr>
  106. <tr class="memitem:ab8ca3b1249c51de3c8f8bdd5caaba74e" id="r_ab8ca3b1249c51de3c8f8bdd5caaba74e"><td class="memItemLeft" align="right" valign="top">enum <a class="el" href="struct_console_log_entry.html#a1d1cfd8ffb84e947f82999c682b666a7">ConsoleLogEntry::Type</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_console_log_entry.html#ab8ca3b1249c51de3c8f8bdd5caaba74e">mType</a></td></tr>
  107. <tr class="separator:ab8ca3b1249c51de3c8f8bdd5caaba74e"><td class="memSeparator" colspan="2">&#160;</td></tr>
  108. <tr class="memitem:adaee102c1d3a7702c12194d492afbb32" id="r_adaee102c1d3a7702c12194d492afbb32"><td class="memItemLeft" align="right" valign="top">const char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_console_log_entry.html#adaee102c1d3a7702c12194d492afbb32">mString</a></td></tr>
  109. <tr class="separator:adaee102c1d3a7702c12194d492afbb32"><td class="memSeparator" colspan="2">&#160;</td></tr>
  110. </table>
  111. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  112. <div class="textblock"><p>Represents an entry in the log. </p>
  113. </div><h2 class="groupheader">Member Enumeration Documentation</h2>
  114. <a id="a221b779e6bb7b8d40677d7642bfefac5" name="a221b779e6bb7b8d40677d7642bfefac5"></a>
  115. <h2 class="memtitle"><span class="permalink"><a href="#a221b779e6bb7b8d40677d7642bfefac5">&#9670;&#160;</a></span>Level</h2>
  116. <div class="memitem">
  117. <div class="memproto">
  118. <table class="memname">
  119. <tr>
  120. <td class="memname">enum <a class="el" href="struct_console_log_entry.html#a221b779e6bb7b8d40677d7642bfefac5">Level</a></td>
  121. </tr>
  122. </table>
  123. </div><div class="memdoc">
  124. <p>This field indicates the severity of the log entry.</p>
  125. <p>Log entries are filtered and displayed differently based on their severity. Errors are highlighted red, while normal entries are displayed as normal text. Often times, the engine will be configured to hide all log entries except warnings or errors, or to perform a special notification when it encounters an error. </p>
  126. <table class="fieldtable">
  127. <tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="a221b779e6bb7b8d40677d7642bfefac5a5ecbcf0afce98b042f35ec71ba03fa4b" name="a221b779e6bb7b8d40677d7642bfefac5a5ecbcf0afce98b042f35ec71ba03fa4b"></a>Normal&#160;</td><td class="fielddoc"></td></tr>
  128. <tr><td class="fieldname"><a id="a221b779e6bb7b8d40677d7642bfefac5a48f2bb70fceb692a2dedd8cea496c44b" name="a221b779e6bb7b8d40677d7642bfefac5a48f2bb70fceb692a2dedd8cea496c44b"></a>Warning&#160;</td><td class="fielddoc"></td></tr>
  129. <tr><td class="fieldname"><a id="a221b779e6bb7b8d40677d7642bfefac5a4dfd42ec49d09d8c6555c218301cc30f" name="a221b779e6bb7b8d40677d7642bfefac5a4dfd42ec49d09d8c6555c218301cc30f"></a>Error&#160;</td><td class="fielddoc"></td></tr>
  130. <tr><td class="fieldname"><a id="a221b779e6bb7b8d40677d7642bfefac5aa2bed2ac9a354fa43a1a5faba3514041" name="a221b779e6bb7b8d40677d7642bfefac5aa2bed2ac9a354fa43a1a5faba3514041"></a>NUM_CLASS&#160;</td><td class="fielddoc"></td></tr>
  131. </table>
  132. </div>
  133. </div>
  134. <a id="a1d1cfd8ffb84e947f82999c682b666a7" name="a1d1cfd8ffb84e947f82999c682b666a7"></a>
  135. <h2 class="memtitle"><span class="permalink"><a href="#a1d1cfd8ffb84e947f82999c682b666a7">&#9670;&#160;</a></span>Type</h2>
  136. <div class="memitem">
  137. <div class="memproto">
  138. <table class="memname">
  139. <tr>
  140. <td class="memname">enum <a class="el" href="struct_console_log_entry.html#a1d1cfd8ffb84e947f82999c682b666a7">Type</a></td>
  141. </tr>
  142. </table>
  143. </div><div class="memdoc">
  144. <p>Used to associate a log entry with a module.</p>
  145. <p>Log entries can come from different sources; for instance, the scripting engine, or the network code. This allows the logging system to be aware of where different log entries originated from. </p>
  146. <table class="fieldtable">
  147. <tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="a1d1cfd8ffb84e947f82999c682b666a7aa7889cca9fe9bf8ce79bc8188b5171d4" name="a1d1cfd8ffb84e947f82999c682b666a7aa7889cca9fe9bf8ce79bc8188b5171d4"></a>General&#160;</td><td class="fielddoc"></td></tr>
  148. <tr><td class="fieldname"><a id="a1d1cfd8ffb84e947f82999c682b666a7a22a0d96e3c0f9b98fb568c695fa25f97" name="a1d1cfd8ffb84e947f82999c682b666a7a22a0d96e3c0f9b98fb568c695fa25f97"></a>Assert&#160;</td><td class="fielddoc"></td></tr>
  149. <tr><td class="fieldname"><a id="a1d1cfd8ffb84e947f82999c682b666a7a66280b4663cd505335c6dcfed94e5729" name="a1d1cfd8ffb84e947f82999c682b666a7a66280b4663cd505335c6dcfed94e5729"></a>Script&#160;</td><td class="fielddoc"></td></tr>
  150. <tr><td class="fieldname"><a id="a1d1cfd8ffb84e947f82999c682b666a7a73c6901c7c648a6a735770bc038bb26a" name="a1d1cfd8ffb84e947f82999c682b666a7a73c6901c7c648a6a735770bc038bb26a"></a>GUI&#160;</td><td class="fielddoc"></td></tr>
  151. <tr><td class="fieldname"><a id="a1d1cfd8ffb84e947f82999c682b666a7a80537b922c8f6fc87c728e968f548334" name="a1d1cfd8ffb84e947f82999c682b666a7a80537b922c8f6fc87c728e968f548334"></a>Network&#160;</td><td class="fielddoc"></td></tr>
  152. <tr><td class="fieldname"><a id="a1d1cfd8ffb84e947f82999c682b666a7a596e9592fd80cd27b3635c81ad8054a7" name="a1d1cfd8ffb84e947f82999c682b666a7a596e9592fd80cd27b3635c81ad8054a7"></a>NUM_TYPE&#160;</td><td class="fielddoc"></td></tr>
  153. </table>
  154. </div>
  155. </div>
  156. <h2 class="groupheader">Member Data Documentation</h2>
  157. <a id="a65304270325b15ad9bdfc1a25ce372e0" name="a65304270325b15ad9bdfc1a25ce372e0"></a>
  158. <h2 class="memtitle"><span class="permalink"><a href="#a65304270325b15ad9bdfc1a25ce372e0">&#9670;&#160;</a></span>mLevel</h2>
  159. <div class="memitem">
  160. <div class="memproto">
  161. <table class="memname">
  162. <tr>
  163. <td class="memname">enum <a class="el" href="struct_console_log_entry.html#a221b779e6bb7b8d40677d7642bfefac5">ConsoleLogEntry::Level</a> mLevel</td>
  164. </tr>
  165. </table>
  166. </div><div class="memdoc">
  167. </div>
  168. </div>
  169. <a id="adaee102c1d3a7702c12194d492afbb32" name="adaee102c1d3a7702c12194d492afbb32"></a>
  170. <h2 class="memtitle"><span class="permalink"><a href="#adaee102c1d3a7702c12194d492afbb32">&#9670;&#160;</a></span>mString</h2>
  171. <div class="memitem">
  172. <div class="memproto">
  173. <table class="memname">
  174. <tr>
  175. <td class="memname">const char* mString</td>
  176. </tr>
  177. </table>
  178. </div><div class="memdoc">
  179. <p>Indicates the actual log entry.</p>
  180. <p>This contains a description of the event being logged. For instance, "unable to access file", or "player connected
  181. successfully", or nearly anything else you might imagine.</p>
  182. <p>Typically, the description should contain a concise, descriptive string describing whatever is being logged. Whenever possible, include useful details like the name of the file being accessed, or the id of the player or <a class="el" href="class_gui_control.html">GuiControl</a>, so that if a log needs to be used to locate a bug, it can be done as painlessly as possible. </p>
  183. </div>
  184. </div>
  185. <a id="ab8ca3b1249c51de3c8f8bdd5caaba74e" name="ab8ca3b1249c51de3c8f8bdd5caaba74e"></a>
  186. <h2 class="memtitle"><span class="permalink"><a href="#ab8ca3b1249c51de3c8f8bdd5caaba74e">&#9670;&#160;</a></span>mType</h2>
  187. <div class="memitem">
  188. <div class="memproto">
  189. <table class="memname">
  190. <tr>
  191. <td class="memname">enum <a class="el" href="struct_console_log_entry.html#a1d1cfd8ffb84e947f82999c682b666a7">ConsoleLogEntry::Type</a> mType</td>
  192. </tr>
  193. </table>
  194. </div><div class="memdoc">
  195. </div>
  196. </div>
  197. <hr/>The documentation for this struct was generated from the following file:<ul>
  198. <li>console/<b>console.h</b></li>
  199. </ul>
  200. </div><!-- contents -->
  201. <!-- start footer part -->
  202. <hr class="footer"/><address class="footer"><small>
  203. 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
  204. </small></address>
  205. </body>
  206. </html>