Add SharedLibraryCore code documentation

RaidMax 2023-05-20 20:51:00 -05:00
parent b08de5b651
commit a0d240460b
256 changed files with 18307 additions and 0 deletions

@ -0,0 +1,102 @@
# BaseController `Public class`
## Diagram
```mermaid
flowchart LR
classDef interfaceStyle stroke-dasharray: 5 5;
classDef abstractStyle stroke-width:4px
subgraph SharedLibraryCore
SharedLibraryCore.BaseController[[BaseController]]
end
subgraph Microsoft.AspNetCore.Mvc
Microsoft.AspNetCore.Mvc.Controller[[Controller]]
end
Microsoft.AspNetCore.Mvc.Controller --> SharedLibraryCore.BaseController
```
## Members
### Properties
#### Protected properties
| Type | Name | Methods |
| --- | --- | --- |
| [`ApplicationConfiguration`](./sharedlibrarycoreconfiguration-ApplicationConfiguration) | [`AppConfig`](#appconfig) | `get` |
| `bool` | [`Authorized`](#authorized) | `get, set` |
| [`EFClient`](./sharedlibrarycoredatabasemodels-EFClient) | [`Client`](#client) | `get` |
| [`TranslationLookup`](./sharedlibrarycorelocalization-TranslationLookup) | [`Localization`](#localization) | `get` |
#### Public properties
| Type | Name | Methods |
| --- | --- | --- |
| [`IManager`](./sharedlibrarycoreinterfaces-IManager) | [`Manager`](#manager) | `get` |
### Methods
#### Protected methods
| Returns | Name |
| --- | --- |
| `Task` | [`SignInAsync`](#signinasync)(`ClaimsPrincipal` claimsPrinciple) |
#### Public methods
| Returns | Name |
| --- | --- |
| `void` | [`OnActionExecuting`](#onactionexecuting)(`ActionExecutingContext` context) |
## Details
### Inheritance
- `Controller`
### Constructors
#### BaseController
```csharp
public BaseController(IManager manager)
```
##### Arguments
| Type | Name | Description |
| --- | --- | --- |
| [`IManager`](./sharedlibrarycoreinterfaces-IManager) | manager | |
### Methods
#### SignInAsync
```csharp
protected async Task SignInAsync(ClaimsPrincipal claimsPrinciple)
```
##### Arguments
| Type | Name | Description |
| --- | --- | --- |
| `ClaimsPrincipal` | claimsPrinciple | |
#### OnActionExecuting
```csharp
public override async void OnActionExecuting(ActionExecutingContext context)
```
##### Arguments
| Type | Name | Description |
| --- | --- | --- |
| `ActionExecutingContext` | context | |
### Properties
#### Authorized
```csharp
protected bool Authorized { get; set; }
```
#### Localization
```csharp
protected TranslationLookup Localization { get; }
```
#### Client
```csharp
protected EFClient Client { get; }
```
#### AppConfig
```csharp
protected ApplicationConfiguration AppConfig { get; }
```
#### Manager
```csharp
public IManager Manager { get; }
```
*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc)

@ -0,0 +1,61 @@
# ColorCode `Public class`
## Diagram
```mermaid
flowchart LR
classDef interfaceStyle stroke-dasharray: 5 5;
classDef abstractStyle stroke-width:4px
subgraph SharedLibraryCore
SharedLibraryCore.ColorCode[[ColorCode]]
end
subgraph Microsoft.AspNetCore.Razor.TagHelpers
Microsoft.AspNetCore.Razor.TagHelpers.TagHelper[[TagHelper]]
end
Microsoft.AspNetCore.Razor.TagHelpers.TagHelper --> SharedLibraryCore.ColorCode
```
## Members
### Properties
#### Public properties
| Type | Name | Methods |
| --- | --- | --- |
| `string` | [`Value`](#value) | `get, set` |
### Methods
#### Public methods
| Returns | Name |
| --- | --- |
| `void` | [`Process`](#process)(`TagHelperContext` context, `TagHelperOutput` output) |
## Details
### Inheritance
- `TagHelper`
### Constructors
#### ColorCode
```csharp
public ColorCode(ApplicationConfiguration appConfig)
```
##### Arguments
| Type | Name | Description |
| --- | --- | --- |
| [`ApplicationConfiguration`](./sharedlibrarycoreconfiguration-ApplicationConfiguration) | appConfig | |
### Methods
#### Process
```csharp
public override void Process(TagHelperContext context, TagHelperOutput output)
```
##### Arguments
| Type | Name | Description |
| --- | --- | --- |
| `TagHelperContext` | context | |
| `TagHelperOutput` | output | |
### Properties
#### Value
```csharp
public string Value { get; set; }
```
*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc)

@ -0,0 +1,155 @@
# Command `Public class`
## Description
Abstract class for command
## Diagram
```mermaid
flowchart LR
classDef interfaceStyle stroke-dasharray: 5 5;
classDef abstractStyle stroke-width:4px
subgraph SharedLibraryCore
SharedLibraryCore.Command[[Command]]
class SharedLibraryCore.Command abstractStyle;
end
subgraph SharedLibraryCore.Interfaces
SharedLibraryCore.Interfaces.IManagerCommand[[IManagerCommand]]
class SharedLibraryCore.Interfaces.IManagerCommand interfaceStyle;
end
SharedLibraryCore.Interfaces.IManagerCommand --> SharedLibraryCore.Command
```
## Members
### Properties
#### Public properties
| Type | Name | Methods |
| --- | --- | --- |
| `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` |
| `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` |
| `Permission` | [`Permission`](#permission)<br>Minimum permission level to execute command | `get, protected set` |
| `int` | [`RequiredArgumentCount`](#requiredargumentcount)<br>Helper property to determine the number of required args | `get` |
| `bool` | [`RequiresTarget`](#requirestarget)<br>Indicates if the command requires a target to execute on | `get, protected set` |
| `Game``[]` | [`SupportedGames`](#supportedgames) | `get, protected set` |
| `string` | [`Syntax`](#syntax)<br>Helper property to provide the syntax of the command | `get` |
### Methods
#### Public methods
| Returns | Name |
| --- | --- |
| `Task` | [`ExecuteAsync`](#executeasync)([`GameEvent`](./sharedlibrarycore-GameEvent) gameEvent)<br>Executes the command |
## Details
### Summary
Abstract class for command
### Inheritance
- [
`IManagerCommand`
](./sharedlibrarycoreinterfaces-IManagerCommand)
### Constructors
#### Command
```csharp
public Command(CommandConfiguration config, ITranslationLookup layout)
```
##### Arguments
| Type | Name | Description |
| --- | --- | --- |
| [`CommandConfiguration`](./sharedlibrarycoreconfiguration-CommandConfiguration) | config | |
| [`ITranslationLookup`](./sharedlibrarycoreinterfaces-ITranslationLookup) | layout | |
### Methods
#### ExecuteAsync
```csharp
public abstract Task ExecuteAsync(GameEvent gameEvent)
```
##### Arguments
| Type | Name | Description |
| --- | --- | --- |
| [`GameEvent`](./sharedlibrarycore-GameEvent) | gameEvent | |
##### Summary
Executes the command
##### Returns
### Properties
#### RequiredArgumentCount
```csharp
public int RequiredArgumentCount { get; }
```
##### Summary
Helper property to determine the number of required args
#### Arguments
```csharp
public CommandArgument Arguments { get; protected set; }
```
##### Summary
Argument list for the command
#### Name
```csharp
public string Name { get; protected set; }
```
##### Summary
Specifies the name and string that triggers the command
#### Description
```csharp
public string Description { get; protected set; }
```
##### Summary
Specifies the command description
#### Syntax
```csharp
public virtual string Syntax { get; }
```
##### Summary
Helper property to provide the syntax of the command
#### Alias
```csharp
public string Alias { get; protected set; }
```
##### Summary
Alternate name for this command to be executed by
#### RequiresTarget
```csharp
public bool RequiresTarget { get; protected set; }
```
##### Summary
Indicates if the command requires a target to execute on
#### Permission
```csharp
public Permission Permission { get; protected set; }
```
##### Summary
Minimum permission level to execute command
#### SupportedGames
```csharp
public Game SupportedGames { get; protected set; }
```
#### AllowImpersonation
```csharp
public bool AllowImpersonation { get; set; }
```
##### Summary
indicates if this command allows impersonation (run as)
#### IsBroadcast
```csharp
public virtual bool IsBroadcast { get; set; }
```
*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc)

@ -0,0 +1,58 @@
# Dvar&lt;T&gt; `Public class`
## Diagram
```mermaid
flowchart LR
classDef interfaceStyle stroke-dasharray: 5 5;
classDef abstractStyle stroke-width:4px
subgraph SharedLibraryCore
SharedLibraryCore.Dvar_1[[Dvar< T >]]
end
```
## Members
### Properties
#### Public properties
| Type | Name | Methods |
| --- | --- | --- |
| `T` | [`DefaultValue`](#defaultvalue) | `get, set` |
| `string` | [`Domain`](#domain) | `get, set` |
| `T` | [`LatchedValue`](#latchedvalue) | `get, set` |
| `string` | [`Name`](#name) | `get, set` |
| `T` | [`Value`](#value) | `get, set` |
## Details
### Constructors
#### Dvar
```csharp
public Dvar()
```
### Properties
#### Name
```csharp
public string Name { get; set; }
```
#### Value
```csharp
public T Value { get; set; }
```
#### DefaultValue
```csharp
public T DefaultValue { get; set; }
```
#### LatchedValue
```csharp
public T LatchedValue { get; set; }
```
#### Domain
```csharp
public string Domain { get; set; }
```
*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc)

@ -0,0 +1,172 @@
# GameEvent `Public class`
## Diagram
```mermaid
flowchart LR
classDef interfaceStyle stroke-dasharray: 5 5;
classDef abstractStyle stroke-width:4px
subgraph SharedLibraryCore
SharedLibraryCore.GameEvent[[GameEvent]]
end
subgraph SharedLibraryCore.Events
SharedLibraryCore.Events.CoreEvent[[CoreEvent]]
class SharedLibraryCore.Events.CoreEvent abstractStyle;
end
SharedLibraryCore.Events.CoreEvent --> SharedLibraryCore.GameEvent
```
## Members
### Properties
#### Public properties
| Type | Name | Methods |
| --- | --- | --- |
| `object` | [`Extra`](#extra) | `get, set` |
| `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` |
| `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` |
| `List`&lt;`string`&gt; | [`Output`](#output) | `get, set` |
| `EventRequiredEntity` | [`RequiredEntity`](#requiredentity) | `get, set` |
| `string` | [`Subtype`](#subtype)<br>suptype of the event for more detailed classification | `get, set` |
| `DateTime` | [`Time`](#time) | `get, set` |
| `string` | [`TypeName`](#typename) | `get` |
### Methods
#### Protected methods
| Returns | Name |
| --- | --- |
| `void` | [`Finalize`](#finalize)() |
#### Public methods
| Returns | Name |
| --- | --- |
| `void` | [`Complete`](#complete)() |
| `Task`&lt;[`GameEvent`](sharedlibrarycore-GameEvent)&gt; | [`WaitAsync`](#waitasync-12)(`...`) |
## Details
### Inheritance
- [
`CoreEvent`
](./sharedlibrarycoreevents-CoreEvent)
### Nested types
#### Enums
- `EventFailReason`
- `EventRequiredEntity`
- `EventSource`
- `EventType`
### Constructors
#### GameEvent
```csharp
public GameEvent()
```
### Methods
#### Finalize
```csharp
protected override void Finalize()
```
#### Complete
```csharp
public void Complete()
```
#### WaitAsync [1/2]
```csharp
public async Task<GameEvent> WaitAsync()
```
#### WaitAsync [2/2]
```csharp
public async Task<GameEvent> WaitAsync(TimeSpan timeSpan, CancellationToken token)
```
##### Arguments
| Type | Name | Description |
| --- | --- | --- |
| `TimeSpan` | timeSpan | |
| `CancellationToken` | token | |
##### Summary
asynchronously wait for GameEvent to be processed
##### Returns
waitable task
### Properties
#### TypeName
```csharp
public string TypeName { get; }
```
#### Subtype
```csharp
public string Subtype { get; set; }
```
##### Summary
suptype of the event for more detailed classification
#### RequiredEntity
```csharp
public EventRequiredEntity RequiredEntity { get; set; }
```
#### GameTime
```csharp
public Nullable<long> GameTime { get; set; }
```
##### Summary
Specifies the game time offset as printed in the log
#### ImpersonationOrigin
```csharp
public EFClient ImpersonationOrigin { get; set; }
```
#### IsRemote
```csharp
public bool IsRemote { get; set; }
```
#### Extra
```csharp
public object Extra { get; set; }
```
#### Time
```csharp
public DateTime Time { get; set; }
```
#### IncrementalId
```csharp
public long IncrementalId { get; }
```
#### FailReason
```csharp
public EventFailReason FailReason { get; set; }
```
#### Failed
```csharp
public bool Failed { get; }
```
#### Output
```csharp
public List<string> Output { get; set; }
```
#### IsBlocking
```csharp
public bool IsBlocking { get; set; }
```
##### Summary
Indicates if the event should block until it is complete
*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc)

@ -0,0 +1,39 @@
# Gametype `Public class`
## Diagram
```mermaid
flowchart LR
classDef interfaceStyle stroke-dasharray: 5 5;
classDef abstractStyle stroke-width:4px
subgraph SharedLibraryCore
SharedLibraryCore.Gametype[[Gametype]]
end
```
## Members
### Properties
#### Public properties
| Type | Name | Methods |
| --- | --- | --- |
| `string` | [`Alias`](#alias) | `get, set` |
| `string` | [`Name`](#name) | `get, set` |
## Details
### Constructors
#### Gametype
```csharp
public Gametype()
```
### Properties
#### Name
```csharp
public string Name { get; set; }
```
#### Alias
```csharp
public string Alias { get; set; }
```
*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc)

@ -0,0 +1,51 @@
# Map `Public class`
## Diagram
```mermaid
flowchart LR
classDef interfaceStyle stroke-dasharray: 5 5;
classDef abstractStyle stroke-width:4px
subgraph SharedLibraryCore
SharedLibraryCore.Map[[Map]]
end
```
## Members
### Properties
#### Public properties
| Type | Name | Methods |
| --- | --- | --- |
| `string` | [`Alias`](#alias) | `get, set` |
| `string` | [`Name`](#name) | `get, set` |
### Methods
#### Public methods
| Returns | Name |
| --- | --- |
| `string` | [`ToString`](#tostring)() |
## Details
### Constructors
#### Map
```csharp
public Map()
```
### Methods
#### ToString
```csharp
public override string ToString()
```
### Properties
#### Name
```csharp
public string Name { get; set; }
```
#### Alias
```csharp
public string Alias { get; set; }
```
*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc)

@ -0,0 +1,672 @@
# Server `Public class`
## Diagram
```mermaid
flowchart LR
classDef interfaceStyle stroke-dasharray: 5 5;
classDef abstractStyle stroke-width:4px
subgraph SharedLibraryCore
SharedLibraryCore.Server[[Server]]
class SharedLibraryCore.Server abstractStyle;
end
subgraph SharedLibraryCore.Interfaces
SharedLibraryCore.Interfaces.IGameServer[[IGameServer]]
class SharedLibraryCore.Interfaces.IGameServer interfaceStyle;
end
SharedLibraryCore.Interfaces.IGameServer --> SharedLibraryCore.Server
```
## Members
### Properties
#### Public properties
| Type | Name | Methods |
| --- | --- | --- |
| `List`&lt;[`ChatInfo`](./sharedlibrarycoredtos-ChatInfo)&gt; | [`ChatHistory`](#chathistory) | `get, protected set` |
| [`ClientHistoryInfo`](./sharedlibrarycoredtos-ClientHistoryInfo) | [`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` |
| `bool` | [`CustomCallback`](#customcallback) | `get, protected set` |
| `long` | [`EndPoint`](#endpoint) | `get` |
| [`IEventParser`](./sharedlibrarycoreinterfaces-IEventParser) | [`EventParser`](#eventparser) | `get, set` |
| `SemaphoreSlim` | [`EventProcessing`](#eventprocessing) | `get` |
| `Game` | [`GameCode`](#gamecode) | `get` |
| `Game` | [`GameName`](#gamename) | `get, set` |
| `string` | [`GamePassword`](#gamepassword) | `get, protected set` |
| `string` | [`Gametype`](#gametype) | `get, set` |
| `string` | [`GametypeName`](#gametypename) | `get` |
| `string` | [`Hostname`](#hostname) | `get, protected set` |
| `string` | [`IP`](#ip)<br>this is actually the listen address now | `get, protected set` |
| `string` | [`Id`](#id) | `get` |
| `bool` | [`IsInitialized`](#isinitialized) | `get, set` |
| `bool` | [`IsLegacyGameIntegrationEnabled`](#islegacygameintegrationenabled) | `get` |
| `long` | [`LegacyDatabaseId`](#legacydatabaseid) | `get` |
| `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` |
| `Nullable`&lt;`DateTime`&gt; | [`MatchEndTime`](#matchendtime) | `get, protected set` |
| `Nullable`&lt;`DateTime`&gt; | [`MatchStartTime`](#matchstarttime) | `get, protected set` |
| `int` | [`MaxClients`](#maxclients) | `get, protected set` |
| `string` | [`Password`](#password) | `get` |
| `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` |
| `IPEndPoint` | [`ResolvedIpEndPoint`](#resolvedipendpoint) | `get, protected set` |
| `bool` | [`RestartRequested`](#restartrequested) | `get, set` |
| [`ServerConfiguration`](./sharedlibrarycoreconfiguration-ServerConfiguration) | [`ServerConfig`](#serverconfig) | `get` |
| `string` | [`ServerName`](#servername) | `get` |
| `bool` | [`Throttled`](#throttled) | `get, protected set` |
| `string` | [`Version`](#version) | `get, protected set` |
| `string` | [`Website`](#website) | `get, protected set` |
| `string` | [`WorkingDirectory`](#workingdirectory) | `get, protected set` |
### Methods
#### 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`&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) |
| `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;`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 |
| `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) |
#### 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; | [`ScriptLoaded`](#scriptloaded)() |
| `Task` | [`Tell`](#tell)(`string` message, [`EFClient`](./sharedlibrarycoredatabasemodels-EFClient) targetClient)<br>Send a message to a particular players |
## Details
### Inheritance
- [
`IGameServer`
](./sharedlibrarycoreinterfaces-IGameServer)
### Nested types
#### Enums
- `Game`
### Constructors
#### Server
```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 | |
| `IServiceProvider` | serviceProvider | |
### Methods
#### Kick [1/2]
```csharp
public abstract Task Kick(string reason, EFClient target, EFClient origin, EFPenalty originalPenalty)
```
##### Arguments
| Type | Name | Description |
| --- | --- | --- |
| `string` | reason | |
| [`EFClient`](./sharedlibrarycoredatabasemodels-EFClient) | target | |
| [`EFClient`](./sharedlibrarycoredatabasemodels-EFClient) | origin | |
| `EFPenalty` | originalPenalty | |
#### ExecuteCommandAsync
```csharp
public abstract Task<string> ExecuteCommandAsync(string command, CancellationToken token)
```
##### Arguments
| Type | Name | Description |
| --- | --- | --- |
| `string` | command | |
| `CancellationToken` | token | |
#### SetDvarAsync
```csharp
public abstract Task SetDvarAsync(string name, object value, CancellationToken token)
```
##### Arguments
| Type | Name | Description |
| --- | --- | --- |
| `string` | name | |
| `object` | value | |
| `CancellationToken` | token | |
#### GetClientsAsList
```csharp
public List<EFClient> GetClientsAsList()
```
##### Summary
Returns list of all current players
##### Returns
#### OnClientConnected
```csharp
public abstract Task<EFClient> OnClientConnected(EFClient P)
```
##### Arguments
| Type | Name | Description |
| --- | --- | --- |
| [`EFClient`](./sharedlibrarycoredatabasemodels-EFClient) | P | EFClient pulled from memory reading |
##### Summary
Add a player to the server's player list
##### Returns
True if player added successfully, false otherwise
#### OnClientDisconnected
```csharp
public abstract Task OnClientDisconnected(EFClient client)
```
##### Arguments
| Type | Name | Description |
| --- | --- | --- |
| [`EFClient`](./sharedlibrarycoredatabasemodels-EFClient) | client | |
##### Summary
Remove player by client number
##### Returns
true if removal succeeded, false otherwise
#### GetClientByName
```csharp
public List<EFClient> GetClientByName(string pName)
```
##### Arguments
| Type | Name | Description |
| --- | --- | --- |
| `string` | pName | EFClient name to search for |
##### Summary
Get a player by name
todo: make this an extension
##### Returns
Matching player if found
#### ProcessUpdatesAsync
```csharp
public virtual Task<bool> ProcessUpdatesAsync(CancellationToken token)
```
##### Arguments
| Type | Name | Description |
| --- | --- | --- |
| `CancellationToken` | token | |
#### ProcessEvent
```csharp
protected abstract Task<bool> ProcessEvent(GameEvent E)
```
##### Arguments
| Type | Name | Description |
| --- | --- | --- |
| [`GameEvent`](./sharedlibrarycore-GameEvent) | E | Event |
##### Summary
Process any server event
##### Returns
True on sucess
#### ExecuteEvent
```csharp
public abstract Task ExecuteEvent(GameEvent E)
```
##### Arguments
| Type | Name | Description |
| --- | --- | --- |
| [`GameEvent`](./sharedlibrarycore-GameEvent) | E | |
#### Broadcast [1/2]
```csharp
public GameEvent Broadcast(string message, EFClient sender)
```
##### Arguments
| Type | Name | Description |
| --- | --- | --- |
| `string` | message | Message to be sent to all players |
| [`EFClient`](./sharedlibrarycoredatabasemodels-EFClient) | sender | Client that initiated the broadcast |
##### Summary
Send a message to all players
#### Broadcast [2/2]
```csharp
public void Broadcast(IEnumerable<string> messages, EFClient sender)
```
##### Arguments
| Type | Name | Description |
| --- | --- | --- |
| `IEnumerable`&lt;`string`&gt; | messages | |
| [`EFClient`](./sharedlibrarycoredatabasemodels-EFClient) | sender | |
#### BroadcastAsync
```csharp
public async Task BroadcastAsync(IEnumerable<string> messages, EFClient sender, CancellationToken token)
```
##### Arguments
| Type | Name | Description |
| --- | --- | --- |
| `IEnumerable`&lt;`string`&gt; | messages | |
| [`EFClient`](./sharedlibrarycoredatabasemodels-EFClient) | sender | |
| `CancellationToken` | token | |
#### Tell
```csharp
protected async Task Tell(string message, EFClient targetClient)
```
##### Arguments
| Type | Name | Description |
| --- | --- | --- |
| `string` | message | Message to send |
| [`EFClient`](./sharedlibrarycoredatabasemodels-EFClient) | targetClient | EFClient to send message to |
##### Summary
Send a message to a particular players
#### ToAdmins
```csharp
public void ToAdmins(string message)
```
##### Arguments
| Type | Name | Description |
| --- | --- | --- |
| `string` | message | Message to send out |
##### Summary
Send a message to all admins on the server
#### Kick [2/2]
```csharp
public Task Kick(string reason, EFClient target, EFClient origin)
```
##### Arguments
| Type | Name | Description |
| --- | --- | --- |
| `string` | reason | Reason for kicking |
| [`EFClient`](./sharedlibrarycoredatabasemodels-EFClient) | target | EFClient to kick |
| [`EFClient`](./sharedlibrarycoredatabasemodels-EFClient) | origin | Client initating the kick |
##### Summary
Kick a player from the server
#### TempBan
```csharp
public abstract Task TempBan(string reason, TimeSpan length, EFClient target, EFClient origin)
```
##### Arguments
| Type | Name | Description |
| --- | --- | --- |
| `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 |
##### Summary
Temporarily ban a player ( default 1 hour ) from the server
#### Ban
```csharp
public abstract Task Ban(string reason, EFClient target, EFClient origin, bool isEvade)
```
##### Arguments
| 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 |
| `bool` | isEvade | obsolete |
##### Summary
Perm ban a player from the server
#### Warn
```csharp
public abstract Task Warn(string reason, EFClient target, EFClient origin)
```
##### Arguments
| Type | Name | Description |
| --- | --- | --- |
| `string` | reason | |
| [`EFClient`](./sharedlibrarycoredatabasemodels-EFClient) | target | |
| [`EFClient`](./sharedlibrarycoredatabasemodels-EFClient) | origin | |
#### Unban
```csharp
public abstract Task Unban(string reason, EFClient targetClient, EFClient originClient)
```
##### Arguments
| Type | Name | Description |
| --- | --- | --- |
| `string` | reason | reason for unban |
| [`EFClient`](./sharedlibrarycoredatabasemodels-EFClient) | targetClient | client being unbanned |
| [`EFClient`](./sharedlibrarycoredatabasemodels-EFClient) | originClient | client performing the unban |
##### Summary
Unban a player by npID / GUID
##### Returns
#### LoadMap
```csharp
public async Task LoadMap(string mapName)
```
##### Arguments
| Type | Name | Description |
| --- | --- | --- |
| `string` | mapName | Non-localized map name |
##### Summary
Change the current server map
#### InitializeTokens
```csharp
public abstract void InitializeTokens()
```
##### Summary
Initalize the macro variables
#### InitializeAutoMessages
```csharp
protected void InitializeAutoMessages()
```
##### Summary
Initialize the messages to be broadcasted
#### ToString
```csharp
public override string ToString()
```
#### ScriptLoaded
```csharp
protected async Task<bool> ScriptLoaded()
```
#### GetIdForServer
```csharp
public abstract Task<long> GetIdForServer(Server server)
```
##### Arguments
| Type | Name | Description |
| --- | --- | --- |
| [`Server`](sharedlibrarycore-Server) | server | |
#### GetClientByNumber
```csharp
public EFClient GetClientByNumber(int clientNumber)
```
##### Arguments
| Type | Name | Description |
| --- | --- | --- |
| `int` | clientNumber | |
### Properties
#### EndPoint
```csharp
public long EndPoint { get; }
```
#### LegacyDatabaseId
```csharp
public abstract long LegacyDatabaseId { get; }
```
#### Id
```csharp
public virtual string Id { get; }
```
#### Manager
```csharp
public IManager Manager { get; protected set; }
```
#### Logger
```csharp
public ILogger Logger { get; }
```
#### ServerConfig
```csharp
public ServerConfiguration ServerConfig { get; }
```
#### Maps
```csharp
public List<Map> Maps { get; protected set; }
```
#### Reports
```csharp
public List<Report> Reports { get; set; }
```
#### ChatHistory
```csharp
public List<ChatInfo> ChatHistory { get; protected set; }
```
#### ClientHistory
```csharp
public ClientHistoryInfo ClientHistory { get; }
```
#### GameName
```csharp
public Game GameName { get; set; }
```
#### GameCode
```csharp
public virtual Game GameCode { get; }
```
#### MatchEndTime
```csharp
public Nullable<DateTime> MatchEndTime { get; protected set; }
```
#### MatchStartTime
```csharp
public Nullable<DateTime> MatchStartTime { get; protected set; }
```
#### Hostname
```csharp
public string Hostname { get; protected set; }
```
#### ServerName
```csharp
public virtual string ServerName { get; }
```
#### Website
```csharp
public string Website { get; protected set; }
```
#### Gametype
```csharp
public string Gametype { get; set; }
```
#### GametypeName
```csharp
public string GametypeName { get; }
```
#### GamePassword
```csharp
public string GamePassword { get; protected set; }
```
#### PrivateClientSlots
```csharp
public int PrivateClientSlots { get; protected set; }
```
#### CurrentMap
```csharp
public Map CurrentMap { get; set; }
```
#### Map
```csharp
public virtual Map Map { get; }
```
#### ClientNum
```csharp
public int ClientNum { get; }
```
#### MaxClients
```csharp
public int MaxClients { get; protected set; }
```
#### Clients
```csharp
public List<EFClient> Clients { get; protected set; }
```
#### ConnectedClients
```csharp
public virtual IReadOnlyList<EFClient> ConnectedClients { get; }
```
#### Password
```csharp
public string Password { get; }
```
#### Throttled
```csharp
public bool Throttled { get; protected set; }
```
#### CustomCallback
```csharp
public bool CustomCallback { get; protected set; }
```
#### IsLegacyGameIntegrationEnabled
```csharp
public virtual bool IsLegacyGameIntegrationEnabled { get; }
```
#### WorkingDirectory
```csharp
public string WorkingDirectory { get; protected set; }
```
#### RemoteConnection
```csharp
public IRConConnection RemoteConnection { get; protected set; }
```
#### RconParser
```csharp
public IRConParser RconParser { get; set; }
```
#### EventParser
```csharp
public IEventParser EventParser { get; set; }
```
#### LogPath
```csharp
public string LogPath { get; protected set; }
```
#### RestartRequested
```csharp
public bool RestartRequested { get; set; }
```
#### EventProcessing
```csharp
public SemaphoreSlim EventProcessing { get; }
```
#### IP
```csharp
public string IP { get; protected set; }
```
##### Summary
this is actually the listen address now
#### ListenAddress
```csharp
public virtual string ListenAddress { get; }
```
#### ResolvedIpEndPoint
```csharp
public IPEndPoint ResolvedIpEndPoint { get; protected set; }
```
#### Version
```csharp
public string Version { get; protected set; }
```
#### IsInitialized
```csharp
public bool IsInitialized { get; set; }
```
#### Port
```csharp
public int Port { get; protected set; }
```
#### ListenPort
```csharp
public virtual int ListenPort { get; }
```
#### PerformanceBucket
```csharp
public string PerformanceBucket { get; init; }
```
*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc)

File diff suppressed because it is too large Load Diff

@ -0,0 +1,27 @@
# Alert `Public class`
## Diagram
```mermaid
flowchart LR
classDef interfaceStyle stroke-dasharray: 5 5;
classDef abstractStyle stroke-width:4px
subgraph SharedLibraryCore.Alerts
SharedLibraryCore.Alerts.Alert[[Alert]]
end
```
## Details
### Nested types
#### Enums
- `AlertCategory`
#### Classes
- `AlertState`
### Constructors
#### Alert
```csharp
public Alert()
```
*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc)

@ -0,0 +1,27 @@
# AlertCategory `Public enum`
## Diagram
```mermaid
flowchart LR
classDef interfaceStyle stroke-dasharray: 5 5;
classDef abstractStyle stroke-width:4px
subgraph SharedLibraryCore.Alerts.Alert
SharedLibraryCore.Alerts.Alert.AlertCategory[[AlertCategory]]
end
```
## Details
### Fields
#### Information
#### Warning
#### Error
#### Message
*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc)

@ -0,0 +1,117 @@
# AlertState `Public class`
## Diagram
```mermaid
flowchart LR
classDef interfaceStyle stroke-dasharray: 5 5;
classDef abstractStyle stroke-width:4px
subgraph SharedLibraryCore.Alerts.Alert
SharedLibraryCore.Alerts.Alert.AlertState[[AlertState]]
end
```
## Members
### Properties
#### Public properties
| Type | Name | Methods |
| --- | --- | --- |
| `Guid` | [`AlertId`](#alertid) | `get` |
| `AlertCategory` | [`Category`](#category) | `get, set` |
| `Nullable`&lt;`bool`&gt; | [`Consumed`](#consumed) | `get, set` |
| `Nullable`&lt;`bool`&gt; | [`Delivered`](#delivered) | `get, set` |
| `Nullable`&lt;`DateTime`&gt; | [`ExpiresAt`](#expiresat) | `get, set` |
| `string` | [`Message`](#message) | `get, set` |
| `Nullable`&lt;`Permission`&gt; | [`MinimumPermission`](#minimumpermission) | `get, set` |
| `DateTime` | [`OccuredAt`](#occuredat) | `get, set` |
| `Nullable`&lt;`int`&gt; | [`RecipientId`](#recipientid) | `get, set` |
| `Nullable`&lt;`int`&gt; | [`ReferenceId`](#referenceid) | `get, set` |
| `string` | [`Source`](#source) | `get, set` |
| `Nullable`&lt;`int`&gt; | [`SourceId`](#sourceid) | `get, set` |
| `string` | [`Type`](#type) | `get, set` |
### Methods
#### Public Static methods
| Returns | Name |
| --- | --- |
| `AlertState` | [`Build`](#build)() |
## Details
### Constructors
#### AlertState
```csharp
public AlertState()
```
### Methods
#### Build
```csharp
public static AlertState Build()
```
### Properties
#### AlertId
```csharp
public Guid AlertId { get; }
```
#### Category
```csharp
public AlertCategory Category { get; set; }
```
#### OccuredAt
```csharp
public DateTime OccuredAt { get; set; }
```
#### ExpiresAt
```csharp
public Nullable<DateTime> ExpiresAt { get; set; }
```
#### Message
```csharp
public string Message { get; set; }
```
#### Source
```csharp
public string Source { get; set; }
```
#### RecipientId
```csharp
public Nullable<int> RecipientId { get; set; }
```
#### SourceId
```csharp
public Nullable<int> SourceId { get; set; }
```
#### ReferenceId
```csharp
public Nullable<int> ReferenceId { get; set; }
```
#### Delivered
```csharp
public Nullable<bool> Delivered { get; set; }
```
#### Consumed
```csharp
public Nullable<bool> Consumed { get; set; }
```
#### MinimumPermission
```csharp
public Nullable<Permission> MinimumPermission { get; set; }
```
#### Type
```csharp
public string Type { get; set; }
```
*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc)

@ -0,0 +1,59 @@
# BanCommand `Public class`
## Description
Permanently bans a client
## Diagram
```mermaid
flowchart LR
classDef interfaceStyle stroke-dasharray: 5 5;
classDef abstractStyle stroke-width:4px
subgraph SharedLibraryCore.Commands
SharedLibraryCore.Commands.BanCommand[[BanCommand]]
end
subgraph SharedLibraryCore
SharedLibraryCore.Command[[Command]]
class SharedLibraryCore.Command abstractStyle;
end
SharedLibraryCore.Command --> SharedLibraryCore.Commands.BanCommand
```
## Members
### Methods
#### Public methods
| Returns | Name |
| --- | --- |
| `Task` | [`ExecuteAsync`](#executeasync)([`GameEvent`](./sharedlibrarycore-GameEvent) gameEvent) |
## Details
### Summary
Permanently bans a client
### Inheritance
- [
`Command`
](./sharedlibrarycore-Command)
### Constructors
#### BanCommand
```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 | |
### Methods
#### ExecuteAsync
```csharp
public override async Task ExecuteAsync(GameEvent gameEvent)
```
##### Arguments
| Type | Name | Description |
| --- | --- | --- |
| [`GameEvent`](./sharedlibrarycore-GameEvent) | gameEvent | |
*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc)

@ -0,0 +1,49 @@
# CommandArgument `Public class`
## Description
Holds information about command args
## Diagram
```mermaid
flowchart LR
classDef interfaceStyle stroke-dasharray: 5 5;
classDef abstractStyle stroke-width:4px
subgraph SharedLibraryCore.Commands
SharedLibraryCore.Commands.CommandArgument[[CommandArgument]]
end
```
## Members
### Properties
#### Public properties
| Type | Name | Methods |
| --- | --- | --- |
| `string` | [`Name`](#name)<br>Name of the argument | `get, set` |
| `bool` | [`Required`](#required)<br>Indicates if the argument is required | `get, set` |
## Details
### Summary
Holds information about command args
### Constructors
#### CommandArgument
```csharp
public CommandArgument()
```
### Properties
#### Name
```csharp
public string Name { get; set; }
```
##### Summary
Name of the argument
#### Required
```csharp
public bool Required { get; set; }
```
##### Summary
Indicates if the argument is required
*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc)

@ -0,0 +1,41 @@
# CommandExtensions `Public class`
## Diagram
```mermaid
flowchart LR
classDef interfaceStyle stroke-dasharray: 5 5;
classDef abstractStyle stroke-width:4px
subgraph SharedLibraryCore.Commands
SharedLibraryCore.Commands.CommandExtensions[[CommandExtensions]]
end
```
## Members
### Methods
#### Public Static methods
| Returns | Name |
| --- | --- |
| `bool` | [`CanPerformActionOnTarget`](#canperformactionontarget)([`GameEvent`](./sharedlibrarycore-GameEvent) gameEvent) |
| `bool` | [`IsTargetingSelf`](#istargetingself)([`GameEvent`](./sharedlibrarycore-GameEvent) gameEvent) |
## Details
### Methods
#### IsTargetingSelf
```csharp
public static bool IsTargetingSelf(GameEvent gameEvent)
```
##### Arguments
| Type | Name | Description |
| --- | --- | --- |
| [`GameEvent`](./sharedlibrarycore-GameEvent) | gameEvent | |
#### CanPerformActionOnTarget
```csharp
public static bool CanPerformActionOnTarget(GameEvent gameEvent)
```
##### Arguments
| Type | Name | Description |
| --- | --- | --- |
| [`GameEvent`](./sharedlibrarycore-GameEvent) | gameEvent | |
*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc)

@ -0,0 +1,39 @@
# CommandProcessing `Public class`
## Diagram
```mermaid
flowchart LR
classDef interfaceStyle stroke-dasharray: 5 5;
classDef abstractStyle stroke-width:4px
subgraph SharedLibraryCore.Commands
SharedLibraryCore.Commands.CommandProcessing[[CommandProcessing]]
end
```
## Members
### Methods
#### 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) |
## Details
### Constructors
#### CommandProcessing
```csharp
public CommandProcessing()
```
### Methods
#### ValidateCommand
```csharp
public static async Task<Command> ValidateCommand(GameEvent gameEvent, ApplicationConfiguration appConfig, CommandConfiguration commandConfig)
```
##### Arguments
| Type | Name | Description |
| --- | --- | --- |
| [`GameEvent`](./sharedlibrarycore-GameEvent) | gameEvent | |
| [`ApplicationConfiguration`](./sharedlibrarycoreconfiguration-ApplicationConfiguration) | appConfig | |
| [`CommandConfiguration`](./sharedlibrarycoreconfiguration-CommandConfiguration) | commandConfig | |
*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc)

@ -0,0 +1,58 @@
# ExecuteRConCommand `Public class`
## Description
Executes RCon command
## Diagram
```mermaid
flowchart LR
classDef interfaceStyle stroke-dasharray: 5 5;
classDef abstractStyle stroke-width:4px
subgraph SharedLibraryCore.Commands
SharedLibraryCore.Commands.ExecuteRConCommand[[ExecuteRConCommand]]
end
subgraph SharedLibraryCore
SharedLibraryCore.Command[[Command]]
class SharedLibraryCore.Command abstractStyle;
end
SharedLibraryCore.Command --> SharedLibraryCore.Commands.ExecuteRConCommand
```
## Members
### Methods
#### Public methods
| Returns | Name |
| --- | --- |
| `Task` | [`ExecuteAsync`](#executeasync)([`GameEvent`](./sharedlibrarycore-GameEvent) E) |
## Details
### Summary
Executes RCon command
### Inheritance
- [
`Command`
](./sharedlibrarycore-Command)
### Constructors
#### ExecuteRConCommand
```csharp
public ExecuteRConCommand(CommandConfiguration config, ITranslationLookup translationLookup)
```
##### Arguments
| Type | Name | Description |
| --- | --- | --- |
| [`CommandConfiguration`](./sharedlibrarycoreconfiguration-CommandConfiguration) | config | |
| [`ITranslationLookup`](./sharedlibrarycoreinterfaces-ITranslationLookup) | translationLookup | |
### Methods
#### ExecuteAsync
```csharp
public override async Task ExecuteAsync(GameEvent E)
```
##### Arguments
| Type | Name | Description |
| --- | --- | --- |
| [`GameEvent`](./sharedlibrarycore-GameEvent) | E | |
*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc)

@ -0,0 +1,58 @@
# FastRestartCommand `Public class`
## Description
Fast restarts the map
## Diagram
```mermaid
flowchart LR
classDef interfaceStyle stroke-dasharray: 5 5;
classDef abstractStyle stroke-width:4px
subgraph SharedLibraryCore.Commands
SharedLibraryCore.Commands.FastRestartCommand[[FastRestartCommand]]
end
subgraph SharedLibraryCore
SharedLibraryCore.Command[[Command]]
class SharedLibraryCore.Command abstractStyle;
end
SharedLibraryCore.Command --> SharedLibraryCore.Commands.FastRestartCommand
```
## Members
### Methods
#### Public methods
| Returns | Name |
| --- | --- |
| `Task` | [`ExecuteAsync`](#executeasync)([`GameEvent`](./sharedlibrarycore-GameEvent) E) |
## Details
### Summary
Fast restarts the map
### Inheritance
- [
`Command`
](./sharedlibrarycore-Command)
### Constructors
#### FastRestartCommand
```csharp
public FastRestartCommand(CommandConfiguration config, ITranslationLookup translationLookup)
```
##### Arguments
| Type | Name | Description |
| --- | --- | --- |
| [`CommandConfiguration`](./sharedlibrarycoreconfiguration-CommandConfiguration) | config | |
| [`ITranslationLookup`](./sharedlibrarycoreinterfaces-ITranslationLookup) | translationLookup | |
### Methods
#### ExecuteAsync
```csharp
public override async Task ExecuteAsync(GameEvent E)
```
##### Arguments
| Type | Name | Description |
| --- | --- | --- |
| [`GameEvent`](./sharedlibrarycore-GameEvent) | E | |
*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc)

@ -0,0 +1,58 @@
# FlagClientCommand `Public class`
## Description
Flag given client for specified reason
## Diagram
```mermaid
flowchart LR
classDef interfaceStyle stroke-dasharray: 5 5;
classDef abstractStyle stroke-width:4px
subgraph SharedLibraryCore.Commands
SharedLibraryCore.Commands.FlagClientCommand[[FlagClientCommand]]
end
subgraph SharedLibraryCore
SharedLibraryCore.Command[[Command]]
class SharedLibraryCore.Command abstractStyle;
end
SharedLibraryCore.Command --> SharedLibraryCore.Commands.FlagClientCommand
```
## Members
### Methods
#### Public methods
| Returns | Name |
| --- | --- |
| `Task` | [`ExecuteAsync`](#executeasync)([`GameEvent`](./sharedlibrarycore-GameEvent) E) |
## Details
### Summary
Flag given client for specified reason
### Inheritance
- [
`Command`
](./sharedlibrarycore-Command)
### Constructors
#### FlagClientCommand
```csharp
public FlagClientCommand(CommandConfiguration config, ITranslationLookup translationLookup)
```
##### Arguments
| Type | Name | Description |
| --- | --- | --- |
| [`CommandConfiguration`](./sharedlibrarycoreconfiguration-CommandConfiguration) | config | |
| [`ITranslationLookup`](./sharedlibrarycoreinterfaces-ITranslationLookup) | translationLookup | |
### Methods
#### ExecuteAsync
```csharp
public override async Task ExecuteAsync(GameEvent E)
```
##### Arguments
| Type | Name | Description |
| --- | --- | --- |
| [`GameEvent`](./sharedlibrarycore-GameEvent) | E | |
*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc)

@ -0,0 +1,58 @@
# GetClientPingCommand `Public class`
## Description
Gets the ping of a client
## Diagram
```mermaid
flowchart LR
classDef interfaceStyle stroke-dasharray: 5 5;
classDef abstractStyle stroke-width:4px
subgraph SharedLibraryCore.Commands
SharedLibraryCore.Commands.GetClientPingCommand[[GetClientPingCommand]]
end
subgraph SharedLibraryCore
SharedLibraryCore.Command[[Command]]
class SharedLibraryCore.Command abstractStyle;
end
SharedLibraryCore.Command --> SharedLibraryCore.Commands.GetClientPingCommand
```
## Members
### Methods
#### Public methods
| Returns | Name |
| --- | --- |
| `Task` | [`ExecuteAsync`](#executeasync)([`GameEvent`](./sharedlibrarycore-GameEvent) E) |
## Details
### Summary
Gets the ping of a client
### Inheritance
- [
`Command`
](./sharedlibrarycore-Command)
### Constructors
#### GetClientPingCommand
```csharp
public GetClientPingCommand(CommandConfiguration config, ITranslationLookup translationLookup)
```
##### Arguments
| Type | Name | Description |
| --- | --- | --- |
| [`CommandConfiguration`](./sharedlibrarycoreconfiguration-CommandConfiguration) | config | |
| [`ITranslationLookup`](./sharedlibrarycoreinterfaces-ITranslationLookup) | translationLookup | |
### Methods
#### ExecuteAsync
```csharp
public override Task ExecuteAsync(GameEvent E)
```
##### Arguments
| Type | Name | Description |
| --- | --- | --- |
| [`GameEvent`](./sharedlibrarycore-GameEvent) | E | |
*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc)

@ -0,0 +1,59 @@
# KickCommand `Public class`
## Description
Kicks client for given reason
## Diagram
```mermaid
flowchart LR
classDef interfaceStyle stroke-dasharray: 5 5;
classDef abstractStyle stroke-width:4px
subgraph SharedLibraryCore.Commands
SharedLibraryCore.Commands.KickCommand[[KickCommand]]
end
subgraph SharedLibraryCore
SharedLibraryCore.Command[[Command]]
class SharedLibraryCore.Command abstractStyle;
end
SharedLibraryCore.Command --> SharedLibraryCore.Commands.KickCommand
```
## Members
### Methods
#### Public methods
| Returns | Name |
| --- | --- |
| `Task` | [`ExecuteAsync`](#executeasync)([`GameEvent`](./sharedlibrarycore-GameEvent) gameEvent) |
## Details
### Summary
Kicks client for given reason
### Inheritance
- [
`Command`
](./sharedlibrarycore-Command)
### Constructors
#### KickCommand
```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 | |
### Methods
#### ExecuteAsync
```csharp
public override async Task ExecuteAsync(GameEvent gameEvent)
```
##### Arguments
| Type | Name | Description |
| --- | --- | --- |
| [`GameEvent`](./sharedlibrarycore-GameEvent) | gameEvent | |
*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc)

@ -0,0 +1,58 @@
# ListBanInfoCommand `Public class`
## Description
Lists ban information for given client
## Diagram
```mermaid
flowchart LR
classDef interfaceStyle stroke-dasharray: 5 5;
classDef abstractStyle stroke-width:4px
subgraph SharedLibraryCore.Commands
SharedLibraryCore.Commands.ListBanInfoCommand[[ListBanInfoCommand]]
end
subgraph SharedLibraryCore
SharedLibraryCore.Command[[Command]]
class SharedLibraryCore.Command abstractStyle;
end
SharedLibraryCore.Command --> SharedLibraryCore.Commands.ListBanInfoCommand
```
## Members
### Methods
#### Public methods
| Returns | Name |
| --- | --- |
| `Task` | [`ExecuteAsync`](#executeasync)([`GameEvent`](./sharedlibrarycore-GameEvent) E) |
## Details
### Summary
Lists ban information for given client
### Inheritance
- [
`Command`
](./sharedlibrarycore-Command)
### Constructors
#### ListBanInfoCommand
```csharp
public ListBanInfoCommand(CommandConfiguration config, ITranslationLookup translationLookup)
```
##### Arguments
| Type | Name | Description |
| --- | --- | --- |
| [`CommandConfiguration`](./sharedlibrarycoreconfiguration-CommandConfiguration) | config | |
| [`ITranslationLookup`](./sharedlibrarycoreinterfaces-ITranslationLookup) | translationLookup | |
### Methods
#### ExecuteAsync
```csharp
public override async Task ExecuteAsync(GameEvent E)
```
##### Arguments
| Type | Name | Description |
| --- | --- | --- |
| [`GameEvent`](./sharedlibrarycore-GameEvent) | E | |
*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc)

@ -0,0 +1,58 @@
# ListExternalIPCommand `Public class`
## Description
Lists external IP
## Diagram
```mermaid
flowchart LR
classDef interfaceStyle stroke-dasharray: 5 5;
classDef abstractStyle stroke-width:4px
subgraph SharedLibraryCore.Commands
SharedLibraryCore.Commands.ListExternalIPCommand[[ListExternalIPCommand]]
end
subgraph SharedLibraryCore
SharedLibraryCore.Command[[Command]]
class SharedLibraryCore.Command abstractStyle;
end
SharedLibraryCore.Command --> SharedLibraryCore.Commands.ListExternalIPCommand
```
## Members
### Methods
#### Public methods
| Returns | Name |
| --- | --- |
| `Task` | [`ExecuteAsync`](#executeasync)([`GameEvent`](./sharedlibrarycore-GameEvent) E) |
## Details
### Summary
Lists external IP
### Inheritance
- [
`Command`
](./sharedlibrarycore-Command)
### Constructors
#### ListExternalIPCommand
```csharp
public ListExternalIPCommand(CommandConfiguration config, ITranslationLookup translationLookup)
```
##### Arguments
| Type | Name | Description |
| --- | --- | --- |
| [`CommandConfiguration`](./sharedlibrarycoreconfiguration-CommandConfiguration) | config | |
| [`ITranslationLookup`](./sharedlibrarycoreinterfaces-ITranslationLookup) | translationLookup | |
### Methods
#### ExecuteAsync
```csharp
public override Task ExecuteAsync(GameEvent E)
```
##### Arguments
| Type | Name | Description |
| --- | --- | --- |
| [`GameEvent`](./sharedlibrarycore-GameEvent) | E | |
*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc)

@ -0,0 +1,58 @@
# ListRulesCommands `Public class`
## Description
Lists server and global rules
## Diagram
```mermaid
flowchart LR
classDef interfaceStyle stroke-dasharray: 5 5;
classDef abstractStyle stroke-width:4px
subgraph SharedLibraryCore.Commands
SharedLibraryCore.Commands.ListRulesCommands[[ListRulesCommands]]
end
subgraph SharedLibraryCore
SharedLibraryCore.Command[[Command]]
class SharedLibraryCore.Command abstractStyle;
end
SharedLibraryCore.Command --> SharedLibraryCore.Commands.ListRulesCommands
```
## Members
### Methods
#### Public methods
| Returns | Name |
| --- | --- |
| `Task` | [`ExecuteAsync`](#executeasync)([`GameEvent`](./sharedlibrarycore-GameEvent) gameEvent) |
## Details
### Summary
Lists server and global rules
### Inheritance
- [
`Command`
](./sharedlibrarycore-Command)
### Constructors
#### ListRulesCommands
```csharp
public ListRulesCommands(CommandConfiguration config, ITranslationLookup translationLookup)
```
##### Arguments
| Type | Name | Description |
| --- | --- | --- |
| [`CommandConfiguration`](./sharedlibrarycoreconfiguration-CommandConfiguration) | config | |
| [`ITranslationLookup`](./sharedlibrarycoreinterfaces-ITranslationLookup) | translationLookup | |
### Methods
#### ExecuteAsync
```csharp
public override async Task ExecuteAsync(GameEvent gameEvent)
```
##### Arguments
| Type | Name | Description |
| --- | --- | --- |
| [`GameEvent`](./sharedlibrarycore-GameEvent) | gameEvent | |
*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc)

@ -0,0 +1,58 @@
# LoadMapCommand `Public class`
## Description
Attempts to load the specified map
## Diagram
```mermaid
flowchart LR
classDef interfaceStyle stroke-dasharray: 5 5;
classDef abstractStyle stroke-width:4px
subgraph SharedLibraryCore.Commands
SharedLibraryCore.Commands.LoadMapCommand[[LoadMapCommand]]
end
subgraph SharedLibraryCore
SharedLibraryCore.Command[[Command]]
class SharedLibraryCore.Command abstractStyle;
end
SharedLibraryCore.Command --> SharedLibraryCore.Commands.LoadMapCommand
```
## Members
### Methods
#### Public methods
| Returns | Name |
| --- | --- |
| `Task` | [`ExecuteAsync`](#executeasync)([`GameEvent`](./sharedlibrarycore-GameEvent) E) |
## Details
### Summary
Attempts to load the specified map
### Inheritance
- [
`Command`
](./sharedlibrarycore-Command)
### Constructors
#### LoadMapCommand
```csharp
public LoadMapCommand(CommandConfiguration config, ITranslationLookup translationLookup)
```
##### Arguments
| Type | Name | Description |
| --- | --- | --- |
| [`CommandConfiguration`](./sharedlibrarycoreconfiguration-CommandConfiguration) | config | |
| [`ITranslationLookup`](./sharedlibrarycoreinterfaces-ITranslationLookup) | translationLookup | |
### Methods
#### ExecuteAsync
```csharp
public override async Task ExecuteAsync(GameEvent E)
```
##### Arguments
| Type | Name | Description |
| --- | --- | --- |
| [`GameEvent`](./sharedlibrarycore-GameEvent) | E | |
*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc)

@ -0,0 +1,58 @@
# MapRotateCommand `Public class`
## Description
Cycles to the next map in rotation
## Diagram
```mermaid
flowchart LR
classDef interfaceStyle stroke-dasharray: 5 5;
classDef abstractStyle stroke-width:4px
subgraph SharedLibraryCore.Commands
SharedLibraryCore.Commands.MapRotateCommand[[MapRotateCommand]]
end
subgraph SharedLibraryCore
SharedLibraryCore.Command[[Command]]
class SharedLibraryCore.Command abstractStyle;
end
SharedLibraryCore.Command --> SharedLibraryCore.Commands.MapRotateCommand
```
## Members
### Methods
#### Public methods
| Returns | Name |
| --- | --- |
| `Task` | [`ExecuteAsync`](#executeasync)([`GameEvent`](./sharedlibrarycore-GameEvent) E) |
## Details
### Summary
Cycles to the next map in rotation
### Inheritance
- [
`Command`
](./sharedlibrarycore-Command)
### Constructors
#### MapRotateCommand
```csharp
public MapRotateCommand(CommandConfiguration config, ITranslationLookup translationLookup)
```
##### Arguments
| Type | Name | Description |
| --- | --- | --- |
| [`CommandConfiguration`](./sharedlibrarycoreconfiguration-CommandConfiguration) | config | |
| [`ITranslationLookup`](./sharedlibrarycoreinterfaces-ITranslationLookup) | translationLookup | |
### Methods
#### ExecuteAsync
```csharp
public override async Task ExecuteAsync(GameEvent E)
```
##### Arguments
| Type | Name | Description |
| --- | --- | --- |
| [`GameEvent`](./sharedlibrarycore-GameEvent) | E | |
*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc)

@ -0,0 +1,58 @@
# MaskCommand `Public class`
## Description
Masks client from announcements and online admin list
## Diagram
```mermaid
flowchart LR
classDef interfaceStyle stroke-dasharray: 5 5;
classDef abstractStyle stroke-width:4px
subgraph SharedLibraryCore.Commands
SharedLibraryCore.Commands.MaskCommand[[MaskCommand]]
end
subgraph SharedLibraryCore
SharedLibraryCore.Command[[Command]]
class SharedLibraryCore.Command abstractStyle;
end
SharedLibraryCore.Command --> SharedLibraryCore.Commands.MaskCommand
```
## Members
### Methods
#### Public methods
| Returns | Name |
| --- | --- |
| `Task` | [`ExecuteAsync`](#executeasync)([`GameEvent`](./sharedlibrarycore-GameEvent) E) |
## Details
### Summary
Masks client from announcements and online admin list
### Inheritance
- [
`Command`
](./sharedlibrarycore-Command)
### Constructors
#### MaskCommand
```csharp
public MaskCommand(CommandConfiguration config, ITranslationLookup translationLookup)
```
##### Arguments
| Type | Name | Description |
| --- | --- | --- |
| [`CommandConfiguration`](./sharedlibrarycoreconfiguration-CommandConfiguration) | config | |
| [`ITranslationLookup`](./sharedlibrarycoreinterfaces-ITranslationLookup) | translationLookup | |
### Methods
#### ExecuteAsync
```csharp
public override async Task ExecuteAsync(GameEvent E)
```
##### Arguments
| Type | Name | Description |
| --- | --- | --- |
| [`GameEvent`](./sharedlibrarycore-GameEvent) | E | |
*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc)

@ -0,0 +1,58 @@
# MemoryUsageCommand `Public class`
## Description
Prints the amount of memory IW4MAdmin is using
## Diagram
```mermaid
flowchart LR
classDef interfaceStyle stroke-dasharray: 5 5;
classDef abstractStyle stroke-width:4px
subgraph SharedLibraryCore.Commands
SharedLibraryCore.Commands.MemoryUsageCommand[[MemoryUsageCommand]]
end
subgraph SharedLibraryCore
SharedLibraryCore.Command[[Command]]
class SharedLibraryCore.Command abstractStyle;
end
SharedLibraryCore.Command --> SharedLibraryCore.Commands.MemoryUsageCommand
```
## Members
### Methods
#### Public methods
| Returns | Name |
| --- | --- |
| `Task` | [`ExecuteAsync`](#executeasync)([`GameEvent`](./sharedlibrarycore-GameEvent) E) |
## Details
### Summary
Prints the amount of memory IW4MAdmin is using
### Inheritance
- [
`Command`
](./sharedlibrarycore-Command)
### Constructors
#### MemoryUsageCommand
```csharp
public MemoryUsageCommand(CommandConfiguration config, ITranslationLookup translationLookup)
```
##### Arguments
| Type | Name | Description |
| --- | --- | --- |
| [`CommandConfiguration`](./sharedlibrarycoreconfiguration-CommandConfiguration) | config | |
| [`ITranslationLookup`](./sharedlibrarycoreinterfaces-ITranslationLookup) | translationLookup | |
### Methods
#### ExecuteAsync
```csharp
public override Task ExecuteAsync(GameEvent E)
```
##### Arguments
| Type | Name | Description |
| --- | --- | --- |
| [`GameEvent`](./sharedlibrarycore-GameEvent) | E | |
*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc)

@ -0,0 +1,73 @@
# NextMapCommand `Public class`
## Description
Retrieves the next map in rotation
## Diagram
```mermaid
flowchart LR
classDef interfaceStyle stroke-dasharray: 5 5;
classDef abstractStyle stroke-width:4px
subgraph SharedLibraryCore.Commands
SharedLibraryCore.Commands.NextMapCommand[[NextMapCommand]]
end
subgraph SharedLibraryCore
SharedLibraryCore.Command[[Command]]
class SharedLibraryCore.Command abstractStyle;
end
SharedLibraryCore.Command --> SharedLibraryCore.Commands.NextMapCommand
```
## Members
### Methods
#### Public Static methods
| Returns | Name |
| --- | --- |
| `Task`&lt;`string`&gt; | [`GetNextMap`](#getnextmap)([`Server`](./sharedlibrarycore-Server) s, [`ITranslationLookup`](./sharedlibrarycoreinterfaces-ITranslationLookup) lookup) |
#### Public methods
| Returns | Name |
| --- | --- |
| `Task` | [`ExecuteAsync`](#executeasync)([`GameEvent`](./sharedlibrarycore-GameEvent) E) |
## Details
### Summary
Retrieves the next map in rotation
### Inheritance
- [
`Command`
](./sharedlibrarycore-Command)
### Constructors
#### NextMapCommand
```csharp
public NextMapCommand(CommandConfiguration config, ITranslationLookup translationLookup)
```
##### Arguments
| Type | Name | Description |
| --- | --- | --- |
| [`CommandConfiguration`](./sharedlibrarycoreconfiguration-CommandConfiguration) | config | |
| [`ITranslationLookup`](./sharedlibrarycoreinterfaces-ITranslationLookup) | translationLookup | |
### Methods
#### GetNextMap
```csharp
public static async Task<string> GetNextMap(Server s, ITranslationLookup lookup)
```
##### Arguments
| Type | Name | Description |
| --- | --- | --- |
| [`Server`](./sharedlibrarycore-Server) | s | |
| [`ITranslationLookup`](./sharedlibrarycoreinterfaces-ITranslationLookup) | lookup | |
#### ExecuteAsync
```csharp
public override async Task ExecuteAsync(GameEvent E)
```
##### Arguments
| Type | Name | Description |
| --- | --- | --- |
| [`GameEvent`](./sharedlibrarycore-GameEvent) | E | |
*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc)

@ -0,0 +1,58 @@
# OwnerCommand `Public class`
## Description
Claims ownership of the server
## Diagram
```mermaid
flowchart LR
classDef interfaceStyle stroke-dasharray: 5 5;
classDef abstractStyle stroke-width:4px
subgraph SharedLibraryCore.Commands
SharedLibraryCore.Commands.OwnerCommand[[OwnerCommand]]
end
subgraph SharedLibraryCore
SharedLibraryCore.Command[[Command]]
class SharedLibraryCore.Command abstractStyle;
end
SharedLibraryCore.Command --> SharedLibraryCore.Commands.OwnerCommand
```
## Members
### Methods
#### Public methods
| Returns | Name |
| --- | --- |
| `Task` | [`ExecuteAsync`](#executeasync)([`GameEvent`](./sharedlibrarycore-GameEvent) E) |
## Details
### Summary
Claims ownership of the server
### Inheritance
- [
`Command`
](./sharedlibrarycore-Command)
### Constructors
#### OwnerCommand
```csharp
public OwnerCommand(CommandConfiguration config, ITranslationLookup translationLookup)
```
##### Arguments
| Type | Name | Description |
| --- | --- | --- |
| [`CommandConfiguration`](./sharedlibrarycoreconfiguration-CommandConfiguration) | config | |
| [`ITranslationLookup`](./sharedlibrarycoreinterfaces-ITranslationLookup) | translationLookup | |
### Methods
#### ExecuteAsync
```csharp
public override async Task ExecuteAsync(GameEvent E)
```
##### Arguments
| Type | Name | Description |
| --- | --- | --- |
| [`GameEvent`](./sharedlibrarycore-GameEvent) | E | |
*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc)

@ -0,0 +1,52 @@
# PrivateMessageAdminsCommand `Public class`
## Diagram
```mermaid
flowchart LR
classDef interfaceStyle stroke-dasharray: 5 5;
classDef abstractStyle stroke-width:4px
subgraph SharedLibraryCore.Commands
SharedLibraryCore.Commands.PrivateMessageAdminsCommand[[PrivateMessageAdminsCommand]]
end
subgraph SharedLibraryCore
SharedLibraryCore.Command[[Command]]
class SharedLibraryCore.Command abstractStyle;
end
SharedLibraryCore.Command --> SharedLibraryCore.Commands.PrivateMessageAdminsCommand
```
## Members
### Methods
#### Public methods
| Returns | Name |
| --- | --- |
| `Task` | [`ExecuteAsync`](#executeasync)([`GameEvent`](./sharedlibrarycore-GameEvent) E) |
## Details
### Inheritance
- [
`Command`
](./sharedlibrarycore-Command)
### Constructors
#### PrivateMessageAdminsCommand
```csharp
public PrivateMessageAdminsCommand(CommandConfiguration config, ITranslationLookup lookup)
```
##### Arguments
| Type | Name | Description |
| --- | --- | --- |
| [`CommandConfiguration`](./sharedlibrarycoreconfiguration-CommandConfiguration) | config | |
| [`ITranslationLookup`](./sharedlibrarycoreinterfaces-ITranslationLookup) | lookup | |
### Methods
#### ExecuteAsync
```csharp
public override Task ExecuteAsync(GameEvent E)
```
##### Arguments
| Type | Name | Description |
| --- | --- | --- |
| [`GameEvent`](./sharedlibrarycore-GameEvent) | E | |
*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc)

@ -0,0 +1,59 @@
# PruneAdminsCommand `Public class`
## Description
Prunes inactive privileged clients
## Diagram
```mermaid
flowchart LR
classDef interfaceStyle stroke-dasharray: 5 5;
classDef abstractStyle stroke-width:4px
subgraph SharedLibraryCore.Commands
SharedLibraryCore.Commands.PruneAdminsCommand[[PruneAdminsCommand]]
end
subgraph SharedLibraryCore
SharedLibraryCore.Command[[Command]]
class SharedLibraryCore.Command abstractStyle;
end
SharedLibraryCore.Command --> SharedLibraryCore.Commands.PruneAdminsCommand
```
## Members
### Methods
#### Public methods
| Returns | Name |
| --- | --- |
| `Task` | [`ExecuteAsync`](#executeasync)([`GameEvent`](./sharedlibrarycore-GameEvent) E) |
## Details
### Summary
Prunes inactive privileged clients
### Inheritance
- [
`Command`
](./sharedlibrarycore-Command)
### Constructors
#### PruneAdminsCommand
```csharp
public PruneAdminsCommand(CommandConfiguration config, ITranslationLookup translationLookup, IDatabaseContextFactory contextFactory)
```
##### Arguments
| Type | Name | Description |
| --- | --- | --- |
| [`CommandConfiguration`](./sharedlibrarycoreconfiguration-CommandConfiguration) | config | |
| [`ITranslationLookup`](./sharedlibrarycoreinterfaces-ITranslationLookup) | translationLookup | |
| `IDatabaseContextFactory` | contextFactory | |
### Methods
#### ExecuteAsync
```csharp
public override async Task ExecuteAsync(GameEvent E)
```
##### Arguments
| Type | Name | Description |
| --- | --- | --- |
| [`GameEvent`](./sharedlibrarycore-GameEvent) | E | |
*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc)

@ -0,0 +1,58 @@
# QuitCommand `Public class`
## Description
Quits IW4MAdmin
## Diagram
```mermaid
flowchart LR
classDef interfaceStyle stroke-dasharray: 5 5;
classDef abstractStyle stroke-width:4px
subgraph SharedLibraryCore.Commands
SharedLibraryCore.Commands.QuitCommand[[QuitCommand]]
end
subgraph SharedLibraryCore
SharedLibraryCore.Command[[Command]]
class SharedLibraryCore.Command abstractStyle;
end
SharedLibraryCore.Command --> SharedLibraryCore.Commands.QuitCommand
```
## Members
### Methods
#### Public methods
| Returns | Name |
| --- | --- |
| `Task` | [`ExecuteAsync`](#executeasync)([`GameEvent`](./sharedlibrarycore-GameEvent) E) |
## Details
### Summary
Quits IW4MAdmin
### Inheritance
- [
`Command`
](./sharedlibrarycore-Command)
### Constructors
#### QuitCommand
```csharp
public QuitCommand(CommandConfiguration config, ITranslationLookup translationLookup)
```
##### Arguments
| Type | Name | Description |
| --- | --- | --- |
| [`CommandConfiguration`](./sharedlibrarycoreconfiguration-CommandConfiguration) | config | |
| [`ITranslationLookup`](./sharedlibrarycoreinterfaces-ITranslationLookup) | translationLookup | |
### Methods
#### ExecuteAsync
```csharp
public override async Task ExecuteAsync(GameEvent E)
```
##### Arguments
| Type | Name | Description |
| --- | --- | --- |
| [`GameEvent`](./sharedlibrarycore-GameEvent) | E | |
*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc)

@ -0,0 +1,58 @@
# RequestTokenCommand `Public class`
## Description
Generates a token for use in webfront login
## Diagram
```mermaid
flowchart LR
classDef interfaceStyle stroke-dasharray: 5 5;
classDef abstractStyle stroke-width:4px
subgraph SharedLibraryCore.Commands
SharedLibraryCore.Commands.RequestTokenCommand[[RequestTokenCommand]]
end
subgraph SharedLibraryCore
SharedLibraryCore.Command[[Command]]
class SharedLibraryCore.Command abstractStyle;
end
SharedLibraryCore.Command --> SharedLibraryCore.Commands.RequestTokenCommand
```
## Members
### Methods
#### Public methods
| Returns | Name |
| --- | --- |
| `Task` | [`ExecuteAsync`](#executeasync)([`GameEvent`](./sharedlibrarycore-GameEvent) gameEvent) |
## Details
### Summary
Generates a token for use in webfront login
### Inheritance
- [
`Command`
](./sharedlibrarycore-Command)
### Constructors
#### RequestTokenCommand
```csharp
public RequestTokenCommand(CommandConfiguration config, ITranslationLookup lookup)
```
##### Arguments
| Type | Name | Description |
| --- | --- | --- |
| [`CommandConfiguration`](./sharedlibrarycoreconfiguration-CommandConfiguration) | config | |
| [`ITranslationLookup`](./sharedlibrarycoreinterfaces-ITranslationLookup) | lookup | |
### Methods
#### ExecuteAsync
```csharp
public override Task ExecuteAsync(GameEvent gameEvent)
```
##### Arguments
| Type | Name | Description |
| --- | --- | --- |
| [`GameEvent`](./sharedlibrarycore-GameEvent) | gameEvent | |
*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc)

@ -0,0 +1,58 @@
# RestartCommand `Public class`
## Description
Restarts IW4MAdmin
## Diagram
```mermaid
flowchart LR
classDef interfaceStyle stroke-dasharray: 5 5;
classDef abstractStyle stroke-width:4px
subgraph SharedLibraryCore.Commands
SharedLibraryCore.Commands.RestartCommand[[RestartCommand]]
end
subgraph SharedLibraryCore
SharedLibraryCore.Command[[Command]]
class SharedLibraryCore.Command abstractStyle;
end
SharedLibraryCore.Command --> SharedLibraryCore.Commands.RestartCommand
```
## Members
### Methods
#### Public methods
| Returns | Name |
| --- | --- |
| `Task` | [`ExecuteAsync`](#executeasync)([`GameEvent`](./sharedlibrarycore-GameEvent) gameEvent) |
## Details
### Summary
Restarts IW4MAdmin
### Inheritance
- [
`Command`
](./sharedlibrarycore-Command)
### Constructors
#### RestartCommand
```csharp
public RestartCommand(CommandConfiguration config, ITranslationLookup translationLookup)
```
##### Arguments
| Type | Name | Description |
| --- | --- | --- |
| [`CommandConfiguration`](./sharedlibrarycoreconfiguration-CommandConfiguration) | config | |
| [`ITranslationLookup`](./sharedlibrarycoreinterfaces-ITranslationLookup) | translationLookup | |
### Methods
#### ExecuteAsync
```csharp
public override async Task ExecuteAsync(GameEvent gameEvent)
```
##### Arguments
| Type | Name | Description |
| --- | --- | --- |
| [`GameEvent`](./sharedlibrarycore-GameEvent) | gameEvent | |
*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc)

@ -0,0 +1,52 @@
# RunAsCommand `Public class`
## Diagram
```mermaid
flowchart LR
classDef interfaceStyle stroke-dasharray: 5 5;
classDef abstractStyle stroke-width:4px
subgraph SharedLibraryCore.Commands
SharedLibraryCore.Commands.RunAsCommand[[RunAsCommand]]
end
subgraph SharedLibraryCore
SharedLibraryCore.Command[[Command]]
class SharedLibraryCore.Command abstractStyle;
end
SharedLibraryCore.Command --> SharedLibraryCore.Commands.RunAsCommand
```
## Members
### Methods
#### Public methods
| Returns | Name |
| --- | --- |
| `Task` | [`ExecuteAsync`](#executeasync)([`GameEvent`](./sharedlibrarycore-GameEvent) gameEvent) |
## Details
### Inheritance
- [
`Command`
](./sharedlibrarycore-Command)
### Constructors
#### RunAsCommand
```csharp
public RunAsCommand(CommandConfiguration config, ITranslationLookup lookup)
```
##### Arguments
| Type | Name | Description |
| --- | --- | --- |
| [`CommandConfiguration`](./sharedlibrarycoreconfiguration-CommandConfiguration) | config | |
| [`ITranslationLookup`](./sharedlibrarycoreinterfaces-ITranslationLookup) | lookup | |
### Methods
#### ExecuteAsync
```csharp
public override async Task ExecuteAsync(GameEvent gameEvent)
```
##### Arguments
| Type | Name | Description |
| --- | --- | --- |
| [`GameEvent`](./sharedlibrarycore-GameEvent) | gameEvent | |
*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc)

@ -0,0 +1,59 @@
# SetGravatarCommand `Public class`
## Description
Sets the email for gravatar in webfront
## Diagram
```mermaid
flowchart LR
classDef interfaceStyle stroke-dasharray: 5 5;
classDef abstractStyle stroke-width:4px
subgraph SharedLibraryCore.Commands
SharedLibraryCore.Commands.SetGravatarCommand[[SetGravatarCommand]]
end
subgraph SharedLibraryCore
SharedLibraryCore.Command[[Command]]
class SharedLibraryCore.Command abstractStyle;
end
SharedLibraryCore.Command --> SharedLibraryCore.Commands.SetGravatarCommand
```
## Members
### Methods
#### Public methods
| Returns | Name |
| --- | --- |
| `Task` | [`ExecuteAsync`](#executeasync)([`GameEvent`](./sharedlibrarycore-GameEvent) E) |
## Details
### Summary
Sets the email for gravatar in webfront
### Inheritance
- [
`Command`
](./sharedlibrarycore-Command)
### Constructors
#### SetGravatarCommand
```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 | |
### Methods
#### ExecuteAsync
```csharp
public override async Task ExecuteAsync(GameEvent E)
```
##### Arguments
| Type | Name | Description |
| --- | --- | --- |
| [`GameEvent`](./sharedlibrarycore-GameEvent) | E | |
*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc)

@ -0,0 +1,59 @@
# SetLevelCommand `Public class`
## Description
Sets the level of given client
## Diagram
```mermaid
flowchart LR
classDef interfaceStyle stroke-dasharray: 5 5;
classDef abstractStyle stroke-width:4px
subgraph SharedLibraryCore.Commands
SharedLibraryCore.Commands.SetLevelCommand[[SetLevelCommand]]
end
subgraph SharedLibraryCore
SharedLibraryCore.Command[[Command]]
class SharedLibraryCore.Command abstractStyle;
end
SharedLibraryCore.Command --> SharedLibraryCore.Commands.SetLevelCommand
```
## Members
### Methods
#### Public methods
| Returns | Name |
| --- | --- |
| `Task` | [`ExecuteAsync`](#executeasync)([`GameEvent`](./sharedlibrarycore-GameEvent) gameEvent) |
## Details
### Summary
Sets the level of given client
### Inheritance
- [
`Command`
](./sharedlibrarycore-Command)
### Constructors
#### SetLevelCommand
```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 | |
### Methods
#### ExecuteAsync
```csharp
public override async Task ExecuteAsync(GameEvent gameEvent)
```
##### Arguments
| Type | Name | Description |
| --- | --- | --- |
| [`GameEvent`](./sharedlibrarycore-GameEvent) | gameEvent | |
*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc)

@ -0,0 +1,58 @@
# SetPasswordCommand `Public class`
## Description
Sets login password
## Diagram
```mermaid
flowchart LR
classDef interfaceStyle stroke-dasharray: 5 5;
classDef abstractStyle stroke-width:4px
subgraph SharedLibraryCore.Commands
SharedLibraryCore.Commands.SetPasswordCommand[[SetPasswordCommand]]
end
subgraph SharedLibraryCore
SharedLibraryCore.Command[[Command]]
class SharedLibraryCore.Command abstractStyle;
end
SharedLibraryCore.Command --> SharedLibraryCore.Commands.SetPasswordCommand
```
## Members
### Methods
#### Public methods
| Returns | Name |
| --- | --- |
| `Task` | [`ExecuteAsync`](#executeasync)([`GameEvent`](./sharedlibrarycore-GameEvent) E) |
## Details
### Summary
Sets login password
### Inheritance
- [
`Command`
](./sharedlibrarycore-Command)
### Constructors
#### SetPasswordCommand
```csharp
public SetPasswordCommand(CommandConfiguration config, ITranslationLookup translationLookup)
```
##### Arguments
| Type | Name | Description |
| --- | --- | --- |
| [`CommandConfiguration`](./sharedlibrarycoreconfiguration-CommandConfiguration) | config | |
| [`ITranslationLookup`](./sharedlibrarycoreinterfaces-ITranslationLookup) | translationLookup | |
### Methods
#### ExecuteAsync
```csharp
public override async Task ExecuteAsync(GameEvent E)
```
##### Arguments
| Type | Name | Description |
| --- | --- | --- |
| [`GameEvent`](./sharedlibrarycore-GameEvent) | E | |
*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc)

@ -0,0 +1,59 @@
# TempBanCommand `Public class`
## Description
Temporarily bans a client
## Diagram
```mermaid
flowchart LR
classDef interfaceStyle stroke-dasharray: 5 5;
classDef abstractStyle stroke-width:4px
subgraph SharedLibraryCore.Commands
SharedLibraryCore.Commands.TempBanCommand[[TempBanCommand]]
end
subgraph SharedLibraryCore
SharedLibraryCore.Command[[Command]]
class SharedLibraryCore.Command abstractStyle;
end
SharedLibraryCore.Command --> SharedLibraryCore.Commands.TempBanCommand
```
## Members
### Methods
#### Public methods
| Returns | Name |
| --- | --- |
| `Task` | [`ExecuteAsync`](#executeasync)([`GameEvent`](./sharedlibrarycore-GameEvent) gameEvent) |
## Details
### Summary
Temporarily bans a client
### Inheritance
- [
`Command`
](./sharedlibrarycore-Command)
### Constructors
#### TempBanCommand
```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 | |
### Methods
#### ExecuteAsync
```csharp
public override async Task ExecuteAsync(GameEvent gameEvent)
```
##### Arguments
| Type | Name | Description |
| --- | --- | --- |
| [`GameEvent`](./sharedlibrarycore-GameEvent) | gameEvent | |
*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc)

@ -0,0 +1,58 @@
# UnbanCommand `Public class`
## Description
Unbans a banned client
## Diagram
```mermaid
flowchart LR
classDef interfaceStyle stroke-dasharray: 5 5;
classDef abstractStyle stroke-width:4px
subgraph SharedLibraryCore.Commands
SharedLibraryCore.Commands.UnbanCommand[[UnbanCommand]]
end
subgraph SharedLibraryCore
SharedLibraryCore.Command[[Command]]
class SharedLibraryCore.Command abstractStyle;
end
SharedLibraryCore.Command --> SharedLibraryCore.Commands.UnbanCommand
```
## Members
### Methods
#### Public methods
| Returns | Name |
| --- | --- |
| `Task` | [`ExecuteAsync`](#executeasync)([`GameEvent`](./sharedlibrarycore-GameEvent) gameEvent) |
## Details
### Summary
Unbans a banned client
### Inheritance
- [
`Command`
](./sharedlibrarycore-Command)
### Constructors
#### UnbanCommand
```csharp
public UnbanCommand(CommandConfiguration config, ITranslationLookup translationLookup)
```
##### Arguments
| Type | Name | Description |
| --- | --- | --- |
| [`CommandConfiguration`](./sharedlibrarycoreconfiguration-CommandConfiguration) | config | |
| [`ITranslationLookup`](./sharedlibrarycoreinterfaces-ITranslationLookup) | translationLookup | |
### Methods
#### ExecuteAsync
```csharp
public override async Task ExecuteAsync(GameEvent gameEvent)
```
##### Arguments
| Type | Name | Description |
| --- | --- | --- |
| [`GameEvent`](./sharedlibrarycore-GameEvent) | gameEvent | |
*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc)

@ -0,0 +1,58 @@
# UnflagClientCommand `Public class`
## Description
Unflag given client for specified reason
## Diagram
```mermaid
flowchart LR
classDef interfaceStyle stroke-dasharray: 5 5;
classDef abstractStyle stroke-width:4px
subgraph SharedLibraryCore.Commands
SharedLibraryCore.Commands.UnflagClientCommand[[UnflagClientCommand]]
end
subgraph SharedLibraryCore
SharedLibraryCore.Command[[Command]]
class SharedLibraryCore.Command abstractStyle;
end
SharedLibraryCore.Command --> SharedLibraryCore.Commands.UnflagClientCommand
```
## Members
### Methods
#### Public methods
| Returns | Name |
| --- | --- |
| `Task` | [`ExecuteAsync`](#executeasync)([`GameEvent`](./sharedlibrarycore-GameEvent) E) |
## Details
### Summary
Unflag given client for specified reason
### Inheritance
- [
`Command`
](./sharedlibrarycore-Command)
### Constructors
#### UnflagClientCommand
```csharp
public UnflagClientCommand(CommandConfiguration config, ITranslationLookup translationLookup)
```
##### Arguments
| Type | Name | Description |
| --- | --- | --- |
| [`CommandConfiguration`](./sharedlibrarycoreconfiguration-CommandConfiguration) | config | |
| [`ITranslationLookup`](./sharedlibrarycoreinterfaces-ITranslationLookup) | translationLookup | |
### Methods
#### ExecuteAsync
```csharp
public override async Task ExecuteAsync(GameEvent E)
```
##### Arguments
| Type | Name | Description |
| --- | --- | --- |
| [`GameEvent`](./sharedlibrarycore-GameEvent) | E | |
*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc)

@ -0,0 +1,66 @@
# UnlinkClientCommand `Public class`
## Description
Provides a way for administrators to "unlink" linked accounts
This problem is common in IW4x where the client identifier is a file
that is commonly transmitted when uploading and sharing the game files
This command creates a new link and assigns the guid, and all aliases with the current IP
associated to the provided client ID to the new link
## Diagram
```mermaid
flowchart LR
classDef interfaceStyle stroke-dasharray: 5 5;
classDef abstractStyle stroke-width:4px
subgraph SharedLibraryCore.Commands
SharedLibraryCore.Commands.UnlinkClientCommand[[UnlinkClientCommand]]
end
subgraph SharedLibraryCore
SharedLibraryCore.Command[[Command]]
class SharedLibraryCore.Command abstractStyle;
end
SharedLibraryCore.Command --> SharedLibraryCore.Commands.UnlinkClientCommand
```
## Members
### Methods
#### Public methods
| Returns | Name |
| --- | --- |
| `Task` | [`ExecuteAsync`](#executeasync)([`GameEvent`](./sharedlibrarycore-GameEvent) E) |
## Details
### Summary
Provides a way for administrators to "unlink" linked accounts
This problem is common in IW4x where the client identifier is a file
that is commonly transmitted when uploading and sharing the game files
This command creates a new link and assigns the guid, and all aliases with the current IP
associated to the provided client ID to the new link
### Inheritance
- [
`Command`
](./sharedlibrarycore-Command)
### Constructors
#### UnlinkClientCommand
```csharp
public UnlinkClientCommand(CommandConfiguration config, ITranslationLookup lookup)
```
##### Arguments
| Type | Name | Description |
| --- | --- | --- |
| [`CommandConfiguration`](./sharedlibrarycoreconfiguration-CommandConfiguration) | config | |
| [`ITranslationLookup`](./sharedlibrarycoreinterfaces-ITranslationLookup) | lookup | |
### Methods
#### ExecuteAsync
```csharp
public override async Task ExecuteAsync(GameEvent E)
```
##### Arguments
| Type | Name | Description |
| --- | --- | --- |
| [`GameEvent`](./sharedlibrarycore-GameEvent) | E | |
*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc)

@ -0,0 +1,58 @@
# UptimeCommand `Public class`
## Description
Prints out how long IW4MAdmin has been running
## Diagram
```mermaid
flowchart LR
classDef interfaceStyle stroke-dasharray: 5 5;
classDef abstractStyle stroke-width:4px
subgraph SharedLibraryCore.Commands
SharedLibraryCore.Commands.UptimeCommand[[UptimeCommand]]
end
subgraph SharedLibraryCore
SharedLibraryCore.Command[[Command]]
class SharedLibraryCore.Command abstractStyle;
end
SharedLibraryCore.Command --> SharedLibraryCore.Commands.UptimeCommand
```
## Members
### Methods
#### Public methods
| Returns | Name |
| --- | --- |
| `Task` | [`ExecuteAsync`](#executeasync)([`GameEvent`](./sharedlibrarycore-GameEvent) E) |
## Details
### Summary
Prints out how long IW4MAdmin has been running
### Inheritance
- [
`Command`
](./sharedlibrarycore-Command)
### Constructors
#### UptimeCommand
```csharp
public UptimeCommand(CommandConfiguration config, ITranslationLookup translationLookup)
```
##### Arguments
| Type | Name | Description |
| --- | --- | --- |
| [`CommandConfiguration`](./sharedlibrarycoreconfiguration-CommandConfiguration) | config | |
| [`ITranslationLookup`](./sharedlibrarycoreinterfaces-ITranslationLookup) | translationLookup | |
### Methods
#### ExecuteAsync
```csharp
public override Task ExecuteAsync(GameEvent E)
```
##### Arguments
| Type | Name | Description |
| --- | --- | --- |
| [`GameEvent`](./sharedlibrarycore-GameEvent) | E | |
*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc)

@ -0,0 +1,58 @@
# WarnClearCommand `Public class`
## Description
Clears all warnings for given client
## Diagram
```mermaid
flowchart LR
classDef interfaceStyle stroke-dasharray: 5 5;
classDef abstractStyle stroke-width:4px
subgraph SharedLibraryCore.Commands
SharedLibraryCore.Commands.WarnClearCommand[[WarnClearCommand]]
end
subgraph SharedLibraryCore
SharedLibraryCore.Command[[Command]]
class SharedLibraryCore.Command abstractStyle;
end
SharedLibraryCore.Command --> SharedLibraryCore.Commands.WarnClearCommand
```
## Members
### Methods
#### Public methods
| Returns | Name |
| --- | --- |
| `Task` | [`ExecuteAsync`](#executeasync)([`GameEvent`](./sharedlibrarycore-GameEvent) E) |
## Details
### Summary
Clears all warnings for given client
### Inheritance
- [
`Command`
](./sharedlibrarycore-Command)
### Constructors
#### WarnClearCommand
```csharp
public WarnClearCommand(CommandConfiguration config, ITranslationLookup translationLookup)
```
##### Arguments
| Type | Name | Description |
| --- | --- | --- |
| [`CommandConfiguration`](./sharedlibrarycoreconfiguration-CommandConfiguration) | config | |
| [`ITranslationLookup`](./sharedlibrarycoreinterfaces-ITranslationLookup) | translationLookup | |
### Methods
#### ExecuteAsync
```csharp
public override Task ExecuteAsync(GameEvent E)
```
##### Arguments
| Type | Name | Description |
| --- | --- | --- |
| [`GameEvent`](./sharedlibrarycore-GameEvent) | E | |
*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc)

@ -0,0 +1,59 @@
# WarnCommand `Public class`
## Description
Warns given client for reason
## Diagram
```mermaid
flowchart LR
classDef interfaceStyle stroke-dasharray: 5 5;
classDef abstractStyle stroke-width:4px
subgraph SharedLibraryCore.Commands
SharedLibraryCore.Commands.WarnCommand[[WarnCommand]]
end
subgraph SharedLibraryCore
SharedLibraryCore.Command[[Command]]
class SharedLibraryCore.Command abstractStyle;
end
SharedLibraryCore.Command --> SharedLibraryCore.Commands.WarnCommand
```
## Members
### Methods
#### Public methods
| Returns | Name |
| --- | --- |
| `Task` | [`ExecuteAsync`](#executeasync)([`GameEvent`](./sharedlibrarycore-GameEvent) gameEvent) |
## Details
### Summary
Warns given client for reason
### Inheritance
- [
`Command`
](./sharedlibrarycore-Command)
### Constructors
#### WarnCommand
```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 | |
### Methods
#### ExecuteAsync
```csharp
public override Task ExecuteAsync(GameEvent gameEvent)
```
##### Arguments
| Type | Name | Description |
| --- | --- | --- |
| [`GameEvent`](./sharedlibrarycore-GameEvent) | gameEvent | |
*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc)

@ -0,0 +1,397 @@
# ApplicationConfiguration `Public class`
## Diagram
```mermaid
flowchart LR
classDef interfaceStyle stroke-dasharray: 5 5;
classDef abstractStyle stroke-width:4px
subgraph SharedLibraryCore.Configuration
SharedLibraryCore.Configuration.ApplicationConfiguration[[ApplicationConfiguration]]
end
subgraph SharedLibraryCore.Interfaces
SharedLibraryCore.Interfaces.IBaseConfiguration[[IBaseConfiguration]]
class SharedLibraryCore.Interfaces.IBaseConfiguration interfaceStyle;
end
SharedLibraryCore.Interfaces.IBaseConfiguration --> SharedLibraryCore.Configuration.ApplicationConfiguration
```
## Members
### Properties
#### Public properties
| Type | Name | Methods |
| --- | --- | --- |
| `int` | [`AutoMessagePeriod`](#automessageperiod) | `get, set` |
| `string``[]` | [`AutoMessages`](#automessages) | `get, set` |
| `TimeSpan``[]` | [`BanDurations`](#bandurations) | `get, set` |
| `string` | [`BroadcastCommandPrefix`](#broadcastcommandprefix) | `get, set` |
| `string` | [`CommandPrefix`](#commandprefix) | `get, set` |
| [`CommunityInformationConfiguration`](./sharedlibrarycoreconfiguration-CommunityInformationConfiguration) | [`CommunityInformation`](#communityinformation) | `get, set` |
| `string` | [`ConnectionString`](#connectionstring) | `get, set` |
| `string` | [`ContactUri`](#contacturi) | `get, set` |
| `string` | [`CustomLocale`](#customlocale) | `get, set` |
| `string` | [`CustomParserEncoding`](#customparserencoding) | `get, set` |
| `string` | [`CustomSayName`](#customsayname) | `get, set` |
| `string` | [`DatabaseProvider`](#databaseprovider) | `get, set` |
| `string``[]` | [`DisallowedClientNames`](#disallowedclientnames) | `get, set` |
| `bool` | [`EnableColorCodes`](#enablecolorcodes) | `get, set` |
| `bool` | [`EnableCustomLocale`](#enablecustomlocale) | `get, set` |
| `bool` | [`EnableCustomParserEncoding`](#enablecustomparserencoding) | `get, set` |
| `bool` | [`EnableCustomSayName`](#enablecustomsayname) | `get, set` |
| `bool` | [`EnableImplicitAccountLinking`](#enableimplicitaccountlinking) | `get, set` |
| `bool` | [`EnableMultipleOwners`](#enablemultipleowners) | `get, set` |
| `bool` | [`EnablePrivilegedUserPrivacy`](#enableprivilegeduserprivacy) | `get, set` |
| `bool` | [`EnableSocialLink`](#enablesociallink) | `get, set` |
| `bool` | [`EnableSteppedHierarchy`](#enablesteppedhierarchy) | `get, set` |
| `bool` | [`EnableWebFront`](#enablewebfront) | `get, set` |
| `bool` | [`EnableWebfrontConnectionWhitelist`](#enablewebfrontconnectionwhitelist) | `get, set` |
| `string``[]` | [`GlobalRules`](#globalrules) | `get, set` |
| `string` | [`Id`](#id) | `get, set` |
| `bool` | [`IgnoreBots`](#ignorebots) | `get, set` |
| `bool` | [`IgnoreServerConnectionLost`](#ignoreserverconnectionlost) | `get, set` |
| `string` | [`IngameAccentColorKey`](#ingameaccentcolorkey) | `get, set` |
| `string` | [`ManualWebfrontUrl`](#manualwebfronturl) | `get, set` |
| `int` | [`MapChangeDelaySeconds`](#mapchangedelayseconds) | `get, set` |
| [`MapConfiguration`](./sharedlibrarycoreconfiguration-MapConfiguration)`[]` | [`Maps`](#maps) | `get, set` |
| `Uri` | [`MasterUrl`](#masterurl) | `get, set` |
| `TimeSpan` | [`MaxClientHistoryTime`](#maxclienthistorytime) | `get, set` |
| `TimeSpan` | [`MaximumTempBanTime`](#maximumtempbantime) | `get, set` |
| `Dictionary`&lt;`string`, `Permission`&gt; | [`MinimumAlertPermissions`](#minimumalertpermissions) | `get, set` |
| `int` | [`MinimumNameLength`](#minimumnamelength) | `get, set` |
| `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` |
| `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` |
| `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` |
| `string` | [`WebfrontBindUrl`](#webfrontbindurl) | `get, set` |
| `string``[]` | [`WebfrontConnectionWhitelist`](#webfrontconnectionwhitelist) | `get, set` |
| `string` | [`WebfrontCustomBranding`](#webfrontcustombranding) | `get, set` |
| `string` | [`WebfrontPrimaryColor`](#webfrontprimarycolor) | `get, set` |
| `string` | [`WebfrontSecondaryColor`](#webfrontsecondarycolor) | `get, set` |
| `string` | [`WebfrontUrl`](#webfronturl) | `get` |
### Methods
#### Public methods
| Returns | Name |
| --- | --- |
| [`IBaseConfiguration`](./sharedlibrarycoreinterfaces-IBaseConfiguration) | [`Generate`](#generate)() |
| `string` | [`Name`](#name)() |
## Details
### Inheritance
- [
`IBaseConfiguration`
](./sharedlibrarycoreinterfaces-IBaseConfiguration)
### Constructors
#### ApplicationConfiguration
```csharp
public ApplicationConfiguration()
```
### Methods
#### Generate
```csharp
public virtual IBaseConfiguration Generate()
```
#### Name
```csharp
public virtual string Name()
```
### Properties
#### CommunityInformation
```csharp
public CommunityInformationConfiguration CommunityInformation { get; set; }
```
#### EnableWebFront
```csharp
public bool EnableWebFront { get; set; }
```
#### WebfrontBindUrl
```csharp
public string WebfrontBindUrl { get; set; }
```
#### ManualWebfrontUrl
```csharp
public string ManualWebfrontUrl { get; set; }
```
#### WebfrontPrimaryColor
```csharp
public string WebfrontPrimaryColor { get; set; }
```
#### WebfrontSecondaryColor
```csharp
public string WebfrontSecondaryColor { get; set; }
```
#### WebfrontCustomBranding
```csharp
public string WebfrontCustomBranding { get; set; }
```
#### Webfront
```csharp
public WebfrontConfiguration Webfront { get; set; }
```
#### EnableMultipleOwners
```csharp
public bool EnableMultipleOwners { get; set; }
```
#### EnableSteppedHierarchy
```csharp
public bool EnableSteppedHierarchy { get; set; }
```
#### UseLocalTranslations
```csharp
public bool UseLocalTranslations { get; set; }
```
#### IgnoreBots
```csharp
public bool IgnoreBots { get; set; }
```
#### EnableCustomSayName
```csharp
public bool EnableCustomSayName { get; set; }
```
#### CustomSayName
```csharp
public string CustomSayName { get; set; }
```
#### EnableSocialLink
```csharp
public bool EnableSocialLink { get; set; }
```
#### SocialLinkAddress
```csharp
public string SocialLinkAddress { get; set; }
```
#### SocialLinkTitle
```csharp
public string SocialLinkTitle { get; set; }
```
#### ContactUri
```csharp
public string ContactUri { get; set; }
```
#### EnableCustomParserEncoding
```csharp
public bool EnableCustomParserEncoding { get; set; }
```
#### CustomParserEncoding
```csharp
public string CustomParserEncoding { get; set; }
```
#### EnableWebfrontConnectionWhitelist
```csharp
public bool EnableWebfrontConnectionWhitelist { get; set; }
```
#### WebfrontConnectionWhitelist
```csharp
public string WebfrontConnectionWhitelist { get; set; }
```
#### EnableCustomLocale
```csharp
public bool EnableCustomLocale { get; set; }
```
#### CustomLocale
```csharp
public string CustomLocale { get; set; }
```
#### CommandPrefix
```csharp
public string CommandPrefix { get; set; }
```
#### BroadcastCommandPrefix
```csharp
public string BroadcastCommandPrefix { get; set; }
```
#### DatabaseProvider
```csharp
public string DatabaseProvider { get; set; }
```
#### ConnectionString
```csharp
public string ConnectionString { get; set; }
```
#### RConPollRate
```csharp
public int RConPollRate { get; set; }
```
#### MaximumTempBanTime
```csharp
public TimeSpan MaximumTempBanTime { get; set; }
```
#### EnableColorCodes
```csharp
public bool EnableColorCodes { get; set; }
```
#### IngameAccentColorKey
```csharp
public string IngameAccentColorKey { get; set; }
```
#### AutoMessagePeriod
```csharp
public int AutoMessagePeriod { get; set; }
```
#### AutoMessages
```csharp
public string AutoMessages { get; set; }
```
#### GlobalRules
```csharp
public string GlobalRules { get; set; }
```
#### DisallowedClientNames
```csharp
public string DisallowedClientNames { get; set; }
```
#### MapChangeDelaySeconds
```csharp
public int MapChangeDelaySeconds { get; set; }
```
#### BanDurations
```csharp
public TimeSpan BanDurations { get; set; }
```
#### PermissionSets
```csharp
public Dictionary<string, List<string>> PermissionSets { get; set; }
```
#### MinimumAlertPermissions
```csharp
public Dictionary<string, Permission> MinimumAlertPermissions { get; set; }
```
#### PresetPenaltyReasons
```csharp
public Dictionary<string, string> PresetPenaltyReasons { get; set; }
```
#### EnablePrivilegedUserPrivacy
```csharp
public bool EnablePrivilegedUserPrivacy { get; set; }
```
#### EnableImplicitAccountLinking
```csharp
public bool EnableImplicitAccountLinking { get; set; }
```
#### RecentAliasIpLinkTimeLimit
```csharp
public TimeSpan RecentAliasIpLinkTimeLimit { get; set; }
```
#### MaxClientHistoryTime
```csharp
public TimeSpan MaxClientHistoryTime { get; set; }
```
#### ServerDataCollectionInterval
```csharp
public TimeSpan ServerDataCollectionInterval { get; set; }
```
#### ServerConnectionAttempts
```csharp
public int ServerConnectionAttempts { get; set; }
```
#### OverridePermissionLevelNames
```csharp
public Dictionary<Permission, string> OverridePermissionLevelNames { get; set; }
```
#### Servers
```csharp
public ServerConfiguration Servers { get; set; }
```
#### MinimumNameLength
```csharp
public int MinimumNameLength { get; set; }
```
#### Id
```csharp
public string Id { get; set; }
```
#### SubscriptionId
```csharp
public string SubscriptionId { get; set; }
```
#### Maps
```csharp
public MapConfiguration Maps { get; set; }
```
#### QuickMessages
```csharp
public QuickMessageConfiguration QuickMessages { get; set; }
```
#### WebfrontUrl
```csharp
public string WebfrontUrl { get; }
```
#### IgnoreServerConnectionLost
```csharp
public bool IgnoreServerConnectionLost { get; set; }
```
#### MasterUrl
```csharp
public Uri MasterUrl { get; set; }
```
*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc)

@ -0,0 +1,85 @@
# CommandConfiguration `Public class`
## Description
Basic command configuration
## Diagram
```mermaid
flowchart LR
classDef interfaceStyle stroke-dasharray: 5 5;
classDef abstractStyle stroke-width:4px
subgraph SharedLibraryCore.Configuration
SharedLibraryCore.Configuration.CommandConfiguration[[CommandConfiguration]]
end
subgraph SharedLibraryCore.Interfaces
SharedLibraryCore.Interfaces.IBaseConfiguration[[IBaseConfiguration]]
class SharedLibraryCore.Interfaces.IBaseConfiguration interfaceStyle;
end
SharedLibraryCore.Interfaces.IBaseConfiguration --> SharedLibraryCore.Configuration.CommandConfiguration
```
## Members
### Properties
#### Public properties
| Type | Name | Methods |
| --- | --- | --- |
| `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` |
### Methods
#### Public methods
| Returns | Name |
| --- | --- |
| [`IBaseConfiguration`](./sharedlibrarycoreinterfaces-IBaseConfiguration) | [`Generate`](#generate)() |
| `string` | [`Name`](#name)() |
## Details
### Summary
Basic command configuration
### Inheritance
- [
`IBaseConfiguration`
](./sharedlibrarycoreinterfaces-IBaseConfiguration)
### Constructors
#### CommandConfiguration
```csharp
public CommandConfiguration()
```
### Methods
#### Generate
```csharp
public virtual IBaseConfiguration Generate()
```
#### Name
```csharp
public virtual string Name()
```
### Properties
#### Commands
```csharp
public Dictionary<string, CommandProperties> Commands { get; set; }
```
##### Summary
Dict of command class names mapped to configurable properties
#### CommandPrefix
```csharp
public string CommandPrefix { get; set; }
```
##### Summary
prefix indicated the chat message is a command
#### BroadcastCommandPrefix
```csharp
public string BroadcastCommandPrefix { get; set; }
```
##### Summary
prefix indicating that the chat message is a broadcast command
*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc)

@ -0,0 +1,73 @@
# CommandProperties `Public class`
## Description
Config driven command properties
## Diagram
```mermaid
flowchart LR
classDef interfaceStyle stroke-dasharray: 5 5;
classDef abstractStyle stroke-width:4px
subgraph SharedLibraryCore.Configuration
SharedLibraryCore.Configuration.CommandProperties[[CommandProperties]]
end
```
## Members
### Properties
#### Public properties
| Type | Name | Methods |
| --- | --- | --- |
| `string` | [`Alias`](#alias)<br>Alias of this command | `get, set` |
| `bool` | [`AllowImpersonation`](#allowimpersonation)<br>Indicates if the command can be run by another user (impersonation) | `get, set` |
| `Permission` | [`MinimumPermission`](#minimumpermission)<br>Specifies the minimum permission level needed to execute the | `get, set` |
| `string` | [`Name`](#name)<br>Specifies the command name | `get, set` |
| `Game``[]` | [`SupportedGames`](#supportedgames)<br>Specifies the games supporting the functionality of the command | `get, set` |
## Details
### Summary
Config driven command properties
### Constructors
#### CommandProperties
```csharp
public CommandProperties()
```
### Properties
#### Name
```csharp
public string Name { get; set; }
```
##### Summary
Specifies the command name
#### Alias
```csharp
public string Alias { get; set; }
```
##### Summary
Alias of this command
#### MinimumPermission
```csharp
public Permission MinimumPermission { get; set; }
```
##### Summary
Specifies the minimum permission level needed to execute the
#### AllowImpersonation
```csharp
public bool AllowImpersonation { get; set; }
```
##### Summary
Indicates if the command can be run by another user (impersonation)
#### SupportedGames
```csharp
public Game SupportedGames { get; set; }
```
##### Summary
Specifies the games supporting the functionality of the command
*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc)

@ -0,0 +1,57 @@
# CommunityInformationConfiguration `Public class`
## Diagram
```mermaid
flowchart LR
classDef interfaceStyle stroke-dasharray: 5 5;
classDef abstractStyle stroke-width:4px
subgraph SharedLibraryCore.Configuration
SharedLibraryCore.Configuration.CommunityInformationConfiguration[[CommunityInformationConfiguration]]
end
```
## Members
### Properties
#### Public properties
| Type | Name | Methods |
| --- | --- | --- |
| `string` | [`Description`](#description) | `get, set` |
| `bool` | [`EnableBanner`](#enablebanner) | `get, set` |
| `bool` | [`IsEnabled`](#isenabled) | `get, set` |
| `string` | [`Name`](#name) | `get, set` |
| [`SocialAccountConfiguration`](./sharedlibrarycoreconfiguration-SocialAccountConfiguration)`[]` | [`SocialAccounts`](#socialaccounts) | `get, set` |
## Details
### Constructors
#### CommunityInformationConfiguration
```csharp
public CommunityInformationConfiguration()
```
### Properties
#### Name
```csharp
public string Name { get; set; }
```
#### Description
```csharp
public string Description { get; set; }
```
#### EnableBanner
```csharp
public bool EnableBanner { get; set; }
```
#### SocialAccounts
```csharp
public SocialAccountConfiguration SocialAccounts { get; set; }
```
#### IsEnabled
```csharp
public bool IsEnabled { get; set; }
```
*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc)

@ -0,0 +1,97 @@
# DefaultSettings `Public class`
## Diagram
```mermaid
flowchart LR
classDef interfaceStyle stroke-dasharray: 5 5;
classDef abstractStyle stroke-width:4px
subgraph SharedLibraryCore.Configuration
SharedLibraryCore.Configuration.DefaultSettings[[DefaultSettings]]
end
subgraph SharedLibraryCore.Interfaces
SharedLibraryCore.Interfaces.IBaseConfiguration[[IBaseConfiguration]]
class SharedLibraryCore.Interfaces.IBaseConfiguration interfaceStyle;
end
SharedLibraryCore.Interfaces.IBaseConfiguration --> SharedLibraryCore.Configuration.DefaultSettings
```
## Members
### Properties
#### Public properties
| Type | Name | Methods |
| --- | --- | --- |
| `string``[]` | [`AutoMessages`](#automessages) | `get, set` |
| `string``[]` | [`DisallowedClientNames`](#disallowedclientnames) | `get, set` |
| [`GameStringConfiguration`](./sharedlibrarycoreconfiguration-GameStringConfiguration) | [`GameStrings`](#gamestrings) | `get, set` |
| [`GametypeConfiguration`](./sharedlibrarycoreconfiguration-GametypeConfiguration)`[]` | [`Gametypes`](#gametypes) | `get, set` |
| `string``[]` | [`GlobalRules`](#globalrules) | `get, set` |
| [`MapConfiguration`](./sharedlibrarycoreconfiguration-MapConfiguration)`[]` | [`Maps`](#maps) | `get, set` |
| [`QuickMessageConfiguration`](./sharedlibrarycoreconfiguration-QuickMessageConfiguration)`[]` | [`QuickMessages`](#quickmessages) | `get, set` |
### Methods
#### Public methods
| Returns | Name |
| --- | --- |
| [`IBaseConfiguration`](./sharedlibrarycoreinterfaces-IBaseConfiguration) | [`Generate`](#generate)() |
| `string` | [`Name`](#name)() |
## Details
### Inheritance
- [
`IBaseConfiguration`
](./sharedlibrarycoreinterfaces-IBaseConfiguration)
### Constructors
#### DefaultSettings
```csharp
public DefaultSettings()
```
### Methods
#### Generate
```csharp
public virtual IBaseConfiguration Generate()
```
#### Name
```csharp
public virtual string Name()
```
### Properties
#### AutoMessages
```csharp
public string AutoMessages { get; set; }
```
#### GlobalRules
```csharp
public string GlobalRules { get; set; }
```
#### Maps
```csharp
public MapConfiguration Maps { get; set; }
```
#### Gametypes
```csharp
public GametypeConfiguration Gametypes { get; set; }
```
#### QuickMessages
```csharp
public QuickMessageConfiguration QuickMessages { get; set; }
```
#### DisallowedClientNames
```csharp
public string DisallowedClientNames { get; set; }
```
#### GameStrings
```csharp
public GameStringConfiguration GameStrings { get; set; }
```
*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc)

@ -0,0 +1,45 @@
# GameStringConfiguration `Public class`
## Diagram
```mermaid
flowchart LR
classDef interfaceStyle stroke-dasharray: 5 5;
classDef abstractStyle stroke-width:4px
subgraph SharedLibraryCore.Configuration
SharedLibraryCore.Configuration.GameStringConfiguration[[GameStringConfiguration]]
end
subgraph System.Collections.Generic
System.Collections.Generic.Dictionary_2[[Dictionary]]
end
System.Collections.Generic.Dictionary_2 --> SharedLibraryCore.Configuration.GameStringConfiguration
```
## Members
### Methods
#### Public methods
| Returns | Name |
| --- | --- |
| `string` | [`GetStringForGame`](#getstringforgame)(`string` key, `Nullable`&lt;`Game`&gt; game) |
## Details
### Inheritance
- `Dictionary`&lt;`Game`, `Dictionary`&lt;`string`, `string`&gt;&gt;
### Constructors
#### GameStringConfiguration
```csharp
public GameStringConfiguration()
```
### Methods
#### GetStringForGame
```csharp
public string GetStringForGame(string key, Nullable<Game> game)
```
##### Arguments
| Type | Name | Description |
| --- | --- | --- |
| `string` | key | |
| `Nullable`&lt;`Game`&gt; | game | |
*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc)

@ -0,0 +1,39 @@
# GametypeConfiguration `Public class`
## Diagram
```mermaid
flowchart LR
classDef interfaceStyle stroke-dasharray: 5 5;
classDef abstractStyle stroke-width:4px
subgraph SharedLibraryCore.Configuration
SharedLibraryCore.Configuration.GametypeConfiguration[[GametypeConfiguration]]
end
```
## Members
### Properties
#### Public properties
| Type | Name | Methods |
| --- | --- | --- |
| `Game` | [`Game`](#game) | `get, set` |
| [`Gametype`](./sharedlibrarycore-Gametype)`[]` | [`Gametypes`](#gametypes) | `get, set` |
## Details
### Constructors
#### GametypeConfiguration
```csharp
public GametypeConfiguration()
```
### Properties
#### Game
```csharp
public Game Game { get; set; }
```
#### Gametypes
```csharp
public Gametype Gametypes { get; set; }
```
*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc)

@ -0,0 +1,39 @@
# MapConfiguration `Public class`
## Diagram
```mermaid
flowchart LR
classDef interfaceStyle stroke-dasharray: 5 5;
classDef abstractStyle stroke-width:4px
subgraph SharedLibraryCore.Configuration
SharedLibraryCore.Configuration.MapConfiguration[[MapConfiguration]]
end
```
## Members
### Properties
#### Public properties
| Type | Name | Methods |
| --- | --- | --- |
| `Game` | [`Game`](#game) | `get, set` |
| [`Map`](./sharedlibrarycore-Map)`[]` | [`Maps`](#maps) | `get, set` |
## Details
### Constructors
#### MapConfiguration
```csharp
public MapConfiguration()
```
### Properties
#### Game
```csharp
public Game Game { get; set; }
```
#### Maps
```csharp
public Map Maps { get; set; }
```
*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc)

@ -0,0 +1,39 @@
# QuickMessageConfiguration `Public class`
## Diagram
```mermaid
flowchart LR
classDef interfaceStyle stroke-dasharray: 5 5;
classDef abstractStyle stroke-width:4px
subgraph SharedLibraryCore.Configuration
SharedLibraryCore.Configuration.QuickMessageConfiguration[[QuickMessageConfiguration]]
end
```
## Members
### Properties
#### Public properties
| Type | Name | Methods |
| --- | --- | --- |
| `Game` | [`Game`](#game) | `get, set` |
| `Dictionary`&lt;`string`, `string`&gt; | [`Messages`](#messages) | `get, set` |
## Details
### Constructors
#### QuickMessageConfiguration
```csharp
public QuickMessageConfiguration()
```
### Properties
#### Game
```csharp
public Game Game { get; set; }
```
#### Messages
```csharp
public Dictionary<string, string> Messages { get; set; }
```
*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc)

@ -0,0 +1,153 @@
# ServerConfiguration `Public class`
## Diagram
```mermaid
flowchart LR
classDef interfaceStyle stroke-dasharray: 5 5;
classDef abstractStyle stroke-width:4px
subgraph SharedLibraryCore.Configuration
SharedLibraryCore.Configuration.ServerConfiguration[[ServerConfiguration]]
end
subgraph SharedLibraryCore.Interfaces
SharedLibraryCore.Interfaces.IBaseConfiguration[[IBaseConfiguration]]
class SharedLibraryCore.Interfaces.IBaseConfiguration interfaceStyle;
end
SharedLibraryCore.Interfaces.IBaseConfiguration --> SharedLibraryCore.Configuration.ServerConfiguration
```
## Members
### Properties
#### Public properties
| Type | Name | Methods |
| --- | --- | --- |
| `string``[]` | [`AutoMessages`](#automessages) | `get, set` |
| `string` | [`CustomHostname`](#customhostname) | `get, set` |
| `string` | [`EventParserVersion`](#eventparserversion) | `get, set` |
| `Uri` | [`GameLogServerUrl`](#gamelogserverurl) | `get, set` |
| `string` | [`IPAddress`](#ipaddress) | `get, set` |
| `string` | [`ManualLogPath`](#manuallogpath) | `get, set` |
| `string` | [`Password`](#password) | `get, set` |
| `string` | [`PerformanceBucket`](#performancebucket) | `get, set` |
| `int` | [`Port`](#port) | `get, set` |
| `string` | [`RConParserVersion`](#rconparserversion) | `get, set` |
| `int` | [`ReservedSlotNumber`](#reservedslotnumber) | `get, set` |
| `string``[]` | [`Rules`](#rules) | `get, set` |
### Methods
#### Public methods
| Returns | Name |
| --- | --- |
| `void` | [`AddEventParser`](#addeventparser)([`IEventParser`](./sharedlibrarycoreinterfaces-IEventParser) parser) |
| `void` | [`AddRConParser`](#addrconparser)([`IRConParser`](./sharedlibrarycoreinterfaces-IRConParser) parser) |
| [`IBaseConfiguration`](./sharedlibrarycoreinterfaces-IBaseConfiguration) | [`Generate`](#generate)() |
| `void` | [`ModifyParsers`](#modifyparsers)() |
| `string` | [`Name`](#name)() |
## Details
### Inheritance
- [
`IBaseConfiguration`
](./sharedlibrarycoreinterfaces-IBaseConfiguration)
### Constructors
#### ServerConfiguration
```csharp
public ServerConfiguration()
```
### Methods
#### Generate
```csharp
public virtual IBaseConfiguration Generate()
```
#### Name
```csharp
public virtual string Name()
```
#### AddRConParser
```csharp
public void AddRConParser(IRConParser parser)
```
##### Arguments
| Type | Name | Description |
| --- | --- | --- |
| [`IRConParser`](./sharedlibrarycoreinterfaces-IRConParser) | parser | |
#### AddEventParser
```csharp
public void AddEventParser(IEventParser parser)
```
##### Arguments
| Type | Name | Description |
| --- | --- | --- |
| [`IEventParser`](./sharedlibrarycoreinterfaces-IEventParser) | parser | |
#### ModifyParsers
```csharp
public void ModifyParsers()
```
### Properties
#### IPAddress
```csharp
public string IPAddress { get; set; }
```
#### Port
```csharp
public int Port { get; set; }
```
#### Password
```csharp
public string Password { get; set; }
```
#### Rules
```csharp
public string Rules { get; set; }
```
#### AutoMessages
```csharp
public string AutoMessages { get; set; }
```
#### ManualLogPath
```csharp
public string ManualLogPath { get; set; }
```
#### RConParserVersion
```csharp
public string RConParserVersion { get; set; }
```
#### EventParserVersion
```csharp
public string EventParserVersion { get; set; }
```
#### ReservedSlotNumber
```csharp
public int ReservedSlotNumber { get; set; }
```
#### GameLogServerUrl
```csharp
public Uri GameLogServerUrl { get; set; }
```
#### CustomHostname
```csharp
public string CustomHostname { get; set; }
```
#### PerformanceBucket
```csharp
public string PerformanceBucket { get; set; }
```
*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc)

@ -0,0 +1,51 @@
# SocialAccountConfiguration `Public class`
## Diagram
```mermaid
flowchart LR
classDef interfaceStyle stroke-dasharray: 5 5;
classDef abstractStyle stroke-width:4px
subgraph SharedLibraryCore.Configuration
SharedLibraryCore.Configuration.SocialAccountConfiguration[[SocialAccountConfiguration]]
end
```
## Members
### Properties
#### Public properties
| Type | Name | Methods |
| --- | --- | --- |
| `string` | [`IconId`](#iconid) | `get, set` |
| `string` | [`IconUrl`](#iconurl) | `get, set` |
| `string` | [`Title`](#title) | `get, set` |
| `string` | [`Url`](#url) | `get, set` |
## Details
### Constructors
#### SocialAccountConfiguration
```csharp
public SocialAccountConfiguration()
```
### Properties
#### Title
```csharp
public string Title { get; set; }
```
#### Url
```csharp
public string Url { get; set; }
```
#### IconUrl
```csharp
public string IconUrl { get; set; }
```
#### IconId
```csharp
public string IconId { get; set; }
```
*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc)

@ -0,0 +1,33 @@
# WebfrontConfiguration `Public class`
## Diagram
```mermaid
flowchart LR
classDef interfaceStyle stroke-dasharray: 5 5;
classDef abstractStyle stroke-width:4px
subgraph SharedLibraryCore.Configuration
SharedLibraryCore.Configuration.WebfrontConfiguration[[WebfrontConfiguration]]
end
```
## Members
### Properties
#### Public properties
| Type | Name | Methods |
| --- | --- | --- |
| `string` | [`ScriptInjection`](#scriptinjection) | `get, set` |
## Details
### Constructors
#### WebfrontConfiguration
```csharp
public WebfrontConfiguration()
```
### Properties
#### ScriptInjection
```csharp
public string ScriptInjection { get; set; }
```
*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc)

@ -0,0 +1,27 @@
# ConfigurationIgnore `Public class`
## Diagram
```mermaid
flowchart LR
classDef interfaceStyle stroke-dasharray: 5 5;
classDef abstractStyle stroke-width:4px
subgraph SharedLibraryCore.Configuration.Attributes
SharedLibraryCore.Configuration.Attributes.ConfigurationIgnore[[ConfigurationIgnore]]
end
subgraph System
System.Attribute[[Attribute]]
end
System.Attribute --> SharedLibraryCore.Configuration.Attributes.ConfigurationIgnore
```
## Details
### Inheritance
- `Attribute`
### Constructors
#### ConfigurationIgnore
```csharp
public ConfigurationIgnore()
```
*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc)

@ -0,0 +1,44 @@
# ConfigurationLinked `Public class`
## Diagram
```mermaid
flowchart LR
classDef interfaceStyle stroke-dasharray: 5 5;
classDef abstractStyle stroke-width:4px
subgraph SharedLibraryCore.Configuration.Attributes
SharedLibraryCore.Configuration.Attributes.ConfigurationLinked[[ConfigurationLinked]]
end
subgraph System
System.Attribute[[Attribute]]
end
System.Attribute --> SharedLibraryCore.Configuration.Attributes.ConfigurationLinked
```
## Members
### Properties
#### Public properties
| Type | Name | Methods |
| --- | --- | --- |
| `string``[]` | [`LinkedPropertyNames`](#linkedpropertynames) | `get, set` |
## Details
### Inheritance
- `Attribute`
### Constructors
#### ConfigurationLinked
```csharp
public ConfigurationLinked(string[] linkedPropertyNames)
```
##### Arguments
| Type | Name | Description |
| --- | --- | --- |
| `string``[]` | linkedPropertyNames | |
### Properties
#### LinkedPropertyNames
```csharp
public string LinkedPropertyNames { get; set; }
```
*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc)

@ -0,0 +1,27 @@
# ConfigurationOptional `Public class`
## Diagram
```mermaid
flowchart LR
classDef interfaceStyle stroke-dasharray: 5 5;
classDef abstractStyle stroke-width:4px
subgraph SharedLibraryCore.Configuration.Attributes
SharedLibraryCore.Configuration.Attributes.ConfigurationOptional[[ConfigurationOptional]]
end
subgraph System
System.Attribute[[Attribute]]
end
System.Attribute --> SharedLibraryCore.Configuration.Attributes.ConfigurationOptional
```
## Details
### Inheritance
- `Attribute`
### Constructors
#### ConfigurationOptional
```csharp
public ConfigurationOptional()
```
*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc)

@ -0,0 +1,44 @@
# LocalizedDisplayName `Internal class`
## Diagram
```mermaid
flowchart LR
classDef interfaceStyle stroke-dasharray: 5 5;
classDef abstractStyle stroke-width:4px
subgraph SharedLibraryCore.Configuration.Attributes
SharedLibraryCore.Configuration.Attributes.LocalizedDisplayName[[LocalizedDisplayName]]
end
subgraph System.ComponentModel
System.ComponentModel.DisplayNameAttribute[[DisplayNameAttribute]]
end
System.ComponentModel.DisplayNameAttribute --> SharedLibraryCore.Configuration.Attributes.LocalizedDisplayName
```
## Members
### Properties
#### Public properties
| Type | Name | Methods |
| --- | --- | --- |
| `string` | [`DisplayName`](#displayname) | `get` |
## Details
### Inheritance
- `DisplayNameAttribute`
### Constructors
#### LocalizedDisplayName
```csharp
public LocalizedDisplayName(string localizationKey)
```
##### Arguments
| Type | Name | Description |
| --- | --- | --- |
| `string` | localizationKey | |
### Properties
#### DisplayName
```csharp
public override string DisplayName { get; }
```
*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc)

@ -0,0 +1,41 @@
# ConfigurationExtensions `Public class`
## Diagram
```mermaid
flowchart LR
classDef interfaceStyle stroke-dasharray: 5 5;
classDef abstractStyle stroke-width:4px
subgraph SharedLibraryCore.Configuration.Extensions
SharedLibraryCore.Configuration.Extensions.ConfigurationExtensions[[ConfigurationExtensions]]
end
```
## Members
### Methods
#### Public Static methods
| Returns | Name |
| --- | --- |
| (`string` Item1, `string` Item2)`[]` | [`TryGetRConPasswords`](#trygetrconpasswords)([`IRConParser`](./sharedlibrarycoreinterfaces-IRConParser) parser) |
| `void` | [`TrySetIpAddress`](#trysetipaddress)([`ServerConfiguration`](./sharedlibrarycoreconfiguration-ServerConfiguration) config) |
## Details
### Methods
#### TrySetIpAddress
```csharp
public static void TrySetIpAddress(ServerConfiguration config)
```
##### Arguments
| Type | Name | Description |
| --- | --- | --- |
| [`ServerConfiguration`](./sharedlibrarycoreconfiguration-ServerConfiguration) | config | |
#### TryGetRConPasswords
```csharp
public static (string Item1, string Item2) TryGetRConPasswords(IRConParser parser)
```
##### Arguments
| Type | Name | Description |
| --- | --- | --- |
| [`IRConParser`](./sharedlibrarycoreinterfaces-IRConParser) | parser | |
*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc)

@ -0,0 +1,33 @@
# ApplicationConfigurationValidator `Public class`
## Description
Validation class for main application configuration
## Diagram
```mermaid
flowchart LR
classDef interfaceStyle stroke-dasharray: 5 5;
classDef abstractStyle stroke-width:4px
subgraph SharedLibraryCore.Configuration.Validation
SharedLibraryCore.Configuration.Validation.ApplicationConfigurationValidator[[ApplicationConfigurationValidator]]
end
subgraph FluentValidation
FluentValidation.AbstractValidator_1[[AbstractValidator]]
end
FluentValidation.AbstractValidator_1 --> SharedLibraryCore.Configuration.Validation.ApplicationConfigurationValidator
```
## Details
### Summary
Validation class for main application configuration
### Inheritance
- `AbstractValidator`&lt;[`ApplicationConfiguration`](./sharedlibrarycoreconfiguration-ApplicationConfiguration)&gt;
### Constructors
#### ApplicationConfigurationValidator
```csharp
public ApplicationConfigurationValidator()
```
*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc)

@ -0,0 +1,33 @@
# ServerConfigurationValidator `Public class`
## Description
Validation class for server configuration
## Diagram
```mermaid
flowchart LR
classDef interfaceStyle stroke-dasharray: 5 5;
classDef abstractStyle stroke-width:4px
subgraph SharedLibraryCore.Configuration.Validation
SharedLibraryCore.Configuration.Validation.ServerConfigurationValidator[[ServerConfigurationValidator]]
end
subgraph FluentValidation
FluentValidation.AbstractValidator_1[[AbstractValidator]]
end
FluentValidation.AbstractValidator_1 --> SharedLibraryCore.Configuration.Validation.ServerConfigurationValidator
```
## Details
### Summary
Validation class for server configuration
### Inheritance
- `AbstractValidator`&lt;[`ServerConfiguration`](./sharedlibrarycoreconfiguration-ServerConfiguration)&gt;
### Constructors
#### ServerConfigurationValidator
```csharp
public ServerConfigurationValidator()
```
*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc)

@ -0,0 +1,468 @@
# EFClient `Public class`
## Diagram
```mermaid
flowchart LR
classDef interfaceStyle stroke-dasharray: 5 5;
classDef abstractStyle stroke-width:4px
subgraph SharedLibraryCore.Database.Models
SharedLibraryCore.Database.Models.EFClient[[EFClient]]
end
subgraph Data.Models.Client
Data.Models.Client.EFClient[[EFClient]]
end
Data.Models.Client.EFClient --> SharedLibraryCore.Database.Models.EFClient
```
## Members
### Properties
#### Public properties
| Type | Name | Methods |
| --- | --- | --- |
| `string` | [`CleanedName`](#cleanedname) | `get` |
| `int` | [`ClientNumber`](#clientnumber) | `get, set` |
| [`ClientPermission`](./sharedlibrarycorelocalization-ClientPermission) | [`ClientPermission`](#clientpermission) | `get` |
| `int` | [`ConnectionLength`](#connectionlength) | `get` |
| `DateTime` | [`ConnectionTime`](#connectiontime) | `get, set` |
| [`Server`](./sharedlibrarycore-Server) | [`CurrentServer`](#currentserver) | `get, set` |
| `string` | [`GuidString`](#guidstring) | `get` |
| `Nullable`&lt;`int`&gt; | [`IPAddress`](#ipaddress) | `get, set` |
| `string` | [`IPAddressString`](#ipaddressstring) | `get` |
| `bool` | [`IsBot`](#isbot) | `get` |
| `bool` | [`IsIngame`](#isingame) | `get` |
| `bool` | [`IsZombieClient`](#iszombieclient) | `get` |
| `IDictionary`&lt;`int`, `long`&gt; | [`LinkedAccounts`](#linkedaccounts) | `get, set` |
| `string` | [`Name`](#name) | `get, set` |
| `int` | [`Ping`](#ping) | `get, set` |
| `int` | [`Score`](#score) | `get, set` |
| `ClientState` | [`State`](#state) | `get, set` |
| `string` | [`Tag`](#tag) | `get, set` |
| `TeamType` | [`Team`](#team) | `get, set` |
| `string` | [`TeamName`](#teamname) | `get, set` |
| `int` | [`TemporalClientNumber`](#temporalclientnumber) | `get` |
| `int` | [`Warnings`](#warnings) | `get, set` |
| `string` | [`XuidString`](#xuidstring) | `get` |
### Methods
#### Protected methods
| Returns | Name |
| --- | --- |
| `void` | [`Finalize`](#finalize)() |
#### Public methods
| Returns | Name |
| --- | --- |
| [`GameEvent`](./sharedlibrarycore-GameEvent) | [`Ban`](#ban)(`string` banReason, [`EFClient`](sharedlibrarycoredatabasemodels-EFClient) 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) |
| `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 |
| `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 |
| `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 |
| `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 |
| `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 |
## Details
### Inheritance
- `EFClient`
### Nested types
#### Enums
- `ClientState`
- `TeamType`
### Constructors
#### EFClient
```csharp
public EFClient()
```
### Methods
#### Finalize
```csharp
protected override void Finalize()
```
#### ToString
```csharp
public override string ToString()
```
#### Tell [1/2]
```csharp
public GameEvent Tell(string message)
```
##### Arguments
| Type | Name | Description |
| --- | --- | --- |
| `string` | message | message content to send to client |
##### Summary
send a message directly to the connected client
#### Tell [2/2]
```csharp
public void Tell(IEnumerable<string> messages)
```
##### Arguments
| Type | Name | Description |
| --- | --- | --- |
| `IEnumerable`&lt;`string`&gt; | messages | |
#### TellAsync
```csharp
public async Task TellAsync(IEnumerable<string> messages, CancellationToken token)
```
##### Arguments
| Type | Name | Description |
| --- | --- | --- |
| `IEnumerable`&lt;`string`&gt; | messages | |
| `CancellationToken` | token | |
#### Warn
```csharp
public GameEvent Warn(string warnReason, EFClient sender)
```
##### Arguments
| Type | Name | Description |
| --- | --- | --- |
| `string` | warnReason | reason for warn |
| [`EFClient`](sharedlibrarycoredatabasemodels-EFClient) | sender | client performing the warn |
##### Summary
warn a client with given reason
#### WarnClear
```csharp
public GameEvent WarnClear(EFClient sender)
```
##### Arguments
| Type | Name | Description |
| --- | --- | --- |
| [`EFClient`](sharedlibrarycoredatabasemodels-EFClient) | sender | client performing the warn clear |
##### Summary
clear all warnings for a client
##### Returns
#### Report
```csharp
public GameEvent Report(string reportReason, EFClient sender)
```
##### Arguments
| Type | Name | Description |
| --- | --- | --- |
| `string` | reportReason | reason for the report |
| [`EFClient`](sharedlibrarycoredatabasemodels-EFClient) | sender | client performing the report |
##### Summary
report a client for a given reason
##### Returns
#### Flag
```csharp
public GameEvent Flag(string flagReason, EFClient sender, Nullable<TimeSpan> flagLength)
```
##### Arguments
| Type | Name | Description |
| --- | --- | --- |
| `string` | flagReason | |
| [`EFClient`](sharedlibrarycoredatabasemodels-EFClient) | sender | |
| `Nullable`&lt;`TimeSpan`&gt; | flagLength | |
#### Unflag
```csharp
public GameEvent Unflag(string unflagReason, EFClient sender)
```
##### Arguments
| Type | Name | Description |
| --- | --- | --- |
| `string` | unflagReason | reason to unflag a player for |
| [`EFClient`](sharedlibrarycoredatabasemodels-EFClient) | sender | client performing the unflag |
##### Summary
unflag a client for a given reason
##### Returns
game event for the un flug
#### Kick [1/2]
```csharp
public GameEvent Kick(string kickReason, EFClient sender)
```
##### Arguments
| Type | Name | Description |
| --- | --- | --- |
| `string` | kickReason | reason to kick for |
| [`EFClient`](sharedlibrarycoredatabasemodels-EFClient) | sender | client performing the kick |
##### Summary
kick a client for the given reason
#### Kick [2/2]
```csharp
public GameEvent Kick(string kickReason, EFClient sender, EFPenalty originalPenalty)
```
##### Arguments
| Type | Name | Description |
| --- | --- | --- |
| `string` | kickReason | reason to kick for |
| [`EFClient`](sharedlibrarycoredatabasemodels-EFClient) | sender | client performing the kick |
| `EFPenalty` | originalPenalty | original client penalty |
##### Summary
kick a client for the given reason
#### TempBan
```csharp
public GameEvent TempBan(string tempbanReason, TimeSpan banLength, EFClient sender)
```
##### Arguments
| Type | Name | Description |
| --- | --- | --- |
| `string` | tempbanReason | reason for the temp ban |
| `TimeSpan` | banLength | how long the temp ban lasts |
| [`EFClient`](sharedlibrarycoredatabasemodels-EFClient) | sender | client performing the tempban |
##### Summary
temporarily ban a client for the given time span
#### Ban
```csharp
public GameEvent Ban(string banReason, EFClient sender, bool isEvade)
```
##### Arguments
| Type | Name | Description |
| --- | --- | --- |
| `string` | banReason | reason for the ban |
| [`EFClient`](sharedlibrarycoredatabasemodels-EFClient) | sender | client performing the ban |
| `bool` | isEvade | obsolete |
##### Summary
permanently ban a client
#### Unban
```csharp
public GameEvent Unban(string unbanReason, EFClient sender)
```
##### Arguments
| Type | Name | Description |
| --- | --- | --- |
| `string` | unbanReason | reason for the unban |
| [`EFClient`](sharedlibrarycoredatabasemodels-EFClient) | sender | client performing the unban |
##### Summary
unban a client
##### Returns
#### SetLevel
```csharp
public GameEvent SetLevel(Permission newPermission, EFClient sender)
```
##### Arguments
| Type | Name | Description |
| --- | --- | --- |
| `Permission` | newPermission | |
| [`EFClient`](sharedlibrarycoredatabasemodels-EFClient) | sender | |
#### IsAbleToConnectSimple
```csharp
public bool IsAbleToConnectSimple()
```
##### Summary
Handles any client related logic on connection
#### OnDisconnect
```csharp
public async Task OnDisconnect()
```
#### OnJoin
```csharp
public async Task OnJoin(Nullable<int> ipAddress, bool enableImplicitLinking)
```
##### Arguments
| Type | Name | Description |
| --- | --- | --- |
| `Nullable`&lt;`int`&gt; | ipAddress | |
| `bool` | enableImplicitLinking | |
#### CanConnect
```csharp
public async Task<bool> CanConnect(Nullable<int> ipAddress, bool enableImplicitLinking)
```
##### Arguments
| Type | Name | Description |
| --- | --- | --- |
| `Nullable`&lt;`int`&gt; | ipAddress | |
| `bool` | enableImplicitLinking | |
#### UpdateTeam
```csharp
public void UpdateTeam(string newTeam)
```
##### Arguments
| Type | Name | Description |
| --- | --- | --- |
| `string` | newTeam | |
#### Lock
```csharp
public async Task Lock()
```
#### Unlock
```csharp
public void Unlock()
```
#### Equals
```csharp
public override bool Equals(object obj)
```
##### Arguments
| Type | Name | Description |
| --- | --- | --- |
| `object` | obj | |
#### GetHashCode
```csharp
public override int GetHashCode()
```
### Properties
#### Name
```csharp
public virtual string Name { get; set; }
```
#### CleanedName
```csharp
public string CleanedName { get; }
```
#### IPAddress
```csharp
public virtual Nullable<int> IPAddress { get; set; }
```
#### IPAddressString
```csharp
public string IPAddressString { get; }
```
#### IsIngame
```csharp
public bool IsIngame { get; }
```
#### LinkedAccounts
```csharp
public virtual IDictionary<int, long> LinkedAccounts { get; set; }
```
#### ClientNumber
```csharp
public int ClientNumber { get; set; }
```
#### Ping
```csharp
public int Ping { get; set; }
```
#### Warnings
```csharp
public int Warnings { get; set; }
```
#### ConnectionTime
```csharp
public DateTime ConnectionTime { get; set; }
```
#### ConnectionLength
```csharp
public int ConnectionLength { get; }
```
#### CurrentServer
```csharp
public Server CurrentServer { get; set; }
```
#### Score
```csharp
public int Score { get; set; }
```
#### IsBot
```csharp
public bool IsBot { get; }
```
#### IsZombieClient
```csharp
public bool IsZombieClient { get; }
```
#### XuidString
```csharp
public string XuidString { get; }
```
#### GuidString
```csharp
public string GuidString { get; }
```
#### State
```csharp
public ClientState State { get; set; }
```
#### Team
```csharp
public TeamType Team { get; set; }
```
#### TeamName
```csharp
public string TeamName { get; set; }
```
#### ClientPermission
```csharp
public ClientPermission ClientPermission { get; }
```
#### Tag
```csharp
public string Tag { get; set; }
```
#### TemporalClientNumber
```csharp
public int TemporalClientNumber { get; }
```
*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc)

@ -0,0 +1,33 @@
# ClientState `Public enum`
## Diagram
```mermaid
flowchart LR
classDef interfaceStyle stroke-dasharray: 5 5;
classDef abstractStyle stroke-width:4px
subgraph SharedLibraryCore.Database.Models.EFClient
SharedLibraryCore.Database.Models.EFClient.ClientState[[ClientState]]
end
```
## Details
### Fields
#### Unknown
##### Summary
default client state
#### Connecting
##### Summary
represents when the client has been detected as joining
by the log file, but has not be authenticated by RCon
#### Connected
##### Summary
represents when the client has been authenticated by RCon
and validated by the database
#### Disconnecting
##### Summary
represents when the client is leaving (either through RCon or log file)
*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc)

@ -0,0 +1,27 @@
# TeamType `Public enum`
## Diagram
```mermaid
flowchart LR
classDef interfaceStyle stroke-dasharray: 5 5;
classDef abstractStyle stroke-width:4px
subgraph SharedLibraryCore.Database.Models.EFClient
SharedLibraryCore.Database.Models.EFClient.TeamType[[TeamType]]
end
```
## Details
### Fields
#### Unknown
#### Spectator
#### Allies
#### Axis
*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc)

@ -0,0 +1,105 @@
# AuditInfo `Public class`
## Description
data transfer class for audit information
## Diagram
```mermaid
flowchart LR
classDef interfaceStyle stroke-dasharray: 5 5;
classDef abstractStyle stroke-width:4px
subgraph SharedLibraryCore.Dtos
SharedLibraryCore.Dtos.AuditInfo[[AuditInfo]]
end
```
## Members
### Properties
#### Public properties
| Type | Name | Methods |
| --- | --- | --- |
| `string` | [`Action`](#action)<br>what audit action occured | `get, set` |
| `string` | [`Data`](#data)<br>additional comment data about the audit event | `get, set` |
| `string` | [`NewValue`](#newvalue)<br>new value | `get, set` |
| `string` | [`OldValue`](#oldvalue)<br>previous value | `get, set` |
| `int` | [`OriginId`](#originid)<br>id of the origin entity | `get, set` |
| `string` | [`OriginName`](#originname)<br>name of the origin entity | `get, set` |
| `Nullable`&lt;`int`&gt; | [`TargetId`](#targetid)<br>id of the target entity | `get, set` |
| `string` | [`TargetName`](#targetname)<br>name of the target entity | `get, set` |
| `DateTime` | [`When`](#when)<br>when the audit event occured | `get, set` |
## Details
### Summary
data transfer class for audit information
### Constructors
#### AuditInfo
```csharp
public AuditInfo()
```
### Properties
#### OriginName
```csharp
public string OriginName { get; set; }
```
##### Summary
name of the origin entity
#### OriginId
```csharp
public int OriginId { get; set; }
```
##### Summary
id of the origin entity
#### TargetName
```csharp
public string TargetName { get; set; }
```
##### Summary
name of the target entity
#### TargetId
```csharp
public Nullable<int> TargetId { get; set; }
```
##### Summary
id of the target entity
#### When
```csharp
public DateTime When { get; set; }
```
##### Summary
when the audit event occured
#### Action
```csharp
public string Action { get; set; }
```
##### Summary
what audit action occured
#### Data
```csharp
public string Data { get; set; }
```
##### Summary
additional comment data about the audit event
#### OldValue
```csharp
public string OldValue { get; set; }
```
##### Summary
previous value
#### NewValue
```csharp
public string NewValue { get; set; }
```
##### Summary
new value
*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc)

@ -0,0 +1,75 @@
# ChatInfo `Public class`
## Diagram
```mermaid
flowchart LR
classDef interfaceStyle stroke-dasharray: 5 5;
classDef abstractStyle stroke-width:4px
subgraph SharedLibraryCore.Dtos
SharedLibraryCore.Dtos.ChatInfo[[ChatInfo]]
end
```
## Members
### Properties
#### Public properties
| Type | Name | Methods |
| --- | --- | --- |
| `int` | [`ClientId`](#clientid) | `get, set` |
| `string` | [`HiddenMessage`](#hiddenmessage) | `get` |
| `bool` | [`IsHidden`](#ishidden) | `get, set` |
| `bool` | [`IsQuickMessage`](#isquickmessage) | `get, set` |
| `string` | [`Message`](#message) | `get, set` |
| `string` | [`Name`](#name) | `get, set` |
| `Game` | [`ServerGame`](#servergame) | `get, set` |
| `DateTime` | [`Time`](#time) | `get, set` |
## Details
### Constructors
#### ChatInfo
```csharp
public ChatInfo()
```
### Properties
#### ClientId
```csharp
public int ClientId { get; set; }
```
#### Message
```csharp
public string Message { get; set; }
```
#### Time
```csharp
public DateTime Time { get; set; }
```
#### Name
```csharp
public string Name { get; set; }
```
#### ServerGame
```csharp
public Game ServerGame { get; set; }
```
#### IsQuickMessage
```csharp
public bool IsQuickMessage { get; set; }
```
#### IsHidden
```csharp
public bool IsHidden { get; set; }
```
#### HiddenMessage
```csharp
public string HiddenMessage { get; }
```
*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc)

@ -0,0 +1,63 @@
# ClientCountSnapshot `Public class`
## Diagram
```mermaid
flowchart LR
classDef interfaceStyle stroke-dasharray: 5 5;
classDef abstractStyle stroke-width:4px
subgraph SharedLibraryCore.Dtos
SharedLibraryCore.Dtos.ClientCountSnapshot[[ClientCountSnapshot]]
end
```
## Members
### Properties
#### Public properties
| Type | Name | Methods |
| --- | --- | --- |
| `int` | [`ClientCount`](#clientcount) | `get, set` |
| `bool` | [`ConnectionInterrupted`](#connectioninterrupted) | `get, set` |
| `string` | [`Map`](#map) | `get, set` |
| `string` | [`MapAlias`](#mapalias) | `get, set` |
| `DateTime` | [`Time`](#time) | `get, set` |
| `string` | [`TimeString`](#timestring) | `get` |
## Details
### Constructors
#### ClientCountSnapshot
```csharp
public ClientCountSnapshot()
```
### Properties
#### Time
```csharp
public DateTime Time { get; set; }
```
#### TimeString
```csharp
public string TimeString { get; }
```
#### ClientCount
```csharp
public int ClientCount { get; set; }
```
#### ConnectionInterrupted
```csharp
public bool ConnectionInterrupted { get; set; }
```
#### Map
```csharp
public string Map { get; set; }
```
#### MapAlias
```csharp
public string MapAlias { get; set; }
```
*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc)

@ -0,0 +1,39 @@
# ClientHistoryInfo `Public class`
## Diagram
```mermaid
flowchart LR
classDef interfaceStyle stroke-dasharray: 5 5;
classDef abstractStyle stroke-width:4px
subgraph SharedLibraryCore.Dtos
SharedLibraryCore.Dtos.ClientHistoryInfo[[ClientHistoryInfo]]
end
```
## Members
### Properties
#### Public properties
| Type | Name | Methods |
| --- | --- | --- |
| `List`&lt;[`ClientCountSnapshot`](./sharedlibrarycoredtos-ClientCountSnapshot)&gt; | [`ClientCounts`](#clientcounts) | `get, set` |
| `long` | [`ServerId`](#serverid) | `get, set` |
## Details
### Constructors
#### ClientHistoryInfo
```csharp
public ClientHistoryInfo()
```
### Properties
#### ServerId
```csharp
public long ServerId { get; set; }
```
#### ClientCounts
```csharp
public List<ClientCountSnapshot> ClientCounts { get; set; }
```
*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc)

@ -0,0 +1,69 @@
# ClientInfo `Public class`
## Diagram
```mermaid
flowchart LR
classDef interfaceStyle stroke-dasharray: 5 5;
classDef abstractStyle stroke-width:4px
subgraph SharedLibraryCore.Dtos
SharedLibraryCore.Dtos.ClientInfo[[ClientInfo]]
end
```
## Members
### Properties
#### Public properties
| Type | Name | Methods |
| --- | --- | --- |
| `int` | [`ClientId`](#clientid) | `get, set` |
| `Game` | [`Game`](#game) | `get, set` |
| `bool` | [`IsMasked`](#ismasked) | `get, set` |
| `DateTime` | [`LastConnection`](#lastconnection) | `get, set` |
| `Permission` | [`Level`](#level) | `get, set` |
| `int` | [`LinkId`](#linkid) | `get, set` |
| `string` | [`Name`](#name) | `get, set` |
## Details
### Constructors
#### ClientInfo
```csharp
public ClientInfo()
```
### Properties
#### Name
```csharp
public string Name { get; set; }
```
#### ClientId
```csharp
public int ClientId { get; set; }
```
#### LinkId
```csharp
public int LinkId { get; set; }
```
#### Level
```csharp
public Permission Level { get; set; }
```
#### LastConnection
```csharp
public DateTime LastConnection { get; set; }
```
#### Game
```csharp
public Game Game { get; set; }
```
#### IsMasked
```csharp
public bool IsMasked { get; set; }
```
*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc)

@ -0,0 +1,39 @@
# CommandResponseInfo `Public class`
## Diagram
```mermaid
flowchart LR
classDef interfaceStyle stroke-dasharray: 5 5;
classDef abstractStyle stroke-width:4px
subgraph SharedLibraryCore.Dtos
SharedLibraryCore.Dtos.CommandResponseInfo[[CommandResponseInfo]]
end
```
## Members
### Properties
#### Public properties
| Type | Name | Methods |
| --- | --- | --- |
| `int` | [`ClientId`](#clientid) | `get, set` |
| `string` | [`Response`](#response) | `get, set` |
## Details
### Constructors
#### CommandResponseInfo
```csharp
public CommandResponseInfo()
```
### Properties
#### Response
```csharp
public string Response { get; set; }
```
#### ClientId
```csharp
public int ClientId { get; set; }
```
*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc)

@ -0,0 +1,45 @@
# EntityInfo `Public class`
## Description
This class holds the basic info for api entities
## Diagram
```mermaid
flowchart LR
classDef interfaceStyle stroke-dasharray: 5 5;
classDef abstractStyle stroke-width:4px
subgraph SharedLibraryCore.Dtos
SharedLibraryCore.Dtos.EntityInfo[[EntityInfo]]
end
```
## Members
### Properties
#### Public properties
| Type | Name | Methods |
| --- | --- | --- |
| `long` | [`Id`](#id) | `get, set` |
| `string` | [`Name`](#name) | `get, set` |
## Details
### Summary
This class holds the basic info for api entities
### Constructors
#### EntityInfo
```csharp
public EntityInfo()
```
### Properties
#### Id
```csharp
public long Id { get; set; }
```
#### Name
```csharp
public string Name { get; set; }
```
*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc)

@ -0,0 +1,43 @@
# ErrorResponse `Public class`
## Diagram
```mermaid
flowchart LR
classDef interfaceStyle stroke-dasharray: 5 5;
classDef abstractStyle stroke-width:4px
subgraph SharedLibraryCore.Dtos
SharedLibraryCore.Dtos.ErrorResponse[[ErrorResponse]]
end
```
## Members
### Properties
#### Public properties
| Type | Name | Methods |
| --- | --- | --- |
| `string``[]` | [`Messages`](#messages)<br>relevant error messages | `get, set` |
| `string` | [`Type`](#type)<br>todo: type of error | `get, set` |
## Details
### Constructors
#### ErrorResponse
```csharp
public ErrorResponse()
```
### Properties
#### Type
```csharp
public string Type { get; set; }
```
##### Summary
todo: type of error
#### Messages
```csharp
public string Messages { get; set; }
```
##### Summary
relevant error messages
*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc)

@ -0,0 +1,81 @@
# EventInfo `Public class`
## Description
This class wraps the information related to a generated event for the API
## Diagram
```mermaid
flowchart LR
classDef interfaceStyle stroke-dasharray: 5 5;
classDef abstractStyle stroke-width:4px
subgraph SharedLibraryCore.Dtos
SharedLibraryCore.Dtos.EventInfo[[EventInfo]]
end
```
## Members
### Properties
#### Public properties
| Type | Name | Methods |
| --- | --- | --- |
| `DateTime` | [`EventTime`](#eventtime) | `get, set` |
| [`EntityInfo`](./sharedlibrarycoredtos-EntityInfo) | [`EventType`](#eventtype) | `get, set` |
| `string` | [`ExtraInfo`](#extrainfo) | `get, set` |
| [`EntityInfo`](./sharedlibrarycoredtos-EntityInfo) | [`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` |
## Details
### Summary
This class wraps the information related to a generated event for the API
### Constructors
#### EventInfo
```csharp
public EventInfo()
```
### Properties
#### GameInfo
```csharp
public EntityInfo GameInfo { get; set; }
```
#### OriginEntity
```csharp
public EntityInfo OriginEntity { get; set; }
```
#### TargetEntity
```csharp
public EntityInfo TargetEntity { get; set; }
```
#### EventType
```csharp
public EntityInfo EventType { get; set; }
```
#### OwnerEntity
```csharp
public EntityInfo OwnerEntity { get; set; }
```
#### EventTime
```csharp
public DateTime EventTime { get; set; }
```
#### ExtraInfo
```csharp
public string ExtraInfo { get; set; }
```
#### Id
```csharp
public string Id { get; }
```
*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc)

@ -0,0 +1,62 @@
# FindClientRequest `Public class`
## Diagram
```mermaid
flowchart LR
classDef interfaceStyle stroke-dasharray: 5 5;
classDef abstractStyle stroke-width:4px
subgraph SharedLibraryCore.Dtos
SharedLibraryCore.Dtos.FindClientRequest[[FindClientRequest]]
SharedLibraryCore.Dtos.PaginationRequest[[PaginationRequest]]
end
SharedLibraryCore.Dtos.PaginationRequest --> SharedLibraryCore.Dtos.FindClientRequest
```
## Members
### Properties
#### Public properties
| Type | Name | Methods |
| --- | --- | --- |
| `string` | [`Name`](#name)<br>name of client | `get, set` |
| `string` | [`Xuid`](#xuid)<br>network id of client | `get, set` |
### Methods
#### Public methods
| Returns | Name |
| --- | --- |
| `string` | [`ToDebugString`](#todebugstring)() |
## Details
### Inheritance
- [
`PaginationRequest`
](./sharedlibrarycoredtos-PaginationRequest)
### Constructors
#### FindClientRequest
```csharp
public FindClientRequest()
```
### Methods
#### ToDebugString
```csharp
public string ToDebugString()
```
### Properties
#### Name
```csharp
public string Name { get; set; }
```
##### Summary
name of client
#### Xuid
```csharp
public string Xuid { get; set; }
```
##### Summary
network id of client
*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc)

@ -0,0 +1,51 @@
# FindClientResult `Public class`
## Diagram
```mermaid
flowchart LR
classDef interfaceStyle stroke-dasharray: 5 5;
classDef abstractStyle stroke-width:4px
subgraph SharedLibraryCore.Dtos
SharedLibraryCore.Dtos.FindClientResult[[FindClientResult]]
end
```
## Members
### Properties
#### Public properties
| Type | Name | Methods |
| --- | --- | --- |
| `int` | [`ClientId`](#clientid)<br>client identifier | `get, set` |
| `string` | [`Name`](#name)<br>name of client | `get, set` |
| `string` | [`Xuid`](#xuid)<br>networkid of client | `get, set` |
## Details
### Constructors
#### FindClientResult
```csharp
public FindClientResult()
```
### Properties
#### ClientId
```csharp
public int ClientId { get; set; }
```
##### Summary
client identifier
#### Xuid
```csharp
public string Xuid { get; set; }
```
##### Summary
networkid of client
#### Name
```csharp
public string Name { get; set; }
```
##### Summary
name of client
*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc)

@ -0,0 +1,79 @@
# IW4MAdminInfo `Public class`
## Diagram
```mermaid
flowchart LR
classDef interfaceStyle stroke-dasharray: 5 5;
classDef abstractStyle stroke-width:4px
subgraph SharedLibraryCore.Dtos
SharedLibraryCore.Dtos.IW4MAdminInfo[[IW4MAdminInfo]]
end
```
## Members
### Properties
#### Public properties
| Type | Name | Methods |
| --- | --- | --- |
| `Game``[]` | [`ActiveServerGames`](#activeservergames)<br>collection of unique game names being monitored | `get, set` |
| `Nullable`&lt;`Game`&gt; | [`Game`](#game)<br>specifies the game name filter | `get, set` |
| `int` | [`MaxConcurrentClients`](#maxconcurrentclients) | `get, set` |
| `DateTime` | [`MaxConcurrentClientsTime`](#maxconcurrentclientstime) | `get, set` |
| `int` | [`RecentClientCount`](#recentclientcount) | `get, set` |
| `int` | [`TotalAvailableClientSlots`](#totalavailableclientslots) | `get, set` |
| `int` | [`TotalClientCount`](#totalclientcount) | `get, set` |
| `int` | [`TotalOccupiedClientSlots`](#totaloccupiedclientslots) | `get, set` |
## Details
### Constructors
#### IW4MAdminInfo
```csharp
public IW4MAdminInfo()
```
### Properties
#### TotalClientCount
```csharp
public int TotalClientCount { get; set; }
```
#### RecentClientCount
```csharp
public int RecentClientCount { get; set; }
```
#### TotalOccupiedClientSlots
```csharp
public int TotalOccupiedClientSlots { get; set; }
```
#### TotalAvailableClientSlots
```csharp
public int TotalAvailableClientSlots { get; set; }
```
#### MaxConcurrentClients
```csharp
public int MaxConcurrentClients { get; set; }
```
#### MaxConcurrentClientsTime
```csharp
public DateTime MaxConcurrentClientsTime { get; set; }
```
#### Game
```csharp
public Nullable<Game> Game { get; set; }
```
##### Summary
specifies the game name filter
#### ActiveServerGames
```csharp
public Game ActiveServerGames { get; set; }
```
##### Summary
collection of unique game names being monitored
*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc)

@ -0,0 +1,49 @@
# LookupValue&lt;TObject&gt; `Public class`
## Diagram
```mermaid
flowchart LR
classDef interfaceStyle stroke-dasharray: 5 5;
classDef abstractStyle stroke-width:4px
subgraph SharedLibraryCore.Dtos
SharedLibraryCore.Dtos.LookupValue_1[[LookupValue< TObject >]]
end
subgraph SharedLibraryCore.Interfaces
SharedLibraryCore.Interfaces.ILookupValue_1[[ILookupValue< TObject >]]
class SharedLibraryCore.Interfaces.ILookupValue_1 interfaceStyle;
end
SharedLibraryCore.Interfaces.ILookupValue_1 --> SharedLibraryCore.Dtos.LookupValue_1
```
## Members
### Properties
#### Public properties
| Type | Name | Methods |
| --- | --- | --- |
| `int` | [`Id`](#id) | `get, set` |
| `TObject` | [`Value`](#value) | `get, set` |
## Details
### Inheritance
- [`ILookupValue`](./sharedlibrarycoreinterfaces-ILookupValueT)&lt;`TObject`&gt;
### Constructors
#### LookupValue
```csharp
public LookupValue()
```
### Properties
#### Id
```csharp
public int Id { get; set; }
```
#### Value
```csharp
public TObject Value { get; set; }
```
*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc)

@ -0,0 +1,39 @@
# Page `Public class`
## Diagram
```mermaid
flowchart LR
classDef interfaceStyle stroke-dasharray: 5 5;
classDef abstractStyle stroke-width:4px
subgraph SharedLibraryCore.Dtos
SharedLibraryCore.Dtos.Page[[Page]]
end
```
## Members
### Properties
#### Public properties
| Type | Name | Methods |
| --- | --- | --- |
| `string` | [`Location`](#location) | `get, set` |
| `string` | [`Name`](#name) | `get, set` |
## Details
### Constructors
#### Page
```csharp
public Page()
```
### Properties
#### Name
```csharp
public string Name { get; set; }
```
#### Location
```csharp
public string Location { get; set; }
```
*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc)

@ -0,0 +1,77 @@
# PaginationRequest `Public class`
## Description
pagination information holder class
## Diagram
```mermaid
flowchart LR
classDef interfaceStyle stroke-dasharray: 5 5;
classDef abstractStyle stroke-width:4px
subgraph SharedLibraryCore.Dtos
SharedLibraryCore.Dtos.PaginationRequest[[PaginationRequest]]
end
```
## Members
### Properties
#### Public properties
| Type | Name | Methods |
| --- | --- | --- |
| `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` |
| `string` | [`Filter`](#filter)<br>filter query | `get, set` |
| `int` | [`Offset`](#offset)<br>how many items to skip | `get, set` |
## Details
### Summary
pagination information holder class
### Constructors
#### PaginationRequest
```csharp
public PaginationRequest()
```
### Properties
#### Offset
```csharp
public int Offset { get; set; }
```
##### Summary
how many items to skip
#### Count
```csharp
public int Count { get; set; }
```
##### Summary
how many items to take
#### Filter
```csharp
public string Filter { get; set; }
```
##### Summary
filter query
#### Direction
```csharp
public SortDirection Direction { get; set; }
```
##### Summary
direction of ordering
#### Before
```csharp
public Nullable<DateTime> Before { get; set; }
```
#### After
```csharp
public Nullable<DateTime> After { get; set; }
```
*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc)

@ -0,0 +1,172 @@
# PenaltyInfo `Public class`
## Diagram
```mermaid
flowchart LR
classDef interfaceStyle stroke-dasharray: 5 5;
classDef abstractStyle stroke-width:4px
subgraph SharedLibraryCore.Dtos
SharedLibraryCore.Dtos.PenaltyInfo[[PenaltyInfo]]
SharedLibraryCore.Dtos.SharedInfo[[SharedInfo]]
end
SharedLibraryCore.Dtos.SharedInfo --> SharedLibraryCore.Dtos.PenaltyInfo
```
## Members
### Properties
#### Public properties
| Type | Name | Methods |
| --- | --- | --- |
| `string` | [`AdditionalPenaltyInformation`](#additionalpenaltyinformation) | `get` |
| `string` | [`AutomatedOffense`](#automatedoffense) | `get, set` |
| `bool` | [`Expired`](#expired) | `get` |
| `Nullable`&lt;`DateTime`&gt; | [`Expires`](#expires) | `get, set` |
| `bool` | [`IsEvade`](#isevade) | `get, set` |
| `string` | [`OffenderIPAddress`](#offenderipaddress) | `get, set` |
| `int` | [`OffenderId`](#offenderid) | `get, set` |
| `Permission` | [`OffenderLevel`](#offenderlevel) | `get, set` |
| `string` | [`OffenderName`](#offendername) | `get, set` |
| `ulong` | [`OffenderNetworkId`](#offendernetworkid) | `get, set` |
| `string` | [`Offense`](#offense) | `get, set` |
| `PenaltyType` | [`PenaltyType`](#penaltytype) | `get, set` |
| `string` | [`PenaltyTypeText`](#penaltytypetext) | `get` |
| `string` | [`PunisherIPAddress`](#punisheripaddress) | `get, set` |
| `int` | [`PunisherId`](#punisherid) | `get, set` |
| `Permission` | [`PunisherLevel`](#punisherlevel) | `get, set` |
| `string` | [`PunisherLevelText`](#punisherleveltext) | `get` |
| `string` | [`PunisherName`](#punishername) | `get, set` |
| `ulong` | [`PunisherNetworkId`](#punishernetworkid) | `get, set` |
| `bool` | [`Sensitive`](#sensitive) | `get` |
| `DateTime` | [`TimePunished`](#timepunished) | `get, set` |
| `string` | [`TimePunishedString`](#timepunishedstring) | `get` |
| `string` | [`TimeRemaining`](#timeremaining) | `get` |
## Details
### Inheritance
- [
`SharedInfo`
](./sharedlibrarycoredtos-SharedInfo)
### Constructors
#### PenaltyInfo
```csharp
public PenaltyInfo()
```
### Properties
#### OffenderName
```csharp
public string OffenderName { get; set; }
```
#### OffenderLevel
```csharp
public Permission OffenderLevel { get; set; }
```
#### OffenderId
```csharp
public int OffenderId { get; set; }
```
#### OffenderNetworkId
```csharp
public ulong OffenderNetworkId { get; set; }
```
#### OffenderIPAddress
```csharp
public string OffenderIPAddress { get; set; }
```
#### PunisherName
```csharp
public string PunisherName { get; set; }
```
#### PunisherId
```csharp
public int PunisherId { get; set; }
```
#### PunisherNetworkId
```csharp
public ulong PunisherNetworkId { get; set; }
```
#### PunisherIPAddress
```csharp
public string PunisherIPAddress { get; set; }
```
#### PunisherLevel
```csharp
public Permission PunisherLevel { get; set; }
```
#### PunisherLevelText
```csharp
public string PunisherLevelText { get; }
```
#### Offense
```csharp
public string Offense { get; set; }
```
#### AutomatedOffense
```csharp
public string AutomatedOffense { get; set; }
```
#### PenaltyType
```csharp
public PenaltyType PenaltyType { get; set; }
```
#### PenaltyTypeText
```csharp
public string PenaltyTypeText { get; }
```
#### TimePunished
```csharp
public DateTime TimePunished { get; set; }
```
#### TimePunishedString
```csharp
public string TimePunishedString { get; }
```
#### TimeRemaining
```csharp
public string TimeRemaining { get; }
```
#### Expired
```csharp
public bool Expired { get; }
```
#### Expires
```csharp
public Nullable<DateTime> Expires { get; set; }
```
#### Sensitive
```csharp
public override bool Sensitive { get; }
```
#### IsEvade
```csharp
public bool IsEvade { get; set; }
```
#### AdditionalPenaltyInformation
```csharp
public string AdditionalPenaltyInformation { get; }
```
*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc)

@ -0,0 +1,189 @@
# PlayerInfo `Public class`
## Diagram
```mermaid
flowchart LR
classDef interfaceStyle stroke-dasharray: 5 5;
classDef abstractStyle stroke-width:4px
subgraph SharedLibraryCore.Dtos
SharedLibraryCore.Dtos.PlayerInfo[[PlayerInfo]]
end
```
## Members
### Properties
#### Public properties
| Type | Name | Methods |
| --- | --- | --- |
| `EFPenalty` | [`ActivePenalty`](#activepenalty) | `get, set` |
| `string` | [`ActivePenaltyType`](#activepenaltytype) | `get, set` |
| `List`&lt;(`string` Item1, `DateTime` Item2)&gt; | [`Aliases`](#aliases) | `get, set` |
| `bool` | [`Authenticated`](#authenticated) | `get, set` |
| `int` | [`ClientId`](#clientid) | `get, set` |
| `string` | [`ConnectProtocolUrl`](#connectprotocolurl) | `get, set` |
| `string` | [`CurrentServerName`](#currentservername) | `get, set` |
| `Game` | [`Game`](#game) | `get, set` |
| [`IGeoLocationResult`](./sharedlibrarycoreinterfaces-IGeoLocationResult) | [`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` |
| `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` |
| `string` | [`Name`](#name) | `get, set` |
| `long` | [`NetworkId`](#networkid) | `get, set` |
| [`ClientNoteMetaResponse`](./sharedlibrarycoredtosmetaresponses-ClientNoteMetaResponse) | [`NoteMeta`](#notemeta) | `get, set` |
| `bool` | [`Online`](#online) | `get, set` |
| `string` | [`Tag`](#tag) | `get, set` |
| `string` | [`TimeOnline`](#timeonline) | `get, set` |
| `Nullable`&lt;`double`&gt; | [`ZScore`](#zscore) | `get, set` |
## Details
### Constructors
#### PlayerInfo
```csharp
public PlayerInfo()
```
### Properties
#### Name
```csharp
public string Name { get; set; }
```
#### Game
```csharp
public Game Game { get; set; }
```
#### ClientId
```csharp
public int ClientId { get; set; }
```
#### Level
```csharp
public string Level { get; set; }
```
#### Tag
```csharp
public string Tag { get; set; }
```
#### LevelInt
```csharp
public int LevelInt { get; set; }
```
#### IPAddress
```csharp
public string IPAddress { get; set; }
```
#### NetworkId
```csharp
public long NetworkId { get; set; }
```
#### Aliases
```csharp
public List<(string Item1, DateTime Item2)> Aliases { get; set; }
```
#### IPs
```csharp
public List<(string Item1, DateTime Item2)> IPs { get; set; }
```
#### HasActivePenalty
```csharp
public bool HasActivePenalty { get; set; }
```
#### ActivePenaltyType
```csharp
public string ActivePenaltyType { get; set; }
```
#### Authenticated
```csharp
public bool Authenticated { get; set; }
```
#### Meta
```csharp
public List<InformationResponse> Meta { get; set; }
```
#### ActivePenalty
```csharp
public EFPenalty ActivePenalty { get; set; }
```
#### Online
```csharp
public bool Online { get; set; }
```
#### TimeOnline
```csharp
public string TimeOnline { get; set; }
```
#### LastConnection
```csharp
public DateTime LastConnection { get; set; }
```
#### LastConnectionText
```csharp
public string LastConnectionText { get; }
```
#### LinkedAccounts
```csharp
public IDictionary<int, long> LinkedAccounts { get; set; }
```
#### MetaFilterType
```csharp
public Nullable<MetaType> MetaFilterType { get; set; }
```
#### ZScore
```csharp
public Nullable<double> ZScore { get; set; }
```
#### ConnectProtocolUrl
```csharp
public string ConnectProtocolUrl { get; set; }
```
#### CurrentServerName
```csharp
public string CurrentServerName { get; set; }
```
#### GeoLocationInfo
```csharp
public IGeoLocationResult GeoLocationInfo { get; set; }
```
#### NoteMeta
```csharp
public ClientNoteMetaResponse NoteMeta { get; set; }
```
#### Interactions
```csharp
public List<IInteractionData> Interactions { get; set; }
```
*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc)

@ -0,0 +1,147 @@
# ServerInfo `Public class`
## Diagram
```mermaid
flowchart LR
classDef interfaceStyle stroke-dasharray: 5 5;
classDef abstractStyle stroke-width:4px
subgraph SharedLibraryCore.Dtos
SharedLibraryCore.Dtos.ServerInfo[[ServerInfo]]
end
```
## Members
### Properties
#### Public properties
| Type | Name | Methods |
| --- | --- | --- |
| `List`&lt;[`ChatInfo`](./sharedlibrarycoredtos-ChatInfo)&gt; | [`ChatHistory`](#chathistory) | `get, set` |
| `int` | [`ClientCount`](#clientcount) | `get, set` |
| [`ClientHistoryInfo`](./sharedlibrarycoredtos-ClientHistoryInfo) | [`ClientHistory`](#clienthistory) | `get, set` |
| `string` | [`ConnectProtocolUrl`](#connectprotocolurl) | `get, set` |
| `string` | [`Endpoint`](#endpoint) | `get` |
| `string` | [`ExternalIPAddress`](#externalipaddress) | `get, set` |
| `Game` | [`Game`](#game) | `get, set` |
| `string` | [`GameType`](#gametype) | `get, set` |
| `long` | [`ID`](#id) | `get, set` |
| `string` | [`IPAddress`](#ipaddress) | `get, set` |
| `bool` | [`IsPasswordProtected`](#ispasswordprotected) | `get, set` |
| `Nullable`&lt;`double`&gt; | [`LobbyZScore`](#lobbyzscore) | `get` |
| `string` | [`Map`](#map) | `get, set` |
| `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` |
| `int` | [`Port`](#port) | `get, set` |
| `int` | [`PrivateClientSlots`](#privateclientslots) | `get, set` |
| `List`&lt;[`Report`](./sharedlibrarycorehelpers-Report)&gt; | [`Reports`](#reports) | `get, set` |
## Details
### Constructors
#### ServerInfo
```csharp
public ServerInfo()
```
### Properties
#### Name
```csharp
public string Name { get; set; }
```
#### Port
```csharp
public int Port { get; set; }
```
#### Map
```csharp
public string Map { get; set; }
```
#### GameType
```csharp
public string GameType { get; set; }
```
#### ClientCount
```csharp
public int ClientCount { get; set; }
```
#### MaxClients
```csharp
public int MaxClients { get; set; }
```
#### PrivateClientSlots
```csharp
public int PrivateClientSlots { get; set; }
```
#### ChatHistory
```csharp
public List<ChatInfo> ChatHistory { get; set; }
```
#### Players
```csharp
public List<PlayerInfo> Players { get; set; }
```
#### Reports
```csharp
public List<Report> Reports { get; set; }
```
#### ClientHistory
```csharp
public ClientHistoryInfo ClientHistory { get; set; }
```
#### ID
```csharp
public long ID { get; set; }
```
#### Online
```csharp
public bool Online { get; set; }
```
#### ConnectProtocolUrl
```csharp
public string ConnectProtocolUrl { get; set; }
```
#### IPAddress
```csharp
public string IPAddress { get; set; }
```
#### ExternalIPAddress
```csharp
public string ExternalIPAddress { get; set; }
```
#### IsPasswordProtected
```csharp
public bool IsPasswordProtected { get; set; }
```
#### Endpoint
```csharp
public string Endpoint { get; }
```
#### LobbyZScore
```csharp
public Nullable<double> LobbyZScore { get; }
```
#### Game
```csharp
public Game Game { get; set; }
```
*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc)

@ -0,0 +1,45 @@
# SharedInfo `Public class`
## Diagram
```mermaid
flowchart LR
classDef interfaceStyle stroke-dasharray: 5 5;
classDef abstractStyle stroke-width:4px
subgraph SharedLibraryCore.Dtos
SharedLibraryCore.Dtos.SharedInfo[[SharedInfo]]
end
```
## Members
### Properties
#### Public properties
| Type | Name | Methods |
| --- | --- | --- |
| `int` | [`Id`](#id) | `get, set` |
| `bool` | [`Sensitive`](#sensitive) | `get, set` |
| `bool` | [`Show`](#show) | `get, set` |
## Details
### Constructors
#### SharedInfo
```csharp
public SharedInfo()
```
### Properties
#### Sensitive
```csharp
public virtual bool Sensitive { get; set; }
```
#### Show
```csharp
public bool Show { get; set; }
```
#### Id
```csharp
public int Id { get; set; }
```
*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc)

@ -0,0 +1,21 @@
# SortDirection `Public enum`
## Diagram
```mermaid
flowchart LR
classDef interfaceStyle stroke-dasharray: 5 5;
classDef abstractStyle stroke-width:4px
subgraph SharedLibraryCore.Dtos
SharedLibraryCore.Dtos.SortDirection[[SortDirection]]
end
```
## Details
### Fields
#### Ascending
#### Descending
*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc)

@ -0,0 +1,45 @@
# WebfrontTranslationHelper `Public class`
## Diagram
```mermaid
flowchart LR
classDef interfaceStyle stroke-dasharray: 5 5;
classDef abstractStyle stroke-width:4px
subgraph SharedLibraryCore.Dtos.Meta
SharedLibraryCore.Dtos.Meta.WebfrontTranslationHelper[[WebfrontTranslationHelper]]
end
```
## Members
### Properties
#### Public properties
| Type | Name | Methods |
| --- | --- | --- |
| `bool` | [`IsInterpolation`](#isinterpolation) | `get, set` |
| `string` | [`MatchValue`](#matchvalue) | `get, set` |
| `string` | [`TranslationValue`](#translationvalue) | `get, set` |
## Details
### Constructors
#### WebfrontTranslationHelper
```csharp
public WebfrontTranslationHelper()
```
### Properties
#### IsInterpolation
```csharp
public bool IsInterpolation { get; set; }
```
#### MatchValue
```csharp
public string MatchValue { get; set; }
```
#### TranslationValue
```csharp
public string TranslationValue { get; set; }
```
*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc)

@ -0,0 +1,42 @@
# BaseClientMetaRequest `Public class`
## Diagram
```mermaid
flowchart LR
classDef interfaceStyle stroke-dasharray: 5 5;
classDef abstractStyle stroke-width:4px
subgraph SharedLibraryCore.Dtos.Meta.Requests
SharedLibraryCore.Dtos.Meta.Requests.BaseClientMetaRequest[[BaseClientMetaRequest]]
end
subgraph SharedLibraryCore.Dtos
SharedLibraryCore.Dtos.PaginationRequest[[PaginationRequest]]
end
SharedLibraryCore.Dtos.PaginationRequest --> SharedLibraryCore.Dtos.Meta.Requests.BaseClientMetaRequest
```
## Members
### Properties
#### Public properties
| Type | Name | Methods |
| --- | --- | --- |
| `int` | [`ClientId`](#clientid) | `get, set` |
## Details
### Inheritance
- [
`PaginationRequest`
](./sharedlibrarycoredtos-PaginationRequest)
### Constructors
#### BaseClientMetaRequest
```csharp
public BaseClientMetaRequest()
```
### Properties
#### ClientId
```csharp
public int ClientId { get; set; }
```
*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc)

@ -0,0 +1,27 @@
# ReceivedPenaltyRequest `Public class`
## Diagram
```mermaid
flowchart LR
classDef interfaceStyle stroke-dasharray: 5 5;
classDef abstractStyle stroke-width:4px
subgraph SharedLibraryCore.Dtos.Meta.Requests
SharedLibraryCore.Dtos.Meta.Requests.ReceivedPenaltyRequest[[ReceivedPenaltyRequest]]
SharedLibraryCore.Dtos.Meta.Requests.BaseClientMetaRequest[[BaseClientMetaRequest]]
end
SharedLibraryCore.Dtos.Meta.Requests.BaseClientMetaRequest --> SharedLibraryCore.Dtos.Meta.Requests.ReceivedPenaltyRequest
```
## Details
### Inheritance
- [
`BaseClientMetaRequest`
](./sharedlibrarycoredtosmetarequests-BaseClientMetaRequest)
### Constructors
#### ReceivedPenaltyRequest
```csharp
public ReceivedPenaltyRequest()
```
*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc)

@ -0,0 +1,27 @@
# AdministeredPenaltyResponse `Public class`
## Diagram
```mermaid
flowchart LR
classDef interfaceStyle stroke-dasharray: 5 5;
classDef abstractStyle stroke-width:4px
subgraph SharedLibraryCore.Dtos.Meta.Responses
SharedLibraryCore.Dtos.Meta.Responses.AdministeredPenaltyResponse[[AdministeredPenaltyResponse]]
SharedLibraryCore.Dtos.Meta.Responses.ReceivedPenaltyResponse[[ReceivedPenaltyResponse]]
end
SharedLibraryCore.Dtos.Meta.Responses.ReceivedPenaltyResponse --> SharedLibraryCore.Dtos.Meta.Responses.AdministeredPenaltyResponse
```
## Details
### Inheritance
- [
`ReceivedPenaltyResponse`
](./sharedlibrarycoredtosmetaresponses-ReceivedPenaltyResponse)
### Constructors
#### AdministeredPenaltyResponse
```csharp
public AdministeredPenaltyResponse()
```
*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc)

@ -0,0 +1,91 @@
# BaseMetaResponse `Public class`
## Diagram
```mermaid
flowchart LR
classDef interfaceStyle stroke-dasharray: 5 5;
classDef abstractStyle stroke-width:4px
subgraph SharedLibraryCore.Dtos.Meta.Responses
SharedLibraryCore.Dtos.Meta.Responses.BaseMetaResponse[[BaseMetaResponse]]
end
subgraph SharedLibraryCore.Interfaces
SharedLibraryCore.Interfaces.IClientMeta[[IClientMeta]]
class SharedLibraryCore.Interfaces.IClientMeta interfaceStyle;
SharedLibraryCore.Interfaces.IClientMetaResponse[[IClientMetaResponse]]
class SharedLibraryCore.Interfaces.IClientMetaResponse interfaceStyle;
end
SharedLibraryCore.Interfaces.IClientMeta --> SharedLibraryCore.Dtos.Meta.Responses.BaseMetaResponse
SharedLibraryCore.Interfaces.IClientMetaResponse --> SharedLibraryCore.Dtos.Meta.Responses.BaseMetaResponse
```
## Members
### Properties
#### Public properties
| Type | Name | Methods |
| --- | --- | --- |
| `int` | [`ClientId`](#clientid) | `get, set` |
| `Nullable`&lt;`int`&gt; | [`Column`](#column) | `get, set` |
| `bool` | [`IsSensitive`](#issensitive) | `get, set` |
| `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` |
| `DateTime` | [`When`](#when) | `get, set` |
## Details
### Inheritance
- [
`IClientMeta`
](./sharedlibrarycoreinterfaces-IClientMeta)
- [
`IClientMetaResponse`
](./sharedlibrarycoreinterfaces-IClientMetaResponse)
### Constructors
#### BaseMetaResponse
```csharp
public BaseMetaResponse()
```
### Properties
#### Type
```csharp
public MetaType Type { get; set; }
```
#### When
```csharp
public DateTime When { get; set; }
```
#### IsSensitive
```csharp
public bool IsSensitive { get; set; }
```
#### ShouldDisplay
```csharp
public bool ShouldDisplay { get; set; }
```
#### Column
```csharp
public virtual Nullable<int> Column { get; set; }
```
#### Order
```csharp
public virtual Nullable<int> Order { get; set; }
```
#### MetaId
```csharp
public long MetaId { get; set; }
```
#### ClientId
```csharp
public int ClientId { get; set; }
```
*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc)

@ -0,0 +1,51 @@
# ClientNoteMetaResponse `Public class`
## Diagram
```mermaid
flowchart LR
classDef interfaceStyle stroke-dasharray: 5 5;
classDef abstractStyle stroke-width:4px
subgraph SharedLibraryCore.Dtos.Meta.Responses
SharedLibraryCore.Dtos.Meta.Responses.ClientNoteMetaResponse[[ClientNoteMetaResponse]]
end
```
## Members
### Properties
#### Public properties
| Type | Name | Methods |
| --- | --- | --- |
| `DateTime` | [`ModifiedDate`](#modifieddate) | `get, set` |
| `string` | [`Note`](#note) | `get, set` |
| `int` | [`OriginEntityId`](#originentityid) | `get, set` |
| `string` | [`OriginEntityName`](#originentityname) | `get, set` |
## Details
### Constructors
#### ClientNoteMetaResponse
```csharp
public ClientNoteMetaResponse()
```
### Properties
#### Note
```csharp
public string Note { get; set; }
```
#### OriginEntityId
```csharp
public int OriginEntityId { get; set; }
```
#### OriginEntityName
```csharp
public string OriginEntityName { get; set; }
```
#### ModifiedDate
```csharp
public DateTime ModifiedDate { get; set; }
```
*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc)

@ -0,0 +1,46 @@
# ConnectionHistoryResponse `Public class`
## Diagram
```mermaid
flowchart LR
classDef interfaceStyle stroke-dasharray: 5 5;
classDef abstractStyle stroke-width:4px
subgraph SharedLibraryCore.Dtos.Meta.Responses
SharedLibraryCore.Dtos.Meta.Responses.ConnectionHistoryResponse[[ConnectionHistoryResponse]]
SharedLibraryCore.Dtos.Meta.Responses.BaseMetaResponse[[BaseMetaResponse]]
end
SharedLibraryCore.Dtos.Meta.Responses.BaseMetaResponse --> SharedLibraryCore.Dtos.Meta.Responses.ConnectionHistoryResponse
```
## Members
### Properties
#### Public properties
| Type | Name | Methods |
| --- | --- | --- |
| `ConnectionType` | [`ConnectionType`](#connectiontype) | `get, set` |
| `string` | [`ServerName`](#servername) | `get, set` |
## Details
### Inheritance
- [
`BaseMetaResponse`
](./sharedlibrarycoredtosmetaresponses-BaseMetaResponse)
### Constructors
#### ConnectionHistoryResponse
```csharp
public ConnectionHistoryResponse()
```
### Properties
#### ServerName
```csharp
public string ServerName { get; set; }
```
#### ConnectionType
```csharp
public ConnectionType ConnectionType { get; set; }
```
*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc)

@ -0,0 +1,52 @@
# InformationResponse `Public class`
## Diagram
```mermaid
flowchart LR
classDef interfaceStyle stroke-dasharray: 5 5;
classDef abstractStyle stroke-width:4px
subgraph SharedLibraryCore.Dtos.Meta.Responses
SharedLibraryCore.Dtos.Meta.Responses.InformationResponse[[InformationResponse]]
SharedLibraryCore.Dtos.Meta.Responses.BaseMetaResponse[[BaseMetaResponse]]
end
SharedLibraryCore.Dtos.Meta.Responses.BaseMetaResponse --> SharedLibraryCore.Dtos.Meta.Responses.InformationResponse
```
## Members
### Properties
#### Public properties
| Type | Name | Methods |
| --- | --- | --- |
| `string` | [`Key`](#key) | `get, set` |
| `string` | [`ToolTipText`](#tooltiptext) | `get, set` |
| `string` | [`Value`](#value) | `get, set` |
## Details
### Inheritance
- [
`BaseMetaResponse`
](./sharedlibrarycoredtosmetaresponses-BaseMetaResponse)
### Constructors
#### InformationResponse
```csharp
public InformationResponse()
```
### Properties
#### Key
```csharp
public string Key { get; set; }
```
#### Value
```csharp
public string Value { get; set; }
```
#### ToolTipText
```csharp
public string ToolTipText { get; set; }
```
*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc)

@ -0,0 +1,98 @@
# MessageResponse `Public class`
## Diagram
```mermaid
flowchart LR
classDef interfaceStyle stroke-dasharray: 5 5;
classDef abstractStyle stroke-width:4px
subgraph SharedLibraryCore.Dtos.Meta.Responses
SharedLibraryCore.Dtos.Meta.Responses.MessageResponse[[MessageResponse]]
SharedLibraryCore.Dtos.Meta.Responses.BaseMetaResponse[[BaseMetaResponse]]
end
SharedLibraryCore.Dtos.Meta.Responses.BaseMetaResponse --> SharedLibraryCore.Dtos.Meta.Responses.MessageResponse
```
## Members
### Properties
#### Public properties
| Type | Name | Methods |
| --- | --- | --- |
| `string` | [`ClientName`](#clientname)<br>name of the client | `get, set` |
| `Game` | [`GameName`](#gamename)<br>specifies the game the chat occured on | `get, set` |
| `string` | [`HiddenMessage`](#hiddenmessage) | `get` |
| `bool` | [`IsHidden`](#ishidden) | `get, set` |
| `bool` | [`IsQuickMessage`](#isquickmessage)<br>indicates if the chat message is a quick message phrase | `get, set` |
| `string` | [`Message`](#message) | `get, set` |
| `bool` | [`SentIngame`](#sentingame)<br>indicates if the message was sent ingame | `get, set` |
| `long` | [`ServerId`](#serverid) | `get, set` |
| `string` | [`ServerName`](#servername)<br>hostname of the server | `get, set` |
## Details
### Inheritance
- [
`BaseMetaResponse`
](./sharedlibrarycoredtosmetaresponses-BaseMetaResponse)
### Constructors
#### MessageResponse
```csharp
public MessageResponse()
```
### Properties
#### ServerId
```csharp
public long ServerId { get; set; }
```
#### Message
```csharp
public string Message { get; set; }
```
#### IsHidden
```csharp
public bool IsHidden { get; set; }
```
#### ClientName
```csharp
public string ClientName { get; set; }
```
##### Summary
name of the client
#### ServerName
```csharp
public string ServerName { get; set; }
```
##### Summary
hostname of the server
#### GameName
```csharp
public Game GameName { get; set; }
```
##### Summary
specifies the game the chat occured on
#### IsQuickMessage
```csharp
public bool IsQuickMessage { get; set; }
```
##### Summary
indicates if the chat message is a quick message phrase
#### SentIngame
```csharp
public bool SentIngame { get; set; }
```
##### Summary
indicates if the message was sent ingame
#### HiddenMessage
```csharp
public string HiddenMessage { get; }
```
*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc)

@ -0,0 +1,70 @@
# PermissionLevelChangedResponse `Public class`
## Diagram
```mermaid
flowchart LR
classDef interfaceStyle stroke-dasharray: 5 5;
classDef abstractStyle stroke-width:4px
subgraph SharedLibraryCore.Dtos.Meta.Responses
SharedLibraryCore.Dtos.Meta.Responses.PermissionLevelChangedResponse[[PermissionLevelChangedResponse]]
SharedLibraryCore.Dtos.Meta.Responses.BaseMetaResponse[[BaseMetaResponse]]
end
SharedLibraryCore.Dtos.Meta.Responses.BaseMetaResponse --> SharedLibraryCore.Dtos.Meta.Responses.PermissionLevelChangedResponse
```
## Members
### Properties
#### Public properties
| Type | Name | Methods |
| --- | --- | --- |
| `int` | [`ChangedById`](#changedbyid) | `get, set` |
| `string` | [`ChangedByName`](#changedbyname) | `get, set` |
| `Permission` | [`CurrentPermissionLevel`](#currentpermissionlevel) | `get` |
| `string` | [`CurrentPermissionLevelValue`](#currentpermissionlevelvalue) | `get, set` |
| `Permission` | [`PreviousPermissionLevel`](#previouspermissionlevel) | `get` |
| `string` | [`PreviousPermissionLevelValue`](#previouspermissionlevelvalue) | `get, set` |
## Details
### Inheritance
- [
`BaseMetaResponse`
](./sharedlibrarycoredtosmetaresponses-BaseMetaResponse)
### Constructors
#### PermissionLevelChangedResponse
```csharp
public PermissionLevelChangedResponse()
```
### Properties
#### PreviousPermissionLevel
```csharp
public Permission PreviousPermissionLevel { get; }
```
#### PreviousPermissionLevelValue
```csharp
public string PreviousPermissionLevelValue { get; set; }
```
#### CurrentPermissionLevel
```csharp
public Permission CurrentPermissionLevel { get; }
```
#### CurrentPermissionLevelValue
```csharp
public string CurrentPermissionLevelValue { get; set; }
```
#### ChangedById
```csharp
public int ChangedById { get; set; }
```
#### ChangedByName
```csharp
public string ChangedByName { get; set; }
```
*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc)

@ -0,0 +1,112 @@
# ReceivedPenaltyResponse `Public class`
## Diagram
```mermaid
flowchart LR
classDef interfaceStyle stroke-dasharray: 5 5;
classDef abstractStyle stroke-width:4px
subgraph SharedLibraryCore.Dtos.Meta.Responses
SharedLibraryCore.Dtos.Meta.Responses.ReceivedPenaltyResponse[[ReceivedPenaltyResponse]]
SharedLibraryCore.Dtos.Meta.Responses.BaseMetaResponse[[BaseMetaResponse]]
end
SharedLibraryCore.Dtos.Meta.Responses.BaseMetaResponse --> SharedLibraryCore.Dtos.Meta.Responses.ReceivedPenaltyResponse
```
## Members
### Properties
#### Public properties
| Type | Name | Methods |
| --- | --- | --- |
| `string` | [`AutomatedOffense`](#automatedoffense) | `get, set` |
| `Nullable`&lt;`DateTime`&gt; | [`ExpirationDate`](#expirationdate) | `get, set` |
| `string` | [`ExpiresInText`](#expiresintext) | `get` |
| `bool` | [`IsLinked`](#islinked) | `get, set` |
| `string` | [`LengthText`](#lengthtext) | `get` |
| `int` | [`LinkedClientId`](#linkedclientid) | `get, set` |
| `int` | [`OffenderClientId`](#offenderclientid) | `get, set` |
| `string` | [`OffenderName`](#offendername) | `get, set` |
| `string` | [`Offense`](#offense) | `get, set` |
| `int` | [`PenaltyId`](#penaltyid) | `get, set` |
| `PenaltyType` | [`PenaltyType`](#penaltytype) | `get, set` |
| `int` | [`PunisherClientId`](#punisherclientid) | `get, set` |
| `string` | [`PunisherName`](#punishername) | `get, set` |
## Details
### Inheritance
- [
`BaseMetaResponse`
](./sharedlibrarycoredtosmetaresponses-BaseMetaResponse)
### Constructors
#### ReceivedPenaltyResponse
```csharp
public ReceivedPenaltyResponse()
```
### Properties
#### PenaltyId
```csharp
public int PenaltyId { get; set; }
```
#### OffenderClientId
```csharp
public int OffenderClientId { get; set; }
```
#### OffenderName
```csharp
public string OffenderName { get; set; }
```
#### PunisherName
```csharp
public string PunisherName { get; set; }
```
#### PunisherClientId
```csharp
public int PunisherClientId { get; set; }
```
#### PenaltyType
```csharp
public PenaltyType PenaltyType { get; set; }
```
#### Offense
```csharp
public string Offense { get; set; }
```
#### AutomatedOffense
```csharp
public string AutomatedOffense { get; set; }
```
#### ExpirationDate
```csharp
public Nullable<DateTime> ExpirationDate { get; set; }
```
#### ExpiresInText
```csharp
public string ExpiresInText { get; }
```
#### LengthText
```csharp
public string LengthText { get; }
```
#### IsLinked
```csharp
public bool IsLinked { get; set; }
```
#### LinkedClientId
```csharp
public int LinkedClientId { get; set; }
```
*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc)

@ -0,0 +1,68 @@
# UpdatedAliasResponse `Public class`
## Diagram
```mermaid
flowchart LR
classDef interfaceStyle stroke-dasharray: 5 5;
classDef abstractStyle stroke-width:4px
subgraph SharedLibraryCore.Dtos.Meta.Responses
SharedLibraryCore.Dtos.Meta.Responses.UpdatedAliasResponse[[UpdatedAliasResponse]]
SharedLibraryCore.Dtos.Meta.Responses.BaseMetaResponse[[BaseMetaResponse]]
end
SharedLibraryCore.Dtos.Meta.Responses.BaseMetaResponse --> SharedLibraryCore.Dtos.Meta.Responses.UpdatedAliasResponse
```
## Members
### Properties
#### Public properties
| Type | Name | Methods |
| --- | --- | --- |
| `string` | [`IPAddress`](#ipaddress) | `get, set` |
| `string` | [`Name`](#name) | `get, set` |
### Methods
#### Public methods
| Returns | Name |
| --- | --- |
| `bool` | [`Equals`](#equals)(`object` obj) |
| `int` | [`GetHashCode`](#gethashcode)() |
## Details
### Inheritance
- [
`BaseMetaResponse`
](./sharedlibrarycoredtosmetaresponses-BaseMetaResponse)
### Constructors
#### UpdatedAliasResponse
```csharp
public UpdatedAliasResponse()
```
### Methods
#### Equals
```csharp
public override bool Equals(object obj)
```
##### Arguments
| Type | Name | Description |
| --- | --- | --- |
| `object` | obj | |
#### GetHashCode
```csharp
public override int GetHashCode()
```
### Properties
#### Name
```csharp
public string Name { get; set; }
```
#### IPAddress
```csharp
public string IPAddress { get; set; }
```
*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc)

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