Dequeue (Stringlist function): Difference between revisions
Jump to navigation
Jump to search
m (1 revision) |
m (1 revision) |
||
| Line 1: | Line 1: | ||
{{Template:Stringlist:Dequeue subtitle}} | {{Template:Stringlist:Dequeue subtitle}} | ||
This callable method returns the current contents of the first item in the method object <var>Stringlist</var>, then it removes that first item. Dequeue is available in <var class=product>Sirius Mods</var> version 7.0 and later. | This callable method returns the current contents of the first item in the method object <var>Stringlist</var>, then it removes that first item. <var>Dequeue</var> is available in <var class=product>Sirius Mods</var> version 7.0 and later. | ||
==Syntax== | ==Syntax== | ||
| Line 15: | Line 15: | ||
==Usage notes== | ==Usage notes== | ||
<ul> | <ul> | ||
<li>All errors in Dequeue result in request cancellation. | <li>All errors in <var>Dequeue</var> result in request cancellation. | ||
<li>The [[FirstItem (Stringlist function)]] returns the first item of a Stringlist without removing it. The [[Pop (Stringlist function)]] returns the last item of a <var>Stringlist</var>, then removes it. | <li>The [[FirstItem (Stringlist function)]] returns the first item of a Stringlist without removing it. The [[Pop (Stringlist function)]] returns the last item of a <var>Stringlist</var>, then removes it. | ||
</ul> | </ul> | ||
[[Category:Stringlist methods|Dequeue function]] | [[Category:Stringlist methods|Dequeue function]] | ||
Revision as of 16:12, 19 January 2011
Retrieve value of first Stringlist item, then remove item (Stringlist class)
This callable method returns the current contents of the first item in the method object Stringlist, then it removes that first item. Dequeue is available in Sirius Mods version 7.0 and later.
Syntax
[%string =] sl:Dequeue
Syntax terms
| %string | This longstring is to contain the contents of the first item in %sl. |
|---|---|
| sl | A Stringlist object. |
Usage notes
- All errors in Dequeue result in request cancellation.
- The FirstItem (Stringlist function) returns the first item of a Stringlist without removing it. The Pop (Stringlist function) returns the last item of a Stringlist, then removes it.