Register forum user name Search FAQ

MUSHclient scripting

Description of MUSHclient world function: world.EchoInput


Name EchoInput
Type Property
Summary A flag to indicate whether we are echoing command input to the output window
Prototype boolean EchoInput;
Description

This property controls whether command input is echoed to the output window.

VBscript example
world.note world.EchoInput
world.EchoInput = vbTrue
world.EchoInput = vbFalse;
Jscript example
world.note(world.EchoInput);
world.EchoInput = true;
world.EchoInput = false;
PerlScript example
$world->note ($world->{EchoInput});
$world->{EchoInput} = false;
$world->{EchoInput} = true;
Python example
world.note(world.EchoInput)
world.EchoInput = True
world.EchoInput = False
Lua example
Note (GetEchoInput ())
SetEchoInput  (true)
SetEchoInput  (false)
Lua notes
Lua implements this as two functions:

GetEchoInput - gets the echo input flag
SetEchoInput - sets the echo input flag

When setting the flag the flag is optional and defaults to true.
Returns TRUE if echoing is enabled
FALSE if echoing is NOT enabled

Note: TRUE is a non-zero value, FALSE is the value 0.

See also ...

Function Description
LogInput The property of whether commands are logged to the log file

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]

Information and images on this site are licensed under the Creative Commons Attribution 3.0 Australia License unless stated otherwise.