Advanced Combat Tracker Plugin API
FormActMain Class
NamespacesAdvanced_Combat_TrackerFormActMain
The main ACT form
Declaration Syntax
C#Visual Basic
public class FormActMain : Form
Public Class FormActMain
	Inherits Form
Members
All MembersConstructorsMethodsPropertiesFieldsEvents



IconMemberDescription
FormActMain(array<String>[]()[][])
Initializes a new instance of the FormActMain class

ActCommands(String)
Accepts text commands to perform specific functions. In EQ2, if someone were to type "/act end", the parser would split apart the resulting text and send "end" to this method.

ActiveCustomTriggers
Gets a list of Custom Triggers currently enabled

ActiveZone
The ZoneData object that represents the last zone an encounter was added to

ActPlugins
AddCombatAction(Int32, Boolean, String, String, String, Dnum, DateTime, Int32, String, String)
Runs the parsed data through the renaming checks(Data Correction tab), raises API events, notifies the Spell Timers window and adds the data to the current encounter

AddCombatAction(MasterSwing)
Runs the parsed data through the renaming checks(Data Correction tab), raises API events, notifies the Spell Timers window and adds the data to the current encounter

AddDamageToGraph(String, Int32) Obsolete.
AddEditCustomTrigger(CustomTrigger)
AddPluginPanel(String, Boolean)
AfterCombatAction
A parsed combat action after it is entered as data. Subscribing to this event shows the data in its final form. Changing the action now would yield no meaningful results.

AppDataFolder
ACT's application data folder for logs, config files, etc... %APPDATA%\Advanced Combat Tracker\

AtksToIng(String) Obsolete.
AtkToIng(String) Obsolete.
BeforeClipboardSet
BeforeCombatAction
A parsed combat action before it is entered as data. Subscribing to this event allows you to change parsed data in real time.

BeforeLogLineRead
Every time a log line passes through the parsing engine

ChangeZone(String)
Change the current zone name and update history DB

CharacterFileNameRegex
Regex used to determine the character's name from the log's file path. The character name will be set as the first capturing group.

CondenseGCMemory()()()()
ConfirmInquisitionPrecogRedirect()()()()
CurrentZone
CustomTriggers
All current Custom Trigger Definitions

Dispose(Boolean)
Clean up any resources being used.
(Overrides Form.Dispose(Boolean).)
EncDatabase
EncDatabaseAdd(HistoryRecord)
EncountersToXml(List<(Of <<'(EncounterData>)>>), Stream, Boolean)
Outputs Encounters as XML CombatActions

EndCombat(Boolean)
Sets the InCombat flag to false, ends the currently active encounters, updates their treeview labels, enters the data into the history database and if applicable runs the export functions

ExportControlChilderenText(XmlTextWriter, Control, String)
ExportControlTextXML(Stream)
Export the Text property of all Form controls to an XML stream

ExportControlTextXML(String)
Exports the Text property of all Form controls to an XML file (the -exportcontroltext switch for ACT can demonstrate this)

GameMacroFolder
The base folder where ACT generated macro exports should go. In EQ2 this is simply the base game folder.

GenerateAttackTypeGraph
A replacable method which will alter graphing of the main tab

GenerateCombatantGraph
A replacable method which will alter graphing of the main tab

GenerateDamageTypeGraph
A replacable method which will alter graphing of the main tab

GenerateEncounterGraph
A replacable method which will alter graphing of the main tab

GetAttackTypeColumns(Boolean)
Gets a list of column names(Usable in GetColumnByName()) for the AttackType view table

GetAutomaticUpdatesAllowed()()()()
Gets whether the user preferences allow ACT to automatically check for updates

GetCombatantDataColumns(Boolean)
Gets a list of column names(Usable in GetColumnByName()) for the Combatant view table

GetDamageTypeDataColumns(Boolean)
Gets a list of column names(Usable in GetColumnByName()) for the DamageType view table

GetDateTimeFromLog
A replacable method that will parse the DateTime from a log line

GetEncounterDataColumns(Boolean)
Gets a list of column names(Usable in GetColumnByName()) for the Encounter view table

GetGraphFillColors()()()()
Gets an array of Color structures defined by the Graph Color settings

GetPersonalTextExport(EncounterData, TextExportFormatOptions)
GetTextExport(Int32, Int32, Int32)
Gets a text export of an encounter using formatters

GetTextExport(Int32, Int32, Int32, Font, Int32)
Gets a text export of an encounter using formatters and column alignment

GetTextExport(Int32, Int32, TextExportFormatOptions)
Gets a text export of an encounter using formatters

GetTextExport(Int32, Int32, TextExportFormatOptions, Font, Int32)
GetTextExport(EncounterData, TextExportFormatOptions)
Gets a text export of an encounter using formatters

GetTextExport(EncounterData, TextExportFormatOptions, Font, Int32)
GetVersion()()()()
Gets the current version of ACT

GlobalTimeSorter
Used to sort log entries of the same timestamp and match up events with log lines in the View Logs window

ImportControlChilderenText(String, String, String, Boolean, Control)
ImportControlTextXML(String)
Imports an XML file to replace the Text property of controls in this Form

ImportControlTextXML(Stream)
Imports an XML stream to replace the Text property of controls in this Form

InCombat
If ACT thinks it is currently in active combat. It is a VERY bad idea to set this variable. Please allow it to be set by SetEncounter() and EndCombat().

IngToAtk(String) Obsolete.
InvokeAddXmlShareToList(Form, String)
IoControlSets
Contains the controls to be visible given a certain Node.FullPath of IoTreeView

IoTreeView
The TreeView for the Import/Export tab

LastEstimatedTime
The last known time by reading the time stamps of the log file plus the number of seconds since the last update

LastKnownTime
The last known time by reading the time stamps of the log file

LastLogLine
LcdButtonPressed
Handle a G15 LCD button press. You should only handle the event if you match the ModeString.

LcdCurrentMode
String representation of the currently visible LCD mode

LcdGetColorView(Bitmap, Int32)
Converts a bitmap to a G19 usable byte array. Optional scrolling.

LcdGetMonoView(Bitmap, Int32)
Converts a bitmap to a G15 usable byte array. Optional scrolling.

LcdRegisterMode(String)
Add a mode to the G15's LCD mode cycle

LcdUnregisterMode(String)
Remove a mode from the G15's LCD mode cycle

LcdUpdate
Handle an LCD update request. You should only handle the event if you match the ModeString.

LoadNewSettings(XmlTextReader)
LoadXmlRecords(String)
LogEncoding
The encoding ACT will open a log with. (Default is UTF8) If you change this value, you should call OpenLog() for it to take effect.

LogFileChanged
When a different log file is opened by ACT; manually or automatically

LogFileFilter
The file filter to use in order to find log files, such as "eq2log*.txt"

LogFileParentFolderName
The base logs folder name. This is used to determine if the folder one or more levels up is the base log folder or hidden through a UNC path share For example, the log file is C:\EQ2\Logs\Permafrost\eq2log_Aditu.txt If "Logs" is entered here, ACT will search all sub-folders of Logs for updated log files. In the case that the file path of the currently open file does not contain this value, like a UNC share path, ACT will not look farther than the current folder for log files.

LogFilePath
Currently used log file. To open a new log file, change this property and call OpenLog()

LogPathHasCharName
MainTreeView
The TreeView object of the main window. You should not navigate through the nodes to enumerate things as the node collection is populated dynamically as nodes are expanded

MemCompressGZip(array<Byte>[]()[][])
Compresses an array of bytes with GZip/DEFLATE

MemDecompressGzip(array<Byte>[]()[][])
Uncompresses an array of bytes compressed with GZip/DEFLATE

OnCombatEnd
When an active encounter is ended

OnCombatStart
When a new encounter is started, before any data is entered

OnLogLineRead
Every time a log line passes through the parsing engine

OpenLog(Boolean, Boolean)
Aborts the current log reading thread and opens the log file specified in the LogFilePath property

OptionsControlSets
Contains the controls to be visible given a certain Node.FullPath of OptionsTreeView

OptionsTreeView
The TreeView for the Options tab

ParseRawLogLine(Boolean, DateTime, String)
Insert a log line into the parsing engine You should increment GlobalTimeSorter if you expect this line to generate combat data

PlaySound(String)
Plays a PCM wave file

PlaySoundMethod
A replacable method that will handle sound output

PlaySoundNull(String, Int32)
PlaySoundWinApi(String, Int32)
PlaySoundWmpApi(String, Int32)
PlayTtsMethod
A replacable method that will handle Text to Speech

PluginDownload(Int32)
Downloads a plugin file

PluginGetRemoteDateUtc(Int32)
Gets the DateTime of the plugin at advancedcombattracker.com

PluginGetSelfData(IActPluginV1)
Gets the data about the current plugin instance

PluginGetSelfDateUtc(IActPluginV1)
Gets the DateTime of the currently running plugin

ReadThreadLock
Suspends log file reading of the currently open log file

RebuildActiveCustomTriggers()()()()
ResetCheckLogs()()()()
Resets the file watcher to use current settings and enables it if the associated checkbox allows.

ResizeLVCols(ListView)
Resizes the columns on a ListView depending on the column header length and column content length

SaveXmlRecords(String)
SelectiveListAdd(String)
Add a player to the Selective Parsing list; checkmarked

SelectiveListClear()()()()
Completely clears the Seletive Parsing list

SelectiveListGetSelected(String)
Determines if a combatant is in the Selective Parsing list and checkmarked

SelectiveListRemove(String, Boolean)
Remove a player from the Selective Parsing list; unchecking or removing

SelectiveListUncheckAll()()()()
Unchecks all combatants in the Selective Parsing list

SendHtmlToClipboard(String)
Sends HTML formatted data to the clipboard in plain text format and CF_HTML format, which can be viewed with WYSIWYG applications.

SendToClipboard(String, Boolean)
Sends text to the Windows Clipboard in three different ways, if any previous one fails. Also may send clipboard data to the ACT Clipboard Sharer if connected.

SendToMacroFile(String, String, String)
Sends a text file to the EQ2 folder

SetEncounter(DateTime, String, String)
This method ensures combat actions are sent to the correct encounter instance and sets the InCombat flag. It also checks the Selective Parsing list to see if the action should be entered into the encounter or ignored.

SetIoHelpText(String)
Sets the the text of the help panel in the Import/Export tab

SetOptionsHelpText(String)
Sets the the text of the help panel in the Options tab

SetParserToNull()()()() Obsolete.
SnippetShareRegex
Used to parse artbitrary log lines for XML snippet sharing. By default it follows a EQ2 specific format for efficiency.

TextExportFormats
TextExportFormatterCap1
The left mark that offsets a text export format variable such as '{' or '<format>'

TextExportFormatterCap2
The right mark that offsets a text export format variable such as '}' or '</format>'

TextExportFormatterRegex
This regex must split apart a text export formatting string into matches containing an export formatter or plain text If a match is a formatting variable, it must be put into the "formatter" capture group If a match is plain text, it must be put into the "text" capture group What is left and right of the "formatter" must be assigned to TextExportFormatterCap1 and TextExportFormatterCap2 respectively Default is: "{(?<formatter>[^}]+)}|(?<text>[^{]+)"

TimeStampLen
The number of characters the full timestamp takes from the beginning of the line until the first character of the rest of the line Include spaces.

TTS(String)
Uses Windows default Text to Speech engine to say something. This special implementation uses an intermedary WAV file to avoid buggy cutoffs during high CPU usage.

UnZip(String, String)
Unzips a file to a folder

UpdateCheckClicked
Triggered when the user manually checks for ACT updates

UpdateLcd(String, Boolean)
Raises an LCD update event

UpdateLcdStatus(String, Boolean)
Writes a timestamped message to the status area of the LCD options

UpdateMiniEnc()()()()
Immediately force an update to the Mini Window

UrlRequest
Handle a client requesting a URL from ACT's web interface

ValidateLists()()()()
ValidateTableSetup()()()()
WebIndexLinks
A collection of links to display on the web server's index page

WriteDebugLog(String)
Writes debugging information to the error log *if* ACT was started with the -debug switch.

WriteExceptionLog(Exception, String)
Writes an exception to ACT's default error log

WriteInfoLog(String)
Writes an informational message to the error log

XmlSnippetAdded
Event for when ACT is instructed to add the data from an XML snippet (the XML data should be parsed and commited)

XmlToEncounters(Stream)
Parses an XML stream created by EncountersToXml()

ZoneChangeRegex
The full Regex to detect zone changes within a log file. This is specifically used by a quick scan method to find the zone name without the normal parsing engine encountering the line.

ZoneDatabase
ZoneDatabaseAdd(HistoryRecord)
ZoneList
Contains a list of ZoneData objects that exist in memory

Inheritance Hierarchy
Object
MarshalByRefObject
 Component
  Control
   ScrollableControl
    ContainerControl
     Form
      FormActMain

Assembly: Advanced Combat Tracker (Module: Advanced Combat Tracker.exe) Version: 3.3.0.254