sharedlibrarycoreinterfaces IGameServer - RaidMax/IW4M-Admin GitHub Wiki

IGameServer Public interface

Diagram

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

Members

Properties

Public properties

Type Name Methods
IReadOnlyList<EFClient> ConnectedClients
List of connected clients		 get
Game GameCode
Game code corresponding to the development studio project		 get
string GamePassword
Game password (required to join)		 get
string Gametype
Current gametype		 get
string Id
Unique identifier for the server (typically ip:port)		 get
bool IsLegacyGameIntegrationEnabled
Indicates if the anticheat/custom callbacks/live radar integration is enabled		 get
long LegacyDatabaseId
Database id for EFServer table and references		 get
string ListenAddress
Network address the server is listening on		 get
int ListenPort
Network port the server is listening on		 get
Map Map
Current map the game server is running		 get
Nullable<DateTime> MatchEndTime
Time the most recent match ended		 get
Nullable<DateTime> MatchStartTime
Time the current match started		 get
int PrivateClientSlots
Number of private client slots		 get
string ServerName
Name of the server (hostname)		 get

Methods

Public methods

Returns Name
Task<string``[]> ExecuteCommandAsync(string command, CancellationToken token)
Execute a server command
Task Kick(string reason, EFClient target, EFClient origin, EFPenalty previousPenalty)
kicks target on behalf of origin for given reason
Task SetDvarAsync(string name, object value, CancellationToken token)
Set value for server dvar

Details

Methods

Kick

Source code

public Task Kick(string reason, EFClient target, EFClient origin, EFPenalty previousPenalty)
Arguments
Type Name Description
string reason reason client is being kicked
EFClient target client to kick
EFClient origin source of kick action
EFPenalty previousPenalty previous penalty the kick is occuring for (if applicable)
Summary

kicks target on behalf of origin for given reason

Returns

ExecuteCommandAsync

Source code

public Task<string> ExecuteCommandAsync(string command, CancellationToken token)
Arguments
Type Name Description
string command Server command to execute
CancellationToken token CancellationToken
Summary

Execute a server command

Returns

Collection of console command output lines

SetDvarAsync

Source code

public Task SetDvarAsync(string name, object value, CancellationToken token)
Arguments
Type Name Description
string name Name of the server value to set
object value Value of the server value
CancellationToken token CancellationToken
Summary

Set value for server dvar

Returns

Properties

MatchEndTime

public Nullable<DateTime> MatchEndTime { get; }
Summary

Time the most recent match ended

MatchStartTime

public Nullable<DateTime> MatchStartTime { get; }
Summary

Time the current match started

ConnectedClients

public IReadOnlyList<EFClient> ConnectedClients { get; }
Summary

List of connected clients

GameCode

public Game GameCode { get; }
Summary

Game code corresponding to the development studio project

IsLegacyGameIntegrationEnabled

public bool IsLegacyGameIntegrationEnabled { get; }
Summary

Indicates if the anticheat/custom callbacks/live radar integration is enabled

Id

public string Id { get; }
Summary

Unique identifier for the server (typically ip:port)

ListenAddress

public string ListenAddress { get; }
Summary

Network address the server is listening on

ListenPort

public int ListenPort { get; }
Summary

Network port the server is listening on

ServerName

public string ServerName { get; }
Summary

Name of the server (hostname)

Gametype

public string Gametype { get; }
Summary

Current gametype

GamePassword

public string GamePassword { get; }
Summary

Game password (required to join)

PrivateClientSlots

public int PrivateClientSlots { get; }
Summary

Number of private client slots

Map

public Map Map { get; }
Summary

Current map the game server is running

LegacyDatabaseId

public long LegacyDatabaseId { get; }
Summary

Database id for EFServer table and references

Generated with ModularDoc

Discord

ko-fi

⚠️ **GitHub.com Fallback** ⚠️