LogNotes
Script function

world.LogNotes

DOC_scripting Read about scripting

Type

Property

Summary

The property of whether notes are logged to the log file

Prototype

short LogNotes;

DOC_data_types View list of data type meanings

Description

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

VBscript example

world.lognotes = 1   ' log notes
world.lognotes = 0   ' don't log notes
world.note world.lognotes  ' display whether notes are logged


Jscript example

world.lognotes = 1;   // log notes
world.lognotes = 0;   // don't log notes
world.note(world.lognotes);  // display whether notes are logged


PerlScript example

$world->{lognotes} = 1;   # log notes
$world->{lognotes} = 0;   # don't log notes
$world->note($world->{lognotes});  # display whether notes are logged


Python example

world.lognotes = 1   # log notes
world.lognotes = 0   # don't log notes
world.note(world.lognotes)  # display whether notes are logged


Lua example

SetLogNotes (true)   -- log notes
SetLogNotes (false)   -- don't log notes
Note(GetLogNotes ())  -- display whether notes are logged


Lua notes

Lua implements this as two functions:

GetLogNotes - gets whether notes are logged
SetLogNotes - sets whether notes are logged

The argument is optional, and defaults to true.


Return value

This is a property. You can use it to find whether notes are currently logged.



See Also ...

Topic

DOC_logging Logging

Functions

FNC_CloseLog CloseLog (Closes the log file)
FNC_FlushLog FlushLog (Flushes the log file to disk)
FNC_IsLogOpen IsLogOpen (Tests to see if a log file is open)
FNC_LogInput LogInput (The property of whether commands 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=LogNotes)

DOC_contents Documentation contents page