Pop (Arraylist function): Difference between revisions
Jump to navigation
Jump to search
m (→Usage Notes) |
mNo edit summary |
||
| Line 6: | Line 6: | ||
</p> | </p> | ||
This function returns the current contents of the last item | This callable function returns the current contents of the last item | ||
in the method object Arraylist; then it removes that item. | in the method object Arraylist; then it removes that item. | ||
Revision as of 22:03, 4 January 2011
<section begin=dpl_desc/>Retrieve last Arraylist item, then remove item<section end=dpl_desc/>
Pop is a member of the Arraylist class.
This callable function returns the current contents of the last item in the method object Arraylist; then it removes that item.
Pop is available in Sirius Mods version 7.0 and later.
Syntax
%item = %arrayl:Pop
Syntax Terms
- %item
- A variable of the same type as specified on the %arrayl declaration to contain the contents of the last %arrayl item.
- %arrayl
- An Arraylist object.
Usage Notes
- The Pop method for object %arrayl is equivalent to specifying %arrayl:Item(%arrayl:Count) followed by %arrayl:RemoveItem(%arrayl:Count).
- LastItem returns the last item of an Arraylist without removing it. Dequeue returns the first item of an Arraylist, then removes it.
- The Push function, a synonym for Add, appends an item to an Arraylist.