Difference between revisions of "Journal"

From OpenEUO
Jump to: navigation, search
m (See Also)
Line 1: Line 1:
''journal partially implemented, but undocumented. See Kal In Ex's journal subroutines for a working alternative.''
+
== Calling Pattern ==
 +
Call
 +
local j = sl.journal()
 +
Results
 +
j is a journal closure
 +
 
 +
== Closure Methods ==
 +
 
 +
* [[journal.clear]]
 +
* [[journal.count]]
 +
* [[journal.line]]
 +
* [[journal.mark]]
 +
* [[journal.nextln]]
 +
* [[journal.nextline]]
 +
* [[journal.refresh]]
 +
 
 +
 
 +
* [[journal.find]]
 +
* [[journal.findcolor]]
 +
* [[journal.gmatch]]
 +
* [[journal.gmatchcolor]]
 +
* [[journal.gsub]]
 +
* [[journal.gsubcolor]]
 +
* [[journal.match]]
 +
* [[journal.matchcolor]]
 +
* [[journal.sub]]
 +
* [[journal.subcolor]]
 +
 
 +
== Example ==
 +
 
 +
== Description ==
 +
 
 +
Use journal to generate a journal tracking/searching object.  Journal takes no arguments and returns a closure with numerous methods simplifying journal access.  All methods work on a passive internal copy of the UO journal, with the exception of [[journal.refresh|refresh]], [[journal.nextline|nextline]], and [[journal.clear|clear]].  Those all cause the internal copy of the journal to be updated with new data from the associated client journal.  For more information, see the associated member methods.
 +
 
 +
''Journal is inspired by and partially modeled upon Kal In Ex's journal library.''
  
 
== See Also ==
 
== See Also ==
Line 5: Line 39:
 
* [http://www.easyuo.com/openeuo/wiki/index.php/Simplelib simplelib]
 
* [http://www.easyuo.com/openeuo/wiki/index.php/Simplelib simplelib]
  
* [[Spin]]
+
* [[keymon]]
 +
 
 +
* [[journal.nextline]]
 +
 
 +
* [[journal.refresh]]
 +
 
 +
* [[machine]]
 +
 
 +
* [[spin]]
 +
 
 +
* [[str]]
  
* [[Str]]
+
* [http://www.easyuo.com/openeuo/wiki/index.php/Documentation#String_Functions string]

Revision as of 17:20, 8 January 2011

Calling Pattern

Call

local j = sl.journal()

Results

j is a journal closure

Closure Methods


Example

Description

Use journal to generate a journal tracking/searching object. Journal takes no arguments and returns a closure with numerous methods simplifying journal access. All methods work on a passive internal copy of the UO journal, with the exception of refresh, nextline, and clear. Those all cause the internal copy of the journal to be updated with new data from the associated client journal. For more information, see the associated member methods.

Journal is inspired by and partially modeled upon Kal In Ex's journal library.

See Also