HeroStats Libraries
StatsEngine Members

StatsEngine overview

Public Static (Shared) Properties

ProgramVersion Gets a string representation of the version number of this assembly
ShouldVersionCheck Gets a value indicating whether or not the application should perform an internet version check to see if the user is running the latest version of the engine.

Public Static (Shared) Methods

Equals (inherited from Object) Determines whether the specified Object instances are considered equal.
ReferenceEquals (inherited from Object) Determines whether the specified Object instances are the same instance.

Public Instance Constructors

StatsEngine Overloaded. Initializes a new instance of the StatsEngine class.

Public Instance Fields

Data The object used to hold the internal data for this object

Public Instance Properties

Container (inherited from Component) Gets the IContainer that contains the Component.
CurrentPendingBadges Gets the list of currently pending badges.
DebtTime Gets the number of seconds we have been playing under debt.
Dirty Gets a value indicating whether any internal data has changed.
Experience Gets or sets the amount of experienced gained since this object has been recording messages for the current hero.
FileName Gets or sets the file name to associate with the data contained in this object.
Item Returns the appropriate as requested
Loading Gets a value indicating if data is currently being read in a background thread
MessageCount Gets a value that is the current count of chat messages stored in memory
OfflineHero Gets or sets the data for the hero held in storage. Cannot be null.
Online Returns true if the scanner is currently accessing a City of Heroes client
OnlineHero Represents the hero that's currently logged in to the City of Heroes client.
Paused Gets a value indicating if the scanner is paused
Playtime Gets or sets the value of the number of seconds the user has been connected to a City of Heroes
ScannerError Gets the last error that the scanner reported.
Scanning Gets or sets the scanner's activity property.
Site (inherited from Component) Gets or sets the ISite of the Component.
TimerPaused Gets a value indicating whether the one-second game timer is paused or not
UncategorizedMessageCount Gets the number of messages that were detected that were not categorized into ChatMessage buckets.
UncategorizedMessages Gets a string containing a carriage return/linefeed (#13#10)-delimited list of messages that were captured from the City of Heroes client, but weren't able to be categorized.

Public Instance Methods

AddPendingBadge Adds a badge to the pending badge list, for later use in updating badges on the web.
ApplyConfig Applies the specified config entries
Clear Removes all stored data from this object, initializing it back to starting values.
CreateObjRef (inherited from MarshalByRefObject) Creates an object that contains all the relevant information required to generate a proxy used to communicate with a remote object.
Dispose (inherited from Component) Releases all resources used by the Component.
Equals (inherited from Object) Determines whether the specified Object is equal to the current Object.
Evaluate Evaluates an infix expression that returns a double
GetDetails Gets the timed data for the specified statistic
GetHashCode (inherited from Object) Serves as a hash function for a particular type, suitable for use in hashing algorithms and data structures like a hash table.
GetLifetimeService (inherited from MarshalByRefObject) Retrieves the current lifetime service object that controls the lifetime policy for this instance.
GetStatistic Gets the value of the named statistic
GetType (inherited from Object) Gets the Type of the current instance.
InitializeLifetimeService (inherited from MarshalByRefObject) Obtains a lifetime service object to control the lifetime policy for this instance.
InitializeWatchedStatistics Initializes custom statistics
IsSyntaxValid Evaluates the syntactical correctness of an arithmatic expression
Load Loads a file into the chat message datatable. Does not update the summarized statistics, since this is best done upstream at the caller ... there may be more than one file being loaded, and it would be a duplication of effort to create the statistics before all files are in.
LogInfoMessage Logs an informational message to the message log. The message will show up in the "HeroStats" channel.
RemovePendingBadges Removes a list of badges from the pending list.
Rescan Recalculates the statistics based on the chat messages currently in memory
Reset Returns the state of this object to its initial values
ResetExperience Zeroes out the value of experience gained.
ResetPlaytime Zeroes out the playtime clock.
ResetStatistic Zeroes out the value of a given statistic. Also clears out any details.
Save Saves this object to the specified file name
SaveStatisticOverloaded. Saves a statistic to in-memory storage
Suspend Suspends or resumes the scanner, optionally writing a message to the chat message store
TerminateRescan Stops the execution of a rescan
ToString (inherited from Component) 

Public Instance Events

Disposed (inherited from Component) Adds an event handler to listen to the Disposed event on the component.
OnBuffGiven Fired when a buff is detected to have been given by the current hero
OnBuffReceived Fired when a buff is detected to be applied to the current hero
OnBuffRemoved Fired when a buff expires on the current hero
OnDamageReceived Fired when the current hero receives damage
OnDataAcquisitionActive Fired when the scanner is resumed from a pause state
OnDataAcquisitionError Fired when the scanner experiences an error
OnDataAcquisitionInactive Fired when the scanner is paused
OnDataAcquisitionStart Fired when the scanner starts
OnDataAcquisitionStop Fired when the scanner is stopped
OnDefeat Fired when the current hero has been defeated
OnDetailDataChanged Fired when timed detail changes.
OnDetailDataCleared Fired when the timed detail data is cleared.
OnEffectStart Fired when an effect (i.e., hold, sleep or stun) has begun on the online hero.
OnEffectStop Fired when an effect (i.e., hold, sleep or stun) ends on the online hero.
OnFileLoad Fired when a file has been successfully loaded.
OnGameTimerTick Fired when the internal timer elapses.
OnHeroLogin Fired when a new hero is detected to have logged in
OnHeroLogout Fired when a hero is detected to have logged out
OnInspirationUsed Fired when the current hero uses an inspiration
OnLoadProgress Fired during loading of a text file or a Rescan
OnPetSummoned Fired when the current hero summons a pet
OnPointsGained Fired when the online hero gets experience, influence, or debt reduction
OnPowerActivated Fired when the current hero activates any power
OnPowerRecharge Fired when a power has been recharged.
OnRecalcDone Fired when a call to Rescan is finished.

See Also

StatsEngine Class | HeroStats.StatsEngine Namespace