group__constructionOperators.html 5.0 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106
  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: Construction Operators</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="#typedef-members">Typedefs</a> </div>
  42. <div class="headertitle">
  43. <div class="title">Construction Operators<div class="ingroups"><a class="el" href="group__Operators.html">Operators</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="typedef-members"></a>
  48. Typedefs</h2></td></tr>
  49. <tr class="memitem:ga70a14b869c34d264188d162a1ffda28e"><td class="memItemLeft" align="right" valign="top">typedef type&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__constructionOperators.html#ga70a14b869c34d264188d162a1ffda28e">new</a></td></tr>
  50. <tr class="separator:ga70a14b869c34d264188d162a1ffda28e"><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">Typedef Documentation</h2>
  54. <a class="anchor" id="ga70a14b869c34d264188d162a1ffda28e"></a>
  55. <div class="memitem">
  56. <div class="memproto">
  57. <table class="memname">
  58. <tr>
  59. <td class="memname">typedef type <a class="el" href="group__constructionOperators.html#ga70a14b869c34d264188d162a1ffda28e">new</a></td>
  60. </tr>
  61. </table>
  62. </div><div class="memdoc">
  63. <p>create a new object</p>
  64. <dl class="section user"><dt>Format</dt><dd><div class="fragment"><div class="line">%myID = <span class="keyword">new</span> <span class="keyword">class</span>([name])</div>
  65. <div class="line">{</div>
  66. <div class="line"> [field = value;]</div>
  67. <div class="line"> ...</div>
  68. <div class="line">};</div>
  69. </div><!-- fragment --></dd></dl>
  70. <dl class="section user"><dt>Where</dt><dd><ul>
  71. <li><em>myID</em> is the return ID that can be used to access the object in the form <code>%myID.myFunction</code>.<br/>
  72. </li>
  73. <li><code>new</code> is the keyword telling the engine to create an instance of the following <em>class</em>.<br/>
  74. </li>
  75. <li><em>class</em> is any class declared in the engine or in script that has been derived from <a class="el" href="classSimObject.html">SimObject</a>.<br/>
  76. </li>
  77. <li><em>name</em> (optional) is the object's name for referencing in the form <code>name.myFunction</code> (without % or $ before it).<br/>
  78. </li>
  79. <li><em>field</em> - You may initialize static or dynamic class fields here, one at a time.<br/>
  80. </li>
  81. </ul>
  82. </dd></dl>
  83. <dl class="section user"><dt>Example</dt><dd><div class="fragment"><div class="line"><span class="comment">// An SceneObject named &#39;Truck&#39;</span></div>
  84. <div class="line"><span class="comment">// with two static fields and one dynamic field to define</span></div>
  85. <div class="line"><span class="keyword">new</span> <a class="code" href="classSceneObject.html">SceneObject</a>(Truck) </div>
  86. <div class="line">{</div>
  87. <div class="line"> position = <span class="stringliteral">&quot;0 0&quot;</span>;</div>
  88. <div class="line"> size = <span class="stringliteral">&quot;5 5&quot;</span>;</div>
  89. <div class="line"> myField = 100;</div>
  90. <div class="line">};</div>
  91. <div class="line"></div>
  92. <div class="line"><span class="comment">// A nameless object (tracked by a variable), with no fields to set</span></div>
  93. <div class="line">%myObject = <span class="keyword">new</span> <a class="code" href="classSimSet.html">SimSet</a>();</div>
  94. </div><!-- fragment --> </dd></dl>
  95. </div>
  96. </div>
  97. </div><!-- contents -->
  98. <!-- start footer part -->
  99. <hr class="footer"/><address class="footer"><small>
  100. Generated by &#160;<a href="http://www.doxygen.org/index.html">
  101. <img class="footer" src="doxygen.png" alt="doxygen"/>
  102. </a> 1.8.3.1
  103. </small></address>
  104. </body>
  105. </html>