TorqueEngine
/
Torque2D
oglindă de https://github.com/TorqueGameEngines/Torque2D.git


			
				
					
						
						
							123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225
							<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.3.1"/>
<title>TorqueScript Reference: Build Info</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="t2d-stylesheet-extra.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td style="padding-left: 0.5em;">
   <div id="projectname">TorqueScript Reference
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.3.1 -->
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Main&#160;Page</span></a></li>
      <li><a href="pages.html"><span>Related&#160;Pages</span></a></li>
      <li><a href="modules.html"><span>Modules</span></a></li>
      <li><a href="annotated.html"><span>Classes</span></a></li>
    </ul>
  </div>
</div><!-- top -->
<div class="header">
  <div class="summary">
<a href="#func-members">Functions</a>  </div>
  <div class="headertitle">
<div class="title">Build Info<div class="ingroups"><a class="el" href="group__TorqueScriptFunctions.html">Function Categories</a></div></div>  </div>
</div><!--header-->
<div class="contents">
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:ga5f7ea90fde66a93b8cc3d722b7ceeeb7"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__BuildInfoFunctions.html#ga5f7ea90fde66a93b8cc3d722b7ceeeb7">getBuildString</a> ()</td></tr>
<tr class="separator:ga5f7ea90fde66a93b8cc3d722b7ceeeb7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gab00dfc3fac9eaefcaf23e04a635026e0"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__BuildInfoFunctions.html#gab00dfc3fac9eaefcaf23e04a635026e0">getCompileTimeString</a> ()</td></tr>
<tr class="separator:gab00dfc3fac9eaefcaf23e04a635026e0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gacc14182b993734c2bd49b8243d3d0be9"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__BuildInfoFunctions.html#gacc14182b993734c2bd49b8243d3d0be9">getEngineVersion</a> ()</td></tr>
<tr class="separator:gacc14182b993734c2bd49b8243d3d0be9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaf9a33b02b002e70eea87d6eca268a82c"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__BuildInfoFunctions.html#gaf9a33b02b002e70eea87d6eca268a82c">getiPhoneToolsVersion</a> ()</td></tr>
<tr class="separator:gaf9a33b02b002e70eea87d6eca268a82c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga035c6d4d21cf8ff538eeb96ce3617673"><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__BuildInfoFunctions.html#ga035c6d4d21cf8ff538eeb96ce3617673">getVersionNumber</a> ()</td></tr>
<tr class="separator:ga035c6d4d21cf8ff538eeb96ce3617673"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga69d8c128d5ba9fb23f5a4aba04dd9cf0"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__BuildInfoFunctions.html#ga69d8c128d5ba9fb23f5a4aba04dd9cf0">getVersionString</a> ()</td></tr>
<tr class="separator:ga69d8c128d5ba9fb23f5a4aba04dd9cf0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga07b6a791039fa5bd97140135ecb9cf5e"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#ga2b43030c97cd77d3fe3fc96fd39aa246">Boolean</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__BuildInfoFunctions.html#ga07b6a791039fa5bd97140135ecb9cf5e">isDebugBuild</a> ()</td></tr>
<tr class="separator:ga07b6a791039fa5bd97140135ecb9cf5e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga85e5ff974863bd1ea59c5e3e21aaa903"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__BuildInfoFunctions.html#ga85e5ff974863bd1ea59c5e3e21aaa903">setCompanyAndProduct</a> (company, product)</td></tr>
<tr class="separator:ga85e5ff974863bd1ea59c5e3e21aaa903"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<h2 class="groupheader">Function Documentation</h2>
<a class="anchor" id="ga5f7ea90fde66a93b8cc3d722b7ceeeb7"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a> getBuildString </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Use the getBuildString function to determine if this build is a \ release, or a \ build. </p>
<dl class="section return"><dt>Returns</dt><dd>Returns a string, either \ for a debug build, or \ for a release build. </dd></dl>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="group__BuildInfoFunctions.html#gab00dfc3fac9eaefcaf23e04a635026e0">getCompileTimeString</a>, <a class="el" href="group__BuildInfoFunctions.html#ga035c6d4d21cf8ff538eeb96ce3617673">getVersionNumber</a>, <a class="el" href="group__BuildInfoFunctions.html#ga69d8c128d5ba9fb23f5a4aba04dd9cf0">getVersionString</a>, <a class="el" href="group__BuildInfoFunctions.html#ga07b6a791039fa5bd97140135ecb9cf5e">isDebugBuild</a> </dd></dl>

</div>
</div>
<a class="anchor" id="gab00dfc3fac9eaefcaf23e04a635026e0"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a> getCompileTimeString </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Use the getCompileTimeString function to determine when the currently running engine was built. </p>
<dl class="section return"><dt>Returns</dt><dd>Returns a string containing  Day Year at Hour:Minute:Second\ showing when this executable was built. </dd></dl>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="group__BuildInfoFunctions.html#ga5f7ea90fde66a93b8cc3d722b7ceeeb7">getBuildString</a>, <a class="el" href="group__BuildInfoFunctions.html#ga035c6d4d21cf8ff538eeb96ce3617673">getVersionNumber</a>, <a class="el" href="group__BuildInfoFunctions.html#ga69d8c128d5ba9fb23f5a4aba04dd9cf0">getVersionString</a>, <a class="el" href="group__BuildInfoFunctions.html#ga07b6a791039fa5bd97140135ecb9cf5e">isDebugBuild</a> </dd></dl>

</div>
</div>
<a class="anchor" id="gacc14182b993734c2bd49b8243d3d0be9"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a> getEngineVersion </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Gets the engine version. </p>

</div>
</div>
<a class="anchor" id="gaf9a33b02b002e70eea87d6eca268a82c"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a> getiPhoneToolsVersion </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Returns iPhone Tools Version </p>

</div>
</div>
<a class="anchor" id="ga035c6d4d21cf8ff538eeb96ce3617673"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#ga85be84504cf913ad90b8ee4f264195d3">Integer</a> getVersionNumber </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Use the getVersionNumber function to get the version number of the currently executing engine. </p>
<dl class="section return"><dt>Returns</dt><dd>Returns an integer representing the engine's version number. </dd></dl>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="group__BuildInfoFunctions.html#ga5f7ea90fde66a93b8cc3d722b7ceeeb7">getBuildString</a>, <a class="el" href="group__BuildInfoFunctions.html#gab00dfc3fac9eaefcaf23e04a635026e0">getCompileTimeString</a>, <a class="el" href="group__BuildInfoFunctions.html#ga69d8c128d5ba9fb23f5a4aba04dd9cf0">getVersionString</a>, <a class="el" href="group__BuildInfoFunctions.html#ga07b6a791039fa5bd97140135ecb9cf5e">isDebugBuild</a> </dd></dl>

</div>
</div>
<a class="anchor" id="ga69d8c128d5ba9fb23f5a4aba04dd9cf0"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a> getVersionString </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Use the getVersionString function to get the version name and number for the currently executing engine. </p>
<dl class="section return"><dt>Returns</dt><dd>Returns a string containing a name and an integer representing the engine's version type and version number. </dd></dl>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="group__BuildInfoFunctions.html#ga5f7ea90fde66a93b8cc3d722b7ceeeb7">getBuildString</a>, <a class="el" href="group__BuildInfoFunctions.html#gab00dfc3fac9eaefcaf23e04a635026e0">getCompileTimeString</a>, <a class="el" href="group__BuildInfoFunctions.html#ga035c6d4d21cf8ff538eeb96ce3617673">getVersionNumber</a>, <a class="el" href="group__BuildInfoFunctions.html#ga07b6a791039fa5bd97140135ecb9cf5e">isDebugBuild</a> </dd></dl>

</div>
</div>
<a class="anchor" id="ga07b6a791039fa5bd97140135ecb9cf5e"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#ga2b43030c97cd77d3fe3fc96fd39aa246">Boolean</a> isDebugBuild </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Use the isDebugBuild function to determine if this is a debug build. </p>
<dl class="section return"><dt>Returns</dt><dd>Returns true if this is a debug build, otherwise false. </dd></dl>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="group__BuildInfoFunctions.html#ga5f7ea90fde66a93b8cc3d722b7ceeeb7">getBuildString</a>, <a class="el" href="group__BuildInfoFunctions.html#gab00dfc3fac9eaefcaf23e04a635026e0">getCompileTimeString</a>, <a class="el" href="group__BuildInfoFunctions.html#ga035c6d4d21cf8ff538eeb96ce3617673">getVersionNumber</a>, <a class="el" href="group__BuildInfoFunctions.html#ga69d8c128d5ba9fb23f5a4aba04dd9cf0">getVersionString</a> </dd></dl>

</div>
</div>
<a class="anchor" id="ga85e5ff974863bd1ea59c5e3e21aaa903"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void setCompanyAndProduct </td>
          <td>(</td>
          <td class="paramtype">company&#160;</td>
          <td class="paramname">, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">product&#160;</td>
          <td class="paramname">&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Sets the company and product information. </p>

</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.3.1
</small></address>
</body>
</html>