Journal - Reetus/ClassicAssist GitHub Wiki

ClassicAssist Macro Commands

Generated on 12/15/2024 3:30:41 AM
Version: 4.425.22+b9a337759d26b9d39ae8ccaac75a36c4255be94a

Journal

ClearJournal

Method Signature:

Void ClearJournal()

Description:

Clear all journal texts.

Example:

ClearJournal()  

InJournal

Method Signature:

Boolean InJournal(System.String, System.String, Int32, Int32)

Parameters

  • text: String value - See description for usage.
  • author: String value - See description for usage. (Optional)
  • hue: Item Hue or -1 for any. (Optional)
  • timeout: Timeout specified in milliseconds. (Optional)

Description:

Check for a text in journal, optional source name.

Example:

if InJournal("town guards", "system"):  

WaitForJournal

Method Signature:

Boolean WaitForJournal(System.String, Int32, System.String, Int32)

Parameters

  • text: String value - See description for usage.
  • timeout: Timeout specified in milliseconds.
  • author: String value - See description for usage. (Optional)
  • hue: Item Hue or -1 for any. (Optional)

Description:

Wait the given timeout for the journal text to appear.

Example:

if WaitForJournal("town guards", 5000, "system"):  

WaitForJournal

Method Signature:

System.ValueTuple2[System.Nullable1[System.Int32],System.String] WaitForJournal(System.Collections.Generic.IEnumerable`1[System.String], Int32, System.String)

Parameters

  • entries: An array of strings.
  • timeout: Timeout specified in milliseconds.
  • author: String value - See description for usage. (Optional)

Description:

Wait up the given timeout for one of any of provided array of string to appear in journal

Example:

(idx, text) = WaitForJournal(['sex', 'drugs'], 5000)

if idx != None:
 print "Found text '{}' at index {}".format(text, idx)
else:
 print 'None of them were found :('