Dequeue (Stringlist function): Difference between revisions
Jump to navigation
Jump to search
m (1 revision) |
m (1 revision) |
||
| Line 8: | Line 8: | ||
{{Template:Stringlist:Dequeue syntax}} | {{Template:Stringlist:Dequeue syntax}} | ||
===Syntax terms=== | ===Syntax terms=== | ||
< | <table class="syntaxTable"> | ||
< | <tr><th>%string </th> | ||
< | <td>This longstring is to contain the contents of the first item in '''%sl'''. </td></tr> | ||
< | <tr><th>sl </th> | ||
< | <td>A Stringlist object.</td></tr> | ||
</ | </table> | ||
==Usage notes== | ==Usage notes== | ||
Revision as of 21:03, 16 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.
Dequeue is a member of the Stringlist class.
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.