[Home] [Downloads] [Search] [Help/forum]

MUSHclient scripting

Description of MUSHclient world function: world.GetQueue

Name GetQueue
Type Method
Summary Returns a variant array which is a list of queued commands
Prototype VARIANT GetQueue();

View list of data type meanings


Returns an array of the currently queued commands (speedwalks etc.).

You might use this if you needed to do something urgently. Retrieve the queue into an array, discard the queue, and then requeue it.

Note: Available in version 3.18 onwards.

VBscript example
dim speedwalkQueue

  speedwalkQueue = world.GetQueue

  If Not IsEmpty (speedwalkQueue) Then
    For Each sw In speedwalkQueue 
       world.note sw

  End If
Jscript example
commandList = new VBArray(world.GetQueue()).toArray();

 if (commandList) 
   for (i = 0; i < commandList.length; i++)
       world.note (commandList [i]);
PerlScript example
foreach $item (Win32::OLE::in ($world->GetQueue ()))
Python example
commandList = world.GetQueue
if (commandList):
  for c in commandList : world.Note (c)
Lua example
for k, v in pairs (GetQueue()) do 
  Note (v) 
Returns If there are no commands in the queue then the return value is empty. Use "IsEmpty" to test for this possibility.

Otherwise, it returns a variant array containing all queued commands. Use "ubound" to find the number of commands in the list.
Introduced in version 3.18

See also ...

Function Description
DiscardQueue Discards the speed walk queue
Queue Queues a command for sending at the "speed walk" rate.
SpeedWalkDelay The number of milliseconds delay between speed walk commands

Search for script function

Enter a word or phrase in the box below to narrow the list down to those that match.

The function name, prototype, summary, and description are searched.

Search for:   

Leave blank to show all functions.

Return codes

Many functions return a "code" which indicates the success or otherwise of the function.

You can view a list of the return codes

Function prototypes

The "prototype" part of each function description lists exactly how the function is called (what arguments, if any, to pass to it).

You can view a list of the data types used in function prototypes

View all functions


Quick links: MUSHclient. MUSHclient help. Forum shortcuts. Posting templates. Lua modules. Lua documentation.

Information and images on this site are licensed under the Creative Commons Attribution 3.0 Australia License unless stated otherwise.


Written by Nick Gammon - 5K   profile for Nick Gammon on Stack Exchange, a network of free, community-driven Q&A sites   Marriage equality

Comments to: Gammon Software support
[RH click to get RSS URL] Forum RSS feed ( https://gammon.com.au/rss/forum.xml )

[Best viewed with any browser - 2K]    [Hosted at FutureQuest]