group__constructionOperators.html 5.7 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110
  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: Construction Operators</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="#typedef-members">Typedefs</a> </div>
  45. <div class="headertitle"><div class="title">Construction Operators<div class="ingroups"><a class="el" href="group__Operators.html">Operators</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="typedef-members" name="typedef-members"></a>
  50. Typedefs</h2></td></tr>
  51. <tr class="memitem:ga70a14b869c34d264188d162a1ffda28e" id="r_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>
  52. <tr class="separator:ga70a14b869c34d264188d162a1ffda28e"><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">Typedef Documentation</h2>
  56. <a id="ga70a14b869c34d264188d162a1ffda28e" name="ga70a14b869c34d264188d162a1ffda28e"></a>
  57. <h2 class="memtitle"><span class="permalink"><a href="#ga70a14b869c34d264188d162a1ffda28e">&#9670;&#160;</a></span>new</h2>
  58. <div class="memitem">
  59. <div class="memproto">
  60. <table class="memname">
  61. <tr>
  62. <td class="memname">typedef type <a class="el" href="group__constructionOperators.html#ga70a14b869c34d264188d162a1ffda28e">new</a></td>
  63. </tr>
  64. </table>
  65. </div><div class="memdoc">
  66. <p>create a new object</p>
  67. <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>
  68. <div class="line">{</div>
  69. <div class="line"> [field = value;]</div>
  70. <div class="line"> ...</div>
  71. <div class="line">};</div>
  72. </div><!-- fragment --></dd></dl>
  73. <dl class="section user"><dt>Where</dt><dd><ul>
  74. <li><em>myID</em> is the return ID that can be used to access the object in the form <code>%myID.myFunction</code>.<br />
  75. </li>
  76. <li><code>new</code> is the keyword telling the engine to create an instance of the following <em>class</em>.<br />
  77. </li>
  78. <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 />
  79. </li>
  80. <li><em>name</em> (optional) is the object's name for referencing in the form <code>name.myFunction</code> (without % or $ before it).<br />
  81. </li>
  82. <li><em>field</em> - You may initialize static or dynamic class fields here, one at a time.<br />
  83. </li>
  84. </ul>
  85. </dd></dl>
  86. <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>
  87. <div class="line"><span class="comment">// with two static fields and one dynamic field to define</span></div>
  88. <div class="line"><span class="keyword">new</span> <a class="code hl_class" href="classSceneObject.html">SceneObject</a>(Truck) </div>
  89. <div class="line">{</div>
  90. <div class="line"> position = <span class="stringliteral">&quot;0 0&quot;</span>;</div>
  91. <div class="line"> size = <span class="stringliteral">&quot;5 5&quot;</span>;</div>
  92. <div class="line"> myField = 100;</div>
  93. <div class="line">};</div>
  94. <div class="line"> </div>
  95. <div class="line"><span class="comment">// A nameless object (tracked by a variable), with no fields to set</span></div>
  96. <div class="line">%myObject = <span class="keyword">new</span> <a class="code hl_class" href="classSimSet.html">SimSet</a>();</div>
  97. <div class="ttc" id="aclassSceneObject_html"><div class="ttname"><a href="classSceneObject.html">SceneObject</a></div><div class="ttdef"><b>Definition</b> SceneObject_ScriptBinding.h:36</div></div>
  98. <div class="ttc" id="aclassSimSet_html"><div class="ttname"><a href="classSimSet.html">SimSet</a></div><div class="ttdef"><b>Definition</b> simSet_ScriptBinding.h:192</div></div>
  99. </div><!-- fragment --> </dd></dl>
  100. </div>
  101. </div>
  102. </div><!-- contents -->
  103. <!-- start footer part -->
  104. <hr class="footer"/><address class="footer"><small>
  105. 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
  106. </small></address>
  107. </body>
  108. </html>