Dequeue (Stringlist function)

From m204wiki
Jump to navigation Jump to search

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.


[%string =] sl:Dequeue

Syntax terms

%string This string 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.
  • Dequeue is available in Sirius Mods version 7.0 and later.

See also

  • FirstItem, which returns the first item of a Stringlist without removing it.
  • Pop, which returns the last item of a Stringlist, then removes it.