Rim/IW4M-Admin
Rim/IW4M-Admin
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases 30 Wiki Activity

Add folder structure for documentation

RaidMax 2023-05-20 21:15:15 -05:00
parent a0d240460b
commit 20ed2571c4
257 changed files with 924 additions and 676 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
CodeDocumentation/SharedLibraryCore/sharedlibrarycore-BaseController.md → CodeDocumentation/SharedLibraryCore/BaseController.md

@ -19,15 +19,15 @@ Microsoft.AspNetCore.Mvc.Controller --> SharedLibraryCore.BaseController
#### Protected properties
| Type | Name | Methods |
| --- | --- | --- |
| [`ApplicationConfiguration`](./sharedlibrarycoreconfiguration-ApplicationConfiguration) | [`AppConfig`](#appconfig) | `get` |
| [`ApplicationConfiguration`](configuration/ApplicationConfiguration.md) | [`AppConfig`](#appconfig) | `get` |
| `bool` | [`Authorized`](#authorized) | `get, set` |
| [`EFClient`](./sharedlibrarycoredatabasemodels-EFClient) | [`Client`](#client) | `get` |
| [`TranslationLookup`](./sharedlibrarycorelocalization-TranslationLookup) | [`Localization`](#localization) | `get` |
| [`EFClient`](database/models/EFClient.md) | [`Client`](#client) | `get` |
| [`TranslationLookup`](localization/TranslationLookup.md) | [`Localization`](#localization) | `get` |
#### Public properties
| Type | Name | Methods |
| --- | --- | --- |
| [`IManager`](./sharedlibrarycoreinterfaces-IManager) | [`Manager`](#manager) | `get` |
| [`IManager`](interfaces/IManager.md) | [`Manager`](#manager) | `get` |
### Methods
#### Protected methods
@ -46,13 +46,14 @@ Microsoft.AspNetCore.Mvc.Controller --> SharedLibraryCore.BaseController
### Constructors
#### BaseController
[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/BaseController.cs#L43)
```csharp
public BaseController(IManager manager)
```
##### Arguments
| Type | Name | Description |
| --- | --- | --- |
| [`IManager`](./sharedlibrarycoreinterfaces-IManager) | manager | |
| [`IManager`](interfaces/IManager.md) | manager | |
### Methods
#### SignInAsync

4
CodeDocumentation/SharedLibraryCore/sharedlibrarycore-ColorCode.md → CodeDocumentation/SharedLibraryCore/ColorCode.md

@ -33,16 +33,18 @@ Microsoft.AspNetCore.Razor.TagHelpers.TagHelper --> SharedLibraryCore.ColorCode
### Constructors
#### ColorCode
[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/TagHelpers/ColorCode.cs#L13)
```csharp
public ColorCode(ApplicationConfiguration appConfig)
```
##### Arguments
| Type | Name | Description |
| --- | --- | --- |
| [`ApplicationConfiguration`](./sharedlibrarycoreconfiguration-ApplicationConfiguration) | appConfig | |
| [`ApplicationConfiguration`](configuration/ApplicationConfiguration.md) | appConfig | |
### Methods
#### Process
[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/TagHelpers/ColorCode.cs#L21)
```csharp
public override void Process(TagHelperContext context, TagHelperOutput output)
```

13
CodeDocumentation/SharedLibraryCore/sharedlibrarycore-Command.md → CodeDocumentation/SharedLibraryCore/Command.md

@ -26,7 +26,7 @@ SharedLibraryCore.Interfaces.IManagerCommand --> SharedLibraryCore.Command
| --- | --- | --- |
| `string` | [`Alias`](#alias)<br>Alternate name for this command to be executed by | `get, protected set` |
| `bool` | [`AllowImpersonation`](#allowimpersonation)<br>indicates if this command allows impersonation (run as) | `get, set` |
| [`CommandArgument`](./sharedlibrarycorecommands-CommandArgument)`[]` | [`Arguments`](#arguments)<br>Argument list for the command | `get, protected set` |
| [`CommandArgument`](commands/CommandArgument.md)`[]` | [`Arguments`](#arguments)<br>Argument list for the command | `get, protected set` |
| `string` | [`Description`](#description)<br>Specifies the command description | `get, protected set` |
| `bool` | [`IsBroadcast`](#isbroadcast) | `get, set` |
| `string` | [`Name`](#name)<br>Specifies the name and string that triggers the command | `get, protected set` |
@ -40,7 +40,7 @@ SharedLibraryCore.Interfaces.IManagerCommand --> SharedLibraryCore.Command
#### Public methods
| Returns | Name |
| --- | --- |
| `Task` | [`ExecuteAsync`](#executeasync)([`GameEvent`](./sharedlibrarycore-GameEvent) gameEvent)<br>Executes the command |
| `Task` | [`ExecuteAsync`](#executeasync)([`GameEvent`](./GameEvent.md) gameEvent)<br>Executes the command |
## Details
### Summary
@ -49,18 +49,19 @@ Abstract class for command
### Inheritance
- [
`IManagerCommand`
](./sharedlibrarycoreinterfaces-IManagerCommand)
](interfaces/IManagerCommand.md)
### Constructors
#### Command
[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Command.cs#L42)
```csharp
public Command(CommandConfiguration config, ITranslationLookup layout)
```
##### Arguments
| Type | Name | Description |
| --- | --- | --- |
| [`CommandConfiguration`](./sharedlibrarycoreconfiguration-CommandConfiguration) | config | |
| [`ITranslationLookup`](./sharedlibrarycoreinterfaces-ITranslationLookup) | layout | |
| [`CommandConfiguration`](configuration/CommandConfiguration.md) | config | |
| [`ITranslationLookup`](interfaces/ITranslationLookup.md) | layout | |
### Methods
#### ExecuteAsync
@ -70,7 +71,7 @@ public abstract Task ExecuteAsync(GameEvent gameEvent)
##### Arguments
| Type | Name | Description |
| --- | --- | --- |
| [`GameEvent`](./sharedlibrarycore-GameEvent) | gameEvent | |
| [`GameEvent`](./GameEvent.md) | gameEvent | |
##### Summary
Executes the command

0
CodeDocumentation/SharedLibraryCore/sharedlibrarycore-DvarT.md → CodeDocumentation/SharedLibraryCore/DvarT.md

9
CodeDocumentation/SharedLibraryCore/sharedlibrarycore-GameEvent.md → CodeDocumentation/SharedLibraryCore/GameEvent.md

@ -24,7 +24,7 @@ SharedLibraryCore.Events.CoreEvent --> SharedLibraryCore.GameEvent
| `EventFailReason` | [`FailReason`](#failreason) | `get, set` |
| `bool` | [`Failed`](#failed) | `get` |
| `Nullable`&lt;`long`&gt; | [`GameTime`](#gametime)<br>Specifies the game time offset as printed in the log | `get, set` |
| [`EFClient`](./sharedlibrarycoredatabasemodels-EFClient) | [`ImpersonationOrigin`](#impersonationorigin) | `get, set` |
| [`EFClient`](database/models/EFClient.md) | [`ImpersonationOrigin`](#impersonationorigin) | `get, set` |
| `long` | [`IncrementalId`](#incrementalid) | `get` |
| `bool` | [`IsBlocking`](#isblocking)<br>Indicates if the event should block until it is complete | `get, set` |
| `bool` | [`IsRemote`](#isremote) | `get, set` |
@ -44,13 +44,13 @@ SharedLibraryCore.Events.CoreEvent --> SharedLibraryCore.GameEvent
| Returns | Name |
| --- | --- |
| `void` | [`Complete`](#complete)() |
| `Task`&lt;[`GameEvent`](sharedlibrarycore-GameEvent)&gt; | [`WaitAsync`](#waitasync-12)(`...`) |
| `Task`&lt;[`GameEvent`](sharedlibrarycore/GameEvent.md)&gt; | [`WaitAsync`](#waitasync-12)(`...`) |
## Details
### Inheritance
- [
`CoreEvent`
](./sharedlibrarycoreevents-CoreEvent)
](events/CoreEvent.md)
### Nested types
#### Enums
@ -61,17 +61,20 @@ SharedLibraryCore.Events.CoreEvent --> SharedLibraryCore.GameEvent
### Constructors
#### GameEvent
[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Events/GameEvent.cs#L260)
```csharp
public GameEvent()
```
### Methods
#### Finalize
[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Events/GameEvent.cs#L277)
```csharp
protected override void Finalize()
```
#### Complete
[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Events/GameEvent.cs#L313)
```csharp
public void Complete()
```

0
CodeDocumentation/SharedLibraryCore/sharedlibrarycore-Gametype.md → CodeDocumentation/SharedLibraryCore/Gametype.md

1
CodeDocumentation/SharedLibraryCore/sharedlibrarycore-Map.md → CodeDocumentation/SharedLibraryCore/Map.md

@ -33,6 +33,7 @@ public Map()
### Methods
#### ToString
[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Game/Map.cs#L9)
```csharp
public override string ToString()
```

125
CodeDocumentation/SharedLibraryCore/sharedlibrarycore-Server.md → CodeDocumentation/SharedLibraryCore/Server.md

@ -21,15 +21,15 @@ SharedLibraryCore.Interfaces.IGameServer --> SharedLibraryCore.Server
#### Public properties
| Type | Name | Methods |
| --- | --- | --- |
| `List`&lt;[`ChatInfo`](./sharedlibrarycoredtos-ChatInfo)&gt; | [`ChatHistory`](#chathistory) | `get, protected set` |
| [`ClientHistoryInfo`](./sharedlibrarycoredtos-ClientHistoryInfo) | [`ClientHistory`](#clienthistory) | `get` |
| `List`&lt;[`ChatInfo`](dtos/ChatInfo.md)&gt; | [`ChatHistory`](#chathistory) | `get, protected set` |
| [`ClientHistoryInfo`](dtos/ClientHistoryInfo.md) | [`ClientHistory`](#clienthistory) | `get` |
| `int` | [`ClientNum`](#clientnum) | `get` |
| `List`&lt;[`EFClient`](./sharedlibrarycoredatabasemodels-EFClient)&gt; | [`Clients`](#clients) | `get, protected set` |
| `IReadOnlyList`&lt;[`EFClient`](./sharedlibrarycoredatabasemodels-EFClient)&gt; | [`ConnectedClients`](#connectedclients) | `get` |
| [`Map`](./sharedlibrarycore-Map) | [`CurrentMap`](#currentmap) | `get, set` |
| `List`&lt;[`EFClient`](database/models/EFClient.md)&gt; | [`Clients`](#clients) | `get, protected set` |
| `IReadOnlyList`&lt;[`EFClient`](database/models/EFClient.md)&gt; | [`ConnectedClients`](#connectedclients) | `get` |
| [`Map`](./Map.md) | [`CurrentMap`](#currentmap) | `get, set` |
| `bool` | [`CustomCallback`](#customcallback) | `get, protected set` |
| `long` | [`EndPoint`](#endpoint) | `get` |
| [`IEventParser`](./sharedlibrarycoreinterfaces-IEventParser) | [`EventParser`](#eventparser) | `get, set` |
| [`IEventParser`](interfaces/IEventParser.md) | [`EventParser`](#eventparser) | `get, set` |
| `SemaphoreSlim` | [`EventProcessing`](#eventprocessing) | `get` |
| `Game` | [`GameCode`](#gamecode) | `get` |
| `Game` | [`GameName`](#gamename) | `get, set` |
@ -45,10 +45,10 @@ SharedLibraryCore.Interfaces.IGameServer --> SharedLibraryCore.Server
| `string` | [`ListenAddress`](#listenaddress) | `get` |
| `int` | [`ListenPort`](#listenport) | `get` |
| `string` | [`LogPath`](#logpath) | `get, protected set` |
| [`ILogger`](./sharedlibrarycoreinterfaces-ILogger) | [`Logger`](#logger) | `get` |
| [`IManager`](./sharedlibrarycoreinterfaces-IManager) | [`Manager`](#manager) | `get, protected set` |
| [`Map`](./sharedlibrarycore-Map) | [`Map`](#map) | `get` |
| `List`&lt;[`Map`](./sharedlibrarycore-Map)&gt; | [`Maps`](#maps) | `get, protected set` |
| [`ILogger`](interfaces/ILogger.md) | [`Logger`](#logger) | `get` |
| [`IManager`](interfaces/IManager.md) | [`Manager`](#manager) | `get, protected set` |
| [`Map`](./Map.md) | [`Map`](#map) | `get` |
| `List`&lt;[`Map`](./Map.md)&gt; | [`Maps`](#maps) | `get, protected set` |
| `Nullable`&lt;`DateTime`&gt; | [`MatchEndTime`](#matchendtime) | `get, protected set` |
| `Nullable`&lt;`DateTime`&gt; | [`MatchStartTime`](#matchstarttime) | `get, protected set` |
| `int` | [`MaxClients`](#maxclients) | `get, protected set` |
@ -56,12 +56,12 @@ SharedLibraryCore.Interfaces.IGameServer --> SharedLibraryCore.Server
| `string` | [`PerformanceBucket`](#performancebucket) | `get, init` |
| `int` | [`Port`](#port) | `get, protected set` |
| `int` | [`PrivateClientSlots`](#privateclientslots) | `get, protected set` |
| [`IRConParser`](./sharedlibrarycoreinterfaces-IRConParser) | [`RconParser`](#rconparser) | `get, set` |
| [`IRConConnection`](./sharedlibrarycoreinterfaces-IRConConnection) | [`RemoteConnection`](#remoteconnection) | `get, protected set` |
| `List`&lt;[`Report`](./sharedlibrarycorehelpers-Report)&gt; | [`Reports`](#reports) | `get, set` |
| [`IRConParser`](interfaces/IRConParser.md) | [`RconParser`](#rconparser) | `get, set` |
| [`IRConConnection`](interfaces/IRConConnection.md) | [`RemoteConnection`](#remoteconnection) | `get, protected set` |
| `List`&lt;[`Report`](helpers/Report.md)&gt; | [`Reports`](#reports) | `get, set` |
| `IPEndPoint` | [`ResolvedIpEndPoint`](#resolvedipendpoint) | `get, protected set` |
| `bool` | [`RestartRequested`](#restartrequested) | `get, set` |
| [`ServerConfiguration`](./sharedlibrarycoreconfiguration-ServerConfiguration) | [`ServerConfig`](#serverconfig) | `get` |
| [`ServerConfiguration`](configuration/ServerConfiguration.md) | [`ServerConfig`](#serverconfig) | `get` |
| `string` | [`ServerName`](#servername) | `get` |
| `bool` | [`Throttled`](#throttled) | `get, protected set` |
| `string` | [`Version`](#version) | `get, protected set` |
@ -72,41 +72,41 @@ SharedLibraryCore.Interfaces.IGameServer --> SharedLibraryCore.Server
#### Public methods
| Returns | Name |
| --- | --- |
| `Task` | [`Ban`](#ban)(`string` reason, [`EFClient`](./sharedlibrarycoredatabasemodels-EFClient) target, [`EFClient`](./sharedlibrarycoredatabasemodels-EFClient) origin, `bool` isEvade)<br>Perm ban a player from the server |
| [`GameEvent`](./sharedlibrarycore-GameEvent) | [`Broadcast`](#broadcast-12)(`...`)<br>Send a message to all players |
| `Task` | [`BroadcastAsync`](#broadcastasync)(`IEnumerable`&lt;`string`&gt; messages, [`EFClient`](./sharedlibrarycoredatabasemodels-EFClient) sender, `CancellationToken` token) |
| `Task` | [`Ban`](#ban)(`string` reason, [`EFClient`](database/models/EFClient.md) target, [`EFClient`](database/models/EFClient.md) origin, `bool` isEvade)<br>Perm ban a player from the server |
| [`GameEvent`](./GameEvent.md) | [`Broadcast`](#broadcast-12)(`...`)<br>Send a message to all players |
| `Task` | [`BroadcastAsync`](#broadcastasync)(`IEnumerable`&lt;`string`&gt; messages, [`EFClient`](database/models/EFClient.md) sender, `CancellationToken` token) |
| `Task`&lt;`string``[]`&gt; | [`ExecuteCommandAsync`](#executecommandasync)(`string` command, `CancellationToken` token) |
| `Task` | [`ExecuteEvent`](#executeevent)([`GameEvent`](./sharedlibrarycore-GameEvent) E) |
| `List`&lt;[`EFClient`](./sharedlibrarycoredatabasemodels-EFClient)&gt; | [`GetClientByName`](#getclientbyname)(`string` pName)<br>Get a player by name<br> todo: make this an extension |
| [`EFClient`](./sharedlibrarycoredatabasemodels-EFClient) | [`GetClientByNumber`](#getclientbynumber)(`int` clientNumber) |
| `List`&lt;[`EFClient`](./sharedlibrarycoredatabasemodels-EFClient)&gt; | [`GetClientsAsList`](#getclientsaslist)()<br>Returns list of all current players |
| `Task`&lt;`long`&gt; | [`GetIdForServer`](#getidforserver)([`Server`](sharedlibrarycore-Server) server) |
| `Task` | [`ExecuteEvent`](#executeevent)([`GameEvent`](./GameEvent.md) E) |
| `List`&lt;[`EFClient`](database/models/EFClient.md)&gt; | [`GetClientByName`](#getclientbyname)(`string` pName)<br>Get a player by name<br> todo: make this an extension |
| [`EFClient`](database/models/EFClient.md) | [`GetClientByNumber`](#getclientbynumber)(`int` clientNumber) |
| `List`&lt;[`EFClient`](database/models/EFClient.md)&gt; | [`GetClientsAsList`](#getclientsaslist)()<br>Returns list of all current players |
| `Task`&lt;`long`&gt; | [`GetIdForServer`](#getidforserver)([`Server`](sharedlibrarycore/Server.md) server) |
| `void` | [`InitializeTokens`](#initializetokens)()<br>Initalize the macro variables |
| `Task` | [`Kick`](#kick-12)(`...`) |
| `Task` | [`LoadMap`](#loadmap)(`string` mapName)<br>Change the current server map |
| `Task`&lt;[`EFClient`](./sharedlibrarycoredatabasemodels-EFClient)&gt; | [`OnClientConnected`](#onclientconnected)([`EFClient`](./sharedlibrarycoredatabasemodels-EFClient) P)<br>Add a player to the server's player list |
| `Task` | [`OnClientDisconnected`](#onclientdisconnected)([`EFClient`](./sharedlibrarycoredatabasemodels-EFClient) client)<br>Remove player by client number |
| `Task`&lt;[`EFClient`](database/models/EFClient.md)&gt; | [`OnClientConnected`](#onclientconnected)([`EFClient`](database/models/EFClient.md) P)<br>Add a player to the server's player list |
| `Task` | [`OnClientDisconnected`](#onclientdisconnected)([`EFClient`](database/models/EFClient.md) client)<br>Remove player by client number |
| `Task`&lt;`bool`&gt; | [`ProcessUpdatesAsync`](#processupdatesasync)(`CancellationToken` token) |
| `Task` | [`SetDvarAsync`](#setdvarasync)(`string` name, `object` value, `CancellationToken` token) |
| `Task` | [`TempBan`](#tempban)(`string` reason, `TimeSpan` length, [`EFClient`](./sharedlibrarycoredatabasemodels-EFClient) target, [`EFClient`](./sharedlibrarycoredatabasemodels-EFClient) origin)<br>Temporarily ban a player ( default 1 hour ) from the server |
| `Task` | [`TempBan`](#tempban)(`string` reason, `TimeSpan` length, [`EFClient`](database/models/EFClient.md) target, [`EFClient`](database/models/EFClient.md) origin)<br>Temporarily ban a player ( default 1 hour ) from the server |
| `void` | [`ToAdmins`](#toadmins)(`string` message)<br>Send a message to all admins on the server |
| `string` | [`ToString`](#tostring)() |
| `Task` | [`Unban`](#unban)(`string` reason, [`EFClient`](./sharedlibrarycoredatabasemodels-EFClient) targetClient, [`EFClient`](./sharedlibrarycoredatabasemodels-EFClient) originClient)<br>Unban a player by npID / GUID |
| `Task` | [`Warn`](#warn)(`string` reason, [`EFClient`](./sharedlibrarycoredatabasemodels-EFClient) target, [`EFClient`](./sharedlibrarycoredatabasemodels-EFClient) origin) |
| `Task` | [`Unban`](#unban)(`string` reason, [`EFClient`](database/models/EFClient.md) targetClient, [`EFClient`](database/models/EFClient.md) originClient)<br>Unban a player by npID / GUID |
| `Task` | [`Warn`](#warn)(`string` reason, [`EFClient`](database/models/EFClient.md) target, [`EFClient`](database/models/EFClient.md) origin) |
#### Protected methods
| Returns | Name |
| --- | --- |
| `void` | [`InitializeAutoMessages`](#initializeautomessages)()<br>Initialize the messages to be broadcasted |
| `Task`&lt;`bool`&gt; | [`ProcessEvent`](#processevent)([`GameEvent`](./sharedlibrarycore-GameEvent) E)<br>Process any server event |
| `Task`&lt;`bool`&gt; | [`ProcessEvent`](#processevent)([`GameEvent`](./GameEvent.md) E)<br>Process any server event |
| `Task`&lt;`bool`&gt; | [`ScriptLoaded`](#scriptloaded)() |
| `Task` | [`Tell`](#tell)(`string` message, [`EFClient`](./sharedlibrarycoredatabasemodels-EFClient) targetClient)<br>Send a message to a particular players |
| `Task` | [`Tell`](#tell)(`string` message, [`EFClient`](database/models/EFClient.md) targetClient)<br>Send a message to a particular players |
## Details
### Inheritance
- [
`IGameServer`
](./sharedlibrarycoreinterfaces-IGameServer)
](interfaces/IGameServer.md)
### Nested types
#### Enums
@ -114,18 +114,19 @@ SharedLibraryCore.Interfaces.IGameServer --> SharedLibraryCore.Server
### Constructors
#### Server
[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Server.cs#L103)
```csharp
public Server(ILogger<Server> logger, ILogger deprecatedLogger, ServerConfiguration config, IManager mgr, IRConConnectionFactory rconConnectionFactory, IGameLogReaderFactory gameLogReaderFactory, IServiceProvider serviceProvider)
```
##### Arguments
| Type | Name | Description |
| --- | --- | --- |
| `ILogger`&lt;[`Server`](sharedlibrarycore-Server)&gt; | logger | |
| [`ILogger`](./sharedlibrarycoreinterfaces-ILogger) | deprecatedLogger | |
| [`ServerConfiguration`](./sharedlibrarycoreconfiguration-ServerConfiguration) | config | |
| [`IManager`](./sharedlibrarycoreinterfaces-IManager) | mgr | |
| [`IRConConnectionFactory`](./sharedlibrarycoreinterfaces-IRConConnectionFactory) | rconConnectionFactory | |
| [`IGameLogReaderFactory`](./sharedlibrarycoreinterfaces-IGameLogReaderFactory) | gameLogReaderFactory | |
| `ILogger`&lt;[`Server`](sharedlibrarycore/Server.md)&gt; | logger | |
| [`ILogger`](interfaces/ILogger.md) | deprecatedLogger | |
| [`ServerConfiguration`](configuration/ServerConfiguration.md) | config | |
| [`IManager`](interfaces/IManager.md) | mgr | |
| [`IRConConnectionFactory`](interfaces/IRConConnectionFactory.md) | rconConnectionFactory | |
| [`IGameLogReaderFactory`](interfaces/IGameLogReaderFactory.md) | gameLogReaderFactory | |
| `IServiceProvider` | serviceProvider | |
### Methods
@ -137,8 +138,8 @@ public abstract Task Kick(string reason, EFClient target, EFClient origin, EFPen
| Type | Name | Description |
| --- | --- | --- |
| `string` | reason | |
| [`EFClient`](./sharedlibrarycoredatabasemodels-EFClient) | target | |
| [`EFClient`](./sharedlibrarycoredatabasemodels-EFClient) | origin | |
| [`EFClient`](database/models/EFClient.md) | target | |
| [`EFClient`](database/models/EFClient.md) | origin | |
| `EFPenalty` | originalPenalty | |
#### ExecuteCommandAsync
@ -163,6 +164,7 @@ public abstract Task SetDvarAsync(string name, object value, CancellationToken t
| `CancellationToken` | token | |
#### GetClientsAsList
[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Server.cs#L176)
```csharp
public List<EFClient> GetClientsAsList()
```
@ -179,7 +181,7 @@ public abstract Task<EFClient> OnClientConnected(EFClient P)
##### Arguments
| Type | Name | Description |
| --- | --- | --- |
| [`EFClient`](./sharedlibrarycoredatabasemodels-EFClient) | P | EFClient pulled from memory reading |
| [`EFClient`](database/models/EFClient.md) | P | EFClient pulled from memory reading |
##### Summary
Add a player to the server's player list
@ -194,7 +196,7 @@ public abstract Task OnClientDisconnected(EFClient client)
##### Arguments
| Type | Name | Description |
| --- | --- | --- |
| [`EFClient`](./sharedlibrarycoredatabasemodels-EFClient) | client | |
| [`EFClient`](database/models/EFClient.md) | client | |
##### Summary
Remove player by client number
@ -203,6 +205,7 @@ Remove player by client number
true if removal succeeded, false otherwise
#### GetClientByName
[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Server.cs#L16707566)
```csharp
public List<EFClient> GetClientByName(string pName)
```
@ -219,6 +222,7 @@ Get a player by name
Matching player if found
#### ProcessUpdatesAsync
[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Server.cs#L229)
```csharp
public virtual Task<bool> ProcessUpdatesAsync(CancellationToken token)
```
@ -234,7 +238,7 @@ protected abstract Task<bool> ProcessEvent(GameEvent E)
##### Arguments
| Type | Name | Description |
| --- | --- | --- |
| [`GameEvent`](./sharedlibrarycore-GameEvent) | E | Event |
| [`GameEvent`](./GameEvent.md) | E | Event |
##### Summary
Process any server event
@ -249,9 +253,10 @@ public abstract Task ExecuteEvent(GameEvent E)
##### Arguments
| Type | Name | Description |
| --- | --- | --- |
| [`GameEvent`](./sharedlibrarycore-GameEvent) | E | |
| [`GameEvent`](./GameEvent.md) | E | |
#### Broadcast [1/2]
[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Server.cs#L248)
```csharp
public GameEvent Broadcast(string message, EFClient sender)
```
@ -259,12 +264,13 @@ public GameEvent Broadcast(string message, EFClient sender)
| Type | Name | Description |
| --- | --- | --- |
| `string` | message | Message to be sent to all players |
| [`EFClient`](./sharedlibrarycoredatabasemodels-EFClient) | sender | Client that initiated the broadcast |
| [`EFClient`](database/models/EFClient.md) | sender | Client that initiated the broadcast |
##### Summary
Send a message to all players
#### Broadcast [2/2]
[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Server.cs#L270)
```csharp
public void Broadcast(IEnumerable<string> messages, EFClient sender)
```
@ -272,7 +278,7 @@ public void Broadcast(IEnumerable<string> messages, EFClient sender)
| Type | Name | Description |
| --- | --- | --- |
| `IEnumerable`&lt;`string`&gt; | messages | |
| [`EFClient`](./sharedlibrarycoredatabasemodels-EFClient) | sender | |
| [`EFClient`](database/models/EFClient.md) | sender | |
#### BroadcastAsync
```csharp
@ -282,7 +288,7 @@ public async Task BroadcastAsync(IEnumerable<string> messages, EFClient sender,
| Type | Name | Description |
| --- | --- | --- |
| `IEnumerable`&lt;`string`&gt; | messages | |
| [`EFClient`](./sharedlibrarycoredatabasemodels-EFClient) | sender | |
| [`EFClient`](database/models/EFClient.md) | sender | |
| `CancellationToken` | token | |
#### Tell
@ -293,12 +299,13 @@ protected async Task Tell(string message, EFClient targetClient)
| Type | Name | Description |
| --- | --- | --- |
| `string` | message | Message to send |
| [`EFClient`](./sharedlibrarycoredatabasemodels-EFClient) | targetClient | EFClient to send message to |
| [`EFClient`](database/models/EFClient.md) | targetClient | EFClient to send message to |
##### Summary
Send a message to a particular players
#### ToAdmins
[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Server.cs#L343)
```csharp
public void ToAdmins(string message)
```
@ -311,6 +318,7 @@ public void ToAdmins(string message)
Send a message to all admins on the server
#### Kick [2/2]
[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Server.cs#L356)
```csharp
public Task Kick(string reason, EFClient target, EFClient origin)
```
@ -318,8 +326,8 @@ public Task Kick(string reason, EFClient target, EFClient origin)
| Type | Name | Description |
| --- | --- | --- |
| `string` | reason | Reason for kicking |
| [`EFClient`](./sharedlibrarycoredatabasemodels-EFClient) | target | EFClient to kick |
| [`EFClient`](./sharedlibrarycoredatabasemodels-EFClient) | origin | Client initating the kick |
| [`EFClient`](database/models/EFClient.md) | target | EFClient to kick |
| [`EFClient`](database/models/EFClient.md) | origin | Client initating the kick |
##### Summary
Kick a player from the server
@ -333,8 +341,8 @@ public abstract Task TempBan(string reason, TimeSpan length, EFClient target, EF
| --- | --- | --- |
| `string` | reason | Reason for banning the player |
| `TimeSpan` | length | Duration of the ban |
| [`EFClient`](./sharedlibrarycoredatabasemodels-EFClient) | target | The client to ban |
| [`EFClient`](./sharedlibrarycoredatabasemodels-EFClient) | origin | The client performing the ban |
| [`EFClient`](database/models/EFClient.md) | target | The client to ban |
| [`EFClient`](database/models/EFClient.md) | origin | The client performing the ban |
##### Summary
Temporarily ban a player ( default 1 hour ) from the server
@ -347,8 +355,8 @@ public abstract Task Ban(string reason, EFClient target, EFClient origin, bool i
| Type | Name | Description |
| --- | --- | --- |
| `string` | reason | The reason for the ban |
| [`EFClient`](./sharedlibrarycoredatabasemodels-EFClient) | target | The person to ban |
| [`EFClient`](./sharedlibrarycoredatabasemodels-EFClient) | origin | The person who banned the target |
| [`EFClient`](database/models/EFClient.md) | target | The person to ban |
| [`EFClient`](database/models/EFClient.md) | origin | The person who banned the target |
| `bool` | isEvade | obsolete |
##### Summary
@ -362,8 +370,8 @@ public abstract Task Warn(string reason, EFClient target, EFClient origin)
| Type | Name | Description |
| --- | --- | --- |
| `string` | reason | |
| [`EFClient`](./sharedlibrarycoredatabasemodels-EFClient) | target | |
| [`EFClient`](./sharedlibrarycoredatabasemodels-EFClient) | origin | |
| [`EFClient`](database/models/EFClient.md) | target | |
| [`EFClient`](database/models/EFClient.md) | origin | |
#### Unban
```csharp
@ -373,8 +381,8 @@ public abstract Task Unban(string reason, EFClient targetClient, EFClient origin
| Type | Name | Description |
| --- | --- | --- |
| `string` | reason | reason for unban |
| [`EFClient`](./sharedlibrarycoredatabasemodels-EFClient) | targetClient | client being unbanned |
| [`EFClient`](./sharedlibrarycoredatabasemodels-EFClient) | originClient | client performing the unban |
| [`EFClient`](database/models/EFClient.md) | targetClient | client being unbanned |
| [`EFClient`](database/models/EFClient.md) | originClient | client performing the unban |
##### Summary
Unban a player by npID / GUID
@ -402,6 +410,7 @@ public abstract void InitializeTokens()
Initalize the macro variables
#### InitializeAutoMessages
[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Server.cs#L407)
```csharp
protected void InitializeAutoMessages()
```
@ -409,6 +418,7 @@ protected void InitializeAutoMessages()
Initialize the messages to be broadcasted
#### ToString
[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Server.cs#L419)
```csharp
public override string ToString()
```
@ -425,9 +435,10 @@ public abstract Task<long> GetIdForServer(Server server)
##### Arguments
| Type | Name | Description |
| --- | --- | --- |
| [`Server`](sharedlibrarycore-Server) | server | |
| [`Server`](sharedlibrarycore/Server.md) | server | |
#### GetClientByNumber
[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Server.cs#L16707566)
```csharp
public EFClient GetClientByNumber(int clientNumber)
```

144
CodeDocumentation/SharedLibraryCore/sharedlibrarycore-Utilities.md → CodeDocumentation/SharedLibraryCore/Utilities.md

@ -28,7 +28,7 @@
| --- | --- |
| `IServiceCollection` | [`AddConfiguration`](#addconfiguration)(`IServiceCollection` serviceCollection, `string` fileName, `TConfigurationType` defaultConfig) |
| `double``[]` | [`AngleStuff`](#anglestuff)(`Vector3` a, `Vector3` b) |
| [`EFClient`](./sharedlibrarycoredatabasemodels-EFClient) | [`AsConsoleClient`](#asconsoleclient)([`IGameServer`](./sharedlibrarycoreinterfaces-IGameServer) server) |
| [`EFClient`](database/models/EFClient.md) | [`AsConsoleClient`](#asconsoleclient)([`IGameServer`](interfaces/IGameServer.md) server) |
| `string` | [`CapClientName`](#capclientname)(`string` name, `int` maxLength)<br>caps client name to the specified character length - 3<br> and adds ellipses to the end of the remaining client name |
| `long` | [`ConvertGuidToLong`](#convertguidtolong-12)(`...`) |
| `string` | [`ConvertIPtoString`](#convertiptostring)(`Nullable`&lt;`int`&gt; ip) |
@ -37,41 +37,41 @@
| `Dictionary`&lt;`string`, `string`&gt; | [`DictionaryFromKeyValue`](#dictionaryfromkeyvalue)(`string` eventLine) |
| `void` | [`ExecuteAfterDelay`](#executeafterdelay-13)(`...`) |
| `Task`&lt;`string``[]`&gt; | [`ExecuteCommandAsync`](#executecommandasync-12)(`...`) |
| `string` | [`FindRuleForReason`](#findruleforreason)(`string` reason, [`ApplicationConfiguration`](./sharedlibrarycoreconfiguration-ApplicationConfiguration) appConfig, [`Server`](./sharedlibrarycore-Server) server) |
| `string` | [`FindRuleForReason`](#findruleforreason)(`string` reason, [`ApplicationConfiguration`](configuration/ApplicationConfiguration.md) appConfig, [`Server`](./Server.md) server) |
| `string` | [`FixDirectoryCharacters`](#fixdirectorycharacters)(`string` path)<br>replaces any directory separator chars with the platform specific character |
| `Vector3` | [`FixIW4Angles`](#fixiw4angles)(`Vector3` vector) |
| `string` | [`FixIW4ForwardSlash`](#fixiw4forwardslash)(`string` str)<br>returns a "fixed" string that prevents message truncation in IW4 (and probably other Q3 clients) |
| `string` | [`FormatExt`](#formatext)(`string` input, `object``[]` values) |
| `string` | [`FormatMessageForEngine`](#formatmessageforengine)(`string` str, [`IRConParserConfiguration`](./sharedlibrarycoreinterfaces-IRConParserConfiguration) config) |
| `string` | [`FormatMessageForEngine`](#formatmessageforengine)(`string` str, [`IRConParserConfiguration`](interfaces/IRConParserConfiguration.md) config) |
| `string``[]` | [`FragmentMessageForDisplay`](#fragmentmessagefordisplay)(`string` message) |
| `long` | [`GenerateGuidFromString`](#generateguidfromstring)(`string` value)<br>generates a numerical hashcode from a string value |
| `string` | [`GetCommandLine`](#getcommandline)(`int` pId) |
| `Task`&lt;[`Dvar`](./sharedlibrarycore-DvarT)&lt;`T`&gt;&gt; | [`GetDvarAsync`](#getdvarasync-12)(`...`) |
| `Task`&lt;[`Dvar`](./DvarT.md)&lt;`T`&gt;&gt; | [`GetDvarAsync`](#getdvarasync-12)(`...`) |
| `Task`&lt;`string`&gt; | [`GetExternalIP`](#getexternalip)()<br>retrieves the external IP address of the current running machine |
| `Game` | [`GetGame`](#getgame)(`string` gameName) |
| `Task`&lt;`IDictionary`&lt;`string`, `string`&gt;&gt; | [`GetInfoAsync`](#getinfoasync)([`Server`](./sharedlibrarycore-Server) server, `Nullable`&lt;`TimeSpan`&gt; delay) |
| `Task`&lt;`IDictionary`&lt;`string`, `string`&gt;&gt; | [`GetInfoAsync`](#getinfoasync)([`Server`](./Server.md) server, `Nullable`&lt;`TimeSpan`&gt; delay) |
| `string` | [`GetLocalizedGametype`](#getlocalizedgametype)(`string` input)<br>Get the full gametype name |
| `Task`&lt;[`Dvar`](./sharedlibrarycore-DvarT)&lt;`T`&gt;&gt; | [`GetMappedDvarValueOrDefaultAsync`](#getmappeddvarvalueordefaultasync)([`Server`](./sharedlibrarycore-Server) server, `string` dvarName, `string` infoResponseName, `IDictionary`&lt;`string`, `string`&gt; infoResponse, `T` overrideDefault, `CancellationToken` token) |
| `Task`&lt;[`Dvar`](./DvarT.md)&lt;`T`&gt;&gt; | [`GetMappedDvarValueOrDefaultAsync`](#getmappeddvarvalueordefaultasync)([`Server`](./Server.md) server, `string` dvarName, `string` infoResponseName, `IDictionary`&lt;`string`, `string`&gt; infoResponse, `T` overrideDefault, `CancellationToken` token) |
| `int` | [`GetStableHashCode`](#getstablehashcode)(`string` str) |
| `Task`&lt;[`IStatusResponse`](./sharedlibrarycoreinterfaces-IStatusResponse)&gt; | [`GetStatusAsync`](#getstatusasync)([`Server`](./sharedlibrarycore-Server) server, `CancellationToken` token) |
| `Task`&lt;[`IStatusResponse`](interfaces/IStatusResponse.md)&gt; | [`GetStatusAsync`](#getstatusasync)([`Server`](./Server.md) server, `CancellationToken` token) |
| `double` | [`GetVersionAsDouble`](#getversionasdouble)() |
| `string` | [`GetVersionAsString`](#getversionasstring)() |
| `bool` | [`HasPermission`](#haspermission-12)(`...`) |
| `string` | [`HumanizeForCurrentCulture`](#humanizeforcurrentculture-12)(`...`)<br>wrapper method for humanizee that uses current current culture |
| [`EFClient`](./sharedlibrarycoredatabasemodels-EFClient) | [`IW4MAdminClient`](#iw4madminclient)([`Server`](./sharedlibrarycore-Server) server) |
| [`EFClient`](database/models/EFClient.md) | [`IW4MAdminClient`](#iw4madminclient)([`Server`](./Server.md) server) |
| `bool` | [`IsBotGuid`](#isbotguid)(`string` guid)<br>determines if the guid provided appears to be a bot guid<br> "1277538174" - (Pluto?)WaW (T4) |
| `bool` | [`IsBroadcastCommand`](#isbroadcastcommand)(`string` str, `string` broadcastCommandPrefix) |
| `bool` | [`IsCodGame`](#iscodgame)([`Server`](./sharedlibrarycore-Server) server) |
| `bool` | [`IsCodGame`](#iscodgame)([`Server`](./Server.md) server) |
| `bool` | [`IsInternal`](#isinternal)(`IPAddress` toTest)<br>https://stackoverflow.com/questions/8113546/how-to-determine-whether-an-ip-address-in-private/39120248<br> An extension method to determine if an IP address is internal, as specified in RFC1918 |
| `bool` | [`IsPrivileged`](#isprivileged)([`EFClient`](./sharedlibrarycoredatabasemodels-EFClient) p)<br>Helper extension that determines if a user is a privileged client |
| `bool` | [`IsPrivileged`](#isprivileged)([`EFClient`](database/models/EFClient.md) p)<br>Helper extension that determines if a user is a privileged client |
| `bool` | [`IsQuickMessage`](#isquickmessage)(`string` message)<br>Determines if the given message is a quick message |
| `bool` | [`IsRemoteLog`](#isremotelog)(`string` log)<br>indicates if the given log path is a remote (http) uri |
| `bool` | [`IsZombieServer`](#iszombieserver)([`Server`](./sharedlibrarycore-Server) server)<br>indicates if the given server is running a zombie game mode |
| `bool` | [`IsZombieServer`](#iszombieserver)([`Server`](./Server.md) server)<br>indicates if the given server is running a zombie game mode |
| `PenaltyType``[]` | [`LinkedPenaltyTypes`](#linkedpenaltytypes)()<br>returns a list of penalty types that should be shown across all profiles |
| `string` | [`MakeAbbreviation`](#makeabbreviation)(`string` gameName) |
| `Permission` | [`MatchPermission`](#matchpermission)(`string` str) |
| `TimeSpan` | [`ParseTimespan`](#parsetimespan)(`string` input) |
| `Task`&lt;`string`&gt; | [`ProcessMessageToken`](#processmessagetoken)([`Server`](./sharedlibrarycore-Server) server, `IList`&lt;[`MessageToken`](./sharedlibrarycorehelpers-MessageToken)&gt; tokens, `string` str) |
| `Task`&lt;`string`&gt; | [`ProcessMessageToken`](#processmessagetoken)([`Server`](./Server.md) server, `IList`&lt;[`MessageToken`](helpers/MessageToken.md)&gt; tokens, `string` str) |
| `bool` | [`PromptBool`](#promptbool)(`string` question, `string` description, `bool` defaultValue)<br>prompt user to answer a yes/no question |
| `int` | [`PromptInt`](#promptint)(`string` question, `string` description, `int` minValue, `int` maxValue, `Nullable`&lt;`int`&gt; defaultValue) |
| (`int` Item1, `T` Item2) | [`PromptSelection`](#promptselection)(`string` question, `T` defaultValue, `string` description, `T``[]` selections) |
@ -80,18 +80,18 @@
| `string` | [`RemoveWords`](#removewords)(`string` str, `int` num) |
| `Task` | [`SetDvarAsync`](#setdvarasync-12)(`...`) |
| `bool` | [`ShouldHideLevel`](#shouldhidelevel)(`Permission` perm) |
| [`WebfrontTranslationHelper`](./sharedlibrarycoredtosmeta-WebfrontTranslationHelper)`[]` | [`SplitTranslationTokens`](#splittranslationtokens)(`string` translationKey)<br>parses translation string into tokens that are able to be formatted by the webfront |
| [`WebfrontTranslationHelper`](dtos/meta/WebfrontTranslationHelper.md)`[]` | [`SplitTranslationTokens`](#splittranslationtokens)(`string` translationKey)<br>parses translation string into tokens that are able to be formatted by the webfront |
| `string` | [`StripColors`](#stripcolors)(`string` str)<br>Remove all IW Engine color codes |
| `string` | [`ToBase64UrlSafeString`](#tobase64urlsafestring)(`string` src) |
| `float` | [`ToDegrees`](#todegrees)(`float` value) |
| `string` | [`ToLocalizedLevelName`](#tolocalizedlevelname)(`Permission` permission) |
| `string` | [`ToNumericalString`](#tonumericalstring-14)(`...`) |
| [`EFClient`](./sharedlibrarycoredatabasemodels-EFClient) | [`ToPartialClient`](#topartialclient)(`EFClient` client) |
| [`EFClient`](database/models/EFClient.md) | [`ToPartialClient`](#topartialclient)(`EFClient` client) |
| `float` | [`ToRadians`](#toradians)(`float` value) |
| `string` | [`ToStandardFormat`](#tostandardformat-12)(`...`) |
| `string` | [`ToTranslatedName`](#totranslatedname)([`MetaType`](./sharedlibrarycoreinterfaces-MetaType) metaType) |
| `string` | [`ToTranslatedName`](#totranslatedname)([`MetaType`](interfaces/MetaType.md) metaType) |
| `string` | [`TrimNewLine`](#trimnewline)(`string` str)<br>trims new line and whitespace from string |
| `Task`&lt;`bool`&gt; | [`TryCreatePenalty`](#trycreatepenalty)(`EFPenalty` penalty, [`IEntityService`](./sharedlibrarycoreinterfaces-IEntityServiceT)&lt;`EFPenalty`&gt; penaltyService, `ILogger` logger) |
| `Task`&lt;`bool`&gt; | [`TryCreatePenalty`](#trycreatepenalty)(`EFPenalty` penalty, [`IEntityService`](interfaces/IEntityServiceT.md)&lt;`EFPenalty`&gt; penaltyService, `ILogger` logger) |
| `Task`&lt;`T`&gt; | [`WithTimeout`](#withtimeout-12)(`...`) |
| `Task` | [`WithWaitCancellation`](#withwaitcancellation-12)(`...`)<br>https://www.planetgeek.ch/2016/12/08/async-method-without-cancellation-support-do-it-my-way/ |
@ -104,6 +104,7 @@
## Details
### Methods
#### ToStandardFormat [1/2]
[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Utilities.cs#L53)
```csharp
public static string ToStandardFormat(Nullable<DateTime> time)
```
@ -113,6 +114,7 @@ public static string ToStandardFormat(Nullable<DateTime> time)
| `Nullable`&lt;`DateTime`&gt; | time | |
#### ToStandardFormat [2/2]
[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Utilities.cs#L54)
```csharp
public static string ToStandardFormat(DateTime time)
```
@ -122,24 +124,27 @@ public static string ToStandardFormat(DateTime time)
| `DateTime` | time | |
#### IW4MAdminClient
[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Utilities.cs#L57)
```csharp
public static EFClient IW4MAdminClient(Server server)
```
##### Arguments
| Type | Name | Description |
| --- | --- | --- |
| [`Server`](./sharedlibrarycore-Server) | server | |
| [`Server`](./Server.md) | server | |
#### AsConsoleClient
[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Utilities.cs#L73)
```csharp
public static EFClient AsConsoleClient(IGameServer server)
```
##### Arguments
| Type | Name | Description |
| --- | --- | --- |
| [`IGameServer`](./sharedlibrarycoreinterfaces-IGameServer) | server | |
| [`IGameServer`](interfaces/IGameServer.md) | server | |
#### RemoveWords
[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Utilities.cs#L97)
```csharp
public static string RemoveWords(string str, int num)
```
@ -150,6 +155,7 @@ public static string RemoveWords(string str, int num)
| `int` | num | |
#### CapClientName
[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Utilities.cs#L123)
```csharp
public static string CapClientName(string name, int maxLength)
```
@ -167,6 +173,7 @@ caps client name to the specified character length - 3
#### MatchPermission
[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Utilities.cs#L133)
```csharp
public static Permission MatchPermission(string str)
```
@ -176,6 +183,7 @@ public static Permission MatchPermission(string str)
| `string` | str | |
#### StripColors
[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Utilities.cs#L153)
```csharp
public static string StripColors(string str)
```
@ -191,6 +199,7 @@ Remove all IW Engine color codes
#### FixIW4ForwardSlash
[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Utilities.cs#L170)
```csharp
public static string FixIW4ForwardSlash(string str)
```
@ -206,6 +215,7 @@ returns a "fixed" string that prevents message truncation in IW4 (and probably o
#### RemoveDiacritics
[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Utilities.cs#L175)
```csharp
public static string RemoveDiacritics(string text)
```
@ -215,6 +225,7 @@ public static string RemoveDiacritics(string text)
| `string` | text | |
#### FormatMessageForEngine
[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Utilities.cs#L191)
```csharp
public static string FormatMessageForEngine(string str, IRConParserConfiguration config)
```
@ -222,16 +233,17 @@ public static string FormatMessageForEngine(string str, IRConParserConfiguration
| Type | Name | Description |
| --- | --- | --- |
| `string` | str | |
| [`IRConParserConfiguration`](./sharedlibrarycoreinterfaces-IRConParserConfiguration) | config | |
| [`IRConParserConfiguration`](interfaces/IRConParserConfiguration.md) | config | |
#### IsZombieServer
[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Utilities.cs#L223)
```csharp
public static bool IsZombieServer(Server server)
```
##### Arguments
| Type | Name | Description |
| --- | --- | --- |
| [`Server`](./sharedlibrarycore-Server) | server | |
| [`Server`](./Server.md) | server | |
##### Summary
indicates if the given server is running a zombie game mode
@ -240,15 +252,17 @@ indicates if the given server is running a zombie game mode
#### IsCodGame
[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Utilities.cs#L229)
```csharp
public static bool IsCodGame(Server server)
```
##### Arguments
| Type | Name | Description |
| --- | --- | --- |
| [`Server`](./sharedlibrarycore-Server) | server | |
| [`Server`](./Server.md) | server | |
#### ConvertLevelToColor
[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Utilities.cs#L240)
```csharp
public static string ConvertLevelToColor(Permission level, string localizedLevel)
```
@ -259,6 +273,7 @@ public static string ConvertLevelToColor(Permission level, string localizedLevel
| `string` | localizedLevel | |
#### ToLocalizedLevelName
[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Utilities.cs#L256)
```csharp
public static string ToLocalizedLevelName(Permission permission)
```
@ -274,11 +289,12 @@ public static async Task<string> ProcessMessageToken(Server server, IList<Messag
##### Arguments
| Type | Name | Description |
| --- | --- | --- |
| [`Server`](./sharedlibrarycore-Server) | server | |
| `IList`&lt;[`MessageToken`](./sharedlibrarycorehelpers-MessageToken)&gt; | tokens | |
| [`Server`](./Server.md) | server | |
| `IList`&lt;[`MessageToken`](helpers/MessageToken.md)&gt; | tokens | |
| `string` | str | |
#### IsBroadcastCommand
[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Utilities.cs#L284)
```csharp
public static bool IsBroadcastCommand(string str, string broadcastCommandPrefix)
```
@ -289,6 +305,7 @@ public static bool IsBroadcastCommand(string str, string broadcastCommandPrefix)
| `string` | broadcastCommandPrefix | |
#### GetLocalizedGametype
[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Utilities.cs#L294)
```csharp
public static string GetLocalizedGametype(string input)
```
@ -304,6 +321,7 @@ Get the full gametype name
#### ConvertGuidToLong [1/2]
[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Utilities.cs#L345)
```csharp
public static long ConvertGuidToLong(string str, NumberStyles numberStyle, Nullable<long> fallback)
```
@ -315,6 +333,7 @@ public static long ConvertGuidToLong(string str, NumberStyles numberStyle, Nulla
| `Nullable`&lt;`long`&gt; | fallback | |
#### ConvertGuidToLong [2/2]
[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Utilities.cs#L358)
```csharp
public static long ConvertGuidToLong(string str, NumberStyles numberStyle, bool convertSigned, Nullable<long> fallback)
```
@ -327,6 +346,7 @@ public static long ConvertGuidToLong(string str, NumberStyles numberStyle, bool
| `Nullable`&lt;`long`&gt; | fallback | |
#### IsBotGuid
[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Utilities.cs#L419)
```csharp
public static bool IsBotGuid(string guid)
```
@ -343,6 +363,7 @@ determines if the guid provided appears to be a bot guid
true if is bot guid, otherwise false
#### GenerateGuidFromString
[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Utilities.cs#L429)
```csharp
public static long GenerateGuidFromString(string value)
```
@ -358,6 +379,7 @@ generates a numerical hashcode from a string value
#### GetStableHashCode
[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Utilities.cs#L435)
```csharp
public static int GetStableHashCode(string str)
```
@ -367,6 +389,7 @@ public static int GetStableHashCode(string str)
| `string` | str | |
#### ConvertToIP
[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Utilities.cs#L457)
```csharp
public static Nullable<int> ConvertToIP(string str)
```
@ -376,6 +399,7 @@ public static Nullable<int> ConvertToIP(string str)
| `string` | str | |
#### ConvertIPtoString
[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Utilities.cs#L465)
```csharp
public static string ConvertIPtoString(Nullable<int> ip)
```
@ -385,6 +409,7 @@ public static string ConvertIPtoString(Nullable<int> ip)
| `Nullable`&lt;`int`&gt; | ip | |
#### GetGame
[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Utilities.cs#L470)
```csharp
public static Game GetGame(string gameName)
```
@ -394,6 +419,7 @@ public static Game GetGame(string gameName)
| `string` | gameName | |
#### ParseTimespan
[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Utilities.cs#L510)
```csharp
public static TimeSpan ParseTimespan(string input)
```
@ -403,6 +429,7 @@ public static TimeSpan ParseTimespan(string input)
| `string` | input | |
#### HasPermission [1/2]
[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Utilities.cs#L16707566)
```csharp
public static bool HasPermission<TEntity, TPermission>(IEnumerable<string> permissionsSet, TEntity entity, TPermission permission)
where TEntity : Enum
@ -416,6 +443,7 @@ where TPermission : Enum
| `TPermission` | permission | |
#### HasPermission [2/2]
[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Utilities.cs#L589)
```csharp
public static bool HasPermission<TEntity, TPermission>(ApplicationConfiguration appConfig, Permission permissionLevel, TEntity entity, TPermission permission)
where TEntity : Enum
@ -424,12 +452,13 @@ where TPermission : Enum
##### Arguments
| Type | Name | Description |
| --- | --- | --- |
| [`ApplicationConfiguration`](./sharedlibrarycoreconfiguration-ApplicationConfiguration) | appConfig | |
| [`ApplicationConfiguration`](configuration/ApplicationConfiguration.md) | appConfig | |
| `Permission` | permissionLevel | |
| `TEntity` | entity | |
| `TPermission` | permission | |
#### LinkedPenaltyTypes
[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Utilities.cs#L599)
```csharp
public static PenaltyType LinkedPenaltyTypes()
```
@ -440,13 +469,14 @@ returns a list of penalty types that should be shown across all profiles
#### IsPrivileged
[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Utilities.cs#L616)
```csharp
public static bool IsPrivileged(EFClient p)
```
##### Arguments
| Type | Name | Description |
| --- | --- | --- |
| [`EFClient`](./sharedlibrarycoredatabasemodels-EFClient) | p | |
| [`EFClient`](database/models/EFClient.md) | p | |
##### Summary
Helper extension that determines if a user is a privileged client
@ -455,6 +485,7 @@ Helper extension that determines if a user is a privileged client
#### PromptBool
[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Utilities.cs#L628)
```csharp
public static bool PromptBool(string question, string description, bool defaultValue)
```
@ -472,6 +503,7 @@ prompt user to answer a yes/no question
#### PromptSelection
[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Utilities.cs#L645)
```csharp
public static Tuple<int,T> PromptSelection<T>(string question, T defaultValue, string description, T[] selections)
where T :
@ -485,6 +517,7 @@ where T :
| `T``[]` | selections | |
#### PromptInt
[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Utilities.cs#L16707566)
```csharp
public static int PromptInt(string question, string description, int minValue, int maxValue, Nullable<int> defaultValue)
```
@ -498,6 +531,7 @@ public static int PromptInt(string question, string description, int minValue, i
| `Nullable`&lt;`int`&gt; | defaultValue | |
#### PromptString
[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Utilities.cs#L16707566)
```csharp
public static string PromptString(string question, string description, string defaultValue)
```
@ -515,6 +549,7 @@ prompt use to enter a string response
#### DictionaryFromKeyValue
[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Utilities.cs#L738)
```csharp
public static Dictionary<string, string> DictionaryFromKeyValue(string eventLine)
```
@ -524,6 +559,7 @@ public static Dictionary<string, string> DictionaryFromKeyValue(string eventLine
| `string` | eventLine | |
#### GetCommandLine
[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Utilities.cs#L761)
```csharp
public static string GetCommandLine(int pId)
```
@ -533,6 +569,7 @@ public static string GetCommandLine(int pId)
| `int` | pId | |
#### IsRemoteLog
[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Utilities.cs#L789)
```csharp
public static bool IsRemoteLog(string log)
```
@ -548,6 +585,7 @@ indicates if the given log path is a remote (http) uri
#### ToBase64UrlSafeString
[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Utilities.cs#L794)
```csharp
public static string ToBase64UrlSafeString(string src)
```
@ -564,7 +602,7 @@ where T :
##### Arguments
| Type | Name | Description |
| --- | --- | --- |
| [`Server`](./sharedlibrarycore-Server) | server | |
| [`Server`](./Server.md) | server | |
| `string` | dvarName | |
| `T` | fallbackValue | |
| `CancellationToken` | token | |
@ -577,7 +615,7 @@ where T :
##### Arguments
| Type | Name | Description |
| --- | --- | --- |
| [`Server`](./sharedlibrarycore-Server) | server | |
| [`Server`](./Server.md) | server | |
| `string` | dvarName | |
| `T` | fallbackValue | |
@ -589,7 +627,7 @@ where T :
##### Arguments
| Type | Name | Description |
| --- | --- | --- |
| [`Server`](./sharedlibrarycore-Server) | server | |
| [`Server`](./Server.md) | server | |
| `string` | dvarName | |
| `string` | infoResponseName | |
| `IDictionary`&lt;`string`, `string`&gt; | infoResponse | |
@ -603,7 +641,7 @@ public static async Task SetDvarAsync(Server server, string dvarName, object dva
##### Arguments
| Type | Name | Description |
| --- | --- | --- |
| [`Server`](./sharedlibrarycore-Server) | server | |
| [`Server`](./Server.md) | server | |
| `string` | dvarName | |
| `object` | dvarValue | |
| `CancellationToken` | token | |
@ -615,7 +653,7 @@ public static async Task SetDvarAsync(Server server, string dvarName, object dva
##### Arguments
| Type | Name | Description |
| --- | --- | --- |
| [`Server`](./sharedlibrarycore-Server) | server | |
| [`Server`](./Server.md) | server | |
| `string` | dvarName | |
| `object` | dvarValue | |
@ -626,7 +664,7 @@ public static async Task<string> ExecuteCommandAsync(Server server, string comma
##### Arguments
| Type | Name | Description |
| --- | --- | --- |
| [`Server`](./sharedlibrarycore-Server) | server | |
| [`Server`](./Server.md) | server | |
| `string` | commandName | |
| `CancellationToken` | token | |
@ -637,7 +675,7 @@ public static async Task<string> ExecuteCommandAsync(Server server, string comma
##### Arguments
| Type | Name | Description |
| --- | --- | --- |
| [`Server`](./sharedlibrarycore-Server) | server | |
| [`Server`](./Server.md) | server | |
| `string` | commandName | |
#### GetStatusAsync
@ -647,7 +685,7 @@ public static async Task<IStatusResponse> GetStatusAsync(Server server, Cancella
##### Arguments
| Type | Name | Description |
| --- | --- | --- |
| [`Server`](./sharedlibrarycore-Server) | server | |
| [`Server`](./Server.md) | server | |
| `CancellationToken` | token | |
#### GetInfoAsync
@ -657,20 +695,23 @@ public static async Task<IDictionary<string, string>> GetInfoAsync(Server server
##### Arguments
| Type | Name | Description |
| --- | --- | --- |
| [`Server`](./sharedlibrarycore-Server) | server | |
| [`Server`](./Server.md) | server | |
| `Nullable`&lt;`TimeSpan`&gt; | delay | |
#### GetVersionAsDouble
[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Utilities.cs#L901)
```csharp
public static double GetVersionAsDouble()
```
#### GetVersionAsString
[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Utilities.cs#L908)
```csharp
public static string GetVersionAsString()
```
#### FormatExt
[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Utilities.cs#L913)
```csharp
public static string FormatExt(string input, object[] values)
```
@ -681,6 +722,7 @@ public static string FormatExt(string input, object[] values)
| `object``[]` | values | |
#### IsInternal
[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Utilities.cs#L940)
```csharp
public static bool IsInternal(IPAddress toTest)
```
@ -707,6 +749,7 @@ retrieves the external IP address of the current running machine
#### IsQuickMessage
[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Utilities.cs#L986)
```csharp
public static bool IsQuickMessage(string message)
```
@ -722,6 +765,7 @@ Determines if the given message is a quick message
true if the
#### TrimNewLine
[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Utilities.cs#L996)
```csharp
public static string TrimNewLine(string str)
```
@ -737,6 +781,7 @@ trims new line and whitespace from string
#### FixIW4Angles
[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Utilities.cs#L1001)
```csharp
public static Vector3 FixIW4Angles(Vector3 vector)
```
@ -746,6 +791,7 @@ public static Vector3 FixIW4Angles(Vector3 vector)
| `Vector3` | vector | |
#### ToRadians
[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Utilities.cs#L1010)
```csharp
public static float ToRadians(float value)
```
@ -755,6 +801,7 @@ public static float ToRadians(float value)
| `float` | value | |
#### ToDegrees
[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Utilities.cs#L1015)
```csharp
public static float ToDegrees(float value)
```
@ -764,6 +811,7 @@ public static float ToDegrees(float value)
| `float` | value | |
#### AngleStuff
[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Utilities.cs#L1020)
```csharp
public static double AngleStuff(Vector3 a, Vector3 b)
```
@ -781,7 +829,7 @@ public static async Task<bool> TryCreatePenalty(EFPenalty penalty, IEntityServic
| Type | Name | Description |
| --- | --- | --- |
| `EFPenalty` | penalty | |
| [`IEntityService`](./sharedlibrarycoreinterfaces-IEntityServiceT)&lt;`EFPenalty`&gt; | penaltyService | |
| [`IEntityService`](interfaces/IEntityServiceT.md)&lt;`EFPenalty`&gt; | penaltyService | |
| `ILogger` | logger | |
#### WithWaitCancellation [1/2]
@ -830,6 +878,7 @@ public static async Task WithTimeout(Task task, TimeSpan timeout)
| `TimeSpan` | timeout | |
#### ShouldHideLevel
[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Utilities.cs#L1094)
```csharp
public static bool ShouldHideLevel(Permission perm)
```
@ -839,6 +888,7 @@ public static bool ShouldHideLevel(Permission perm)
| `Permission` | perm | |
#### SplitTranslationTokens
[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Utilities.cs#L1104)
```csharp
public static WebfrontTranslationHelper SplitTranslationTokens(string translationKey)
```
@ -854,6 +904,7 @@ parses translation string into tokens that are able to be formatted by the webfr
#### FixDirectoryCharacters
[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Utilities.cs#L1156)
```csharp
public static string FixDirectoryCharacters(string path)
```
@ -869,6 +920,7 @@ replaces any directory separator chars with the platform specific character
#### HumanizeForCurrentCulture [1/2]
[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Utilities.cs#L1169)
```csharp
public static string HumanizeForCurrentCulture(TimeSpan timeSpan, int precision, TimeUnit maxUnit, TimeUnit minUnit, string collectionSeparator, bool toWords)
```
@ -886,6 +938,7 @@ public static string HumanizeForCurrentCulture(TimeSpan timeSpan, int precision,
wrapper method for humanizee that uses current current culture
#### HumanizeForCurrentCulture [2/2]
[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Utilities.cs#L1179)
```csharp
public static string HumanizeForCurrentCulture(DateTime input, bool utcDate, Nullable<DateTime> dateToCompareAgainst, CultureInfo culture)
```
@ -898,15 +951,17 @@ public static string HumanizeForCurrentCulture(DateTime input, bool utcDate, Nul
| `CultureInfo` | culture | |
#### ToTranslatedName
[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Utilities.cs#L1184)
```csharp
public static string ToTranslatedName(MetaType metaType)
```
##### Arguments
| Type | Name | Description |
| --- | --- | --- |
| [`MetaType`](./sharedlibrarycoreinterfaces-MetaType) | metaType | |
| [`MetaType`](interfaces/MetaType.md) | metaType | |
#### ToPartialClient
[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Utilities.cs#L1189)
```csharp
public static EFClient ToPartialClient(EFClient client)
```
@ -916,6 +971,7 @@ public static EFClient ToPartialClient(EFClient client)
| `EFClient` | client | |
#### ToNumericalString [1/4]
[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Utilities.cs#L1215)
```csharp
public static string ToNumericalString(Nullable<int> value)
```
@ -925,6 +981,7 @@ public static string ToNumericalString(Nullable<int> value)
| `Nullable`&lt;`int`&gt; | value | |
#### ToNumericalString [2/4]
[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Utilities.cs#L1220)
```csharp
public static string ToNumericalString(int value)
```
@ -934,6 +991,7 @@ public static string ToNumericalString(int value)
| `int` | value | |
#### ToNumericalString [3/4]
[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Utilities.cs#L1225)
```csharp
public static string ToNumericalString(double value, int precision)
```
@ -944,6 +1002,7 @@ public static string ToNumericalString(double value, int precision)
| `int` | precision | |
#### ToNumericalString [4/4]
[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Utilities.cs#L1232)
```csharp
public static string ToNumericalString(Nullable<double> value, int precision)
```
@ -954,6 +1013,7 @@ public static string ToNumericalString(Nullable<double> value, int precision)
| `int` | precision | |
#### FragmentMessageForDisplay
[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Utilities.cs#L1237)
```csharp
public static string FragmentMessageForDisplay(string message)
```
@ -963,6 +1023,7 @@ public static string FragmentMessageForDisplay(string message)
| `string` | message | |
#### FindRuleForReason
[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Utilities.cs#L16707566)
```csharp
public static string FindRuleForReason(string reason, ApplicationConfiguration appConfig, Server server)
```
@ -970,10 +1031,11 @@ public static string FindRuleForReason(string reason, ApplicationConfiguration a
| Type | Name | Description |
| --- | --- | --- |
| `string` | reason | |
| [`ApplicationConfiguration`](./sharedlibrarycoreconfiguration-ApplicationConfiguration) | appConfig | |
| [`Server`](./sharedlibrarycore-Server) | server | |
| [`ApplicationConfiguration`](configuration/ApplicationConfiguration.md) | appConfig | |
| [`Server`](./Server.md) | server | |
#### MakeAbbreviation
[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Utilities.cs#L1294)
```csharp
public static string MakeAbbreviation(string gameName)
```
@ -983,6 +1045,7 @@ public static string MakeAbbreviation(string gameName)
| `string` | gameName | |
#### AddConfiguration
[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Utilities.cs#L16707566)
```csharp
public static IServiceCollection AddConfiguration<TConfigurationType>(IServiceCollection serviceCollection, string fileName, TConfigurationType defaultConfig)
where TConfigurationType :
@ -995,6 +1058,7 @@ where TConfigurationType :
| `TConfigurationType` | defaultConfig | |
#### ExecuteAfterDelay [1/3]
[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Utilities.cs#L1337)
```csharp
public static void ExecuteAfterDelay(TimeSpan duration, Func<CancellationToken, Task> action, CancellationToken token)
```
@ -1006,6 +1070,7 @@ public static void ExecuteAfterDelay(TimeSpan duration, Func<CancellationToken,
| `CancellationToken` | token | |
#### ExecuteAfterDelay [2/3]
[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Utilities.cs#L16707566)
```csharp
public static void ExecuteAfterDelay(int delayMs, Func<CancellationToken, Task> action, CancellationToken token)
```
@ -1017,6 +1082,7 @@ public static void ExecuteAfterDelay(int delayMs, Func<CancellationToken, Task>
| `CancellationToken` | token | |
#### ExecuteAfterDelay [3/3]
[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Utilities.cs#L1359)
```csharp
public static void ExecuteAfterDelay(Func<CancellationToken, Task> action, int delayMs, CancellationToken token)
```
@ -1028,11 +1094,13 @@ public static void ExecuteAfterDelay(Func<CancellationToken, Task> action, int d
| `CancellationToken` | token | |
#### <PromptInt>g__InputOrDefault|55_0
[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Utilities.cs#L690)
```csharp
internal static string <PromptInt>g__InputOrDefault|55_0()
```
#### <PromptString>g__InputOrDefault|56_0
[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Utilities.cs#L721)
```csharp
internal static string <PromptString>g__InputOrDefault|56_0()
```

0
CodeDocumentation/SharedLibraryCore/sharedlibrarycorealerts-Alert.md → CodeDocumentation/SharedLibraryCore/alerts/Alert.md

0
CodeDocumentation/SharedLibraryCore/sharedlibrarycorealertsalert-AlertCategory.md → CodeDocumentation/SharedLibraryCore/alerts/alert/AlertCategory.md

2
CodeDocumentation/SharedLibraryCore/sharedlibrarycorealertsalert-AlertState.md → CodeDocumentation/SharedLibraryCore/alerts/alert/AlertState.md

@ -38,12 +38,14 @@
## Details
### Constructors
#### AlertState
[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Alerts/Alert.cs#L18)
```csharp
public AlertState()
```
### Methods
#### Build
[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Alerts/Alert.cs#L31)
```csharp
public static AlertState Build()
```

13
CodeDocumentation/SharedLibraryCore/sharedlibrarycorecommands-BanCommand.md → CodeDocumentation/SharedLibraryCore/commands/BanCommand.md

@ -23,7 +23,7 @@ SharedLibraryCore.Command --> SharedLibraryCore.Commands.BanCommand
#### Public methods
| Returns | Name |
| --- | --- |
| `Task` | [`ExecuteAsync`](#executeasync)([`GameEvent`](./sharedlibrarycore-GameEvent) gameEvent) |
| `Task` | [`ExecuteAsync`](#executeasync)([`GameEvent`](../GameEvent.md) gameEvent) |
## Details
### Summary
@ -32,19 +32,20 @@ Permanently bans a client
### Inheritance
- [
`Command`
](./sharedlibrarycore-Command)
](../Command.md)
### Constructors
#### BanCommand
[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Commands/NativeCommands.cs#L308)
```csharp
public BanCommand(ApplicationConfiguration appConfig, CommandConfiguration config, ITranslationLookup translationLookup)
```
##### Arguments
| Type | Name | Description |
| --- | --- | --- |
| [`ApplicationConfiguration`](./sharedlibrarycoreconfiguration-ApplicationConfiguration) | appConfig | |
| [`CommandConfiguration`](./sharedlibrarycoreconfiguration-CommandConfiguration) | config | |
| [`ITranslationLookup`](./sharedlibrarycoreinterfaces-ITranslationLookup) | translationLookup | |
| [`ApplicationConfiguration`](../configuration/ApplicationConfiguration.md) | appConfig | |
| [`CommandConfiguration`](../configuration/CommandConfiguration.md) | config | |
| [`ITranslationLookup`](../interfaces/ITranslationLookup.md) | translationLookup | |
### Methods
#### ExecuteAsync
@ -54,6 +55,6 @@ public override async Task ExecuteAsync(GameEvent gameEvent)
##### Arguments
| Type | Name | Description |
| --- | --- | --- |
| [`GameEvent`](./sharedlibrarycore-GameEvent) | gameEvent | |
| [`GameEvent`](../GameEvent.md) | gameEvent | |
*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc)

0
CodeDocumentation/SharedLibraryCore/sharedlibrarycorecommands-CommandArgument.md → CodeDocumentation/SharedLibraryCore/commands/CommandArgument.md

10
CodeDocumentation/SharedLibraryCore/sharedlibrarycorecommands-CommandExtensions.md → CodeDocumentation/SharedLibraryCore/commands/CommandExtensions.md

@ -15,27 +15,29 @@
#### Public Static methods
| Returns | Name |
| --- | --- |
| `bool` | [`CanPerformActionOnTarget`](#canperformactionontarget)([`GameEvent`](./sharedlibrarycore-GameEvent) gameEvent) |
| `bool` | [`IsTargetingSelf`](#istargetingself)([`GameEvent`](./sharedlibrarycore-GameEvent) gameEvent) |
| `bool` | [`CanPerformActionOnTarget`](#canperformactionontarget)([`GameEvent`](../GameEvent.md) gameEvent) |
| `bool` | [`IsTargetingSelf`](#istargetingself)([`GameEvent`](../GameEvent.md) gameEvent) |
## Details
### Methods
#### IsTargetingSelf
[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Commands/CommandExtensions.cs#L6)
```csharp
public static bool IsTargetingSelf(GameEvent gameEvent)
```
##### Arguments
| Type | Name | Description |
| --- | --- | --- |
| [`GameEvent`](./sharedlibrarycore-GameEvent) | gameEvent | |
| [`GameEvent`](../GameEvent.md) | gameEvent | |
#### CanPerformActionOnTarget
[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Commands/CommandExtensions.cs#L11)
```csharp
public static bool CanPerformActionOnTarget(GameEvent gameEvent)
```
##### Arguments
| Type | Name | Description |
| --- | --- | --- |
| [`GameEvent`](./sharedlibrarycore-GameEvent) | gameEvent | |
| [`GameEvent`](../GameEvent.md) | gameEvent | |
*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc)

8
CodeDocumentation/SharedLibraryCore/sharedlibrarycorecommands-CommandProcessing.md → CodeDocumentation/SharedLibraryCore/commands/CommandProcessing.md

@ -15,7 +15,7 @@
#### Public Static methods
| Returns | Name |
| --- | --- |
| `Task`&lt;[`Command`](./sharedlibrarycore-Command)&gt; | [`ValidateCommand`](#validatecommand)([`GameEvent`](./sharedlibrarycore-GameEvent) gameEvent, [`ApplicationConfiguration`](./sharedlibrarycoreconfiguration-ApplicationConfiguration) appConfig, [`CommandConfiguration`](./sharedlibrarycoreconfiguration-CommandConfiguration) commandConfig) |
| `Task`&lt;[`Command`](../Command.md)&gt; | [`ValidateCommand`](#validatecommand)([`GameEvent`](../GameEvent.md) gameEvent, [`ApplicationConfiguration`](../configuration/ApplicationConfiguration.md) appConfig, [`CommandConfiguration`](../configuration/CommandConfiguration.md) commandConfig) |
## Details
### Constructors
@ -32,8 +32,8 @@ public static async Task<Command> ValidateCommand(GameEvent gameEvent, Applicati
##### Arguments
| Type | Name | Description |
| --- | --- | --- |
| [`GameEvent`](./sharedlibrarycore-GameEvent) | gameEvent | |
| [`ApplicationConfiguration`](./sharedlibrarycoreconfiguration-ApplicationConfiguration) | appConfig | |
| [`CommandConfiguration`](./sharedlibrarycoreconfiguration-CommandConfiguration) | commandConfig | |
| [`GameEvent`](../GameEvent.md) | gameEvent | |
| [`ApplicationConfiguration`](../configuration/ApplicationConfiguration.md) | appConfig | |
| [`CommandConfiguration`](../configuration/CommandConfiguration.md) | commandConfig | |
*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc)

11
CodeDocumentation/SharedLibraryCore/sharedlibrarycorecommands-ExecuteRConCommand.md → CodeDocumentation/SharedLibraryCore/commands/ExecuteRConCommand.md

@ -23,7 +23,7 @@ SharedLibraryCore.Command --> SharedLibraryCore.Commands.ExecuteRConCommand
#### Public methods
| Returns | Name |
| --- | --- |
| `Task` | [`ExecuteAsync`](#executeasync)([`GameEvent`](./sharedlibrarycore-GameEvent) E) |
| `Task` | [`ExecuteAsync`](#executeasync)([`GameEvent`](../GameEvent.md) E) |
## Details
### Summary
@ -32,18 +32,19 @@ Executes RCon command
### Inheritance
- [
`Command`
](./sharedlibrarycore-Command)
](../Command.md)
### Constructors
#### ExecuteRConCommand
[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Commands/NativeCommands.cs#L927)
```csharp
public ExecuteRConCommand(CommandConfiguration config, ITranslationLookup translationLookup)
```
##### Arguments
| Type | Name | Description |
| --- | --- | --- |
| [`CommandConfiguration`](./sharedlibrarycoreconfiguration-CommandConfiguration) | config | |
| [`ITranslationLookup`](./sharedlibrarycoreinterfaces-ITranslationLookup) | translationLookup | |
| [`CommandConfiguration`](../configuration/CommandConfiguration.md) | config | |
| [`ITranslationLookup`](../interfaces/ITranslationLookup.md) | translationLookup | |
### Methods
#### ExecuteAsync
@ -53,6 +54,6 @@ public override async Task ExecuteAsync(GameEvent E)
##### Arguments
| Type | Name | Description |
| --- | --- | --- |
| [`GameEvent`](./sharedlibrarycore-GameEvent) | E | |
| [`GameEvent`](../GameEvent.md) | E | |
*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc)

11
CodeDocumentation/SharedLibraryCore/sharedlibrarycorecommands-FastRestartCommand.md → CodeDocumentation/SharedLibraryCore/commands/FastRestartCommand.md

@ -23,7 +23,7 @@ SharedLibraryCore.Command --> SharedLibraryCore.Commands.FastRestartCommand
#### Public methods
| Returns | Name |
| --- | --- |
| `Task` | [`ExecuteAsync`](#executeasync)([`GameEvent`](./sharedlibrarycore-GameEvent) E) |
| `Task` | [`ExecuteAsync`](#executeasync)([`GameEvent`](../GameEvent.md) E) |
## Details
### Summary
@ -32,18 +32,19 @@ Fast restarts the map
### Inheritance
- [
`Command`
](./sharedlibrarycore-Command)
](../Command.md)
### Constructors
#### FastRestartCommand
[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Commands/NativeCommands.cs#L413)
```csharp
public FastRestartCommand(CommandConfiguration config, ITranslationLookup translationLookup)
```
##### Arguments
| Type | Name | Description |
| --- | --- | --- |
| [`CommandConfiguration`](./sharedlibrarycoreconfiguration-CommandConfiguration) | config | |
| [`ITranslationLookup`](./sharedlibrarycoreinterfaces-ITranslationLookup) | translationLookup | |
| [`CommandConfiguration`](../configuration/CommandConfiguration.md) | config | |
| [`ITranslationLookup`](../interfaces/ITranslationLookup.md) | translationLookup | |
### Methods
#### ExecuteAsync
@ -53,6 +54,6 @@ public override async Task ExecuteAsync(GameEvent E)
##### Arguments
| Type | Name | Description |
| --- | --- | --- |
| [`GameEvent`](./sharedlibrarycore-GameEvent) | E | |
| [`GameEvent`](../GameEvent.md) | E | |
*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc)

11
CodeDocumentation/SharedLibraryCore/sharedlibrarycorecommands-FlagClientCommand.md → CodeDocumentation/SharedLibraryCore/commands/FlagClientCommand.md

@ -23,7 +23,7 @@ SharedLibraryCore.Command --> SharedLibraryCore.Commands.FlagClientCommand
#### Public methods
| Returns | Name |
| --- | --- |
| `Task` | [`ExecuteAsync`](#executeasync)([`GameEvent`](./sharedlibrarycore-GameEvent) E) |
| `Task` | [`ExecuteAsync`](#executeasync)([`GameEvent`](../GameEvent.md) E) |
## Details
### Summary
@ -32,18 +32,19 @@ Flag given client for specified reason
### Inheritance
- [
`Command`
](./sharedlibrarycore-Command)
](../Command.md)
### Constructors
#### FlagClientCommand
[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Commands/NativeCommands.cs#L748)
```csharp
public FlagClientCommand(CommandConfiguration config, ITranslationLookup translationLookup)
```
##### Arguments
| Type | Name | Description |
| --- | --- | --- |
| [`CommandConfiguration`](./sharedlibrarycoreconfiguration-CommandConfiguration) | config | |
| [`ITranslationLookup`](./sharedlibrarycoreinterfaces-ITranslationLookup) | translationLookup | |
| [`CommandConfiguration`](../configuration/CommandConfiguration.md) | config | |
| [`ITranslationLookup`](../interfaces/ITranslationLookup.md) | translationLookup | |
### Methods
#### ExecuteAsync
@ -53,6 +54,6 @@ public override async Task ExecuteAsync(GameEvent E)
##### Arguments
| Type | Name | Description |
| --- | --- | --- |
| [`GameEvent`](./sharedlibrarycore-GameEvent) | E | |
| [`GameEvent`](../GameEvent.md) | E | |
*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc)

12
CodeDocumentation/SharedLibraryCore/sharedlibrarycorecommands-GetClientPingCommand.md → CodeDocumentation/SharedLibraryCore/commands/GetClientPingCommand.md

@ -23,7 +23,7 @@ SharedLibraryCore.Command --> SharedLibraryCore.Commands.GetClientPingCommand
#### Public methods
| Returns | Name |
| --- | --- |
| `Task` | [`ExecuteAsync`](#executeasync)([`GameEvent`](./sharedlibrarycore-GameEvent) E) |
| `Task` | [`ExecuteAsync`](#executeasync)([`GameEvent`](../GameEvent.md) E) |
## Details
### Summary
@ -32,27 +32,29 @@ Gets the ping of a client
### Inheritance
- [
`Command`
](./sharedlibrarycore-Command)
](../Command.md)
### Constructors
#### GetClientPingCommand
[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Commands/NativeCommands.cs#L1093)
```csharp
public GetClientPingCommand(CommandConfiguration config, ITranslationLookup translationLookup)
```
##### Arguments
| Type | Name | Description |
| --- | --- | --- |
| [`CommandConfiguration`](./sharedlibrarycoreconfiguration-CommandConfiguration) | config | |
| [`ITranslationLookup`](./sharedlibrarycoreinterfaces-ITranslationLookup) | translationLookup | |
| [`CommandConfiguration`](../configuration/CommandConfiguration.md) | config | |
| [`ITranslationLookup`](../interfaces/ITranslationLookup.md) | translationLookup | |
### Methods
#### ExecuteAsync
[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Commands/NativeCommands.cs#L1112)
```csharp
public override Task ExecuteAsync(GameEvent E)
```
##### Arguments
| Type | Name | Description |
| --- | --- | --- |
| [`GameEvent`](./sharedlibrarycore-GameEvent) | E | |
| [`GameEvent`](../GameEvent.md) | E | |
*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc)

13
CodeDocumentation/SharedLibraryCore/sharedlibrarycorecommands-KickCommand.md → CodeDocumentation/SharedLibraryCore/commands/KickCommand.md

@ -23,7 +23,7 @@ SharedLibraryCore.Command --> SharedLibraryCore.Commands.KickCommand
#### Public methods
| Returns | Name |
| --- | --- |
| `Task` | [`ExecuteAsync`](#executeasync)([`GameEvent`](./sharedlibrarycore-GameEvent) gameEvent) |
| `Task` | [`ExecuteAsync`](#executeasync)([`GameEvent`](../GameEvent.md) gameEvent) |
## Details
### Summary
@ -32,19 +32,20 @@ Kicks client for given reason
### Inheritance
- [
`Command`
](./sharedlibrarycore-Command)
](../Command.md)
### Constructors
#### KickCommand
[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Commands/NativeCommands.cs#L185)
```csharp
public KickCommand(ApplicationConfiguration appConfig, CommandConfiguration config, ITranslationLookup translationLookup)
```
##### Arguments
| Type | Name | Description |
| --- | --- | --- |
| [`ApplicationConfiguration`](./sharedlibrarycoreconfiguration-ApplicationConfiguration) | appConfig | |
| [`CommandConfiguration`](./sharedlibrarycoreconfiguration-CommandConfiguration) | config | |
| [`ITranslationLookup`](./sharedlibrarycoreinterfaces-ITranslationLookup) | translationLookup | |
| [`ApplicationConfiguration`](../configuration/ApplicationConfiguration.md) | appConfig | |
| [`CommandConfiguration`](../configuration/CommandConfiguration.md) | config | |
| [`ITranslationLookup`](../interfaces/ITranslationLookup.md) | translationLookup | |
### Methods
#### ExecuteAsync
@ -54,6 +55,6 @@ public override async Task ExecuteAsync(GameEvent gameEvent)
##### Arguments
| Type | Name | Description |
| --- | --- | --- |
| [`GameEvent`](./sharedlibrarycore-GameEvent) | gameEvent | |
| [`GameEvent`](../GameEvent.md) | gameEvent | |
*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc)

11
CodeDocumentation/SharedLibraryCore/sharedlibrarycorecommands-ListBanInfoCommand.md → CodeDocumentation/SharedLibraryCore/commands/ListBanInfoCommand.md

@ -23,7 +23,7 @@ SharedLibraryCore.Command --> SharedLibraryCore.Commands.ListBanInfoCommand
#### Public methods
| Returns | Name |
| --- | --- |
| `Task` | [`ExecuteAsync`](#executeasync)([`GameEvent`](./sharedlibrarycore-GameEvent) E) |
| `Task` | [`ExecuteAsync`](#executeasync)([`GameEvent`](../GameEvent.md) E) |
## Details
### Summary
@ -32,18 +32,19 @@ Lists ban information for given client
### Inheritance
- [
`Command`
](./sharedlibrarycore-Command)
](../Command.md)
### Constructors
#### ListBanInfoCommand
[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Commands/NativeCommands.cs#L878)
```csharp
public ListBanInfoCommand(CommandConfiguration config, ITranslationLookup translationLookup)
```
##### Arguments
| Type | Name | Description |
| --- | --- | --- |
| [`CommandConfiguration`](./sharedlibrarycoreconfiguration-CommandConfiguration) | config | |
| [`ITranslationLookup`](./sharedlibrarycoreinterfaces-ITranslationLookup) | translationLookup | |
| [`CommandConfiguration`](../configuration/CommandConfiguration.md) | config | |
| [`ITranslationLookup`](../interfaces/ITranslationLookup.md) | translationLookup | |
### Methods
#### ExecuteAsync
@ -53,6 +54,6 @@ public override async Task ExecuteAsync(GameEvent E)
##### Arguments
| Type | Name | Description |
| --- | --- | --- |
| [`GameEvent`](./sharedlibrarycore-GameEvent) | E | |
| [`GameEvent`](../GameEvent.md) | E | |
*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc)

12
CodeDocumentation/SharedLibraryCore/sharedlibrarycorecommands-ListExternalIPCommand.md → CodeDocumentation/SharedLibraryCore/commands/ListExternalIPCommand.md

@ -23,7 +23,7 @@ SharedLibraryCore.Command --> SharedLibraryCore.Commands.ListExternalIPCommand
#### Public methods
| Returns | Name |
| --- | --- |
| `Task` | [`ExecuteAsync`](#executeasync)([`GameEvent`](./sharedlibrarycore-GameEvent) E) |
| `Task` | [`ExecuteAsync`](#executeasync)([`GameEvent`](../GameEvent.md) E) |
## Details
### Summary
@ -32,27 +32,29 @@ Lists external IP
### Inheritance
- [
`Command`
](./sharedlibrarycore-Command)
](../Command.md)
### Constructors
#### ListExternalIPCommand
[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Commands/NativeCommands.cs#L963)
```csharp
public ListExternalIPCommand(CommandConfiguration config, ITranslationLookup translationLookup)
```
##### Arguments
| Type | Name | Description |
| --- | --- | --- |
| [`CommandConfiguration`](./sharedlibrarycoreconfiguration-CommandConfiguration) | config | |
| [`ITranslationLookup`](./sharedlibrarycoreinterfaces-ITranslationLookup) | translationLookup | |
| [`CommandConfiguration`](../configuration/CommandConfiguration.md) | config | |
| [`ITranslationLookup`](../interfaces/ITranslationLookup.md) | translationLookup | |
### Methods
#### ExecuteAsync
[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Commands/NativeCommands.cs#L974)
```csharp
public override Task ExecuteAsync(GameEvent E)
```
##### Arguments
| Type | Name | Description |
| --- | --- | --- |
| [`GameEvent`](./sharedlibrarycore-GameEvent) | E | |
| [`GameEvent`](../GameEvent.md) | E | |
*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc)

11
CodeDocumentation/SharedLibraryCore/sharedlibrarycorecommands-ListRulesCommands.md → CodeDocumentation/SharedLibraryCore/commands/ListRulesCommands.md

@ -23,7 +23,7 @@ SharedLibraryCore.Command --> SharedLibraryCore.Commands.ListRulesCommands
#### Public methods
| Returns | Name |
| --- | --- |
| `Task` | [`ExecuteAsync`](#executeasync)([`GameEvent`](./sharedlibrarycore-GameEvent) gameEvent) |
| `Task` | [`ExecuteAsync`](#executeasync)([`GameEvent`](../GameEvent.md) gameEvent) |
## Details
### Summary
@ -32,18 +32,19 @@ Lists server and global rules
### Inheritance
- [
`Command`
](./sharedlibrarycore-Command)
](../Command.md)
### Constructors
#### ListRulesCommands
[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Commands/NativeCommands.cs#L700)
```csharp
public ListRulesCommands(CommandConfiguration config, ITranslationLookup translationLookup)
```
##### Arguments
| Type | Name | Description |
| --- | --- | --- |
| [`CommandConfiguration`](./sharedlibrarycoreconfiguration-CommandConfiguration) | config | |
| [`ITranslationLookup`](./sharedlibrarycoreinterfaces-ITranslationLookup) | translationLookup | |
| [`CommandConfiguration`](../configuration/CommandConfiguration.md) | config | |
| [`ITranslationLookup`](../interfaces/ITranslationLookup.md) | translationLookup | |
### Methods
#### ExecuteAsync
@ -53,6 +54,6 @@ public override async Task ExecuteAsync(GameEvent gameEvent)
##### Arguments
| Type | Name | Description |
| --- | --- | --- |
| [`GameEvent`](./sharedlibrarycore-GameEvent) | gameEvent | |
| [`GameEvent`](../GameEvent.md) | gameEvent | |
*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc)

11
CodeDocumentation/SharedLibraryCore/sharedlibrarycorecommands-LoadMapCommand.md → CodeDocumentation/SharedLibraryCore/commands/LoadMapCommand.md

@ -23,7 +23,7 @@ SharedLibraryCore.Command --> SharedLibraryCore.Commands.LoadMapCommand
#### Public methods
| Returns | Name |
| --- | --- |
| `Task` | [`ExecuteAsync`](#executeasync)([`GameEvent`](./sharedlibrarycore-GameEvent) E) |
| `Task` | [`ExecuteAsync`](#executeasync)([`GameEvent`](../GameEvent.md) E) |
## Details
### Summary
@ -32,18 +32,19 @@ Attempts to load the specified map
### Inheritance
- [
`Command`
](./sharedlibrarycore-Command)
](../Command.md)
### Constructors
#### LoadMapCommand
[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Commands/NativeCommands.cs#L658)
```csharp
public LoadMapCommand(CommandConfiguration config, ITranslationLookup translationLookup)
```
##### Arguments
| Type | Name | Description |
| --- | --- | --- |
| [`CommandConfiguration`](./sharedlibrarycoreconfiguration-CommandConfiguration) | config | |
| [`ITranslationLookup`](./sharedlibrarycoreinterfaces-ITranslationLookup) | translationLookup | |
| [`CommandConfiguration`](../configuration/CommandConfiguration.md) | config | |
| [`ITranslationLookup`](../interfaces/ITranslationLookup.md) | translationLookup | |
### Methods
#### ExecuteAsync
@ -53,6 +54,6 @@ public override async Task ExecuteAsync(GameEvent E)
##### Arguments
| Type | Name | Description |
| --- | --- | --- |
| [`GameEvent`](./sharedlibrarycore-GameEvent) | E | |
| [`GameEvent`](../GameEvent.md) | E | |
*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc)

11
CodeDocumentation/SharedLibraryCore/sharedlibrarycorecommands-MapRotateCommand.md → CodeDocumentation/SharedLibraryCore/commands/MapRotateCommand.md

@ -23,7 +23,7 @@ SharedLibraryCore.Command --> SharedLibraryCore.Commands.MapRotateCommand
#### Public methods
| Returns | Name |
| --- | --- |
| `Task` | [`ExecuteAsync`](#executeasync)([`GameEvent`](./sharedlibrarycore-GameEvent) E) |
| `Task` | [`ExecuteAsync`](#executeasync)([`GameEvent`](../GameEvent.md) E) |
## Details
### Summary
@ -32,18 +32,19 @@ Cycles to the next map in rotation
### Inheritance
- [
`Command`
](./sharedlibrarycore-Command)
](../Command.md)
### Constructors
#### MapRotateCommand
[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Commands/NativeCommands.cs#L439)
```csharp
public MapRotateCommand(CommandConfiguration config, ITranslationLookup translationLookup)
```
##### Arguments
| Type | Name | Description |
| --- | --- | --- |
| [`CommandConfiguration`](./sharedlibrarycoreconfiguration-CommandConfiguration) | config | |
| [`ITranslationLookup`](./sharedlibrarycoreinterfaces-ITranslationLookup) | translationLookup | |
| [`CommandConfiguration`](../configuration/CommandConfiguration.md) | config | |
| [`ITranslationLookup`](../interfaces/ITranslationLookup.md) | translationLookup | |
### Methods
#### ExecuteAsync
@ -53,6 +54,6 @@ public override async Task ExecuteAsync(GameEvent E)
##### Arguments
| Type | Name | Description |
| --- | --- | --- |
| [`GameEvent`](./sharedlibrarycore-GameEvent) | E | |
| [`GameEvent`](../GameEvent.md) | E | |
*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc)

11
CodeDocumentation/SharedLibraryCore/sharedlibrarycorecommands-MaskCommand.md → CodeDocumentation/SharedLibraryCore/commands/MaskCommand.md

@ -23,7 +23,7 @@ SharedLibraryCore.Command --> SharedLibraryCore.Commands.MaskCommand
#### Public methods
| Returns | Name |
| --- | --- |
| `Task` | [`ExecuteAsync`](#executeasync)([`GameEvent`](./sharedlibrarycore-GameEvent) E) |
| `Task` | [`ExecuteAsync`](#executeasync)([`GameEvent`](../GameEvent.md) E) |
## Details
### Summary
@ -32,18 +32,19 @@ Masks client from announcements and online admin list
### Inheritance
- [
`Command`
](./sharedlibrarycore-Command)
](../Command.md)
### Constructors
#### MaskCommand
[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Commands/NativeCommands.cs#L846)
```csharp
public MaskCommand(CommandConfiguration config, ITranslationLookup translationLookup)
```
##### Arguments
| Type | Name | Description |
| --- | --- | --- |
| [`CommandConfiguration`](./sharedlibrarycoreconfiguration-CommandConfiguration) | config | |
| [`ITranslationLookup`](./sharedlibrarycoreinterfaces-ITranslationLookup) | translationLookup | |
| [`CommandConfiguration`](../configuration/CommandConfiguration.md) | config | |
| [`ITranslationLookup`](../interfaces/ITranslationLookup.md) | translationLookup | |
### Methods
#### ExecuteAsync
@ -53,6 +54,6 @@ public override async Task ExecuteAsync(GameEvent E)
##### Arguments
| Type | Name | Description |
| --- | --- | --- |
| [`GameEvent`](./sharedlibrarycore-GameEvent) | E | |
| [`GameEvent`](../GameEvent.md) | E | |
*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc)

12
CodeDocumentation/SharedLibraryCore/sharedlibrarycorecommands-MemoryUsageCommand.md → CodeDocumentation/SharedLibraryCore/commands/MemoryUsageCommand.md

@ -23,7 +23,7 @@ SharedLibraryCore.Command --> SharedLibraryCore.Commands.MemoryUsageCommand
#### Public methods
| Returns | Name |
| --- | --- |
| `Task` | [`ExecuteAsync`](#executeasync)([`GameEvent`](./sharedlibrarycore-GameEvent) E) |
| `Task` | [`ExecuteAsync`](#executeasync)([`GameEvent`](../GameEvent.md) E) |
## Details
### Summary
@ -32,27 +32,29 @@ Prints the amount of memory IW4MAdmin is using
### Inheritance
- [
`Command`
](./sharedlibrarycore-Command)
](../Command.md)
### Constructors
#### MemoryUsageCommand
[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Commands/NativeCommands.cs#L610)
```csharp
public MemoryUsageCommand(CommandConfiguration config, ITranslationLookup translationLookup)
```
##### Arguments
| Type | Name | Description |
| --- | --- | --- |
| [`CommandConfiguration`](./sharedlibrarycoreconfiguration-CommandConfiguration) | config | |
| [`ITranslationLookup`](./sharedlibrarycoreinterfaces-ITranslationLookup) | translationLookup | |
| [`CommandConfiguration`](../configuration/CommandConfiguration.md) | config | |
| [`ITranslationLookup`](../interfaces/ITranslationLookup.md) | translationLookup | |
### Methods
#### ExecuteAsync
[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Commands/NativeCommands.cs#L621)
```csharp
public override Task ExecuteAsync(GameEvent E)
```
##### Arguments
| Type | Name | Description |
| --- | --- | --- |
| [`GameEvent`](./sharedlibrarycore-GameEvent) | E | |
| [`GameEvent`](../GameEvent.md) | E | |
*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc)

17
CodeDocumentation/SharedLibraryCore/sharedlibrarycorecommands-NextMapCommand.md → CodeDocumentation/SharedLibraryCore/commands/NextMapCommand.md

@ -23,12 +23,12 @@ SharedLibraryCore.Command --> SharedLibraryCore.Commands.NextMapCommand
#### Public Static methods
| Returns | Name |
| --- | --- |
| `Task`&lt;`string`&gt; | [`GetNextMap`](#getnextmap)([`Server`](./sharedlibrarycore-Server) s, [`ITranslationLookup`](./sharedlibrarycoreinterfaces-ITranslationLookup) lookup) |
| `Task`&lt;`string`&gt; | [`GetNextMap`](#getnextmap)([`Server`](../Server.md) s, [`ITranslationLookup`](../interfaces/ITranslationLookup.md) lookup) |
#### Public methods
| Returns | Name |
| --- | --- |
| `Task` | [`ExecuteAsync`](#executeasync)([`GameEvent`](./sharedlibrarycore-GameEvent) E) |
| `Task` | [`ExecuteAsync`](#executeasync)([`GameEvent`](../GameEvent.md) E) |
## Details
### Summary
@ -37,18 +37,19 @@ Retrieves the next map in rotation
### Inheritance
- [
`Command`
](./sharedlibrarycore-Command)
](../Command.md)
### Constructors
#### NextMapCommand
[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Commands/NativeCommands.cs#L1178)
```csharp
public NextMapCommand(CommandConfiguration config, ITranslationLookup translationLookup)
```
##### Arguments
| Type | Name | Description |
| --- | --- | --- |
| [`CommandConfiguration`](./sharedlibrarycoreconfiguration-CommandConfiguration) | config | |
| [`ITranslationLookup`](./sharedlibrarycoreinterfaces-ITranslationLookup) | translationLookup | |
| [`CommandConfiguration`](../configuration/CommandConfiguration.md) | config | |
| [`ITranslationLookup`](../interfaces/ITranslationLookup.md) | translationLookup | |
### Methods
#### GetNextMap
@ -58,8 +59,8 @@ public static async Task<string> GetNextMap(Server s, ITranslationLookup lookup)
##### Arguments
| Type | Name | Description |
| --- | --- | --- |
| [`Server`](./sharedlibrarycore-Server) | s | |
| [`ITranslationLookup`](./sharedlibrarycoreinterfaces-ITranslationLookup) | lookup | |
| [`Server`](../Server.md) | s | |
| [`ITranslationLookup`](../interfaces/ITranslationLookup.md) | lookup | |
#### ExecuteAsync
```csharp
@ -68,6 +69,6 @@ public override async Task ExecuteAsync(GameEvent E)
##### Arguments
| Type | Name | Description |
| --- | --- | --- |
| [`GameEvent`](./sharedlibrarycore-GameEvent) | E | |
| [`GameEvent`](../GameEvent.md) | E | |
*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc)

11
CodeDocumentation/SharedLibraryCore/sharedlibrarycorecommands-OwnerCommand.md → CodeDocumentation/SharedLibraryCore/commands/OwnerCommand.md

@ -23,7 +23,7 @@ SharedLibraryCore.Command --> SharedLibraryCore.Commands.OwnerCommand
#### Public methods
| Returns | Name |
| --- | --- |
| `Task` | [`ExecuteAsync`](#executeasync)([`GameEvent`](./sharedlibrarycore-GameEvent) E) |
| `Task` | [`ExecuteAsync`](#executeasync)([`GameEvent`](../GameEvent.md) E) |
## Details
### Summary
@ -32,18 +32,19 @@ Claims ownership of the server
### Inheritance
- [
`Command`
](./sharedlibrarycore-Command)
](../Command.md)
### Constructors
#### OwnerCommand
[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Commands/NativeCommands.cs#L69)
```csharp
public OwnerCommand(CommandConfiguration config, ITranslationLookup translationLookup)
```
##### Arguments
| Type | Name | Description |
| --- | --- | --- |
| [`CommandConfiguration`](./sharedlibrarycoreconfiguration-CommandConfiguration) | config | |
| [`ITranslationLookup`](./sharedlibrarycoreinterfaces-ITranslationLookup) | translationLookup | |
| [`CommandConfiguration`](../configuration/CommandConfiguration.md) | config | |
| [`ITranslationLookup`](../interfaces/ITranslationLookup.md) | translationLookup | |
### Methods
#### ExecuteAsync
@ -53,6 +54,6 @@ public override async Task ExecuteAsync(GameEvent E)
##### Arguments
| Type | Name | Description |
| --- | --- | --- |
| [`GameEvent`](./sharedlibrarycore-GameEvent) | E | |
| [`GameEvent`](../GameEvent.md) | E | |
*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc)

12
CodeDocumentation/SharedLibraryCore/sharedlibrarycorecommands-PrivateMessageAdminsCommand.md → CodeDocumentation/SharedLibraryCore/commands/PrivateMessageAdminsCommand.md

@ -20,33 +20,35 @@ SharedLibraryCore.Command --> SharedLibraryCore.Commands.PrivateMessageAdminsCom
#### Public methods
| Returns | Name |
| --- | --- |
| `Task` | [`ExecuteAsync`](#executeasync)([`GameEvent`](./sharedlibrarycore-GameEvent) E) |
| `Task` | [`ExecuteAsync`](#executeasync)([`GameEvent`](../GameEvent.md) E) |
## Details
### Inheritance
- [
`Command`
](./sharedlibrarycore-Command)
](../Command.md)
### Constructors
#### PrivateMessageAdminsCommand
[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Commands/PrivateMessageAdminsCommand.cs#L12)
```csharp
public PrivateMessageAdminsCommand(CommandConfiguration config, ITranslationLookup lookup)
```
##### Arguments
| Type | Name | Description |
| --- | --- | --- |
| [`CommandConfiguration`](./sharedlibrarycoreconfiguration-CommandConfiguration) | config | |
| [`ITranslationLookup`](./sharedlibrarycoreinterfaces-ITranslationLookup) | lookup | |
| [`CommandConfiguration`](../configuration/CommandConfiguration.md) | config | |
| [`ITranslationLookup`](../interfaces/ITranslationLookup.md) | lookup | |
### Methods
#### ExecuteAsync
[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Commands/PrivateMessageAdminsCommand.cs#L23)
```csharp
public override Task ExecuteAsync(GameEvent E)
```
##### Arguments
| Type | Name | Description |
| --- | --- | --- |
| [`GameEvent`](./sharedlibrarycore-GameEvent) | E | |
| [`GameEvent`](../GameEvent.md) | E | |
*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc)

11
CodeDocumentation/SharedLibraryCore/sharedlibrarycorecommands-PruneAdminsCommand.md → CodeDocumentation/SharedLibraryCore/commands/PruneAdminsCommand.md

@ -23,7 +23,7 @@ SharedLibraryCore.Command --> SharedLibraryCore.Commands.PruneAdminsCommand
#### Public methods
| Returns | Name |
| --- | --- |
| `Task` | [`ExecuteAsync`](#executeasync)([`GameEvent`](./sharedlibrarycore-GameEvent) E) |
| `Task` | [`ExecuteAsync`](#executeasync)([`GameEvent`](../GameEvent.md) E) |
## Details
### Summary
@ -32,18 +32,19 @@ Prunes inactive privileged clients
### Inheritance
- [
`Command`
](./sharedlibrarycore-Command)
](../Command.md)
### Constructors
#### PruneAdminsCommand
[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Commands/NativeCommands.cs#L988)
```csharp
public PruneAdminsCommand(CommandConfiguration config, ITranslationLookup translationLookup, IDatabaseContextFactory contextFactory)
```
##### Arguments
| Type | Name | Description |
| --- | --- | --- |
| [`CommandConfiguration`](./sharedlibrarycoreconfiguration-CommandConfiguration) | config | |
| [`ITranslationLookup`](./sharedlibrarycoreinterfaces-ITranslationLookup) | translationLookup | |
| [`CommandConfiguration`](../configuration/CommandConfiguration.md) | config | |
| [`ITranslationLookup`](../interfaces/ITranslationLookup.md) | translationLookup | |
| `IDatabaseContextFactory` | contextFactory | |
### Methods
@ -54,6 +55,6 @@ public override async Task ExecuteAsync(GameEvent E)
##### Arguments
| Type | Name | Description |
| --- | --- | --- |
| [`GameEvent`](./sharedlibrarycore-GameEvent) | E | |
| [`GameEvent`](../GameEvent.md) | E | |
*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc)

11
CodeDocumentation/SharedLibraryCore/sharedlibrarycorecommands-QuitCommand.md → CodeDocumentation/SharedLibraryCore/commands/QuitCommand.md

@ -23,7 +23,7 @@ SharedLibraryCore.Command --> SharedLibraryCore.Commands.QuitCommand
#### Public methods
| Returns | Name |
| --- | --- |
| `Task` | [`ExecuteAsync`](#executeasync)([`GameEvent`](./sharedlibrarycore-GameEvent) E) |
| `Task` | [`ExecuteAsync`](#executeasync)([`GameEvent`](../GameEvent.md) E) |
## Details
### Summary
@ -32,18 +32,19 @@ Quits IW4MAdmin
### Inheritance
- [
`Command`
](./sharedlibrarycore-Command)
](../Command.md)
### Constructors
#### QuitCommand
[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Commands/NativeCommands.cs#L26)
```csharp
public QuitCommand(CommandConfiguration config, ITranslationLookup translationLookup)
```
##### Arguments
| Type | Name | Description |
| --- | --- | --- |
| [`CommandConfiguration`](./sharedlibrarycoreconfiguration-CommandConfiguration) | config | |
| [`ITranslationLookup`](./sharedlibrarycoreinterfaces-ITranslationLookup) | translationLookup | |
| [`CommandConfiguration`](../configuration/CommandConfiguration.md) | config | |
| [`ITranslationLookup`](../interfaces/ITranslationLookup.md) | translationLookup | |
### Methods
#### ExecuteAsync
@ -53,6 +54,6 @@ public override async Task ExecuteAsync(GameEvent E)
##### Arguments
| Type | Name | Description |
| --- | --- | --- |
| [`GameEvent`](./sharedlibrarycore-GameEvent) | E | |
| [`GameEvent`](../GameEvent.md) | E | |
*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc)

12
CodeDocumentation/SharedLibraryCore/sharedlibrarycorecommands-RequestTokenCommand.md → CodeDocumentation/SharedLibraryCore/commands/RequestTokenCommand.md

@ -23,7 +23,7 @@ SharedLibraryCore.Command --> SharedLibraryCore.Commands.RequestTokenCommand
#### Public methods
| Returns | Name |
| --- | --- |
| `Task` | [`ExecuteAsync`](#executeasync)([`GameEvent`](./sharedlibrarycore-GameEvent) gameEvent) |
| `Task` | [`ExecuteAsync`](#executeasync)([`GameEvent`](../GameEvent.md) gameEvent) |
## Details
### Summary
@ -32,27 +32,29 @@ Generates a token for use in webfront login
### Inheritance
- [
`Command`
](./sharedlibrarycore-Command)
](../Command.md)
### Constructors
#### RequestTokenCommand
[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Commands/RequestTokenCommand.cs#L14)
```csharp
public RequestTokenCommand(CommandConfiguration config, ITranslationLookup lookup)
```
##### Arguments
| Type | Name | Description |
| --- | --- | --- |
| [`CommandConfiguration`](./sharedlibrarycoreconfiguration-CommandConfiguration) | config | |
| [`ITranslationLookup`](./sharedlibrarycoreinterfaces-ITranslationLookup) | lookup | |
| [`CommandConfiguration`](../configuration/CommandConfiguration.md) | config | |
| [`ITranslationLookup`](../interfaces/ITranslationLookup.md) | lookup | |
### Methods
#### ExecuteAsync
[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Commands/RequestTokenCommand.cs#L24)
```csharp
public override Task ExecuteAsync(GameEvent gameEvent)
```
##### Arguments
| Type | Name | Description |
| --- | --- | --- |
| [`GameEvent`](./sharedlibrarycore-GameEvent) | gameEvent | |
| [`GameEvent`](../GameEvent.md) | gameEvent | |
*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc)

11
CodeDocumentation/SharedLibraryCore/sharedlibrarycorecommands-RestartCommand.md → CodeDocumentation/SharedLibraryCore/commands/RestartCommand.md

@ -23,7 +23,7 @@ SharedLibraryCore.Command --> SharedLibraryCore.Commands.RestartCommand
#### Public methods
| Returns | Name |
| --- | --- |
| `Task` | [`ExecuteAsync`](#executeasync)([`GameEvent`](./sharedlibrarycore-GameEvent) gameEvent) |
| `Task` | [`ExecuteAsync`](#executeasync)([`GameEvent`](../GameEvent.md) gameEvent) |
## Details
### Summary
@ -32,18 +32,19 @@ Restarts IW4MAdmin
### Inheritance
- [
`Command`
](./sharedlibrarycore-Command)
](../Command.md)
### Constructors
#### RestartCommand
[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Commands/NativeCommands.cs#L47)
```csharp
public RestartCommand(CommandConfiguration config, ITranslationLookup translationLookup)
```
##### Arguments
| Type | Name | Description |
| --- | --- | --- |
| [`CommandConfiguration`](./sharedlibrarycoreconfiguration-CommandConfiguration) | config | |
| [`ITranslationLookup`](./sharedlibrarycoreinterfaces-ITranslationLookup) | translationLookup | |
| [`CommandConfiguration`](../configuration/CommandConfiguration.md) | config | |
| [`ITranslationLookup`](../interfaces/ITranslationLookup.md) | translationLookup | |
### Methods
#### ExecuteAsync
@ -53,6 +54,6 @@ public override async Task ExecuteAsync(GameEvent gameEvent)
##### Arguments
| Type | Name | Description |
| --- | --- | --- |
| [`GameEvent`](./sharedlibrarycore-GameEvent) | gameEvent | |
| [`GameEvent`](../GameEvent.md) | gameEvent | |
*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc)

11
CodeDocumentation/SharedLibraryCore/sharedlibrarycorecommands-RunAsCommand.md → CodeDocumentation/SharedLibraryCore/commands/RunAsCommand.md

@ -20,24 +20,25 @@ SharedLibraryCore.Command --> SharedLibraryCore.Commands.RunAsCommand
#### Public methods
| Returns | Name |
| --- | --- |
| `Task` | [`ExecuteAsync`](#executeasync)([`GameEvent`](./sharedlibrarycore-GameEvent) gameEvent) |
| `Task` | [`ExecuteAsync`](#executeasync)([`GameEvent`](../GameEvent.md) gameEvent) |
## Details
### Inheritance
- [
`Command`
](./sharedlibrarycore-Command)
](../Command.md)
### Constructors
#### RunAsCommand
[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Commands/RunAsCommand.cs#L11)
```csharp
public RunAsCommand(CommandConfiguration config, ITranslationLookup lookup)
```
##### Arguments
| Type | Name | Description |
| --- | --- | --- |
| [`CommandConfiguration`](./sharedlibrarycoreconfiguration-CommandConfiguration) | config | |
| [`ITranslationLookup`](./sharedlibrarycoreinterfaces-ITranslationLookup) | lookup | |
| [`CommandConfiguration`](../configuration/CommandConfiguration.md) | config | |
| [`ITranslationLookup`](../interfaces/ITranslationLookup.md) | lookup | |
### Methods
#### ExecuteAsync
@ -47,6 +48,6 @@ public override async Task ExecuteAsync(GameEvent gameEvent)
##### Arguments
| Type | Name | Description |
| --- | --- | --- |
| [`GameEvent`](./sharedlibrarycore-GameEvent) | gameEvent | |
| [`GameEvent`](../GameEvent.md) | gameEvent | |
*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc)

13
CodeDocumentation/SharedLibraryCore/sharedlibrarycorecommands-SetGravatarCommand.md → CodeDocumentation/SharedLibraryCore/commands/SetGravatarCommand.md

@ -23,7 +23,7 @@ SharedLibraryCore.Command --> SharedLibraryCore.Commands.SetGravatarCommand
#### Public methods
| Returns | Name |
| --- | --- |
| `Task` | [`ExecuteAsync`](#executeasync)([`GameEvent`](./sharedlibrarycore-GameEvent) E) |
| `Task` | [`ExecuteAsync`](#executeasync)([`GameEvent`](../GameEvent.md) E) |
## Details
### Summary
@ -32,19 +32,20 @@ Sets the email for gravatar in webfront
### Inheritance
- [
`Command`
](./sharedlibrarycore-Command)
](../Command.md)
### Constructors
#### SetGravatarCommand
[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Commands/NativeCommands.cs#L1139)
```csharp
public SetGravatarCommand(CommandConfiguration config, ITranslationLookup translationLookup, IMetaServiceV2 metaService)
```
##### Arguments
| Type | Name | Description |
| --- | --- | --- |
| [`CommandConfiguration`](./sharedlibrarycoreconfiguration-CommandConfiguration) | config | |
| [`ITranslationLookup`](./sharedlibrarycoreinterfaces-ITranslationLookup) | translationLookup | |
| [`IMetaServiceV2`](./sharedlibrarycoreinterfaces-IMetaServiceV2) | metaService | |
| [`CommandConfiguration`](../configuration/CommandConfiguration.md) | config | |
| [`ITranslationLookup`](../interfaces/ITranslationLookup.md) | translationLookup | |
| [`IMetaServiceV2`](../interfaces/IMetaServiceV2.md) | metaService | |
### Methods
#### ExecuteAsync
@ -54,6 +55,6 @@ public override async Task ExecuteAsync(GameEvent E)
##### Arguments
| Type | Name | Description |
| --- | --- | --- |
| [`GameEvent`](./sharedlibrarycore-GameEvent) | E | |
| [`GameEvent`](../GameEvent.md) | E | |
*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc)

13
CodeDocumentation/SharedLibraryCore/sharedlibrarycorecommands-SetLevelCommand.md → CodeDocumentation/SharedLibraryCore/commands/SetLevelCommand.md

@ -23,7 +23,7 @@ SharedLibraryCore.Command --> SharedLibraryCore.Commands.SetLevelCommand
#### Public methods
| Returns | Name |
| --- | --- |
| `Task` | [`ExecuteAsync`](#executeasync)([`GameEvent`](./sharedlibrarycore-GameEvent) gameEvent) |
| `Task` | [`ExecuteAsync`](#executeasync)([`GameEvent`](../GameEvent.md) gameEvent) |
## Details
### Summary
@ -32,19 +32,20 @@ Sets the level of given client
### Inheritance
- [
`Command`
](./sharedlibrarycore-Command)
](../Command.md)
### Constructors
#### SetLevelCommand
[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Commands/NativeCommands.cs#L468)
```csharp
public SetLevelCommand(CommandConfiguration config, ITranslationLookup translationLookup, ILogger<SetLevelCommand> logger)
```
##### Arguments
| Type | Name | Description |
| --- | --- | --- |
| [`CommandConfiguration`](./sharedlibrarycoreconfiguration-CommandConfiguration) | config | |
| [`ITranslationLookup`](./sharedlibrarycoreinterfaces-ITranslationLookup) | translationLookup | |
| `ILogger`&lt;[`SetLevelCommand`](sharedlibrarycorecommands-SetLevelCommand)&gt; | logger | |
| [`CommandConfiguration`](../configuration/CommandConfiguration.md) | config | |
| [`ITranslationLookup`](../interfaces/ITranslationLookup.md) | translationLookup | |
| `ILogger`&lt;[`SetLevelCommand`](sharedlibrarycore/commands/SetLevelCommand.md)&gt; | logger | |
### Methods
#### ExecuteAsync
@ -54,6 +55,6 @@ public override async Task ExecuteAsync(GameEvent gameEvent)
##### Arguments
| Type | Name | Description |
| --- | --- | --- |
| [`GameEvent`](./sharedlibrarycore-GameEvent) | gameEvent | |
| [`GameEvent`](../GameEvent.md) | gameEvent | |
*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc)

11
CodeDocumentation/SharedLibraryCore/sharedlibrarycorecommands-SetPasswordCommand.md → CodeDocumentation/SharedLibraryCore/commands/SetPasswordCommand.md

@ -23,7 +23,7 @@ SharedLibraryCore.Command --> SharedLibraryCore.Commands.SetPasswordCommand
#### Public methods
| Returns | Name |
| --- | --- |
| `Task` | [`ExecuteAsync`](#executeasync)([`GameEvent`](./sharedlibrarycore-GameEvent) E) |
| `Task` | [`ExecuteAsync`](#executeasync)([`GameEvent`](../GameEvent.md) E) |
## Details
### Summary
@ -32,18 +32,19 @@ Sets login password
### Inheritance
- [
`Command`
](./sharedlibrarycore-Command)
](../Command.md)
### Constructors
#### SetPasswordCommand
[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Commands/NativeCommands.cs#L1051)
```csharp
public SetPasswordCommand(CommandConfiguration config, ITranslationLookup translationLookup)
```
##### Arguments
| Type | Name | Description |
| --- | --- | --- |
| [`CommandConfiguration`](./sharedlibrarycoreconfiguration-CommandConfiguration) | config | |
| [`ITranslationLookup`](./sharedlibrarycoreinterfaces-ITranslationLookup) | translationLookup | |
| [`CommandConfiguration`](../configuration/CommandConfiguration.md) | config | |
| [`ITranslationLookup`](../interfaces/ITranslationLookup.md) | translationLookup | |
### Methods
#### ExecuteAsync
@ -53,6 +54,6 @@ public override async Task ExecuteAsync(GameEvent E)
##### Arguments
| Type | Name | Description |
| --- | --- | --- |
| [`GameEvent`](./sharedlibrarycore-GameEvent) | E | |
| [`GameEvent`](../GameEvent.md) | E | |
*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc)

13
CodeDocumentation/SharedLibraryCore/sharedlibrarycorecommands-TempBanCommand.md → CodeDocumentation/SharedLibraryCore/commands/TempBanCommand.md

@ -23,7 +23,7 @@ SharedLibraryCore.Command --> SharedLibraryCore.Commands.TempBanCommand
#### Public methods
| Returns | Name |
| --- | --- |
| `Task` | [`ExecuteAsync`](#executeasync)([`GameEvent`](./sharedlibrarycore-GameEvent) gameEvent) |
| `Task` | [`ExecuteAsync`](#executeasync)([`GameEvent`](../GameEvent.md) gameEvent) |
## Details
### Summary
@ -32,19 +32,20 @@ Temporarily bans a client
### Inheritance
- [
`Command`
](./sharedlibrarycore-Command)
](../Command.md)
### Constructors
#### TempBanCommand
[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Commands/NativeCommands.cs#L236)
```csharp
public TempBanCommand(ApplicationConfiguration appConfig, CommandConfiguration config, ITranslationLookup translationLookup)
```
##### Arguments
| Type | Name | Description |
| --- | --- | --- |
| [`ApplicationConfiguration`](./sharedlibrarycoreconfiguration-ApplicationConfiguration) | appConfig | |
| [`CommandConfiguration`](./sharedlibrarycoreconfiguration-CommandConfiguration) | config | |
| [`ITranslationLookup`](./sharedlibrarycoreinterfaces-ITranslationLookup) | translationLookup | |
| [`ApplicationConfiguration`](../configuration/ApplicationConfiguration.md) | appConfig | |
| [`CommandConfiguration`](../configuration/CommandConfiguration.md) | config | |
| [`ITranslationLookup`](../interfaces/ITranslationLookup.md) | translationLookup | |
### Methods
#### ExecuteAsync
@ -54,6 +55,6 @@ public override async Task ExecuteAsync(GameEvent gameEvent)
##### Arguments
| Type | Name | Description |
| --- | --- | --- |
| [`GameEvent`](./sharedlibrarycore-GameEvent) | gameEvent | |
| [`GameEvent`](../GameEvent.md) | gameEvent | |
*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc)

11
CodeDocumentation/SharedLibraryCore/sharedlibrarycorecommands-UnbanCommand.md → CodeDocumentation/SharedLibraryCore/commands/UnbanCommand.md

@ -23,7 +23,7 @@ SharedLibraryCore.Command --> SharedLibraryCore.Commands.UnbanCommand
#### Public methods
| Returns | Name |
| --- | --- |
| `Task` | [`ExecuteAsync`](#executeasync)([`GameEvent`](./sharedlibrarycore-GameEvent) gameEvent) |
| `Task` | [`ExecuteAsync`](#executeasync)([`GameEvent`](../GameEvent.md) gameEvent) |
## Details
### Summary
@ -32,18 +32,19 @@ Unbans a banned client
### Inheritance
- [
`Command`
](./sharedlibrarycore-Command)
](../Command.md)
### Constructors
#### UnbanCommand
[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Commands/NativeCommands.cs#L356)
```csharp
public UnbanCommand(CommandConfiguration config, ITranslationLookup translationLookup)
```
##### Arguments
| Type | Name | Description |
| --- | --- | --- |
| [`CommandConfiguration`](./sharedlibrarycoreconfiguration-CommandConfiguration) | config | |
| [`ITranslationLookup`](./sharedlibrarycoreinterfaces-ITranslationLookup) | translationLookup | |
| [`CommandConfiguration`](../configuration/CommandConfiguration.md) | config | |
| [`ITranslationLookup`](../interfaces/ITranslationLookup.md) | translationLookup | |
### Methods
#### ExecuteAsync
@ -53,6 +54,6 @@ public override async Task ExecuteAsync(GameEvent gameEvent)
##### Arguments
| Type | Name | Description |
| --- | --- | --- |
| [`GameEvent`](./sharedlibrarycore-GameEvent) | gameEvent | |
| [`GameEvent`](../GameEvent.md) | gameEvent | |
*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc)

11
CodeDocumentation/SharedLibraryCore/sharedlibrarycorecommands-UnflagClientCommand.md → CodeDocumentation/SharedLibraryCore/commands/UnflagClientCommand.md

@ -23,7 +23,7 @@ SharedLibraryCore.Command --> SharedLibraryCore.Commands.UnflagClientCommand
#### Public methods
| Returns | Name |
| --- | --- |
| `Task` | [`ExecuteAsync`](#executeasync)([`GameEvent`](./sharedlibrarycore-GameEvent) E) |
| `Task` | [`ExecuteAsync`](#executeasync)([`GameEvent`](../GameEvent.md) E) |
## Details
### Summary
@ -32,18 +32,19 @@ Unflag given client for specified reason
### Inheritance
- [
`Command`
](./sharedlibrarycore-Command)
](../Command.md)
### Constructors
#### UnflagClientCommand
[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Commands/NativeCommands.cs#L797)
```csharp
public UnflagClientCommand(CommandConfiguration config, ITranslationLookup translationLookup)
```
##### Arguments
| Type | Name | Description |
| --- | --- | --- |
| [`CommandConfiguration`](./sharedlibrarycoreconfiguration-CommandConfiguration) | config | |
| [`ITranslationLookup`](./sharedlibrarycoreinterfaces-ITranslationLookup) | translationLookup | |
| [`CommandConfiguration`](../configuration/CommandConfiguration.md) | config | |
| [`ITranslationLookup`](../interfaces/ITranslationLookup.md) | translationLookup | |
### Methods
#### ExecuteAsync
@ -53,6 +54,6 @@ public override async Task ExecuteAsync(GameEvent E)
##### Arguments
| Type | Name | Description |
| --- | --- | --- |
| [`GameEvent`](./sharedlibrarycore-GameEvent) | E | |
| [`GameEvent`](../GameEvent.md) | E | |
*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc)

11
CodeDocumentation/SharedLibraryCore/sharedlibrarycorecommands-UnlinkClientCommand.md → CodeDocumentation/SharedLibraryCore/commands/UnlinkClientCommand.md

@ -27,7 +27,7 @@ SharedLibraryCore.Command --> SharedLibraryCore.Commands.UnlinkClientCommand
#### Public methods
| Returns | Name |
| --- | --- |
| `Task` | [`ExecuteAsync`](#executeasync)([`GameEvent`](./sharedlibrarycore-GameEvent) E) |
| `Task` | [`ExecuteAsync`](#executeasync)([`GameEvent`](../GameEvent.md) E) |
## Details
### Summary
@ -40,18 +40,19 @@ Provides a way for administrators to "unlink" linked accounts
### Inheritance
- [
`Command`
](./sharedlibrarycore-Command)
](../Command.md)
### Constructors
#### UnlinkClientCommand
[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Commands/UnlinkClientCommand.cs#L17)
```csharp
public UnlinkClientCommand(CommandConfiguration config, ITranslationLookup lookup)
```
##### Arguments
| Type | Name | Description |
| --- | --- | --- |
| [`CommandConfiguration`](./sharedlibrarycoreconfiguration-CommandConfiguration) | config | |
| [`ITranslationLookup`](./sharedlibrarycoreinterfaces-ITranslationLookup) | lookup | |
| [`CommandConfiguration`](../configuration/CommandConfiguration.md) | config | |
| [`ITranslationLookup`](../interfaces/ITranslationLookup.md) | lookup | |
### Methods
#### ExecuteAsync
@ -61,6 +62,6 @@ public override async Task ExecuteAsync(GameEvent E)
##### Arguments
| Type | Name | Description |
| --- | --- | --- |
| [`GameEvent`](./sharedlibrarycore-GameEvent) | E | |
| [`GameEvent`](../GameEvent.md) | E | |
*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc)

12
CodeDocumentation/SharedLibraryCore/sharedlibrarycorecommands-UptimeCommand.md → CodeDocumentation/SharedLibraryCore/commands/UptimeCommand.md

@ -23,7 +23,7 @@ SharedLibraryCore.Command --> SharedLibraryCore.Commands.UptimeCommand
#### Public methods
| Returns | Name |
| --- | --- |
| `Task` | [`ExecuteAsync`](#executeasync)([`GameEvent`](./sharedlibrarycore-GameEvent) E) |
| `Task` | [`ExecuteAsync`](#executeasync)([`GameEvent`](../GameEvent.md) E) |
## Details
### Summary
@ -32,27 +32,29 @@ Prints out how long IW4MAdmin has been running
### Inheritance
- [
`Command`
](./sharedlibrarycore-Command)
](../Command.md)
### Constructors
#### UptimeCommand
[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Commands/NativeCommands.cs#L633)
```csharp
public UptimeCommand(CommandConfiguration config, ITranslationLookup translationLookup)
```
##### Arguments
| Type | Name | Description |
| --- | --- | --- |
| [`CommandConfiguration`](./sharedlibrarycoreconfiguration-CommandConfiguration) | config | |
| [`ITranslationLookup`](./sharedlibrarycoreinterfaces-ITranslationLookup) | translationLookup | |
| [`CommandConfiguration`](../configuration/CommandConfiguration.md) | config | |
| [`ITranslationLookup`](../interfaces/ITranslationLookup.md) | translationLookup | |
### Methods
#### ExecuteAsync
[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Commands/NativeCommands.cs#L644)
```csharp
public override Task ExecuteAsync(GameEvent E)
```
##### Arguments
| Type | Name | Description |
| --- | --- | --- |
| [`GameEvent`](./sharedlibrarycore-GameEvent) | E | |
| [`GameEvent`](../GameEvent.md) | E | |
*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc)

12
CodeDocumentation/SharedLibraryCore/sharedlibrarycorecommands-WarnClearCommand.md → CodeDocumentation/SharedLibraryCore/commands/WarnClearCommand.md

@ -23,7 +23,7 @@ SharedLibraryCore.Command --> SharedLibraryCore.Commands.WarnClearCommand
#### Public methods
| Returns | Name |
| --- | --- |
| `Task` | [`ExecuteAsync`](#executeasync)([`GameEvent`](./sharedlibrarycore-GameEvent) E) |
| `Task` | [`ExecuteAsync`](#executeasync)([`GameEvent`](../GameEvent.md) E) |
## Details
### Summary
@ -32,27 +32,29 @@ Clears all warnings for given client
### Inheritance
- [
`Command`
](./sharedlibrarycore-Command)
](../Command.md)
### Constructors
#### WarnClearCommand
[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Commands/NativeCommands.cs#L148)
```csharp
public WarnClearCommand(CommandConfiguration config, ITranslationLookup translationLookup)
```
##### Arguments
| Type | Name | Description |
| --- | --- | --- |
| [`CommandConfiguration`](./sharedlibrarycoreconfiguration-CommandConfiguration) | config | |
| [`ITranslationLookup`](./sharedlibrarycoreinterfaces-ITranslationLookup) | translationLookup | |
| [`CommandConfiguration`](../configuration/CommandConfiguration.md) | config | |
| [`ITranslationLookup`](../interfaces/ITranslationLookup.md) | translationLookup | |
### Methods
#### ExecuteAsync
[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Commands/NativeCommands.cs#L167)
```csharp
public override Task ExecuteAsync(GameEvent E)
```
##### Arguments
| Type | Name | Description |
| --- | --- | --- |
| [`GameEvent`](./sharedlibrarycore-GameEvent) | E | |
| [`GameEvent`](../GameEvent.md) | E | |
*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc)

14
CodeDocumentation/SharedLibraryCore/sharedlibrarycorecommands-WarnCommand.md → CodeDocumentation/SharedLibraryCore/commands/WarnCommand.md

@ -23,7 +23,7 @@ SharedLibraryCore.Command --> SharedLibraryCore.Commands.WarnCommand
#### Public methods
| Returns | Name |
| --- | --- |
| `Task` | [`ExecuteAsync`](#executeasync)([`GameEvent`](./sharedlibrarycore-GameEvent) gameEvent) |
| `Task` | [`ExecuteAsync`](#executeasync)([`GameEvent`](../GameEvent.md) gameEvent) |
## Details
### Summary
@ -32,28 +32,30 @@ Warns given client for reason
### Inheritance
- [
`Command`
](./sharedlibrarycore-Command)
](../Command.md)
### Constructors
#### WarnCommand
[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Commands/NativeCommands.cs#L108)
```csharp
public WarnCommand(ApplicationConfiguration appConfig, CommandConfiguration config, ITranslationLookup translationLookup)
```
##### Arguments
| Type | Name | Description |
| --- | --- | --- |
| [`ApplicationConfiguration`](./sharedlibrarycoreconfiguration-ApplicationConfiguration) | appConfig | |
| [`CommandConfiguration`](./sharedlibrarycoreconfiguration-CommandConfiguration) | config | |
| [`ITranslationLookup`](./sharedlibrarycoreinterfaces-ITranslationLookup) | translationLookup | |
| [`ApplicationConfiguration`](../configuration/ApplicationConfiguration.md) | appConfig | |
| [`CommandConfiguration`](../configuration/CommandConfiguration.md) | config | |
| [`ITranslationLookup`](../interfaces/ITranslationLookup.md) | translationLookup | |
### Methods
#### ExecuteAsync
[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Commands/NativeCommands.cs#L132)
```csharp
public override Task ExecuteAsync(GameEvent gameEvent)
```
##### Arguments
| Type | Name | Description |
| --- | --- | --- |
| [`GameEvent`](./sharedlibrarycore-GameEvent) | gameEvent | |
| [`GameEvent`](../GameEvent.md) | gameEvent | |
*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc)

17
CodeDocumentation/SharedLibraryCore/sharedlibrarycoreconfiguration-ApplicationConfiguration.md → CodeDocumentation/SharedLibraryCore/configuration/ApplicationConfiguration.md

@ -25,7 +25,7 @@ SharedLibraryCore.Interfaces.IBaseConfiguration --> SharedLibraryCore.Configurat
| `TimeSpan``[]` | [`BanDurations`](#bandurations) | `get, set` |
| `string` | [`BroadcastCommandPrefix`](#broadcastcommandprefix) | `get, set` |
| `string` | [`CommandPrefix`](#commandprefix) | `get, set` |
| [`CommunityInformationConfiguration`](./sharedlibrarycoreconfiguration-CommunityInformationConfiguration) | [`CommunityInformation`](#communityinformation) | `get, set` |
| [`CommunityInformationConfiguration`](./CommunityInformationConfiguration.md) | [`CommunityInformation`](#communityinformation) | `get, set` |
| `string` | [`ConnectionString`](#connectionstring) | `get, set` |
| `string` | [`ContactUri`](#contacturi) | `get, set` |
| `string` | [`CustomLocale`](#customlocale) | `get, set` |
@ -51,7 +51,7 @@ SharedLibraryCore.Interfaces.IBaseConfiguration --> SharedLibraryCore.Configurat
| `string` | [`IngameAccentColorKey`](#ingameaccentcolorkey) | `get, set` |
| `string` | [`ManualWebfrontUrl`](#manualwebfronturl) | `get, set` |
| `int` | [`MapChangeDelaySeconds`](#mapchangedelayseconds) | `get, set` |
| [`MapConfiguration`](./sharedlibrarycoreconfiguration-MapConfiguration)`[]` | [`Maps`](#maps) | `get, set` |
| [`MapConfiguration`](./MapConfiguration.md)`[]` | [`Maps`](#maps) | `get, set` |
| `Uri` | [`MasterUrl`](#masterurl) | `get, set` |
| `TimeSpan` | [`MaxClientHistoryTime`](#maxclienthistorytime) | `get, set` |
| `TimeSpan` | [`MaximumTempBanTime`](#maximumtempbantime) | `get, set` |
@ -60,17 +60,17 @@ SharedLibraryCore.Interfaces.IBaseConfiguration --> SharedLibraryCore.Configurat
| `Dictionary`&lt;`Permission`, `string`&gt; | [`OverridePermissionLevelNames`](#overridepermissionlevelnames) | `get, set` |
| `Dictionary`&lt;`string`, `List`&lt;`string`&gt;&gt; | [`PermissionSets`](#permissionsets) | `get, set` |
| `Dictionary`&lt;`string`, `string`&gt; | [`PresetPenaltyReasons`](#presetpenaltyreasons) | `get, set` |
| [`QuickMessageConfiguration`](./sharedlibrarycoreconfiguration-QuickMessageConfiguration)`[]` | [`QuickMessages`](#quickmessages) | `get, set` |
| [`QuickMessageConfiguration`](./QuickMessageConfiguration.md)`[]` | [`QuickMessages`](#quickmessages) | `get, set` |
| `int` | [`RConPollRate`](#rconpollrate) | `get, set` |
| `TimeSpan` | [`RecentAliasIpLinkTimeLimit`](#recentaliasiplinktimelimit) | `get, set` |
| `int` | [`ServerConnectionAttempts`](#serverconnectionattempts) | `get, set` |
| `TimeSpan` | [`ServerDataCollectionInterval`](#serverdatacollectioninterval) | `get, set` |
| [`ServerConfiguration`](./sharedlibrarycoreconfiguration-ServerConfiguration)`[]` | [`Servers`](#servers) | `get, set` |
| [`ServerConfiguration`](./ServerConfiguration.md)`[]` | [`Servers`](#servers) | `get, set` |
| `string` | [`SocialLinkAddress`](#sociallinkaddress) | `get, set` |
| `string` | [`SocialLinkTitle`](#sociallinktitle) | `get, set` |
| `string` | [`SubscriptionId`](#subscriptionid) | `get, set` |
| `bool` | [`UseLocalTranslations`](#uselocaltranslations) | `get, set` |
| [`WebfrontConfiguration`](./sharedlibrarycoreconfiguration-WebfrontConfiguration) | [`Webfront`](#webfront) | `get, set` |
| [`WebfrontConfiguration`](./WebfrontConfiguration.md) | [`Webfront`](#webfront) | `get, set` |
| `string` | [`WebfrontBindUrl`](#webfrontbindurl) | `get, set` |
| `string``[]` | [`WebfrontConnectionWhitelist`](#webfrontconnectionwhitelist) | `get, set` |
| `string` | [`WebfrontCustomBranding`](#webfrontcustombranding) | `get, set` |
@ -82,28 +82,31 @@ SharedLibraryCore.Interfaces.IBaseConfiguration --> SharedLibraryCore.Configurat
#### Public methods
| Returns | Name |
| --- | --- |
| [`IBaseConfiguration`](./sharedlibrarycoreinterfaces-IBaseConfiguration) | [`Generate`](#generate)() |
| [`IBaseConfiguration`](../interfaces/IBaseConfiguration.md) | [`Generate`](#generate)() |
| `string` | [`Name`](#name)() |
## Details
### Inheritance
- [
`IBaseConfiguration`
](./sharedlibrarycoreinterfaces-IBaseConfiguration)
](../interfaces/IBaseConfiguration.md)
### Constructors
#### ApplicationConfiguration
[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Configuration/ApplicationConfiguration.cs#L17)
```csharp
public ApplicationConfiguration()
```
### Methods
#### Generate
[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Configuration/ApplicationConfiguration.cs#L212)
```csharp
public virtual IBaseConfiguration Generate()
```
#### Name
[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Configuration/ApplicationConfiguration.cs#L233)
```csharp
public virtual string Name()
```

9
CodeDocumentation/SharedLibraryCore/sharedlibrarycoreconfiguration-CommandConfiguration.md → CodeDocumentation/SharedLibraryCore/configuration/CommandConfiguration.md

@ -25,13 +25,13 @@ SharedLibraryCore.Interfaces.IBaseConfiguration --> SharedLibraryCore.Configurat
| --- | --- | --- |
| `string` | [`BroadcastCommandPrefix`](#broadcastcommandprefix)<br>prefix indicating that the chat message is a broadcast command | `get, set` |
| `string` | [`CommandPrefix`](#commandprefix)<br>prefix indicated the chat message is a command | `get, set` |
| `Dictionary`&lt;`string`, [`CommandProperties`](./sharedlibrarycoreconfiguration-CommandProperties)&gt; | [`Commands`](#commands)<br>Dict of command class names mapped to configurable properties | `get, set` |
| `Dictionary`&lt;`string`, [`CommandProperties`](./CommandProperties.md)&gt; | [`Commands`](#commands)<br>Dict of command class names mapped to configurable properties | `get, set` |
### Methods
#### Public methods
| Returns | Name |
| --- | --- |
| [`IBaseConfiguration`](./sharedlibrarycoreinterfaces-IBaseConfiguration) | [`Generate`](#generate)() |
| [`IBaseConfiguration`](../interfaces/IBaseConfiguration.md) | [`Generate`](#generate)() |
| `string` | [`Name`](#name)() |
## Details
@ -41,21 +41,24 @@ Basic command configuration
### Inheritance
- [
`IBaseConfiguration`
](./sharedlibrarycoreinterfaces-IBaseConfiguration)
](../interfaces/IBaseConfiguration.md)
### Constructors
#### CommandConfiguration
[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Configuration/CommandConfiguration.cs#L17)
```csharp
public CommandConfiguration()
```
### Methods
#### Generate
[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Configuration/CommandConfiguration.cs#L32)
```csharp
public virtual IBaseConfiguration Generate()
```
#### Name
[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Configuration/CommandConfiguration.cs#L37)
```csharp
public virtual string Name()
```

1
CodeDocumentation/SharedLibraryCore/sharedlibrarycoreconfiguration-CommandProperties.md → CodeDocumentation/SharedLibraryCore/configuration/CommandProperties.md

@ -30,6 +30,7 @@ Config driven command properties
### Constructors
#### CommandProperties
[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Configuration/CommandProperties.cs#L39)
```csharp
public CommandProperties()
```

3
CodeDocumentation/SharedLibraryCore/sharedlibrarycoreconfiguration-CommunityInformationConfiguration.md → CodeDocumentation/SharedLibraryCore/configuration/CommunityInformationConfiguration.md

@ -19,11 +19,12 @@
| `bool` | [`EnableBanner`](#enablebanner) | `get, set` |
| `bool` | [`IsEnabled`](#isenabled) | `get, set` |
| `string` | [`Name`](#name) | `get, set` |
| [`SocialAccountConfiguration`](./sharedlibrarycoreconfiguration-SocialAccountConfiguration)`[]` | [`SocialAccounts`](#socialaccounts) | `get, set` |
| [`SocialAccountConfiguration`](./SocialAccountConfiguration.md)`[]` | [`SocialAccounts`](#socialaccounts) | `get, set` |
## Details
### Constructors
#### CommunityInformationConfiguration
[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Configuration/CommunityInformationConfiguration.cs#L5)
```csharp
public CommunityInformationConfiguration()
```

14
CodeDocumentation/SharedLibraryCore/sharedlibrarycoreconfiguration-DefaultSettings.md → CodeDocumentation/SharedLibraryCore/configuration/DefaultSettings.md

@ -22,24 +22,24 @@ SharedLibraryCore.Interfaces.IBaseConfiguration --> SharedLibraryCore.Configurat
| --- | --- | --- |
| `string``[]` | [`AutoMessages`](#automessages) | `get, set` |
| `string``[]` | [`DisallowedClientNames`](#disallowedclientnames) | `get, set` |
| [`GameStringConfiguration`](./sharedlibrarycoreconfiguration-GameStringConfiguration) | [`GameStrings`](#gamestrings) | `get, set` |
| [`GametypeConfiguration`](./sharedlibrarycoreconfiguration-GametypeConfiguration)`[]` | [`Gametypes`](#gametypes) | `get, set` |
| [`GameStringConfiguration`](./GameStringConfiguration.md) | [`GameStrings`](#gamestrings) | `get, set` |
| [`GametypeConfiguration`](./GametypeConfiguration.md)`[]` | [`Gametypes`](#gametypes) | `get, set` |
| `string``[]` | [`GlobalRules`](#globalrules) | `get, set` |
| [`MapConfiguration`](./sharedlibrarycoreconfiguration-MapConfiguration)`[]` | [`Maps`](#maps) | `get, set` |
| [`QuickMessageConfiguration`](./sharedlibrarycoreconfiguration-QuickMessageConfiguration)`[]` | [`QuickMessages`](#quickmessages) | `get, set` |
| [`MapConfiguration`](./MapConfiguration.md)`[]` | [`Maps`](#maps) | `get, set` |
| [`QuickMessageConfiguration`](./QuickMessageConfiguration.md)`[]` | [`QuickMessages`](#quickmessages) | `get, set` |
### Methods
#### Public methods
| Returns | Name |
| --- | --- |
| [`IBaseConfiguration`](./sharedlibrarycoreinterfaces-IBaseConfiguration) | [`Generate`](#generate)() |
| [`IBaseConfiguration`](../interfaces/IBaseConfiguration.md) | [`Generate`](#generate)() |
| `string` | [`Name`](#name)() |
## Details
### Inheritance
- [
`IBaseConfiguration`
](./sharedlibrarycoreinterfaces-IBaseConfiguration)
](../interfaces/IBaseConfiguration.md)
### Constructors
#### DefaultSettings
@ -49,11 +49,13 @@ public DefaultSettings()
### Methods
#### Generate
[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Configuration/DefaultSettings.cs#L16)
```csharp
public virtual IBaseConfiguration Generate()
```
#### Name
[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Configuration/DefaultSettings.cs#L21)
```csharp
public virtual string Name()
```

1
CodeDocumentation/SharedLibraryCore/sharedlibrarycoreconfiguration-GameStringConfiguration.md → CodeDocumentation/SharedLibraryCore/configuration/GameStringConfiguration.md

@ -33,6 +33,7 @@ public GameStringConfiguration()
### Methods
#### GetStringForGame
[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Configuration/GameStringConfiguration.cs#L10)
```csharp
public string GetStringForGame(string key, Nullable<Game> game)
```

2
CodeDocumentation/SharedLibraryCore/sharedlibrarycoreconfiguration-GametypeConfiguration.md → CodeDocumentation/SharedLibraryCore/configuration/GametypeConfiguration.md

@ -16,7 +16,7 @@
| Type | Name | Methods |
| --- | --- | --- |
| `Game` | [`Game`](#game) | `get, set` |
| [`Gametype`](./sharedlibrarycore-Gametype)`[]` | [`Gametypes`](#gametypes) | `get, set` |
| [`Gametype`](../Gametype.md)`[]` | [`Gametypes`](#gametypes) | `get, set` |
## Details
### Constructors

2
CodeDocumentation/SharedLibraryCore/sharedlibrarycoreconfiguration-MapConfiguration.md → CodeDocumentation/SharedLibraryCore/configuration/MapConfiguration.md

@ -16,7 +16,7 @@
| Type | Name | Methods |
| --- | --- | --- |
| `Game` | [`Game`](#game) | `get, set` |
| [`Map`](./sharedlibrarycore-Map)`[]` | [`Maps`](#maps) | `get, set` |
| [`Map`](../Map.md)`[]` | [`Maps`](#maps) | `get, set` |
## Details
### Constructors

0
CodeDocumentation/SharedLibraryCore/sharedlibrarycoreconfiguration-QuickMessageConfiguration.md → CodeDocumentation/SharedLibraryCore/configuration/QuickMessageConfiguration.md

18
CodeDocumentation/SharedLibraryCore/sharedlibrarycoreconfiguration-ServerConfiguration.md → CodeDocumentation/SharedLibraryCore/configuration/ServerConfiguration.md

@ -37,9 +37,9 @@ SharedLibraryCore.Interfaces.IBaseConfiguration --> SharedLibraryCore.Configurat
#### Public methods
| Returns | Name |
| --- | --- |
| `void` | [`AddEventParser`](#addeventparser)([`IEventParser`](./sharedlibrarycoreinterfaces-IEventParser) parser) |
| `void` | [`AddRConParser`](#addrconparser)([`IRConParser`](./sharedlibrarycoreinterfaces-IRConParser) parser) |
| [`IBaseConfiguration`](./sharedlibrarycoreinterfaces-IBaseConfiguration) | [`Generate`](#generate)() |
| `void` | [`AddEventParser`](#addeventparser)([`IEventParser`](../interfaces/IEventParser.md) parser) |
| `void` | [`AddRConParser`](#addrconparser)([`IRConParser`](../interfaces/IRConParser.md) parser) |
| [`IBaseConfiguration`](../interfaces/IBaseConfiguration.md) | [`Generate`](#generate)() |
| `void` | [`ModifyParsers`](#modifyparsers)() |
| `string` | [`Name`](#name)() |
@ -47,44 +47,50 @@ SharedLibraryCore.Interfaces.IBaseConfiguration --> SharedLibraryCore.Configurat
### Inheritance
- [
`IBaseConfiguration`
](./sharedlibrarycoreinterfaces-IBaseConfiguration)
](../interfaces/IBaseConfiguration.md)
### Constructors
#### ServerConfiguration
[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Configuration/ServerConfiguration.cs#L32)
```csharp
public ServerConfiguration()
```
### Methods
#### Generate
[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Configuration/ServerConfiguration.cs#L60)
```csharp
public virtual IBaseConfiguration Generate()
```
#### Name
[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Configuration/ServerConfiguration.cs#L125)
```csharp
public virtual string Name()
```
#### AddRConParser
[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Configuration/ServerConfiguration.cs#L130)
```csharp
public void AddRConParser(IRConParser parser)
```
##### Arguments
| Type | Name | Description |
| --- | --- | --- |
| [`IRConParser`](./sharedlibrarycoreinterfaces-IRConParser) | parser | |
| [`IRConParser`](../interfaces/IRConParser.md) | parser | |
#### AddEventParser
[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Configuration/ServerConfiguration.cs#L135)
```csharp
public void AddEventParser(IEventParser parser)
```
##### Arguments
| Type | Name | Description |
| --- | --- | --- |
| [`IEventParser`](./sharedlibrarycoreinterfaces-IEventParser) | parser | |
| [`IEventParser`](../interfaces/IEventParser.md) | parser | |
#### ModifyParsers
[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Configuration/ServerConfiguration.cs#L16707566)
```csharp
public void ModifyParsers()
```

0
CodeDocumentation/SharedLibraryCore/sharedlibrarycoreconfiguration-SocialAccountConfiguration.md → CodeDocumentation/SharedLibraryCore/configuration/SocialAccountConfiguration.md

0
CodeDocumentation/SharedLibraryCore/sharedlibrarycoreconfiguration-WebfrontConfiguration.md → CodeDocumentation/SharedLibraryCore/configuration/WebfrontConfiguration.md

0
CodeDocumentation/SharedLibraryCore/sharedlibrarycoreconfigurationattributes-ConfigurationIgnore.md → CodeDocumentation/SharedLibraryCore/configuration/attributes/ConfigurationIgnore.md

1
CodeDocumentation/SharedLibraryCore/sharedlibrarycoreconfigurationattributes-ConfigurationLinked.md → CodeDocumentation/SharedLibraryCore/configuration/attributes/ConfigurationLinked.md

@ -27,6 +27,7 @@ System.Attribute --> SharedLibraryCore.Configuration.Attributes.ConfigurationLin
### Constructors
#### ConfigurationLinked
[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Configuration/Attributes/ConfigurationLinked.cs#L8)
```csharp
public ConfigurationLinked(string[] linkedPropertyNames)
```

0
CodeDocumentation/SharedLibraryCore/sharedlibrarycoreconfigurationattributes-ConfigurationOptional.md → CodeDocumentation/SharedLibraryCore/configuration/attributes/ConfigurationOptional.md

1
CodeDocumentation/SharedLibraryCore/sharedlibrarycoreconfigurationattributes-LocalizedDisplayName.md → CodeDocumentation/SharedLibraryCore/configuration/attributes/LocalizedDisplayName.md

@ -27,6 +27,7 @@ System.ComponentModel.DisplayNameAttribute --> SharedLibraryCore.Configuration.A
### Constructors
#### LocalizedDisplayName
[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Configuration/Attributes/LocalizedDisplayName.cs#L9)
```csharp
public LocalizedDisplayName(string localizationKey)
```

10
CodeDocumentation/SharedLibraryCore/sharedlibrarycoreconfigurationextensions-ConfigurationExtensions.md → CodeDocumentation/SharedLibraryCore/configuration/extensions/ConfigurationExtensions.md

@ -15,27 +15,29 @@
#### Public Static methods
| Returns | Name |
| --- | --- |
| (`string` Item1, `string` Item2)`[]` | [`TryGetRConPasswords`](#trygetrconpasswords)([`IRConParser`](./sharedlibrarycoreinterfaces-IRConParser) parser) |
| `void` | [`TrySetIpAddress`](#trysetipaddress)([`ServerConfiguration`](./sharedlibrarycoreconfiguration-ServerConfiguration) config) |
| (`string` Item1, `string` Item2)`[]` | [`TryGetRConPasswords`](#trygetrconpasswords)([`IRConParser`](../../interfaces/IRConParser.md) parser) |
| `void` | [`TrySetIpAddress`](#trysetipaddress)([`ServerConfiguration`](../ServerConfiguration.md) config) |
## Details
### Methods
#### TrySetIpAddress
[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Configuration/Extensions/ConfigurationExtensions.cs#L17)
```csharp
public static void TrySetIpAddress(ServerConfiguration config)
```
##### Arguments
| Type | Name | Description |
| --- | --- | --- |
| [`ServerConfiguration`](./sharedlibrarycoreconfiguration-ServerConfiguration) | config | |
| [`ServerConfiguration`](../ServerConfiguration.md) | config | |
#### TryGetRConPasswords
[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Configuration/Extensions/ConfigurationExtensions.cs#L42)
```csharp
public static (string Item1, string Item2) TryGetRConPasswords(IRConParser parser)
```
##### Arguments
| Type | Name | Description |
| --- | --- | --- |
| [`IRConParser`](./sharedlibrarycoreinterfaces-IRConParser) | parser | |
| [`IRConParser`](../../interfaces/IRConParser.md) | parser | |
*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc)

3
CodeDocumentation/SharedLibraryCore/sharedlibrarycoreconfigurationvalidation-ApplicationConfigurationValidator.md → CodeDocumentation/SharedLibraryCore/configuration/validation/ApplicationConfigurationValidator.md

@ -22,10 +22,11 @@ FluentValidation.AbstractValidator_1 --> SharedLibraryCore.Configuration.Validat
Validation class for main application configuration
### Inheritance
- `AbstractValidator`&lt;[`ApplicationConfiguration`](./sharedlibrarycoreconfiguration-ApplicationConfiguration)&gt;
- `AbstractValidator`&lt;[`ApplicationConfiguration`](../ApplicationConfiguration.md)&gt;
### Constructors
#### ApplicationConfigurationValidator
[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Configuration/Validation/ApplicationConfigurationValidator.cs#L13)
```csharp
public ApplicationConfigurationValidator()
```

3
CodeDocumentation/SharedLibraryCore/sharedlibrarycoreconfigurationvalidation-ServerConfigurationValidator.md → CodeDocumentation/SharedLibraryCore/configuration/validation/ServerConfigurationValidator.md

@ -22,10 +22,11 @@ FluentValidation.AbstractValidator_1 --> SharedLibraryCore.Configuration.Validat
Validation class for server configuration
### Inheritance
- `AbstractValidator`&lt;[`ServerConfiguration`](./sharedlibrarycoreconfiguration-ServerConfiguration)&gt;
- `AbstractValidator`&lt;[`ServerConfiguration`](../ServerConfiguration.md)&gt;
### Constructors
#### ServerConfigurationValidator
[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Configuration/Validation/ServerConfigurationValidator.cs#L10)
```csharp
public ServerConfigurationValidator()
```

69
CodeDocumentation/SharedLibraryCore/sharedlibrarycoredatabasemodels-EFClient.md → CodeDocumentation/SharedLibraryCore/database/models/EFClient.md

@ -21,10 +21,10 @@ Data.Models.Client.EFClient --> SharedLibraryCore.Database.Models.EFClient
| --- | --- | --- |
| `string` | [`CleanedName`](#cleanedname) | `get` |
| `int` | [`ClientNumber`](#clientnumber) | `get, set` |
| [`ClientPermission`](./sharedlibrarycorelocalization-ClientPermission) | [`ClientPermission`](#clientpermission) | `get` |
| [`ClientPermission`](../../localization/ClientPermission.md) | [`ClientPermission`](#clientpermission) | `get` |
| `int` | [`ConnectionLength`](#connectionlength) | `get` |
| `DateTime` | [`ConnectionTime`](#connectiontime) | `get, set` |
| [`Server`](./sharedlibrarycore-Server) | [`CurrentServer`](#currentserver) | `get, set` |
| [`Server`](../../Server.md) | [`CurrentServer`](#currentserver) | `get, set` |
| `string` | [`GuidString`](#guidstring) | `get` |
| `Nullable`&lt;`int`&gt; | [`IPAddress`](#ipaddress) | `get, set` |
| `string` | [`IPAddressString`](#ipaddressstring) | `get` |
@ -52,28 +52,28 @@ Data.Models.Client.EFClient --> SharedLibraryCore.Database.Models.EFClient
#### Public methods
| Returns | Name |
| --- | --- |
| [`GameEvent`](./sharedlibrarycore-GameEvent) | [`Ban`](#ban)(`string` banReason, [`EFClient`](sharedlibrarycoredatabasemodels-EFClient) sender, `bool` isEvade)<br>permanently ban a client |
| [`GameEvent`](../../GameEvent.md) | [`Ban`](#ban)(`string` banReason, [`EFClient`](sharedlibrarycore/database/models/EFClient.md) sender, `bool` isEvade)<br>permanently ban a client |
| `Task`&lt;`bool`&gt; | [`CanConnect`](#canconnect)(`Nullable`&lt;`int`&gt; ipAddress, `bool` enableImplicitLinking) |
| `bool` | [`Equals`](#equals)(`object` obj) |
| [`GameEvent`](./sharedlibrarycore-GameEvent) | [`Flag`](#flag)(`string` flagReason, [`EFClient`](sharedlibrarycoredatabasemodels-EFClient) sender, `Nullable`&lt;`TimeSpan`&gt; flagLength) |
| [`GameEvent`](../../GameEvent.md) | [`Flag`](#flag)(`string` flagReason, [`EFClient`](sharedlibrarycore/database/models/EFClient.md) sender, `Nullable`&lt;`TimeSpan`&gt; flagLength) |
| `int` | [`GetHashCode`](#gethashcode)() |
| `bool` | [`IsAbleToConnectSimple`](#isabletoconnectsimple)()<br>Handles any client related logic on connection |
| [`GameEvent`](./sharedlibrarycore-GameEvent) | [`Kick`](#kick-12)(`...`)<br>kick a client for the given reason |
| [`GameEvent`](../../GameEvent.md) | [`Kick`](#kick-12)(`...`)<br>kick a client for the given reason |
| `Task` | [`Lock`](#lock)() |
| `Task` | [`OnDisconnect`](#ondisconnect)() |
| `Task` | [`OnJoin`](#onjoin)(`Nullable`&lt;`int`&gt; ipAddress, `bool` enableImplicitLinking) |
| [`GameEvent`](./sharedlibrarycore-GameEvent) | [`Report`](#report)(`string` reportReason, [`EFClient`](sharedlibrarycoredatabasemodels-EFClient) sender)<br>report a client for a given reason |
| [`GameEvent`](./sharedlibrarycore-GameEvent) | [`SetLevel`](#setlevel)(`Permission` newPermission, [`EFClient`](sharedlibrarycoredatabasemodels-EFClient) sender) |
| [`GameEvent`](./sharedlibrarycore-GameEvent) | [`Tell`](#tell-12)(`...`)<br>send a message directly to the connected client |
| [`GameEvent`](../../GameEvent.md) | [`Report`](#report)(`string` reportReason, [`EFClient`](sharedlibrarycore/database/models/EFClient.md) sender)<br>report a client for a given reason |
| [`GameEvent`](../../GameEvent.md) | [`SetLevel`](#setlevel)(`Permission` newPermission, [`EFClient`](sharedlibrarycore/database/models/EFClient.md) sender) |
| [`GameEvent`](../../GameEvent.md) | [`Tell`](#tell-12)(`...`)<br>send a message directly to the connected client |
| `Task` | [`TellAsync`](#tellasync)(`IEnumerable`&lt;`string`&gt; messages, `CancellationToken` token) |
| [`GameEvent`](./sharedlibrarycore-GameEvent) | [`TempBan`](#tempban)(`string` tempbanReason, `TimeSpan` banLength, [`EFClient`](sharedlibrarycoredatabasemodels-EFClient) sender)<br>temporarily ban a client for the given time span |
| [`GameEvent`](../../GameEvent.md) | [`TempBan`](#tempban)(`string` tempbanReason, `TimeSpan` banLength, [`EFClient`](sharedlibrarycore/database/models/EFClient.md) sender)<br>temporarily ban a client for the given time span |
| `string` | [`ToString`](#tostring)() |
| [`GameEvent`](./sharedlibrarycore-GameEvent) | [`Unban`](#unban)(`string` unbanReason, [`EFClient`](sharedlibrarycoredatabasemodels-EFClient) sender)<br>unban a client |
| [`GameEvent`](./sharedlibrarycore-GameEvent) | [`Unflag`](#unflag)(`string` unflagReason, [`EFClient`](sharedlibrarycoredatabasemodels-EFClient) sender)<br>unflag a client for a given reason |
| [`GameEvent`](../../GameEvent.md) | [`Unban`](#unban)(`string` unbanReason, [`EFClient`](sharedlibrarycore/database/models/EFClient.md) sender)<br>unban a client |
| [`GameEvent`](../../GameEvent.md) | [`Unflag`](#unflag)(`string` unflagReason, [`EFClient`](sharedlibrarycore/database/models/EFClient.md) sender)<br>unflag a client for a given reason |
| `void` | [`Unlock`](#unlock)() |
| `void` | [`UpdateTeam`](#updateteam)(`string` newTeam) |
| [`GameEvent`](./sharedlibrarycore-GameEvent) | [`Warn`](#warn)(`string` warnReason, [`EFClient`](sharedlibrarycoredatabasemodels-EFClient) sender)<br>warn a client with given reason |
| [`GameEvent`](./sharedlibrarycore-GameEvent) | [`WarnClear`](#warnclear)([`EFClient`](sharedlibrarycoredatabasemodels-EFClient) sender)<br>clear all warnings for a client |
| [`GameEvent`](../../GameEvent.md) | [`Warn`](#warn)(`string` warnReason, [`EFClient`](sharedlibrarycore/database/models/EFClient.md) sender)<br>warn a client with given reason |
| [`GameEvent`](../../GameEvent.md) | [`WarnClear`](#warnclear)([`EFClient`](sharedlibrarycore/database/models/EFClient.md) sender)<br>clear all warnings for a client |
## Details
### Inheritance
@ -86,22 +86,26 @@ Data.Models.Client.EFClient --> SharedLibraryCore.Database.Models.EFClient
### Constructors
#### EFClient
[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/PartialEntities/EFClient.cs#L53)
```csharp
public EFClient()
```
### Methods
#### Finalize
[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/PartialEntities/EFClient.cs#L147)
```csharp
protected override void Finalize()
```
#### ToString
[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/PartialEntities/EFClient.cs#L152)
```csharp
public override string ToString()
```
#### Tell [1/2]
[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/PartialEntities/EFClient.cs#L162)
```csharp
public GameEvent Tell(string message)
```
@ -114,6 +118,7 @@ public GameEvent Tell(string message)
send a message directly to the connected client
#### Tell [2/2]
[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/PartialEntities/EFClient.cs#L186)
```csharp
public void Tell(IEnumerable<string> messages)
```
@ -133,6 +138,7 @@ public async Task TellAsync(IEnumerable<string> messages, CancellationToken toke
| `CancellationToken` | token | |
#### Warn
[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/PartialEntities/EFClient.cs#L214)
```csharp
public GameEvent Warn(string warnReason, EFClient sender)
```
@ -140,19 +146,20 @@ public GameEvent Warn(string warnReason, EFClient sender)
| Type | Name | Description |
| --- | --- | --- |
| `string` | warnReason | reason for warn |
| [`EFClient`](sharedlibrarycoredatabasemodels-EFClient) | sender | client performing the warn |
| [`EFClient`](sharedlibrarycore/database/models/EFClient.md) | sender | client performing the warn |
##### Summary
warn a client with given reason
#### WarnClear
[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/PartialEntities/EFClient.cs#L246)
```csharp
public GameEvent WarnClear(EFClient sender)
```
##### Arguments
| Type | Name | Description |
| --- | --- | --- |
| [`EFClient`](sharedlibrarycoredatabasemodels-EFClient) | sender | client performing the warn clear |
| [`EFClient`](sharedlibrarycore/database/models/EFClient.md) | sender | client performing the warn clear |
##### Summary
clear all warnings for a client
@ -161,6 +168,7 @@ clear all warnings for a client
#### Report
[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/PartialEntities/EFClient.cs#L16707566)
```csharp
public GameEvent Report(string reportReason, EFClient sender)
```
@ -168,7 +176,7 @@ public GameEvent Report(string reportReason, EFClient sender)
| Type | Name | Description |
| --- | --- | --- |
| `string` | reportReason | reason for the report |
| [`EFClient`](sharedlibrarycoredatabasemodels-EFClient) | sender | client performing the report |
| [`EFClient`](sharedlibrarycore/database/models/EFClient.md) | sender | client performing the report |
##### Summary
report a client for a given reason
@ -177,6 +185,7 @@ report a client for a given reason
#### Flag
[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/PartialEntities/EFClient.cs#L317)
```csharp
public GameEvent Flag(string flagReason, EFClient sender, Nullable<TimeSpan> flagLength)
```
@ -184,10 +193,11 @@ public GameEvent Flag(string flagReason, EFClient sender, Nullable<TimeSpan> fla
| Type | Name | Description |
| --- | --- | --- |
| `string` | flagReason | |
| [`EFClient`](sharedlibrarycoredatabasemodels-EFClient) | sender | |
| [`EFClient`](sharedlibrarycore/database/models/EFClient.md) | sender | |
| `Nullable`&lt;`TimeSpan`&gt; | flagLength | |
#### Unflag
[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/PartialEntities/EFClient.cs#L350)
```csharp
public GameEvent Unflag(string unflagReason, EFClient sender)
```
@ -195,7 +205,7 @@ public GameEvent Unflag(string unflagReason, EFClient sender)
| Type | Name | Description |
| --- | --- | --- |
| `string` | unflagReason | reason to unflag a player for |
| [`EFClient`](sharedlibrarycoredatabasemodels-EFClient) | sender | client performing the unflag |
| [`EFClient`](sharedlibrarycore/database/models/EFClient.md) | sender | client performing the unflag |
##### Summary
unflag a client for a given reason
@ -204,6 +214,7 @@ unflag a client for a given reason
game event for the un flug
#### Kick [1/2]
[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/PartialEntities/EFClient.cs#L381)
```csharp
public GameEvent Kick(string kickReason, EFClient sender)
```
@ -211,12 +222,13 @@ public GameEvent Kick(string kickReason, EFClient sender)
| Type | Name | Description |
| --- | --- | --- |
| `string` | kickReason | reason to kick for |
| [`EFClient`](sharedlibrarycoredatabasemodels-EFClient) | sender | client performing the kick |
| [`EFClient`](sharedlibrarycore/database/models/EFClient.md) | sender | client performing the kick |
##### Summary
kick a client for the given reason
#### Kick [2/2]
[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/PartialEntities/EFClient.cs#L392)
```csharp
public GameEvent Kick(string kickReason, EFClient sender, EFPenalty originalPenalty)
```
@ -224,13 +236,14 @@ public GameEvent Kick(string kickReason, EFClient sender, EFPenalty originalPena
| Type | Name | Description |
| --- | --- | --- |
| `string` | kickReason | reason to kick for |
| [`EFClient`](sharedlibrarycoredatabasemodels-EFClient) | sender | client performing the kick |
| [`EFClient`](sharedlibrarycore/database/models/EFClient.md) | sender | client performing the kick |
| `EFPenalty` | originalPenalty | original client penalty |
##### Summary
kick a client for the given reason
#### TempBan
[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/PartialEntities/EFClient.cs#L422)
```csharp
public GameEvent TempBan(string tempbanReason, TimeSpan banLength, EFClient sender)
```
@ -239,12 +252,13 @@ public GameEvent TempBan(string tempbanReason, TimeSpan banLength, EFClient send
| --- | --- | --- |
| `string` | tempbanReason | reason for the temp ban |
| `TimeSpan` | banLength | how long the temp ban lasts |
| [`EFClient`](sharedlibrarycoredatabasemodels-EFClient) | sender | client performing the tempban |
| [`EFClient`](sharedlibrarycore/database/models/EFClient.md) | sender | client performing the tempban |
##### Summary
temporarily ban a client for the given time span
#### Ban
[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/PartialEntities/EFClient.cs#L452)
```csharp
public GameEvent Ban(string banReason, EFClient sender, bool isEvade)
```
@ -252,13 +266,14 @@ public GameEvent Ban(string banReason, EFClient sender, bool isEvade)
| Type | Name | Description |
| --- | --- | --- |
| `string` | banReason | reason for the ban |
| [`EFClient`](sharedlibrarycoredatabasemodels-EFClient) | sender | client performing the ban |
| [`EFClient`](sharedlibrarycore/database/models/EFClient.md) | sender | client performing the ban |
| `bool` | isEvade | obsolete |
##### Summary
permanently ban a client
#### Unban
[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/PartialEntities/EFClient.cs#L487)
```csharp
public GameEvent Unban(string unbanReason, EFClient sender)
```
@ -266,7 +281,7 @@ public GameEvent Unban(string unbanReason, EFClient sender)
| Type | Name | Description |
| --- | --- | --- |
| `string` | unbanReason | reason for the unban |
| [`EFClient`](sharedlibrarycoredatabasemodels-EFClient) | sender | client performing the unban |
| [`EFClient`](sharedlibrarycore/database/models/EFClient.md) | sender | client performing the unban |
##### Summary
unban a client
@ -275,6 +290,7 @@ unban a client
#### SetLevel
[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/PartialEntities/EFClient.cs#L515)
```csharp
public GameEvent SetLevel(Permission newPermission, EFClient sender)
```
@ -282,9 +298,10 @@ public GameEvent SetLevel(Permission newPermission, EFClient sender)
| Type | Name | Description |
| --- | --- | --- |
| `Permission` | newPermission | |
| [`EFClient`](sharedlibrarycoredatabasemodels-EFClient) | sender | |
| [`EFClient`](sharedlibrarycore/database/models/EFClient.md) | sender | |
#### IsAbleToConnectSimple
[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/PartialEntities/EFClient.cs#L548)
```csharp
public bool IsAbleToConnectSimple()
```
@ -317,6 +334,7 @@ public async Task<bool> CanConnect(Nullable<int> ipAddress, bool enableImplicitL
| `bool` | enableImplicitLinking | |
#### UpdateTeam
[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/PartialEntities/EFClient.cs#L787)
```csharp
public void UpdateTeam(string newTeam)
```
@ -331,11 +349,13 @@ public async Task Lock()
```
#### Unlock
[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/PartialEntities/EFClient.cs#L810)
```csharp
public void Unlock()
```
#### Equals
[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/PartialEntities/EFClient.cs#L818)
```csharp
public override bool Equals(object obj)
```
@ -345,6 +365,7 @@ public override bool Equals(object obj)
| `object` | obj | |
#### GetHashCode
[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/PartialEntities/EFClient.cs#L823)
```csharp
public override int GetHashCode()
```

0
CodeDocumentation/SharedLibraryCore/sharedlibrarycoredatabasemodelsefclient-ClientState.md → CodeDocumentation/SharedLibraryCore/database/models/efclient/ClientState.md

0
CodeDocumentation/SharedLibraryCore/sharedlibrarycoredatabasemodelsefclient-TeamType.md → CodeDocumentation/SharedLibraryCore/database/models/efclient/TeamType.md

0
CodeDocumentation/SharedLibraryCore/sharedlibrarycoredtos-AuditInfo.md → CodeDocumentation/SharedLibraryCore/dtos/AuditInfo.md

0
CodeDocumentation/SharedLibraryCore/sharedlibrarycoredtos-ChatInfo.md → CodeDocumentation/SharedLibraryCore/dtos/ChatInfo.md

0
CodeDocumentation/SharedLibraryCore/sharedlibrarycoredtos-ClientCountSnapshot.md → CodeDocumentation/SharedLibraryCore/dtos/ClientCountSnapshot.md

3
CodeDocumentation/SharedLibraryCore/sharedlibrarycoredtos-ClientHistoryInfo.md → CodeDocumentation/SharedLibraryCore/dtos/ClientHistoryInfo.md

@ -15,12 +15,13 @@
#### Public properties
| Type | Name | Methods |
| --- | --- | --- |
| `List`&lt;[`ClientCountSnapshot`](./sharedlibrarycoredtos-ClientCountSnapshot)&gt; | [`ClientCounts`](#clientcounts) | `get, set` |
| `List`&lt;[`ClientCountSnapshot`](./ClientCountSnapshot.md)&gt; | [`ClientCounts`](#clientcounts) | `get, set` |
| `long` | [`ServerId`](#serverid) | `get, set` |
## Details
### Constructors
#### ClientHistoryInfo
[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Dtos/ClientHistoryInfo.cs#L9)
```csharp
public ClientHistoryInfo()
```

0
CodeDocumentation/SharedLibraryCore/sharedlibrarycoredtos-ClientInfo.md → CodeDocumentation/SharedLibraryCore/dtos/ClientInfo.md

0
CodeDocumentation/SharedLibraryCore/sharedlibrarycoredtos-CommandResponseInfo.md → CodeDocumentation/SharedLibraryCore/dtos/CommandResponseInfo.md

0
CodeDocumentation/SharedLibraryCore/sharedlibrarycoredtos-EntityInfo.md → CodeDocumentation/SharedLibraryCore/dtos/EntityInfo.md

0
CodeDocumentation/SharedLibraryCore/sharedlibrarycoredtos-ErrorResponse.md → CodeDocumentation/SharedLibraryCore/dtos/ErrorResponse.md

11
CodeDocumentation/SharedLibraryCore/sharedlibrarycoredtos-EventInfo.md → CodeDocumentation/SharedLibraryCore/dtos/EventInfo.md

@ -19,13 +19,13 @@ This class wraps the information related to a generated event for the API
| Type | Name | Methods |
| --- | --- | --- |
| `DateTime` | [`EventTime`](#eventtime) | `get, set` |
| [`EntityInfo`](./sharedlibrarycoredtos-EntityInfo) | [`EventType`](#eventtype) | `get, set` |
| [`EntityInfo`](./EntityInfo.md) | [`EventType`](#eventtype) | `get, set` |
| `string` | [`ExtraInfo`](#extrainfo) | `get, set` |
| [`EntityInfo`](./sharedlibrarycoredtos-EntityInfo) | [`GameInfo`](#gameinfo) | `get, set` |
| [`EntityInfo`](./EntityInfo.md) | [`GameInfo`](#gameinfo) | `get, set` |
| `string` | [`Id`](#id) | `get` |
| [`EntityInfo`](./sharedlibrarycoredtos-EntityInfo) | [`OriginEntity`](#originentity) | `get, set` |
| [`EntityInfo`](./sharedlibrarycoredtos-EntityInfo) | [`OwnerEntity`](#ownerentity) | `get, set` |
| [`EntityInfo`](./sharedlibrarycoredtos-EntityInfo) | [`TargetEntity`](#targetentity) | `get, set` |
| [`EntityInfo`](./EntityInfo.md) | [`OriginEntity`](#originentity) | `get, set` |
| [`EntityInfo`](./EntityInfo.md) | [`OwnerEntity`](#ownerentity) | `get, set` |
| [`EntityInfo`](./EntityInfo.md) | [`TargetEntity`](#targetentity) | `get, set` |
## Details
### Summary
@ -33,6 +33,7 @@ This class wraps the information related to a generated event for the API
### Constructors
#### EventInfo
[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Dtos/EventInfo.cs#L17)
```csharp
public EventInfo()
```

3
CodeDocumentation/SharedLibraryCore/sharedlibrarycoredtos-FindClientRequest.md → CodeDocumentation/SharedLibraryCore/dtos/FindClientRequest.md

@ -30,7 +30,7 @@ SharedLibraryCore.Dtos.PaginationRequest --> SharedLibraryCore.Dtos.FindClientRe
### Inheritance
- [
`PaginationRequest`
](./sharedlibrarycoredtos-PaginationRequest)
](./PaginationRequest.md)
### Constructors
#### FindClientRequest
@ -40,6 +40,7 @@ public FindClientRequest()
### Methods
#### ToDebugString
[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Dtos/FindClientRequest.cs#L16)
```csharp
public string ToDebugString()
```

0
CodeDocumentation/SharedLibraryCore/sharedlibrarycoredtos-FindClientResult.md → CodeDocumentation/SharedLibraryCore/dtos/FindClientResult.md

0
CodeDocumentation/SharedLibraryCore/sharedlibrarycoredtos-IW4MAdminInfo.md → CodeDocumentation/SharedLibraryCore/dtos/IW4MAdminInfo.md

2
CodeDocumentation/SharedLibraryCore/sharedlibrarycoredtos-LookupValueT.md → CodeDocumentation/SharedLibraryCore/dtos/LookupValueT.md

@ -27,7 +27,7 @@ SharedLibraryCore.Interfaces.ILookupValue_1 --> SharedLibraryCore.Dtos.LookupVal
## Details
### Inheritance
- [`ILookupValue`](./sharedlibrarycoreinterfaces-ILookupValueT)&lt;`TObject`&gt;
- [`ILookupValue`](../interfaces/ILookupValueT.md)&lt;`TObject`&gt;
### Constructors
#### LookupValue

0
CodeDocumentation/SharedLibraryCore/sharedlibrarycoredtos-Page.md → CodeDocumentation/SharedLibraryCore/dtos/Page.md

3
CodeDocumentation/SharedLibraryCore/sharedlibrarycoredtos-PaginationRequest.md → CodeDocumentation/SharedLibraryCore/dtos/PaginationRequest.md

@ -21,7 +21,7 @@ pagination information holder class
| `Nullable`&lt;`DateTime`&gt; | [`After`](#after) | `get, set` |
| `Nullable`&lt;`DateTime`&gt; | [`Before`](#before) | `get, set` |
| `int` | [`Count`](#count)<br>how many items to take | `get, set` |
| [`SortDirection`](./sharedlibrarycoredtos-SortDirection) | [`Direction`](#direction)<br>direction of ordering | `get, set` |
| [`SortDirection`](./SortDirection.md) | [`Direction`](#direction)<br>direction of ordering | `get, set` |
| `string` | [`Filter`](#filter)<br>filter query | `get, set` |
| `int` | [`Offset`](#offset)<br>how many items to skip | `get, set` |
@ -31,6 +31,7 @@ pagination information holder class
### Constructors
#### PaginationRequest
[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Dtos/PaginationRequest.cs#L18)
```csharp
public PaginationRequest()
```

2
CodeDocumentation/SharedLibraryCore/sharedlibrarycoredtos-PenaltyInfo.md → CodeDocumentation/SharedLibraryCore/dtos/PenaltyInfo.md

@ -45,7 +45,7 @@ SharedLibraryCore.Dtos.SharedInfo --> SharedLibraryCore.Dtos.PenaltyInfo
### Inheritance
- [
`SharedInfo`
](./sharedlibrarycoredtos-SharedInfo)
](./SharedInfo.md)
### Constructors
#### PenaltyInfo

10
CodeDocumentation/SharedLibraryCore/sharedlibrarycoredtos-PlayerInfo.md → CodeDocumentation/SharedLibraryCore/dtos/PlayerInfo.md

@ -23,21 +23,21 @@
| `string` | [`ConnectProtocolUrl`](#connectprotocolurl) | `get, set` |
| `string` | [`CurrentServerName`](#currentservername) | `get, set` |
| `Game` | [`Game`](#game) | `get, set` |
| [`IGeoLocationResult`](./sharedlibrarycoreinterfaces-IGeoLocationResult) | [`GeoLocationInfo`](#geolocationinfo) | `get, set` |
| [`IGeoLocationResult`](../interfaces/IGeoLocationResult.md) | [`GeoLocationInfo`](#geolocationinfo) | `get, set` |
| `bool` | [`HasActivePenalty`](#hasactivepenalty) | `get, set` |
| `string` | [`IPAddress`](#ipaddress) | `get, set` |
| `List`&lt;(`string` Item1, `DateTime` Item2)&gt; | [`IPs`](#ips) | `get, set` |
| `List`&lt;[`IInteractionData`](./sharedlibrarycoreinterfaces-IInteractionData)&gt; | [`Interactions`](#interactions) | `get, set` |
| `List`&lt;[`IInteractionData`](../interfaces/IInteractionData.md)&gt; | [`Interactions`](#interactions) | `get, set` |
| `DateTime` | [`LastConnection`](#lastconnection) | `get, set` |
| `string` | [`LastConnectionText`](#lastconnectiontext) | `get` |
| `string` | [`Level`](#level) | `get, set` |
| `int` | [`LevelInt`](#levelint) | `get, set` |
| `IDictionary`&lt;`int`, `long`&gt; | [`LinkedAccounts`](#linkedaccounts) | `get, set` |
| `List`&lt;[`InformationResponse`](./sharedlibrarycoredtosmetaresponses-InformationResponse)&gt; | [`Meta`](#meta) | `get, set` |
| `Nullable`&lt;[`MetaType`](./sharedlibrarycoreinterfaces-MetaType)&gt; | [`MetaFilterType`](#metafiltertype) | `get, set` |
| `List`&lt;[`InformationResponse`](meta/responses/InformationResponse.md)&gt; | [`Meta`](#meta) | `get, set` |
| `Nullable`&lt;[`MetaType`](../interfaces/MetaType.md)&gt; | [`MetaFilterType`](#metafiltertype) | `get, set` |
| `string` | [`Name`](#name) | `get, set` |
| `long` | [`NetworkId`](#networkid) | `get, set` |
| [`ClientNoteMetaResponse`](./sharedlibrarycoredtosmetaresponses-ClientNoteMetaResponse) | [`NoteMeta`](#notemeta) | `get, set` |
| [`ClientNoteMetaResponse`](meta/responses/ClientNoteMetaResponse.md) | [`NoteMeta`](#notemeta) | `get, set` |
| `bool` | [`Online`](#online) | `get, set` |
| `string` | [`Tag`](#tag) | `get, set` |
| `string` | [`TimeOnline`](#timeonline) | `get, set` |

8
CodeDocumentation/SharedLibraryCore/sharedlibrarycoredtos-ServerInfo.md → CodeDocumentation/SharedLibraryCore/dtos/ServerInfo.md

@ -15,9 +15,9 @@
#### Public properties
| Type | Name | Methods |
| --- | --- | --- |
| `List`&lt;[`ChatInfo`](./sharedlibrarycoredtos-ChatInfo)&gt; | [`ChatHistory`](#chathistory) | `get, set` |
| `List`&lt;[`ChatInfo`](./ChatInfo.md)&gt; | [`ChatHistory`](#chathistory) | `get, set` |
| `int` | [`ClientCount`](#clientcount) | `get, set` |
| [`ClientHistoryInfo`](./sharedlibrarycoredtos-ClientHistoryInfo) | [`ClientHistory`](#clienthistory) | `get, set` |
| [`ClientHistoryInfo`](./ClientHistoryInfo.md) | [`ClientHistory`](#clienthistory) | `get, set` |
| `string` | [`ConnectProtocolUrl`](#connectprotocolurl) | `get, set` |
| `string` | [`Endpoint`](#endpoint) | `get` |
| `string` | [`ExternalIPAddress`](#externalipaddress) | `get, set` |
@ -31,10 +31,10 @@
| `int` | [`MaxClients`](#maxclients) | `get, set` |
| `string` | [`Name`](#name) | `get, set` |
| `bool` | [`Online`](#online) | `get, set` |
| `List`&lt;[`PlayerInfo`](./sharedlibrarycoredtos-PlayerInfo)&gt; | [`Players`](#players) | `get, set` |
| `List`&lt;[`PlayerInfo`](./PlayerInfo.md)&gt; | [`Players`](#players) | `get, set` |
| `int` | [`Port`](#port) | `get, set` |
| `int` | [`PrivateClientSlots`](#privateclientslots) | `get, set` |
| `List`&lt;[`Report`](./sharedlibrarycorehelpers-Report)&gt; | [`Reports`](#reports) | `get, set` |
| `List`&lt;[`Report`](../helpers/Report.md)&gt; | [`Reports`](#reports) | `get, set` |
## Details
### Constructors

1
CodeDocumentation/SharedLibraryCore/sharedlibrarycoredtos-SharedInfo.md → CodeDocumentation/SharedLibraryCore/dtos/SharedInfo.md

@ -22,6 +22,7 @@
## Details
### Constructors
#### SharedInfo
[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Dtos/SharedInfo.cs#L6)
```csharp
public SharedInfo()
```

0
CodeDocumentation/SharedLibraryCore/sharedlibrarycoredtos-SortDirection.md → CodeDocumentation/SharedLibraryCore/dtos/SortDirection.md

0
CodeDocumentation/SharedLibraryCore/sharedlibrarycoredtosmeta-WebfrontTranslationHelper.md → CodeDocumentation/SharedLibraryCore/dtos/meta/WebfrontTranslationHelper.md

2
CodeDocumentation/SharedLibraryCore/sharedlibrarycoredtosmetarequests-BaseClientMetaRequest.md → CodeDocumentation/SharedLibraryCore/dtos/meta/requests/BaseClientMetaRequest.md

@ -25,7 +25,7 @@ SharedLibraryCore.Dtos.PaginationRequest --> SharedLibraryCore.Dtos.Meta.Request
### Inheritance
- [
`PaginationRequest`
](./sharedlibrarycoredtos-PaginationRequest)
](../../PaginationRequest.md)
### Constructors
#### BaseClientMetaRequest

2
CodeDocumentation/SharedLibraryCore/sharedlibrarycoredtosmetarequests-ReceivedPenaltyRequest.md → CodeDocumentation/SharedLibraryCore/dtos/meta/requests/ReceivedPenaltyRequest.md

@ -16,7 +16,7 @@ SharedLibraryCore.Dtos.Meta.Requests.BaseClientMetaRequest --> SharedLibraryCore
### Inheritance
- [
`BaseClientMetaRequest`
](./sharedlibrarycoredtosmetarequests-BaseClientMetaRequest)
](./BaseClientMetaRequest.md)
### Constructors
#### ReceivedPenaltyRequest

2
CodeDocumentation/SharedLibraryCore/sharedlibrarycoredtosmetaresponses-AdministeredPenaltyResponse.md → CodeDocumentation/SharedLibraryCore/dtos/meta/responses/AdministeredPenaltyResponse.md

@ -16,7 +16,7 @@ SharedLibraryCore.Dtos.Meta.Responses.ReceivedPenaltyResponse --> SharedLibraryC
### Inheritance
- [
`ReceivedPenaltyResponse`
](./sharedlibrarycoredtosmetaresponses-ReceivedPenaltyResponse)
](./ReceivedPenaltyResponse.md)
### Constructors
#### AdministeredPenaltyResponse

6
CodeDocumentation/SharedLibraryCore/sharedlibrarycoredtosmetaresponses-BaseMetaResponse.md → CodeDocumentation/SharedLibraryCore/dtos/meta/responses/BaseMetaResponse.md

@ -29,17 +29,17 @@ SharedLibraryCore.Interfaces.IClientMetaResponse --> SharedLibraryCore.Dtos.Meta
| `long` | [`MetaId`](#metaid) | `get, set` |
| `Nullable`&lt;`int`&gt; | [`Order`](#order) | `get, set` |
| `bool` | [`ShouldDisplay`](#shoulddisplay) | `get, set` |
| [`MetaType`](./sharedlibrarycoreinterfaces-MetaType) | [`Type`](#type) | `get, set` |
| [`MetaType`](../../../interfaces/MetaType.md) | [`Type`](#type) | `get, set` |
| `DateTime` | [`When`](#when) | `get, set` |
## Details
### Inheritance
- [
`IClientMeta`
](./sharedlibrarycoreinterfaces-IClientMeta)
](../../../interfaces/IClientMeta.md)
- [
`IClientMetaResponse`
](./sharedlibrarycoreinterfaces-IClientMetaResponse)
](../../../interfaces/IClientMetaResponse.md)
### Constructors
#### BaseMetaResponse

0
CodeDocumentation/SharedLibraryCore/sharedlibrarycoredtosmetaresponses-ClientNoteMetaResponse.md → CodeDocumentation/SharedLibraryCore/dtos/meta/responses/ClientNoteMetaResponse.md

2
CodeDocumentation/SharedLibraryCore/sharedlibrarycoredtosmetaresponses-ConnectionHistoryResponse.md → CodeDocumentation/SharedLibraryCore/dtos/meta/responses/ConnectionHistoryResponse.md

@ -24,7 +24,7 @@ SharedLibraryCore.Dtos.Meta.Responses.BaseMetaResponse --> SharedLibraryCore.Dto
### Inheritance
- [
`BaseMetaResponse`
](./sharedlibrarycoredtosmetaresponses-BaseMetaResponse)
](./BaseMetaResponse.md)
### Constructors
#### ConnectionHistoryResponse

2
CodeDocumentation/SharedLibraryCore/sharedlibrarycoredtosmetaresponses-InformationResponse.md → CodeDocumentation/SharedLibraryCore/dtos/meta/responses/InformationResponse.md

@ -25,7 +25,7 @@ SharedLibraryCore.Dtos.Meta.Responses.BaseMetaResponse --> SharedLibraryCore.Dto
### Inheritance
- [
`BaseMetaResponse`
](./sharedlibrarycoredtosmetaresponses-BaseMetaResponse)
](./BaseMetaResponse.md)
### Constructors
#### InformationResponse

2
CodeDocumentation/SharedLibraryCore/sharedlibrarycoredtosmetaresponses-MessageResponse.md → CodeDocumentation/SharedLibraryCore/dtos/meta/responses/MessageResponse.md

@ -31,7 +31,7 @@ SharedLibraryCore.Dtos.Meta.Responses.BaseMetaResponse --> SharedLibraryCore.Dto
### Inheritance
- [
`BaseMetaResponse`
](./sharedlibrarycoredtosmetaresponses-BaseMetaResponse)
](./BaseMetaResponse.md)
### Constructors
#### MessageResponse

2
CodeDocumentation/SharedLibraryCore/sharedlibrarycoredtosmetaresponses-PermissionLevelChangedResponse.md → CodeDocumentation/SharedLibraryCore/dtos/meta/responses/PermissionLevelChangedResponse.md

@ -28,7 +28,7 @@ SharedLibraryCore.Dtos.Meta.Responses.BaseMetaResponse --> SharedLibraryCore.Dto
### Inheritance
- [
`BaseMetaResponse`
](./sharedlibrarycoredtosmetaresponses-BaseMetaResponse)
](./BaseMetaResponse.md)
### Constructors
#### PermissionLevelChangedResponse

2
CodeDocumentation/SharedLibraryCore/sharedlibrarycoredtosmetaresponses-ReceivedPenaltyResponse.md → CodeDocumentation/SharedLibraryCore/dtos/meta/responses/ReceivedPenaltyResponse.md

@ -35,7 +35,7 @@ SharedLibraryCore.Dtos.Meta.Responses.BaseMetaResponse --> SharedLibraryCore.Dto
### Inheritance
- [
`BaseMetaResponse`
](./sharedlibrarycoredtosmetaresponses-BaseMetaResponse)
](./BaseMetaResponse.md)
### Constructors
#### ReceivedPenaltyResponse

5
CodeDocumentation/SharedLibraryCore/sharedlibrarycoredtosmetaresponses-UpdatedAliasResponse.md → CodeDocumentation/SharedLibraryCore/dtos/meta/responses/UpdatedAliasResponse.md

@ -31,16 +31,18 @@ SharedLibraryCore.Dtos.Meta.Responses.BaseMetaResponse --> SharedLibraryCore.Dto
### Inheritance
- [
`BaseMetaResponse`
](./sharedlibrarycoredtosmetaresponses-BaseMetaResponse)
](./BaseMetaResponse.md)
### Constructors
#### UpdatedAliasResponse
[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Dtos/Meta/Responses/UpdatedAliasResponse.cs#L6)
```csharp
public UpdatedAliasResponse()
```
### Methods
#### Equals
[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Dtos/Meta/Responses/UpdatedAliasResponse.cs#L9)
```csharp
public override bool Equals(object obj)
```
@ -50,6 +52,7 @@ public override bool Equals(object obj)
| `object` | obj | |
#### GetHashCode
[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Dtos/Meta/Responses/UpdatedAliasResponse.cs#L19)
```csharp
public override int GetHashCode()
```

Some files were not shown because too many files have changed in this diff Show More