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


			
				
					
						
						
							123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237
							<!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: Path Expando</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">Path Expando<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:ga1672ccca5a3f85f12bcc066dd8fda7f3" id="r_ga1672ccca5a3f85f12bcc066dd8fda7f3"><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__PathExpandoFunctions.html#ga1672ccca5a3f85f12bcc066dd8fda7f3">addPathExpando</a> (string expando, string path)</td></tr>
<tr class="separator:ga1672ccca5a3f85f12bcc066dd8fda7f3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga3dedd9344548db1bdc30d9d59c35991b" id="r_ga3dedd9344548db1bdc30d9d59c35991b"><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__PathExpandoFunctions.html#ga3dedd9344548db1bdc30d9d59c35991b">collapsePath</a> (string path)</td></tr>
<tr class="separator:ga3dedd9344548db1bdc30d9d59c35991b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaec0fb75693c7b7dc9517167bb2135bb2" id="r_gaec0fb75693c7b7dc9517167bb2135bb2"><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__PathExpandoFunctions.html#gaec0fb75693c7b7dc9517167bb2135bb2">expandPath</a> (string path)</td></tr>
<tr class="separator:gaec0fb75693c7b7dc9517167bb2135bb2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga353dfde67494394e6587104b349bfeae" id="r_ga353dfde67494394e6587104b349bfeae"><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__PathExpandoFunctions.html#ga353dfde67494394e6587104b349bfeae">getPathExpandoCount</a> ()</td></tr>
<tr class="separator:ga353dfde67494394e6587104b349bfeae"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaea955968e70b1c73727cdaa3b5346a55" id="r_gaea955968e70b1c73727cdaa3b5346a55"><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__PathExpandoFunctions.html#gaea955968e70b1c73727cdaa3b5346a55">getPathExpandoKey</a> (int expandoIndex)</td></tr>
<tr class="separator:gaea955968e70b1c73727cdaa3b5346a55"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga79372aa6f87a5ccec374557ccebd58ae" id="r_ga79372aa6f87a5ccec374557ccebd58ae"><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__PathExpandoFunctions.html#ga79372aa6f87a5ccec374557ccebd58ae">getPathExpandoValue</a> (int expandoIndex)</td></tr>
<tr class="separator:ga79372aa6f87a5ccec374557ccebd58ae"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga739d722aaf5bf1ee288f0fc177cb62ca" id="r_ga739d722aaf5bf1ee288f0fc177cb62ca"><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__PathExpandoFunctions.html#ga739d722aaf5bf1ee288f0fc177cb62ca">isPathExpando</a> (string expando)</td></tr>
<tr class="separator:ga739d722aaf5bf1ee288f0fc177cb62ca"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gac7514fa863156f369c13fe8533165021" id="r_gac7514fa863156f369c13fe8533165021"><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__PathExpandoFunctions.html#gac7514fa863156f369c13fe8533165021">removePathExpando</a> (string expando)</td></tr>
<tr class="separator:gac7514fa863156f369c13fe8533165021"><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="ga1672ccca5a3f85f12bcc066dd8fda7f3" name="ga1672ccca5a3f85f12bcc066dd8fda7f3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga1672ccca5a3f85f12bcc066dd8fda7f3">&#9670;&#160;</a></span>addPathExpando()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="group__MetaScriptingFunctions.html#ga3428b441d74b14a5aed2f08490b4b9f3">void</a> addPathExpando </td>
          <td>(</td>
          <td class="paramtype">string&#160;</td>
          <td class="paramname"><em>expando</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">string&#160;</td>
          <td class="paramname"><em>path</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Adds the expando to the path. If it already exists then it is replaced. </p>

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

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a> collapsePath </td>
          <td>(</td>
          <td class="paramtype">string&#160;</td>
          <td class="paramname"><em>path</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Collapses a path into either an expando path or a relative path. </p>

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

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a> expandPath </td>
          <td>(</td>
          <td class="paramtype">string&#160;</td>
          <td class="paramname"><em>path</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Expands an expando or relative path into a full path. </p>

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

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#ga85be84504cf913ad90b8ee4f264195d3">Integer</a> getPathExpandoCount </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Gets the expando path count. </p>

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

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a> getPathExpandoKey </td>
          <td>(</td>
          <td class="paramtype">int&#160;</td>
          <td class="paramname"><em>expandoIndex</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Gets the path expando key (the expando name) at the specified index. </p>

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

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a> getPathExpandoValue </td>
          <td>(</td>
          <td class="paramtype">int&#160;</td>
          <td class="paramname"><em>expandoIndex</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Gets the path expando value (the expando path) at the specified index. </p>

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

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#ga2b43030c97cd77d3fe3fc96fd39aa246">Boolean</a> isPathExpando </td>
          <td>(</td>
          <td class="paramtype">string&#160;</td>
          <td class="paramname"><em>expando</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Checks whether the specified path expando is current set or not. </p>

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

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="group__MetaScriptingFunctions.html#ga3428b441d74b14a5aed2f08490b4b9f3">void</a> removePathExpando </td>
          <td>(</td>
          <td class="paramtype">string&#160;</td>
          <td class="paramname"><em>expando</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Removes the specified path expando. </p>

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