HeroStats Libraries
ChatMessage Members

ChatMessage overview

Public Static (Shared) Fields

ADMIN_CHANNEL_AND_CATEGORY The textual name of the administrative channel and the administrative category
LOGGING_CHANNEL_AND_CATEGORY The textual name of the logging category
START_TIMER_MESSAGE_TEXT The text of the Message portion of the ChatMessage that is created when the update timer is started
STOP_TIMER_MESSAGE_TEXT The text of the Message portion of the ChatMessage that is created when the update timer is stopped

Public Static (Shared) Properties

UseLegacyMessages Gets or sets the legacy message use setting.
StopTimerMessage A static message indicating that the timer has stopped and no messages are being logged.
StartTimerMessage A static message indicating that the timer has started and messages are being logged.
MessageFileName The name of the chat message file (including path).

Public Static (Shared) Methods

Initialize Initializes the chat message subsystem. Loads ChatMessageRegexs.dat, among other things.
Reinitialize Resets the chat message subsystem, reloading ChatMessageRegexs.dat
ResetUseCount Resets the use count for all chat messages.
StripHighlights Removes pseudo-html markup from the text passed in as the parameter. Removes only <H%gt; and %lt;/H> tags.
WriteScanningTracking Writes a debug message about message scanning performance.

Public Instance Constructors

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

Public Instance Properties

BuffArea Returns the buff area portion of the timer config for this chat message (if any).
BuffStackability Returns the buff stackability portion of the timer config for this chat message (if any).
BuffTime Returns the buff time portion of the timer config for this chat message (if any).
Category The HeroStats category to which this message applies
Channel Gets the channel the message arrived on
HighlightedMessage A pseudo-html formatted message highlighting with <H> and </H> surrounding the captured values
Item Looks up the key text in the capture variable name-value list and returns the associated value text
Message Gets the text of the message
Regex The regular expression string that matched the message, if any
Timestamp Gets the time the message arrived
Variables Gets a sorted list of capture variable names available in this object. Can be used later in this[string varname] to get the values

Public Instance Methods

ChangeMessage Changes a ChatMessage object to contain the values specified by the parameter.
Equals (inherited from Object)Determines whether the specified Object is equal to the current Object.
GetContextPowerNames Gets a list of power names that could be appropriate to the message based on the context in which the message was found
GetHashCode (inherited from Object)Serves as a hash function for a particular type. GetHashCode is suitable for use in hashing algorithms and data structures like a hash table.
GetType (inherited from Object)Gets the Type of the current instance.
SetPowerName Adds or changes the "PowerName" capture variable in this message. Useful for cases where the power name isn't known outside of the context of other messages.
ToString (inherited from Object)Returns a String that represents the current Object.

See Also

ChatMessage Class | CityOfHeroes Namespace