sharedlibrarycoreinterfaces IEventParser - RaidMax/IW4M-Admin GitHub Wiki
Public interface
IEventParser Diagram
flowchart LR
classDef interfaceStyle stroke-dasharray: 5 5;
classDef abstractStyle stroke-width:4px
subgraph SharedLibraryCore.Interfaces
SharedLibraryCore.Interfaces.IEventParser[IEventParser](/RaidMax/IW4M-Admin/wiki/IEventParser)
class SharedLibraryCore.Interfaces.IEventParser interfaceStyle;
end
Members
Properties
Public properties
Type | Name | Methods |
---|---|---|
IEventParserConfiguration |
Configuration Get game specific folder prefix for log files |
get, set |
Game |
GameName specifies the game name (usually the internal studio iteration ie: IW4, T5 etc...) |
get, set |
string |
Name specifies the text name of the game the parser is for |
get, set |
string |
URLProtocolFormat specifies the connect URI used to join game servers via web browser |
get, set |
string |
Version stores the game/client specific version (usually the value of the "version" DVAR) |
get, set |
Methods
Public methods
Returns | Name |
---|---|
GameEvent |
GenerateGameEvent (string logLine)Generates a game event based on log line input |
void |
RegisterCustomEvent (string eventSubtype, string eventTriggerValue, Func <string , IEventParserConfiguration , GameEvent , GameEvent > eventModifier) |
Details
Methods
GenerateGameEvent
public GameEvent GenerateGameEvent(string logLine)
Arguments
Type | Name | Description |
---|---|---|
string |
logLine | single log line string |
Summary
Generates a game event based on log line input
Returns
RegisterCustomEvent
public void RegisterCustomEvent(string eventSubtype, string eventTriggerValue, Func<string, IEventParserConfiguration, GameEvent, GameEvent> eventModifier)
Arguments
Type | Name | Description |
---|---|---|
string |
eventSubtype | |
string |
eventTriggerValue | |
Func <string , IEventParserConfiguration , GameEvent , GameEvent > |
eventModifier |
Properties
Configuration
public IEventParserConfiguration Configuration { get; set; }
Summary
Get game specific folder prefix for log files
Version
public string Version { get; set; }
Summary
stores the game/client specific version (usually the value of the "version" DVAR)
GameName
public Game GameName { get; set; }
Summary
specifies the game name (usually the internal studio iteration ie: IW4, T5 etc...)
URLProtocolFormat
public string URLProtocolFormat { get; set; }
Summary
specifies the connect URI used to join game servers via web browser
Name
public string Name { get; set; }
Summary
specifies the text name of the game the parser is for
Generated with ModularDoc