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

PushCommand

Script function

world.PushCommand

Read about scripting

Type

Method

Summary

Pushes the current command into the command history list

Prototype

BSTR PushCommand();

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.


Available in MUSHclient version 3.18 onwards.



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

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

(Help topic: function=PushCommand)

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]