world.LogNotes

MUSHclient script function (Property)

The property of whether notes are logged to the log file

Prototype

short LogNotes;

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.

Related topic

Logging

See also