group__SerializeFunctions.html 5.8 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125
  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: Serialization</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">Serialization<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:gabab787e3e046cba2a836cbf83ec6472b"><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__SerializeFunctions.html#gabab787e3e046cba2a836cbf83ec6472b">loadObject</a> (filename)</td></tr>
  50. <tr class="separator:gabab787e3e046cba2a836cbf83ec6472b"><td class="memSeparator" colspan="2">&#160;</td></tr>
  51. <tr class="memitem:gaaa4e60a69db8291bbebec7ff3c85d57c"><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__SerializeFunctions.html#gaaa4e60a69db8291bbebec7ff3c85d57c">saveObject</a> (object, filename)</td></tr>
  52. <tr class="separator:gaaa4e60a69db8291bbebec7ff3c85d57c"><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">Function Documentation</h2>
  56. <a class="anchor" id="gabab787e3e046cba2a836cbf83ec6472b"></a>
  57. <div class="memitem">
  58. <div class="memproto">
  59. <table class="memname">
  60. <tr>
  61. <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#ga85be84504cf913ad90b8ee4f264195d3">Integer</a> loadObject </td>
  62. <td>(</td>
  63. <td class="paramtype">filename&#160;</td>
  64. <td class="paramname"></td><td>)</td>
  65. <td></td>
  66. </tr>
  67. </table>
  68. </div><div class="memdoc">
  69. <p>Loads an object from the specified filename </p>
  70. <dl class="params"><dt>Parameters</dt><dd>
  71. <table class="params">
  72. <tr><td class="paramname">filename</td><td>The name of the file to load the object from </td></tr>
  73. </table>
  74. </dd>
  75. </dl>
  76. <dl class="section return"><dt>Returns</dt><dd>Returns the ID of the object on success, or 0 on failure.</dd></dl>
  77. <dl class="section see"><dt>See Also</dt><dd><a class="el" href="classFileObject.html#a2b2d3fbeea8517d038208d362cb6b378">FileObject::writeObject</a>, <a class="el" href="classSimObject.html#ad4944a7132f9ee90f801f4cd57014836">SimObject::save</a> </dd></dl>
  78. </div>
  79. </div>
  80. <a class="anchor" id="gaaa4e60a69db8291bbebec7ff3c85d57c"></a>
  81. <div class="memitem">
  82. <div class="memproto">
  83. <table class="memname">
  84. <tr>
  85. <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#ga2b43030c97cd77d3fe3fc96fd39aa246">Boolean</a> saveObject </td>
  86. <td>(</td>
  87. <td class="paramtype">object&#160;</td>
  88. <td class="paramname">, </td>
  89. </tr>
  90. <tr>
  91. <td class="paramkey"></td>
  92. <td></td>
  93. <td class="paramtype">filename&#160;</td>
  94. <td class="paramname">&#160;</td>
  95. </tr>
  96. <tr>
  97. <td></td>
  98. <td>)</td>
  99. <td></td><td></td>
  100. </tr>
  101. </table>
  102. </div><div class="memdoc">
  103. <p>Saves the given object to the given filename </p>
  104. <dl class="params"><dt>Parameters</dt><dd>
  105. <table class="params">
  106. <tr><td class="paramname">object</td><td>The <a class="el" href="classSimObject.html">SimObject</a> to save </td></tr>
  107. <tr><td class="paramname">filename</td><td>The name of the file in which to save the object </td></tr>
  108. </table>
  109. </dd>
  110. </dl>
  111. <dl class="section return"><dt>Returns</dt><dd>Returns true on success and flase on failure</dd></dl>
  112. <dl class="section see"><dt>See Also</dt><dd><a class="el" href="classFileObject.html#a2b2d3fbeea8517d038208d362cb6b378">FileObject::writeObject</a>, <a class="el" href="classSimObject.html#ad4944a7132f9ee90f801f4cd57014836">SimObject::save</a> </dd></dl>
  113. </div>
  114. </div>
  115. </div><!-- contents -->
  116. <!-- start footer part -->
  117. <hr class="footer"/><address class="footer"><small>
  118. Generated by &#160;<a href="http://www.doxygen.org/index.html">
  119. <img class="footer" src="doxygen.png" alt="doxygen"/>
  120. </a> 1.8.3.1
  121. </small></address>
  122. </body>
  123. </html>