1 sharedlibrarycoreinterfaces IRConParser

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

Table of Contents

• IRConParser Public interface
• Diagram
• Members
• Properties
• Public properties
• Methods
• Public methods
• Details
• Methods
• GetDvarAsync
• Arguments
• SetDvarAsync
• Arguments
• Summary
• Returns
• ExecuteCommandAsync
• Arguments
• Summary
• Returns
• GetStatusAsync
• Arguments
• Summary
• Returns
• GetOverrideDvarName
• Arguments
• Summary
• Returns
• GetDefaultDvarValue
• Arguments
• OverrideTimeoutForCommand
• Arguments
• Summary
• Returns
• Properties
• Configuration
• Summary
• Version
• Summary
• GameName
• Summary
• CanGenerateLogPath
• Summary
• Name
• Summary
• RConEngine
• Summary
• IsOneLog
• Summary

IRConParser Public interface

Diagram

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

Members

Properties

Public properties

Type	Name	Methods
bool	CanGenerateLogPath indicates if the game supports generating a log path from DVAR retrieval of fs_game, fs_basepath, g_log	get
IRConParserConfiguration	Configuration stores the RCon configuration	get, set
Game	GameName specifies the game name (usually the internal studio iteration ie: IW4, T5 etc...)	get
bool	IsOneLog indicates that the game does not log to the mods folder (when mod is loaded), but rather always to the fs_basegame directory	get
string	Name specifies the name of the parser	get
string	RConEngine specifies the type of rcon engine eg: COD, Source	get
string	Version stores the game/client specific version (usually the value of the "version" DVAR)	get

Methods

Public methods

Returns	Name
Task<string``[]>	ExecuteCommandAsync(IRConConnection connection, string command, CancellationToken token) executes a console command on the server
T	GetDefaultDvarValue(string dvarName)
Task<Dvar<T>>	GetDvarAsync(IRConConnection connection, string dvarName, T fallbackValue, CancellationToken token)
string	GetOverrideDvarName(string dvarName) retrieves the value of given dvar key if it exists in the override dict otherwise returns original
Task<IStatusResponse>	GetStatusAsync(IRConConnection connection, CancellationToken token) get the list of connected clients from status response
Nullable<TimeSpan>	OverrideTimeoutForCommand(string command) determines the amount of time to wait for the command to respond
Task<bool>	SetDvarAsync(IRConConnection connection, string dvarName, object dvarValue, CancellationToken token) set value of DVAR by name

Details

Methods

GetDvarAsync

Source code

public Task<Dvar<T>> GetDvarAsync<T>(IRConConnection connection, string dvarName, T fallbackValue, CancellationToken token)
where T : 

Arguments

Type	Name	Description
IRConConnection	connection
string	dvarName
T	fallbackValue
CancellationToken	token

SetDvarAsync

Source code

public Task<bool> SetDvarAsync(IRConConnection connection, string dvarName, object dvarValue, CancellationToken token)

Arguments

Type	Name	Description
IRConConnection	connection	RCon connection to use
string	dvarName	name of DVAR to set
object	dvarValue	value to set DVAR to
CancellationToken	token

Summary

set value of DVAR by name

Returns

ExecuteCommandAsync

Source code

public Task<string> ExecuteCommandAsync(IRConConnection connection, string command, CancellationToken token)

Arguments

Type	Name	Description
IRConConnection	connection	RCon connection to use
string	command	console command to execute
CancellationToken	token

Summary

executes a console command on the server

Returns

GetStatusAsync

Source code

public Task<IStatusResponse> GetStatusAsync(IRConConnection connection, CancellationToken token)

Arguments

Type	Name	Description
IRConConnection	connection	RCon connection to use
CancellationToken	token

Summary

get the list of connected clients from status response

Returns

IStatusResponse

GetOverrideDvarName

Source code

public string GetOverrideDvarName(string dvarName)

Arguments

Type	Name	Description
string	dvarName	name of dvar key

Summary

retrieves the value of given dvar key if it exists in the override dict otherwise returns original

Returns

GetDefaultDvarValue

Source code

public T GetDefaultDvarValue<T>(string dvarName)
where T : 

Arguments

Type	Name	Description
string	dvarName

OverrideTimeoutForCommand

Source code

public Nullable<TimeSpan> OverrideTimeoutForCommand(string command)

Arguments

Type	Name	Description
string	command	name of command being executed

Summary

determines the amount of time to wait for the command to respond

Returns

Properties

Configuration

public IRConParserConfiguration Configuration { get; set; }

Summary

stores the RCon configuration

Version

public string Version { get; }

Summary

stores the game/client specific version (usually the value of the "version" DVAR)

GameName

public Game GameName { get; }

Summary

specifies the game name (usually the internal studio iteration ie: IW4, T5 etc...)

CanGenerateLogPath

public bool CanGenerateLogPath { get; }

Summary

indicates if the game supports generating a log path from DVAR retrieval of fs_game, fs_basepath, g_log

Name

public string Name { get; }

Summary

specifies the name of the parser

RConEngine

public string RConEngine { get; }

Summary

specifies the type of rcon engine eg: COD, Source

IsOneLog

public bool IsOneLog { get; }

Summary

indicates that the game does not log to the mods folder (when mod is loaded), but rather always to the fs_basegame directory

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