Journal

The Journal class provides access to the message Journal.

Table of Contents

Methods

Clear

Syntax: Journal.Clear(toBeRemoved)

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

Parameters:
  • toBeRemoved (String)
Returns: Void

FilterText

Syntax: Journal.FilterText(text)

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

Parameters:
  • text (String): Text to block. case insensitive, and will match if the incoming message contains the text
Returns: Void

GetJournalEntry

Syntax: 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:
  • afterTimestap (Double): Timestamp as UnixTime, the number of seconds elapsed since 01-Jan-1970. (default: -1, no filter)
Returns: List[Journal.JournalEntry]

GetLineText

Syntax: Journal.GetLineText(text, addname)

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

Parameters:
  • text (String): Text to search.
  • addname (Boolean): Prepend source name. (default: False)
Returns: String

GetSpeechName

Syntax: Journal.GetSpeechName()

Get list of speakers.

Returns: List[String]

GetTextByColor

Syntax: Journal.GetTextByColor(color, addname)

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

Parameters:
  • color (Int32): Color of the source.
  • addname (Boolean): Prepend source name. (default: False)
Returns: List[String]

GetTextByName

Syntax: Journal.GetTextByName(name, addname)

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

Parameters:
  • name (String): Name of the source.
  • addname (Boolean): Prepend source name. (default: False)
Returns: List[String]

GetTextBySerial

Syntax: Journal.GetTextBySerial(serial, addname)

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

Parameters:
  • serial (Int32): Serial of the source.
  • addname (Boolean): Prepend source name. (default: False)
Returns: List[String]

GetTextByType

Syntax: Journal.GetTextByType(type, addname)

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

Parameters:
  • type (String): Regular System Emote Label Focus Whisper Yell Spell Guild Alliance Party Encoded Special
  • addname (Boolean): Prepend source name. (default: False)
Returns: List[String]

RemoveFilterText

Syntax: Journal.RemoveFilterText(text)

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

Parameters:
  • text (String): Text to no longer block. case insensitive
Returns: Void

Search

Syntax: Journal.Search(text)

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

Parameters:
  • text (String): Text to search.
Returns: Boolean

SearchByColor

Syntax: Journal.SearchByColor(text, color)

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

Parameters:
  • text (String): Text to search.
  • color (Int32): Color of the message.
Returns: Boolean

SearchByName

Syntax: Journal.SearchByName(text, name)

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

Parameters:
  • text (String): Text to search.
  • name (String): Name of the source.
Returns: Boolean

SearchByType

Syntax: Journal.SearchByType(text, type)

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

Parameters:
  • text (String): Text to search.
  • type (String): Regular System Emote Label Focus Whisper Yell Spell Guild Alliance Party Encoded Special
Returns: Boolean

WaitByName

Syntax: Journal.WaitByName(name, delay)

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

Parameters:
  • name (String): Name of the source.
  • delay (Int32): Maximum pause in milliseconds.
Returns: Boolean

WaitJournal

Syntax: Journal.WaitJournal(text, delay)

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

Parameters:
  • text (String): Text to search.
  • delay (Int32): Maximum pause in milliseconds.
Returns: String, Boolean