| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221 |
- <!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: 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 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 Page</span></a></li>
- <li><a href="pages.html"><span>Related 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">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 name="func-members"></a>
- Functions</h2></td></tr>
- <tr class="memitem:ga1672ccca5a3f85f12bcc066dd8fda7f3"><td class="memItemLeft" align="right" valign="top">void </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"> </td></tr>
- <tr class="memitem:ga174752fc45b24e9b935f7a485f34b558"><td class="memItemLeft" align="right" valign="top">string </td><td class="memItemRight" valign="bottom"><a class="el" href="group__PathExpandoFunctions.html#ga174752fc45b24e9b935f7a485f34b558">collapsePath</a> (string path)</td></tr>
- <tr class="separator:ga174752fc45b24e9b935f7a485f34b558"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ga047e69334d1034fd49571ff80484789e"><td class="memItemLeft" align="right" valign="top">string </td><td class="memItemRight" valign="bottom"><a class="el" href="group__PathExpandoFunctions.html#ga047e69334d1034fd49571ff80484789e">expandPath</a> (string path)</td></tr>
- <tr class="separator:ga047e69334d1034fd49571ff80484789e"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ga751e1345b486ea220b94337a44533885"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__PathExpandoFunctions.html#ga751e1345b486ea220b94337a44533885">getPathExpandoCount</a> ()</td></tr>
- <tr class="separator:ga751e1345b486ea220b94337a44533885"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ga70d74a810f27bae7212871cda19447e2"><td class="memItemLeft" align="right" valign="top">string </td><td class="memItemRight" valign="bottom"><a class="el" href="group__PathExpandoFunctions.html#ga70d74a810f27bae7212871cda19447e2">getPathExpandoKey</a> (int expandoIndex)</td></tr>
- <tr class="separator:ga70d74a810f27bae7212871cda19447e2"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:gaad4cef23e62eb3aaae2065802e4c0536"><td class="memItemLeft" align="right" valign="top">string </td><td class="memItemRight" valign="bottom"><a class="el" href="group__PathExpandoFunctions.html#gaad4cef23e62eb3aaae2065802e4c0536">getPathExpandoValue</a> (int expandoIndex)</td></tr>
- <tr class="separator:gaad4cef23e62eb3aaae2065802e4c0536"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ga8febff23be0cde71aed777ca697350ad"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="group__PathExpandoFunctions.html#ga8febff23be0cde71aed777ca697350ad">isPathExpando</a> (string expando)</td></tr>
- <tr class="separator:ga8febff23be0cde71aed777ca697350ad"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:gac7514fa863156f369c13fe8533165021"><td class="memItemLeft" align="right" valign="top">void </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"> </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="ga1672ccca5a3f85f12bcc066dd8fda7f3"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">void addPathExpando </td>
- <td>(</td>
- <td class="paramtype">string </td>
- <td class="paramname"><em>expando</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">string </td>
- <td class="paramname"><em>path</em> </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 class="anchor" id="ga174752fc45b24e9b935f7a485f34b558"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">string collapsePath </td>
- <td>(</td>
- <td class="paramtype">string </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 class="anchor" id="ga047e69334d1034fd49571ff80484789e"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">string expandPath </td>
- <td>(</td>
- <td class="paramtype">string </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 class="anchor" id="ga751e1345b486ea220b94337a44533885"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">int 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 class="anchor" id="ga70d74a810f27bae7212871cda19447e2"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">string getPathExpandoKey </td>
- <td>(</td>
- <td class="paramtype">int </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 class="anchor" id="gaad4cef23e62eb3aaae2065802e4c0536"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">string getPathExpandoValue </td>
- <td>(</td>
- <td class="paramtype">int </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 class="anchor" id="ga8febff23be0cde71aed777ca697350ad"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">bool isPathExpando </td>
- <td>(</td>
- <td class="paramtype">string </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 class="anchor" id="gac7514fa863156f369c13fe8533165021"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">void removePathExpando </td>
- <td>(</td>
- <td class="paramtype">string </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  <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>
|