TorqueEngine
/
Torque2D
mirror de https://github.com/TorqueGameEngines/Torque2D.git


			
				
					
						
						
							123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172
							<!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: Platform</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">Platform<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:ga56aaea6fccef411ae5a0a21c090da7b7"><td class="memItemLeft" align="right" valign="top">string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__PlatformFunctions.html#ga56aaea6fccef411ae5a0a21c090da7b7">getClipboard</a> ()</td></tr>
<tr class="separator:ga56aaea6fccef411ae5a0a21c090da7b7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga9143526cf84b04e6d3e159d69d2f82d2"><td class="memItemLeft" align="right" valign="top">string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__PlatformFunctions.html#ga9143526cf84b04e6d3e159d69d2f82d2">getLocalTime</a> ()</td></tr>
<tr class="separator:ga9143526cf84b04e6d3e159d69d2f82d2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga7922bd8b3983a13d7bc2bb3d3a6e646b"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__PlatformFunctions.html#ga7922bd8b3983a13d7bc2bb3d3a6e646b">getRealTime</a> ()</td></tr>
<tr class="separator:ga7922bd8b3983a13d7bc2bb3d3a6e646b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga971f645034affb11967038475fe1ba29"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__PlatformFunctions.html#ga971f645034affb11967038475fe1ba29">setClipboard</a> (string)</td></tr>
<tr class="separator:ga971f645034affb11967038475fe1ba29"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga58cf944aee93660ca1c75f4eafb96c86"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__PlatformFunctions.html#ga58cf944aee93660ca1c75f4eafb96c86">setMouseLock</a> (isLocked)</td></tr>
<tr class="separator:ga58cf944aee93660ca1c75f4eafb96c86"><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="ga56aaea6fccef411ae5a0a21c090da7b7"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">string getClipboard </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Use the getClipboard function to get the contents of the GUI clipboard. </p>
<dl class="section return"><dt>Returns</dt><dd>Returns a string equal to the current contents of the copy the clipboard, or a NULL strain if the copy clipboard is empty. </dd></dl>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="group__PlatformFunctions.html#ga971f645034affb11967038475fe1ba29">setClipboard</a> </dd></dl>

</div>
</div>
<a class="anchor" id="ga9143526cf84b04e6d3e159d69d2f82d2"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">string getLocalTime </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Get the local time </p>
<dl class="section return"><dt>Returns</dt><dd>the local time formatted as: monthday/month/year hour/minute/second </dd></dl>

</div>
</div>
<a class="anchor" id="ga7922bd8b3983a13d7bc2bb3d3a6e646b"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int getRealTime </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Use the getRealTime function to the computer time in milliseconds. </p>
<dl class="section return"><dt>Returns</dt><dd>Returns the current real time in milliseconds. </dd></dl>
<dl class="section see"><dt>See Also</dt><dd><a class="el" href="group__EventScheduleFunctions.html#ga5fd2b156623d78138bcb44167eabab78">getSimTime</a> </dd></dl>

</div>
</div>
<a class="anchor" id="ga971f645034affb11967038475fe1ba29"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">bool setClipboard </td>
          <td>(</td>
          <td class="paramtype">string&#160;</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Use the setClipboard function to Set value on clipboard to string. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">string</td><td>The new value to place in the GUI clipboard. </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Returns true if successful, false otherwise. </dd></dl>
<dl class="section see"><dt>See Also</dt><dd>getClipoard") </dd></dl>

</div>
</div>
<a class="anchor" id="ga58cf944aee93660ca1c75f4eafb96c86"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void setMouseLock </td>
          <td>(</td>
          <td class="paramtype">isLocked&#160;</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Use the setMouseLock function to un/lock the mouse. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">isLocked</td><td>A boolean value. </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>No return value </dd></dl>

</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>