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

Queue

Script function

world.Queue

Read about scripting

Type

Method

Summary

Queues a command for sending at the "speed walk" rate.

Prototype

long Queue(BSTR Message, boolean Echo);

View list of data type meanings

Description

Queues the supplied command for sending to the MUD at the designated "speed walk" rate. This is for sending commands slowly, because quick sending might be inappropriate.

If the speed walk delay (SpeedWalkDelay property) is zero, then using Queue is exactly the same as using Send.

If Echo is true then the commands are echoed to the output window (as they are sent, not as they are queued).

If the speed walk delay is not zero, then the supplied message is appended to the end of the command queue. The command is split up at line breaks (whenever a carriage-return/linefeed combination is found), and each line is sent, separated by a delay of SpeedWalkDelay milliseconds.

Periodically (every SpeedWalkDelay milliseconds) the command at the top of the command queue is retrieved and sent to the MUD, and echoed in the output window if required.

If you want to bypass the queue (eg. to say something) then use SendImmediate.


VBscript example

world.queue world.evaluatespeedwalk ("4n"), true


Jscript example

world.queue(world.evaluatespeedwalk("4n"), true);


PerlScript example

$world->queue($world->evaluatespeedwalk("4n"), true);


Python example

world.queue(world.evaluatespeedwalk("4n"), True)


Lua example

Queue (EvaluateSpeedwalk("4n"), true)


Lua notes

The echo flag is optional, and defaults to true.


Return value

eWorldClosed : The world is closed
eItemInUse : Cannot be called from within OnPluginSent script callback
eOK: Queued OK

View list of return code meanings

See Also ...

Functions

(DiscardQueue) Discards the speed walk queue
(EvaluateSpeedwalk) Evaluates a speed walk string
(GetQueue) Returns a variant array which is a list of queued commands
(Note) Sends a note to the output window
(Send) Sends a message to the MUD
(SendImmediate) Sends a message to the MUD immediately, bypassing the speedwalk queue
(SpeedWalkDelay) The number of milliseconds delay between speed walk commands

(Help topic: function=Queue)

Documentation contents page


Search ...

Enter a search string to find matching documentation.

Search for:   

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.

[Home]


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]