[Home] [Downloads] [Search] [Help/forum]

LogNotes

Script function

world.LogNotes

Read about scripting

Type

Property

Summary

The property of whether notes are logged to the log file

Prototype

short LogNotes;

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

Logging

Functions

(CloseLog) Closes the log file
(FlushLog) Flushes the log file to disk
(IsLogOpen) Tests to see if a log file is open
(LogInput) The property of whether commands are logged to the log file
(LogOutput) The property of whether MUD output is logged to the log file
(LogSend) Sends a message to the MUD and logs it
(OpenLog) Opens a log file.
(WriteLog) Writes to the log file

(Help topic: function=LogNotes)

Documentation contents page


Search ...

Enter a search string to find matching documentation.

Search for:   

Quick links: MUSHclient. MUSHclient help. Forum shortcuts. Posting templates. Lua modules. Lua documentation.

Information and images on this site are licensed under the Creative Commons Attribution 3.0 Australia License unless stated otherwise.

[Home]


Written by Nick Gammon - 5K   profile for Nick Gammon on Stack Exchange, a network of free, community-driven Q&A sites   Marriage equality

Comments to: Gammon Software support
[RH click to get RSS URL] Forum RSS feed ( https://gammon.com.au/rss/forum.xml )

[Best viewed with any browser - 2K]    [Hosted at FutureQuest]