Script function

world.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.

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.

See Also ...

Topic

Information

Functions

(Debug) Displays debugging information about the world
(GetConnectDuration) Returns the number of seconds this world has been connected.
(GetEntity) Retrieves the value of an MXP server-defined entity
(GetHostAddress) Returns a list of IP addresses that correspond to a host name on the Internet
(GetHostName) Returns the host name that corresponds to an IP address on the Internet
(GetInfo) Gets information about the current world
(GetInternalCommandsList) Returns a list of the internal MUSHclient command names
(GetLineCount) Gets count of lines received
(GetLineInfo) Gets details about a specified line in the output window
(GetLinesInBufferCount) Returns the number of lines in the output window
(GetMainWindowPosition) Returns the position and size of the main MUSHclient window
(GetNotepadWindowPosition) Returns the position and size of the specified notepad window
(GetNotes) Gets the world's notes
(GetQueue) Returns a variant array which is a list of queued commands
(GetReceivedBytes) Returns the number of bytes received from the world
(GetRecentLines) Assembles a block of text from recent MUD output
(GetSelectionEndColumn) Returns the endling column of the selection in the output window
(GetSelectionEndLine) Returns the last line of the selection in the output window
(GetSelectionStartColumn) Returns the starting column of the selection in the output window
(GetSelectionStartLine) Returns the starting line of the selection in the output window
(GetSentBytes) Returns the number of bytes sent to the world
(GetStyleInfo) Gets details about a specified style run for a specified line in the output window
(GetSysColor) Gets the colour of various windows items
(GetSystemMetrics) Returns selected system information from Windows
(GetWorldID) Returns the 24-character ID of the current world
(GetWorldWindowPosition) Returns the position and size of the current world window
(GetWorldWindowPositionX) Returns the position and size of a specific world window
(GetXMLEntity) Retrieves the value of a standard entity
(IsConnected) Tests to see if the world is connected to the MUD server
(LogInput) The property of whether commands are logged to the log file
(SetChanged) Sets or clears the "document has changed" flag
(SetEntity) Sets the value of an MXP entity
(UdpPortList) Returns an array of all the UDP ports in use by this world
(Version) Gets the MUSHclient version string.
(WorldAddress) Returns the TCP/IP address of the current world.
(WorldName) Gets the world's name
(WorldPort) Returns the port number of the current world.

(Help topic: function=EchoInput)