Journal - RazorEnhanced API

Journal.Clear(toBeRemoved)

Removes all matching entry from the Jorunal. Removes all entry from the Jorunal.

Parameters

toBeRemovedString

Return

Void

Journal.FilterText(text)

Store a string that if matched, will block journal message ( case insensitive )

Parameters

textString

Text to block. case insensitive, and will match if the incoming message contains the text

Return

Void

void

Journal.GetJournalEntry(afterTimestap)

Get a copy of all Journal lines as JournalEntry. The list can be filtered to include *only* most recent events. Get a copy of all Journal lines as JournalEntry. The list can be filtered to include *only* most recent events.

Parameters

afterTimestapJournal.JournalEntry Double

A JournalEntry object (default: null, no filter) Timestap as UnixTime, the number of seconds elapsed since 01-Jan-1970. (default: -1, no filter)

Return

List[Journal.JournalEntry]

List of JournalEntry List of JournalEntry

Journal.GetLineText(text, addname)

Search and return the most recent line Journal containing the given text. (case sensitive)

Parameters

textString

Text to search.

addnameBoolean

Prepend source name. (default: False)

Return

String

Return the full line - Empty string if not found.

Journal.GetSpeechName()

Get list of speakers.

Return

List[String]

List of speakers as text.

Journal.GetTextByColor(color, addname)

Returns all the lines present in the Journal for a given color.

Parameters

colorInt32

Color of the source.

addnameBoolean

Prepend source name. (default: False)

Return

List[String]

A list of Journal as lines of text.

Journal.GetTextByName(name, addname)

Returns all the lines present in the Journal for a given source name. (case sensitive)

Parameters

nameString

Name of the source.

addnameBoolean

Prepend source name. (default: False)

Return

List[String]

A list of Journal as lines of text.

Journal.GetTextBySerial(serial, addname)

Returns all the lines present in the Journal for a given serial.

Parameters

serialInt32

Serial of the source.

addnameBoolean

Prepend source name. (default: False)

Return

List[String]

A list of Journal as lines of text.

Journal.GetTextByType(type, addname)

Returns all the lines present in the Journal for a given type. (case sensitive)

Parameters

typeString

Regular System Emote Label Focus Whisper Yell Spell Guild Alliance Party Encoded Special

addnameBoolean

Prepend source name. (default: False)

Return

List[String]

A list of Journal as lines of text.

Journal.RemoveFilterText(text)

Remove a stored a string that if matched, would block journal message ( case insensitive )

Parameters

textString

Text to no longer block. case insensitive

Return

Void

void

Journal.Search(text)

Search in the Journal for the occurrence of text. (case sensitive)

Parameters

textString

Text to search.

Return

Boolean

True: Text is found - False: otherwise

Journal.SearchByColor(text, color)

Search in the Journal for the occurrence of text, for a given color. (case sensitive)

Parameters

textString

Text to search.

colorInt32

Color of the message.

Return

Boolean

True: Text is found - False: otherwise

Journal.SearchByName(text, name)

Search in the Journal for the occurrence of text, for a given source. (case sensitive)

Parameters

textString

Text to search.

nameString

Name of the source.

Return

Boolean

True: Text is found - False: otherwise

Journal.SearchByType(text, type)

Search in the Journal for the occurrence of text, for a given type. (case sensitive)

Parameters

textString

Text to search.

typeString

Regular System Emote Label Focus Whisper Yell Spell Guild Alliance Party Encoded Special

Return

Boolean

True: Text is found - False: otherwise

Journal.WaitByName(name, delay)

Pause script and wait for maximum amount of time, for a specific source to appear in Jorunal. (case sensitive)

Parameters

nameString

Name of the source.

delayInt32

Maximum pause in milliseconds.

Return

Boolean

Journal.WaitJournal(text, delay)

Pause script and wait for maximum amount of time, for a specific text to appear in Journal. (case sensitive)

Parameters

textString List[String]

Text to search.

delayInt32

Maximum pause in milliseconds.

Return

Boolean String

True: Text is found - False: otherwise