User Tools

Site Tools


array

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revisionPrevious revision
Next revision
Previous revision
array [2020/02/16 20:33] justinarray [2024/02/17 10:27] (current) justin
Line 5: Line 5:
  
 ====Examples:==== ====Examples:====
 +<code bauxite>
 +array["ITEM_0001", "ITEM_0005", "ITEM_0008"]
 +</code>
 +User-defined list of [[item]] IDs (e.g. from which to randomly pick an item for the player).
 +
 <code bauxite> <code bauxite>
 group["room_01"] group["room_01"]
Line 39: Line 44:
 </code> </code>
 List of integers from 5 to, but not including, 0, with an increment of -1 (i.e. 5, 4, 3, 2, 1). List of integers from 5 to, but not including, 0, with an increment of -1 (i.e. 5, 4, 3, 2, 1).
 +
 +=====Functions=====
 +The following functions can be used to manipulate or retrieve the values in an array.
 +^Name^Description^
 +|push_front(value)|Appends a value to the beginning of an array.|
 +|push_back(value)|Appends a value to the end of an array.|
 +|pop_front()|Removes and returns the first value of an array.|
 +|pop_back()|Removes and returns the last value of an array.|
 +|insert(index, value)|Inserts a value into an array at the specified index (starting at 0).|
 +|remove(index)|Removes a value from an array at the specified index (starting at 0).|
 +|erase(value)|Removes the first occurrence of the specified value from an array.|
 +|clear()|Removes all values from an array.|
 +|size()|Returns the number of items in an array.|
 +
 +====Examples:====
 +<code bauxite>
 +$my_array.push_front($my_value);
 +</code>
 +<code bauxite>
 +$my_array.push_back($my_value);
 +</code>
 +<code bauxite>
 +$first_value = $my_array.pop_front();
 +</code>
 +<code bauxite>
 +$last_value = $my_array.pop_back();
 +</code>
 +<code bauxite>
 +$my_array.insert(1, $my_value);
 +</code>
 +<code bauxite>
 +$my_array.remove(2);
 +</code>
 +<code bauxite>
 +$my_array.erase($my_value);
 +</code>
 +<code bauxite>
 +$my_array.clear();
 +</code>
 +<code bauxite>
 +$item_count = $my_array.size();
 +</code>
  
 ~~NOTOC~~ ~~NOTOC~~
array.1581914010.txt.gz · Last modified: 2020/02/16 20:33 by justin