world.PushCommand

MUSHclient script function (Method) — introduced in version 3.18

Pushes the current command into the command history list

Prototype

BSTR PushCommand();

Data type meanings

Description

Pushes the current contents of the command window into the command history list, and then blanks the current command.

You could use this prior to doing SetCommand, as SetCommand will not work with a command in the command window.

This function returns the text of the command that was in the command window, in case you want to restore it later.

If more than one window is open for this world, it uses the first window in the window list.

VBscript example

world.PushCommand

Jscript example

world.PushCommand ();

PerlScript example

$world->PushCommand ();

Python example

world.PushCommand

Lua example

PushCommand ()

Return value

The original contents of the command window.

See also

FunctionDescription
GetCommandGets the current command in the command window
GetCommandListReturns some or all commands from the command history
SelectCommandSelects (highlights) the current command in the command window
SetCommandSends text to the command window