Pop (Arraylist function): Difference between revisions

From m204wiki
Jump to navigation Jump to search
mNo edit summary
mNo edit summary
Line 1: Line 1:
<span style="font-size:120%; color:black"><b><section begin=dpl_desc/>Retrieve last Arraylist item, then remove item<section end=dpl_desc/></b></span>
{{Template:Arraylist:Pop subtitle}}
[[Category:Arraylist methods|Pop function]]
[[Category:Arraylist methods|Pop function]]
<!--DPL?? Category:Arraylist methods|Pop function: Retrieve last Arraylist item, then remove item-->
<!--DPL?? Category:Arraylist methods|Pop function: Retrieve last Arraylist item, then remove item-->
Line 10: Line 10:


Pop is available in ''Sirius Mods'' version 7.0 and later.
Pop is available in ''Sirius Mods'' version 7.0 and later.
===Syntax===
==Syntax==
  %item = %arrayl:Pop
{{Template:Arraylist:Pop syntax}}
====Syntax Terms====
===Syntax terms===
<dl>
<dl>
<dt><i>%item</i>
<dt><i>%item</i>
Line 22: Line 22:


</dl>
</dl>
===Usage Notes===
==Usage notes==
<ul>
<ul>
<li>The Pop method for object %arrayl is equivalent to
<li>The Pop method for object %arrayl is equivalent to

Revision as of 23:27, 19 January 2011

Retrieve last Arraylist item, then remove item (Arraylist class)

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 =] al: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.