world.EchoInput

MUSHclient script function (Property)

A flag to indicate whether we are echoing command input to the output window

Prototype

boolean EchoInput;

Data type meanings

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.

Return value

TRUE if echoing is enabled
FALSE if echoing is NOT enabled

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

Related topic

Information

See also