PushCommand
Script function

world.PushCommand

DOC_scripting Read about scripting

Type

Method

Summary

Pushes the current command into the command history list

Prototype

BSTR PushCommand();

DOC_data_types View list of 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 ...

Functions

FNC_GetCommand GetCommand (Gets the current command in the command window)
FNC_GetCommandList GetCommandList (Returns some or all commands from the command history)
FNC_SelectCommand SelectCommand (Selects (highlights) the current command in the command window)
FNC_SetCommand SetCommand (Sends text to the command window)

(Help topic: function=PushCommand)

DOC_contents Documentation contents page