Dequeue (Stringlist function): Difference between revisions
Jump to navigation
Jump to search
m (1 revision) |
m (syntax digram, tags and links) |
||
| Line 8: | Line 8: | ||
<table class="syntaxTable"> | <table class="syntaxTable"> | ||
<tr><th>%string</th> | <tr><th>%string</th> | ||
<td>This | <td>This string is to contain the contents of the first item in <var class="term">sl</var>. </td></tr> | ||
<tr><th>sl</th> | <tr><th>sl</th> | ||
<td>A <var>Stringlist</var> object.</td></tr> | <td>A <var>Stringlist</var> object.</td></tr> | ||
| Line 16: | Line 16: | ||
<ul> | <ul> | ||
<li>All errors in <var>Dequeue</var> result in request cancellation. | <li>All errors in <var>Dequeue</var> result in request cancellation. | ||
<li> | <li>See also:<ul><li><var>[[FirstItem (Stringlist function)|FirstItem]]</var> which returns the first item of a Stringlist without removing it.<li><var>[[Pop (Stringlist function)|Pop]]</var> which returns the last item of a <var>Stringlist</var>, then removes it.</ul> | ||
</ul> | </ul> | ||
[[Category:Stringlist methods|Dequeue function]] | [[Category:Stringlist methods|Dequeue function]] | ||
Revision as of 01:50, 26 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 string is to contain the contents of the first item in sl. |
|---|---|
| sl | A Stringlist object. |