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


			
				
					
						
						
							123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839
							<!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 Fields</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 Fields<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:ga8d92d81e5a86d805abd40e99460c1063" id="r_ga8d92d81e5a86d805abd40e99460c1063"><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__FieldManipulatorFunctions.html#ga8d92d81e5a86d805abd40e99460c1063">firstWord</a> (sourceString)</td></tr>
<tr class="separator:ga8d92d81e5a86d805abd40e99460c1063"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga002437d92507b59b54ccd6ff59ac29de" id="r_ga002437d92507b59b54ccd6ff59ac29de"><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__FieldManipulatorFunctions.html#ga002437d92507b59b54ccd6ff59ac29de">getField</a> (sourceString, index)</td></tr>
<tr class="separator:ga002437d92507b59b54ccd6ff59ac29de"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga2d4d9e3911ed9a21a14b94ed44177a52" id="r_ga2d4d9e3911ed9a21a14b94ed44177a52"><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__FieldManipulatorFunctions.html#ga2d4d9e3911ed9a21a14b94ed44177a52">getFieldCount</a> (sourceString)</td></tr>
<tr class="separator:ga2d4d9e3911ed9a21a14b94ed44177a52"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga12cd6b5563ff2c601032d3ad29917ed3" id="r_ga12cd6b5563ff2c601032d3ad29917ed3"><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__FieldManipulatorFunctions.html#ga12cd6b5563ff2c601032d3ad29917ed3">getFields</a> (sourceString, index[, endindex])</td></tr>
<tr class="separator:ga12cd6b5563ff2c601032d3ad29917ed3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga6566909583165a3699a680734361e1e4" id="r_ga6566909583165a3699a680734361e1e4"><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__FieldManipulatorFunctions.html#ga6566909583165a3699a680734361e1e4">getRecord</a> (sourceString, index)</td></tr>
<tr class="separator:ga6566909583165a3699a680734361e1e4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga32bf09c559fb66e120b4fb84a28c78ad" id="r_ga32bf09c559fb66e120b4fb84a28c78ad"><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__FieldManipulatorFunctions.html#ga32bf09c559fb66e120b4fb84a28c78ad">getRecordCount</a> (sourceString)</td></tr>
<tr class="separator:ga32bf09c559fb66e120b4fb84a28c78ad"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga77abe0211d5bf5d04492364aeee7f9f9" id="r_ga77abe0211d5bf5d04492364aeee7f9f9"><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__FieldManipulatorFunctions.html#ga77abe0211d5bf5d04492364aeee7f9f9">getRecords</a> (sourceString, index[, endindex])</td></tr>
<tr class="separator:ga77abe0211d5bf5d04492364aeee7f9f9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga67e6dd340b36af0b7ac756b7dd775acb" id="r_ga67e6dd340b36af0b7ac756b7dd775acb"><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__FieldManipulatorFunctions.html#ga67e6dd340b36af0b7ac756b7dd775acb">getUnit</a> (sourceString, index, separator)</td></tr>
<tr class="separator:ga67e6dd340b36af0b7ac756b7dd775acb"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaaf70484588db95a0ae6291363fbece52" id="r_gaaf70484588db95a0ae6291363fbece52"><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__FieldManipulatorFunctions.html#gaaf70484588db95a0ae6291363fbece52">getUnitCount</a> (sourceString, separator)</td></tr>
<tr class="separator:gaaf70484588db95a0ae6291363fbece52"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gab9848b8f9ac4309659e4412700fa969b" id="r_gab9848b8f9ac4309659e4412700fa969b"><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__FieldManipulatorFunctions.html#gab9848b8f9ac4309659e4412700fa969b">getWord</a> (sourceString, index)</td></tr>
<tr class="separator:gab9848b8f9ac4309659e4412700fa969b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gab7fc75069bcbb768c9f1b247c58a4def" id="r_gab7fc75069bcbb768c9f1b247c58a4def"><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__FieldManipulatorFunctions.html#gab7fc75069bcbb768c9f1b247c58a4def">getWordCount</a> (sourceString)</td></tr>
<tr class="separator:gab7fc75069bcbb768c9f1b247c58a4def"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga915d70c8b797822e366a3c1e9266f58f" id="r_ga915d70c8b797822e366a3c1e9266f58f"><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__FieldManipulatorFunctions.html#ga915d70c8b797822e366a3c1e9266f58f">getWords</a> (sourceString, index[, endindex])</td></tr>
<tr class="separator:ga915d70c8b797822e366a3c1e9266f58f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaed8a4598e98535feb635b43d592d2be1" id="r_gaed8a4598e98535feb635b43d592d2be1"><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__FieldManipulatorFunctions.html#gaed8a4598e98535feb635b43d592d2be1">NextToken</a> (tokenList, tokenVar, delimeter)</td></tr>
<tr class="separator:gaed8a4598e98535feb635b43d592d2be1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga501b2144ac56dad783e3c7c4dc8adce6" id="r_ga501b2144ac56dad783e3c7c4dc8adce6"><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__FieldManipulatorFunctions.html#ga501b2144ac56dad783e3c7c4dc8adce6">removeField</a> (sourceString, index)</td></tr>
<tr class="separator:ga501b2144ac56dad783e3c7c4dc8adce6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga4cf3c1de132bb69588792d838380e54f" id="r_ga4cf3c1de132bb69588792d838380e54f"><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__FieldManipulatorFunctions.html#ga4cf3c1de132bb69588792d838380e54f">removeRecord</a> (sourceString, index)</td></tr>
<tr class="separator:ga4cf3c1de132bb69588792d838380e54f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga41ef40d4022d190367715d424c239a5f" id="r_ga41ef40d4022d190367715d424c239a5f"><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__FieldManipulatorFunctions.html#ga41ef40d4022d190367715d424c239a5f">removeWord</a> (sourceString, index)</td></tr>
<tr class="separator:ga41ef40d4022d190367715d424c239a5f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gafb09129326976ea439c34378834e9595" id="r_gafb09129326976ea439c34378834e9595"><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__FieldManipulatorFunctions.html#gafb09129326976ea439c34378834e9595">restWords</a> (sourceString)</td></tr>
<tr class="separator:gafb09129326976ea439c34378834e9595"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga2a0626e25168010caa8122cdf7e17611" id="r_ga2a0626e25168010caa8122cdf7e17611"><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__FieldManipulatorFunctions.html#ga2a0626e25168010caa8122cdf7e17611">setField</a> (sourceString, index, replace)</td></tr>
<tr class="separator:ga2a0626e25168010caa8122cdf7e17611"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga3245b0afa80c910b7d8030ad96649a0b" id="r_ga3245b0afa80c910b7d8030ad96649a0b"><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__FieldManipulatorFunctions.html#ga3245b0afa80c910b7d8030ad96649a0b">setRecord</a> (sourceString, index, replace)</td></tr>
<tr class="separator:ga3245b0afa80c910b7d8030ad96649a0b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga0fe1b3f29f0bd3b6280659ed468db65e" id="r_ga0fe1b3f29f0bd3b6280659ed468db65e"><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__FieldManipulatorFunctions.html#ga0fe1b3f29f0bd3b6280659ed468db65e">setUnit</a> (sourceString, index, replace, separator)</td></tr>
<tr class="separator:ga0fe1b3f29f0bd3b6280659ed468db65e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga231cccf1868a4a2376966469c4509426" id="r_ga231cccf1868a4a2376966469c4509426"><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__FieldManipulatorFunctions.html#ga231cccf1868a4a2376966469c4509426">setWord</a> (sourceString, index, replace)</td></tr>
<tr class="separator:ga231cccf1868a4a2376966469c4509426"><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="ga8d92d81e5a86d805abd40e99460c1063" name="ga8d92d81e5a86d805abd40e99460c1063"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga8d92d81e5a86d805abd40e99460c1063">&#9670;&#160;</a></span>firstWord()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a> firstWord </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 firstWord function to retrieve the first word found in sourceString. </p><dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">sourceString</td><td>A string containing one or more words. </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Returns the first word found in sourceString, or a NULL string, if no words are found. </dd></dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="group__FieldManipulatorFunctions.html#gafb09129326976ea439c34378834e9595">restWords</a> </dd></dl>

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

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a> getField </td>
          <td>(</td>
          <td class="paramtype">sourceString&#160;</td>
          <td class="paramname">, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">index&#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 getField function to get the field at index in sourceString. </p><dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">sourceString</td><td>A string containing one or more fields. </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Returns field at index in sourceString, or null string if no field exists at that index. </dd></dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="group__FieldManipulatorFunctions.html#ga12cd6b5563ff2c601032d3ad29917ed3">getFields</a>, <a class="el" href="group__FieldManipulatorFunctions.html#ga2a0626e25168010caa8122cdf7e17611">setField</a> </dd></dl>

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

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#ga85be84504cf913ad90b8ee4f264195d3">Integer</a> getFieldCount </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 getFieldCount function to get the number of fields in sourceString. </p><dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">sourceString</td><td>A string containing one or more fields. </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Returns number of fields in sourceString or 0 if no fields are present </dd></dl>

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

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a> getFields </td>
          <td>(</td>
          <td class="paramtype">sourceString&#160;</td>
          <td class="paramname">, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">index&#160;</td>
          <td class="paramname">[, endindex]&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Use the getFields function to retrieve a set of fields from a sourceString. </p><dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">sourceString</td><td>A string containing one or more fields. </td></tr>
    <tr><td class="paramname">index</td><td>The index of the first field to retrieve. </td></tr>
    <tr><td class="paramname">endindex</td><td>The index of the final field to retrieve. </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Returns all fields (separated by current delimiter) from sourceString, starting at index and ending at endIndex or end of string, whichever comes first. If no endIndex is specified, all remaining fields are returned. </dd></dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="group__FieldManipulatorFunctions.html#ga002437d92507b59b54ccd6ff59ac29de">getField</a>, <a class="el" href="group__FieldManipulatorFunctions.html#ga2a0626e25168010caa8122cdf7e17611">setField</a> </dd></dl>

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

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a> getRecord </td>
          <td>(</td>
          <td class="paramtype">sourceString&#160;</td>
          <td class="paramname">, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">index&#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 getRecord function to get the record at index in sourceString. </p><dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">sourceString</td><td>A string containing one or more records. </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Returns record at index in sourceString, or NULL string if no record exists at that index. </dd></dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="group__FieldManipulatorFunctions.html#ga77abe0211d5bf5d04492364aeee7f9f9">getRecords</a>, <a class="el" href="group__FieldManipulatorFunctions.html#ga3245b0afa80c910b7d8030ad96649a0b">setRecord</a> </dd></dl>

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

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#ga85be84504cf913ad90b8ee4f264195d3">Integer</a> getRecordCount </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 getRecordCount function to get the number of records in sourceString. </p><dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">sourceString</td><td>A string containing one or more records. </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Returns number of records in sourceString or 0 if no records are present </dd></dl>

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

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a> getRecords </td>
          <td>(</td>
          <td class="paramtype">sourceString&#160;</td>
          <td class="paramname">, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">index&#160;</td>
          <td class="paramname">[, endindex]&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Use the getRecords function to retrieve a set of records from a sourceString. </p><dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">sourceString</td><td>A string containing one or more records. </td></tr>
    <tr><td class="paramname">index</td><td>The index of the first record to retrieve. </td></tr>
    <tr><td class="paramname">endindex</td><td>The index of the final record to retrieve. </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Returns all records (separated by current delimiter) from sourceString, starting at index and ending at endIndex or end of string, whichever comes first. If no endIndex is specified, all remaining records are returned. </dd></dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="group__FieldManipulatorFunctions.html#ga6566909583165a3699a680734361e1e4">getRecord</a>, <a class="el" href="group__FieldManipulatorFunctions.html#ga3245b0afa80c910b7d8030ad96649a0b">setRecord</a> </dd></dl>

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

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a> getUnit </td>
          <td>(</td>
          <td class="paramtype">sourceString&#160;</td>
          <td class="paramname">, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">index&#160;</td>
          <td class="paramname">, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">separator&#160;</td>
          <td class="paramname">&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

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

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#ga85be84504cf913ad90b8ee4f264195d3">Integer</a> getUnitCount </td>
          <td>(</td>
          <td class="paramtype">sourceString&#160;</td>
          <td class="paramname">, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">separator&#160;</td>
          <td class="paramname">&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

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

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a> getWord </td>
          <td>(</td>
          <td class="paramtype">sourceString&#160;</td>
          <td class="paramname">, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">index&#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 getWord function to get the word at index in sourceString. </p><dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">sourceString</td><td>A string containing one or more words. </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Returns word at index in sourceString, or null string if no word exists at that index. </dd></dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="group__FieldManipulatorFunctions.html#ga915d70c8b797822e366a3c1e9266f58f">getWords</a>, <a class="el" href="group__FieldManipulatorFunctions.html#ga231cccf1868a4a2376966469c4509426">setWord</a> </dd></dl>

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

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#ga85be84504cf913ad90b8ee4f264195d3">Integer</a> getWordCount </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 getWordCount function to get the number of words in sourceString. </p><dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">sourceString</td><td>A string containing one or more words. </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Returns number of words in sourceString or 0 if no words are present </dd></dl>

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

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a> getWords </td>
          <td>(</td>
          <td class="paramtype">sourceString&#160;</td>
          <td class="paramname">, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">index&#160;</td>
          <td class="paramname">[, endindex]&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Use the getWords function to retrieve a set of words from a sourceString. </p><dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">sourceString</td><td>A string containing one or more words. </td></tr>
    <tr><td class="paramname">index</td><td>The index of the first word to retrieve. </td></tr>
    <tr><td class="paramname">endindex</td><td>The index of the final word to retrieve. </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Returns all words (separated by current delimiter) from sourceString, starting at index and ending at endIndex or end of string, whichever comes first. If no endIndex is specified, all remaining words are returned. </dd></dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="group__FieldManipulatorFunctions.html#gab9848b8f9ac4309659e4412700fa969b">getWord</a>, <a class="el" href="group__FieldManipulatorFunctions.html#ga231cccf1868a4a2376966469c4509426">setWord</a> </dd></dl>

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

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a> NextToken </td>
          <td>(</td>
          <td class="paramtype">tokenList&#160;</td>
          <td class="paramname">, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">tokenVar&#160;</td>
          <td class="paramname">, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">delimeter&#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 nextToken function to get the first token found in tokenList, where tokens are separated by the character(s) specified in delimeter. The token itself is stored in a variable whose name is specified in tokenVar. This function provides complex power in a simple package. Please read the notes below, they are very important. This function is scope-smart. That is, when we specify the name of the variable to store a token in by passing a value in tokenVar, we do not include either a local symbol (%), or a global symbol ($). We just pass in an un-adorned name, let's say \George. Then, depending on where this function is called, \George\ will become a local (George), or a global ($George) variable. If this function is called within a function or method definition, \George\ will be local (George). If this function is called from the file-scope (executed as part of a file and not within the scope of a function or method), \George\ will become a global ($George). There is one additional special case. If you attempt to use this from the console command line, the token will vaporize and no variable will be created </p><dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">tokenList</td><td>The string containing token(s). </td></tr>
    <tr><td class="paramname">tokenVar</td><td>The 'name' of the variable to store the token in. </td></tr>
    <tr><td class="paramname">delimeter</td><td>The character(s) to use as a delimeter. A delimeter may be a single character, or a sequence of characters. </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Returns a copy of tokenList, less the first token and the first delimiter. If there are no more tokens, a NULL string is returned. </dd></dl>

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

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a> removeField </td>
          <td>(</td>
          <td class="paramtype">sourceString&#160;</td>
          <td class="paramname">, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">index&#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 removeField function to remove a single indexed field from a sourceString. </p><dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">sourceString</td><td>A string containing one or more fields. </td></tr>
    <tr><td class="paramname">index</td><td>The index of the field to remove. </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Returns sourceString minus the removed field. If the index is greater than the number of fields in sourceString, the original string is returned. </dd></dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="group__FieldManipulatorFunctions.html#ga2a0626e25168010caa8122cdf7e17611">setField</a> </dd></dl>

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

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a> removeRecord </td>
          <td>(</td>
          <td class="paramtype">sourceString&#160;</td>
          <td class="paramname">, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">index&#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 removeRecord function to remove a single indexed record from a sourceString. </p><dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">sourceString</td><td>A string containing one or more records. </td></tr>
    <tr><td class="paramname">index</td><td>The index of the record to remove. </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Returns sourceString minus the removed record. If the index is greater than the number of records in sourceString, the original string is returned. </dd></dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="group__FieldManipulatorFunctions.html#ga3245b0afa80c910b7d8030ad96649a0b">setRecord</a> </dd></dl>

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

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a> removeWord </td>
          <td>(</td>
          <td class="paramtype">sourceString&#160;</td>
          <td class="paramname">, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">index&#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 removeWord function to remove a single indexed word from a sourceString. </p><dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">sourceString</td><td>A string containing one or more words. </td></tr>
    <tr><td class="paramname">index</td><td>The index of the word to remove. </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Returns sourceString minus the removed word. If the index is greater than the number of words in sourceString, the original string is returned. </dd></dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="group__FieldManipulatorFunctions.html#ga231cccf1868a4a2376966469c4509426">setWord</a> </dd></dl>

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

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a> restWords </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 restWords function to retrieve all words after the first word in sourceString. </p><dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">sourceString</td><td>A string containing one or more words. </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Returns a string containing all the words after the first word found in sourceString, or a NULL string if no words remain after the first word (or if no words at all remain). </dd></dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="group__FieldManipulatorFunctions.html#ga8d92d81e5a86d805abd40e99460c1063">firstWord</a> </dd></dl>

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

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a> setField </td>
          <td>(</td>
          <td class="paramtype">sourceString&#160;</td>
          <td class="paramname">, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">index&#160;</td>
          <td class="paramname">, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">replace&#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 setField function to replace an existing field with a new field(s), or to add field(s) to a string.. </p><dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">sourceString</td><td>A string containing one or more fields. </td></tr>
    <tr><td class="paramname">index</td><td>The index of the field to remove. </td></tr>
    <tr><td class="paramname">replace</td><td>The new field(s) to replace the field at index with. </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>There are multiple return cases:- In the first case, a simple one-to-one replacement, the field at index in sourceString will be replaced with the value in replace, and the new string will be returned.- In the first case, a multi-to-one replacement, the field at index in sourceString will be replaced with the value in replace, which can be two or more fields, and the new string will be returned.- In the thrid and final case, new records, empty or filled, can be appended to the end of sourceString. If index is beyond the end of the sourceString, that is, the index is greater than the total count of fields in sourceString, the requisite number of empty (null-string) fields will be appended to the end of sourceString and the value in replace will be appended to the end of this new string. This entire resultant string will be returned. </dd></dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="group__FieldManipulatorFunctions.html#ga002437d92507b59b54ccd6ff59ac29de">getField</a>, <a class="el" href="group__FieldManipulatorFunctions.html#ga12cd6b5563ff2c601032d3ad29917ed3">getFields</a>, <a class="el" href="group__FieldManipulatorFunctions.html#ga501b2144ac56dad783e3c7c4dc8adce6">removeField</a> </dd></dl>

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

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a> setRecord </td>
          <td>(</td>
          <td class="paramtype">sourceString&#160;</td>
          <td class="paramname">, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">index&#160;</td>
          <td class="paramname">, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">replace&#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 setRecord function to replace an existing record with a new record(s), or to add record(s) to a string.. </p><dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">sourceString</td><td>A string containing one or more records. </td></tr>
    <tr><td class="paramname">index</td><td>The index of the record to remove. </td></tr>
    <tr><td class="paramname">replace</td><td>The new record(s) to replace the record at index with. </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>There are multiple return cases:- In the first case, a simple one-to-one replacement, the record at index in sourceString will be replaced with the value in replace, and the new string will be returned.- In the first case, a multi-to-one replacement, the record at index in sourceString will be replaced with the value in replace, which can be two or more records, and the new string will be returned.- In the thrid and final case, new records, empty or filled, can be appended to the end of sourceString. If index is beyond the end of the sourceString, that is, the index is greater than the total count of records in sourceString, the requisite number of empty (null-string) records will be appended to the end of sourceString and the value in replace will be appended to the end of this new string. This entire resultant string will be returned. </dd></dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="group__FieldManipulatorFunctions.html#ga6566909583165a3699a680734361e1e4">getRecord</a>, <a class="el" href="group__FieldManipulatorFunctions.html#ga77abe0211d5bf5d04492364aeee7f9f9">getRecords</a>, <a class="el" href="group__FieldManipulatorFunctions.html#ga4cf3c1de132bb69588792d838380e54f">removeRecord</a> </dd></dl>

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

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a> setUnit </td>
          <td>(</td>
          <td class="paramtype">sourceString&#160;</td>
          <td class="paramname">, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">index&#160;</td>
          <td class="paramname">, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">replace&#160;</td>
          <td class="paramname">, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">separator&#160;</td>
          <td class="paramname">&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

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

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#gadd36cf0d984acde0881d9ab8fff3ae5d">String</a> setWord </td>
          <td>(</td>
          <td class="paramtype">sourceString&#160;</td>
          <td class="paramname">, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">index&#160;</td>
          <td class="paramname">, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">replace&#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 setWord function to replace an existing word with a new word(s), or to add word(s) to a string.. </p><dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">sourceString</td><td>A string containing one or more words. </td></tr>
    <tr><td class="paramname">index</td><td>The index of the word to remove. </td></tr>
    <tr><td class="paramname">replace</td><td>The new word(s) to replace the word at index with. </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>There are multiple return cases:- In the first case, a simple one-to-one replacement, the word at index in sourceString will be replaced with the value in replace, and the new string will be returned.- In the first case, a multi-to-one replacement, the word at index in sourceString will be replaced with the value in replace, which can be two or more words, and the new string will be returned.- In the third and final case, new records, empty or filled, can be appended to the end of sourceString. If index is beyond the end of the sourceString, that is, the index is greater than the total count of words in sourceString, the requisite number of empty (null-string) words will be appended to the end of sourceString and the value in replace will be appended to the end of this new string. This entire resultant string will be returned. </dd></dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="group__FieldManipulatorFunctions.html#gab9848b8f9ac4309659e4412700fa969b">getWord</a>, <a class="el" href="group__FieldManipulatorFunctions.html#ga915d70c8b797822e366a3c1e9266f58f">getWords</a>, <a class="el" href="group__FieldManipulatorFunctions.html#ga41ef40d4022d190367715d424c239a5f">removeWord</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>