world.LogInput

MUSHclient script function (Property)

The property of whether commands are logged to the log file

Prototype

short LogInput;

Data type meanings

Description

Set to 1 to log commands to the log file, 0 to not log

VBscript example

world.loginput = 1   ' log input
world.loginput = 0   ' don't log input
world.note world.loginput  ' display whether input is logged

Jscript example

world.loginput = 1;   // log input
world.loginput = 0;   // don't log input
world.note(world.loginput);  // display whether input is logged

PerlScript example

$world->{loginput} = 1;   # log input
$world->{loginput} = 0;   # don't log input
$world->note($world->{loginput});  # display whether input is logged

Python example

world.loginput = 1   # log input
world.loginput = 0   # don't log input
world.note(world.loginput)  # display whether input is logged

Lua example

SetLogInput (true)   -- log input
SetLogInput (false)   -- don't log input
Note(GetLogInput ())  -- display whether input is logged

Lua notes

Lua implements this as two functions:

GetLogInput- gets whether input is logged
SetLogInput- sets whether input is logged

The argument is optional, and defaults to true.

Return value

This is a property. You can use it to find whether commands (your input) are currently logged.

Related topic

Logging

See also

FunctionDescription
EchoInputA flag to indicate whether we are echoing command input to the output window
LogNotesThe property of whether notes are logged to the log file
LogOutputThe property of whether MUD output is logged to the log file