DiscardQueue
Script function

world.DiscardQueue

DOC_scripting Read about scripting

Type

Method

Summary

Discards the speed walk queue

Prototype

long DiscardQueue();

DOC_data_types View list of data type meanings

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

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

(Help topic: function=DiscardQueue)

DOC_contents Documentation contents page