C# Class FFACETools.FFACE.ChatTools

Class container to impliment Pyrolol's chat system

Private Properties

Method	Description
ChatTools ( int instanceID ) : System	Constructor
CleanLine ( String line ) : String	Will convert AT Brackets, Element Icons, and strip everything else.
CleanLine ( String line, LineSettings lineSettings ) : String	Will strip/convert requested items based on LineSettings passed.
Clear ( ) : void	Clears the internal ChatTools queue
GetNextLine ( ) : ChatLine	Will get the next chat line with default LineSettings.OldSchool
GetNextLine ( LineSettings lineSettings ) : ChatLine	Will get the next chat line

Method	Description
CleanTimeStamp ( String s ) : String	Cleans Timestamp plugin's addition to the _chatLog. (Call before stripping color codes)
GetCurrentLine ( LineSettings lineSettings ) : ChatLine
GetLine ( short index ) : ChatLogEntry
GetLineExtra ( short index ) : ChatLogEntry
GetLineRaw ( short index ) : ChatLogEntry	Will get the raw data of a chat line from FFACE
LineParsed ( ) : void	Marks a line as parsed in the internal ChatTools queue
NumberOfUnparsedLines ( ) : int	Returns the number of unparsed lines in the internal ChatTools queue
Update ( ) : void	Updates the internal ChatTools queue

Constructor

public ChatTools ( int instanceID ) : System
instanceID	int	Instance ID generated by FFACE
return	System

Will convert AT Brackets, Element Icons, and strip everything else.

public static CleanLine ( String line ) : String
line	String	line to clean (left intact)
return	String

Will strip/convert requested items based on LineSettings passed.

public static CleanLine ( String line, LineSettings lineSettings ) : String
line	String	line to clean (left intact)
lineSettings	LineSettings	LineSettings to apply to the line for cleaning/converting.
return	String

Clears the internal ChatTools queue

public Clear ( ) : void
return	void

Will get the next chat line with default LineSettings.OldSchool

public GetNextLine ( ) : ChatLine
return	ChatLine

Will get the next chat line

public GetNextLine ( LineSettings lineSettings ) : ChatLine
lineSettings	LineSettings	LineSettings to apply to cleanline.
return	ChatLine