Script function

world.DiscardQueue

Type

Method

Summary

Discards the speed walk queue

Prototype

long DiscardQueue();

Description

Discards any commands queued up, to be sent at the speedwalk delay interval.

The return value is the number of commands discarded.

VBscript example

world.discardqueue

Jscript example

world.discardqueue();

PerlScript example

$world->discardqueue();

Python example

world.discardqueue

Lua example

DiscardQueue()

Return value

The number of commands discarded (might be zero).

See Also ...

Functions

(GetQueue) Returns a variant array which is a list of queued commands
(Queue) Queues a command for sending at the "speed walk" rate.
(SpeedWalkDelay) The number of milliseconds delay between speed walk commands

(Help topic: function=DiscardQueue)