Queue object

The Queue object allows you to access and modify messages currently queued for sending to Battle.net.

How to use

Example: Count how many items are in the queue.

Value = Queue.Count

Example: Clearing the queue.

Value = Quotes.Clear

Properties

List of properties

• .Count

Count property

Returns the total number of items in the queue.

Functions

List of functions and subs

• .Push(QueueObj object)
• .Pop
• .Peek
• .Item(Index)
• .ItemByID(MessageID)
• .RemoveLines(MatchStr)
• .RemoveItem(MessageID)
• .RemoveItemByID(MessageID)
• .Clear

Push function

Pushes the provided QueueObj object to the top of the message queue.

Peek function

Returns the QueueObj object on the top of the message queue.

Item function

Returns the QueueObj object at the provided index in the queue.

ItemByID function

Returns the QueueObj object at the provided id in the queue.

RemoveItem sub

Removes the QueueObj object from the provided index in the queue.

RemoveItemByID sub

Removes the QueueObj object from the provided id in the queue.

Clear sub

Clears the queue of all messages.

See also

• QueueObj object
• List of script objects