1 sharedlibrarycoreinterfaces IRConParserConfiguration

RaidMax edited this page 2023-05-20 22:09:21 -05:00

Table of Contents

• IRConParserConfiguration Public interface
• Diagram
• Members
• Properties
• Public properties
• Details
• Properties
• CommandPrefixes
• Summary
• Status
• Summary
• MapStatus
• Summary
• GametypeStatus
• Summary
• HostnameStatus
• Summary
• MaxPlayersStatus
• Summary
• Dvar
• Summary
• StatusHeader
• Summary
• ServerNotRunningResponse
• Summary
• WaitForResponse
• Summary
• GuidNumberStyle
• Summary
• OverrideDvarNameMapping
• Summary
• DefaultDvarValues
• Summary
• OverrideCommandTimeouts
• Summary
• NoticeMaximumLines
• Summary
• NoticeMaxCharactersPerLine
• Summary
• NoticeLineSeparator
• Summary
• DefaultRConPort
• Summary
• DefaultInstallationDirectoryHint
• Summary
• ColorCodeMapping
• FloodProtectInterval
• ShouldRemoveDiacritics
• Summary

IRConParserConfiguration Public interface

Diagram

  flowchart LR
  classDef interfaceStyle stroke-dasharray: 5 5;
  classDef abstractStyle stroke-width:4px
  subgraph SharedLibraryCore.Interfaces
  SharedLibraryCore.Interfaces.IRConParserConfiguration[[IRConParserConfiguration]]
  class SharedLibraryCore.Interfaces.IRConParserConfiguration interfaceStyle;
  end

Members

Properties

Public properties

Type	Name	Methods
ColorCodeMapping	ColorCodeMapping	get
CommandPrefix	CommandPrefixes stores the command format for console commands	get
IDictionary<string, string>	DefaultDvarValues specifies the default dvar values for games that don't support certain dvars	get
string	DefaultInstallationDirectoryHint Default Indicator of where the game is installed (ex file path or registry entry)	get
Nullable<int>	DefaultRConPort Default port the game listens to RCon requests on	get
ParserRegex	Dvar stores the regex info for parsing get DVAR responses	get
short	FloodProtectInterval	get
ParserRegex	GametypeStatus stores regex info for parsing the gametype line from rcon status response	get
NumberStyles	GuidNumberStyle indicates the format expected for parsed guids	get
ParserRegex	HostnameStatus stores regex info for parsing hostname line from rcon status response	get
ParserRegex	MapStatus stores regex info for parsing the map line from rcon status response	get
ParserRegex	MaxPlayersStatus stores regex info for parsing max players line from rcon status response	get
string	NoticeLineSeparator specifies the characters used to split a line	get
int	NoticeMaxCharactersPerLine specifies how many characters can be displayed per notice line	get
int	NoticeMaximumLines specifies how many lines can be used for ingame notice	get, set
IDictionary<string, Nullable<int>>	OverrideCommandTimeouts contains a setup of commands that have override timeouts	get
IDictionary<string, string>	OverrideDvarNameMapping specifies simple mappings for dvar names in scenarios where the needed information is not stored in a traditional dvar name	get
string	ServerNotRunningResponse Specifies the expected response message from rcon when the server is not running	get
bool	ShouldRemoveDiacritics indicates if diacritics (accented characters) should be normalized	get
ParserRegex	Status stores the regex info for parsing get status response	get
ParserRegex	StatusHeader stores the regex info for parsing the header of a status response	get
bool	WaitForResponse indicates if the application should wait for response from server when executing a command	get

Details

Properties

CommandPrefixes

public CommandPrefix CommandPrefixes { get; }

Summary

stores the command format for console commands

Status

public ParserRegex Status { get; }

Summary

stores the regex info for parsing get status response

MapStatus

public ParserRegex MapStatus { get; }

Summary

stores regex info for parsing the map line from rcon status response

GametypeStatus

public ParserRegex GametypeStatus { get; }

Summary

stores regex info for parsing the gametype line from rcon status response

HostnameStatus

public ParserRegex HostnameStatus { get; }

Summary

stores regex info for parsing hostname line from rcon status response

MaxPlayersStatus

public ParserRegex MaxPlayersStatus { get; }

Summary

stores regex info for parsing max players line from rcon status response

Dvar

public ParserRegex Dvar { get; }

Summary

stores the regex info for parsing get DVAR responses

StatusHeader

public ParserRegex StatusHeader { get; }

Summary

stores the regex info for parsing the header of a status response

ServerNotRunningResponse

public string ServerNotRunningResponse { get; }

Summary

Specifies the expected response message from rcon when the server is not running

WaitForResponse

public bool WaitForResponse { get; }

Summary

indicates if the application should wait for response from server when executing a command

GuidNumberStyle

public NumberStyles GuidNumberStyle { get; }

Summary

indicates the format expected for parsed guids

OverrideDvarNameMapping

public IDictionary<string, string> OverrideDvarNameMapping { get; }

Summary

specifies simple mappings for dvar names in scenarios where the needed information is not stored in a traditional dvar name

DefaultDvarValues

public IDictionary<string, string> DefaultDvarValues { get; }

Summary

specifies the default dvar values for games that don't support certain dvars

OverrideCommandTimeouts

public IDictionary<string, Nullable<int>> OverrideCommandTimeouts { get; }

Summary

contains a setup of commands that have override timeouts

NoticeMaximumLines

public int NoticeMaximumLines { get; set; }

Summary

specifies how many lines can be used for ingame notice

NoticeMaxCharactersPerLine

public int NoticeMaxCharactersPerLine { get; }

Summary

specifies how many characters can be displayed per notice line

NoticeLineSeparator

public string NoticeLineSeparator { get; }

Summary

specifies the characters used to split a line

DefaultRConPort

public Nullable<int> DefaultRConPort { get; }

Summary

Default port the game listens to RCon requests on

DefaultInstallationDirectoryHint

public string DefaultInstallationDirectoryHint { get; }

Summary

Default Indicator of where the game is installed (ex file path or registry entry)

ColorCodeMapping

public ColorCodeMapping ColorCodeMapping { get; }

FloodProtectInterval

public short FloodProtectInterval { get; }

ShouldRemoveDiacritics

public bool ShouldRemoveDiacritics { get; }

Summary

indicates if diacritics (accented characters) should be normalized

Generated with ModularDoc

• Overview
• Getting Started
• FAQ
• Knowledge Base
• Features
  • Commands
  • Webfront
  • Game Interface
  • Permission Sets
  • Plugins
  • API
  • Searching
• Plugin Development
  • Examples
• Configuration
• Game Log Server