TorqueEngine
/
Torque2D
зеркало из https://github.com/TorqueGameEngines/Torque2D.git


			
				
					
						
						
							123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197
							<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.9.8"/>
<meta name="viewport" content="width=device-width, initial-scale=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 id="projectrow">
  <td id="projectalign">
   <div id="projectname">TorqueScript Reference
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.8 -->
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() {
  initMenu('',false,false,'search.php','Search');
});
/* @license-end */
</script>
<div id="main-nav"></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 id="func-members" name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:gadc3e177fa67f62c263412544518541ec" id="r_gadc3e177fa67f62c263412544518541ec"><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__PlatformFunctions.html#gadc3e177fa67f62c263412544518541ec">createUUID</a> ()</td></tr>
<tr class="separator:gadc3e177fa67f62c263412544518541ec"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga42c8de0ef4b366fdbb17d7fcfec22c24" id="r_ga42c8de0ef4b366fdbb17d7fcfec22c24"><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__PlatformFunctions.html#ga42c8de0ef4b366fdbb17d7fcfec22c24">getClipboard</a> ()</td></tr>
<tr class="separator:ga42c8de0ef4b366fdbb17d7fcfec22c24"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga2f31611af0ac77b1fc75105723029240" id="r_ga2f31611af0ac77b1fc75105723029240"><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__PlatformFunctions.html#ga2f31611af0ac77b1fc75105723029240">getLocalTime</a> ()</td></tr>
<tr class="separator:ga2f31611af0ac77b1fc75105723029240"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gac1309f3a6aa01dddaf0f3fc69341b6ba" id="r_gac1309f3a6aa01dddaf0f3fc69341b6ba"><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__PlatformFunctions.html#gac1309f3a6aa01dddaf0f3fc69341b6ba">getRealTime</a> ()</td></tr>
<tr class="separator:gac1309f3a6aa01dddaf0f3fc69341b6ba"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga99a3148a9940bec5d6ab559b42d757e3" id="r_ga99a3148a9940bec5d6ab559b42d757e3"><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__PlatformFunctions.html#ga99a3148a9940bec5d6ab559b42d757e3">setClipboard</a> (string)</td></tr>
<tr class="separator:ga99a3148a9940bec5d6ab559b42d757e3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga58cf944aee93660ca1c75f4eafb96c86" id="r_ga58cf944aee93660ca1c75f4eafb96c86"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__MetaScriptingFunctions.html#ga3428b441d74b14a5aed2f08490b4b9f3">void</a>&#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 id="gadc3e177fa67f62c263412544518541ec" name="gadc3e177fa67f62c263412544518541ec"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gadc3e177fa67f62c263412544518541ec">&#9670;&#160;</a></span>createUUID()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a> createUUID </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Creates a UUID string. </p>

</div>
</div>
<a id="ga42c8de0ef4b366fdbb17d7fcfec22c24" name="ga42c8de0ef4b366fdbb17d7fcfec22c24"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga42c8de0ef4b366fdbb17d7fcfec22c24">&#9670;&#160;</a></span>getClipboard()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a> 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#ga99a3148a9940bec5d6ab559b42d757e3">setClipboard</a> </dd></dl>

</div>
</div>
<a id="ga2f31611af0ac77b1fc75105723029240" name="ga2f31611af0ac77b1fc75105723029240"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga2f31611af0ac77b1fc75105723029240">&#9670;&#160;</a></span>getLocalTime()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a> 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 id="gac1309f3a6aa01dddaf0f3fc69341b6ba" name="gac1309f3a6aa01dddaf0f3fc69341b6ba"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gac1309f3a6aa01dddaf0f3fc69341b6ba">&#9670;&#160;</a></span>getRealTime()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#ga85be84504cf913ad90b8ee4f264195d3">Integer</a> 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#ga28987bb6b28966266b0cc82744b195ee">getSimTime</a> </dd></dl>

</div>
</div>
<a id="ga99a3148a9940bec5d6ab559b42d757e3" name="ga99a3148a9940bec5d6ab559b42d757e3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga99a3148a9940bec5d6ab559b42d757e3">&#9670;&#160;</a></span>setClipboard()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#ga2b43030c97cd77d3fe3fc96fd39aa246">Boolean</a> 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 id="ga58cf944aee93660ca1c75f4eafb96c86" name="ga58cf944aee93660ca1c75f4eafb96c86"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga58cf944aee93660ca1c75f4eafb96c86">&#9670;&#160;</a></span>setMouseLock()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="group__MetaScriptingFunctions.html#ga3428b441d74b14a5aed2f08490b4b9f3">void</a> 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="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.8
</small></address>
</body>
</html>