C# Class FFACETools.FFACE.ChatTools

Class container to impliment Pyrolol's chat system
Show file Open project: golfandsurf/Campah

Private Properties

Property Type Description
CleanTimeStamp String
GetCurrentLine ChatLine
GetLine ChatLogEntry
GetLineExtra ChatLogEntry
GetLineRaw ChatLogEntry
LineParsed void
NumberOfUnparsedLines int
Update void

Public Methods

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

Private Methods

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

Method Details

ChatTools() public method

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

CleanLine() public static method

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

CleanLine() public static method

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

Clear() public method

Clears the internal ChatTools queue
public Clear ( ) : void
return void

GetNextLine() public method

Will get the next chat line with default LineSettings.OldSchool
public GetNextLine ( ) : ChatLine
return ChatLine

GetNextLine() public method

Will get the next chat line
public GetNextLine ( LineSettings lineSettings ) : ChatLine
lineSettings LineSettings LineSettings to apply to cleanline.
return ChatLine