Pop (Arraylist function): Difference between revisions

From m204wiki
Jump to navigation Jump to search
mNo edit summary
 
(22 intermediate revisions by 5 users not shown)
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]]
This [[Notation conventions for methods#Callable functions|callable]] function returns the current contents of the last item in the method object <var>Arraylist</var>; then it removes that item.
<!--DPL?? Category:Arraylist methods|Pop function: Retrieve last Arraylist item, then remove item-->
 
<p>
==Syntax==
Pop is a member of the [[Arraylist class]].
{{Template:Arraylist:Pop syntax}}
===Syntax terms===
<table class="syntaxTable">
<tr><th>%item</th>
<td>An, optional, variable of the same type as specified on the <var class="term">al</var> declaration to contain the contents of the last <var class="term">al</var> item. </td></tr>
<tr><th>al</th>
<td>An <var>Arraylist</var> object.</td></tr>
</table>
 
==Usage notes==
<ul>
<li>The <var>Pop</var> method for object <var class="term">al</var> is equivalent to specifying the following code fragment:
<p class="code"><var class="term">al</var>:<var>[[Item (Arraylist property)|Item]]</var>(<var class="term">al</var>:<var>[[Count (Arraylist property)|Count]]</var>)
<var class="term">al</var>:<var>[[RemoveItem (Arraylist function)|RemoveItem]]</var>(<var class="term">al</var>:Count)
</p>
</p>


This callable function returns the current contents of the last item
<li><var>Pop</var> is available in <var class="product">[[Sirius Mods|Sirius Mods]]</var> Version 7.0 and later.
in the method object Arraylist; then it removes that item.
</ul>
 
Pop is available in ''Sirius Mods'' version 7.0 and later.
===Syntax===
  %item = %arrayl:Pop
====Syntax Terms====
<dl>
<dt><i>%item</i>
<dd>A variable of the same
type as specified on the ''%arrayl'' declaration
to contain the contents of the last ''%arrayl'' item.
<dt><i>%arrayl</i>
<dd>An Arraylist object.


</dl>
==See also==
===Usage Notes===
<ul>
<ul>
<li>The Pop method for object %arrayl is equivalent to
<li><var>[[LastItem (Arraylist property)|LastItem]]</var> returns the last item of an <var>Arraylist</var> without removing it.
specifying <tt>%arrayl:[[Item (Arraylist property)|Item]](%arrayl:Count)</tt>
<li><var>[[Dequeue (Arraylist function)|Dequeue]]</var> returns the first item of an <var>Arraylist</var>, then removes it.
followed by <tt>%arrayl:[[RemoveItem (Arraylist function)|RemoveItem]](%arrayl:Count)</tt>.
<li><var>[[Push (Arraylist function)|Push]]</var>, a synonym for Add, appends an item to an <var>Arraylist</var>.
<li>[[LastItem (Arraylist property)|LastItem]]
returns the last item of an Arraylist without removing it.
[[Dequeue (Arraylist function)|Dequeue]]
returns the first item of an Arraylist, then removes it.
<li>The [[Push (Arraylist function)|Push]] function, a synonym for Add,
appends an item to an Arraylist.
</ul>
</ul>
{{Template:Arraylist:Pop footer}}

Latest revision as of 16:17, 1 November 2012

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

This callable function returns the current contents of the last item in the method object Arraylist; then it removes that item.

Syntax

[%item =] al:Pop

Syntax terms

%item An, optional, variable of the same type as specified on the al declaration to contain the contents of the last al item.
al An Arraylist object.

Usage notes

  • The Pop method for object al is equivalent to specifying the following code fragment:

    al:Item(al:Count) al:RemoveItem(al:Count)

  • Pop is available in Sirius Mods Version 7.0 and later.

See also

  • LastItem returns the last item of an Arraylist without removing it.
  • Dequeue returns the first item of an Arraylist, then removes it.
  • Push, a synonym for Add, appends an item to an Arraylist.
Retrieved from "https://m204wiki.rocketsoftware.com/index.php?title=Pop_(Arraylist_function)&oldid=14745"