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

MUSHclient scripting

Description of MUSHclient world function: world.GetCommand


Name GetCommand
Type Method
Summary Gets the current command in the command window
Prototype BSTR GetCommand();

View list of data type meanings

Description

Returns the current contents of the command window, without changing it.

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


Note: Available in version 3.18 onwards.


VBscript example
world.Note world.GetCommand
Jscript example
world.Note (world.GetCommand ());
PerlScript example
$world->Note ($world->GetCommand ());
Python example
world.Note (world.GetCommand )
Lua example
Note (GetCommand ())
Returns The contents of the command window.
Introduced in version 3.18

See also ...

Function Description
GetCommandList Returns some or all commands from the command history
PushCommand Pushes the current command into the command history list
SelectCommand Selects (highlights) the current command in the command window
SetCommand Sends text to the command window

Search for script function

Enter a word or phrase in the box below to narrow the list down to those that match.

The function name, prototype, summary, and description are searched.

Search for:   

Leave blank to show all functions.


Return codes

Many functions return a "code" which indicates the success or otherwise of the function.

You can view a list of the return codes


Function prototypes

The "prototype" part of each function description lists exactly how the function is called (what arguments, if any, to pass to it).

You can view a list of the data types used in function prototypes


View all functions

[Back]

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]