FormActMain Class |
Namespace: Advanced_Combat_Tracker
public class FormActMain : Form
The FormActMain type exposes the following members.
Name | Description | |
---|---|---|
FormActMain | Initializes a new instance of the FormActMain class |
Name | Description | |
---|---|---|
ActColorSettings |
Contains controls that make up the ACT color options. Retrieve/change colors or subscribe to change events. (ForeColorSettingChanged)
| |
ActiveCustomTriggers |
Gets a list of Custom Triggers currently enabled
| |
ActiveZone |
The ZoneData object that represents the last zone an encounter was added to
| |
ActPlugins |
List of plugins shown in the UI. Call PluginsApplyOrderToUI() if modified. Avoid adding or removing entries, only reorder.
| |
AfterCombatActionDataLock |
While this object is locked, ACT will not add data to encounters. This may prevent an encounter from ending if there is data queued.
Usage:
lock(AfterCombatActionDataLock) { code here; }
| |
AppDataFolder |
ACT's application data folder for logs, config files, etc... %APPDATA%\Advanced Combat Tracker\
| |
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.
| |
CurrentZone | ||
CustomTriggers |
All current Custom Trigger Definitions
| |
DefaultPersonalTextFormat |
The text export format to use when there are no presets
| |
DefaultTextFormat |
The text export format to use when there are no presets
| |
DpiScale |
The scaling factor of the monitor that ACT is on
| |
EncDatabase | ||
GameMacroFolder |
The base folder where ACT generated macro exports should go. In EQ2 this is simply the base game folder.
| |
GlobalTimeSorter |
Used to sort log entries of the same timestamp and match up events with log lines in the View Logs window
| |
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().
| |
InitActDone |
Evaluates to true if ACT has finished initializing
| |
IoControlSets |
Contains the controls to be visible given a certain Node.FullPath of IoTreeView
| |
IoTreeView |
The TreeView for the Import/Export tab
| |
IsActClosing | ||
KnownActAssemblyNames |
ACT will warn the user if ACT's folder contains assemblies not on this list. This is to curtail the bad practice of putting plugins in the default search path.
| |
LastEstimatedTime |
The last known time by reading the time stamps of the log file plus the number of seconds since the last update
| |
LastHostileTime |
The last time SetEncounter was called by a parsing event.
| |
LastKnownTime |
The last known time by reading the time stamps of the log file
| |
LastLogLine | ||
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.
| |
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
| |
OptionsControlSets |
Contains the controls to be visible given a certain Node.FullPath of OptionsTreeView
| |
OptionsTreeView |
The TreeView for the Options tab
| |
OriginalLoglineCustomTriggers |
When enabled, the log lines passed to Custom Triggers are the original log lines instead of the version modified by plugins.
| |
OriginalLoglineViewLogs |
When enabled, the log lines appearing in View Logs are the original log lines instead of the version modified by plugins.
| |
Portable |
If ACT started in Portable mode and is trying to keep files out of %APPDATA%/%TEMP%
| |
ReadThreadLock |
Suspends log file reading of the currently open log file
| |
SnippetShareRegex |
Used to parse arbitrary log lines for XML snippet sharing. By default it follows a EQ2 specific format; should fail quickly otherwise.
| |
TemporaryFolder |
The temp folder that ACT uses. May be in %TEMP%.
| |
TextExportFormats |
A list of TextExportFormatOptions that ACT uses for text exports in mini-parse, clipboard exports, etc. Do NOT directly modify. Use AddTextFormat() / RemoveTextFormat()
| |
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.
| |
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 | ||
ZoneList |
Contains a list of ZoneData objects that exist in memory
|
Name | Description | |
---|---|---|
ActCommands |
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.
| |
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
| |
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
| |
AddEditCustomTrigger | ||
AddPluginPanel | ||
AddTextFormat |
Adds a new text export format to TextExportFormats and updates ACT's dropdown controls
| |
ChangeZone |
Change the current zone name and update history DB
| |
CondenseGCMemory | ||
CornerControlAdd |
Add a control to the upper-right corner of ACT. Avoid heights greater than 24px
| |
CornerControlRemove |
Remove a control reference from the corner controls layout
| |
CreateAssemblyReport | ||
CreateDamageString | ||
Dispose |
Clean up any resources being used.
(Overrides FormDispose(Boolean).) | |
EncDatabaseAdd | ||
EncountersToXml |
Outputs Encounters as XML CombatActions
| |
EndCombat |
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
| |
ExportControlChildrenText | ||
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)
| |
GetAttackTypeColumns |
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 |
Gets a list of column names(Usable in GetColumnByName()) for the Combatant view table
| |
GetCompanionFilePath |
Creates a file path of a Companion Log file given a Main Log file and Companion name
| |
GetDamageTypeDataColumns |
Gets a list of column names(Usable in GetColumnByName()) for the DamageType view table
| |
GetEncounterDataColumns |
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 | ||
GetTextExport(EncounterData, TextExportFormatOptions) |
Gets a text export of an encounter using formatters
| |
GetTextExport(Int32, Int32, TextExportFormatOptions) |
Gets a text export of an encounter using formatters
| |
GetTextExport(Int32, Int32, Int32) |
Gets a text export of an encounter using formatters
| |
GetTextExport(EncounterData, TextExportFormatOptions, Font, Int32) | ||
GetTextExport(Int32, Int32, TextExportFormatOptions, Font, Int32) | ||
GetTextExport(Int32, Int32, Int32, Font, Int32) |
Gets a text export of an encounter using formatters and column alignment
| |
GetVersion |
Gets the current version of ACT
| |
GetWindowRect | ||
ImportControlChilderenText | ||
ImportControlTextXML(Stream) |
Imports an XML stream to replace the Text property of controls in this Form
| |
ImportControlTextXML(String) |
Imports an XML file to replace the Text property of controls in this Form
| |
InvokeAddXmlShareToList | ||
LoadNewSettings | ||
LoadXmlRecords | ||
MakeAbsolutePathString |
Make an absolute path from a relative path and its reference path
| |
MakeRelativePathString |
Make a path relative to the given folder.
| |
MemCompressGZip |
Compresses an array of bytes with GZip
| |
MemDecompressGzip |
Uncompresses an array of bytes compressed with GZip
| |
NotificationAdd |
Add a notification to the main window Notifications tab
| |
OpenCompanionLogs | ||
OpenLog |
Aborts the current log reading thread and opens the log file specified in the LogFilePath property
| |
ParseRawLogLine |
Insert a log line into the parsing engine
You should increment GlobalTimeSorter if you expect this line to generate combat data
| |
PlayCommandSound |
Plays the sound configured in Options -> Sound -> Command sound
| |
PlayExportSound |
Plays the sound configured in Options -> Sound -> Export sound
| |
PlayMiscSound |
Plays the sound configured in Options -> Sound -> Misc sound
| |
PlaySound |
Plays a PCM wave file using the currently selected implementation in PlaySoundMethod.
| |
PlaySoundNull | ||
PlaySoundWinApi | ||
PlaySoundWmpApi | ||
PlayTtsDirect | ||
PlayTtsWavIntermediary | ||
PluginCornerControlAdd |
Add a control to the upper-right corner of the Plugin Listing tab. Avoid heights greater than 22px
| |
PluginCornerControlRemove |
Remove a control reference from the plugin corner controls layout
| |
PluginDownload |
Downloads a plugin file. May use WININET caching if requested more than once per ACT execution.
| |
PluginGetGithubApi |
Gets the GitHub API cache file of the plugin at advancedcombattracker.com (No rate limit)
If the plugin is not GitHub hosted, this will throw an exception.
The cache file is updated every 3 minutes if GitHub says it needs to be.
| |
PluginGetRemoteDateUtc |
Gets the DateTime of the plugin at advancedcombattracker.com
| |
PluginGetRemoteVersion |
Gets the version string of the plugin at advancedcombattracker.com
| |
PluginGetSelfData |
Gets the data about the current plugin instance
| |
PluginGetSelfDateUtc |
Gets the DateTime of the currently running plugin
| |
PluginsApplyOrderToUI |
Reads the ActPlugins List and reorders the GUI plugins page.
| |
PrintWindow(IntPtr) | ||
PrintWindow(IntPtr, IntPtr, Int32) | ||
RebuildActiveCustomTriggers | ||
RemoveTextFormat |
Remove a text export format from TextExportFormats and update ACT's dropdown controls
| |
ResetCheckLogs |
Resets the file watcher to use current settings and enables it if the associated checkbox allows.
| |
ResizeLVCols |
Resizes the columns on a ListView depending on the column header length and column content length
| |
RestartACT |
Prompts the user to restart ACT with a non-blocking message. (thread-safe)
| |
SaveXmlRecords | ||
SelectiveListAdd |
Add a player to the Selective Parsing list; checkmarked
| |
SelectiveListClear |
Completely clears the Seletive Parsing list
| |
SelectiveListGetMode |
Gets the currently configured Selective Parsing mode from Options
| |
SelectiveListGetSelected |
Determines if a combatant is in the Selective Parsing list and checkmarked
| |
SelectiveListRemove |
Remove a player from the Selective Parsing list; unchecking or removing
| |
SelectiveListUncheckAll |
Unchecks all combatants in the Selective Parsing list
| |
SendHtmlToClipboard |
Sends HTML formatted data to the clipboard in plain text format and CF_HTML format, which can be viewed with WYSIWYG applications.
| |
SendToClipboard |
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 |
Sends a text file to the EQ2 folder
| |
SetEncounter |
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 |
Sets the the text of the help panel in the Import/Export tab
| |
SetOptionsHelpText |
Sets the the text of the help panel in the Options tab
| |
TraySliderAdd |
Creates and returns a TraySlider on the UI thread with an OK button for 15 seconds and shows within 250ms
| |
TTS |
Performs Text to Speech using the currently selected implementation in PlayTtsMethod. (Default ACT implementation uses a intermediary WAV file to avoid buggy cutoffs during high CPU usage)
| |
UnblockFiles |
Scans a folder and subfolders for files with the downloaded zone identifier which might affect running code, then prompts the user to automatically unblock them
| |
UncachedFileSave(FileInfo, MemoryStream) |
Bypass Windows disk write caching to save a file. If the file exists, it will be deleted first. If the file destination file already contains the data, the entire operation is skipped.
| |
UncachedFileSave(FileInfo, MemoryStream, Boolean) |
Bypass Windows disk write caching to save a file. If the file exists, it will be deleted first.
| |
UnZip |
Unzips a file to a folder
| |
UpdateMiniEnc |
Immediately force an update to the Mini Window
| |
ValidateLists |
Makes sure that the ACT options pages list all of the available columns. (Drop down selectors)
| |
ValidateTableSetup |
Makes sure that the ACT options pages list all of the available columns. (Main table columns/sorters)
| |
WriteDebugLog |
Writes debugging information to the error log *if* ACT was started with the -debug switch.
| |
WriteExceptionLog |
Writes an exception to ACT's default error log
| |
WriteInfoLog |
Writes an informational message to the error log
| |
XmlToEncounters |
Parses an XML stream created by EncountersToXml()
| |
ZoneDatabaseAdd |
Name | Description | |
---|---|---|
ActLifecycleChanged |
Receives events for the different stages of ACT startup and when it initially starts to close
| |
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.
| |
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 is read. Parsing plugins should subscribe to this event. Plugins can change the log line before OnLogLineRead subscribers see it or before it is saved in View Logs or passed to the Custom Trigger engine.
| |
LogFileChanged |
When a different log file is opened by ACT; manually or automatically
| |
LogFileRenamed |
When a log file is renamed to an archive name, typically before the old filename is re-opened as blank
| |
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. May be modified by BeforeLogLineRead subscribers.
| |
UpdateCheckClicked |
Triggered when the user manually checks for ACT updates
| |
UrlRequest |
Handle a client requesting a URL from ACT's web interface
| |
XmlSnippetAdded |
Event for when ACT is instructed to add the data from an XML snippet (the XML data should be parsed and commited)
|
Name | Description | |
---|---|---|
GenerateAttackTypeGraph |
A replaceable method which will alter graphing of the main tab
| |
GenerateCombatantGraph |
A replaceable method which will alter graphing of the main tab
| |
GenerateDamageTypeGraph |
A replaceable method which will alter graphing of the main tab
| |
GenerateEncounterGraph |
A replaceable method which will alter graphing of the main tab
| |
GetDateTimeFromLog |
A replacable method that will parse the DateTime from a log line
| |
PlaySoundMethod |
A replacable method that will handle sound output. Save this to a local variable if you plan on restoring the ACT default later.
| |
PlayTtsMethod |
A replacable method that will handle Text to Speech. Save this to a local variable if you plan on restoring the ACT default later.
| |
WebIndexLinks |
A collection of links to display on the web server's index page
|