Frictional Game Wiki

<h2>array &lt;typename T></h2> <div class="level2"> </div> <h3>Fields</h3> <div class="level3"> <p> array &lt;typename T> has no public fields. </p> </div> <h3>Functions</h3> <div class="level3"> <span class='np_break'> </span> <div class="table"><table class="inline"> <thead> <tr class="row0"> <th class="col0"> Return Type </th><th class="col1"> Function Name </th><th class="col2"> Parameters </th><th class="col3"> Description </th> </tr> </thead> <tr class="row1"> <td class="col0"> void </td><td class="col1"> insertAt </td><td class="col2"> uint alIndex, <br/> const T &in aValue </td><td class="col3"> Inserts the value at the specified index, shifting existing values to the right. </td> </tr> <tr class="row2"> <td class="col0"> void </td><td class="col1"> removeAt </td><td class="col2"> uint alIndex </td><td class="col3"> Removes the value at the specified index, shifting values after the index to the left. </td> </tr> <tr class="row3"> <td class="col0"> void </td><td class="col1"> insertLast </td><td class="col2"> const T &in aValue </td><td class="leftalign"> Inserts the value into a new index at the end of the array. </td> </tr> <tr class="row4"> <td class="col0"> void </td><td class="col1"> insertBack </td><td class="col2"> const T &in aValue </td><td class="col3"> <em>Using this function results in an error.</em> </td> </tr> <tr class="row5"> <td class="col0"> void </td><td class="col1"> removeFirst </td><td class="leftalign"> </td><td class="col3"> Removes the value at the beginning of the array. </td> </tr> <tr class="row6"> <td class="col0"> void </td><td class="col1"> removeLast </td><td class="leftalign"> </td><td class="col3"> Removes the value at the end of the array. </td> </tr> <tr class="row7"> <td class="col0"> uint </td><td class="col1"> length </td><td class="leftalign"> </td><td class="col3"> Returns the number of elements within the array. </td> </tr> <tr class="row8"> <td class="col0"> void </td><td class="col1"> resize </td><td class="col2"> uint alLength </td><td class="col3"> Resizes the array to the specified size, creating or removing elements as necessary. </td> </tr> <tr class="row9"> <td class="col0"> void </td><td class="col1"> sortAsc </td><td class="leftalign"> </td><td class="col3"> Sorts all elements in the array into ascending order. </td> </tr> <tr class="row10"> <td class="col0"> void </td><td class="col1"> sortAsc </td><td class="col2"> uint alIndex, <br/> uint alLength </td><td class="col3"> Sorts elements in the array into ascending order, affecting only the subsection at the given index to the given length. </td> </tr> <tr class="row11"> <td class="col0"> void </td><td class="col1"> sortDesc </td><td class="leftalign"> </td><td class="col3"> Sorts all elements in the array into descending order. </td> </tr> <tr class="row12"> <td class="col0"> void </td><td class="col1"> sortDesc </td><td class="col2"> uint alIndex, <br/> uint alLength </td><td class="col3"> Sorts elements in the array into descending order, affecting only the subsection at the given index to the given length. </td> </tr> <tr class="row13"> <td class="col0"> void </td><td class="col1"> reverse </td><td class="leftalign"> </td><td class="col3"> Reverses the order of elements in the array. </td> </tr> <tr class="row14"> <td class="col0"> int </td><td class="col1"> find </td><td class="col2"> const T &in aValue </td><td class="col3"> Returns the index of the first element in the array equal to the given value, or -1 if the value was not found. </td> </tr> <tr class="row15"> <td class="col0"> int </td><td class="col1"> find </td><td class="col2"> uint alIndex, <br/> const T &in aValue </td><td class="col3"> Returns the index of the first element in the array equal to the given value, or -1 if the value was not found. Only affects elements starting at the given index. </td> </tr> <tr class="row16"> <td class="col0"> void </td><td class="col1"> push_back </td><td class="col2"> const T &in aValue </td><td class="col3"> Inserts the given value at the end of the array. </td> </tr> <tr class="row17"> <td class="col0"> void </td><td class="col1"> push_front </td><td class="col2"> const T &in aValue </td><td class="col3"> Inserts the given value at the beginning of the array. </td> </tr> <tr class="row18"> <td class="col0"> void </td><td class="col1"> pop_back </td><td class="leftalign"> </td><td class="col3"> Removes the element at the end of the array. </td> </tr> <tr class="row19"> <td class="col0"> void </td><td class="col1"> pop_front </td><td class="leftalign"> </td><td class="col3"> Removes the element at the beginning of the array. </td> </tr> <tr class="row20"> <td class="col0"> uint </td><td class="col1"> size </td><td class="leftalign"> </td><td class="col3"> Returns the number of elements within the array. </td> </tr> </table> <span class='np_break'> </span> </div> </div> <h3>Remarks</h3> <div class="level3"> <p> The array class is unique in the HPL3 API in that it uses what is called a generic template. What this means is, when you create an array, you need to specify what variable type the array will be holding. This ensures that all objects within a given array are guaranteed to be of that type, eliminating the need for redundant conversions and type checks. </p> <p> To declare an array, you put the type the array will be holding between a less than operator ( < ) and a greater than operator ( > ). </p> <pre class="code =c++"><span class="co1">// An array of integers</span> array< int<span class="sy0">></span> mvIntegerArray<span class="sy0">;</span>   <span class="co1">// An array of floats</span> array< float<span class="sy0">></span> mvFloatArray<span class="sy0">;</span>   <span class="co1">// An array of strings</span> array< tString<span class="sy0">></span> mvStringArray<span class="sy0">;</span> </pre><p> </p> <p> There are a number of ways to add values to your array. The simplest way is to use the push_back function. This automatically puts the given value at the end of the array. </p> <pre class="code =c++">mvIntegerArray.<span class="me1">push_back</span><span class="br0">(</span><span class="nu0">5</span><span class="br0">)</span><span class="sy0">;</span> mvIntegerArray.<span class="me1">push_back</span><span class="br0">(</span><span class="nu0">2</span><span class="br0">)</span><span class="sy0">;</span> mvIntegerArray.<span class="me1">push_back</span><span class="br0">(</span><span class="nu0">11</span><span class="br0">)</span><span class="sy0">;</span>   <span class="co1">// The contents of mvIntegerArray: { 5, 2, 11 } </span> </pre><p> </p> <p> Another common way is to assign a value to an existing index within the array, using the square bracket ( [ ] ) syntax. (Indeces start at 0.) </p> <pre class="code =c++">mvIntegerArray<span class="br0">[</span><span class="nu0">0</span><span class="br0">]</span> <span class="sy0">=</span> <span class="nu0">29</span><span class="sy0">;</span> mvIntegerArray<span class="br0">[</span><span class="nu0">2</span><span class="br0">]</span> <span class="sy0">=</span> <span class="sy0">-</span><span class="nu0">12</span><span class="sy0">;</span>   <span class="co1">// The contents of mvIntegerArray: { 29, 2, -12 } </span> </pre><p> </p> <p> To retrieve an element from within the array, use the square bracket ([]) syntax with an integer index. </p> <pre class="code =c++"><span class="kw4">int</span> lIntValue <span class="sy0">=</span> mvIntegerArray<span class="br0">[</span><span class="nu0">0</span><span class="br0">]</span><span class="sy0">;</span>   <span class="co1">// The value of lIntvalue: 29 </span> </pre><p> </p> <p> Trying to assign a value to or retrieve a value from an index that does not exist in the array will result in an error. </p> <pre class="code =c++"><span class="co1">// If the index at [100] doesn't exist, both of these lines</span> <span class="co1">// of code will throw an error.</span> mvIntegerArray<span class="br0">[</span><span class="nu0">100</span><span class="br0">]</span> <span class="sy0">=</span> <span class="nu0">5</span><span class="sy0">;</span> <span class="kw4">int</span> lIntValue <span class="sy0">=</span> mvIntegerArray<span class="br0">[</span><span class="nu0">100</span><span class="br0">]</span><span class="sy0">;</span>   <span class="co1">// However, the following code will work just fine</span> mvIntegerArray.<span class="me1">resize</span><span class="br0">(</span><span class="nu0">101</span><span class="br0">)</span><span class="sy0">;</span> mvIntegerArray<span class="br0">[</span><span class="nu0">100</span><span class="br0">]</span> <span class="sy0">=</span> <span class="nu0">5</span><span class="sy0">;</span> <span class="kw4">int</span> lIntValue <span class="sy0">=</span> mvIntegerArray<span class="br0">[</span><span class="nu0">100</span><span class="br0">]</span><span class="sy0">;</span> </pre><p> </p> </div>