1 iw4madmin IW4MServer

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

Table of Contents

• IW4MServer Public class
• Diagram
• Members
• Properties
• Public properties
• Methods
• Public methods
• Protected methods
• Public Static methods
• Internal Static methods
• Details
• Inheritance
• Constructors
• IW4MServer
• Arguments
• Methods
• OnClientConnected
• Arguments
• OnClientDisconnected
• Arguments
• ExecuteEvent
• Arguments
• ProcessEvent
• Arguments
• Summary
• Returns
• EnsureServerAdded
• GetIdForServer
• Arguments
• ProcessUpdatesAsync
• Arguments
• Initialize
• GenerateUriForLog
• Arguments
• GenerateLogPath
• Arguments
• Warn
• Arguments
• Kick
• Arguments
• ExecuteCommandAsync
• Arguments
• SetDvarAsync
• Arguments
• TempBan
• Arguments
• Ban
• Arguments
• Unban
• Arguments
• InitializeTokens
• g__IsValidGamePath|35_0
• Arguments
• Properties
• LegacyDatabaseId

IW4MServer Public class

Diagram

  flowchart LR
  classDef interfaceStyle stroke-dasharray: 5 5;
  classDef abstractStyle stroke-width:4px
  subgraph IW4MAdmin
  IW4MAdmin.IW4MServer[[IW4MServer]]
  end
  subgraph SharedLibraryCore
  SharedLibraryCore.Server[[Server]]
  class SharedLibraryCore.Server abstractStyle;
  end
SharedLibraryCore.Server --> IW4MAdmin.IW4MServer

Members

Properties

Public properties

Type	Name	Methods
long	LegacyDatabaseId	get

Methods

Public methods

Returns	Name
Task	Ban(string reason, EFClient targetClient, EFClient originClient, bool isEvade)
Task	EnsureServerAdded()
Task<string``[]>	ExecuteCommandAsync(string command, CancellationToken token)
Task	ExecuteEvent(GameEvent E)
Uri``[]	GenerateUriForLog(string logPath, string gameLogServerUrl)
Task<long>	GetIdForServer(Server server)
Task	Initialize()
void	InitializeTokens()
Task	Kick(string reason, EFClient targetClient, EFClient originClient, EFPenalty previousPenalty)
Task<EFClient>	OnClientConnected(EFClient clientFromLog)
Task	OnClientDisconnected(EFClient client)
Task<bool>	ProcessUpdatesAsync(CancellationToken token)
Task	SetDvarAsync(string name, object value, CancellationToken token)
Task	TempBan(string reason, TimeSpan length, EFClient targetClient, EFClient originClient)
Task	Unban(string reason, EFClient targetClient, EFClient originClient)
Task	Warn(string reason, EFClient targetClient, EFClient targetOrigin)

Protected methods

Returns	Name
Task<bool>	ProcessEvent(GameEvent E) Perform the server specific tasks when an event occurs

Public Static methods

Returns	Name
string	GenerateLogPath(LogPathGeneratorInfo logInfo)

Internal Static methods

Returns	Name
bool	[`g__IsValidGamePath

Details

Inheritance

• Server

Constructors

IW4MServer

Source code

public IW4MServer(ServerConfiguration serverConfiguration, CommandConfiguration commandConfiguration, ITranslationLookup lookup, IMetaServiceV2 metaService, IServiceProvider serviceProvider, IClientNoticeMessageFormatter messageFormatter, ILookupCache<EFServer> serverCache)

Arguments

Type	Name	Description
ServerConfiguration	serverConfiguration
CommandConfiguration	commandConfiguration
ITranslationLookup	lookup
IMetaServiceV2	metaService
IServiceProvider	serviceProvider
IClientNoticeMessageFormatter	messageFormatter
ILookupCache<EFServer>	serverCache

Methods

OnClientConnected

Source code

public override async Task<EFClient> OnClientConnected(EFClient clientFromLog)

Arguments

Type	Name	Description
EFClient	clientFromLog

OnClientDisconnected

Source code

public override async Task OnClientDisconnected(EFClient client)

Arguments

Type	Name	Description
EFClient	client

ExecuteEvent

Source code

public override async Task ExecuteEvent(GameEvent E)

Arguments

Type	Name	Description
GameEvent	E

ProcessEvent

Source code

protected override async Task<bool> ProcessEvent(GameEvent E)

Arguments

Type	Name	Description
GameEvent	E

Summary

Perform the server specific tasks when an event occurs

Returns

EnsureServerAdded

Source code

public async Task EnsureServerAdded()

GetIdForServer

Source code

public override async Task<long> GetIdForServer(Server server)

Arguments

Type	Name	Description
Server	server

ProcessUpdatesAsync

Source code

public override async Task<bool> ProcessUpdatesAsync(CancellationToken token)

Arguments

Type	Name	Description
CancellationToken	token

Initialize

Source code

public async Task Initialize()

GenerateUriForLog

Source code

public Uri GenerateUriForLog(string logPath, string gameLogServerUrl)

Arguments

Type	Name	Description
string	logPath
string	gameLogServerUrl

GenerateLogPath

Source code

public static string GenerateLogPath(LogPathGeneratorInfo logInfo)

Arguments

Type	Name	Description
LogPathGeneratorInfo	logInfo

Warn

Source code

public override async Task Warn(string reason, EFClient targetClient, EFClient targetOrigin)

Arguments

Type	Name	Description
string	reason
EFClient	targetClient
EFClient	targetOrigin

Kick

Source code

public override async Task Kick(string reason, EFClient targetClient, EFClient originClient, EFPenalty previousPenalty)

Arguments

Type	Name	Description
string	reason
EFClient	targetClient
EFClient	originClient
EFPenalty	previousPenalty

ExecuteCommandAsync

Source code

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

Arguments

Type	Name	Description
string	command
CancellationToken	token

SetDvarAsync

Source code

public override Task SetDvarAsync(string name, object value, CancellationToken token)

Arguments

Type	Name	Description
string	name
object	value
CancellationToken	token

TempBan

Source code

public override async Task TempBan(string reason, TimeSpan length, EFClient targetClient, EFClient originClient)

Arguments

Type	Name	Description
string	reason
TimeSpan	length
EFClient	targetClient
EFClient	originClient

Ban

Source code

public override async Task Ban(string reason, EFClient targetClient, EFClient originClient, bool isEvade)

Arguments

Type	Name	Description
string	reason
EFClient	targetClient
EFClient	originClient
bool	isEvade

Unban

Source code

public override async Task Unban(string reason, EFClient targetClient, EFClient originClient)

Arguments

Type	Name	Description
string	reason
EFClient	targetClient
EFClient	originClient

InitializeTokens

Source code

public override void InitializeTokens()

g__IsValidGamePath|35_0

Source code

internal static bool <GenerateLogPath>g__IsValidGamePath|35_0(string path)

Arguments

Type	Name	Description
string	path

Properties

LegacyDatabaseId

public override long LegacyDatabaseId { get; }

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