TorqueEngine
/
Torque2D
镜像来自 https://github.com/TorqueGameEngines/Torque2D.git


			
				
					
						
						
							123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650
							<!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: String</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">String<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:ga484bcb723e4d8bd6f7e6b362ccbdea27" id="r_ga484bcb723e4d8bd6f7e6b362ccbdea27"><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__StringFunctions.html#ga484bcb723e4d8bd6f7e6b362ccbdea27">getSubStr</a> (sourceString, start, count)</td></tr>
<tr class="separator:ga484bcb723e4d8bd6f7e6b362ccbdea27"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga398dd476c27e2270efec203fcead4f74" id="r_ga398dd476c27e2270efec203fcead4f74"><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__StringFunctions.html#ga398dd476c27e2270efec203fcead4f74">ltrim</a> (sourceString)</td></tr>
<tr class="separator:ga398dd476c27e2270efec203fcead4f74"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga39d5c31d3f04fdd1687d2fcda5754136" id="r_ga39d5c31d3f04fdd1687d2fcda5754136"><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__StringFunctions.html#ga39d5c31d3f04fdd1687d2fcda5754136">rtrim</a> (sourceString)</td></tr>
<tr class="separator:ga39d5c31d3f04fdd1687d2fcda5754136"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga44cf5b8b8bea66e935d51769da41d268" id="r_ga44cf5b8b8bea66e935d51769da41d268"><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__StringFunctions.html#ga44cf5b8b8bea66e935d51769da41d268">strchr</a> (sourceString, char)</td></tr>
<tr class="separator:ga44cf5b8b8bea66e935d51769da41d268"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gadd80e9144f64c2e3219a74be1198b4d2" id="r_gadd80e9144f64c2e3219a74be1198b4d2"><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__StringFunctions.html#gadd80e9144f64c2e3219a74be1198b4d2">strcmp</a> (string1, string2)</td></tr>
<tr class="separator:gadd80e9144f64c2e3219a74be1198b4d2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gae26368e0921a917a0644f6f4c38ceeb7" id="r_gae26368e0921a917a0644f6f4c38ceeb7"><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__StringFunctions.html#gae26368e0921a917a0644f6f4c38ceeb7">stricmp</a> (string1, string2)</td></tr>
<tr class="separator:gae26368e0921a917a0644f6f4c38ceeb7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga6732ae030c5401ac4df1568df612e6a0" id="r_ga6732ae030c5401ac4df1568df612e6a0"><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__StringFunctions.html#ga6732ae030c5401ac4df1568df612e6a0">stripChars</a> (sourceString, chars)</td></tr>
<tr class="separator:ga6732ae030c5401ac4df1568df612e6a0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga8146a7417e5547eb8218351806454ed3" id="r_ga8146a7417e5547eb8218351806454ed3"><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__StringFunctions.html#ga8146a7417e5547eb8218351806454ed3">stripColorCodes</a> (stringtoStrip)</td></tr>
<tr class="separator:ga8146a7417e5547eb8218351806454ed3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaa0f0826c103e5d3da9790db75545ce11" id="r_gaa0f0826c103e5d3da9790db75545ce11"><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__StringFunctions.html#gaa0f0826c103e5d3da9790db75545ce11">stripTrailingSpaces</a> (string)</td></tr>
<tr class="separator:gaa0f0826c103e5d3da9790db75545ce11"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gadebd1409d216aaa04765a5c45f4d433d" id="r_gadebd1409d216aaa04765a5c45f4d433d"><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__StringFunctions.html#gadebd1409d216aaa04765a5c45f4d433d">strlen</a> (string)</td></tr>
<tr class="separator:gadebd1409d216aaa04765a5c45f4d433d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga4ca39bba5a20c2b54cbf832c86825b9f" id="r_ga4ca39bba5a20c2b54cbf832c86825b9f"><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__StringFunctions.html#ga4ca39bba5a20c2b54cbf832c86825b9f">strlwr</a> (sourceString)</td></tr>
<tr class="separator:ga4ca39bba5a20c2b54cbf832c86825b9f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaea95ea452d0f17de9bd06af7f9f1f3a7" id="r_gaea95ea452d0f17de9bd06af7f9f1f3a7"><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__StringFunctions.html#gaea95ea452d0f17de9bd06af7f9f1f3a7">strpos</a> (sourceString, searchString, [offset]?)</td></tr>
<tr class="separator:gaea95ea452d0f17de9bd06af7f9f1f3a7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga29ce3d394e74b71a57109211835ab0c3" id="r_ga29ce3d394e74b71a57109211835ab0c3"><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__StringFunctions.html#ga29ce3d394e74b71a57109211835ab0c3">strrchr</a> (sourceString, char)</td></tr>
<tr class="separator:ga29ce3d394e74b71a57109211835ab0c3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga4e1268b2e16a57b6967d5246b5e8dbb0" id="r_ga4e1268b2e16a57b6967d5246b5e8dbb0"><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__StringFunctions.html#ga4e1268b2e16a57b6967d5246b5e8dbb0">strreplace</a> (sourceString, from, to)</td></tr>
<tr class="separator:ga4e1268b2e16a57b6967d5246b5e8dbb0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gae9f5ef43b0385406834f79bdea12aec6" id="r_gae9f5ef43b0385406834f79bdea12aec6"><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__StringFunctions.html#gae9f5ef43b0385406834f79bdea12aec6">strstr</a> (sourceString, searchString)</td></tr>
<tr class="separator:gae9f5ef43b0385406834f79bdea12aec6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga00d04a14fa694517811ee2df409ebd59" id="r_ga00d04a14fa694517811ee2df409ebd59"><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__StringFunctions.html#ga00d04a14fa694517811ee2df409ebd59">strupr</a> (sourceString)</td></tr>
<tr class="separator:ga00d04a14fa694517811ee2df409ebd59"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga61510d39195c7eaab61a609b02c91f74" id="r_ga61510d39195c7eaab61a609b02c91f74"><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__StringFunctions.html#ga61510d39195c7eaab61a609b02c91f74">trim</a> (sourceString)</td></tr>
<tr class="separator:ga61510d39195c7eaab61a609b02c91f74"><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="ga484bcb723e4d8bd6f7e6b362ccbdea27" name="ga484bcb723e4d8bd6f7e6b362ccbdea27"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga484bcb723e4d8bd6f7e6b362ccbdea27">&#9670;&#160;</a></span>getSubStr()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a> getSubStr </td>
          <td>(</td>
          <td class="paramtype">sourceString&#160;</td>
          <td class="paramname">, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">start&#160;</td>
          <td class="paramname">, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">count&#160;</td>
          <td class="paramname">&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Use the getSubStr function to get a sub-string of sourceString, starting at character index start and ending at character index start + count, or the end-of-string, which ever comes first. If start + count is greater than the length of sourceString, the extraction will return a string shorter than count. </p><dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">sourceString</td><td>The string from which to extract a sub-string. </td></tr>
    <tr><td class="paramname">start</td><td>The character index at which the extraction starts. </td></tr>
    <tr><td class="paramname">count</td><td>The length of the sub-string to extract. </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Returns a string made up of the character at start in sourceString and ending at the end of the original sourceString, or start + count, whichever comes first. </dd></dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="group__StringFunctions.html#ga44cf5b8b8bea66e935d51769da41d268">strchr</a> </dd></dl>

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

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a> ltrim </td>
          <td>(</td>
          <td class="paramtype">sourceString&#160;</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Use the ltrim function to strip the leading white space from sourceString. White space is any character in this set: spaces, TABs, and NULL strings. </p><dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">sourceString</td><td>The string to be trimmed. </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Returns sourceString with all the leading white spaces removed. </dd></dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="group__StringFunctions.html#ga6732ae030c5401ac4df1568df612e6a0">stripChars</a>, stripMLControlChars, <a class="el" href="group__StringFunctions.html#gaa0f0826c103e5d3da9790db75545ce11">stripTrailingSpaces</a>, <a class="el" href="group__StringFunctions.html#ga39d5c31d3f04fdd1687d2fcda5754136">rtrim</a>, <a class="el" href="group__StringFunctions.html#ga61510d39195c7eaab61a609b02c91f74">trim</a> </dd></dl>

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

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a> rtrim </td>
          <td>(</td>
          <td class="paramtype">sourceString&#160;</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Use the rtrim function to strip the trailing white space from sourceString. White space is any character in this set: spaces, TABs, and NULL strings. </p><dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">sourceString</td><td>The string to be trimmed. </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Returns sourceString with all the trailing white spaces removed. </dd></dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="group__StringFunctions.html#ga6732ae030c5401ac4df1568df612e6a0">stripChars</a>, stripMLControlChars, <a class="el" href="group__StringFunctions.html#gaa0f0826c103e5d3da9790db75545ce11">stripTrailingSpaces</a>, <a class="el" href="group__StringFunctions.html#ga398dd476c27e2270efec203fcead4f74">ltrim</a>, <a class="el" href="group__StringFunctions.html#ga61510d39195c7eaab61a609b02c91f74">trim</a> </dd></dl>

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

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a> strchr </td>
          <td>(</td>
          <td class="paramtype">sourceString&#160;</td>
          <td class="paramname">, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">char&#160;</td>
          <td class="paramname">&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Use the strchr function to extract a sub-string of sourceString, where the sub-string is equal to the first occurence of char in sourceString followed by the remainder of sourceString. </p><dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">sourceString</td><td>The string from which to extract a sub-string. </td></tr>
    <tr><td class="paramname">char</td><td>The character to search for in sourceString. </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Returns a string composed of first instance of char in sourceString, and all of the characters after it. If char is not found, a NULL string is returned. </dd></dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="group__StringFunctions.html#ga484bcb723e4d8bd6f7e6b362ccbdea27">getSubStr</a> </dd></dl>

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

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#ga85be84504cf913ad90b8ee4f264195d3">Integer</a> strcmp </td>
          <td>(</td>
          <td class="paramtype">string1&#160;</td>
          <td class="paramname">, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">string2&#160;</td>
          <td class="paramname">&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Use the strcmp function to do a lexicographic case sensitive string comparison between string1 and string2. </p><dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">string1</td><td>String to be compared to string2. </td></tr>
    <tr><td class="paramname">string2</td><td>String to be compared to string1. </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Returns a numeric value: &lt;-1 (string1 is less than string2, including case), 0 (string1 is equal to string2, including case), 1 (string1 is greater than string2, including case)&gt;. </dd></dl>
<dl class="section see"><dt>See also</dt><dd>see <a class="el" href="group__StringFunctions.html#gae26368e0921a917a0644f6f4c38ceeb7">stricmp</a>, <a class="el" href="group__StringFunctions.html#gae9f5ef43b0385406834f79bdea12aec6">strstr</a> </dd></dl>

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

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#ga85be84504cf913ad90b8ee4f264195d3">Integer</a> stricmp </td>
          <td>(</td>
          <td class="paramtype">string1&#160;</td>
          <td class="paramname">, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">string2&#160;</td>
          <td class="paramname">&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Use the stricmp function to do a lexicographic case in-sensitive string comparison between string1 and string2. </p><dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">string1</td><td>String to be compared to string2. </td></tr>
    <tr><td class="paramname">string2</td><td>String to be compared to string1. </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Returns a numeric value: &lt;-1 (string1 is less than string2, ignoring case), 0 (string1 is equal to string2, ignoring case), 1 (string1 is greater than string2, ignoring case)&gt;. </dd></dl>
<dl class="section see"><dt>See also</dt><dd>see <a class="el" href="group__StringFunctions.html#gadd80e9144f64c2e3219a74be1198b4d2">strcmp</a>, <a class="el" href="group__StringFunctions.html#gae9f5ef43b0385406834f79bdea12aec6">strstr</a> </dd></dl>

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

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a> stripChars </td>
          <td>(</td>
          <td class="paramtype">sourceString&#160;</td>
          <td class="paramname">, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">chars&#160;</td>
          <td class="paramname">&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Use the stripChars function to remove chars from sourceString. </p><dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">sourceString</td><td>The string to be modified. </td></tr>
    <tr><td class="paramname">chars</td><td>The character or characters to search for and remove. </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Returns a copy of sourceString, from which all instances of chars have been removed. This may be the original sourceString, if chars was not found. </dd></dl>
<dl class="section see"><dt>See also</dt><dd>stripMLControlChars, <a class="el" href="group__StringFunctions.html#gaa0f0826c103e5d3da9790db75545ce11">stripTrailingSpaces</a> </dd></dl>

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

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a> stripColorCodes </td>
          <td>(</td>
          <td class="paramtype">stringtoStrip&#160;</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>remove TorqueML color codes from the string. </p><dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">stringtoString</td><td>The string from which to remove TorqueML color codes </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>A string consisting of the original string minus color codes </dd></dl>

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

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a> stripTrailingSpaces </td>
          <td>(</td>
          <td class="paramtype">string&#160;</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Removes all spaces after the final </p><dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">string</td><td>from which to remove trailing spaces </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>the source string minus trailing spaces </dd></dl>

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

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#ga85be84504cf913ad90b8ee4f264195d3">Integer</a> strlen </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 strlen function to determine how many characters there are in string. </p><dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">string</td><td>The string to count characters for. </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Returns the number of characters in string, or 0 if string is invalid or a NULL string </dd></dl>

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

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a> strlwr </td>
          <td>(</td>
          <td class="paramtype">sourceString&#160;</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Use the strlwr function to convert all alpha characters in sourceString to lower-case equivalents. </p><dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">sourceString</td><td>The string to be modified. </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Returns a copy of sourceString in which all upper-case characters have been converted to lower-case letters. </dd></dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="group__StringFunctions.html#ga00d04a14fa694517811ee2df409ebd59">strupr</a> </dd></dl>

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

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#ga85be84504cf913ad90b8ee4f264195d3">Integer</a> strpos </td>
          <td>(</td>
          <td class="paramtype">sourceString&#160;</td>
          <td class="paramname">, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">searchString&#160;</td>
          <td class="paramname">, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">[offset] ?&#160;</td>
          <td class="paramname">&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Use the strPos function to locate the first instance of searchString in sourceString, starting at character 0, or at an optional offset. </p><dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">sourceString</td><td>The string in which to search for searchString. </td></tr>
    <tr><td class="paramname">searchString</td><td>The string for which to search for in sourceString. </td></tr>
    <tr><td class="paramname">offset</td><td>An optional non-negative integer value representing the character offset within sourceString at which to begin the search. </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Returns a numeric character index representing the postion in sourceString at which searchString was found, or -1 to indicate that no instance of searchString was found. </dd></dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="group__StringFunctions.html#gae9f5ef43b0385406834f79bdea12aec6">strstr</a> </dd></dl>

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

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a> strrchr </td>
          <td>(</td>
          <td class="paramtype">sourceString&#160;</td>
          <td class="paramname">, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">char&#160;</td>
          <td class="paramname">&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>strrchr searches the sourceString for the last occurance of the given char </p><dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">sourceString</td><td>The string to search </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Either a string consisting of the given string from the last occurance of the given char on or an empty string if not found </dd></dl>

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

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a> strreplace </td>
          <td>(</td>
          <td class="paramtype">sourceString&#160;</td>
          <td class="paramname">, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">from&#160;</td>
          <td class="paramname">, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">to&#160;</td>
          <td class="paramname">&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Use the strreplace function to replace every instance of from in sourceString with to. This function is case-sensitive and only does exact matching </p><dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">sourceString</td><td>The string to do replacement operations on. </td></tr>
    <tr><td class="paramname">from</td><td>The old value to be replaced. </td></tr>
    <tr><td class="paramname">to</td><td>The new value to replace old values with. </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Returns a new version of sourceString in which every instance of the value in from was replaced with the value in to. </dd></dl>

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

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#ga85be84504cf913ad90b8ee4f264195d3">Integer</a> strstr </td>
          <td>(</td>
          <td class="paramtype">sourceString&#160;</td>
          <td class="paramname">, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">searchString&#160;</td>
          <td class="paramname">&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Use the strstr function to locate the first instance of searchString in sourceString. </p><dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">sourceString</td><td>The string in which to search for searchString. </td></tr>
    <tr><td class="paramname">searchString</td><td>The string for which to search for in sourceString. </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Returns a numeric character index representing the position in sourceString at which searchString was found, or -1 to indicate that no instance of searchString was found. </dd></dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="group__StringFunctions.html#gaea95ea452d0f17de9bd06af7f9f1f3a7">strpos</a> </dd></dl>

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

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a> strupr </td>
          <td>(</td>
          <td class="paramtype">sourceString&#160;</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Use the strupr function to convert all alpha characters in sourceString to upper-case equivalents. </p><dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">sourceString</td><td>The string to be modified. </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Returns a copy of sourceString in which all lower-case characters have been converted to upper-case letters. </dd></dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="group__StringFunctions.html#ga4ca39bba5a20c2b54cbf832c86825b9f">strlwr</a> </dd></dl>

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

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a> trim </td>
          <td>(</td>
          <td class="paramtype">sourceString&#160;</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Use the trim function to strip the leading and trailing white space from sourceString. White space is any character in this set: spaces, TABs, and NULL strings. </p><dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">sourceString</td><td>The string to be trimmed. </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Returns sourceString with all the leading and trailing white spaces removed. </dd></dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="group__StringFunctions.html#ga6732ae030c5401ac4df1568df612e6a0">stripChars</a>, stripMLControlChars, <a class="el" href="group__StringFunctions.html#gaa0f0826c103e5d3da9790db75545ce11">stripTrailingSpaces</a>, <a class="el" href="group__StringFunctions.html#ga398dd476c27e2270efec203fcead4f74">ltrim</a>, <a class="el" href="group__StringFunctions.html#ga39d5c31d3f04fdd1687d2fcda5754136">rtrim</a> </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>