LogInput
Script function

world.LogInput

DOC_scripting Read about scripting

Type

Property

Summary

The property of whether commands are logged to the log file

Prototype

short LogInput;

DOC_data_types View list of 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.



See Also ...

Topic

DOC_logging Logging

Functions

FNC_CloseLog CloseLog (Closes the log file)
FNC_EchoInput EchoInput (A flag to indicate whether we are echoing command input to the output window)
FNC_FlushLog FlushLog (Flushes the log file to disk)
FNC_IsLogOpen IsLogOpen (Tests to see if a log file is open)
FNC_LogNotes LogNotes (The property of whether notes are logged to the log file)
FNC_LogOutput LogOutput (The property of whether MUD output is logged to the log file)
FNC_LogSend LogSend (Sends a message to the MUD and logs it)
FNC_OpenLog OpenLog (Opens a log file.)
FNC_WriteLog WriteLog (Writes to the log file)

(Help topic: function=LogInput)

DOC_contents Documentation contents page