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

MUSHclient scripting

Description of MUSHclient world function: world.SetCommand


Name SetCommand
Type Method
Summary Sends text to the command window
Prototype long SetCommand(BSTR Message);

View list of data type meanings

Description

This lets you send text to the command window. It will only act if the command window is currently empty (to avoid wiping out something you are typing).

Because of this you cannot test "setcommand" by typing it into the command window, because by definition, the command window will not be empty (it will have the "setcommand" in it). You must do it from a script, or an immediate window.

VBscript example
world.SetCommand "think Here is another command"
Jscript example
world.SetCommand("think Here is another command");
PerlScript example
$world->SetCommand("think Here is another command");
Python example
world.SetCommand("think Here is another command")
Lua example
SetCommand ("think Here is another command")
Returns eCommandNotEmpty : Command area was not empty
eOK: Set OK

View list of return code meanings


See also ...

Function Description
Note Sends a note to the output window
PasteCommand Pastes text into the command window, replacing the current selection
Send Sends a message to the MUD
SetCommandSelection Selects specified columns in 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]