Add folder structure for documentation
parent
a0d240460b
commit
20ed2571c4
@ -19,15 +19,15 @@ Microsoft.AspNetCore.Mvc.Controller --> SharedLibraryCore.BaseController
|
|||||||
#### Protected properties
|
#### Protected properties
|
||||||
| Type | Name | Methods |
|
| Type | Name | Methods |
|
||||||
| --- | --- | --- |
|
| --- | --- | --- |
|
||||||
| [`ApplicationConfiguration`](./sharedlibrarycoreconfiguration-ApplicationConfiguration) | [`AppConfig`](#appconfig) | `get` |
|
| [`ApplicationConfiguration`](configuration/ApplicationConfiguration.md) | [`AppConfig`](#appconfig) | `get` |
|
||||||
| `bool` | [`Authorized`](#authorized) | `get, set` |
|
| `bool` | [`Authorized`](#authorized) | `get, set` |
|
||||||
| [`EFClient`](./sharedlibrarycoredatabasemodels-EFClient) | [`Client`](#client) | `get` |
|
| [`EFClient`](database/models/EFClient.md) | [`Client`](#client) | `get` |
|
||||||
| [`TranslationLookup`](./sharedlibrarycorelocalization-TranslationLookup) | [`Localization`](#localization) | `get` |
|
| [`TranslationLookup`](localization/TranslationLookup.md) | [`Localization`](#localization) | `get` |
|
||||||
|
|
||||||
#### Public properties
|
#### Public properties
|
||||||
| Type | Name | Methods |
|
| Type | Name | Methods |
|
||||||
| --- | --- | --- |
|
| --- | --- | --- |
|
||||||
| [`IManager`](./sharedlibrarycoreinterfaces-IManager) | [`Manager`](#manager) | `get` |
|
| [`IManager`](interfaces/IManager.md) | [`Manager`](#manager) | `get` |
|
||||||
|
|
||||||
### Methods
|
### Methods
|
||||||
#### Protected methods
|
#### Protected methods
|
||||||
@ -46,13 +46,14 @@ Microsoft.AspNetCore.Mvc.Controller --> SharedLibraryCore.BaseController
|
|||||||
|
|
||||||
### Constructors
|
### Constructors
|
||||||
#### BaseController
|
#### BaseController
|
||||||
|
[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/BaseController.cs#L43)
|
||||||
```csharp
|
```csharp
|
||||||
public BaseController(IManager manager)
|
public BaseController(IManager manager)
|
||||||
```
|
```
|
||||||
##### Arguments
|
##### Arguments
|
||||||
| Type | Name | Description |
|
| Type | Name | Description |
|
||||||
| --- | --- | --- |
|
| --- | --- | --- |
|
||||||
| [`IManager`](./sharedlibrarycoreinterfaces-IManager) | manager | |
|
| [`IManager`](interfaces/IManager.md) | manager | |
|
||||||
|
|
||||||
### Methods
|
### Methods
|
||||||
#### SignInAsync
|
#### SignInAsync
|
@ -33,16 +33,18 @@ Microsoft.AspNetCore.Razor.TagHelpers.TagHelper --> SharedLibraryCore.ColorCode
|
|||||||
|
|
||||||
### Constructors
|
### Constructors
|
||||||
#### ColorCode
|
#### ColorCode
|
||||||
|
[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/TagHelpers/ColorCode.cs#L13)
|
||||||
```csharp
|
```csharp
|
||||||
public ColorCode(ApplicationConfiguration appConfig)
|
public ColorCode(ApplicationConfiguration appConfig)
|
||||||
```
|
```
|
||||||
##### Arguments
|
##### Arguments
|
||||||
| Type | Name | Description |
|
| Type | Name | Description |
|
||||||
| --- | --- | --- |
|
| --- | --- | --- |
|
||||||
| [`ApplicationConfiguration`](./sharedlibrarycoreconfiguration-ApplicationConfiguration) | appConfig | |
|
| [`ApplicationConfiguration`](configuration/ApplicationConfiguration.md) | appConfig | |
|
||||||
|
|
||||||
### Methods
|
### Methods
|
||||||
#### Process
|
#### Process
|
||||||
|
[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/TagHelpers/ColorCode.cs#L21)
|
||||||
```csharp
|
```csharp
|
||||||
public override void Process(TagHelperContext context, TagHelperOutput output)
|
public override void Process(TagHelperContext context, TagHelperOutput output)
|
||||||
```
|
```
|
@ -26,7 +26,7 @@ SharedLibraryCore.Interfaces.IManagerCommand --> SharedLibraryCore.Command
|
|||||||
| --- | --- | --- |
|
| --- | --- | --- |
|
||||||
| `string` | [`Alias`](#alias)<br>Alternate name for this command to be executed by | `get, protected set` |
|
| `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` |
|
| `bool` | [`AllowImpersonation`](#allowimpersonation)<br>indicates if this command allows impersonation (run as) | `get, set` |
|
||||||
| [`CommandArgument`](./sharedlibrarycorecommands-CommandArgument)`[]` | [`Arguments`](#arguments)<br>Argument list for the command | `get, protected set` |
|
| [`CommandArgument`](commands/CommandArgument.md)`[]` | [`Arguments`](#arguments)<br>Argument list for the command | `get, protected set` |
|
||||||
| `string` | [`Description`](#description)<br>Specifies the command description | `get, protected set` |
|
| `string` | [`Description`](#description)<br>Specifies the command description | `get, protected set` |
|
||||||
| `bool` | [`IsBroadcast`](#isbroadcast) | `get, set` |
|
| `bool` | [`IsBroadcast`](#isbroadcast) | `get, set` |
|
||||||
| `string` | [`Name`](#name)<br>Specifies the name and string that triggers the command | `get, protected set` |
|
| `string` | [`Name`](#name)<br>Specifies the name and string that triggers the command | `get, protected set` |
|
||||||
@ -40,7 +40,7 @@ SharedLibraryCore.Interfaces.IManagerCommand --> SharedLibraryCore.Command
|
|||||||
#### Public methods
|
#### Public methods
|
||||||
| Returns | Name |
|
| Returns | Name |
|
||||||
| --- | --- |
|
| --- | --- |
|
||||||
| `Task` | [`ExecuteAsync`](#executeasync)([`GameEvent`](./sharedlibrarycore-GameEvent) gameEvent)<br>Executes the command |
|
| `Task` | [`ExecuteAsync`](#executeasync)([`GameEvent`](./GameEvent.md) gameEvent)<br>Executes the command |
|
||||||
|
|
||||||
## Details
|
## Details
|
||||||
### Summary
|
### Summary
|
||||||
@ -49,18 +49,19 @@ Abstract class for command
|
|||||||
### Inheritance
|
### Inheritance
|
||||||
- [
|
- [
|
||||||
`IManagerCommand`
|
`IManagerCommand`
|
||||||
](./sharedlibrarycoreinterfaces-IManagerCommand)
|
](interfaces/IManagerCommand.md)
|
||||||
|
|
||||||
### Constructors
|
### Constructors
|
||||||
#### Command
|
#### Command
|
||||||
|
[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Command.cs#L42)
|
||||||
```csharp
|
```csharp
|
||||||
public Command(CommandConfiguration config, ITranslationLookup layout)
|
public Command(CommandConfiguration config, ITranslationLookup layout)
|
||||||
```
|
```
|
||||||
##### Arguments
|
##### Arguments
|
||||||
| Type | Name | Description |
|
| Type | Name | Description |
|
||||||
| --- | --- | --- |
|
| --- | --- | --- |
|
||||||
| [`CommandConfiguration`](./sharedlibrarycoreconfiguration-CommandConfiguration) | config | |
|
| [`CommandConfiguration`](configuration/CommandConfiguration.md) | config | |
|
||||||
| [`ITranslationLookup`](./sharedlibrarycoreinterfaces-ITranslationLookup) | layout | |
|
| [`ITranslationLookup`](interfaces/ITranslationLookup.md) | layout | |
|
||||||
|
|
||||||
### Methods
|
### Methods
|
||||||
#### ExecuteAsync
|
#### ExecuteAsync
|
||||||
@ -70,7 +71,7 @@ public abstract Task ExecuteAsync(GameEvent gameEvent)
|
|||||||
##### Arguments
|
##### Arguments
|
||||||
| Type | Name | Description |
|
| Type | Name | Description |
|
||||||
| --- | --- | --- |
|
| --- | --- | --- |
|
||||||
| [`GameEvent`](./sharedlibrarycore-GameEvent) | gameEvent | |
|
| [`GameEvent`](./GameEvent.md) | gameEvent | |
|
||||||
|
|
||||||
##### Summary
|
##### Summary
|
||||||
Executes the command
|
Executes the command
|
@ -24,7 +24,7 @@ SharedLibraryCore.Events.CoreEvent --> SharedLibraryCore.GameEvent
|
|||||||
| `EventFailReason` | [`FailReason`](#failreason) | `get, set` |
|
| `EventFailReason` | [`FailReason`](#failreason) | `get, set` |
|
||||||
| `bool` | [`Failed`](#failed) | `get` |
|
| `bool` | [`Failed`](#failed) | `get` |
|
||||||
| `Nullable`<`long`> | [`GameTime`](#gametime)<br>Specifies the game time offset as printed in the log | `get, set` |
|
| `Nullable`<`long`> | [`GameTime`](#gametime)<br>Specifies the game time offset as printed in the log | `get, set` |
|
||||||
| [`EFClient`](./sharedlibrarycoredatabasemodels-EFClient) | [`ImpersonationOrigin`](#impersonationorigin) | `get, set` |
|
| [`EFClient`](database/models/EFClient.md) | [`ImpersonationOrigin`](#impersonationorigin) | `get, set` |
|
||||||
| `long` | [`IncrementalId`](#incrementalid) | `get` |
|
| `long` | [`IncrementalId`](#incrementalid) | `get` |
|
||||||
| `bool` | [`IsBlocking`](#isblocking)<br>Indicates if the event should block until it is complete | `get, set` |
|
| `bool` | [`IsBlocking`](#isblocking)<br>Indicates if the event should block until it is complete | `get, set` |
|
||||||
| `bool` | [`IsRemote`](#isremote) | `get, set` |
|
| `bool` | [`IsRemote`](#isremote) | `get, set` |
|
||||||
@ -44,13 +44,13 @@ SharedLibraryCore.Events.CoreEvent --> SharedLibraryCore.GameEvent
|
|||||||
| Returns | Name |
|
| Returns | Name |
|
||||||
| --- | --- |
|
| --- | --- |
|
||||||
| `void` | [`Complete`](#complete)() |
|
| `void` | [`Complete`](#complete)() |
|
||||||
| `Task`<[`GameEvent`](sharedlibrarycore-GameEvent)> | [`WaitAsync`](#waitasync-12)(`...`) |
|
| `Task`<[`GameEvent`](sharedlibrarycore/GameEvent.md)> | [`WaitAsync`](#waitasync-12)(`...`) |
|
||||||
|
|
||||||
## Details
|
## Details
|
||||||
### Inheritance
|
### Inheritance
|
||||||
- [
|
- [
|
||||||
`CoreEvent`
|
`CoreEvent`
|
||||||
](./sharedlibrarycoreevents-CoreEvent)
|
](events/CoreEvent.md)
|
||||||
|
|
||||||
### Nested types
|
### Nested types
|
||||||
#### Enums
|
#### Enums
|
||||||
@ -61,17 +61,20 @@ SharedLibraryCore.Events.CoreEvent --> SharedLibraryCore.GameEvent
|
|||||||
|
|
||||||
### Constructors
|
### Constructors
|
||||||
#### GameEvent
|
#### GameEvent
|
||||||
|
[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Events/GameEvent.cs#L260)
|
||||||
```csharp
|
```csharp
|
||||||
public GameEvent()
|
public GameEvent()
|
||||||
```
|
```
|
||||||
|
|
||||||
### Methods
|
### Methods
|
||||||
#### Finalize
|
#### Finalize
|
||||||
|
[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Events/GameEvent.cs#L277)
|
||||||
```csharp
|
```csharp
|
||||||
protected override void Finalize()
|
protected override void Finalize()
|
||||||
```
|
```
|
||||||
|
|
||||||
#### Complete
|
#### Complete
|
||||||
|
[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Events/GameEvent.cs#L313)
|
||||||
```csharp
|
```csharp
|
||||||
public void Complete()
|
public void Complete()
|
||||||
```
|
```
|
@ -33,6 +33,7 @@ public Map()
|
|||||||
|
|
||||||
### Methods
|
### Methods
|
||||||
#### ToString
|
#### ToString
|
||||||
|
[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Game/Map.cs#L9)
|
||||||
```csharp
|
```csharp
|
||||||
public override string ToString()
|
public override string ToString()
|
||||||
```
|
```
|
@ -21,15 +21,15 @@ SharedLibraryCore.Interfaces.IGameServer --> SharedLibraryCore.Server
|
|||||||
#### Public properties
|
#### Public properties
|
||||||
| Type | Name | Methods |
|
| Type | Name | Methods |
|
||||||
| --- | --- | --- |
|
| --- | --- | --- |
|
||||||
| `List`<[`ChatInfo`](./sharedlibrarycoredtos-ChatInfo)> | [`ChatHistory`](#chathistory) | `get, protected set` |
|
| `List`<[`ChatInfo`](dtos/ChatInfo.md)> | [`ChatHistory`](#chathistory) | `get, protected set` |
|
||||||
| [`ClientHistoryInfo`](./sharedlibrarycoredtos-ClientHistoryInfo) | [`ClientHistory`](#clienthistory) | `get` |
|
| [`ClientHistoryInfo`](dtos/ClientHistoryInfo.md) | [`ClientHistory`](#clienthistory) | `get` |
|
||||||
| `int` | [`ClientNum`](#clientnum) | `get` |
|
| `int` | [`ClientNum`](#clientnum) | `get` |
|
||||||
| `List`<[`EFClient`](./sharedlibrarycoredatabasemodels-EFClient)> | [`Clients`](#clients) | `get, protected set` |
|
| `List`<[`EFClient`](database/models/EFClient.md)> | [`Clients`](#clients) | `get, protected set` |
|
||||||
| `IReadOnlyList`<[`EFClient`](./sharedlibrarycoredatabasemodels-EFClient)> | [`ConnectedClients`](#connectedclients) | `get` |
|
| `IReadOnlyList`<[`EFClient`](database/models/EFClient.md)> | [`ConnectedClients`](#connectedclients) | `get` |
|
||||||
| [`Map`](./sharedlibrarycore-Map) | [`CurrentMap`](#currentmap) | `get, set` |
|
| [`Map`](./Map.md) | [`CurrentMap`](#currentmap) | `get, set` |
|
||||||
| `bool` | [`CustomCallback`](#customcallback) | `get, protected set` |
|
| `bool` | [`CustomCallback`](#customcallback) | `get, protected set` |
|
||||||
| `long` | [`EndPoint`](#endpoint) | `get` |
|
| `long` | [`EndPoint`](#endpoint) | `get` |
|
||||||
| [`IEventParser`](./sharedlibrarycoreinterfaces-IEventParser) | [`EventParser`](#eventparser) | `get, set` |
|
| [`IEventParser`](interfaces/IEventParser.md) | [`EventParser`](#eventparser) | `get, set` |
|
||||||
| `SemaphoreSlim` | [`EventProcessing`](#eventprocessing) | `get` |
|
| `SemaphoreSlim` | [`EventProcessing`](#eventprocessing) | `get` |
|
||||||
| `Game` | [`GameCode`](#gamecode) | `get` |
|
| `Game` | [`GameCode`](#gamecode) | `get` |
|
||||||
| `Game` | [`GameName`](#gamename) | `get, set` |
|
| `Game` | [`GameName`](#gamename) | `get, set` |
|
||||||
@ -45,10 +45,10 @@ SharedLibraryCore.Interfaces.IGameServer --> SharedLibraryCore.Server
|
|||||||
| `string` | [`ListenAddress`](#listenaddress) | `get` |
|
| `string` | [`ListenAddress`](#listenaddress) | `get` |
|
||||||
| `int` | [`ListenPort`](#listenport) | `get` |
|
| `int` | [`ListenPort`](#listenport) | `get` |
|
||||||
| `string` | [`LogPath`](#logpath) | `get, protected set` |
|
| `string` | [`LogPath`](#logpath) | `get, protected set` |
|
||||||
| [`ILogger`](./sharedlibrarycoreinterfaces-ILogger) | [`Logger`](#logger) | `get` |
|
| [`ILogger`](interfaces/ILogger.md) | [`Logger`](#logger) | `get` |
|
||||||
| [`IManager`](./sharedlibrarycoreinterfaces-IManager) | [`Manager`](#manager) | `get, protected set` |
|
| [`IManager`](interfaces/IManager.md) | [`Manager`](#manager) | `get, protected set` |
|
||||||
| [`Map`](./sharedlibrarycore-Map) | [`Map`](#map) | `get` |
|
| [`Map`](./Map.md) | [`Map`](#map) | `get` |
|
||||||
| `List`<[`Map`](./sharedlibrarycore-Map)> | [`Maps`](#maps) | `get, protected set` |
|
| `List`<[`Map`](./Map.md)> | [`Maps`](#maps) | `get, protected set` |
|
||||||
| `Nullable`<`DateTime`> | [`MatchEndTime`](#matchendtime) | `get, protected set` |
|
| `Nullable`<`DateTime`> | [`MatchEndTime`](#matchendtime) | `get, protected set` |
|
||||||
| `Nullable`<`DateTime`> | [`MatchStartTime`](#matchstarttime) | `get, protected set` |
|
| `Nullable`<`DateTime`> | [`MatchStartTime`](#matchstarttime) | `get, protected set` |
|
||||||
| `int` | [`MaxClients`](#maxclients) | `get, protected set` |
|
| `int` | [`MaxClients`](#maxclients) | `get, protected set` |
|
||||||
@ -56,12 +56,12 @@ SharedLibraryCore.Interfaces.IGameServer --> SharedLibraryCore.Server
|
|||||||
| `string` | [`PerformanceBucket`](#performancebucket) | `get, init` |
|
| `string` | [`PerformanceBucket`](#performancebucket) | `get, init` |
|
||||||
| `int` | [`Port`](#port) | `get, protected set` |
|
| `int` | [`Port`](#port) | `get, protected set` |
|
||||||
| `int` | [`PrivateClientSlots`](#privateclientslots) | `get, protected set` |
|
| `int` | [`PrivateClientSlots`](#privateclientslots) | `get, protected set` |
|
||||||
| [`IRConParser`](./sharedlibrarycoreinterfaces-IRConParser) | [`RconParser`](#rconparser) | `get, set` |
|
| [`IRConParser`](interfaces/IRConParser.md) | [`RconParser`](#rconparser) | `get, set` |
|
||||||
| [`IRConConnection`](./sharedlibrarycoreinterfaces-IRConConnection) | [`RemoteConnection`](#remoteconnection) | `get, protected set` |
|
| [`IRConConnection`](interfaces/IRConConnection.md) | [`RemoteConnection`](#remoteconnection) | `get, protected set` |
|
||||||
| `List`<[`Report`](./sharedlibrarycorehelpers-Report)> | [`Reports`](#reports) | `get, set` |
|
| `List`<[`Report`](helpers/Report.md)> | [`Reports`](#reports) | `get, set` |
|
||||||
| `IPEndPoint` | [`ResolvedIpEndPoint`](#resolvedipendpoint) | `get, protected set` |
|
| `IPEndPoint` | [`ResolvedIpEndPoint`](#resolvedipendpoint) | `get, protected set` |
|
||||||
| `bool` | [`RestartRequested`](#restartrequested) | `get, set` |
|
| `bool` | [`RestartRequested`](#restartrequested) | `get, set` |
|
||||||
| [`ServerConfiguration`](./sharedlibrarycoreconfiguration-ServerConfiguration) | [`ServerConfig`](#serverconfig) | `get` |
|
| [`ServerConfiguration`](configuration/ServerConfiguration.md) | [`ServerConfig`](#serverconfig) | `get` |
|
||||||
| `string` | [`ServerName`](#servername) | `get` |
|
| `string` | [`ServerName`](#servername) | `get` |
|
||||||
| `bool` | [`Throttled`](#throttled) | `get, protected set` |
|
| `bool` | [`Throttled`](#throttled) | `get, protected set` |
|
||||||
| `string` | [`Version`](#version) | `get, protected set` |
|
| `string` | [`Version`](#version) | `get, protected set` |
|
||||||
@ -72,41 +72,41 @@ SharedLibraryCore.Interfaces.IGameServer --> SharedLibraryCore.Server
|
|||||||
#### Public methods
|
#### Public methods
|
||||||
| Returns | Name |
|
| 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 |
|
| `Task` | [`Ban`](#ban)(`string` reason, [`EFClient`](database/models/EFClient.md) target, [`EFClient`](database/models/EFClient.md) origin, `bool` isEvade)<br>Perm ban a player from the server |
|
||||||
| [`GameEvent`](./sharedlibrarycore-GameEvent) | [`Broadcast`](#broadcast-12)(`...`)<br>Send a message to all players |
|
| [`GameEvent`](./GameEvent.md) | [`Broadcast`](#broadcast-12)(`...`)<br>Send a message to all players |
|
||||||
| `Task` | [`BroadcastAsync`](#broadcastasync)(`IEnumerable`<`string`> messages, [`EFClient`](./sharedlibrarycoredatabasemodels-EFClient) sender, `CancellationToken` token) |
|
| `Task` | [`BroadcastAsync`](#broadcastasync)(`IEnumerable`<`string`> messages, [`EFClient`](database/models/EFClient.md) sender, `CancellationToken` token) |
|
||||||
| `Task`<`string``[]`> | [`ExecuteCommandAsync`](#executecommandasync)(`string` command, `CancellationToken` token) |
|
| `Task`<`string``[]`> | [`ExecuteCommandAsync`](#executecommandasync)(`string` command, `CancellationToken` token) |
|
||||||
| `Task` | [`ExecuteEvent`](#executeevent)([`GameEvent`](./sharedlibrarycore-GameEvent) E) |
|
| `Task` | [`ExecuteEvent`](#executeevent)([`GameEvent`](./GameEvent.md) E) |
|
||||||
| `List`<[`EFClient`](./sharedlibrarycoredatabasemodels-EFClient)> | [`GetClientByName`](#getclientbyname)(`string` pName)<br>Get a player by name<br> todo: make this an extension |
|
| `List`<[`EFClient`](database/models/EFClient.md)> | [`GetClientByName`](#getclientbyname)(`string` pName)<br>Get a player by name<br> todo: make this an extension |
|
||||||
| [`EFClient`](./sharedlibrarycoredatabasemodels-EFClient) | [`GetClientByNumber`](#getclientbynumber)(`int` clientNumber) |
|
| [`EFClient`](database/models/EFClient.md) | [`GetClientByNumber`](#getclientbynumber)(`int` clientNumber) |
|
||||||
| `List`<[`EFClient`](./sharedlibrarycoredatabasemodels-EFClient)> | [`GetClientsAsList`](#getclientsaslist)()<br>Returns list of all current players |
|
| `List`<[`EFClient`](database/models/EFClient.md)> | [`GetClientsAsList`](#getclientsaslist)()<br>Returns list of all current players |
|
||||||
| `Task`<`long`> | [`GetIdForServer`](#getidforserver)([`Server`](sharedlibrarycore-Server) server) |
|
| `Task`<`long`> | [`GetIdForServer`](#getidforserver)([`Server`](sharedlibrarycore/Server.md) server) |
|
||||||
| `void` | [`InitializeTokens`](#initializetokens)()<br>Initalize the macro variables |
|
| `void` | [`InitializeTokens`](#initializetokens)()<br>Initalize the macro variables |
|
||||||
| `Task` | [`Kick`](#kick-12)(`...`) |
|
| `Task` | [`Kick`](#kick-12)(`...`) |
|
||||||
| `Task` | [`LoadMap`](#loadmap)(`string` mapName)<br>Change the current server map |
|
| `Task` | [`LoadMap`](#loadmap)(`string` mapName)<br>Change the current server map |
|
||||||
| `Task`<[`EFClient`](./sharedlibrarycoredatabasemodels-EFClient)> | [`OnClientConnected`](#onclientconnected)([`EFClient`](./sharedlibrarycoredatabasemodels-EFClient) P)<br>Add a player to the server's player list |
|
| `Task`<[`EFClient`](database/models/EFClient.md)> | [`OnClientConnected`](#onclientconnected)([`EFClient`](database/models/EFClient.md) 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` | [`OnClientDisconnected`](#onclientdisconnected)([`EFClient`](database/models/EFClient.md) client)<br>Remove player by client number |
|
||||||
| `Task`<`bool`> | [`ProcessUpdatesAsync`](#processupdatesasync)(`CancellationToken` token) |
|
| `Task`<`bool`> | [`ProcessUpdatesAsync`](#processupdatesasync)(`CancellationToken` token) |
|
||||||
| `Task` | [`SetDvarAsync`](#setdvarasync)(`string` name, `object` value, `CancellationToken` token) |
|
| `Task` | [`SetDvarAsync`](#setdvarasync)(`string` name, `object` value, `CancellationToken` token) |
|
||||||
| `Task` | [`TempBan`](#tempban)(`string` reason, `TimeSpan` length, [`EFClient`](./sharedlibrarycoredatabasemodels-EFClient) target, [`EFClient`](./sharedlibrarycoredatabasemodels-EFClient) origin)<br>Temporarily ban a player ( default 1 hour ) from the server |
|
| `Task` | [`TempBan`](#tempban)(`string` reason, `TimeSpan` length, [`EFClient`](database/models/EFClient.md) target, [`EFClient`](database/models/EFClient.md) origin)<br>Temporarily ban a player ( default 1 hour ) from the server |
|
||||||
| `void` | [`ToAdmins`](#toadmins)(`string` message)<br>Send a message to all admins on the server |
|
| `void` | [`ToAdmins`](#toadmins)(`string` message)<br>Send a message to all admins on the server |
|
||||||
| `string` | [`ToString`](#tostring)() |
|
| `string` | [`ToString`](#tostring)() |
|
||||||
| `Task` | [`Unban`](#unban)(`string` reason, [`EFClient`](./sharedlibrarycoredatabasemodels-EFClient) targetClient, [`EFClient`](./sharedlibrarycoredatabasemodels-EFClient) originClient)<br>Unban a player by npID / GUID |
|
| `Task` | [`Unban`](#unban)(`string` reason, [`EFClient`](database/models/EFClient.md) targetClient, [`EFClient`](database/models/EFClient.md) originClient)<br>Unban a player by npID / GUID |
|
||||||
| `Task` | [`Warn`](#warn)(`string` reason, [`EFClient`](./sharedlibrarycoredatabasemodels-EFClient) target, [`EFClient`](./sharedlibrarycoredatabasemodels-EFClient) origin) |
|
| `Task` | [`Warn`](#warn)(`string` reason, [`EFClient`](database/models/EFClient.md) target, [`EFClient`](database/models/EFClient.md) origin) |
|
||||||
|
|
||||||
#### Protected methods
|
#### Protected methods
|
||||||
| Returns | Name |
|
| Returns | Name |
|
||||||
| --- | --- |
|
| --- | --- |
|
||||||
| `void` | [`InitializeAutoMessages`](#initializeautomessages)()<br>Initialize the messages to be broadcasted |
|
| `void` | [`InitializeAutoMessages`](#initializeautomessages)()<br>Initialize the messages to be broadcasted |
|
||||||
| `Task`<`bool`> | [`ProcessEvent`](#processevent)([`GameEvent`](./sharedlibrarycore-GameEvent) E)<br>Process any server event |
|
| `Task`<`bool`> | [`ProcessEvent`](#processevent)([`GameEvent`](./GameEvent.md) E)<br>Process any server event |
|
||||||
| `Task`<`bool`> | [`ScriptLoaded`](#scriptloaded)() |
|
| `Task`<`bool`> | [`ScriptLoaded`](#scriptloaded)() |
|
||||||
| `Task` | [`Tell`](#tell)(`string` message, [`EFClient`](./sharedlibrarycoredatabasemodels-EFClient) targetClient)<br>Send a message to a particular players |
|
| `Task` | [`Tell`](#tell)(`string` message, [`EFClient`](database/models/EFClient.md) targetClient)<br>Send a message to a particular players |
|
||||||
|
|
||||||
## Details
|
## Details
|
||||||
### Inheritance
|
### Inheritance
|
||||||
- [
|
- [
|
||||||
`IGameServer`
|
`IGameServer`
|
||||||
](./sharedlibrarycoreinterfaces-IGameServer)
|
](interfaces/IGameServer.md)
|
||||||
|
|
||||||
### Nested types
|
### Nested types
|
||||||
#### Enums
|
#### Enums
|
||||||
@ -114,18 +114,19 @@ SharedLibraryCore.Interfaces.IGameServer --> SharedLibraryCore.Server
|
|||||||
|
|
||||||
### Constructors
|
### Constructors
|
||||||
#### Server
|
#### Server
|
||||||
|
[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Server.cs#L103)
|
||||||
```csharp
|
```csharp
|
||||||
public Server(ILogger<Server> logger, ILogger deprecatedLogger, ServerConfiguration config, IManager mgr, IRConConnectionFactory rconConnectionFactory, IGameLogReaderFactory gameLogReaderFactory, IServiceProvider serviceProvider)
|
public Server(ILogger<Server> logger, ILogger deprecatedLogger, ServerConfiguration config, IManager mgr, IRConConnectionFactory rconConnectionFactory, IGameLogReaderFactory gameLogReaderFactory, IServiceProvider serviceProvider)
|
||||||
```
|
```
|
||||||
##### Arguments
|
##### Arguments
|
||||||
| Type | Name | Description |
|
| Type | Name | Description |
|
||||||
| --- | --- | --- |
|
| --- | --- | --- |
|
||||||
| `ILogger`<[`Server`](sharedlibrarycore-Server)> | logger | |
|
| `ILogger`<[`Server`](sharedlibrarycore/Server.md)> | logger | |
|
||||||
| [`ILogger`](./sharedlibrarycoreinterfaces-ILogger) | deprecatedLogger | |
|
| [`ILogger`](interfaces/ILogger.md) | deprecatedLogger | |
|
||||||
| [`ServerConfiguration`](./sharedlibrarycoreconfiguration-ServerConfiguration) | config | |
|
| [`ServerConfiguration`](configuration/ServerConfiguration.md) | config | |
|
||||||
| [`IManager`](./sharedlibrarycoreinterfaces-IManager) | mgr | |
|
| [`IManager`](interfaces/IManager.md) | mgr | |
|
||||||
| [`IRConConnectionFactory`](./sharedlibrarycoreinterfaces-IRConConnectionFactory) | rconConnectionFactory | |
|
| [`IRConConnectionFactory`](interfaces/IRConConnectionFactory.md) | rconConnectionFactory | |
|
||||||
| [`IGameLogReaderFactory`](./sharedlibrarycoreinterfaces-IGameLogReaderFactory) | gameLogReaderFactory | |
|
| [`IGameLogReaderFactory`](interfaces/IGameLogReaderFactory.md) | gameLogReaderFactory | |
|
||||||
| `IServiceProvider` | serviceProvider | |
|
| `IServiceProvider` | serviceProvider | |
|
||||||
|
|
||||||
### Methods
|
### Methods
|
||||||
@ -137,8 +138,8 @@ public abstract Task Kick(string reason, EFClient target, EFClient origin, EFPen
|
|||||||
| Type | Name | Description |
|
| Type | Name | Description |
|
||||||
| --- | --- | --- |
|
| --- | --- | --- |
|
||||||
| `string` | reason | |
|
| `string` | reason | |
|
||||||
| [`EFClient`](./sharedlibrarycoredatabasemodels-EFClient) | target | |
|
| [`EFClient`](database/models/EFClient.md) | target | |
|
||||||
| [`EFClient`](./sharedlibrarycoredatabasemodels-EFClient) | origin | |
|
| [`EFClient`](database/models/EFClient.md) | origin | |
|
||||||
| `EFPenalty` | originalPenalty | |
|
| `EFPenalty` | originalPenalty | |
|
||||||
|
|
||||||
#### ExecuteCommandAsync
|
#### ExecuteCommandAsync
|
||||||
@ -163,6 +164,7 @@ public abstract Task SetDvarAsync(string name, object value, CancellationToken t
|
|||||||
| `CancellationToken` | token | |
|
| `CancellationToken` | token | |
|
||||||
|
|
||||||
#### GetClientsAsList
|
#### GetClientsAsList
|
||||||
|
[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Server.cs#L176)
|
||||||
```csharp
|
```csharp
|
||||||
public List<EFClient> GetClientsAsList()
|
public List<EFClient> GetClientsAsList()
|
||||||
```
|
```
|
||||||
@ -179,7 +181,7 @@ public abstract Task<EFClient> OnClientConnected(EFClient P)
|
|||||||
##### Arguments
|
##### Arguments
|
||||||
| Type | Name | Description |
|
| Type | Name | Description |
|
||||||
| --- | --- | --- |
|
| --- | --- | --- |
|
||||||
| [`EFClient`](./sharedlibrarycoredatabasemodels-EFClient) | P | EFClient pulled from memory reading |
|
| [`EFClient`](database/models/EFClient.md) | P | EFClient pulled from memory reading |
|
||||||
|
|
||||||
##### Summary
|
##### Summary
|
||||||
Add a player to the server's player list
|
Add a player to the server's player list
|
||||||
@ -194,7 +196,7 @@ public abstract Task OnClientDisconnected(EFClient client)
|
|||||||
##### Arguments
|
##### Arguments
|
||||||
| Type | Name | Description |
|
| Type | Name | Description |
|
||||||
| --- | --- | --- |
|
| --- | --- | --- |
|
||||||
| [`EFClient`](./sharedlibrarycoredatabasemodels-EFClient) | client | |
|
| [`EFClient`](database/models/EFClient.md) | client | |
|
||||||
|
|
||||||
##### Summary
|
##### Summary
|
||||||
Remove player by client number
|
Remove player by client number
|
||||||
@ -203,6 +205,7 @@ Remove player by client number
|
|||||||
true if removal succeeded, false otherwise
|
true if removal succeeded, false otherwise
|
||||||
|
|
||||||
#### GetClientByName
|
#### GetClientByName
|
||||||
|
[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Server.cs#L16707566)
|
||||||
```csharp
|
```csharp
|
||||||
public List<EFClient> GetClientByName(string pName)
|
public List<EFClient> GetClientByName(string pName)
|
||||||
```
|
```
|
||||||
@ -219,6 +222,7 @@ Get a player by name
|
|||||||
Matching player if found
|
Matching player if found
|
||||||
|
|
||||||
#### ProcessUpdatesAsync
|
#### ProcessUpdatesAsync
|
||||||
|
[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Server.cs#L229)
|
||||||
```csharp
|
```csharp
|
||||||
public virtual Task<bool> ProcessUpdatesAsync(CancellationToken token)
|
public virtual Task<bool> ProcessUpdatesAsync(CancellationToken token)
|
||||||
```
|
```
|
||||||
@ -234,7 +238,7 @@ protected abstract Task<bool> ProcessEvent(GameEvent E)
|
|||||||
##### Arguments
|
##### Arguments
|
||||||
| Type | Name | Description |
|
| Type | Name | Description |
|
||||||
| --- | --- | --- |
|
| --- | --- | --- |
|
||||||
| [`GameEvent`](./sharedlibrarycore-GameEvent) | E | Event |
|
| [`GameEvent`](./GameEvent.md) | E | Event |
|
||||||
|
|
||||||
##### Summary
|
##### Summary
|
||||||
Process any server event
|
Process any server event
|
||||||
@ -249,9 +253,10 @@ public abstract Task ExecuteEvent(GameEvent E)
|
|||||||
##### Arguments
|
##### Arguments
|
||||||
| Type | Name | Description |
|
| Type | Name | Description |
|
||||||
| --- | --- | --- |
|
| --- | --- | --- |
|
||||||
| [`GameEvent`](./sharedlibrarycore-GameEvent) | E | |
|
| [`GameEvent`](./GameEvent.md) | E | |
|
||||||
|
|
||||||
#### Broadcast [1/2]
|
#### Broadcast [1/2]
|
||||||
|
[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Server.cs#L248)
|
||||||
```csharp
|
```csharp
|
||||||
public GameEvent Broadcast(string message, EFClient sender)
|
public GameEvent Broadcast(string message, EFClient sender)
|
||||||
```
|
```
|
||||||
@ -259,12 +264,13 @@ public GameEvent Broadcast(string message, EFClient sender)
|
|||||||
| Type | Name | Description |
|
| Type | Name | Description |
|
||||||
| --- | --- | --- |
|
| --- | --- | --- |
|
||||||
| `string` | message | Message to be sent to all players |
|
| `string` | message | Message to be sent to all players |
|
||||||
| [`EFClient`](./sharedlibrarycoredatabasemodels-EFClient) | sender | Client that initiated the broadcast |
|
| [`EFClient`](database/models/EFClient.md) | sender | Client that initiated the broadcast |
|
||||||
|
|
||||||
##### Summary
|
##### Summary
|
||||||
Send a message to all players
|
Send a message to all players
|
||||||
|
|
||||||
#### Broadcast [2/2]
|
#### Broadcast [2/2]
|
||||||
|
[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Server.cs#L270)
|
||||||
```csharp
|
```csharp
|
||||||
public void Broadcast(IEnumerable<string> messages, EFClient sender)
|
public void Broadcast(IEnumerable<string> messages, EFClient sender)
|
||||||
```
|
```
|
||||||
@ -272,7 +278,7 @@ public void Broadcast(IEnumerable<string> messages, EFClient sender)
|
|||||||
| Type | Name | Description |
|
| Type | Name | Description |
|
||||||
| --- | --- | --- |
|
| --- | --- | --- |
|
||||||
| `IEnumerable`<`string`> | messages | |
|
| `IEnumerable`<`string`> | messages | |
|
||||||
| [`EFClient`](./sharedlibrarycoredatabasemodels-EFClient) | sender | |
|
| [`EFClient`](database/models/EFClient.md) | sender | |
|
||||||
|
|
||||||
#### BroadcastAsync
|
#### BroadcastAsync
|
||||||
```csharp
|
```csharp
|
||||||
@ -282,7 +288,7 @@ public async Task BroadcastAsync(IEnumerable<string> messages, EFClient sender,
|
|||||||
| Type | Name | Description |
|
| Type | Name | Description |
|
||||||
| --- | --- | --- |
|
| --- | --- | --- |
|
||||||
| `IEnumerable`<`string`> | messages | |
|
| `IEnumerable`<`string`> | messages | |
|
||||||
| [`EFClient`](./sharedlibrarycoredatabasemodels-EFClient) | sender | |
|
| [`EFClient`](database/models/EFClient.md) | sender | |
|
||||||
| `CancellationToken` | token | |
|
| `CancellationToken` | token | |
|
||||||
|
|
||||||
#### Tell
|
#### Tell
|
||||||
@ -293,12 +299,13 @@ protected async Task Tell(string message, EFClient targetClient)
|
|||||||
| Type | Name | Description |
|
| Type | Name | Description |
|
||||||
| --- | --- | --- |
|
| --- | --- | --- |
|
||||||
| `string` | message | Message to send |
|
| `string` | message | Message to send |
|
||||||
| [`EFClient`](./sharedlibrarycoredatabasemodels-EFClient) | targetClient | EFClient to send message to |
|
| [`EFClient`](database/models/EFClient.md) | targetClient | EFClient to send message to |
|
||||||
|
|
||||||
##### Summary
|
##### Summary
|
||||||
Send a message to a particular players
|
Send a message to a particular players
|
||||||
|
|
||||||
#### ToAdmins
|
#### ToAdmins
|
||||||
|
[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Server.cs#L343)
|
||||||
```csharp
|
```csharp
|
||||||
public void ToAdmins(string message)
|
public void ToAdmins(string message)
|
||||||
```
|
```
|
||||||
@ -311,6 +318,7 @@ public void ToAdmins(string message)
|
|||||||
Send a message to all admins on the server
|
Send a message to all admins on the server
|
||||||
|
|
||||||
#### Kick [2/2]
|
#### Kick [2/2]
|
||||||
|
[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Server.cs#L356)
|
||||||
```csharp
|
```csharp
|
||||||
public Task Kick(string reason, EFClient target, EFClient origin)
|
public Task Kick(string reason, EFClient target, EFClient origin)
|
||||||
```
|
```
|
||||||
@ -318,8 +326,8 @@ public Task Kick(string reason, EFClient target, EFClient origin)
|
|||||||
| Type | Name | Description |
|
| Type | Name | Description |
|
||||||
| --- | --- | --- |
|
| --- | --- | --- |
|
||||||
| `string` | reason | Reason for kicking |
|
| `string` | reason | Reason for kicking |
|
||||||
| [`EFClient`](./sharedlibrarycoredatabasemodels-EFClient) | target | EFClient to kick |
|
| [`EFClient`](database/models/EFClient.md) | target | EFClient to kick |
|
||||||
| [`EFClient`](./sharedlibrarycoredatabasemodels-EFClient) | origin | Client initating the kick |
|
| [`EFClient`](database/models/EFClient.md) | origin | Client initating the kick |
|
||||||
|
|
||||||
##### Summary
|
##### Summary
|
||||||
Kick a player from the server
|
Kick a player from the server
|
||||||
@ -333,8 +341,8 @@ public abstract Task TempBan(string reason, TimeSpan length, EFClient target, EF
|
|||||||
| --- | --- | --- |
|
| --- | --- | --- |
|
||||||
| `string` | reason | Reason for banning the player |
|
| `string` | reason | Reason for banning the player |
|
||||||
| `TimeSpan` | length | Duration of the ban |
|
| `TimeSpan` | length | Duration of the ban |
|
||||||
| [`EFClient`](./sharedlibrarycoredatabasemodels-EFClient) | target | The client to ban |
|
| [`EFClient`](database/models/EFClient.md) | target | The client to ban |
|
||||||
| [`EFClient`](./sharedlibrarycoredatabasemodels-EFClient) | origin | The client performing the ban |
|
| [`EFClient`](database/models/EFClient.md) | origin | The client performing the ban |
|
||||||
|
|
||||||
##### Summary
|
##### Summary
|
||||||
Temporarily ban a player ( default 1 hour ) from the server
|
Temporarily ban a player ( default 1 hour ) from the server
|
||||||
@ -347,8 +355,8 @@ public abstract Task Ban(string reason, EFClient target, EFClient origin, bool i
|
|||||||
| Type | Name | Description |
|
| Type | Name | Description |
|
||||||
| --- | --- | --- |
|
| --- | --- | --- |
|
||||||
| `string` | reason | The reason for the ban |
|
| `string` | reason | The reason for the ban |
|
||||||
| [`EFClient`](./sharedlibrarycoredatabasemodels-EFClient) | target | The person to ban |
|
| [`EFClient`](database/models/EFClient.md) | target | The person to ban |
|
||||||
| [`EFClient`](./sharedlibrarycoredatabasemodels-EFClient) | origin | The person who banned the target |
|
| [`EFClient`](database/models/EFClient.md) | origin | The person who banned the target |
|
||||||
| `bool` | isEvade | obsolete |
|
| `bool` | isEvade | obsolete |
|
||||||
|
|
||||||
##### Summary
|
##### Summary
|
||||||
@ -362,8 +370,8 @@ public abstract Task Warn(string reason, EFClient target, EFClient origin)
|
|||||||
| Type | Name | Description |
|
| Type | Name | Description |
|
||||||
| --- | --- | --- |
|
| --- | --- | --- |
|
||||||
| `string` | reason | |
|
| `string` | reason | |
|
||||||
| [`EFClient`](./sharedlibrarycoredatabasemodels-EFClient) | target | |
|
| [`EFClient`](database/models/EFClient.md) | target | |
|
||||||
| [`EFClient`](./sharedlibrarycoredatabasemodels-EFClient) | origin | |
|
| [`EFClient`](database/models/EFClient.md) | origin | |
|
||||||
|
|
||||||
#### Unban
|
#### Unban
|
||||||
```csharp
|
```csharp
|
||||||
@ -373,8 +381,8 @@ public abstract Task Unban(string reason, EFClient targetClient, EFClient origin
|
|||||||
| Type | Name | Description |
|
| Type | Name | Description |
|
||||||
| --- | --- | --- |
|
| --- | --- | --- |
|
||||||
| `string` | reason | reason for unban |
|
| `string` | reason | reason for unban |
|
||||||
| [`EFClient`](./sharedlibrarycoredatabasemodels-EFClient) | targetClient | client being unbanned |
|
| [`EFClient`](database/models/EFClient.md) | targetClient | client being unbanned |
|
||||||
| [`EFClient`](./sharedlibrarycoredatabasemodels-EFClient) | originClient | client performing the unban |
|
| [`EFClient`](database/models/EFClient.md) | originClient | client performing the unban |
|
||||||
|
|
||||||
##### Summary
|
##### Summary
|
||||||
Unban a player by npID / GUID
|
Unban a player by npID / GUID
|
||||||
@ -402,6 +410,7 @@ public abstract void InitializeTokens()
|
|||||||
Initalize the macro variables
|
Initalize the macro variables
|
||||||
|
|
||||||
#### InitializeAutoMessages
|
#### InitializeAutoMessages
|
||||||
|
[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Server.cs#L407)
|
||||||
```csharp
|
```csharp
|
||||||
protected void InitializeAutoMessages()
|
protected void InitializeAutoMessages()
|
||||||
```
|
```
|
||||||
@ -409,6 +418,7 @@ protected void InitializeAutoMessages()
|
|||||||
Initialize the messages to be broadcasted
|
Initialize the messages to be broadcasted
|
||||||
|
|
||||||
#### ToString
|
#### ToString
|
||||||
|
[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Server.cs#L419)
|
||||||
```csharp
|
```csharp
|
||||||
public override string ToString()
|
public override string ToString()
|
||||||
```
|
```
|
||||||
@ -425,9 +435,10 @@ public abstract Task<long> GetIdForServer(Server server)
|
|||||||
##### Arguments
|
##### Arguments
|
||||||
| Type | Name | Description |
|
| Type | Name | Description |
|
||||||
| --- | --- | --- |
|
| --- | --- | --- |
|
||||||
| [`Server`](sharedlibrarycore-Server) | server | |
|
| [`Server`](sharedlibrarycore/Server.md) | server | |
|
||||||
|
|
||||||
#### GetClientByNumber
|
#### GetClientByNumber
|
||||||
|
[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Server.cs#L16707566)
|
||||||
```csharp
|
```csharp
|
||||||
public EFClient GetClientByNumber(int clientNumber)
|
public EFClient GetClientByNumber(int clientNumber)
|
||||||
```
|
```
|
@ -28,7 +28,7 @@
|
|||||||
| --- | --- |
|
| --- | --- |
|
||||||
| `IServiceCollection` | [`AddConfiguration`](#addconfiguration)(`IServiceCollection` serviceCollection, `string` fileName, `TConfigurationType` defaultConfig) |
|
| `IServiceCollection` | [`AddConfiguration`](#addconfiguration)(`IServiceCollection` serviceCollection, `string` fileName, `TConfigurationType` defaultConfig) |
|
||||||
| `double``[]` | [`AngleStuff`](#anglestuff)(`Vector3` a, `Vector3` b) |
|
| `double``[]` | [`AngleStuff`](#anglestuff)(`Vector3` a, `Vector3` b) |
|
||||||
| [`EFClient`](./sharedlibrarycoredatabasemodels-EFClient) | [`AsConsoleClient`](#asconsoleclient)([`IGameServer`](./sharedlibrarycoreinterfaces-IGameServer) server) |
|
| [`EFClient`](database/models/EFClient.md) | [`AsConsoleClient`](#asconsoleclient)([`IGameServer`](interfaces/IGameServer.md) server) |
|
||||||
| `string` | [`CapClientName`](#capclientname)(`string` name, `int` maxLength)<br>caps client name to the specified character length - 3<br> and adds ellipses to the end of the remaining client name |
|
| `string` | [`CapClientName`](#capclientname)(`string` name, `int` maxLength)<br>caps client name to the specified character length - 3<br> and adds ellipses to the end of the remaining client name |
|
||||||
| `long` | [`ConvertGuidToLong`](#convertguidtolong-12)(`...`) |
|
| `long` | [`ConvertGuidToLong`](#convertguidtolong-12)(`...`) |
|
||||||
| `string` | [`ConvertIPtoString`](#convertiptostring)(`Nullable`<`int`> ip) |
|
| `string` | [`ConvertIPtoString`](#convertiptostring)(`Nullable`<`int`> ip) |
|
||||||
@ -37,41 +37,41 @@
|
|||||||
| `Dictionary`<`string`, `string`> | [`DictionaryFromKeyValue`](#dictionaryfromkeyvalue)(`string` eventLine) |
|
| `Dictionary`<`string`, `string`> | [`DictionaryFromKeyValue`](#dictionaryfromkeyvalue)(`string` eventLine) |
|
||||||
| `void` | [`ExecuteAfterDelay`](#executeafterdelay-13)(`...`) |
|
| `void` | [`ExecuteAfterDelay`](#executeafterdelay-13)(`...`) |
|
||||||
| `Task`<`string``[]`> | [`ExecuteCommandAsync`](#executecommandasync-12)(`...`) |
|
| `Task`<`string``[]`> | [`ExecuteCommandAsync`](#executecommandasync-12)(`...`) |
|
||||||
| `string` | [`FindRuleForReason`](#findruleforreason)(`string` reason, [`ApplicationConfiguration`](./sharedlibrarycoreconfiguration-ApplicationConfiguration) appConfig, [`Server`](./sharedlibrarycore-Server) server) |
|
| `string` | [`FindRuleForReason`](#findruleforreason)(`string` reason, [`ApplicationConfiguration`](configuration/ApplicationConfiguration.md) appConfig, [`Server`](./Server.md) server) |
|
||||||
| `string` | [`FixDirectoryCharacters`](#fixdirectorycharacters)(`string` path)<br>replaces any directory separator chars with the platform specific character |
|
| `string` | [`FixDirectoryCharacters`](#fixdirectorycharacters)(`string` path)<br>replaces any directory separator chars with the platform specific character |
|
||||||
| `Vector3` | [`FixIW4Angles`](#fixiw4angles)(`Vector3` vector) |
|
| `Vector3` | [`FixIW4Angles`](#fixiw4angles)(`Vector3` vector) |
|
||||||
| `string` | [`FixIW4ForwardSlash`](#fixiw4forwardslash)(`string` str)<br>returns a "fixed" string that prevents message truncation in IW4 (and probably other Q3 clients) |
|
| `string` | [`FixIW4ForwardSlash`](#fixiw4forwardslash)(`string` str)<br>returns a "fixed" string that prevents message truncation in IW4 (and probably other Q3 clients) |
|
||||||
| `string` | [`FormatExt`](#formatext)(`string` input, `object``[]` values) |
|
| `string` | [`FormatExt`](#formatext)(`string` input, `object``[]` values) |
|
||||||
| `string` | [`FormatMessageForEngine`](#formatmessageforengine)(`string` str, [`IRConParserConfiguration`](./sharedlibrarycoreinterfaces-IRConParserConfiguration) config) |
|
| `string` | [`FormatMessageForEngine`](#formatmessageforengine)(`string` str, [`IRConParserConfiguration`](interfaces/IRConParserConfiguration.md) config) |
|
||||||
| `string``[]` | [`FragmentMessageForDisplay`](#fragmentmessagefordisplay)(`string` message) |
|
| `string``[]` | [`FragmentMessageForDisplay`](#fragmentmessagefordisplay)(`string` message) |
|
||||||
| `long` | [`GenerateGuidFromString`](#generateguidfromstring)(`string` value)<br>generates a numerical hashcode from a string value |
|
| `long` | [`GenerateGuidFromString`](#generateguidfromstring)(`string` value)<br>generates a numerical hashcode from a string value |
|
||||||
| `string` | [`GetCommandLine`](#getcommandline)(`int` pId) |
|
| `string` | [`GetCommandLine`](#getcommandline)(`int` pId) |
|
||||||
| `Task`<[`Dvar`](./sharedlibrarycore-DvarT)<`T`>> | [`GetDvarAsync`](#getdvarasync-12)(`...`) |
|
| `Task`<[`Dvar`](./DvarT.md)<`T`>> | [`GetDvarAsync`](#getdvarasync-12)(`...`) |
|
||||||
| `Task`<`string`> | [`GetExternalIP`](#getexternalip)()<br>retrieves the external IP address of the current running machine |
|
| `Task`<`string`> | [`GetExternalIP`](#getexternalip)()<br>retrieves the external IP address of the current running machine |
|
||||||
| `Game` | [`GetGame`](#getgame)(`string` gameName) |
|
| `Game` | [`GetGame`](#getgame)(`string` gameName) |
|
||||||
| `Task`<`IDictionary`<`string`, `string`>> | [`GetInfoAsync`](#getinfoasync)([`Server`](./sharedlibrarycore-Server) server, `Nullable`<`TimeSpan`> delay) |
|
| `Task`<`IDictionary`<`string`, `string`>> | [`GetInfoAsync`](#getinfoasync)([`Server`](./Server.md) server, `Nullable`<`TimeSpan`> delay) |
|
||||||
| `string` | [`GetLocalizedGametype`](#getlocalizedgametype)(`string` input)<br>Get the full gametype name |
|
| `string` | [`GetLocalizedGametype`](#getlocalizedgametype)(`string` input)<br>Get the full gametype name |
|
||||||
| `Task`<[`Dvar`](./sharedlibrarycore-DvarT)<`T`>> | [`GetMappedDvarValueOrDefaultAsync`](#getmappeddvarvalueordefaultasync)([`Server`](./sharedlibrarycore-Server) server, `string` dvarName, `string` infoResponseName, `IDictionary`<`string`, `string`> infoResponse, `T` overrideDefault, `CancellationToken` token) |
|
| `Task`<[`Dvar`](./DvarT.md)<`T`>> | [`GetMappedDvarValueOrDefaultAsync`](#getmappeddvarvalueordefaultasync)([`Server`](./Server.md) server, `string` dvarName, `string` infoResponseName, `IDictionary`<`string`, `string`> infoResponse, `T` overrideDefault, `CancellationToken` token) |
|
||||||
| `int` | [`GetStableHashCode`](#getstablehashcode)(`string` str) |
|
| `int` | [`GetStableHashCode`](#getstablehashcode)(`string` str) |
|
||||||
| `Task`<[`IStatusResponse`](./sharedlibrarycoreinterfaces-IStatusResponse)> | [`GetStatusAsync`](#getstatusasync)([`Server`](./sharedlibrarycore-Server) server, `CancellationToken` token) |
|
| `Task`<[`IStatusResponse`](interfaces/IStatusResponse.md)> | [`GetStatusAsync`](#getstatusasync)([`Server`](./Server.md) server, `CancellationToken` token) |
|
||||||
| `double` | [`GetVersionAsDouble`](#getversionasdouble)() |
|
| `double` | [`GetVersionAsDouble`](#getversionasdouble)() |
|
||||||
| `string` | [`GetVersionAsString`](#getversionasstring)() |
|
| `string` | [`GetVersionAsString`](#getversionasstring)() |
|
||||||
| `bool` | [`HasPermission`](#haspermission-12)(`...`) |
|
| `bool` | [`HasPermission`](#haspermission-12)(`...`) |
|
||||||
| `string` | [`HumanizeForCurrentCulture`](#humanizeforcurrentculture-12)(`...`)<br>wrapper method for humanizee that uses current current culture |
|
| `string` | [`HumanizeForCurrentCulture`](#humanizeforcurrentculture-12)(`...`)<br>wrapper method for humanizee that uses current current culture |
|
||||||
| [`EFClient`](./sharedlibrarycoredatabasemodels-EFClient) | [`IW4MAdminClient`](#iw4madminclient)([`Server`](./sharedlibrarycore-Server) server) |
|
| [`EFClient`](database/models/EFClient.md) | [`IW4MAdminClient`](#iw4madminclient)([`Server`](./Server.md) server) |
|
||||||
| `bool` | [`IsBotGuid`](#isbotguid)(`string` guid)<br>determines if the guid provided appears to be a bot guid<br> "1277538174" - (Pluto?)WaW (T4) |
|
| `bool` | [`IsBotGuid`](#isbotguid)(`string` guid)<br>determines if the guid provided appears to be a bot guid<br> "1277538174" - (Pluto?)WaW (T4) |
|
||||||
| `bool` | [`IsBroadcastCommand`](#isbroadcastcommand)(`string` str, `string` broadcastCommandPrefix) |
|
| `bool` | [`IsBroadcastCommand`](#isbroadcastcommand)(`string` str, `string` broadcastCommandPrefix) |
|
||||||
| `bool` | [`IsCodGame`](#iscodgame)([`Server`](./sharedlibrarycore-Server) server) |
|
| `bool` | [`IsCodGame`](#iscodgame)([`Server`](./Server.md) server) |
|
||||||
| `bool` | [`IsInternal`](#isinternal)(`IPAddress` toTest)<br>https://stackoverflow.com/questions/8113546/how-to-determine-whether-an-ip-address-in-private/39120248<br> An extension method to determine if an IP address is internal, as specified in RFC1918 |
|
| `bool` | [`IsInternal`](#isinternal)(`IPAddress` toTest)<br>https://stackoverflow.com/questions/8113546/how-to-determine-whether-an-ip-address-in-private/39120248<br> An extension method to determine if an IP address is internal, as specified in RFC1918 |
|
||||||
| `bool` | [`IsPrivileged`](#isprivileged)([`EFClient`](./sharedlibrarycoredatabasemodels-EFClient) p)<br>Helper extension that determines if a user is a privileged client |
|
| `bool` | [`IsPrivileged`](#isprivileged)([`EFClient`](database/models/EFClient.md) p)<br>Helper extension that determines if a user is a privileged client |
|
||||||
| `bool` | [`IsQuickMessage`](#isquickmessage)(`string` message)<br>Determines if the given message is a quick message |
|
| `bool` | [`IsQuickMessage`](#isquickmessage)(`string` message)<br>Determines if the given message is a quick message |
|
||||||
| `bool` | [`IsRemoteLog`](#isremotelog)(`string` log)<br>indicates if the given log path is a remote (http) uri |
|
| `bool` | [`IsRemoteLog`](#isremotelog)(`string` log)<br>indicates if the given log path is a remote (http) uri |
|
||||||
| `bool` | [`IsZombieServer`](#iszombieserver)([`Server`](./sharedlibrarycore-Server) server)<br>indicates if the given server is running a zombie game mode |
|
| `bool` | [`IsZombieServer`](#iszombieserver)([`Server`](./Server.md) server)<br>indicates if the given server is running a zombie game mode |
|
||||||
| `PenaltyType``[]` | [`LinkedPenaltyTypes`](#linkedpenaltytypes)()<br>returns a list of penalty types that should be shown across all profiles |
|
| `PenaltyType``[]` | [`LinkedPenaltyTypes`](#linkedpenaltytypes)()<br>returns a list of penalty types that should be shown across all profiles |
|
||||||
| `string` | [`MakeAbbreviation`](#makeabbreviation)(`string` gameName) |
|
| `string` | [`MakeAbbreviation`](#makeabbreviation)(`string` gameName) |
|
||||||
| `Permission` | [`MatchPermission`](#matchpermission)(`string` str) |
|
| `Permission` | [`MatchPermission`](#matchpermission)(`string` str) |
|
||||||
| `TimeSpan` | [`ParseTimespan`](#parsetimespan)(`string` input) |
|
| `TimeSpan` | [`ParseTimespan`](#parsetimespan)(`string` input) |
|
||||||
| `Task`<`string`> | [`ProcessMessageToken`](#processmessagetoken)([`Server`](./sharedlibrarycore-Server) server, `IList`<[`MessageToken`](./sharedlibrarycorehelpers-MessageToken)> tokens, `string` str) |
|
| `Task`<`string`> | [`ProcessMessageToken`](#processmessagetoken)([`Server`](./Server.md) server, `IList`<[`MessageToken`](helpers/MessageToken.md)> tokens, `string` str) |
|
||||||
| `bool` | [`PromptBool`](#promptbool)(`string` question, `string` description, `bool` defaultValue)<br>prompt user to answer a yes/no question |
|
| `bool` | [`PromptBool`](#promptbool)(`string` question, `string` description, `bool` defaultValue)<br>prompt user to answer a yes/no question |
|
||||||
| `int` | [`PromptInt`](#promptint)(`string` question, `string` description, `int` minValue, `int` maxValue, `Nullable`<`int`> defaultValue) |
|
| `int` | [`PromptInt`](#promptint)(`string` question, `string` description, `int` minValue, `int` maxValue, `Nullable`<`int`> defaultValue) |
|
||||||
| (`int` Item1, `T` Item2) | [`PromptSelection`](#promptselection)(`string` question, `T` defaultValue, `string` description, `T``[]` selections) |
|
| (`int` Item1, `T` Item2) | [`PromptSelection`](#promptselection)(`string` question, `T` defaultValue, `string` description, `T``[]` selections) |
|
||||||
@ -80,18 +80,18 @@
|
|||||||
| `string` | [`RemoveWords`](#removewords)(`string` str, `int` num) |
|
| `string` | [`RemoveWords`](#removewords)(`string` str, `int` num) |
|
||||||
| `Task` | [`SetDvarAsync`](#setdvarasync-12)(`...`) |
|
| `Task` | [`SetDvarAsync`](#setdvarasync-12)(`...`) |
|
||||||
| `bool` | [`ShouldHideLevel`](#shouldhidelevel)(`Permission` perm) |
|
| `bool` | [`ShouldHideLevel`](#shouldhidelevel)(`Permission` perm) |
|
||||||
| [`WebfrontTranslationHelper`](./sharedlibrarycoredtosmeta-WebfrontTranslationHelper)`[]` | [`SplitTranslationTokens`](#splittranslationtokens)(`string` translationKey)<br>parses translation string into tokens that are able to be formatted by the webfront |
|
| [`WebfrontTranslationHelper`](dtos/meta/WebfrontTranslationHelper.md)`[]` | [`SplitTranslationTokens`](#splittranslationtokens)(`string` translationKey)<br>parses translation string into tokens that are able to be formatted by the webfront |
|
||||||
| `string` | [`StripColors`](#stripcolors)(`string` str)<br>Remove all IW Engine color codes |
|
| `string` | [`StripColors`](#stripcolors)(`string` str)<br>Remove all IW Engine color codes |
|
||||||
| `string` | [`ToBase64UrlSafeString`](#tobase64urlsafestring)(`string` src) |
|
| `string` | [`ToBase64UrlSafeString`](#tobase64urlsafestring)(`string` src) |
|
||||||
| `float` | [`ToDegrees`](#todegrees)(`float` value) |
|
| `float` | [`ToDegrees`](#todegrees)(`float` value) |
|
||||||
| `string` | [`ToLocalizedLevelName`](#tolocalizedlevelname)(`Permission` permission) |
|
| `string` | [`ToLocalizedLevelName`](#tolocalizedlevelname)(`Permission` permission) |
|
||||||
| `string` | [`ToNumericalString`](#tonumericalstring-14)(`...`) |
|
| `string` | [`ToNumericalString`](#tonumericalstring-14)(`...`) |
|
||||||
| [`EFClient`](./sharedlibrarycoredatabasemodels-EFClient) | [`ToPartialClient`](#topartialclient)(`EFClient` client) |
|
| [`EFClient`](database/models/EFClient.md) | [`ToPartialClient`](#topartialclient)(`EFClient` client) |
|
||||||
| `float` | [`ToRadians`](#toradians)(`float` value) |
|
| `float` | [`ToRadians`](#toradians)(`float` value) |
|
||||||
| `string` | [`ToStandardFormat`](#tostandardformat-12)(`...`) |
|
| `string` | [`ToStandardFormat`](#tostandardformat-12)(`...`) |
|
||||||
| `string` | [`ToTranslatedName`](#totranslatedname)([`MetaType`](./sharedlibrarycoreinterfaces-MetaType) metaType) |
|
| `string` | [`ToTranslatedName`](#totranslatedname)([`MetaType`](interfaces/MetaType.md) metaType) |
|
||||||
| `string` | [`TrimNewLine`](#trimnewline)(`string` str)<br>trims new line and whitespace from string |
|
| `string` | [`TrimNewLine`](#trimnewline)(`string` str)<br>trims new line and whitespace from string |
|
||||||
| `Task`<`bool`> | [`TryCreatePenalty`](#trycreatepenalty)(`EFPenalty` penalty, [`IEntityService`](./sharedlibrarycoreinterfaces-IEntityServiceT)<`EFPenalty`> penaltyService, `ILogger` logger) |
|
| `Task`<`bool`> | [`TryCreatePenalty`](#trycreatepenalty)(`EFPenalty` penalty, [`IEntityService`](interfaces/IEntityServiceT.md)<`EFPenalty`> penaltyService, `ILogger` logger) |
|
||||||
| `Task`<`T`> | [`WithTimeout`](#withtimeout-12)(`...`) |
|
| `Task`<`T`> | [`WithTimeout`](#withtimeout-12)(`...`) |
|
||||||
| `Task` | [`WithWaitCancellation`](#withwaitcancellation-12)(`...`)<br>https://www.planetgeek.ch/2016/12/08/async-method-without-cancellation-support-do-it-my-way/ |
|
| `Task` | [`WithWaitCancellation`](#withwaitcancellation-12)(`...`)<br>https://www.planetgeek.ch/2016/12/08/async-method-without-cancellation-support-do-it-my-way/ |
|
||||||
|
|
||||||
@ -104,6 +104,7 @@
|
|||||||
## Details
|
## Details
|
||||||
### Methods
|
### Methods
|
||||||
#### ToStandardFormat [1/2]
|
#### ToStandardFormat [1/2]
|
||||||
|
[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Utilities.cs#L53)
|
||||||
```csharp
|
```csharp
|
||||||
public static string ToStandardFormat(Nullable<DateTime> time)
|
public static string ToStandardFormat(Nullable<DateTime> time)
|
||||||
```
|
```
|
||||||
@ -113,6 +114,7 @@ public static string ToStandardFormat(Nullable<DateTime> time)
|
|||||||
| `Nullable`<`DateTime`> | time | |
|
| `Nullable`<`DateTime`> | time | |
|
||||||
|
|
||||||
#### ToStandardFormat [2/2]
|
#### ToStandardFormat [2/2]
|
||||||
|
[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Utilities.cs#L54)
|
||||||
```csharp
|
```csharp
|
||||||
public static string ToStandardFormat(DateTime time)
|
public static string ToStandardFormat(DateTime time)
|
||||||
```
|
```
|
||||||
@ -122,24 +124,27 @@ public static string ToStandardFormat(DateTime time)
|
|||||||
| `DateTime` | time | |
|
| `DateTime` | time | |
|
||||||
|
|
||||||
#### IW4MAdminClient
|
#### IW4MAdminClient
|
||||||
|
[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Utilities.cs#L57)
|
||||||
```csharp
|
```csharp
|
||||||
public static EFClient IW4MAdminClient(Server server)
|
public static EFClient IW4MAdminClient(Server server)
|
||||||
```
|
```
|
||||||
##### Arguments
|
##### Arguments
|
||||||
| Type | Name | Description |
|
| Type | Name | Description |
|
||||||
| --- | --- | --- |
|
| --- | --- | --- |
|
||||||
| [`Server`](./sharedlibrarycore-Server) | server | |
|
| [`Server`](./Server.md) | server | |
|
||||||
|
|
||||||
#### AsConsoleClient
|
#### AsConsoleClient
|
||||||
|
[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Utilities.cs#L73)
|
||||||
```csharp
|
```csharp
|
||||||
public static EFClient AsConsoleClient(IGameServer server)
|
public static EFClient AsConsoleClient(IGameServer server)
|
||||||
```
|
```
|
||||||
##### Arguments
|
##### Arguments
|
||||||
| Type | Name | Description |
|
| Type | Name | Description |
|
||||||
| --- | --- | --- |
|
| --- | --- | --- |
|
||||||
| [`IGameServer`](./sharedlibrarycoreinterfaces-IGameServer) | server | |
|
| [`IGameServer`](interfaces/IGameServer.md) | server | |
|
||||||
|
|
||||||
#### RemoveWords
|
#### RemoveWords
|
||||||
|
[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Utilities.cs#L97)
|
||||||
```csharp
|
```csharp
|
||||||
public static string RemoveWords(string str, int num)
|
public static string RemoveWords(string str, int num)
|
||||||
```
|
```
|
||||||
@ -150,6 +155,7 @@ public static string RemoveWords(string str, int num)
|
|||||||
| `int` | num | |
|
| `int` | num | |
|
||||||
|
|
||||||
#### CapClientName
|
#### CapClientName
|
||||||
|
[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Utilities.cs#L123)
|
||||||
```csharp
|
```csharp
|
||||||
public static string CapClientName(string name, int maxLength)
|
public static string CapClientName(string name, int maxLength)
|
||||||
```
|
```
|
||||||
@ -167,6 +173,7 @@ caps client name to the specified character length - 3
|
|||||||
|
|
||||||
|
|
||||||
#### MatchPermission
|
#### MatchPermission
|
||||||
|
[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Utilities.cs#L133)
|
||||||
```csharp
|
```csharp
|
||||||
public static Permission MatchPermission(string str)
|
public static Permission MatchPermission(string str)
|
||||||
```
|
```
|
||||||
@ -176,6 +183,7 @@ public static Permission MatchPermission(string str)
|
|||||||
| `string` | str | |
|
| `string` | str | |
|
||||||
|
|
||||||
#### StripColors
|
#### StripColors
|
||||||
|
[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Utilities.cs#L153)
|
||||||
```csharp
|
```csharp
|
||||||
public static string StripColors(string str)
|
public static string StripColors(string str)
|
||||||
```
|
```
|
||||||
@ -191,6 +199,7 @@ Remove all IW Engine color codes
|
|||||||
|
|
||||||
|
|
||||||
#### FixIW4ForwardSlash
|
#### FixIW4ForwardSlash
|
||||||
|
[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Utilities.cs#L170)
|
||||||
```csharp
|
```csharp
|
||||||
public static string FixIW4ForwardSlash(string str)
|
public static string FixIW4ForwardSlash(string str)
|
||||||
```
|
```
|
||||||
@ -206,6 +215,7 @@ returns a "fixed" string that prevents message truncation in IW4 (and probably o
|
|||||||
|
|
||||||
|
|
||||||
#### RemoveDiacritics
|
#### RemoveDiacritics
|
||||||
|
[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Utilities.cs#L175)
|
||||||
```csharp
|
```csharp
|
||||||
public static string RemoveDiacritics(string text)
|
public static string RemoveDiacritics(string text)
|
||||||
```
|
```
|
||||||
@ -215,6 +225,7 @@ public static string RemoveDiacritics(string text)
|
|||||||
| `string` | text | |
|
| `string` | text | |
|
||||||
|
|
||||||
#### FormatMessageForEngine
|
#### FormatMessageForEngine
|
||||||
|
[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Utilities.cs#L191)
|
||||||
```csharp
|
```csharp
|
||||||
public static string FormatMessageForEngine(string str, IRConParserConfiguration config)
|
public static string FormatMessageForEngine(string str, IRConParserConfiguration config)
|
||||||
```
|
```
|
||||||
@ -222,16 +233,17 @@ public static string FormatMessageForEngine(string str, IRConParserConfiguration
|
|||||||
| Type | Name | Description |
|
| Type | Name | Description |
|
||||||
| --- | --- | --- |
|
| --- | --- | --- |
|
||||||
| `string` | str | |
|
| `string` | str | |
|
||||||
| [`IRConParserConfiguration`](./sharedlibrarycoreinterfaces-IRConParserConfiguration) | config | |
|
| [`IRConParserConfiguration`](interfaces/IRConParserConfiguration.md) | config | |
|
||||||
|
|
||||||
#### IsZombieServer
|
#### IsZombieServer
|
||||||
|
[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Utilities.cs#L223)
|
||||||
```csharp
|
```csharp
|
||||||
public static bool IsZombieServer(Server server)
|
public static bool IsZombieServer(Server server)
|
||||||
```
|
```
|
||||||
##### Arguments
|
##### Arguments
|
||||||
| Type | Name | Description |
|
| Type | Name | Description |
|
||||||
| --- | --- | --- |
|
| --- | --- | --- |
|
||||||
| [`Server`](./sharedlibrarycore-Server) | server | |
|
| [`Server`](./Server.md) | server | |
|
||||||
|
|
||||||
##### Summary
|
##### Summary
|
||||||
indicates if the given server is running a zombie game mode
|
indicates if the given server is running a zombie game mode
|
||||||
@ -240,15 +252,17 @@ indicates if the given server is running a zombie game mode
|
|||||||
|
|
||||||
|
|
||||||
#### IsCodGame
|
#### IsCodGame
|
||||||
|
[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Utilities.cs#L229)
|
||||||
```csharp
|
```csharp
|
||||||
public static bool IsCodGame(Server server)
|
public static bool IsCodGame(Server server)
|
||||||
```
|
```
|
||||||
##### Arguments
|
##### Arguments
|
||||||
| Type | Name | Description |
|
| Type | Name | Description |
|
||||||
| --- | --- | --- |
|
| --- | --- | --- |
|
||||||
| [`Server`](./sharedlibrarycore-Server) | server | |
|
| [`Server`](./Server.md) | server | |
|
||||||
|
|
||||||
#### ConvertLevelToColor
|
#### ConvertLevelToColor
|
||||||
|
[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Utilities.cs#L240)
|
||||||
```csharp
|
```csharp
|
||||||
public static string ConvertLevelToColor(Permission level, string localizedLevel)
|
public static string ConvertLevelToColor(Permission level, string localizedLevel)
|
||||||
```
|
```
|
||||||
@ -259,6 +273,7 @@ public static string ConvertLevelToColor(Permission level, string localizedLevel
|
|||||||
| `string` | localizedLevel | |
|
| `string` | localizedLevel | |
|
||||||
|
|
||||||
#### ToLocalizedLevelName
|
#### ToLocalizedLevelName
|
||||||
|
[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Utilities.cs#L256)
|
||||||
```csharp
|
```csharp
|
||||||
public static string ToLocalizedLevelName(Permission permission)
|
public static string ToLocalizedLevelName(Permission permission)
|
||||||
```
|
```
|
||||||
@ -274,11 +289,12 @@ public static async Task<string> ProcessMessageToken(Server server, IList<Messag
|
|||||||
##### Arguments
|
##### Arguments
|
||||||
| Type | Name | Description |
|
| Type | Name | Description |
|
||||||
| --- | --- | --- |
|
| --- | --- | --- |
|
||||||
| [`Server`](./sharedlibrarycore-Server) | server | |
|
| [`Server`](./Server.md) | server | |
|
||||||
| `IList`<[`MessageToken`](./sharedlibrarycorehelpers-MessageToken)> | tokens | |
|
| `IList`<[`MessageToken`](helpers/MessageToken.md)> | tokens | |
|
||||||
| `string` | str | |
|
| `string` | str | |
|
||||||
|
|
||||||
#### IsBroadcastCommand
|
#### IsBroadcastCommand
|
||||||
|
[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Utilities.cs#L284)
|
||||||
```csharp
|
```csharp
|
||||||
public static bool IsBroadcastCommand(string str, string broadcastCommandPrefix)
|
public static bool IsBroadcastCommand(string str, string broadcastCommandPrefix)
|
||||||
```
|
```
|
||||||
@ -289,6 +305,7 @@ public static bool IsBroadcastCommand(string str, string broadcastCommandPrefix)
|
|||||||
| `string` | broadcastCommandPrefix | |
|
| `string` | broadcastCommandPrefix | |
|
||||||
|
|
||||||
#### GetLocalizedGametype
|
#### GetLocalizedGametype
|
||||||
|
[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Utilities.cs#L294)
|
||||||
```csharp
|
```csharp
|
||||||
public static string GetLocalizedGametype(string input)
|
public static string GetLocalizedGametype(string input)
|
||||||
```
|
```
|
||||||
@ -304,6 +321,7 @@ Get the full gametype name
|
|||||||
|
|
||||||
|
|
||||||
#### ConvertGuidToLong [1/2]
|
#### ConvertGuidToLong [1/2]
|
||||||
|
[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Utilities.cs#L345)
|
||||||
```csharp
|
```csharp
|
||||||
public static long ConvertGuidToLong(string str, NumberStyles numberStyle, Nullable<long> fallback)
|
public static long ConvertGuidToLong(string str, NumberStyles numberStyle, Nullable<long> fallback)
|
||||||
```
|
```
|
||||||
@ -315,6 +333,7 @@ public static long ConvertGuidToLong(string str, NumberStyles numberStyle, Nulla
|
|||||||
| `Nullable`<`long`> | fallback | |
|
| `Nullable`<`long`> | fallback | |
|
||||||
|
|
||||||
#### ConvertGuidToLong [2/2]
|
#### ConvertGuidToLong [2/2]
|
||||||
|
[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Utilities.cs#L358)
|
||||||
```csharp
|
```csharp
|
||||||
public static long ConvertGuidToLong(string str, NumberStyles numberStyle, bool convertSigned, Nullable<long> fallback)
|
public static long ConvertGuidToLong(string str, NumberStyles numberStyle, bool convertSigned, Nullable<long> fallback)
|
||||||
```
|
```
|
||||||
@ -327,6 +346,7 @@ public static long ConvertGuidToLong(string str, NumberStyles numberStyle, bool
|
|||||||
| `Nullable`<`long`> | fallback | |
|
| `Nullable`<`long`> | fallback | |
|
||||||
|
|
||||||
#### IsBotGuid
|
#### IsBotGuid
|
||||||
|
[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Utilities.cs#L419)
|
||||||
```csharp
|
```csharp
|
||||||
public static bool IsBotGuid(string guid)
|
public static bool IsBotGuid(string guid)
|
||||||
```
|
```
|
||||||
@ -343,6 +363,7 @@ determines if the guid provided appears to be a bot guid
|
|||||||
true if is bot guid, otherwise false
|
true if is bot guid, otherwise false
|
||||||
|
|
||||||
#### GenerateGuidFromString
|
#### GenerateGuidFromString
|
||||||
|
[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Utilities.cs#L429)
|
||||||
```csharp
|
```csharp
|
||||||
public static long GenerateGuidFromString(string value)
|
public static long GenerateGuidFromString(string value)
|
||||||
```
|
```
|
||||||
@ -358,6 +379,7 @@ generates a numerical hashcode from a string value
|
|||||||
|
|
||||||
|
|
||||||
#### GetStableHashCode
|
#### GetStableHashCode
|
||||||
|
[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Utilities.cs#L435)
|
||||||
```csharp
|
```csharp
|
||||||
public static int GetStableHashCode(string str)
|
public static int GetStableHashCode(string str)
|
||||||
```
|
```
|
||||||
@ -367,6 +389,7 @@ public static int GetStableHashCode(string str)
|
|||||||
| `string` | str | |
|
| `string` | str | |
|
||||||
|
|
||||||
#### ConvertToIP
|
#### ConvertToIP
|
||||||
|
[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Utilities.cs#L457)
|
||||||
```csharp
|
```csharp
|
||||||
public static Nullable<int> ConvertToIP(string str)
|
public static Nullable<int> ConvertToIP(string str)
|
||||||
```
|
```
|
||||||
@ -376,6 +399,7 @@ public static Nullable<int> ConvertToIP(string str)
|
|||||||
| `string` | str | |
|
| `string` | str | |
|
||||||
|
|
||||||
#### ConvertIPtoString
|
#### ConvertIPtoString
|
||||||
|
[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Utilities.cs#L465)
|
||||||
```csharp
|
```csharp
|
||||||
public static string ConvertIPtoString(Nullable<int> ip)
|
public static string ConvertIPtoString(Nullable<int> ip)
|
||||||
```
|
```
|
||||||
@ -385,6 +409,7 @@ public static string ConvertIPtoString(Nullable<int> ip)
|
|||||||
| `Nullable`<`int`> | ip | |
|
| `Nullable`<`int`> | ip | |
|
||||||
|
|
||||||
#### GetGame
|
#### GetGame
|
||||||
|
[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Utilities.cs#L470)
|
||||||
```csharp
|
```csharp
|
||||||
public static Game GetGame(string gameName)
|
public static Game GetGame(string gameName)
|
||||||
```
|
```
|
||||||
@ -394,6 +419,7 @@ public static Game GetGame(string gameName)
|
|||||||
| `string` | gameName | |
|
| `string` | gameName | |
|
||||||
|
|
||||||
#### ParseTimespan
|
#### ParseTimespan
|
||||||
|
[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Utilities.cs#L510)
|
||||||
```csharp
|
```csharp
|
||||||
public static TimeSpan ParseTimespan(string input)
|
public static TimeSpan ParseTimespan(string input)
|
||||||
```
|
```
|
||||||
@ -403,6 +429,7 @@ public static TimeSpan ParseTimespan(string input)
|
|||||||
| `string` | input | |
|
| `string` | input | |
|
||||||
|
|
||||||
#### HasPermission [1/2]
|
#### HasPermission [1/2]
|
||||||
|
[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Utilities.cs#L16707566)
|
||||||
```csharp
|
```csharp
|
||||||
public static bool HasPermission<TEntity, TPermission>(IEnumerable<string> permissionsSet, TEntity entity, TPermission permission)
|
public static bool HasPermission<TEntity, TPermission>(IEnumerable<string> permissionsSet, TEntity entity, TPermission permission)
|
||||||
where TEntity : Enum
|
where TEntity : Enum
|
||||||
@ -416,6 +443,7 @@ where TPermission : Enum
|
|||||||
| `TPermission` | permission | |
|
| `TPermission` | permission | |
|
||||||
|
|
||||||
#### HasPermission [2/2]
|
#### HasPermission [2/2]
|
||||||
|
[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Utilities.cs#L589)
|
||||||
```csharp
|
```csharp
|
||||||
public static bool HasPermission<TEntity, TPermission>(ApplicationConfiguration appConfig, Permission permissionLevel, TEntity entity, TPermission permission)
|
public static bool HasPermission<TEntity, TPermission>(ApplicationConfiguration appConfig, Permission permissionLevel, TEntity entity, TPermission permission)
|
||||||
where TEntity : Enum
|
where TEntity : Enum
|
||||||
@ -424,12 +452,13 @@ where TPermission : Enum
|
|||||||
##### Arguments
|
##### Arguments
|
||||||
| Type | Name | Description |
|
| Type | Name | Description |
|
||||||
| --- | --- | --- |
|
| --- | --- | --- |
|
||||||
| [`ApplicationConfiguration`](./sharedlibrarycoreconfiguration-ApplicationConfiguration) | appConfig | |
|
| [`ApplicationConfiguration`](configuration/ApplicationConfiguration.md) | appConfig | |
|
||||||
| `Permission` | permissionLevel | |
|
| `Permission` | permissionLevel | |
|
||||||
| `TEntity` | entity | |
|
| `TEntity` | entity | |
|
||||||
| `TPermission` | permission | |
|
| `TPermission` | permission | |
|
||||||
|
|
||||||
#### LinkedPenaltyTypes
|
#### LinkedPenaltyTypes
|
||||||
|
[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Utilities.cs#L599)
|
||||||
```csharp
|
```csharp
|
||||||
public static PenaltyType LinkedPenaltyTypes()
|
public static PenaltyType LinkedPenaltyTypes()
|
||||||
```
|
```
|
||||||
@ -440,13 +469,14 @@ returns a list of penalty types that should be shown across all profiles
|
|||||||
|
|
||||||
|
|
||||||
#### IsPrivileged
|
#### IsPrivileged
|
||||||
|
[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Utilities.cs#L616)
|
||||||
```csharp
|
```csharp
|
||||||
public static bool IsPrivileged(EFClient p)
|
public static bool IsPrivileged(EFClient p)
|
||||||
```
|
```
|
||||||
##### Arguments
|
##### Arguments
|
||||||
| Type | Name | Description |
|
| Type | Name | Description |
|
||||||
| --- | --- | --- |
|
| --- | --- | --- |
|
||||||
| [`EFClient`](./sharedlibrarycoredatabasemodels-EFClient) | p | |
|
| [`EFClient`](database/models/EFClient.md) | p | |
|
||||||
|
|
||||||
##### Summary
|
##### Summary
|
||||||
Helper extension that determines if a user is a privileged client
|
Helper extension that determines if a user is a privileged client
|
||||||
@ -455,6 +485,7 @@ Helper extension that determines if a user is a privileged client
|
|||||||
|
|
||||||
|
|
||||||
#### PromptBool
|
#### PromptBool
|
||||||
|
[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Utilities.cs#L628)
|
||||||
```csharp
|
```csharp
|
||||||
public static bool PromptBool(string question, string description, bool defaultValue)
|
public static bool PromptBool(string question, string description, bool defaultValue)
|
||||||
```
|
```
|
||||||
@ -472,6 +503,7 @@ prompt user to answer a yes/no question
|
|||||||
|
|
||||||
|
|
||||||
#### PromptSelection
|
#### PromptSelection
|
||||||
|
[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Utilities.cs#L645)
|
||||||
```csharp
|
```csharp
|
||||||
public static Tuple<int,T> PromptSelection<T>(string question, T defaultValue, string description, T[] selections)
|
public static Tuple<int,T> PromptSelection<T>(string question, T defaultValue, string description, T[] selections)
|
||||||
where T :
|
where T :
|
||||||
@ -485,6 +517,7 @@ where T :
|
|||||||
| `T``[]` | selections | |
|
| `T``[]` | selections | |
|
||||||
|
|
||||||
#### PromptInt
|
#### PromptInt
|
||||||
|
[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Utilities.cs#L16707566)
|
||||||
```csharp
|
```csharp
|
||||||
public static int PromptInt(string question, string description, int minValue, int maxValue, Nullable<int> defaultValue)
|
public static int PromptInt(string question, string description, int minValue, int maxValue, Nullable<int> defaultValue)
|
||||||
```
|
```
|
||||||
@ -498,6 +531,7 @@ public static int PromptInt(string question, string description, int minValue, i
|
|||||||
| `Nullable`<`int`> | defaultValue | |
|
| `Nullable`<`int`> | defaultValue | |
|
||||||
|
|
||||||
#### PromptString
|
#### PromptString
|
||||||
|
[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Utilities.cs#L16707566)
|
||||||
```csharp
|
```csharp
|
||||||
public static string PromptString(string question, string description, string defaultValue)
|
public static string PromptString(string question, string description, string defaultValue)
|
||||||
```
|
```
|
||||||
@ -515,6 +549,7 @@ prompt use to enter a string response
|
|||||||
|
|
||||||
|
|
||||||
#### DictionaryFromKeyValue
|
#### DictionaryFromKeyValue
|
||||||
|
[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Utilities.cs#L738)
|
||||||
```csharp
|
```csharp
|
||||||
public static Dictionary<string, string> DictionaryFromKeyValue(string eventLine)
|
public static Dictionary<string, string> DictionaryFromKeyValue(string eventLine)
|
||||||
```
|
```
|
||||||
@ -524,6 +559,7 @@ public static Dictionary<string, string> DictionaryFromKeyValue(string eventLine
|
|||||||
| `string` | eventLine | |
|
| `string` | eventLine | |
|
||||||
|
|
||||||
#### GetCommandLine
|
#### GetCommandLine
|
||||||
|
[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Utilities.cs#L761)
|
||||||
```csharp
|
```csharp
|
||||||
public static string GetCommandLine(int pId)
|
public static string GetCommandLine(int pId)
|
||||||
```
|
```
|
||||||
@ -533,6 +569,7 @@ public static string GetCommandLine(int pId)
|
|||||||
| `int` | pId | |
|
| `int` | pId | |
|
||||||
|
|
||||||
#### IsRemoteLog
|
#### IsRemoteLog
|
||||||
|
[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Utilities.cs#L789)
|
||||||
```csharp
|
```csharp
|
||||||
public static bool IsRemoteLog(string log)
|
public static bool IsRemoteLog(string log)
|
||||||
```
|
```
|
||||||
@ -548,6 +585,7 @@ indicates if the given log path is a remote (http) uri
|
|||||||
|
|
||||||
|
|
||||||
#### ToBase64UrlSafeString
|
#### ToBase64UrlSafeString
|
||||||
|
[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Utilities.cs#L794)
|
||||||
```csharp
|
```csharp
|
||||||
public static string ToBase64UrlSafeString(string src)
|
public static string ToBase64UrlSafeString(string src)
|
||||||
```
|
```
|
||||||
@ -564,7 +602,7 @@ where T :
|
|||||||
##### Arguments
|
##### Arguments
|
||||||
| Type | Name | Description |
|
| Type | Name | Description |
|
||||||
| --- | --- | --- |
|
| --- | --- | --- |
|
||||||
| [`Server`](./sharedlibrarycore-Server) | server | |
|
| [`Server`](./Server.md) | server | |
|
||||||
| `string` | dvarName | |
|
| `string` | dvarName | |
|
||||||
| `T` | fallbackValue | |
|
| `T` | fallbackValue | |
|
||||||
| `CancellationToken` | token | |
|
| `CancellationToken` | token | |
|
||||||
@ -577,7 +615,7 @@ where T :
|
|||||||
##### Arguments
|
##### Arguments
|
||||||
| Type | Name | Description |
|
| Type | Name | Description |
|
||||||
| --- | --- | --- |
|
| --- | --- | --- |
|
||||||
| [`Server`](./sharedlibrarycore-Server) | server | |
|
| [`Server`](./Server.md) | server | |
|
||||||
| `string` | dvarName | |
|
| `string` | dvarName | |
|
||||||
| `T` | fallbackValue | |
|
| `T` | fallbackValue | |
|
||||||
|
|
||||||
@ -589,7 +627,7 @@ where T :
|
|||||||
##### Arguments
|
##### Arguments
|
||||||
| Type | Name | Description |
|
| Type | Name | Description |
|
||||||
| --- | --- | --- |
|
| --- | --- | --- |
|
||||||
| [`Server`](./sharedlibrarycore-Server) | server | |
|
| [`Server`](./Server.md) | server | |
|
||||||
| `string` | dvarName | |
|
| `string` | dvarName | |
|
||||||
| `string` | infoResponseName | |
|
| `string` | infoResponseName | |
|
||||||
| `IDictionary`<`string`, `string`> | infoResponse | |
|
| `IDictionary`<`string`, `string`> | infoResponse | |
|
||||||
@ -603,7 +641,7 @@ public static async Task SetDvarAsync(Server server, string dvarName, object dva
|
|||||||
##### Arguments
|
##### Arguments
|
||||||
| Type | Name | Description |
|
| Type | Name | Description |
|
||||||
| --- | --- | --- |
|
| --- | --- | --- |
|
||||||
| [`Server`](./sharedlibrarycore-Server) | server | |
|
| [`Server`](./Server.md) | server | |
|
||||||
| `string` | dvarName | |
|
| `string` | dvarName | |
|
||||||
| `object` | dvarValue | |
|
| `object` | dvarValue | |
|
||||||
| `CancellationToken` | token | |
|
| `CancellationToken` | token | |
|
||||||
@ -615,7 +653,7 @@ public static async Task SetDvarAsync(Server server, string dvarName, object dva
|
|||||||
##### Arguments
|
##### Arguments
|
||||||
| Type | Name | Description |
|
| Type | Name | Description |
|
||||||
| --- | --- | --- |
|
| --- | --- | --- |
|
||||||
| [`Server`](./sharedlibrarycore-Server) | server | |
|
| [`Server`](./Server.md) | server | |
|
||||||
| `string` | dvarName | |
|
| `string` | dvarName | |
|
||||||
| `object` | dvarValue | |
|
| `object` | dvarValue | |
|
||||||
|
|
||||||
@ -626,7 +664,7 @@ public static async Task<string> ExecuteCommandAsync(Server server, string comma
|
|||||||
##### Arguments
|
##### Arguments
|
||||||
| Type | Name | Description |
|
| Type | Name | Description |
|
||||||
| --- | --- | --- |
|
| --- | --- | --- |
|
||||||
| [`Server`](./sharedlibrarycore-Server) | server | |
|
| [`Server`](./Server.md) | server | |
|
||||||
| `string` | commandName | |
|
| `string` | commandName | |
|
||||||
| `CancellationToken` | token | |
|
| `CancellationToken` | token | |
|
||||||
|
|
||||||
@ -637,7 +675,7 @@ public static async Task<string> ExecuteCommandAsync(Server server, string comma
|
|||||||
##### Arguments
|
##### Arguments
|
||||||
| Type | Name | Description |
|
| Type | Name | Description |
|
||||||
| --- | --- | --- |
|
| --- | --- | --- |
|
||||||
| [`Server`](./sharedlibrarycore-Server) | server | |
|
| [`Server`](./Server.md) | server | |
|
||||||
| `string` | commandName | |
|
| `string` | commandName | |
|
||||||
|
|
||||||
#### GetStatusAsync
|
#### GetStatusAsync
|
||||||
@ -647,7 +685,7 @@ public static async Task<IStatusResponse> GetStatusAsync(Server server, Cancella
|
|||||||
##### Arguments
|
##### Arguments
|
||||||
| Type | Name | Description |
|
| Type | Name | Description |
|
||||||
| --- | --- | --- |
|
| --- | --- | --- |
|
||||||
| [`Server`](./sharedlibrarycore-Server) | server | |
|
| [`Server`](./Server.md) | server | |
|
||||||
| `CancellationToken` | token | |
|
| `CancellationToken` | token | |
|
||||||
|
|
||||||
#### GetInfoAsync
|
#### GetInfoAsync
|
||||||
@ -657,20 +695,23 @@ public static async Task<IDictionary<string, string>> GetInfoAsync(Server server
|
|||||||
##### Arguments
|
##### Arguments
|
||||||
| Type | Name | Description |
|
| Type | Name | Description |
|
||||||
| --- | --- | --- |
|
| --- | --- | --- |
|
||||||
| [`Server`](./sharedlibrarycore-Server) | server | |
|
| [`Server`](./Server.md) | server | |
|
||||||
| `Nullable`<`TimeSpan`> | delay | |
|
| `Nullable`<`TimeSpan`> | delay | |
|
||||||
|
|
||||||
#### GetVersionAsDouble
|
#### GetVersionAsDouble
|
||||||
|
[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Utilities.cs#L901)
|
||||||
```csharp
|
```csharp
|
||||||
public static double GetVersionAsDouble()
|
public static double GetVersionAsDouble()
|
||||||
```
|
```
|
||||||
|
|
||||||
#### GetVersionAsString
|
#### GetVersionAsString
|
||||||
|
[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Utilities.cs#L908)
|
||||||
```csharp
|
```csharp
|
||||||
public static string GetVersionAsString()
|
public static string GetVersionAsString()
|
||||||
```
|
```
|
||||||
|
|
||||||
#### FormatExt
|
#### FormatExt
|
||||||
|
[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Utilities.cs#L913)
|
||||||
```csharp
|
```csharp
|
||||||
public static string FormatExt(string input, object[] values)
|
public static string FormatExt(string input, object[] values)
|
||||||
```
|
```
|
||||||
@ -681,6 +722,7 @@ public static string FormatExt(string input, object[] values)
|
|||||||
| `object``[]` | values | |
|
| `object``[]` | values | |
|
||||||
|
|
||||||
#### IsInternal
|
#### IsInternal
|
||||||
|
[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Utilities.cs#L940)
|
||||||
```csharp
|
```csharp
|
||||||
public static bool IsInternal(IPAddress toTest)
|
public static bool IsInternal(IPAddress toTest)
|
||||||
```
|
```
|
||||||
@ -707,6 +749,7 @@ retrieves the external IP address of the current running machine
|
|||||||
|
|
||||||
|
|
||||||
#### IsQuickMessage
|
#### IsQuickMessage
|
||||||
|
[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Utilities.cs#L986)
|
||||||
```csharp
|
```csharp
|
||||||
public static bool IsQuickMessage(string message)
|
public static bool IsQuickMessage(string message)
|
||||||
```
|
```
|
||||||
@ -722,6 +765,7 @@ Determines if the given message is a quick message
|
|||||||
true if the
|
true if the
|
||||||
|
|
||||||
#### TrimNewLine
|
#### TrimNewLine
|
||||||
|
[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Utilities.cs#L996)
|
||||||
```csharp
|
```csharp
|
||||||
public static string TrimNewLine(string str)
|
public static string TrimNewLine(string str)
|
||||||
```
|
```
|
||||||
@ -737,6 +781,7 @@ trims new line and whitespace from string
|
|||||||
|
|
||||||
|
|
||||||
#### FixIW4Angles
|
#### FixIW4Angles
|
||||||
|
[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Utilities.cs#L1001)
|
||||||
```csharp
|
```csharp
|
||||||
public static Vector3 FixIW4Angles(Vector3 vector)
|
public static Vector3 FixIW4Angles(Vector3 vector)
|
||||||
```
|
```
|
||||||
@ -746,6 +791,7 @@ public static Vector3 FixIW4Angles(Vector3 vector)
|
|||||||
| `Vector3` | vector | |
|
| `Vector3` | vector | |
|
||||||
|
|
||||||
#### ToRadians
|
#### ToRadians
|
||||||
|
[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Utilities.cs#L1010)
|
||||||
```csharp
|
```csharp
|
||||||
public static float ToRadians(float value)
|
public static float ToRadians(float value)
|
||||||
```
|
```
|
||||||
@ -755,6 +801,7 @@ public static float ToRadians(float value)
|
|||||||
| `float` | value | |
|
| `float` | value | |
|
||||||
|
|
||||||
#### ToDegrees
|
#### ToDegrees
|
||||||
|
[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Utilities.cs#L1015)
|
||||||
```csharp
|
```csharp
|
||||||
public static float ToDegrees(float value)
|
public static float ToDegrees(float value)
|
||||||
```
|
```
|
||||||
@ -764,6 +811,7 @@ public static float ToDegrees(float value)
|
|||||||
| `float` | value | |
|
| `float` | value | |
|
||||||
|
|
||||||
#### AngleStuff
|
#### AngleStuff
|
||||||
|
[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Utilities.cs#L1020)
|
||||||
```csharp
|
```csharp
|
||||||
public static double AngleStuff(Vector3 a, Vector3 b)
|
public static double AngleStuff(Vector3 a, Vector3 b)
|
||||||
```
|
```
|
||||||
@ -781,7 +829,7 @@ public static async Task<bool> TryCreatePenalty(EFPenalty penalty, IEntityServic
|
|||||||
| Type | Name | Description |
|
| Type | Name | Description |
|
||||||
| --- | --- | --- |
|
| --- | --- | --- |
|
||||||
| `EFPenalty` | penalty | |
|
| `EFPenalty` | penalty | |
|
||||||
| [`IEntityService`](./sharedlibrarycoreinterfaces-IEntityServiceT)<`EFPenalty`> | penaltyService | |
|
| [`IEntityService`](interfaces/IEntityServiceT.md)<`EFPenalty`> | penaltyService | |
|
||||||
| `ILogger` | logger | |
|
| `ILogger` | logger | |
|
||||||
|
|
||||||
#### WithWaitCancellation [1/2]
|
#### WithWaitCancellation [1/2]
|
||||||
@ -830,6 +878,7 @@ public static async Task WithTimeout(Task task, TimeSpan timeout)
|
|||||||
| `TimeSpan` | timeout | |
|
| `TimeSpan` | timeout | |
|
||||||
|
|
||||||
#### ShouldHideLevel
|
#### ShouldHideLevel
|
||||||
|
[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Utilities.cs#L1094)
|
||||||
```csharp
|
```csharp
|
||||||
public static bool ShouldHideLevel(Permission perm)
|
public static bool ShouldHideLevel(Permission perm)
|
||||||
```
|
```
|
||||||
@ -839,6 +888,7 @@ public static bool ShouldHideLevel(Permission perm)
|
|||||||
| `Permission` | perm | |
|
| `Permission` | perm | |
|
||||||
|
|
||||||
#### SplitTranslationTokens
|
#### SplitTranslationTokens
|
||||||
|
[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Utilities.cs#L1104)
|
||||||
```csharp
|
```csharp
|
||||||
public static WebfrontTranslationHelper SplitTranslationTokens(string translationKey)
|
public static WebfrontTranslationHelper SplitTranslationTokens(string translationKey)
|
||||||
```
|
```
|
||||||
@ -854,6 +904,7 @@ parses translation string into tokens that are able to be formatted by the webfr
|
|||||||
|
|
||||||
|
|
||||||
#### FixDirectoryCharacters
|
#### FixDirectoryCharacters
|
||||||
|
[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Utilities.cs#L1156)
|
||||||
```csharp
|
```csharp
|
||||||
public static string FixDirectoryCharacters(string path)
|
public static string FixDirectoryCharacters(string path)
|
||||||
```
|
```
|
||||||
@ -869,6 +920,7 @@ replaces any directory separator chars with the platform specific character
|
|||||||
|
|
||||||
|
|
||||||
#### HumanizeForCurrentCulture [1/2]
|
#### HumanizeForCurrentCulture [1/2]
|
||||||
|
[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Utilities.cs#L1169)
|
||||||
```csharp
|
```csharp
|
||||||
public static string HumanizeForCurrentCulture(TimeSpan timeSpan, int precision, TimeUnit maxUnit, TimeUnit minUnit, string collectionSeparator, bool toWords)
|
public static string HumanizeForCurrentCulture(TimeSpan timeSpan, int precision, TimeUnit maxUnit, TimeUnit minUnit, string collectionSeparator, bool toWords)
|
||||||
```
|
```
|
||||||
@ -886,6 +938,7 @@ public static string HumanizeForCurrentCulture(TimeSpan timeSpan, int precision,
|
|||||||
wrapper method for humanizee that uses current current culture
|
wrapper method for humanizee that uses current current culture
|
||||||
|
|
||||||
#### HumanizeForCurrentCulture [2/2]
|
#### HumanizeForCurrentCulture [2/2]
|
||||||
|
[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Utilities.cs#L1179)
|
||||||
```csharp
|
```csharp
|
||||||
public static string HumanizeForCurrentCulture(DateTime input, bool utcDate, Nullable<DateTime> dateToCompareAgainst, CultureInfo culture)
|
public static string HumanizeForCurrentCulture(DateTime input, bool utcDate, Nullable<DateTime> dateToCompareAgainst, CultureInfo culture)
|
||||||
```
|
```
|
||||||
@ -898,15 +951,17 @@ public static string HumanizeForCurrentCulture(DateTime input, bool utcDate, Nul
|
|||||||
| `CultureInfo` | culture | |
|
| `CultureInfo` | culture | |
|
||||||
|
|
||||||
#### ToTranslatedName
|
#### ToTranslatedName
|
||||||
|
[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Utilities.cs#L1184)
|
||||||
```csharp
|
```csharp
|
||||||
public static string ToTranslatedName(MetaType metaType)
|
public static string ToTranslatedName(MetaType metaType)
|
||||||
```
|
```
|
||||||
##### Arguments
|
##### Arguments
|
||||||
| Type | Name | Description |
|
| Type | Name | Description |
|
||||||
| --- | --- | --- |
|
| --- | --- | --- |
|
||||||
| [`MetaType`](./sharedlibrarycoreinterfaces-MetaType) | metaType | |
|
| [`MetaType`](interfaces/MetaType.md) | metaType | |
|
||||||
|
|
||||||
#### ToPartialClient
|
#### ToPartialClient
|
||||||
|
[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Utilities.cs#L1189)
|
||||||
```csharp
|
```csharp
|
||||||
public static EFClient ToPartialClient(EFClient client)
|
public static EFClient ToPartialClient(EFClient client)
|
||||||
```
|
```
|
||||||
@ -916,6 +971,7 @@ public static EFClient ToPartialClient(EFClient client)
|
|||||||
| `EFClient` | client | |
|
| `EFClient` | client | |
|
||||||
|
|
||||||
#### ToNumericalString [1/4]
|
#### ToNumericalString [1/4]
|
||||||
|
[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Utilities.cs#L1215)
|
||||||
```csharp
|
```csharp
|
||||||
public static string ToNumericalString(Nullable<int> value)
|
public static string ToNumericalString(Nullable<int> value)
|
||||||
```
|
```
|
||||||
@ -925,6 +981,7 @@ public static string ToNumericalString(Nullable<int> value)
|
|||||||
| `Nullable`<`int`> | value | |
|
| `Nullable`<`int`> | value | |
|
||||||
|
|
||||||
#### ToNumericalString [2/4]
|
#### ToNumericalString [2/4]
|
||||||
|
[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Utilities.cs#L1220)
|
||||||
```csharp
|
```csharp
|
||||||
public static string ToNumericalString(int value)
|
public static string ToNumericalString(int value)
|
||||||
```
|
```
|
||||||
@ -934,6 +991,7 @@ public static string ToNumericalString(int value)
|
|||||||
| `int` | value | |
|
| `int` | value | |
|
||||||
|
|
||||||
#### ToNumericalString [3/4]
|
#### ToNumericalString [3/4]
|
||||||
|
[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Utilities.cs#L1225)
|
||||||
```csharp
|
```csharp
|
||||||
public static string ToNumericalString(double value, int precision)
|
public static string ToNumericalString(double value, int precision)
|
||||||
```
|
```
|
||||||
@ -944,6 +1002,7 @@ public static string ToNumericalString(double value, int precision)
|
|||||||
| `int` | precision | |
|
| `int` | precision | |
|
||||||
|
|
||||||
#### ToNumericalString [4/4]
|
#### ToNumericalString [4/4]
|
||||||
|
[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Utilities.cs#L1232)
|
||||||
```csharp
|
```csharp
|
||||||
public static string ToNumericalString(Nullable<double> value, int precision)
|
public static string ToNumericalString(Nullable<double> value, int precision)
|
||||||
```
|
```
|
||||||
@ -954,6 +1013,7 @@ public static string ToNumericalString(Nullable<double> value, int precision)
|
|||||||
| `int` | precision | |
|
| `int` | precision | |
|
||||||
|
|
||||||
#### FragmentMessageForDisplay
|
#### FragmentMessageForDisplay
|
||||||
|
[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Utilities.cs#L1237)
|
||||||
```csharp
|
```csharp
|
||||||
public static string FragmentMessageForDisplay(string message)
|
public static string FragmentMessageForDisplay(string message)
|
||||||
```
|
```
|
||||||
@ -963,6 +1023,7 @@ public static string FragmentMessageForDisplay(string message)
|
|||||||
| `string` | message | |
|
| `string` | message | |
|
||||||
|
|
||||||
#### FindRuleForReason
|
#### FindRuleForReason
|
||||||
|
[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Utilities.cs#L16707566)
|
||||||
```csharp
|
```csharp
|
||||||
public static string FindRuleForReason(string reason, ApplicationConfiguration appConfig, Server server)
|
public static string FindRuleForReason(string reason, ApplicationConfiguration appConfig, Server server)
|
||||||
```
|
```
|
||||||
@ -970,10 +1031,11 @@ public static string FindRuleForReason(string reason, ApplicationConfiguration a
|
|||||||
| Type | Name | Description |
|
| Type | Name | Description |
|
||||||
| --- | --- | --- |
|
| --- | --- | --- |
|
||||||
| `string` | reason | |
|
| `string` | reason | |
|
||||||
| [`ApplicationConfiguration`](./sharedlibrarycoreconfiguration-ApplicationConfiguration) | appConfig | |
|
| [`ApplicationConfiguration`](configuration/ApplicationConfiguration.md) | appConfig | |
|
||||||
| [`Server`](./sharedlibrarycore-Server) | server | |
|
| [`Server`](./Server.md) | server | |
|
||||||
|
|
||||||
#### MakeAbbreviation
|
#### MakeAbbreviation
|
||||||
|
[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Utilities.cs#L1294)
|
||||||
```csharp
|
```csharp
|
||||||
public static string MakeAbbreviation(string gameName)
|
public static string MakeAbbreviation(string gameName)
|
||||||
```
|
```
|
||||||
@ -983,6 +1045,7 @@ public static string MakeAbbreviation(string gameName)
|
|||||||
| `string` | gameName | |
|
| `string` | gameName | |
|
||||||
|
|
||||||
#### AddConfiguration
|
#### AddConfiguration
|
||||||
|
[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Utilities.cs#L16707566)
|
||||||
```csharp
|
```csharp
|
||||||
public static IServiceCollection AddConfiguration<TConfigurationType>(IServiceCollection serviceCollection, string fileName, TConfigurationType defaultConfig)
|
public static IServiceCollection AddConfiguration<TConfigurationType>(IServiceCollection serviceCollection, string fileName, TConfigurationType defaultConfig)
|
||||||
where TConfigurationType :
|
where TConfigurationType :
|
||||||
@ -995,6 +1058,7 @@ where TConfigurationType :
|
|||||||
| `TConfigurationType` | defaultConfig | |
|
| `TConfigurationType` | defaultConfig | |
|
||||||
|
|
||||||
#### ExecuteAfterDelay [1/3]
|
#### ExecuteAfterDelay [1/3]
|
||||||
|
[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Utilities.cs#L1337)
|
||||||
```csharp
|
```csharp
|
||||||
public static void ExecuteAfterDelay(TimeSpan duration, Func<CancellationToken, Task> action, CancellationToken token)
|
public static void ExecuteAfterDelay(TimeSpan duration, Func<CancellationToken, Task> action, CancellationToken token)
|
||||||
```
|
```
|
||||||
@ -1006,6 +1070,7 @@ public static void ExecuteAfterDelay(TimeSpan duration, Func<CancellationToken,
|
|||||||
| `CancellationToken` | token | |
|
| `CancellationToken` | token | |
|
||||||
|
|
||||||
#### ExecuteAfterDelay [2/3]
|
#### ExecuteAfterDelay [2/3]
|
||||||
|
[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Utilities.cs#L16707566)
|
||||||
```csharp
|
```csharp
|
||||||
public static void ExecuteAfterDelay(int delayMs, Func<CancellationToken, Task> action, CancellationToken token)
|
public static void ExecuteAfterDelay(int delayMs, Func<CancellationToken, Task> action, CancellationToken token)
|
||||||
```
|
```
|
||||||
@ -1017,6 +1082,7 @@ public static void ExecuteAfterDelay(int delayMs, Func<CancellationToken, Task>
|
|||||||
| `CancellationToken` | token | |
|
| `CancellationToken` | token | |
|
||||||
|
|
||||||
#### ExecuteAfterDelay [3/3]
|
#### ExecuteAfterDelay [3/3]
|
||||||
|
[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Utilities.cs#L1359)
|
||||||
```csharp
|
```csharp
|
||||||
public static void ExecuteAfterDelay(Func<CancellationToken, Task> action, int delayMs, CancellationToken token)
|
public static void ExecuteAfterDelay(Func<CancellationToken, Task> action, int delayMs, CancellationToken token)
|
||||||
```
|
```
|
||||||
@ -1028,11 +1094,13 @@ public static void ExecuteAfterDelay(Func<CancellationToken, Task> action, int d
|
|||||||
| `CancellationToken` | token | |
|
| `CancellationToken` | token | |
|
||||||
|
|
||||||
#### <PromptInt>g__InputOrDefault|55_0
|
#### <PromptInt>g__InputOrDefault|55_0
|
||||||
|
[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Utilities.cs#L690)
|
||||||
```csharp
|
```csharp
|
||||||
internal static string <PromptInt>g__InputOrDefault|55_0()
|
internal static string <PromptInt>g__InputOrDefault|55_0()
|
||||||
```
|
```
|
||||||
|
|
||||||
#### <PromptString>g__InputOrDefault|56_0
|
#### <PromptString>g__InputOrDefault|56_0
|
||||||
|
[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Utilities.cs#L721)
|
||||||
```csharp
|
```csharp
|
||||||
internal static string <PromptString>g__InputOrDefault|56_0()
|
internal static string <PromptString>g__InputOrDefault|56_0()
|
||||||
```
|
```
|
@ -38,12 +38,14 @@
|
|||||||
## Details
|
## Details
|
||||||
### Constructors
|
### Constructors
|
||||||
#### AlertState
|
#### AlertState
|
||||||
|
[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Alerts/Alert.cs#L18)
|
||||||
```csharp
|
```csharp
|
||||||
public AlertState()
|
public AlertState()
|
||||||
```
|
```
|
||||||
|
|
||||||
### Methods
|
### Methods
|
||||||
#### Build
|
#### Build
|
||||||
|
[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Alerts/Alert.cs#L31)
|
||||||
```csharp
|
```csharp
|
||||||
public static AlertState Build()
|
public static AlertState Build()
|
||||||
```
|
```
|
@ -23,7 +23,7 @@ SharedLibraryCore.Command --> SharedLibraryCore.Commands.BanCommand
|
|||||||
#### Public methods
|
#### Public methods
|
||||||
| Returns | Name |
|
| Returns | Name |
|
||||||
| --- | --- |
|
| --- | --- |
|
||||||
| `Task` | [`ExecuteAsync`](#executeasync)([`GameEvent`](./sharedlibrarycore-GameEvent) gameEvent) |
|
| `Task` | [`ExecuteAsync`](#executeasync)([`GameEvent`](../GameEvent.md) gameEvent) |
|
||||||
|
|
||||||
## Details
|
## Details
|
||||||
### Summary
|
### Summary
|
||||||
@ -32,19 +32,20 @@ Permanently bans a client
|
|||||||
### Inheritance
|
### Inheritance
|
||||||
- [
|
- [
|
||||||
`Command`
|
`Command`
|
||||||
](./sharedlibrarycore-Command)
|
](../Command.md)
|
||||||
|
|
||||||
### Constructors
|
### Constructors
|
||||||
#### BanCommand
|
#### BanCommand
|
||||||
|
[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Commands/NativeCommands.cs#L308)
|
||||||
```csharp
|
```csharp
|
||||||
public BanCommand(ApplicationConfiguration appConfig, CommandConfiguration config, ITranslationLookup translationLookup)
|
public BanCommand(ApplicationConfiguration appConfig, CommandConfiguration config, ITranslationLookup translationLookup)
|
||||||
```
|
```
|
||||||
##### Arguments
|
##### Arguments
|
||||||
| Type | Name | Description |
|
| Type | Name | Description |
|
||||||
| --- | --- | --- |
|
| --- | --- | --- |
|
||||||
| [`ApplicationConfiguration`](./sharedlibrarycoreconfiguration-ApplicationConfiguration) | appConfig | |
|
| [`ApplicationConfiguration`](../configuration/ApplicationConfiguration.md) | appConfig | |
|
||||||
| [`CommandConfiguration`](./sharedlibrarycoreconfiguration-CommandConfiguration) | config | |
|
| [`CommandConfiguration`](../configuration/CommandConfiguration.md) | config | |
|
||||||
| [`ITranslationLookup`](./sharedlibrarycoreinterfaces-ITranslationLookup) | translationLookup | |
|
| [`ITranslationLookup`](../interfaces/ITranslationLookup.md) | translationLookup | |
|
||||||
|
|
||||||
### Methods
|
### Methods
|
||||||
#### ExecuteAsync
|
#### ExecuteAsync
|
||||||
@ -54,6 +55,6 @@ public override async Task ExecuteAsync(GameEvent gameEvent)
|
|||||||
##### Arguments
|
##### Arguments
|
||||||
| Type | Name | Description |
|
| Type | Name | Description |
|
||||||
| --- | --- | --- |
|
| --- | --- | --- |
|
||||||
| [`GameEvent`](./sharedlibrarycore-GameEvent) | gameEvent | |
|
| [`GameEvent`](../GameEvent.md) | gameEvent | |
|
||||||
|
|
||||||
*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc)
|
*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc)
|
@ -15,27 +15,29 @@
|
|||||||
#### Public Static methods
|
#### Public Static methods
|
||||||
| Returns | Name |
|
| Returns | Name |
|
||||||
| --- | --- |
|
| --- | --- |
|
||||||
| `bool` | [`CanPerformActionOnTarget`](#canperformactionontarget)([`GameEvent`](./sharedlibrarycore-GameEvent) gameEvent) |
|
| `bool` | [`CanPerformActionOnTarget`](#canperformactionontarget)([`GameEvent`](../GameEvent.md) gameEvent) |
|
||||||
| `bool` | [`IsTargetingSelf`](#istargetingself)([`GameEvent`](./sharedlibrarycore-GameEvent) gameEvent) |
|
| `bool` | [`IsTargetingSelf`](#istargetingself)([`GameEvent`](../GameEvent.md) gameEvent) |
|
||||||
|
|
||||||
## Details
|
## Details
|
||||||
### Methods
|
### Methods
|
||||||
#### IsTargetingSelf
|
#### IsTargetingSelf
|
||||||
|
[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Commands/CommandExtensions.cs#L6)
|
||||||
```csharp
|
```csharp
|
||||||
public static bool IsTargetingSelf(GameEvent gameEvent)
|
public static bool IsTargetingSelf(GameEvent gameEvent)
|
||||||
```
|
```
|
||||||
##### Arguments
|
##### Arguments
|
||||||
| Type | Name | Description |
|
| Type | Name | Description |
|
||||||
| --- | --- | --- |
|
| --- | --- | --- |
|
||||||
| [`GameEvent`](./sharedlibrarycore-GameEvent) | gameEvent | |
|
| [`GameEvent`](../GameEvent.md) | gameEvent | |
|
||||||
|
|
||||||
#### CanPerformActionOnTarget
|
#### CanPerformActionOnTarget
|
||||||
|
[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Commands/CommandExtensions.cs#L11)
|
||||||
```csharp
|
```csharp
|
||||||
public static bool CanPerformActionOnTarget(GameEvent gameEvent)
|
public static bool CanPerformActionOnTarget(GameEvent gameEvent)
|
||||||
```
|
```
|
||||||
##### Arguments
|
##### Arguments
|
||||||
| Type | Name | Description |
|
| Type | Name | Description |
|
||||||
| --- | --- | --- |
|
| --- | --- | --- |
|
||||||
| [`GameEvent`](./sharedlibrarycore-GameEvent) | gameEvent | |
|
| [`GameEvent`](../GameEvent.md) | gameEvent | |
|
||||||
|
|
||||||
*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc)
|
*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc)
|
@ -15,7 +15,7 @@
|
|||||||
#### Public Static methods
|
#### Public Static methods
|
||||||
| Returns | Name |
|
| Returns | Name |
|
||||||
| --- | --- |
|
| --- | --- |
|
||||||
| `Task`<[`Command`](./sharedlibrarycore-Command)> | [`ValidateCommand`](#validatecommand)([`GameEvent`](./sharedlibrarycore-GameEvent) gameEvent, [`ApplicationConfiguration`](./sharedlibrarycoreconfiguration-ApplicationConfiguration) appConfig, [`CommandConfiguration`](./sharedlibrarycoreconfiguration-CommandConfiguration) commandConfig) |
|
| `Task`<[`Command`](../Command.md)> | [`ValidateCommand`](#validatecommand)([`GameEvent`](../GameEvent.md) gameEvent, [`ApplicationConfiguration`](../configuration/ApplicationConfiguration.md) appConfig, [`CommandConfiguration`](../configuration/CommandConfiguration.md) commandConfig) |
|
||||||
|
|
||||||
## Details
|
## Details
|
||||||
### Constructors
|
### Constructors
|
||||||
@ -32,8 +32,8 @@ public static async Task<Command> ValidateCommand(GameEvent gameEvent, Applicati
|
|||||||
##### Arguments
|
##### Arguments
|
||||||
| Type | Name | Description |
|
| Type | Name | Description |
|
||||||
| --- | --- | --- |
|
| --- | --- | --- |
|
||||||
| [`GameEvent`](./sharedlibrarycore-GameEvent) | gameEvent | |
|
| [`GameEvent`](../GameEvent.md) | gameEvent | |
|
||||||
| [`ApplicationConfiguration`](./sharedlibrarycoreconfiguration-ApplicationConfiguration) | appConfig | |
|
| [`ApplicationConfiguration`](../configuration/ApplicationConfiguration.md) | appConfig | |
|
||||||
| [`CommandConfiguration`](./sharedlibrarycoreconfiguration-CommandConfiguration) | commandConfig | |
|
| [`CommandConfiguration`](../configuration/CommandConfiguration.md) | commandConfig | |
|
||||||
|
|
||||||
*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc)
|
*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc)
|
@ -23,7 +23,7 @@ SharedLibraryCore.Command --> SharedLibraryCore.Commands.ExecuteRConCommand
|
|||||||
#### Public methods
|
#### Public methods
|
||||||
| Returns | Name |
|
| Returns | Name |
|
||||||
| --- | --- |
|
| --- | --- |
|
||||||
| `Task` | [`ExecuteAsync`](#executeasync)([`GameEvent`](./sharedlibrarycore-GameEvent) E) |
|
| `Task` | [`ExecuteAsync`](#executeasync)([`GameEvent`](../GameEvent.md) E) |
|
||||||
|
|
||||||
## Details
|
## Details
|
||||||
### Summary
|
### Summary
|
||||||
@ -32,18 +32,19 @@ Executes RCon command
|
|||||||
### Inheritance
|
### Inheritance
|
||||||
- [
|
- [
|
||||||
`Command`
|
`Command`
|
||||||
](./sharedlibrarycore-Command)
|
](../Command.md)
|
||||||
|
|
||||||
### Constructors
|
### Constructors
|
||||||
#### ExecuteRConCommand
|
#### ExecuteRConCommand
|
||||||
|
[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Commands/NativeCommands.cs#L927)
|
||||||
```csharp
|
```csharp
|
||||||
public ExecuteRConCommand(CommandConfiguration config, ITranslationLookup translationLookup)
|
public ExecuteRConCommand(CommandConfiguration config, ITranslationLookup translationLookup)
|
||||||
```
|
```
|
||||||
##### Arguments
|
##### Arguments
|
||||||
| Type | Name | Description |
|
| Type | Name | Description |
|
||||||
| --- | --- | --- |
|
| --- | --- | --- |
|
||||||
| [`CommandConfiguration`](./sharedlibrarycoreconfiguration-CommandConfiguration) | config | |
|
| [`CommandConfiguration`](../configuration/CommandConfiguration.md) | config | |
|
||||||
| [`ITranslationLookup`](./sharedlibrarycoreinterfaces-ITranslationLookup) | translationLookup | |
|
| [`ITranslationLookup`](../interfaces/ITranslationLookup.md) | translationLookup | |
|
||||||
|
|
||||||
### Methods
|
### Methods
|
||||||
#### ExecuteAsync
|
#### ExecuteAsync
|
||||||
@ -53,6 +54,6 @@ public override async Task ExecuteAsync(GameEvent E)
|
|||||||
##### Arguments
|
##### Arguments
|
||||||
| Type | Name | Description |
|
| Type | Name | Description |
|
||||||
| --- | --- | --- |
|
| --- | --- | --- |
|
||||||
| [`GameEvent`](./sharedlibrarycore-GameEvent) | E | |
|
| [`GameEvent`](../GameEvent.md) | E | |
|
||||||
|
|
||||||
*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc)
|
*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc)
|
@ -23,7 +23,7 @@ SharedLibraryCore.Command --> SharedLibraryCore.Commands.FastRestartCommand
|
|||||||
#### Public methods
|
#### Public methods
|
||||||
| Returns | Name |
|
| Returns | Name |
|
||||||
| --- | --- |
|
| --- | --- |
|
||||||
| `Task` | [`ExecuteAsync`](#executeasync)([`GameEvent`](./sharedlibrarycore-GameEvent) E) |
|
| `Task` | [`ExecuteAsync`](#executeasync)([`GameEvent`](../GameEvent.md) E) |
|
||||||
|
|
||||||
## Details
|
## Details
|
||||||
### Summary
|
### Summary
|
||||||
@ -32,18 +32,19 @@ Fast restarts the map
|
|||||||
### Inheritance
|
### Inheritance
|
||||||
- [
|
- [
|
||||||
`Command`
|
`Command`
|
||||||
](./sharedlibrarycore-Command)
|
](../Command.md)
|
||||||
|
|
||||||
### Constructors
|
### Constructors
|
||||||
#### FastRestartCommand
|
#### FastRestartCommand
|
||||||
|
[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Commands/NativeCommands.cs#L413)
|
||||||
```csharp
|
```csharp
|
||||||
public FastRestartCommand(CommandConfiguration config, ITranslationLookup translationLookup)
|
public FastRestartCommand(CommandConfiguration config, ITranslationLookup translationLookup)
|
||||||
```
|
```
|
||||||
##### Arguments
|
##### Arguments
|
||||||
| Type | Name | Description |
|
| Type | Name | Description |
|
||||||
| --- | --- | --- |
|
| --- | --- | --- |
|
||||||
| [`CommandConfiguration`](./sharedlibrarycoreconfiguration-CommandConfiguration) | config | |
|
| [`CommandConfiguration`](../configuration/CommandConfiguration.md) | config | |
|
||||||
| [`ITranslationLookup`](./sharedlibrarycoreinterfaces-ITranslationLookup) | translationLookup | |
|
| [`ITranslationLookup`](../interfaces/ITranslationLookup.md) | translationLookup | |
|
||||||
|
|
||||||
### Methods
|
### Methods
|
||||||
#### ExecuteAsync
|
#### ExecuteAsync
|
||||||
@ -53,6 +54,6 @@ public override async Task ExecuteAsync(GameEvent E)
|
|||||||
##### Arguments
|
##### Arguments
|
||||||
| Type | Name | Description |
|
| Type | Name | Description |
|
||||||
| --- | --- | --- |
|
| --- | --- | --- |
|
||||||
| [`GameEvent`](./sharedlibrarycore-GameEvent) | E | |
|
| [`GameEvent`](../GameEvent.md) | E | |
|
||||||
|
|
||||||
*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc)
|
*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc)
|
@ -23,7 +23,7 @@ SharedLibraryCore.Command --> SharedLibraryCore.Commands.FlagClientCommand
|
|||||||
#### Public methods
|
#### Public methods
|
||||||
| Returns | Name |
|
| Returns | Name |
|
||||||
| --- | --- |
|
| --- | --- |
|
||||||
| `Task` | [`ExecuteAsync`](#executeasync)([`GameEvent`](./sharedlibrarycore-GameEvent) E) |
|
| `Task` | [`ExecuteAsync`](#executeasync)([`GameEvent`](../GameEvent.md) E) |
|
||||||
|
|
||||||
## Details
|
## Details
|
||||||
### Summary
|
### Summary
|
||||||
@ -32,18 +32,19 @@ Flag given client for specified reason
|
|||||||
### Inheritance
|
### Inheritance
|
||||||
- [
|
- [
|
||||||
`Command`
|
`Command`
|
||||||
](./sharedlibrarycore-Command)
|
](../Command.md)
|
||||||
|
|
||||||
### Constructors
|
### Constructors
|
||||||
#### FlagClientCommand
|
#### FlagClientCommand
|
||||||
|
[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Commands/NativeCommands.cs#L748)
|
||||||
```csharp
|
```csharp
|
||||||
public FlagClientCommand(CommandConfiguration config, ITranslationLookup translationLookup)
|
public FlagClientCommand(CommandConfiguration config, ITranslationLookup translationLookup)
|
||||||
```
|
```
|
||||||
##### Arguments
|
##### Arguments
|
||||||
| Type | Name | Description |
|
| Type | Name | Description |
|
||||||
| --- | --- | --- |
|
| --- | --- | --- |
|
||||||
| [`CommandConfiguration`](./sharedlibrarycoreconfiguration-CommandConfiguration) | config | |
|
| [`CommandConfiguration`](../configuration/CommandConfiguration.md) | config | |
|
||||||
| [`ITranslationLookup`](./sharedlibrarycoreinterfaces-ITranslationLookup) | translationLookup | |
|
| [`ITranslationLookup`](../interfaces/ITranslationLookup.md) | translationLookup | |
|
||||||
|
|
||||||
### Methods
|
### Methods
|
||||||
#### ExecuteAsync
|
#### ExecuteAsync
|
||||||
@ -53,6 +54,6 @@ public override async Task ExecuteAsync(GameEvent E)
|
|||||||
##### Arguments
|
##### Arguments
|
||||||
| Type | Name | Description |
|
| Type | Name | Description |
|
||||||
| --- | --- | --- |
|
| --- | --- | --- |
|
||||||
| [`GameEvent`](./sharedlibrarycore-GameEvent) | E | |
|
| [`GameEvent`](../GameEvent.md) | E | |
|
||||||
|
|
||||||
*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc)
|
*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc)
|
@ -23,7 +23,7 @@ SharedLibraryCore.Command --> SharedLibraryCore.Commands.GetClientPingCommand
|
|||||||
#### Public methods
|
#### Public methods
|
||||||
| Returns | Name |
|
| Returns | Name |
|
||||||
| --- | --- |
|
| --- | --- |
|
||||||
| `Task` | [`ExecuteAsync`](#executeasync)([`GameEvent`](./sharedlibrarycore-GameEvent) E) |
|
| `Task` | [`ExecuteAsync`](#executeasync)([`GameEvent`](../GameEvent.md) E) |
|
||||||
|
|
||||||
## Details
|
## Details
|
||||||
### Summary
|
### Summary
|
||||||
@ -32,27 +32,29 @@ Gets the ping of a client
|
|||||||
### Inheritance
|
### Inheritance
|
||||||
- [
|
- [
|
||||||
`Command`
|
`Command`
|
||||||
](./sharedlibrarycore-Command)
|
](../Command.md)
|
||||||
|
|
||||||
### Constructors
|
### Constructors
|
||||||
#### GetClientPingCommand
|
#### GetClientPingCommand
|
||||||
|
[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Commands/NativeCommands.cs#L1093)
|
||||||
```csharp
|
```csharp
|
||||||
public GetClientPingCommand(CommandConfiguration config, ITranslationLookup translationLookup)
|
public GetClientPingCommand(CommandConfiguration config, ITranslationLookup translationLookup)
|
||||||
```
|
```
|
||||||
##### Arguments
|
##### Arguments
|
||||||
| Type | Name | Description |
|
| Type | Name | Description |
|
||||||
| --- | --- | --- |
|
| --- | --- | --- |
|
||||||
| [`CommandConfiguration`](./sharedlibrarycoreconfiguration-CommandConfiguration) | config | |
|
| [`CommandConfiguration`](../configuration/CommandConfiguration.md) | config | |
|
||||||
| [`ITranslationLookup`](./sharedlibrarycoreinterfaces-ITranslationLookup) | translationLookup | |
|
| [`ITranslationLookup`](../interfaces/ITranslationLookup.md) | translationLookup | |
|
||||||
|
|
||||||
### Methods
|
### Methods
|
||||||
#### ExecuteAsync
|
#### ExecuteAsync
|
||||||
|
[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Commands/NativeCommands.cs#L1112)
|
||||||
```csharp
|
```csharp
|
||||||
public override Task ExecuteAsync(GameEvent E)
|
public override Task ExecuteAsync(GameEvent E)
|
||||||
```
|
```
|
||||||
##### Arguments
|
##### Arguments
|
||||||
| Type | Name | Description |
|
| Type | Name | Description |
|
||||||
| --- | --- | --- |
|
| --- | --- | --- |
|
||||||
| [`GameEvent`](./sharedlibrarycore-GameEvent) | E | |
|
| [`GameEvent`](../GameEvent.md) | E | |
|
||||||
|
|
||||||
*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc)
|
*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc)
|
@ -23,7 +23,7 @@ SharedLibraryCore.Command --> SharedLibraryCore.Commands.KickCommand
|
|||||||
#### Public methods
|
#### Public methods
|
||||||
| Returns | Name |
|
| Returns | Name |
|
||||||
| --- | --- |
|
| --- | --- |
|
||||||
| `Task` | [`ExecuteAsync`](#executeasync)([`GameEvent`](./sharedlibrarycore-GameEvent) gameEvent) |
|
| `Task` | [`ExecuteAsync`](#executeasync)([`GameEvent`](../GameEvent.md) gameEvent) |
|
||||||
|
|
||||||
## Details
|
## Details
|
||||||
### Summary
|
### Summary
|
||||||
@ -32,19 +32,20 @@ Kicks client for given reason
|
|||||||
### Inheritance
|
### Inheritance
|
||||||
- [
|
- [
|
||||||
`Command`
|
`Command`
|
||||||
](./sharedlibrarycore-Command)
|
](../Command.md)
|
||||||
|
|
||||||
### Constructors
|
### Constructors
|
||||||
#### KickCommand
|
#### KickCommand
|
||||||
|
[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Commands/NativeCommands.cs#L185)
|
||||||
```csharp
|
```csharp
|
||||||
public KickCommand(ApplicationConfiguration appConfig, CommandConfiguration config, ITranslationLookup translationLookup)
|
public KickCommand(ApplicationConfiguration appConfig, CommandConfiguration config, ITranslationLookup translationLookup)
|
||||||
```
|
```
|
||||||
##### Arguments
|
##### Arguments
|
||||||
| Type | Name | Description |
|
| Type | Name | Description |
|
||||||
| --- | --- | --- |
|
| --- | --- | --- |
|
||||||
| [`ApplicationConfiguration`](./sharedlibrarycoreconfiguration-ApplicationConfiguration) | appConfig | |
|
| [`ApplicationConfiguration`](../configuration/ApplicationConfiguration.md) | appConfig | |
|
||||||
| [`CommandConfiguration`](./sharedlibrarycoreconfiguration-CommandConfiguration) | config | |
|
| [`CommandConfiguration`](../configuration/CommandConfiguration.md) | config | |
|
||||||
| [`ITranslationLookup`](./sharedlibrarycoreinterfaces-ITranslationLookup) | translationLookup | |
|
| [`ITranslationLookup`](../interfaces/ITranslationLookup.md) | translationLookup | |
|
||||||
|
|
||||||
### Methods
|
### Methods
|
||||||
#### ExecuteAsync
|
#### ExecuteAsync
|
||||||
@ -54,6 +55,6 @@ public override async Task ExecuteAsync(GameEvent gameEvent)
|
|||||||
##### Arguments
|
##### Arguments
|
||||||
| Type | Name | Description |
|
| Type | Name | Description |
|
||||||
| --- | --- | --- |
|
| --- | --- | --- |
|
||||||
| [`GameEvent`](./sharedlibrarycore-GameEvent) | gameEvent | |
|
| [`GameEvent`](../GameEvent.md) | gameEvent | |
|
||||||
|
|
||||||
*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc)
|
*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc)
|
@ -23,7 +23,7 @@ SharedLibraryCore.Command --> SharedLibraryCore.Commands.ListBanInfoCommand
|
|||||||
#### Public methods
|
#### Public methods
|
||||||
| Returns | Name |
|
| Returns | Name |
|
||||||
| --- | --- |
|
| --- | --- |
|
||||||
| `Task` | [`ExecuteAsync`](#executeasync)([`GameEvent`](./sharedlibrarycore-GameEvent) E) |
|
| `Task` | [`ExecuteAsync`](#executeasync)([`GameEvent`](../GameEvent.md) E) |
|
||||||
|
|
||||||
## Details
|
## Details
|
||||||
### Summary
|
### Summary
|
||||||
@ -32,18 +32,19 @@ Lists ban information for given client
|
|||||||
### Inheritance
|
### Inheritance
|
||||||
- [
|
- [
|
||||||
`Command`
|
`Command`
|
||||||
](./sharedlibrarycore-Command)
|
](../Command.md)
|
||||||
|
|
||||||
### Constructors
|
### Constructors
|
||||||
#### ListBanInfoCommand
|
#### ListBanInfoCommand
|
||||||
|
[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Commands/NativeCommands.cs#L878)
|
||||||
```csharp
|
```csharp
|
||||||
public ListBanInfoCommand(CommandConfiguration config, ITranslationLookup translationLookup)
|
public ListBanInfoCommand(CommandConfiguration config, ITranslationLookup translationLookup)
|
||||||
```
|
```
|
||||||
##### Arguments
|
##### Arguments
|
||||||
| Type | Name | Description |
|
| Type | Name | Description |
|
||||||
| --- | --- | --- |
|
| --- | --- | --- |
|
||||||
| [`CommandConfiguration`](./sharedlibrarycoreconfiguration-CommandConfiguration) | config | |
|
| [`CommandConfiguration`](../configuration/CommandConfiguration.md) | config | |
|
||||||
| [`ITranslationLookup`](./sharedlibrarycoreinterfaces-ITranslationLookup) | translationLookup | |
|
| [`ITranslationLookup`](../interfaces/ITranslationLookup.md) | translationLookup | |
|
||||||
|
|
||||||
### Methods
|
### Methods
|
||||||
#### ExecuteAsync
|
#### ExecuteAsync
|
||||||
@ -53,6 +54,6 @@ public override async Task ExecuteAsync(GameEvent E)
|
|||||||
##### Arguments
|
##### Arguments
|
||||||
| Type | Name | Description |
|
| Type | Name | Description |
|
||||||
| --- | --- | --- |
|
| --- | --- | --- |
|
||||||
| [`GameEvent`](./sharedlibrarycore-GameEvent) | E | |
|
| [`GameEvent`](../GameEvent.md) | E | |
|
||||||
|
|
||||||
*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc)
|
*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc)
|
@ -23,7 +23,7 @@ SharedLibraryCore.Command --> SharedLibraryCore.Commands.ListExternalIPCommand
|
|||||||
#### Public methods
|
#### Public methods
|
||||||
| Returns | Name |
|
| Returns | Name |
|
||||||
| --- | --- |
|
| --- | --- |
|
||||||
| `Task` | [`ExecuteAsync`](#executeasync)([`GameEvent`](./sharedlibrarycore-GameEvent) E) |
|
| `Task` | [`ExecuteAsync`](#executeasync)([`GameEvent`](../GameEvent.md) E) |
|
||||||
|
|
||||||
## Details
|
## Details
|
||||||
### Summary
|
### Summary
|
||||||
@ -32,27 +32,29 @@ Lists external IP
|
|||||||
### Inheritance
|
### Inheritance
|
||||||
- [
|
- [
|
||||||
`Command`
|
`Command`
|
||||||
](./sharedlibrarycore-Command)
|
](../Command.md)
|
||||||
|
|
||||||
### Constructors
|
### Constructors
|
||||||
#### ListExternalIPCommand
|
#### ListExternalIPCommand
|
||||||
|
[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Commands/NativeCommands.cs#L963)
|
||||||
```csharp
|
```csharp
|
||||||
public ListExternalIPCommand(CommandConfiguration config, ITranslationLookup translationLookup)
|
public ListExternalIPCommand(CommandConfiguration config, ITranslationLookup translationLookup)
|
||||||
```
|
```
|
||||||
##### Arguments
|
##### Arguments
|
||||||
| Type | Name | Description |
|
| Type | Name | Description |
|
||||||
| --- | --- | --- |
|
| --- | --- | --- |
|
||||||
| [`CommandConfiguration`](./sharedlibrarycoreconfiguration-CommandConfiguration) | config | |
|
| [`CommandConfiguration`](../configuration/CommandConfiguration.md) | config | |
|
||||||
| [`ITranslationLookup`](./sharedlibrarycoreinterfaces-ITranslationLookup) | translationLookup | |
|
| [`ITranslationLookup`](../interfaces/ITranslationLookup.md) | translationLookup | |
|
||||||
|
|
||||||
### Methods
|
### Methods
|
||||||
#### ExecuteAsync
|
#### ExecuteAsync
|
||||||
|
[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Commands/NativeCommands.cs#L974)
|
||||||
```csharp
|
```csharp
|
||||||
public override Task ExecuteAsync(GameEvent E)
|
public override Task ExecuteAsync(GameEvent E)
|
||||||
```
|
```
|
||||||
##### Arguments
|
##### Arguments
|
||||||
| Type | Name | Description |
|
| Type | Name | Description |
|
||||||
| --- | --- | --- |
|
| --- | --- | --- |
|
||||||
| [`GameEvent`](./sharedlibrarycore-GameEvent) | E | |
|
| [`GameEvent`](../GameEvent.md) | E | |
|
||||||
|
|
||||||
*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc)
|
*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc)
|
@ -23,7 +23,7 @@ SharedLibraryCore.Command --> SharedLibraryCore.Commands.ListRulesCommands
|
|||||||
#### Public methods
|
#### Public methods
|
||||||
| Returns | Name |
|
| Returns | Name |
|
||||||
| --- | --- |
|
| --- | --- |
|
||||||
| `Task` | [`ExecuteAsync`](#executeasync)([`GameEvent`](./sharedlibrarycore-GameEvent) gameEvent) |
|
| `Task` | [`ExecuteAsync`](#executeasync)([`GameEvent`](../GameEvent.md) gameEvent) |
|
||||||
|
|
||||||
## Details
|
## Details
|
||||||
### Summary
|
### Summary
|
||||||
@ -32,18 +32,19 @@ Lists server and global rules
|
|||||||
### Inheritance
|
### Inheritance
|
||||||
- [
|
- [
|
||||||
`Command`
|
`Command`
|
||||||
](./sharedlibrarycore-Command)
|
](../Command.md)
|
||||||
|
|
||||||
### Constructors
|
### Constructors
|
||||||
#### ListRulesCommands
|
#### ListRulesCommands
|
||||||
|
[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Commands/NativeCommands.cs#L700)
|
||||||
```csharp
|
```csharp
|
||||||
public ListRulesCommands(CommandConfiguration config, ITranslationLookup translationLookup)
|
public ListRulesCommands(CommandConfiguration config, ITranslationLookup translationLookup)
|
||||||
```
|
```
|
||||||
##### Arguments
|
##### Arguments
|
||||||
| Type | Name | Description |
|
| Type | Name | Description |
|
||||||
| --- | --- | --- |
|
| --- | --- | --- |
|
||||||
| [`CommandConfiguration`](./sharedlibrarycoreconfiguration-CommandConfiguration) | config | |
|
| [`CommandConfiguration`](../configuration/CommandConfiguration.md) | config | |
|
||||||
| [`ITranslationLookup`](./sharedlibrarycoreinterfaces-ITranslationLookup) | translationLookup | |
|
| [`ITranslationLookup`](../interfaces/ITranslationLookup.md) | translationLookup | |
|
||||||
|
|
||||||
### Methods
|
### Methods
|
||||||
#### ExecuteAsync
|
#### ExecuteAsync
|
||||||
@ -53,6 +54,6 @@ public override async Task ExecuteAsync(GameEvent gameEvent)
|
|||||||
##### Arguments
|
##### Arguments
|
||||||
| Type | Name | Description |
|
| Type | Name | Description |
|
||||||
| --- | --- | --- |
|
| --- | --- | --- |
|
||||||
| [`GameEvent`](./sharedlibrarycore-GameEvent) | gameEvent | |
|
| [`GameEvent`](../GameEvent.md) | gameEvent | |
|
||||||
|
|
||||||
*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc)
|
*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc)
|
@ -23,7 +23,7 @@ SharedLibraryCore.Command --> SharedLibraryCore.Commands.LoadMapCommand
|
|||||||
#### Public methods
|
#### Public methods
|
||||||
| Returns | Name |
|
| Returns | Name |
|
||||||
| --- | --- |
|
| --- | --- |
|
||||||
| `Task` | [`ExecuteAsync`](#executeasync)([`GameEvent`](./sharedlibrarycore-GameEvent) E) |
|
| `Task` | [`ExecuteAsync`](#executeasync)([`GameEvent`](../GameEvent.md) E) |
|
||||||
|
|
||||||
## Details
|
## Details
|
||||||
### Summary
|
### Summary
|
||||||
@ -32,18 +32,19 @@ Attempts to load the specified map
|
|||||||
### Inheritance
|
### Inheritance
|
||||||
- [
|
- [
|
||||||
`Command`
|
`Command`
|
||||||
](./sharedlibrarycore-Command)
|
](../Command.md)
|
||||||
|
|
||||||
### Constructors
|
### Constructors
|
||||||
#### LoadMapCommand
|
#### LoadMapCommand
|
||||||
|
[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Commands/NativeCommands.cs#L658)
|
||||||
```csharp
|
```csharp
|
||||||
public LoadMapCommand(CommandConfiguration config, ITranslationLookup translationLookup)
|
public LoadMapCommand(CommandConfiguration config, ITranslationLookup translationLookup)
|
||||||
```
|
```
|
||||||
##### Arguments
|
##### Arguments
|
||||||
| Type | Name | Description |
|
| Type | Name | Description |
|
||||||
| --- | --- | --- |
|
| --- | --- | --- |
|
||||||
| [`CommandConfiguration`](./sharedlibrarycoreconfiguration-CommandConfiguration) | config | |
|
| [`CommandConfiguration`](../configuration/CommandConfiguration.md) | config | |
|
||||||
| [`ITranslationLookup`](./sharedlibrarycoreinterfaces-ITranslationLookup) | translationLookup | |
|
| [`ITranslationLookup`](../interfaces/ITranslationLookup.md) | translationLookup | |
|
||||||
|
|
||||||
### Methods
|
### Methods
|
||||||
#### ExecuteAsync
|
#### ExecuteAsync
|
||||||
@ -53,6 +54,6 @@ public override async Task ExecuteAsync(GameEvent E)
|
|||||||
##### Arguments
|
##### Arguments
|
||||||
| Type | Name | Description |
|
| Type | Name | Description |
|
||||||
| --- | --- | --- |
|
| --- | --- | --- |
|
||||||
| [`GameEvent`](./sharedlibrarycore-GameEvent) | E | |
|
| [`GameEvent`](../GameEvent.md) | E | |
|
||||||
|
|
||||||
*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc)
|
*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc)
|
@ -23,7 +23,7 @@ SharedLibraryCore.Command --> SharedLibraryCore.Commands.MapRotateCommand
|
|||||||
#### Public methods
|
#### Public methods
|
||||||
| Returns | Name |
|
| Returns | Name |
|
||||||
| --- | --- |
|
| --- | --- |
|
||||||
| `Task` | [`ExecuteAsync`](#executeasync)([`GameEvent`](./sharedlibrarycore-GameEvent) E) |
|
| `Task` | [`ExecuteAsync`](#executeasync)([`GameEvent`](../GameEvent.md) E) |
|
||||||
|
|
||||||
## Details
|
## Details
|
||||||
### Summary
|
### Summary
|
||||||
@ -32,18 +32,19 @@ Cycles to the next map in rotation
|
|||||||
### Inheritance
|
### Inheritance
|
||||||
- [
|
- [
|
||||||
`Command`
|
`Command`
|
||||||
](./sharedlibrarycore-Command)
|
](../Command.md)
|
||||||
|
|
||||||
### Constructors
|
### Constructors
|
||||||
#### MapRotateCommand
|
#### MapRotateCommand
|
||||||
|
[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Commands/NativeCommands.cs#L439)
|
||||||
```csharp
|
```csharp
|
||||||
public MapRotateCommand(CommandConfiguration config, ITranslationLookup translationLookup)
|
public MapRotateCommand(CommandConfiguration config, ITranslationLookup translationLookup)
|
||||||
```
|
```
|
||||||
##### Arguments
|
##### Arguments
|
||||||
| Type | Name | Description |
|
| Type | Name | Description |
|
||||||
| --- | --- | --- |
|
| --- | --- | --- |
|
||||||
| [`CommandConfiguration`](./sharedlibrarycoreconfiguration-CommandConfiguration) | config | |
|
| [`CommandConfiguration`](../configuration/CommandConfiguration.md) | config | |
|
||||||
| [`ITranslationLookup`](./sharedlibrarycoreinterfaces-ITranslationLookup) | translationLookup | |
|
| [`ITranslationLookup`](../interfaces/ITranslationLookup.md) | translationLookup | |
|
||||||
|
|
||||||
### Methods
|
### Methods
|
||||||
#### ExecuteAsync
|
#### ExecuteAsync
|
||||||
@ -53,6 +54,6 @@ public override async Task ExecuteAsync(GameEvent E)
|
|||||||
##### Arguments
|
##### Arguments
|
||||||
| Type | Name | Description |
|
| Type | Name | Description |
|
||||||
| --- | --- | --- |
|
| --- | --- | --- |
|
||||||
| [`GameEvent`](./sharedlibrarycore-GameEvent) | E | |
|
| [`GameEvent`](../GameEvent.md) | E | |
|
||||||
|
|
||||||
*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc)
|
*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc)
|
@ -23,7 +23,7 @@ SharedLibraryCore.Command --> SharedLibraryCore.Commands.MaskCommand
|
|||||||
#### Public methods
|
#### Public methods
|
||||||
| Returns | Name |
|
| Returns | Name |
|
||||||
| --- | --- |
|
| --- | --- |
|
||||||
| `Task` | [`ExecuteAsync`](#executeasync)([`GameEvent`](./sharedlibrarycore-GameEvent) E) |
|
| `Task` | [`ExecuteAsync`](#executeasync)([`GameEvent`](../GameEvent.md) E) |
|
||||||
|
|
||||||
## Details
|
## Details
|
||||||
### Summary
|
### Summary
|
||||||
@ -32,18 +32,19 @@ Masks client from announcements and online admin list
|
|||||||
### Inheritance
|
### Inheritance
|
||||||
- [
|
- [
|
||||||
`Command`
|
`Command`
|
||||||
](./sharedlibrarycore-Command)
|
](../Command.md)
|
||||||
|
|
||||||
### Constructors
|
### Constructors
|
||||||
#### MaskCommand
|
#### MaskCommand
|
||||||
|
[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Commands/NativeCommands.cs#L846)
|
||||||
```csharp
|
```csharp
|
||||||
public MaskCommand(CommandConfiguration config, ITranslationLookup translationLookup)
|
public MaskCommand(CommandConfiguration config, ITranslationLookup translationLookup)
|
||||||
```
|
```
|
||||||
##### Arguments
|
##### Arguments
|
||||||
| Type | Name | Description |
|
| Type | Name | Description |
|
||||||
| --- | --- | --- |
|
| --- | --- | --- |
|
||||||
| [`CommandConfiguration`](./sharedlibrarycoreconfiguration-CommandConfiguration) | config | |
|
| [`CommandConfiguration`](../configuration/CommandConfiguration.md) | config | |
|
||||||
| [`ITranslationLookup`](./sharedlibrarycoreinterfaces-ITranslationLookup) | translationLookup | |
|
| [`ITranslationLookup`](../interfaces/ITranslationLookup.md) | translationLookup | |
|
||||||
|
|
||||||
### Methods
|
### Methods
|
||||||
#### ExecuteAsync
|
#### ExecuteAsync
|
||||||
@ -53,6 +54,6 @@ public override async Task ExecuteAsync(GameEvent E)
|
|||||||
##### Arguments
|
##### Arguments
|
||||||
| Type | Name | Description |
|
| Type | Name | Description |
|
||||||
| --- | --- | --- |
|
| --- | --- | --- |
|
||||||
| [`GameEvent`](./sharedlibrarycore-GameEvent) | E | |
|
| [`GameEvent`](../GameEvent.md) | E | |
|
||||||
|
|
||||||
*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc)
|
*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc)
|
@ -23,7 +23,7 @@ SharedLibraryCore.Command --> SharedLibraryCore.Commands.MemoryUsageCommand
|
|||||||
#### Public methods
|
#### Public methods
|
||||||
| Returns | Name |
|
| Returns | Name |
|
||||||
| --- | --- |
|
| --- | --- |
|
||||||
| `Task` | [`ExecuteAsync`](#executeasync)([`GameEvent`](./sharedlibrarycore-GameEvent) E) |
|
| `Task` | [`ExecuteAsync`](#executeasync)([`GameEvent`](../GameEvent.md) E) |
|
||||||
|
|
||||||
## Details
|
## Details
|
||||||
### Summary
|
### Summary
|
||||||
@ -32,27 +32,29 @@ Prints the amount of memory IW4MAdmin is using
|
|||||||
### Inheritance
|
### Inheritance
|
||||||
- [
|
- [
|
||||||
`Command`
|
`Command`
|
||||||
](./sharedlibrarycore-Command)
|
](../Command.md)
|
||||||
|
|
||||||
### Constructors
|
### Constructors
|
||||||
#### MemoryUsageCommand
|
#### MemoryUsageCommand
|
||||||
|
[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Commands/NativeCommands.cs#L610)
|
||||||
```csharp
|
```csharp
|
||||||
public MemoryUsageCommand(CommandConfiguration config, ITranslationLookup translationLookup)
|
public MemoryUsageCommand(CommandConfiguration config, ITranslationLookup translationLookup)
|
||||||
```
|
```
|
||||||
##### Arguments
|
##### Arguments
|
||||||
| Type | Name | Description |
|
| Type | Name | Description |
|
||||||
| --- | --- | --- |
|
| --- | --- | --- |
|
||||||
| [`CommandConfiguration`](./sharedlibrarycoreconfiguration-CommandConfiguration) | config | |
|
| [`CommandConfiguration`](../configuration/CommandConfiguration.md) | config | |
|
||||||
| [`ITranslationLookup`](./sharedlibrarycoreinterfaces-ITranslationLookup) | translationLookup | |
|
| [`ITranslationLookup`](../interfaces/ITranslationLookup.md) | translationLookup | |
|
||||||
|
|
||||||
### Methods
|
### Methods
|
||||||
#### ExecuteAsync
|
#### ExecuteAsync
|
||||||
|
[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Commands/NativeCommands.cs#L621)
|
||||||
```csharp
|
```csharp
|
||||||
public override Task ExecuteAsync(GameEvent E)
|
public override Task ExecuteAsync(GameEvent E)
|
||||||
```
|
```
|
||||||
##### Arguments
|
##### Arguments
|
||||||
| Type | Name | Description |
|
| Type | Name | Description |
|
||||||
| --- | --- | --- |
|
| --- | --- | --- |
|
||||||
| [`GameEvent`](./sharedlibrarycore-GameEvent) | E | |
|
| [`GameEvent`](../GameEvent.md) | E | |
|
||||||
|
|
||||||
*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc)
|
*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc)
|
@ -23,12 +23,12 @@ SharedLibraryCore.Command --> SharedLibraryCore.Commands.NextMapCommand
|
|||||||
#### Public Static methods
|
#### Public Static methods
|
||||||
| Returns | Name |
|
| Returns | Name |
|
||||||
| --- | --- |
|
| --- | --- |
|
||||||
| `Task`<`string`> | [`GetNextMap`](#getnextmap)([`Server`](./sharedlibrarycore-Server) s, [`ITranslationLookup`](./sharedlibrarycoreinterfaces-ITranslationLookup) lookup) |
|
| `Task`<`string`> | [`GetNextMap`](#getnextmap)([`Server`](../Server.md) s, [`ITranslationLookup`](../interfaces/ITranslationLookup.md) lookup) |
|
||||||
|
|
||||||
#### Public methods
|
#### Public methods
|
||||||
| Returns | Name |
|
| Returns | Name |
|
||||||
| --- | --- |
|
| --- | --- |
|
||||||
| `Task` | [`ExecuteAsync`](#executeasync)([`GameEvent`](./sharedlibrarycore-GameEvent) E) |
|
| `Task` | [`ExecuteAsync`](#executeasync)([`GameEvent`](../GameEvent.md) E) |
|
||||||
|
|
||||||
## Details
|
## Details
|
||||||
### Summary
|
### Summary
|
||||||
@ -37,18 +37,19 @@ Retrieves the next map in rotation
|
|||||||
### Inheritance
|
### Inheritance
|
||||||
- [
|
- [
|
||||||
`Command`
|
`Command`
|
||||||
](./sharedlibrarycore-Command)
|
](../Command.md)
|
||||||
|
|
||||||
### Constructors
|
### Constructors
|
||||||
#### NextMapCommand
|
#### NextMapCommand
|
||||||
|
[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Commands/NativeCommands.cs#L1178)
|
||||||
```csharp
|
```csharp
|
||||||
public NextMapCommand(CommandConfiguration config, ITranslationLookup translationLookup)
|
public NextMapCommand(CommandConfiguration config, ITranslationLookup translationLookup)
|
||||||
```
|
```
|
||||||
##### Arguments
|
##### Arguments
|
||||||
| Type | Name | Description |
|
| Type | Name | Description |
|
||||||
| --- | --- | --- |
|
| --- | --- | --- |
|
||||||
| [`CommandConfiguration`](./sharedlibrarycoreconfiguration-CommandConfiguration) | config | |
|
| [`CommandConfiguration`](../configuration/CommandConfiguration.md) | config | |
|
||||||
| [`ITranslationLookup`](./sharedlibrarycoreinterfaces-ITranslationLookup) | translationLookup | |
|
| [`ITranslationLookup`](../interfaces/ITranslationLookup.md) | translationLookup | |
|
||||||
|
|
||||||
### Methods
|
### Methods
|
||||||
#### GetNextMap
|
#### GetNextMap
|
||||||
@ -58,8 +59,8 @@ public static async Task<string> GetNextMap(Server s, ITranslationLookup lookup)
|
|||||||
##### Arguments
|
##### Arguments
|
||||||
| Type | Name | Description |
|
| Type | Name | Description |
|
||||||
| --- | --- | --- |
|
| --- | --- | --- |
|
||||||
| [`Server`](./sharedlibrarycore-Server) | s | |
|
| [`Server`](../Server.md) | s | |
|
||||||
| [`ITranslationLookup`](./sharedlibrarycoreinterfaces-ITranslationLookup) | lookup | |
|
| [`ITranslationLookup`](../interfaces/ITranslationLookup.md) | lookup | |
|
||||||
|
|
||||||
#### ExecuteAsync
|
#### ExecuteAsync
|
||||||
```csharp
|
```csharp
|
||||||
@ -68,6 +69,6 @@ public override async Task ExecuteAsync(GameEvent E)
|
|||||||
##### Arguments
|
##### Arguments
|
||||||
| Type | Name | Description |
|
| Type | Name | Description |
|
||||||
| --- | --- | --- |
|
| --- | --- | --- |
|
||||||
| [`GameEvent`](./sharedlibrarycore-GameEvent) | E | |
|
| [`GameEvent`](../GameEvent.md) | E | |
|
||||||
|
|
||||||
*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc)
|
*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc)
|
@ -23,7 +23,7 @@ SharedLibraryCore.Command --> SharedLibraryCore.Commands.OwnerCommand
|
|||||||
#### Public methods
|
#### Public methods
|
||||||
| Returns | Name |
|
| Returns | Name |
|
||||||
| --- | --- |
|
| --- | --- |
|
||||||
| `Task` | [`ExecuteAsync`](#executeasync)([`GameEvent`](./sharedlibrarycore-GameEvent) E) |
|
| `Task` | [`ExecuteAsync`](#executeasync)([`GameEvent`](../GameEvent.md) E) |
|
||||||
|
|
||||||
## Details
|
## Details
|
||||||
### Summary
|
### Summary
|
||||||
@ -32,18 +32,19 @@ Claims ownership of the server
|
|||||||
### Inheritance
|
### Inheritance
|
||||||
- [
|
- [
|
||||||
`Command`
|
`Command`
|
||||||
](./sharedlibrarycore-Command)
|
](../Command.md)
|
||||||
|
|
||||||
### Constructors
|
### Constructors
|
||||||
#### OwnerCommand
|
#### OwnerCommand
|
||||||
|
[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Commands/NativeCommands.cs#L69)
|
||||||
```csharp
|
```csharp
|
||||||
public OwnerCommand(CommandConfiguration config, ITranslationLookup translationLookup)
|
public OwnerCommand(CommandConfiguration config, ITranslationLookup translationLookup)
|
||||||
```
|
```
|
||||||
##### Arguments
|
##### Arguments
|
||||||
| Type | Name | Description |
|
| Type | Name | Description |
|
||||||
| --- | --- | --- |
|
| --- | --- | --- |
|
||||||
| [`CommandConfiguration`](./sharedlibrarycoreconfiguration-CommandConfiguration) | config | |
|
| [`CommandConfiguration`](../configuration/CommandConfiguration.md) | config | |
|
||||||
| [`ITranslationLookup`](./sharedlibrarycoreinterfaces-ITranslationLookup) | translationLookup | |
|
| [`ITranslationLookup`](../interfaces/ITranslationLookup.md) | translationLookup | |
|
||||||
|
|
||||||
### Methods
|
### Methods
|
||||||
#### ExecuteAsync
|
#### ExecuteAsync
|
||||||
@ -53,6 +54,6 @@ public override async Task ExecuteAsync(GameEvent E)
|
|||||||
##### Arguments
|
##### Arguments
|
||||||
| Type | Name | Description |
|
| Type | Name | Description |
|
||||||
| --- | --- | --- |
|
| --- | --- | --- |
|
||||||
| [`GameEvent`](./sharedlibrarycore-GameEvent) | E | |
|
| [`GameEvent`](../GameEvent.md) | E | |
|
||||||
|
|
||||||
*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc)
|
*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc)
|
@ -20,33 +20,35 @@ SharedLibraryCore.Command --> SharedLibraryCore.Commands.PrivateMessageAdminsCom
|
|||||||
#### Public methods
|
#### Public methods
|
||||||
| Returns | Name |
|
| Returns | Name |
|
||||||
| --- | --- |
|
| --- | --- |
|
||||||
| `Task` | [`ExecuteAsync`](#executeasync)([`GameEvent`](./sharedlibrarycore-GameEvent) E) |
|
| `Task` | [`ExecuteAsync`](#executeasync)([`GameEvent`](../GameEvent.md) E) |
|
||||||
|
|
||||||
## Details
|
## Details
|
||||||
### Inheritance
|
### Inheritance
|
||||||
- [
|
- [
|
||||||
`Command`
|
`Command`
|
||||||
](./sharedlibrarycore-Command)
|
](../Command.md)
|
||||||
|
|
||||||
### Constructors
|
### Constructors
|
||||||
#### PrivateMessageAdminsCommand
|
#### PrivateMessageAdminsCommand
|
||||||
|
[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Commands/PrivateMessageAdminsCommand.cs#L12)
|
||||||
```csharp
|
```csharp
|
||||||
public PrivateMessageAdminsCommand(CommandConfiguration config, ITranslationLookup lookup)
|
public PrivateMessageAdminsCommand(CommandConfiguration config, ITranslationLookup lookup)
|
||||||
```
|
```
|
||||||
##### Arguments
|
##### Arguments
|
||||||
| Type | Name | Description |
|
| Type | Name | Description |
|
||||||
| --- | --- | --- |
|
| --- | --- | --- |
|
||||||
| [`CommandConfiguration`](./sharedlibrarycoreconfiguration-CommandConfiguration) | config | |
|
| [`CommandConfiguration`](../configuration/CommandConfiguration.md) | config | |
|
||||||
| [`ITranslationLookup`](./sharedlibrarycoreinterfaces-ITranslationLookup) | lookup | |
|
| [`ITranslationLookup`](../interfaces/ITranslationLookup.md) | lookup | |
|
||||||
|
|
||||||
### Methods
|
### Methods
|
||||||
#### ExecuteAsync
|
#### ExecuteAsync
|
||||||
|
[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Commands/PrivateMessageAdminsCommand.cs#L23)
|
||||||
```csharp
|
```csharp
|
||||||
public override Task ExecuteAsync(GameEvent E)
|
public override Task ExecuteAsync(GameEvent E)
|
||||||
```
|
```
|
||||||
##### Arguments
|
##### Arguments
|
||||||
| Type | Name | Description |
|
| Type | Name | Description |
|
||||||
| --- | --- | --- |
|
| --- | --- | --- |
|
||||||
| [`GameEvent`](./sharedlibrarycore-GameEvent) | E | |
|
| [`GameEvent`](../GameEvent.md) | E | |
|
||||||
|
|
||||||
*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc)
|
*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc)
|
@ -23,7 +23,7 @@ SharedLibraryCore.Command --> SharedLibraryCore.Commands.PruneAdminsCommand
|
|||||||
#### Public methods
|
#### Public methods
|
||||||
| Returns | Name |
|
| Returns | Name |
|
||||||
| --- | --- |
|
| --- | --- |
|
||||||
| `Task` | [`ExecuteAsync`](#executeasync)([`GameEvent`](./sharedlibrarycore-GameEvent) E) |
|
| `Task` | [`ExecuteAsync`](#executeasync)([`GameEvent`](../GameEvent.md) E) |
|
||||||
|
|
||||||
## Details
|
## Details
|
||||||
### Summary
|
### Summary
|
||||||
@ -32,18 +32,19 @@ Prunes inactive privileged clients
|
|||||||
### Inheritance
|
### Inheritance
|
||||||
- [
|
- [
|
||||||
`Command`
|
`Command`
|
||||||
](./sharedlibrarycore-Command)
|
](../Command.md)
|
||||||
|
|
||||||
### Constructors
|
### Constructors
|
||||||
#### PruneAdminsCommand
|
#### PruneAdminsCommand
|
||||||
|
[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Commands/NativeCommands.cs#L988)
|
||||||
```csharp
|
```csharp
|
||||||
public PruneAdminsCommand(CommandConfiguration config, ITranslationLookup translationLookup, IDatabaseContextFactory contextFactory)
|
public PruneAdminsCommand(CommandConfiguration config, ITranslationLookup translationLookup, IDatabaseContextFactory contextFactory)
|
||||||
```
|
```
|
||||||
##### Arguments
|
##### Arguments
|
||||||
| Type | Name | Description |
|
| Type | Name | Description |
|
||||||
| --- | --- | --- |
|
| --- | --- | --- |
|
||||||
| [`CommandConfiguration`](./sharedlibrarycoreconfiguration-CommandConfiguration) | config | |
|
| [`CommandConfiguration`](../configuration/CommandConfiguration.md) | config | |
|
||||||
| [`ITranslationLookup`](./sharedlibrarycoreinterfaces-ITranslationLookup) | translationLookup | |
|
| [`ITranslationLookup`](../interfaces/ITranslationLookup.md) | translationLookup | |
|
||||||
| `IDatabaseContextFactory` | contextFactory | |
|
| `IDatabaseContextFactory` | contextFactory | |
|
||||||
|
|
||||||
### Methods
|
### Methods
|
||||||
@ -54,6 +55,6 @@ public override async Task ExecuteAsync(GameEvent E)
|
|||||||
##### Arguments
|
##### Arguments
|
||||||
| Type | Name | Description |
|
| Type | Name | Description |
|
||||||
| --- | --- | --- |
|
| --- | --- | --- |
|
||||||
| [`GameEvent`](./sharedlibrarycore-GameEvent) | E | |
|
| [`GameEvent`](../GameEvent.md) | E | |
|
||||||
|
|
||||||
*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc)
|
*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc)
|
@ -23,7 +23,7 @@ SharedLibraryCore.Command --> SharedLibraryCore.Commands.QuitCommand
|
|||||||
#### Public methods
|
#### Public methods
|
||||||
| Returns | Name |
|
| Returns | Name |
|
||||||
| --- | --- |
|
| --- | --- |
|
||||||
| `Task` | [`ExecuteAsync`](#executeasync)([`GameEvent`](./sharedlibrarycore-GameEvent) E) |
|
| `Task` | [`ExecuteAsync`](#executeasync)([`GameEvent`](../GameEvent.md) E) |
|
||||||
|
|
||||||
## Details
|
## Details
|
||||||
### Summary
|
### Summary
|
||||||
@ -32,18 +32,19 @@ Quits IW4MAdmin
|
|||||||
### Inheritance
|
### Inheritance
|
||||||
- [
|
- [
|
||||||
`Command`
|
`Command`
|
||||||
](./sharedlibrarycore-Command)
|
](../Command.md)
|
||||||
|
|
||||||
### Constructors
|
### Constructors
|
||||||
#### QuitCommand
|
#### QuitCommand
|
||||||
|
[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Commands/NativeCommands.cs#L26)
|
||||||
```csharp
|
```csharp
|
||||||
public QuitCommand(CommandConfiguration config, ITranslationLookup translationLookup)
|
public QuitCommand(CommandConfiguration config, ITranslationLookup translationLookup)
|
||||||
```
|
```
|
||||||
##### Arguments
|
##### Arguments
|
||||||
| Type | Name | Description |
|
| Type | Name | Description |
|
||||||
| --- | --- | --- |
|
| --- | --- | --- |
|
||||||
| [`CommandConfiguration`](./sharedlibrarycoreconfiguration-CommandConfiguration) | config | |
|
| [`CommandConfiguration`](../configuration/CommandConfiguration.md) | config | |
|
||||||
| [`ITranslationLookup`](./sharedlibrarycoreinterfaces-ITranslationLookup) | translationLookup | |
|
| [`ITranslationLookup`](../interfaces/ITranslationLookup.md) | translationLookup | |
|
||||||
|
|
||||||
### Methods
|
### Methods
|
||||||
#### ExecuteAsync
|
#### ExecuteAsync
|
||||||
@ -53,6 +54,6 @@ public override async Task ExecuteAsync(GameEvent E)
|
|||||||
##### Arguments
|
##### Arguments
|
||||||
| Type | Name | Description |
|
| Type | Name | Description |
|
||||||
| --- | --- | --- |
|
| --- | --- | --- |
|
||||||
| [`GameEvent`](./sharedlibrarycore-GameEvent) | E | |
|
| [`GameEvent`](../GameEvent.md) | E | |
|
||||||
|
|
||||||
*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc)
|
*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc)
|
@ -23,7 +23,7 @@ SharedLibraryCore.Command --> SharedLibraryCore.Commands.RequestTokenCommand
|
|||||||
#### Public methods
|
#### Public methods
|
||||||
| Returns | Name |
|
| Returns | Name |
|
||||||
| --- | --- |
|
| --- | --- |
|
||||||
| `Task` | [`ExecuteAsync`](#executeasync)([`GameEvent`](./sharedlibrarycore-GameEvent) gameEvent) |
|
| `Task` | [`ExecuteAsync`](#executeasync)([`GameEvent`](../GameEvent.md) gameEvent) |
|
||||||
|
|
||||||
## Details
|
## Details
|
||||||
### Summary
|
### Summary
|
||||||
@ -32,27 +32,29 @@ Generates a token for use in webfront login
|
|||||||
### Inheritance
|
### Inheritance
|
||||||
- [
|
- [
|
||||||
`Command`
|
`Command`
|
||||||
](./sharedlibrarycore-Command)
|
](../Command.md)
|
||||||
|
|
||||||
### Constructors
|
### Constructors
|
||||||
#### RequestTokenCommand
|
#### RequestTokenCommand
|
||||||
|
[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Commands/RequestTokenCommand.cs#L14)
|
||||||
```csharp
|
```csharp
|
||||||
public RequestTokenCommand(CommandConfiguration config, ITranslationLookup lookup)
|
public RequestTokenCommand(CommandConfiguration config, ITranslationLookup lookup)
|
||||||
```
|
```
|
||||||
##### Arguments
|
##### Arguments
|
||||||
| Type | Name | Description |
|
| Type | Name | Description |
|
||||||
| --- | --- | --- |
|
| --- | --- | --- |
|
||||||
| [`CommandConfiguration`](./sharedlibrarycoreconfiguration-CommandConfiguration) | config | |
|
| [`CommandConfiguration`](../configuration/CommandConfiguration.md) | config | |
|
||||||
| [`ITranslationLookup`](./sharedlibrarycoreinterfaces-ITranslationLookup) | lookup | |
|
| [`ITranslationLookup`](../interfaces/ITranslationLookup.md) | lookup | |
|
||||||
|
|
||||||
### Methods
|
### Methods
|
||||||
#### ExecuteAsync
|
#### ExecuteAsync
|
||||||
|
[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Commands/RequestTokenCommand.cs#L24)
|
||||||
```csharp
|
```csharp
|
||||||
public override Task ExecuteAsync(GameEvent gameEvent)
|
public override Task ExecuteAsync(GameEvent gameEvent)
|
||||||
```
|
```
|
||||||
##### Arguments
|
##### Arguments
|
||||||
| Type | Name | Description |
|
| Type | Name | Description |
|
||||||
| --- | --- | --- |
|
| --- | --- | --- |
|
||||||
| [`GameEvent`](./sharedlibrarycore-GameEvent) | gameEvent | |
|
| [`GameEvent`](../GameEvent.md) | gameEvent | |
|
||||||
|
|
||||||
*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc)
|
*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc)
|
@ -23,7 +23,7 @@ SharedLibraryCore.Command --> SharedLibraryCore.Commands.RestartCommand
|
|||||||
#### Public methods
|
#### Public methods
|
||||||
| Returns | Name |
|
| Returns | Name |
|
||||||
| --- | --- |
|
| --- | --- |
|
||||||
| `Task` | [`ExecuteAsync`](#executeasync)([`GameEvent`](./sharedlibrarycore-GameEvent) gameEvent) |
|
| `Task` | [`ExecuteAsync`](#executeasync)([`GameEvent`](../GameEvent.md) gameEvent) |
|
||||||
|
|
||||||
## Details
|
## Details
|
||||||
### Summary
|
### Summary
|
||||||
@ -32,18 +32,19 @@ Restarts IW4MAdmin
|
|||||||
### Inheritance
|
### Inheritance
|
||||||
- [
|
- [
|
||||||
`Command`
|
`Command`
|
||||||
](./sharedlibrarycore-Command)
|
](../Command.md)
|
||||||
|
|
||||||
### Constructors
|
### Constructors
|
||||||
#### RestartCommand
|
#### RestartCommand
|
||||||
|
[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Commands/NativeCommands.cs#L47)
|
||||||
```csharp
|
```csharp
|
||||||
public RestartCommand(CommandConfiguration config, ITranslationLookup translationLookup)
|
public RestartCommand(CommandConfiguration config, ITranslationLookup translationLookup)
|
||||||
```
|
```
|
||||||
##### Arguments
|
##### Arguments
|
||||||
| Type | Name | Description |
|
| Type | Name | Description |
|
||||||
| --- | --- | --- |
|
| --- | --- | --- |
|
||||||
| [`CommandConfiguration`](./sharedlibrarycoreconfiguration-CommandConfiguration) | config | |
|
| [`CommandConfiguration`](../configuration/CommandConfiguration.md) | config | |
|
||||||
| [`ITranslationLookup`](./sharedlibrarycoreinterfaces-ITranslationLookup) | translationLookup | |
|
| [`ITranslationLookup`](../interfaces/ITranslationLookup.md) | translationLookup | |
|
||||||
|
|
||||||
### Methods
|
### Methods
|
||||||
#### ExecuteAsync
|
#### ExecuteAsync
|
||||||
@ -53,6 +54,6 @@ public override async Task ExecuteAsync(GameEvent gameEvent)
|
|||||||
##### Arguments
|
##### Arguments
|
||||||
| Type | Name | Description |
|
| Type | Name | Description |
|
||||||
| --- | --- | --- |
|
| --- | --- | --- |
|
||||||
| [`GameEvent`](./sharedlibrarycore-GameEvent) | gameEvent | |
|
| [`GameEvent`](../GameEvent.md) | gameEvent | |
|
||||||
|
|
||||||
*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc)
|
*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc)
|
@ -20,24 +20,25 @@ SharedLibraryCore.Command --> SharedLibraryCore.Commands.RunAsCommand
|
|||||||
#### Public methods
|
#### Public methods
|
||||||
| Returns | Name |
|
| Returns | Name |
|
||||||
| --- | --- |
|
| --- | --- |
|
||||||
| `Task` | [`ExecuteAsync`](#executeasync)([`GameEvent`](./sharedlibrarycore-GameEvent) gameEvent) |
|
| `Task` | [`ExecuteAsync`](#executeasync)([`GameEvent`](../GameEvent.md) gameEvent) |
|
||||||
|
|
||||||
## Details
|
## Details
|
||||||
### Inheritance
|
### Inheritance
|
||||||
- [
|
- [
|
||||||
`Command`
|
`Command`
|
||||||
](./sharedlibrarycore-Command)
|
](../Command.md)
|
||||||
|
|
||||||
### Constructors
|
### Constructors
|
||||||
#### RunAsCommand
|
#### RunAsCommand
|
||||||
|
[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Commands/RunAsCommand.cs#L11)
|
||||||
```csharp
|
```csharp
|
||||||
public RunAsCommand(CommandConfiguration config, ITranslationLookup lookup)
|
public RunAsCommand(CommandConfiguration config, ITranslationLookup lookup)
|
||||||
```
|
```
|
||||||
##### Arguments
|
##### Arguments
|
||||||
| Type | Name | Description |
|
| Type | Name | Description |
|
||||||
| --- | --- | --- |
|
| --- | --- | --- |
|
||||||
| [`CommandConfiguration`](./sharedlibrarycoreconfiguration-CommandConfiguration) | config | |
|
| [`CommandConfiguration`](../configuration/CommandConfiguration.md) | config | |
|
||||||
| [`ITranslationLookup`](./sharedlibrarycoreinterfaces-ITranslationLookup) | lookup | |
|
| [`ITranslationLookup`](../interfaces/ITranslationLookup.md) | lookup | |
|
||||||
|
|
||||||
### Methods
|
### Methods
|
||||||
#### ExecuteAsync
|
#### ExecuteAsync
|
||||||
@ -47,6 +48,6 @@ public override async Task ExecuteAsync(GameEvent gameEvent)
|
|||||||
##### Arguments
|
##### Arguments
|
||||||
| Type | Name | Description |
|
| Type | Name | Description |
|
||||||
| --- | --- | --- |
|
| --- | --- | --- |
|
||||||
| [`GameEvent`](./sharedlibrarycore-GameEvent) | gameEvent | |
|
| [`GameEvent`](../GameEvent.md) | gameEvent | |
|
||||||
|
|
||||||
*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc)
|
*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc)
|
@ -23,7 +23,7 @@ SharedLibraryCore.Command --> SharedLibraryCore.Commands.SetGravatarCommand
|
|||||||
#### Public methods
|
#### Public methods
|
||||||
| Returns | Name |
|
| Returns | Name |
|
||||||
| --- | --- |
|
| --- | --- |
|
||||||
| `Task` | [`ExecuteAsync`](#executeasync)([`GameEvent`](./sharedlibrarycore-GameEvent) E) |
|
| `Task` | [`ExecuteAsync`](#executeasync)([`GameEvent`](../GameEvent.md) E) |
|
||||||
|
|
||||||
## Details
|
## Details
|
||||||
### Summary
|
### Summary
|
||||||
@ -32,19 +32,20 @@ Sets the email for gravatar in webfront
|
|||||||
### Inheritance
|
### Inheritance
|
||||||
- [
|
- [
|
||||||
`Command`
|
`Command`
|
||||||
](./sharedlibrarycore-Command)
|
](../Command.md)
|
||||||
|
|
||||||
### Constructors
|
### Constructors
|
||||||
#### SetGravatarCommand
|
#### SetGravatarCommand
|
||||||
|
[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Commands/NativeCommands.cs#L1139)
|
||||||
```csharp
|
```csharp
|
||||||
public SetGravatarCommand(CommandConfiguration config, ITranslationLookup translationLookup, IMetaServiceV2 metaService)
|
public SetGravatarCommand(CommandConfiguration config, ITranslationLookup translationLookup, IMetaServiceV2 metaService)
|
||||||
```
|
```
|
||||||
##### Arguments
|
##### Arguments
|
||||||
| Type | Name | Description |
|
| Type | Name | Description |
|
||||||
| --- | --- | --- |
|
| --- | --- | --- |
|
||||||
| [`CommandConfiguration`](./sharedlibrarycoreconfiguration-CommandConfiguration) | config | |
|
| [`CommandConfiguration`](../configuration/CommandConfiguration.md) | config | |
|
||||||
| [`ITranslationLookup`](./sharedlibrarycoreinterfaces-ITranslationLookup) | translationLookup | |
|
| [`ITranslationLookup`](../interfaces/ITranslationLookup.md) | translationLookup | |
|
||||||
| [`IMetaServiceV2`](./sharedlibrarycoreinterfaces-IMetaServiceV2) | metaService | |
|
| [`IMetaServiceV2`](../interfaces/IMetaServiceV2.md) | metaService | |
|
||||||
|
|
||||||
### Methods
|
### Methods
|
||||||
#### ExecuteAsync
|
#### ExecuteAsync
|
||||||
@ -54,6 +55,6 @@ public override async Task ExecuteAsync(GameEvent E)
|
|||||||
##### Arguments
|
##### Arguments
|
||||||
| Type | Name | Description |
|
| Type | Name | Description |
|
||||||
| --- | --- | --- |
|
| --- | --- | --- |
|
||||||
| [`GameEvent`](./sharedlibrarycore-GameEvent) | E | |
|
| [`GameEvent`](../GameEvent.md) | E | |
|
||||||
|
|
||||||
*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc)
|
*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc)
|
@ -23,7 +23,7 @@ SharedLibraryCore.Command --> SharedLibraryCore.Commands.SetLevelCommand
|
|||||||
#### Public methods
|
#### Public methods
|
||||||
| Returns | Name |
|
| Returns | Name |
|
||||||
| --- | --- |
|
| --- | --- |
|
||||||
| `Task` | [`ExecuteAsync`](#executeasync)([`GameEvent`](./sharedlibrarycore-GameEvent) gameEvent) |
|
| `Task` | [`ExecuteAsync`](#executeasync)([`GameEvent`](../GameEvent.md) gameEvent) |
|
||||||
|
|
||||||
## Details
|
## Details
|
||||||
### Summary
|
### Summary
|
||||||
@ -32,19 +32,20 @@ Sets the level of given client
|
|||||||
### Inheritance
|
### Inheritance
|
||||||
- [
|
- [
|
||||||
`Command`
|
`Command`
|
||||||
](./sharedlibrarycore-Command)
|
](../Command.md)
|
||||||
|
|
||||||
### Constructors
|
### Constructors
|
||||||
#### SetLevelCommand
|
#### SetLevelCommand
|
||||||
|
[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Commands/NativeCommands.cs#L468)
|
||||||
```csharp
|
```csharp
|
||||||
public SetLevelCommand(CommandConfiguration config, ITranslationLookup translationLookup, ILogger<SetLevelCommand> logger)
|
public SetLevelCommand(CommandConfiguration config, ITranslationLookup translationLookup, ILogger<SetLevelCommand> logger)
|
||||||
```
|
```
|
||||||
##### Arguments
|
##### Arguments
|
||||||
| Type | Name | Description |
|
| Type | Name | Description |
|
||||||
| --- | --- | --- |
|
| --- | --- | --- |
|
||||||
| [`CommandConfiguration`](./sharedlibrarycoreconfiguration-CommandConfiguration) | config | |
|
| [`CommandConfiguration`](../configuration/CommandConfiguration.md) | config | |
|
||||||
| [`ITranslationLookup`](./sharedlibrarycoreinterfaces-ITranslationLookup) | translationLookup | |
|
| [`ITranslationLookup`](../interfaces/ITranslationLookup.md) | translationLookup | |
|
||||||
| `ILogger`<[`SetLevelCommand`](sharedlibrarycorecommands-SetLevelCommand)> | logger | |
|
| `ILogger`<[`SetLevelCommand`](sharedlibrarycore/commands/SetLevelCommand.md)> | logger | |
|
||||||
|
|
||||||
### Methods
|
### Methods
|
||||||
#### ExecuteAsync
|
#### ExecuteAsync
|
||||||
@ -54,6 +55,6 @@ public override async Task ExecuteAsync(GameEvent gameEvent)
|
|||||||
##### Arguments
|
##### Arguments
|
||||||
| Type | Name | Description |
|
| Type | Name | Description |
|
||||||
| --- | --- | --- |
|
| --- | --- | --- |
|
||||||
| [`GameEvent`](./sharedlibrarycore-GameEvent) | gameEvent | |
|
| [`GameEvent`](../GameEvent.md) | gameEvent | |
|
||||||
|
|
||||||
*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc)
|
*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc)
|
@ -23,7 +23,7 @@ SharedLibraryCore.Command --> SharedLibraryCore.Commands.SetPasswordCommand
|
|||||||
#### Public methods
|
#### Public methods
|
||||||
| Returns | Name |
|
| Returns | Name |
|
||||||
| --- | --- |
|
| --- | --- |
|
||||||
| `Task` | [`ExecuteAsync`](#executeasync)([`GameEvent`](./sharedlibrarycore-GameEvent) E) |
|
| `Task` | [`ExecuteAsync`](#executeasync)([`GameEvent`](../GameEvent.md) E) |
|
||||||
|
|
||||||
## Details
|
## Details
|
||||||
### Summary
|
### Summary
|
||||||
@ -32,18 +32,19 @@ Sets login password
|
|||||||
### Inheritance
|
### Inheritance
|
||||||
- [
|
- [
|
||||||
`Command`
|
`Command`
|
||||||
](./sharedlibrarycore-Command)
|
](../Command.md)
|
||||||
|
|
||||||
### Constructors
|
### Constructors
|
||||||
#### SetPasswordCommand
|
#### SetPasswordCommand
|
||||||
|
[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Commands/NativeCommands.cs#L1051)
|
||||||
```csharp
|
```csharp
|
||||||
public SetPasswordCommand(CommandConfiguration config, ITranslationLookup translationLookup)
|
public SetPasswordCommand(CommandConfiguration config, ITranslationLookup translationLookup)
|
||||||
```
|
```
|
||||||
##### Arguments
|
##### Arguments
|
||||||
| Type | Name | Description |
|
| Type | Name | Description |
|
||||||
| --- | --- | --- |
|
| --- | --- | --- |
|
||||||
| [`CommandConfiguration`](./sharedlibrarycoreconfiguration-CommandConfiguration) | config | |
|
| [`CommandConfiguration`](../configuration/CommandConfiguration.md) | config | |
|
||||||
| [`ITranslationLookup`](./sharedlibrarycoreinterfaces-ITranslationLookup) | translationLookup | |
|
| [`ITranslationLookup`](../interfaces/ITranslationLookup.md) | translationLookup | |
|
||||||
|
|
||||||
### Methods
|
### Methods
|
||||||
#### ExecuteAsync
|
#### ExecuteAsync
|
||||||
@ -53,6 +54,6 @@ public override async Task ExecuteAsync(GameEvent E)
|
|||||||
##### Arguments
|
##### Arguments
|
||||||
| Type | Name | Description |
|
| Type | Name | Description |
|
||||||
| --- | --- | --- |
|
| --- | --- | --- |
|
||||||
| [`GameEvent`](./sharedlibrarycore-GameEvent) | E | |
|
| [`GameEvent`](../GameEvent.md) | E | |
|
||||||
|
|
||||||
*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc)
|
*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc)
|
@ -23,7 +23,7 @@ SharedLibraryCore.Command --> SharedLibraryCore.Commands.TempBanCommand
|
|||||||
#### Public methods
|
#### Public methods
|
||||||
| Returns | Name |
|
| Returns | Name |
|
||||||
| --- | --- |
|
| --- | --- |
|
||||||
| `Task` | [`ExecuteAsync`](#executeasync)([`GameEvent`](./sharedlibrarycore-GameEvent) gameEvent) |
|
| `Task` | [`ExecuteAsync`](#executeasync)([`GameEvent`](../GameEvent.md) gameEvent) |
|
||||||
|
|
||||||
## Details
|
## Details
|
||||||
### Summary
|
### Summary
|
||||||
@ -32,19 +32,20 @@ Temporarily bans a client
|
|||||||
### Inheritance
|
### Inheritance
|
||||||
- [
|
- [
|
||||||
`Command`
|
`Command`
|
||||||
](./sharedlibrarycore-Command)
|
](../Command.md)
|
||||||
|
|
||||||
### Constructors
|
### Constructors
|
||||||
#### TempBanCommand
|
#### TempBanCommand
|
||||||
|
[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Commands/NativeCommands.cs#L236)
|
||||||
```csharp
|
```csharp
|
||||||
public TempBanCommand(ApplicationConfiguration appConfig, CommandConfiguration config, ITranslationLookup translationLookup)
|
public TempBanCommand(ApplicationConfiguration appConfig, CommandConfiguration config, ITranslationLookup translationLookup)
|
||||||
```
|
```
|
||||||
##### Arguments
|
##### Arguments
|
||||||
| Type | Name | Description |
|
| Type | Name | Description |
|
||||||
| --- | --- | --- |
|
| --- | --- | --- |
|
||||||
| [`ApplicationConfiguration`](./sharedlibrarycoreconfiguration-ApplicationConfiguration) | appConfig | |
|
| [`ApplicationConfiguration`](../configuration/ApplicationConfiguration.md) | appConfig | |
|
||||||
| [`CommandConfiguration`](./sharedlibrarycoreconfiguration-CommandConfiguration) | config | |
|
| [`CommandConfiguration`](../configuration/CommandConfiguration.md) | config | |
|
||||||
| [`ITranslationLookup`](./sharedlibrarycoreinterfaces-ITranslationLookup) | translationLookup | |
|
| [`ITranslationLookup`](../interfaces/ITranslationLookup.md) | translationLookup | |
|
||||||
|
|
||||||
### Methods
|
### Methods
|
||||||
#### ExecuteAsync
|
#### ExecuteAsync
|
||||||
@ -54,6 +55,6 @@ public override async Task ExecuteAsync(GameEvent gameEvent)
|
|||||||
##### Arguments
|
##### Arguments
|
||||||
| Type | Name | Description |
|
| Type | Name | Description |
|
||||||
| --- | --- | --- |
|
| --- | --- | --- |
|
||||||
| [`GameEvent`](./sharedlibrarycore-GameEvent) | gameEvent | |
|
| [`GameEvent`](../GameEvent.md) | gameEvent | |
|
||||||
|
|
||||||
*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc)
|
*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc)
|
@ -23,7 +23,7 @@ SharedLibraryCore.Command --> SharedLibraryCore.Commands.UnbanCommand
|
|||||||
#### Public methods
|
#### Public methods
|
||||||
| Returns | Name |
|
| Returns | Name |
|
||||||
| --- | --- |
|
| --- | --- |
|
||||||
| `Task` | [`ExecuteAsync`](#executeasync)([`GameEvent`](./sharedlibrarycore-GameEvent) gameEvent) |
|
| `Task` | [`ExecuteAsync`](#executeasync)([`GameEvent`](../GameEvent.md) gameEvent) |
|
||||||
|
|
||||||
## Details
|
## Details
|
||||||
### Summary
|
### Summary
|
||||||
@ -32,18 +32,19 @@ Unbans a banned client
|
|||||||
### Inheritance
|
### Inheritance
|
||||||
- [
|
- [
|
||||||
`Command`
|
`Command`
|
||||||
](./sharedlibrarycore-Command)
|
](../Command.md)
|
||||||
|
|
||||||
### Constructors
|
### Constructors
|
||||||
#### UnbanCommand
|
#### UnbanCommand
|
||||||
|
[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Commands/NativeCommands.cs#L356)
|
||||||
```csharp
|
```csharp
|
||||||
public UnbanCommand(CommandConfiguration config, ITranslationLookup translationLookup)
|
public UnbanCommand(CommandConfiguration config, ITranslationLookup translationLookup)
|
||||||
```
|
```
|
||||||
##### Arguments
|
##### Arguments
|
||||||
| Type | Name | Description |
|
| Type | Name | Description |
|
||||||
| --- | --- | --- |
|
| --- | --- | --- |
|
||||||
| [`CommandConfiguration`](./sharedlibrarycoreconfiguration-CommandConfiguration) | config | |
|
| [`CommandConfiguration`](../configuration/CommandConfiguration.md) | config | |
|
||||||
| [`ITranslationLookup`](./sharedlibrarycoreinterfaces-ITranslationLookup) | translationLookup | |
|
| [`ITranslationLookup`](../interfaces/ITranslationLookup.md) | translationLookup | |
|
||||||
|
|
||||||
### Methods
|
### Methods
|
||||||
#### ExecuteAsync
|
#### ExecuteAsync
|
||||||
@ -53,6 +54,6 @@ public override async Task ExecuteAsync(GameEvent gameEvent)
|
|||||||
##### Arguments
|
##### Arguments
|
||||||
| Type | Name | Description |
|
| Type | Name | Description |
|
||||||
| --- | --- | --- |
|
| --- | --- | --- |
|
||||||
| [`GameEvent`](./sharedlibrarycore-GameEvent) | gameEvent | |
|
| [`GameEvent`](../GameEvent.md) | gameEvent | |
|
||||||
|
|
||||||
*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc)
|
*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc)
|
@ -23,7 +23,7 @@ SharedLibraryCore.Command --> SharedLibraryCore.Commands.UnflagClientCommand
|
|||||||
#### Public methods
|
#### Public methods
|
||||||
| Returns | Name |
|
| Returns | Name |
|
||||||
| --- | --- |
|
| --- | --- |
|
||||||
| `Task` | [`ExecuteAsync`](#executeasync)([`GameEvent`](./sharedlibrarycore-GameEvent) E) |
|
| `Task` | [`ExecuteAsync`](#executeasync)([`GameEvent`](../GameEvent.md) E) |
|
||||||
|
|
||||||
## Details
|
## Details
|
||||||
### Summary
|
### Summary
|
||||||
@ -32,18 +32,19 @@ Unflag given client for specified reason
|
|||||||
### Inheritance
|
### Inheritance
|
||||||
- [
|
- [
|
||||||
`Command`
|
`Command`
|
||||||
](./sharedlibrarycore-Command)
|
](../Command.md)
|
||||||
|
|
||||||
### Constructors
|
### Constructors
|
||||||
#### UnflagClientCommand
|
#### UnflagClientCommand
|
||||||
|
[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Commands/NativeCommands.cs#L797)
|
||||||
```csharp
|
```csharp
|
||||||
public UnflagClientCommand(CommandConfiguration config, ITranslationLookup translationLookup)
|
public UnflagClientCommand(CommandConfiguration config, ITranslationLookup translationLookup)
|
||||||
```
|
```
|
||||||
##### Arguments
|
##### Arguments
|
||||||
| Type | Name | Description |
|
| Type | Name | Description |
|
||||||
| --- | --- | --- |
|
| --- | --- | --- |
|
||||||
| [`CommandConfiguration`](./sharedlibrarycoreconfiguration-CommandConfiguration) | config | |
|
| [`CommandConfiguration`](../configuration/CommandConfiguration.md) | config | |
|
||||||
| [`ITranslationLookup`](./sharedlibrarycoreinterfaces-ITranslationLookup) | translationLookup | |
|
| [`ITranslationLookup`](../interfaces/ITranslationLookup.md) | translationLookup | |
|
||||||
|
|
||||||
### Methods
|
### Methods
|
||||||
#### ExecuteAsync
|
#### ExecuteAsync
|
||||||
@ -53,6 +54,6 @@ public override async Task ExecuteAsync(GameEvent E)
|
|||||||
##### Arguments
|
##### Arguments
|
||||||
| Type | Name | Description |
|
| Type | Name | Description |
|
||||||
| --- | --- | --- |
|
| --- | --- | --- |
|
||||||
| [`GameEvent`](./sharedlibrarycore-GameEvent) | E | |
|
| [`GameEvent`](../GameEvent.md) | E | |
|
||||||
|
|
||||||
*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc)
|
*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc)
|
@ -27,7 +27,7 @@ SharedLibraryCore.Command --> SharedLibraryCore.Commands.UnlinkClientCommand
|
|||||||
#### Public methods
|
#### Public methods
|
||||||
| Returns | Name |
|
| Returns | Name |
|
||||||
| --- | --- |
|
| --- | --- |
|
||||||
| `Task` | [`ExecuteAsync`](#executeasync)([`GameEvent`](./sharedlibrarycore-GameEvent) E) |
|
| `Task` | [`ExecuteAsync`](#executeasync)([`GameEvent`](../GameEvent.md) E) |
|
||||||
|
|
||||||
## Details
|
## Details
|
||||||
### Summary
|
### Summary
|
||||||
@ -40,18 +40,19 @@ Provides a way for administrators to "unlink" linked accounts
|
|||||||
### Inheritance
|
### Inheritance
|
||||||
- [
|
- [
|
||||||
`Command`
|
`Command`
|
||||||
](./sharedlibrarycore-Command)
|
](../Command.md)
|
||||||
|
|
||||||
### Constructors
|
### Constructors
|
||||||
#### UnlinkClientCommand
|
#### UnlinkClientCommand
|
||||||
|
[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Commands/UnlinkClientCommand.cs#L17)
|
||||||
```csharp
|
```csharp
|
||||||
public UnlinkClientCommand(CommandConfiguration config, ITranslationLookup lookup)
|
public UnlinkClientCommand(CommandConfiguration config, ITranslationLookup lookup)
|
||||||
```
|
```
|
||||||
##### Arguments
|
##### Arguments
|
||||||
| Type | Name | Description |
|
| Type | Name | Description |
|
||||||
| --- | --- | --- |
|
| --- | --- | --- |
|
||||||
| [`CommandConfiguration`](./sharedlibrarycoreconfiguration-CommandConfiguration) | config | |
|
| [`CommandConfiguration`](../configuration/CommandConfiguration.md) | config | |
|
||||||
| [`ITranslationLookup`](./sharedlibrarycoreinterfaces-ITranslationLookup) | lookup | |
|
| [`ITranslationLookup`](../interfaces/ITranslationLookup.md) | lookup | |
|
||||||
|
|
||||||
### Methods
|
### Methods
|
||||||
#### ExecuteAsync
|
#### ExecuteAsync
|
||||||
@ -61,6 +62,6 @@ public override async Task ExecuteAsync(GameEvent E)
|
|||||||
##### Arguments
|
##### Arguments
|
||||||
| Type | Name | Description |
|
| Type | Name | Description |
|
||||||
| --- | --- | --- |
|
| --- | --- | --- |
|
||||||
| [`GameEvent`](./sharedlibrarycore-GameEvent) | E | |
|
| [`GameEvent`](../GameEvent.md) | E | |
|
||||||
|
|
||||||
*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc)
|
*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc)
|
@ -23,7 +23,7 @@ SharedLibraryCore.Command --> SharedLibraryCore.Commands.UptimeCommand
|
|||||||
#### Public methods
|
#### Public methods
|
||||||
| Returns | Name |
|
| Returns | Name |
|
||||||
| --- | --- |
|
| --- | --- |
|
||||||
| `Task` | [`ExecuteAsync`](#executeasync)([`GameEvent`](./sharedlibrarycore-GameEvent) E) |
|
| `Task` | [`ExecuteAsync`](#executeasync)([`GameEvent`](../GameEvent.md) E) |
|
||||||
|
|
||||||
## Details
|
## Details
|
||||||
### Summary
|
### Summary
|
||||||
@ -32,27 +32,29 @@ Prints out how long IW4MAdmin has been running
|
|||||||
### Inheritance
|
### Inheritance
|
||||||
- [
|
- [
|
||||||
`Command`
|
`Command`
|
||||||
](./sharedlibrarycore-Command)
|
](../Command.md)
|
||||||
|
|
||||||
### Constructors
|
### Constructors
|
||||||
#### UptimeCommand
|
#### UptimeCommand
|
||||||
|
[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Commands/NativeCommands.cs#L633)
|
||||||
```csharp
|
```csharp
|
||||||
public UptimeCommand(CommandConfiguration config, ITranslationLookup translationLookup)
|
public UptimeCommand(CommandConfiguration config, ITranslationLookup translationLookup)
|
||||||
```
|
```
|
||||||
##### Arguments
|
##### Arguments
|
||||||
| Type | Name | Description |
|
| Type | Name | Description |
|
||||||
| --- | --- | --- |
|
| --- | --- | --- |
|
||||||
| [`CommandConfiguration`](./sharedlibrarycoreconfiguration-CommandConfiguration) | config | |
|
| [`CommandConfiguration`](../configuration/CommandConfiguration.md) | config | |
|
||||||
| [`ITranslationLookup`](./sharedlibrarycoreinterfaces-ITranslationLookup) | translationLookup | |
|
| [`ITranslationLookup`](../interfaces/ITranslationLookup.md) | translationLookup | |
|
||||||
|
|
||||||
### Methods
|
### Methods
|
||||||
#### ExecuteAsync
|
#### ExecuteAsync
|
||||||
|
[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Commands/NativeCommands.cs#L644)
|
||||||
```csharp
|
```csharp
|
||||||
public override Task ExecuteAsync(GameEvent E)
|
public override Task ExecuteAsync(GameEvent E)
|
||||||
```
|
```
|
||||||
##### Arguments
|
##### Arguments
|
||||||
| Type | Name | Description |
|
| Type | Name | Description |
|
||||||
| --- | --- | --- |
|
| --- | --- | --- |
|
||||||
| [`GameEvent`](./sharedlibrarycore-GameEvent) | E | |
|
| [`GameEvent`](../GameEvent.md) | E | |
|
||||||
|
|
||||||
*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc)
|
*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc)
|
@ -23,7 +23,7 @@ SharedLibraryCore.Command --> SharedLibraryCore.Commands.WarnClearCommand
|
|||||||
#### Public methods
|
#### Public methods
|
||||||
| Returns | Name |
|
| Returns | Name |
|
||||||
| --- | --- |
|
| --- | --- |
|
||||||
| `Task` | [`ExecuteAsync`](#executeasync)([`GameEvent`](./sharedlibrarycore-GameEvent) E) |
|
| `Task` | [`ExecuteAsync`](#executeasync)([`GameEvent`](../GameEvent.md) E) |
|
||||||
|
|
||||||
## Details
|
## Details
|
||||||
### Summary
|
### Summary
|
||||||
@ -32,27 +32,29 @@ Clears all warnings for given client
|
|||||||
### Inheritance
|
### Inheritance
|
||||||
- [
|
- [
|
||||||
`Command`
|
`Command`
|
||||||
](./sharedlibrarycore-Command)
|
](../Command.md)
|
||||||
|
|
||||||
### Constructors
|
### Constructors
|
||||||
#### WarnClearCommand
|
#### WarnClearCommand
|
||||||
|
[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Commands/NativeCommands.cs#L148)
|
||||||
```csharp
|
```csharp
|
||||||
public WarnClearCommand(CommandConfiguration config, ITranslationLookup translationLookup)
|
public WarnClearCommand(CommandConfiguration config, ITranslationLookup translationLookup)
|
||||||
```
|
```
|
||||||
##### Arguments
|
##### Arguments
|
||||||
| Type | Name | Description |
|
| Type | Name | Description |
|
||||||
| --- | --- | --- |
|
| --- | --- | --- |
|
||||||
| [`CommandConfiguration`](./sharedlibrarycoreconfiguration-CommandConfiguration) | config | |
|
| [`CommandConfiguration`](../configuration/CommandConfiguration.md) | config | |
|
||||||
| [`ITranslationLookup`](./sharedlibrarycoreinterfaces-ITranslationLookup) | translationLookup | |
|
| [`ITranslationLookup`](../interfaces/ITranslationLookup.md) | translationLookup | |
|
||||||
|
|
||||||
### Methods
|
### Methods
|
||||||
#### ExecuteAsync
|
#### ExecuteAsync
|
||||||
|
[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Commands/NativeCommands.cs#L167)
|
||||||
```csharp
|
```csharp
|
||||||
public override Task ExecuteAsync(GameEvent E)
|
public override Task ExecuteAsync(GameEvent E)
|
||||||
```
|
```
|
||||||
##### Arguments
|
##### Arguments
|
||||||
| Type | Name | Description |
|
| Type | Name | Description |
|
||||||
| --- | --- | --- |
|
| --- | --- | --- |
|
||||||
| [`GameEvent`](./sharedlibrarycore-GameEvent) | E | |
|
| [`GameEvent`](../GameEvent.md) | E | |
|
||||||
|
|
||||||
*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc)
|
*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc)
|
@ -23,7 +23,7 @@ SharedLibraryCore.Command --> SharedLibraryCore.Commands.WarnCommand
|
|||||||
#### Public methods
|
#### Public methods
|
||||||
| Returns | Name |
|
| Returns | Name |
|
||||||
| --- | --- |
|
| --- | --- |
|
||||||
| `Task` | [`ExecuteAsync`](#executeasync)([`GameEvent`](./sharedlibrarycore-GameEvent) gameEvent) |
|
| `Task` | [`ExecuteAsync`](#executeasync)([`GameEvent`](../GameEvent.md) gameEvent) |
|
||||||
|
|
||||||
## Details
|
## Details
|
||||||
### Summary
|
### Summary
|
||||||
@ -32,28 +32,30 @@ Warns given client for reason
|
|||||||
### Inheritance
|
### Inheritance
|
||||||
- [
|
- [
|
||||||
`Command`
|
`Command`
|
||||||
](./sharedlibrarycore-Command)
|
](../Command.md)
|
||||||
|
|
||||||
### Constructors
|
### Constructors
|
||||||
#### WarnCommand
|
#### WarnCommand
|
||||||
|
[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Commands/NativeCommands.cs#L108)
|
||||||
```csharp
|
```csharp
|
||||||
public WarnCommand(ApplicationConfiguration appConfig, CommandConfiguration config, ITranslationLookup translationLookup)
|
public WarnCommand(ApplicationConfiguration appConfig, CommandConfiguration config, ITranslationLookup translationLookup)
|
||||||
```
|
```
|
||||||
##### Arguments
|
##### Arguments
|
||||||
| Type | Name | Description |
|
| Type | Name | Description |
|
||||||
| --- | --- | --- |
|
| --- | --- | --- |
|
||||||
| [`ApplicationConfiguration`](./sharedlibrarycoreconfiguration-ApplicationConfiguration) | appConfig | |
|
| [`ApplicationConfiguration`](../configuration/ApplicationConfiguration.md) | appConfig | |
|
||||||
| [`CommandConfiguration`](./sharedlibrarycoreconfiguration-CommandConfiguration) | config | |
|
| [`CommandConfiguration`](../configuration/CommandConfiguration.md) | config | |
|
||||||
| [`ITranslationLookup`](./sharedlibrarycoreinterfaces-ITranslationLookup) | translationLookup | |
|
| [`ITranslationLookup`](../interfaces/ITranslationLookup.md) | translationLookup | |
|
||||||
|
|
||||||
### Methods
|
### Methods
|
||||||
#### ExecuteAsync
|
#### ExecuteAsync
|
||||||
|
[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Commands/NativeCommands.cs#L132)
|
||||||
```csharp
|
```csharp
|
||||||
public override Task ExecuteAsync(GameEvent gameEvent)
|
public override Task ExecuteAsync(GameEvent gameEvent)
|
||||||
```
|
```
|
||||||
##### Arguments
|
##### Arguments
|
||||||
| Type | Name | Description |
|
| Type | Name | Description |
|
||||||
| --- | --- | --- |
|
| --- | --- | --- |
|
||||||
| [`GameEvent`](./sharedlibrarycore-GameEvent) | gameEvent | |
|
| [`GameEvent`](../GameEvent.md) | gameEvent | |
|
||||||
|
|
||||||
*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc)
|
*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc)
|
@ -25,7 +25,7 @@ SharedLibraryCore.Interfaces.IBaseConfiguration --> SharedLibraryCore.Configurat
|
|||||||
| `TimeSpan``[]` | [`BanDurations`](#bandurations) | `get, set` |
|
| `TimeSpan``[]` | [`BanDurations`](#bandurations) | `get, set` |
|
||||||
| `string` | [`BroadcastCommandPrefix`](#broadcastcommandprefix) | `get, set` |
|
| `string` | [`BroadcastCommandPrefix`](#broadcastcommandprefix) | `get, set` |
|
||||||
| `string` | [`CommandPrefix`](#commandprefix) | `get, set` |
|
| `string` | [`CommandPrefix`](#commandprefix) | `get, set` |
|
||||||
| [`CommunityInformationConfiguration`](./sharedlibrarycoreconfiguration-CommunityInformationConfiguration) | [`CommunityInformation`](#communityinformation) | `get, set` |
|
| [`CommunityInformationConfiguration`](./CommunityInformationConfiguration.md) | [`CommunityInformation`](#communityinformation) | `get, set` |
|
||||||
| `string` | [`ConnectionString`](#connectionstring) | `get, set` |
|
| `string` | [`ConnectionString`](#connectionstring) | `get, set` |
|
||||||
| `string` | [`ContactUri`](#contacturi) | `get, set` |
|
| `string` | [`ContactUri`](#contacturi) | `get, set` |
|
||||||
| `string` | [`CustomLocale`](#customlocale) | `get, set` |
|
| `string` | [`CustomLocale`](#customlocale) | `get, set` |
|
||||||
@ -51,7 +51,7 @@ SharedLibraryCore.Interfaces.IBaseConfiguration --> SharedLibraryCore.Configurat
|
|||||||
| `string` | [`IngameAccentColorKey`](#ingameaccentcolorkey) | `get, set` |
|
| `string` | [`IngameAccentColorKey`](#ingameaccentcolorkey) | `get, set` |
|
||||||
| `string` | [`ManualWebfrontUrl`](#manualwebfronturl) | `get, set` |
|
| `string` | [`ManualWebfrontUrl`](#manualwebfronturl) | `get, set` |
|
||||||
| `int` | [`MapChangeDelaySeconds`](#mapchangedelayseconds) | `get, set` |
|
| `int` | [`MapChangeDelaySeconds`](#mapchangedelayseconds) | `get, set` |
|
||||||
| [`MapConfiguration`](./sharedlibrarycoreconfiguration-MapConfiguration)`[]` | [`Maps`](#maps) | `get, set` |
|
| [`MapConfiguration`](./MapConfiguration.md)`[]` | [`Maps`](#maps) | `get, set` |
|
||||||
| `Uri` | [`MasterUrl`](#masterurl) | `get, set` |
|
| `Uri` | [`MasterUrl`](#masterurl) | `get, set` |
|
||||||
| `TimeSpan` | [`MaxClientHistoryTime`](#maxclienthistorytime) | `get, set` |
|
| `TimeSpan` | [`MaxClientHistoryTime`](#maxclienthistorytime) | `get, set` |
|
||||||
| `TimeSpan` | [`MaximumTempBanTime`](#maximumtempbantime) | `get, set` |
|
| `TimeSpan` | [`MaximumTempBanTime`](#maximumtempbantime) | `get, set` |
|
||||||
@ -60,17 +60,17 @@ SharedLibraryCore.Interfaces.IBaseConfiguration --> SharedLibraryCore.Configurat
|
|||||||
| `Dictionary`<`Permission`, `string`> | [`OverridePermissionLevelNames`](#overridepermissionlevelnames) | `get, set` |
|
| `Dictionary`<`Permission`, `string`> | [`OverridePermissionLevelNames`](#overridepermissionlevelnames) | `get, set` |
|
||||||
| `Dictionary`<`string`, `List`<`string`>> | [`PermissionSets`](#permissionsets) | `get, set` |
|
| `Dictionary`<`string`, `List`<`string`>> | [`PermissionSets`](#permissionsets) | `get, set` |
|
||||||
| `Dictionary`<`string`, `string`> | [`PresetPenaltyReasons`](#presetpenaltyreasons) | `get, set` |
|
| `Dictionary`<`string`, `string`> | [`PresetPenaltyReasons`](#presetpenaltyreasons) | `get, set` |
|
||||||
| [`QuickMessageConfiguration`](./sharedlibrarycoreconfiguration-QuickMessageConfiguration)`[]` | [`QuickMessages`](#quickmessages) | `get, set` |
|
| [`QuickMessageConfiguration`](./QuickMessageConfiguration.md)`[]` | [`QuickMessages`](#quickmessages) | `get, set` |
|
||||||
| `int` | [`RConPollRate`](#rconpollrate) | `get, set` |
|
| `int` | [`RConPollRate`](#rconpollrate) | `get, set` |
|
||||||
| `TimeSpan` | [`RecentAliasIpLinkTimeLimit`](#recentaliasiplinktimelimit) | `get, set` |
|
| `TimeSpan` | [`RecentAliasIpLinkTimeLimit`](#recentaliasiplinktimelimit) | `get, set` |
|
||||||
| `int` | [`ServerConnectionAttempts`](#serverconnectionattempts) | `get, set` |
|
| `int` | [`ServerConnectionAttempts`](#serverconnectionattempts) | `get, set` |
|
||||||
| `TimeSpan` | [`ServerDataCollectionInterval`](#serverdatacollectioninterval) | `get, set` |
|
| `TimeSpan` | [`ServerDataCollectionInterval`](#serverdatacollectioninterval) | `get, set` |
|
||||||
| [`ServerConfiguration`](./sharedlibrarycoreconfiguration-ServerConfiguration)`[]` | [`Servers`](#servers) | `get, set` |
|
| [`ServerConfiguration`](./ServerConfiguration.md)`[]` | [`Servers`](#servers) | `get, set` |
|
||||||
| `string` | [`SocialLinkAddress`](#sociallinkaddress) | `get, set` |
|
| `string` | [`SocialLinkAddress`](#sociallinkaddress) | `get, set` |
|
||||||
| `string` | [`SocialLinkTitle`](#sociallinktitle) | `get, set` |
|
| `string` | [`SocialLinkTitle`](#sociallinktitle) | `get, set` |
|
||||||
| `string` | [`SubscriptionId`](#subscriptionid) | `get, set` |
|
| `string` | [`SubscriptionId`](#subscriptionid) | `get, set` |
|
||||||
| `bool` | [`UseLocalTranslations`](#uselocaltranslations) | `get, set` |
|
| `bool` | [`UseLocalTranslations`](#uselocaltranslations) | `get, set` |
|
||||||
| [`WebfrontConfiguration`](./sharedlibrarycoreconfiguration-WebfrontConfiguration) | [`Webfront`](#webfront) | `get, set` |
|
| [`WebfrontConfiguration`](./WebfrontConfiguration.md) | [`Webfront`](#webfront) | `get, set` |
|
||||||
| `string` | [`WebfrontBindUrl`](#webfrontbindurl) | `get, set` |
|
| `string` | [`WebfrontBindUrl`](#webfrontbindurl) | `get, set` |
|
||||||
| `string``[]` | [`WebfrontConnectionWhitelist`](#webfrontconnectionwhitelist) | `get, set` |
|
| `string``[]` | [`WebfrontConnectionWhitelist`](#webfrontconnectionwhitelist) | `get, set` |
|
||||||
| `string` | [`WebfrontCustomBranding`](#webfrontcustombranding) | `get, set` |
|
| `string` | [`WebfrontCustomBranding`](#webfrontcustombranding) | `get, set` |
|
||||||
@ -82,28 +82,31 @@ SharedLibraryCore.Interfaces.IBaseConfiguration --> SharedLibraryCore.Configurat
|
|||||||
#### Public methods
|
#### Public methods
|
||||||
| Returns | Name |
|
| Returns | Name |
|
||||||
| --- | --- |
|
| --- | --- |
|
||||||
| [`IBaseConfiguration`](./sharedlibrarycoreinterfaces-IBaseConfiguration) | [`Generate`](#generate)() |
|
| [`IBaseConfiguration`](../interfaces/IBaseConfiguration.md) | [`Generate`](#generate)() |
|
||||||
| `string` | [`Name`](#name)() |
|
| `string` | [`Name`](#name)() |
|
||||||
|
|
||||||
## Details
|
## Details
|
||||||
### Inheritance
|
### Inheritance
|
||||||
- [
|
- [
|
||||||
`IBaseConfiguration`
|
`IBaseConfiguration`
|
||||||
](./sharedlibrarycoreinterfaces-IBaseConfiguration)
|
](../interfaces/IBaseConfiguration.md)
|
||||||
|
|
||||||
### Constructors
|
### Constructors
|
||||||
#### ApplicationConfiguration
|
#### ApplicationConfiguration
|
||||||
|
[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Configuration/ApplicationConfiguration.cs#L17)
|
||||||
```csharp
|
```csharp
|
||||||
public ApplicationConfiguration()
|
public ApplicationConfiguration()
|
||||||
```
|
```
|
||||||
|
|
||||||
### Methods
|
### Methods
|
||||||
#### Generate
|
#### Generate
|
||||||
|
[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Configuration/ApplicationConfiguration.cs#L212)
|
||||||
```csharp
|
```csharp
|
||||||
public virtual IBaseConfiguration Generate()
|
public virtual IBaseConfiguration Generate()
|
||||||
```
|
```
|
||||||
|
|
||||||
#### Name
|
#### Name
|
||||||
|
[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Configuration/ApplicationConfiguration.cs#L233)
|
||||||
```csharp
|
```csharp
|
||||||
public virtual string Name()
|
public virtual string Name()
|
||||||
```
|
```
|
@ -25,13 +25,13 @@ SharedLibraryCore.Interfaces.IBaseConfiguration --> SharedLibraryCore.Configurat
|
|||||||
| --- | --- | --- |
|
| --- | --- | --- |
|
||||||
| `string` | [`BroadcastCommandPrefix`](#broadcastcommandprefix)<br>prefix indicating that the chat message is a broadcast command | `get, set` |
|
| `string` | [`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` |
|
| `string` | [`CommandPrefix`](#commandprefix)<br>prefix indicated the chat message is a command | `get, set` |
|
||||||
| `Dictionary`<`string`, [`CommandProperties`](./sharedlibrarycoreconfiguration-CommandProperties)> | [`Commands`](#commands)<br>Dict of command class names mapped to configurable properties | `get, set` |
|
| `Dictionary`<`string`, [`CommandProperties`](./CommandProperties.md)> | [`Commands`](#commands)<br>Dict of command class names mapped to configurable properties | `get, set` |
|
||||||
|
|
||||||
### Methods
|
### Methods
|
||||||
#### Public methods
|
#### Public methods
|
||||||
| Returns | Name |
|
| Returns | Name |
|
||||||
| --- | --- |
|
| --- | --- |
|
||||||
| [`IBaseConfiguration`](./sharedlibrarycoreinterfaces-IBaseConfiguration) | [`Generate`](#generate)() |
|
| [`IBaseConfiguration`](../interfaces/IBaseConfiguration.md) | [`Generate`](#generate)() |
|
||||||
| `string` | [`Name`](#name)() |
|
| `string` | [`Name`](#name)() |
|
||||||
|
|
||||||
## Details
|
## Details
|
||||||
@ -41,21 +41,24 @@ Basic command configuration
|
|||||||
### Inheritance
|
### Inheritance
|
||||||
- [
|
- [
|
||||||
`IBaseConfiguration`
|
`IBaseConfiguration`
|
||||||
](./sharedlibrarycoreinterfaces-IBaseConfiguration)
|
](../interfaces/IBaseConfiguration.md)
|
||||||
|
|
||||||
### Constructors
|
### Constructors
|
||||||
#### CommandConfiguration
|
#### CommandConfiguration
|
||||||
|
[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Configuration/CommandConfiguration.cs#L17)
|
||||||
```csharp
|
```csharp
|
||||||
public CommandConfiguration()
|
public CommandConfiguration()
|
||||||
```
|
```
|
||||||
|
|
||||||
### Methods
|
### Methods
|
||||||
#### Generate
|
#### Generate
|
||||||
|
[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Configuration/CommandConfiguration.cs#L32)
|
||||||
```csharp
|
```csharp
|
||||||
public virtual IBaseConfiguration Generate()
|
public virtual IBaseConfiguration Generate()
|
||||||
```
|
```
|
||||||
|
|
||||||
#### Name
|
#### Name
|
||||||
|
[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Configuration/CommandConfiguration.cs#L37)
|
||||||
```csharp
|
```csharp
|
||||||
public virtual string Name()
|
public virtual string Name()
|
||||||
```
|
```
|
@ -30,6 +30,7 @@ Config driven command properties
|
|||||||
|
|
||||||
### Constructors
|
### Constructors
|
||||||
#### CommandProperties
|
#### CommandProperties
|
||||||
|
[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Configuration/CommandProperties.cs#L39)
|
||||||
```csharp
|
```csharp
|
||||||
public CommandProperties()
|
public CommandProperties()
|
||||||
```
|
```
|
@ -19,11 +19,12 @@
|
|||||||
| `bool` | [`EnableBanner`](#enablebanner) | `get, set` |
|
| `bool` | [`EnableBanner`](#enablebanner) | `get, set` |
|
||||||
| `bool` | [`IsEnabled`](#isenabled) | `get, set` |
|
| `bool` | [`IsEnabled`](#isenabled) | `get, set` |
|
||||||
| `string` | [`Name`](#name) | `get, set` |
|
| `string` | [`Name`](#name) | `get, set` |
|
||||||
| [`SocialAccountConfiguration`](./sharedlibrarycoreconfiguration-SocialAccountConfiguration)`[]` | [`SocialAccounts`](#socialaccounts) | `get, set` |
|
| [`SocialAccountConfiguration`](./SocialAccountConfiguration.md)`[]` | [`SocialAccounts`](#socialaccounts) | `get, set` |
|
||||||
|
|
||||||
## Details
|
## Details
|
||||||
### Constructors
|
### Constructors
|
||||||
#### CommunityInformationConfiguration
|
#### CommunityInformationConfiguration
|
||||||
|
[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Configuration/CommunityInformationConfiguration.cs#L5)
|
||||||
```csharp
|
```csharp
|
||||||
public CommunityInformationConfiguration()
|
public CommunityInformationConfiguration()
|
||||||
```
|
```
|
@ -22,24 +22,24 @@ SharedLibraryCore.Interfaces.IBaseConfiguration --> SharedLibraryCore.Configurat
|
|||||||
| --- | --- | --- |
|
| --- | --- | --- |
|
||||||
| `string``[]` | [`AutoMessages`](#automessages) | `get, set` |
|
| `string``[]` | [`AutoMessages`](#automessages) | `get, set` |
|
||||||
| `string``[]` | [`DisallowedClientNames`](#disallowedclientnames) | `get, set` |
|
| `string``[]` | [`DisallowedClientNames`](#disallowedclientnames) | `get, set` |
|
||||||
| [`GameStringConfiguration`](./sharedlibrarycoreconfiguration-GameStringConfiguration) | [`GameStrings`](#gamestrings) | `get, set` |
|
| [`GameStringConfiguration`](./GameStringConfiguration.md) | [`GameStrings`](#gamestrings) | `get, set` |
|
||||||
| [`GametypeConfiguration`](./sharedlibrarycoreconfiguration-GametypeConfiguration)`[]` | [`Gametypes`](#gametypes) | `get, set` |
|
| [`GametypeConfiguration`](./GametypeConfiguration.md)`[]` | [`Gametypes`](#gametypes) | `get, set` |
|
||||||
| `string``[]` | [`GlobalRules`](#globalrules) | `get, set` |
|
| `string``[]` | [`GlobalRules`](#globalrules) | `get, set` |
|
||||||
| [`MapConfiguration`](./sharedlibrarycoreconfiguration-MapConfiguration)`[]` | [`Maps`](#maps) | `get, set` |
|
| [`MapConfiguration`](./MapConfiguration.md)`[]` | [`Maps`](#maps) | `get, set` |
|
||||||
| [`QuickMessageConfiguration`](./sharedlibrarycoreconfiguration-QuickMessageConfiguration)`[]` | [`QuickMessages`](#quickmessages) | `get, set` |
|
| [`QuickMessageConfiguration`](./QuickMessageConfiguration.md)`[]` | [`QuickMessages`](#quickmessages) | `get, set` |
|
||||||
|
|
||||||
### Methods
|
### Methods
|
||||||
#### Public methods
|
#### Public methods
|
||||||
| Returns | Name |
|
| Returns | Name |
|
||||||
| --- | --- |
|
| --- | --- |
|
||||||
| [`IBaseConfiguration`](./sharedlibrarycoreinterfaces-IBaseConfiguration) | [`Generate`](#generate)() |
|
| [`IBaseConfiguration`](../interfaces/IBaseConfiguration.md) | [`Generate`](#generate)() |
|
||||||
| `string` | [`Name`](#name)() |
|
| `string` | [`Name`](#name)() |
|
||||||
|
|
||||||
## Details
|
## Details
|
||||||
### Inheritance
|
### Inheritance
|
||||||
- [
|
- [
|
||||||
`IBaseConfiguration`
|
`IBaseConfiguration`
|
||||||
](./sharedlibrarycoreinterfaces-IBaseConfiguration)
|
](../interfaces/IBaseConfiguration.md)
|
||||||
|
|
||||||
### Constructors
|
### Constructors
|
||||||
#### DefaultSettings
|
#### DefaultSettings
|
||||||
@ -49,11 +49,13 @@ public DefaultSettings()
|
|||||||
|
|
||||||
### Methods
|
### Methods
|
||||||
#### Generate
|
#### Generate
|
||||||
|
[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Configuration/DefaultSettings.cs#L16)
|
||||||
```csharp
|
```csharp
|
||||||
public virtual IBaseConfiguration Generate()
|
public virtual IBaseConfiguration Generate()
|
||||||
```
|
```
|
||||||
|
|
||||||
#### Name
|
#### Name
|
||||||
|
[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Configuration/DefaultSettings.cs#L21)
|
||||||
```csharp
|
```csharp
|
||||||
public virtual string Name()
|
public virtual string Name()
|
||||||
```
|
```
|
@ -33,6 +33,7 @@ public GameStringConfiguration()
|
|||||||
|
|
||||||
### Methods
|
### Methods
|
||||||
#### GetStringForGame
|
#### GetStringForGame
|
||||||
|
[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Configuration/GameStringConfiguration.cs#L10)
|
||||||
```csharp
|
```csharp
|
||||||
public string GetStringForGame(string key, Nullable<Game> game)
|
public string GetStringForGame(string key, Nullable<Game> game)
|
||||||
```
|
```
|
@ -16,7 +16,7 @@
|
|||||||
| Type | Name | Methods |
|
| Type | Name | Methods |
|
||||||
| --- | --- | --- |
|
| --- | --- | --- |
|
||||||
| `Game` | [`Game`](#game) | `get, set` |
|
| `Game` | [`Game`](#game) | `get, set` |
|
||||||
| [`Gametype`](./sharedlibrarycore-Gametype)`[]` | [`Gametypes`](#gametypes) | `get, set` |
|
| [`Gametype`](../Gametype.md)`[]` | [`Gametypes`](#gametypes) | `get, set` |
|
||||||
|
|
||||||
## Details
|
## Details
|
||||||
### Constructors
|
### Constructors
|
@ -16,7 +16,7 @@
|
|||||||
| Type | Name | Methods |
|
| Type | Name | Methods |
|
||||||
| --- | --- | --- |
|
| --- | --- | --- |
|
||||||
| `Game` | [`Game`](#game) | `get, set` |
|
| `Game` | [`Game`](#game) | `get, set` |
|
||||||
| [`Map`](./sharedlibrarycore-Map)`[]` | [`Maps`](#maps) | `get, set` |
|
| [`Map`](../Map.md)`[]` | [`Maps`](#maps) | `get, set` |
|
||||||
|
|
||||||
## Details
|
## Details
|
||||||
### Constructors
|
### Constructors
|
@ -37,9 +37,9 @@ SharedLibraryCore.Interfaces.IBaseConfiguration --> SharedLibraryCore.Configurat
|
|||||||
#### Public methods
|
#### Public methods
|
||||||
| Returns | Name |
|
| Returns | Name |
|
||||||
| --- | --- |
|
| --- | --- |
|
||||||
| `void` | [`AddEventParser`](#addeventparser)([`IEventParser`](./sharedlibrarycoreinterfaces-IEventParser) parser) |
|
| `void` | [`AddEventParser`](#addeventparser)([`IEventParser`](../interfaces/IEventParser.md) parser) |
|
||||||
| `void` | [`AddRConParser`](#addrconparser)([`IRConParser`](./sharedlibrarycoreinterfaces-IRConParser) parser) |
|
| `void` | [`AddRConParser`](#addrconparser)([`IRConParser`](../interfaces/IRConParser.md) parser) |
|
||||||
| [`IBaseConfiguration`](./sharedlibrarycoreinterfaces-IBaseConfiguration) | [`Generate`](#generate)() |
|
| [`IBaseConfiguration`](../interfaces/IBaseConfiguration.md) | [`Generate`](#generate)() |
|
||||||
| `void` | [`ModifyParsers`](#modifyparsers)() |
|
| `void` | [`ModifyParsers`](#modifyparsers)() |
|
||||||
| `string` | [`Name`](#name)() |
|
| `string` | [`Name`](#name)() |
|
||||||
|
|
||||||
@ -47,44 +47,50 @@ SharedLibraryCore.Interfaces.IBaseConfiguration --> SharedLibraryCore.Configurat
|
|||||||
### Inheritance
|
### Inheritance
|
||||||
- [
|
- [
|
||||||
`IBaseConfiguration`
|
`IBaseConfiguration`
|
||||||
](./sharedlibrarycoreinterfaces-IBaseConfiguration)
|
](../interfaces/IBaseConfiguration.md)
|
||||||
|
|
||||||
### Constructors
|
### Constructors
|
||||||
#### ServerConfiguration
|
#### ServerConfiguration
|
||||||
|
[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Configuration/ServerConfiguration.cs#L32)
|
||||||
```csharp
|
```csharp
|
||||||
public ServerConfiguration()
|
public ServerConfiguration()
|
||||||
```
|
```
|
||||||
|
|
||||||
### Methods
|
### Methods
|
||||||
#### Generate
|
#### Generate
|
||||||
|
[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Configuration/ServerConfiguration.cs#L60)
|
||||||
```csharp
|
```csharp
|
||||||
public virtual IBaseConfiguration Generate()
|
public virtual IBaseConfiguration Generate()
|
||||||
```
|
```
|
||||||
|
|
||||||
#### Name
|
#### Name
|
||||||
|
[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Configuration/ServerConfiguration.cs#L125)
|
||||||
```csharp
|
```csharp
|
||||||
public virtual string Name()
|
public virtual string Name()
|
||||||
```
|
```
|
||||||
|
|
||||||
#### AddRConParser
|
#### AddRConParser
|
||||||
|
[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Configuration/ServerConfiguration.cs#L130)
|
||||||
```csharp
|
```csharp
|
||||||
public void AddRConParser(IRConParser parser)
|
public void AddRConParser(IRConParser parser)
|
||||||
```
|
```
|
||||||
##### Arguments
|
##### Arguments
|
||||||
| Type | Name | Description |
|
| Type | Name | Description |
|
||||||
| --- | --- | --- |
|
| --- | --- | --- |
|
||||||
| [`IRConParser`](./sharedlibrarycoreinterfaces-IRConParser) | parser | |
|
| [`IRConParser`](../interfaces/IRConParser.md) | parser | |
|
||||||
|
|
||||||
#### AddEventParser
|
#### AddEventParser
|
||||||
|
[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Configuration/ServerConfiguration.cs#L135)
|
||||||
```csharp
|
```csharp
|
||||||
public void AddEventParser(IEventParser parser)
|
public void AddEventParser(IEventParser parser)
|
||||||
```
|
```
|
||||||
##### Arguments
|
##### Arguments
|
||||||
| Type | Name | Description |
|
| Type | Name | Description |
|
||||||
| --- | --- | --- |
|
| --- | --- | --- |
|
||||||
| [`IEventParser`](./sharedlibrarycoreinterfaces-IEventParser) | parser | |
|
| [`IEventParser`](../interfaces/IEventParser.md) | parser | |
|
||||||
|
|
||||||
#### ModifyParsers
|
#### ModifyParsers
|
||||||
|
[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Configuration/ServerConfiguration.cs#L16707566)
|
||||||
```csharp
|
```csharp
|
||||||
public void ModifyParsers()
|
public void ModifyParsers()
|
||||||
```
|
```
|
@ -27,6 +27,7 @@ System.Attribute --> SharedLibraryCore.Configuration.Attributes.ConfigurationLin
|
|||||||
|
|
||||||
### Constructors
|
### Constructors
|
||||||
#### ConfigurationLinked
|
#### ConfigurationLinked
|
||||||
|
[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Configuration/Attributes/ConfigurationLinked.cs#L8)
|
||||||
```csharp
|
```csharp
|
||||||
public ConfigurationLinked(string[] linkedPropertyNames)
|
public ConfigurationLinked(string[] linkedPropertyNames)
|
||||||
```
|
```
|
@ -27,6 +27,7 @@ System.ComponentModel.DisplayNameAttribute --> SharedLibraryCore.Configuration.A
|
|||||||
|
|
||||||
### Constructors
|
### Constructors
|
||||||
#### LocalizedDisplayName
|
#### LocalizedDisplayName
|
||||||
|
[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Configuration/Attributes/LocalizedDisplayName.cs#L9)
|
||||||
```csharp
|
```csharp
|
||||||
public LocalizedDisplayName(string localizationKey)
|
public LocalizedDisplayName(string localizationKey)
|
||||||
```
|
```
|
@ -15,27 +15,29 @@
|
|||||||
#### Public Static methods
|
#### Public Static methods
|
||||||
| Returns | Name |
|
| Returns | Name |
|
||||||
| --- | --- |
|
| --- | --- |
|
||||||
| (`string` Item1, `string` Item2)`[]` | [`TryGetRConPasswords`](#trygetrconpasswords)([`IRConParser`](./sharedlibrarycoreinterfaces-IRConParser) parser) |
|
| (`string` Item1, `string` Item2)`[]` | [`TryGetRConPasswords`](#trygetrconpasswords)([`IRConParser`](../../interfaces/IRConParser.md) parser) |
|
||||||
| `void` | [`TrySetIpAddress`](#trysetipaddress)([`ServerConfiguration`](./sharedlibrarycoreconfiguration-ServerConfiguration) config) |
|
| `void` | [`TrySetIpAddress`](#trysetipaddress)([`ServerConfiguration`](../ServerConfiguration.md) config) |
|
||||||
|
|
||||||
## Details
|
## Details
|
||||||
### Methods
|
### Methods
|
||||||
#### TrySetIpAddress
|
#### TrySetIpAddress
|
||||||
|
[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Configuration/Extensions/ConfigurationExtensions.cs#L17)
|
||||||
```csharp
|
```csharp
|
||||||
public static void TrySetIpAddress(ServerConfiguration config)
|
public static void TrySetIpAddress(ServerConfiguration config)
|
||||||
```
|
```
|
||||||
##### Arguments
|
##### Arguments
|
||||||
| Type | Name | Description |
|
| Type | Name | Description |
|
||||||
| --- | --- | --- |
|
| --- | --- | --- |
|
||||||
| [`ServerConfiguration`](./sharedlibrarycoreconfiguration-ServerConfiguration) | config | |
|
| [`ServerConfiguration`](../ServerConfiguration.md) | config | |
|
||||||
|
|
||||||
#### TryGetRConPasswords
|
#### TryGetRConPasswords
|
||||||
|
[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Configuration/Extensions/ConfigurationExtensions.cs#L42)
|
||||||
```csharp
|
```csharp
|
||||||
public static (string Item1, string Item2) TryGetRConPasswords(IRConParser parser)
|
public static (string Item1, string Item2) TryGetRConPasswords(IRConParser parser)
|
||||||
```
|
```
|
||||||
##### Arguments
|
##### Arguments
|
||||||
| Type | Name | Description |
|
| Type | Name | Description |
|
||||||
| --- | --- | --- |
|
| --- | --- | --- |
|
||||||
| [`IRConParser`](./sharedlibrarycoreinterfaces-IRConParser) | parser | |
|
| [`IRConParser`](../../interfaces/IRConParser.md) | parser | |
|
||||||
|
|
||||||
*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc)
|
*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc)
|
@ -22,10 +22,11 @@ FluentValidation.AbstractValidator_1 --> SharedLibraryCore.Configuration.Validat
|
|||||||
Validation class for main application configuration
|
Validation class for main application configuration
|
||||||
|
|
||||||
### Inheritance
|
### Inheritance
|
||||||
- `AbstractValidator`<[`ApplicationConfiguration`](./sharedlibrarycoreconfiguration-ApplicationConfiguration)>
|
- `AbstractValidator`<[`ApplicationConfiguration`](../ApplicationConfiguration.md)>
|
||||||
|
|
||||||
### Constructors
|
### Constructors
|
||||||
#### ApplicationConfigurationValidator
|
#### ApplicationConfigurationValidator
|
||||||
|
[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Configuration/Validation/ApplicationConfigurationValidator.cs#L13)
|
||||||
```csharp
|
```csharp
|
||||||
public ApplicationConfigurationValidator()
|
public ApplicationConfigurationValidator()
|
||||||
```
|
```
|
@ -22,10 +22,11 @@ FluentValidation.AbstractValidator_1 --> SharedLibraryCore.Configuration.Validat
|
|||||||
Validation class for server configuration
|
Validation class for server configuration
|
||||||
|
|
||||||
### Inheritance
|
### Inheritance
|
||||||
- `AbstractValidator`<[`ServerConfiguration`](./sharedlibrarycoreconfiguration-ServerConfiguration)>
|
- `AbstractValidator`<[`ServerConfiguration`](../ServerConfiguration.md)>
|
||||||
|
|
||||||
### Constructors
|
### Constructors
|
||||||
#### ServerConfigurationValidator
|
#### ServerConfigurationValidator
|
||||||
|
[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Configuration/Validation/ServerConfigurationValidator.cs#L10)
|
||||||
```csharp
|
```csharp
|
||||||
public ServerConfigurationValidator()
|
public ServerConfigurationValidator()
|
||||||
```
|
```
|
@ -21,10 +21,10 @@ Data.Models.Client.EFClient --> SharedLibraryCore.Database.Models.EFClient
|
|||||||
| --- | --- | --- |
|
| --- | --- | --- |
|
||||||
| `string` | [`CleanedName`](#cleanedname) | `get` |
|
| `string` | [`CleanedName`](#cleanedname) | `get` |
|
||||||
| `int` | [`ClientNumber`](#clientnumber) | `get, set` |
|
| `int` | [`ClientNumber`](#clientnumber) | `get, set` |
|
||||||
| [`ClientPermission`](./sharedlibrarycorelocalization-ClientPermission) | [`ClientPermission`](#clientpermission) | `get` |
|
| [`ClientPermission`](../../localization/ClientPermission.md) | [`ClientPermission`](#clientpermission) | `get` |
|
||||||
| `int` | [`ConnectionLength`](#connectionlength) | `get` |
|
| `int` | [`ConnectionLength`](#connectionlength) | `get` |
|
||||||
| `DateTime` | [`ConnectionTime`](#connectiontime) | `get, set` |
|
| `DateTime` | [`ConnectionTime`](#connectiontime) | `get, set` |
|
||||||
| [`Server`](./sharedlibrarycore-Server) | [`CurrentServer`](#currentserver) | `get, set` |
|
| [`Server`](../../Server.md) | [`CurrentServer`](#currentserver) | `get, set` |
|
||||||
| `string` | [`GuidString`](#guidstring) | `get` |
|
| `string` | [`GuidString`](#guidstring) | `get` |
|
||||||
| `Nullable`<`int`> | [`IPAddress`](#ipaddress) | `get, set` |
|
| `Nullable`<`int`> | [`IPAddress`](#ipaddress) | `get, set` |
|
||||||
| `string` | [`IPAddressString`](#ipaddressstring) | `get` |
|
| `string` | [`IPAddressString`](#ipaddressstring) | `get` |
|
||||||
@ -52,28 +52,28 @@ Data.Models.Client.EFClient --> SharedLibraryCore.Database.Models.EFClient
|
|||||||
#### Public methods
|
#### Public methods
|
||||||
| Returns | Name |
|
| Returns | Name |
|
||||||
| --- | --- |
|
| --- | --- |
|
||||||
| [`GameEvent`](./sharedlibrarycore-GameEvent) | [`Ban`](#ban)(`string` banReason, [`EFClient`](sharedlibrarycoredatabasemodels-EFClient) sender, `bool` isEvade)<br>permanently ban a client |
|
| [`GameEvent`](../../GameEvent.md) | [`Ban`](#ban)(`string` banReason, [`EFClient`](sharedlibrarycore/database/models/EFClient.md) sender, `bool` isEvade)<br>permanently ban a client |
|
||||||
| `Task`<`bool`> | [`CanConnect`](#canconnect)(`Nullable`<`int`> ipAddress, `bool` enableImplicitLinking) |
|
| `Task`<`bool`> | [`CanConnect`](#canconnect)(`Nullable`<`int`> ipAddress, `bool` enableImplicitLinking) |
|
||||||
| `bool` | [`Equals`](#equals)(`object` obj) |
|
| `bool` | [`Equals`](#equals)(`object` obj) |
|
||||||
| [`GameEvent`](./sharedlibrarycore-GameEvent) | [`Flag`](#flag)(`string` flagReason, [`EFClient`](sharedlibrarycoredatabasemodels-EFClient) sender, `Nullable`<`TimeSpan`> flagLength) |
|
| [`GameEvent`](../../GameEvent.md) | [`Flag`](#flag)(`string` flagReason, [`EFClient`](sharedlibrarycore/database/models/EFClient.md) sender, `Nullable`<`TimeSpan`> flagLength) |
|
||||||
| `int` | [`GetHashCode`](#gethashcode)() |
|
| `int` | [`GetHashCode`](#gethashcode)() |
|
||||||
| `bool` | [`IsAbleToConnectSimple`](#isabletoconnectsimple)()<br>Handles any client related logic on connection |
|
| `bool` | [`IsAbleToConnectSimple`](#isabletoconnectsimple)()<br>Handles any client related logic on connection |
|
||||||
| [`GameEvent`](./sharedlibrarycore-GameEvent) | [`Kick`](#kick-12)(`...`)<br>kick a client for the given reason |
|
| [`GameEvent`](../../GameEvent.md) | [`Kick`](#kick-12)(`...`)<br>kick a client for the given reason |
|
||||||
| `Task` | [`Lock`](#lock)() |
|
| `Task` | [`Lock`](#lock)() |
|
||||||
| `Task` | [`OnDisconnect`](#ondisconnect)() |
|
| `Task` | [`OnDisconnect`](#ondisconnect)() |
|
||||||
| `Task` | [`OnJoin`](#onjoin)(`Nullable`<`int`> ipAddress, `bool` enableImplicitLinking) |
|
| `Task` | [`OnJoin`](#onjoin)(`Nullable`<`int`> ipAddress, `bool` enableImplicitLinking) |
|
||||||
| [`GameEvent`](./sharedlibrarycore-GameEvent) | [`Report`](#report)(`string` reportReason, [`EFClient`](sharedlibrarycoredatabasemodels-EFClient) sender)<br>report a client for a given reason |
|
| [`GameEvent`](../../GameEvent.md) | [`Report`](#report)(`string` reportReason, [`EFClient`](sharedlibrarycore/database/models/EFClient.md) sender)<br>report a client for a given reason |
|
||||||
| [`GameEvent`](./sharedlibrarycore-GameEvent) | [`SetLevel`](#setlevel)(`Permission` newPermission, [`EFClient`](sharedlibrarycoredatabasemodels-EFClient) sender) |
|
| [`GameEvent`](../../GameEvent.md) | [`SetLevel`](#setlevel)(`Permission` newPermission, [`EFClient`](sharedlibrarycore/database/models/EFClient.md) sender) |
|
||||||
| [`GameEvent`](./sharedlibrarycore-GameEvent) | [`Tell`](#tell-12)(`...`)<br>send a message directly to the connected client |
|
| [`GameEvent`](../../GameEvent.md) | [`Tell`](#tell-12)(`...`)<br>send a message directly to the connected client |
|
||||||
| `Task` | [`TellAsync`](#tellasync)(`IEnumerable`<`string`> messages, `CancellationToken` token) |
|
| `Task` | [`TellAsync`](#tellasync)(`IEnumerable`<`string`> messages, `CancellationToken` token) |
|
||||||
| [`GameEvent`](./sharedlibrarycore-GameEvent) | [`TempBan`](#tempban)(`string` tempbanReason, `TimeSpan` banLength, [`EFClient`](sharedlibrarycoredatabasemodels-EFClient) sender)<br>temporarily ban a client for the given time span |
|
| [`GameEvent`](../../GameEvent.md) | [`TempBan`](#tempban)(`string` tempbanReason, `TimeSpan` banLength, [`EFClient`](sharedlibrarycore/database/models/EFClient.md) sender)<br>temporarily ban a client for the given time span |
|
||||||
| `string` | [`ToString`](#tostring)() |
|
| `string` | [`ToString`](#tostring)() |
|
||||||
| [`GameEvent`](./sharedlibrarycore-GameEvent) | [`Unban`](#unban)(`string` unbanReason, [`EFClient`](sharedlibrarycoredatabasemodels-EFClient) sender)<br>unban a client |
|
| [`GameEvent`](../../GameEvent.md) | [`Unban`](#unban)(`string` unbanReason, [`EFClient`](sharedlibrarycore/database/models/EFClient.md) sender)<br>unban a client |
|
||||||
| [`GameEvent`](./sharedlibrarycore-GameEvent) | [`Unflag`](#unflag)(`string` unflagReason, [`EFClient`](sharedlibrarycoredatabasemodels-EFClient) sender)<br>unflag a client for a given reason |
|
| [`GameEvent`](../../GameEvent.md) | [`Unflag`](#unflag)(`string` unflagReason, [`EFClient`](sharedlibrarycore/database/models/EFClient.md) sender)<br>unflag a client for a given reason |
|
||||||
| `void` | [`Unlock`](#unlock)() |
|
| `void` | [`Unlock`](#unlock)() |
|
||||||
| `void` | [`UpdateTeam`](#updateteam)(`string` newTeam) |
|
| `void` | [`UpdateTeam`](#updateteam)(`string` newTeam) |
|
||||||
| [`GameEvent`](./sharedlibrarycore-GameEvent) | [`Warn`](#warn)(`string` warnReason, [`EFClient`](sharedlibrarycoredatabasemodels-EFClient) sender)<br>warn a client with given reason |
|
| [`GameEvent`](../../GameEvent.md) | [`Warn`](#warn)(`string` warnReason, [`EFClient`](sharedlibrarycore/database/models/EFClient.md) sender)<br>warn a client with given reason |
|
||||||
| [`GameEvent`](./sharedlibrarycore-GameEvent) | [`WarnClear`](#warnclear)([`EFClient`](sharedlibrarycoredatabasemodels-EFClient) sender)<br>clear all warnings for a client |
|
| [`GameEvent`](../../GameEvent.md) | [`WarnClear`](#warnclear)([`EFClient`](sharedlibrarycore/database/models/EFClient.md) sender)<br>clear all warnings for a client |
|
||||||
|
|
||||||
## Details
|
## Details
|
||||||
### Inheritance
|
### Inheritance
|
||||||
@ -86,22 +86,26 @@ Data.Models.Client.EFClient --> SharedLibraryCore.Database.Models.EFClient
|
|||||||
|
|
||||||
### Constructors
|
### Constructors
|
||||||
#### EFClient
|
#### EFClient
|
||||||
|
[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/PartialEntities/EFClient.cs#L53)
|
||||||
```csharp
|
```csharp
|
||||||
public EFClient()
|
public EFClient()
|
||||||
```
|
```
|
||||||
|
|
||||||
### Methods
|
### Methods
|
||||||
#### Finalize
|
#### Finalize
|
||||||
|
[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/PartialEntities/EFClient.cs#L147)
|
||||||
```csharp
|
```csharp
|
||||||
protected override void Finalize()
|
protected override void Finalize()
|
||||||
```
|
```
|
||||||
|
|
||||||
#### ToString
|
#### ToString
|
||||||
|
[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/PartialEntities/EFClient.cs#L152)
|
||||||
```csharp
|
```csharp
|
||||||
public override string ToString()
|
public override string ToString()
|
||||||
```
|
```
|
||||||
|
|
||||||
#### Tell [1/2]
|
#### Tell [1/2]
|
||||||
|
[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/PartialEntities/EFClient.cs#L162)
|
||||||
```csharp
|
```csharp
|
||||||
public GameEvent Tell(string message)
|
public GameEvent Tell(string message)
|
||||||
```
|
```
|
||||||
@ -114,6 +118,7 @@ public GameEvent Tell(string message)
|
|||||||
send a message directly to the connected client
|
send a message directly to the connected client
|
||||||
|
|
||||||
#### Tell [2/2]
|
#### Tell [2/2]
|
||||||
|
[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/PartialEntities/EFClient.cs#L186)
|
||||||
```csharp
|
```csharp
|
||||||
public void Tell(IEnumerable<string> messages)
|
public void Tell(IEnumerable<string> messages)
|
||||||
```
|
```
|
||||||
@ -133,6 +138,7 @@ public async Task TellAsync(IEnumerable<string> messages, CancellationToken toke
|
|||||||
| `CancellationToken` | token | |
|
| `CancellationToken` | token | |
|
||||||
|
|
||||||
#### Warn
|
#### Warn
|
||||||
|
[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/PartialEntities/EFClient.cs#L214)
|
||||||
```csharp
|
```csharp
|
||||||
public GameEvent Warn(string warnReason, EFClient sender)
|
public GameEvent Warn(string warnReason, EFClient sender)
|
||||||
```
|
```
|
||||||
@ -140,19 +146,20 @@ public GameEvent Warn(string warnReason, EFClient sender)
|
|||||||
| Type | Name | Description |
|
| Type | Name | Description |
|
||||||
| --- | --- | --- |
|
| --- | --- | --- |
|
||||||
| `string` | warnReason | reason for warn |
|
| `string` | warnReason | reason for warn |
|
||||||
| [`EFClient`](sharedlibrarycoredatabasemodels-EFClient) | sender | client performing the warn |
|
| [`EFClient`](sharedlibrarycore/database/models/EFClient.md) | sender | client performing the warn |
|
||||||
|
|
||||||
##### Summary
|
##### Summary
|
||||||
warn a client with given reason
|
warn a client with given reason
|
||||||
|
|
||||||
#### WarnClear
|
#### WarnClear
|
||||||
|
[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/PartialEntities/EFClient.cs#L246)
|
||||||
```csharp
|
```csharp
|
||||||
public GameEvent WarnClear(EFClient sender)
|
public GameEvent WarnClear(EFClient sender)
|
||||||
```
|
```
|
||||||
##### Arguments
|
##### Arguments
|
||||||
| Type | Name | Description |
|
| Type | Name | Description |
|
||||||
| --- | --- | --- |
|
| --- | --- | --- |
|
||||||
| [`EFClient`](sharedlibrarycoredatabasemodels-EFClient) | sender | client performing the warn clear |
|
| [`EFClient`](sharedlibrarycore/database/models/EFClient.md) | sender | client performing the warn clear |
|
||||||
|
|
||||||
##### Summary
|
##### Summary
|
||||||
clear all warnings for a client
|
clear all warnings for a client
|
||||||
@ -161,6 +168,7 @@ clear all warnings for a client
|
|||||||
|
|
||||||
|
|
||||||
#### Report
|
#### Report
|
||||||
|
[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/PartialEntities/EFClient.cs#L16707566)
|
||||||
```csharp
|
```csharp
|
||||||
public GameEvent Report(string reportReason, EFClient sender)
|
public GameEvent Report(string reportReason, EFClient sender)
|
||||||
```
|
```
|
||||||
@ -168,7 +176,7 @@ public GameEvent Report(string reportReason, EFClient sender)
|
|||||||
| Type | Name | Description |
|
| Type | Name | Description |
|
||||||
| --- | --- | --- |
|
| --- | --- | --- |
|
||||||
| `string` | reportReason | reason for the report |
|
| `string` | reportReason | reason for the report |
|
||||||
| [`EFClient`](sharedlibrarycoredatabasemodels-EFClient) | sender | client performing the report |
|
| [`EFClient`](sharedlibrarycore/database/models/EFClient.md) | sender | client performing the report |
|
||||||
|
|
||||||
##### Summary
|
##### Summary
|
||||||
report a client for a given reason
|
report a client for a given reason
|
||||||
@ -177,6 +185,7 @@ report a client for a given reason
|
|||||||
|
|
||||||
|
|
||||||
#### Flag
|
#### Flag
|
||||||
|
[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/PartialEntities/EFClient.cs#L317)
|
||||||
```csharp
|
```csharp
|
||||||
public GameEvent Flag(string flagReason, EFClient sender, Nullable<TimeSpan> flagLength)
|
public GameEvent Flag(string flagReason, EFClient sender, Nullable<TimeSpan> flagLength)
|
||||||
```
|
```
|
||||||
@ -184,10 +193,11 @@ public GameEvent Flag(string flagReason, EFClient sender, Nullable<TimeSpan> fla
|
|||||||
| Type | Name | Description |
|
| Type | Name | Description |
|
||||||
| --- | --- | --- |
|
| --- | --- | --- |
|
||||||
| `string` | flagReason | |
|
| `string` | flagReason | |
|
||||||
| [`EFClient`](sharedlibrarycoredatabasemodels-EFClient) | sender | |
|
| [`EFClient`](sharedlibrarycore/database/models/EFClient.md) | sender | |
|
||||||
| `Nullable`<`TimeSpan`> | flagLength | |
|
| `Nullable`<`TimeSpan`> | flagLength | |
|
||||||
|
|
||||||
#### Unflag
|
#### Unflag
|
||||||
|
[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/PartialEntities/EFClient.cs#L350)
|
||||||
```csharp
|
```csharp
|
||||||
public GameEvent Unflag(string unflagReason, EFClient sender)
|
public GameEvent Unflag(string unflagReason, EFClient sender)
|
||||||
```
|
```
|
||||||
@ -195,7 +205,7 @@ public GameEvent Unflag(string unflagReason, EFClient sender)
|
|||||||
| Type | Name | Description |
|
| Type | Name | Description |
|
||||||
| --- | --- | --- |
|
| --- | --- | --- |
|
||||||
| `string` | unflagReason | reason to unflag a player for |
|
| `string` | unflagReason | reason to unflag a player for |
|
||||||
| [`EFClient`](sharedlibrarycoredatabasemodels-EFClient) | sender | client performing the unflag |
|
| [`EFClient`](sharedlibrarycore/database/models/EFClient.md) | sender | client performing the unflag |
|
||||||
|
|
||||||
##### Summary
|
##### Summary
|
||||||
unflag a client for a given reason
|
unflag a client for a given reason
|
||||||
@ -204,6 +214,7 @@ unflag a client for a given reason
|
|||||||
game event for the un flug
|
game event for the un flug
|
||||||
|
|
||||||
#### Kick [1/2]
|
#### Kick [1/2]
|
||||||
|
[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/PartialEntities/EFClient.cs#L381)
|
||||||
```csharp
|
```csharp
|
||||||
public GameEvent Kick(string kickReason, EFClient sender)
|
public GameEvent Kick(string kickReason, EFClient sender)
|
||||||
```
|
```
|
||||||
@ -211,12 +222,13 @@ public GameEvent Kick(string kickReason, EFClient sender)
|
|||||||
| Type | Name | Description |
|
| Type | Name | Description |
|
||||||
| --- | --- | --- |
|
| --- | --- | --- |
|
||||||
| `string` | kickReason | reason to kick for |
|
| `string` | kickReason | reason to kick for |
|
||||||
| [`EFClient`](sharedlibrarycoredatabasemodels-EFClient) | sender | client performing the kick |
|
| [`EFClient`](sharedlibrarycore/database/models/EFClient.md) | sender | client performing the kick |
|
||||||
|
|
||||||
##### Summary
|
##### Summary
|
||||||
kick a client for the given reason
|
kick a client for the given reason
|
||||||
|
|
||||||
#### Kick [2/2]
|
#### Kick [2/2]
|
||||||
|
[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/PartialEntities/EFClient.cs#L392)
|
||||||
```csharp
|
```csharp
|
||||||
public GameEvent Kick(string kickReason, EFClient sender, EFPenalty originalPenalty)
|
public GameEvent Kick(string kickReason, EFClient sender, EFPenalty originalPenalty)
|
||||||
```
|
```
|
||||||
@ -224,13 +236,14 @@ public GameEvent Kick(string kickReason, EFClient sender, EFPenalty originalPena
|
|||||||
| Type | Name | Description |
|
| Type | Name | Description |
|
||||||
| --- | --- | --- |
|
| --- | --- | --- |
|
||||||
| `string` | kickReason | reason to kick for |
|
| `string` | kickReason | reason to kick for |
|
||||||
| [`EFClient`](sharedlibrarycoredatabasemodels-EFClient) | sender | client performing the kick |
|
| [`EFClient`](sharedlibrarycore/database/models/EFClient.md) | sender | client performing the kick |
|
||||||
| `EFPenalty` | originalPenalty | original client penalty |
|
| `EFPenalty` | originalPenalty | original client penalty |
|
||||||
|
|
||||||
##### Summary
|
##### Summary
|
||||||
kick a client for the given reason
|
kick a client for the given reason
|
||||||
|
|
||||||
#### TempBan
|
#### TempBan
|
||||||
|
[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/PartialEntities/EFClient.cs#L422)
|
||||||
```csharp
|
```csharp
|
||||||
public GameEvent TempBan(string tempbanReason, TimeSpan banLength, EFClient sender)
|
public GameEvent TempBan(string tempbanReason, TimeSpan banLength, EFClient sender)
|
||||||
```
|
```
|
||||||
@ -239,12 +252,13 @@ public GameEvent TempBan(string tempbanReason, TimeSpan banLength, EFClient send
|
|||||||
| --- | --- | --- |
|
| --- | --- | --- |
|
||||||
| `string` | tempbanReason | reason for the temp ban |
|
| `string` | tempbanReason | reason for the temp ban |
|
||||||
| `TimeSpan` | banLength | how long the temp ban lasts |
|
| `TimeSpan` | banLength | how long the temp ban lasts |
|
||||||
| [`EFClient`](sharedlibrarycoredatabasemodels-EFClient) | sender | client performing the tempban |
|
| [`EFClient`](sharedlibrarycore/database/models/EFClient.md) | sender | client performing the tempban |
|
||||||
|
|
||||||
##### Summary
|
##### Summary
|
||||||
temporarily ban a client for the given time span
|
temporarily ban a client for the given time span
|
||||||
|
|
||||||
#### Ban
|
#### Ban
|
||||||
|
[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/PartialEntities/EFClient.cs#L452)
|
||||||
```csharp
|
```csharp
|
||||||
public GameEvent Ban(string banReason, EFClient sender, bool isEvade)
|
public GameEvent Ban(string banReason, EFClient sender, bool isEvade)
|
||||||
```
|
```
|
||||||
@ -252,13 +266,14 @@ public GameEvent Ban(string banReason, EFClient sender, bool isEvade)
|
|||||||
| Type | Name | Description |
|
| Type | Name | Description |
|
||||||
| --- | --- | --- |
|
| --- | --- | --- |
|
||||||
| `string` | banReason | reason for the ban |
|
| `string` | banReason | reason for the ban |
|
||||||
| [`EFClient`](sharedlibrarycoredatabasemodels-EFClient) | sender | client performing the ban |
|
| [`EFClient`](sharedlibrarycore/database/models/EFClient.md) | sender | client performing the ban |
|
||||||
| `bool` | isEvade | obsolete |
|
| `bool` | isEvade | obsolete |
|
||||||
|
|
||||||
##### Summary
|
##### Summary
|
||||||
permanently ban a client
|
permanently ban a client
|
||||||
|
|
||||||
#### Unban
|
#### Unban
|
||||||
|
[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/PartialEntities/EFClient.cs#L487)
|
||||||
```csharp
|
```csharp
|
||||||
public GameEvent Unban(string unbanReason, EFClient sender)
|
public GameEvent Unban(string unbanReason, EFClient sender)
|
||||||
```
|
```
|
||||||
@ -266,7 +281,7 @@ public GameEvent Unban(string unbanReason, EFClient sender)
|
|||||||
| Type | Name | Description |
|
| Type | Name | Description |
|
||||||
| --- | --- | --- |
|
| --- | --- | --- |
|
||||||
| `string` | unbanReason | reason for the unban |
|
| `string` | unbanReason | reason for the unban |
|
||||||
| [`EFClient`](sharedlibrarycoredatabasemodels-EFClient) | sender | client performing the unban |
|
| [`EFClient`](sharedlibrarycore/database/models/EFClient.md) | sender | client performing the unban |
|
||||||
|
|
||||||
##### Summary
|
##### Summary
|
||||||
unban a client
|
unban a client
|
||||||
@ -275,6 +290,7 @@ unban a client
|
|||||||
|
|
||||||
|
|
||||||
#### SetLevel
|
#### SetLevel
|
||||||
|
[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/PartialEntities/EFClient.cs#L515)
|
||||||
```csharp
|
```csharp
|
||||||
public GameEvent SetLevel(Permission newPermission, EFClient sender)
|
public GameEvent SetLevel(Permission newPermission, EFClient sender)
|
||||||
```
|
```
|
||||||
@ -282,9 +298,10 @@ public GameEvent SetLevel(Permission newPermission, EFClient sender)
|
|||||||
| Type | Name | Description |
|
| Type | Name | Description |
|
||||||
| --- | --- | --- |
|
| --- | --- | --- |
|
||||||
| `Permission` | newPermission | |
|
| `Permission` | newPermission | |
|
||||||
| [`EFClient`](sharedlibrarycoredatabasemodels-EFClient) | sender | |
|
| [`EFClient`](sharedlibrarycore/database/models/EFClient.md) | sender | |
|
||||||
|
|
||||||
#### IsAbleToConnectSimple
|
#### IsAbleToConnectSimple
|
||||||
|
[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/PartialEntities/EFClient.cs#L548)
|
||||||
```csharp
|
```csharp
|
||||||
public bool IsAbleToConnectSimple()
|
public bool IsAbleToConnectSimple()
|
||||||
```
|
```
|
||||||
@ -317,6 +334,7 @@ public async Task<bool> CanConnect(Nullable<int> ipAddress, bool enableImplicitL
|
|||||||
| `bool` | enableImplicitLinking | |
|
| `bool` | enableImplicitLinking | |
|
||||||
|
|
||||||
#### UpdateTeam
|
#### UpdateTeam
|
||||||
|
[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/PartialEntities/EFClient.cs#L787)
|
||||||
```csharp
|
```csharp
|
||||||
public void UpdateTeam(string newTeam)
|
public void UpdateTeam(string newTeam)
|
||||||
```
|
```
|
||||||
@ -331,11 +349,13 @@ public async Task Lock()
|
|||||||
```
|
```
|
||||||
|
|
||||||
#### Unlock
|
#### Unlock
|
||||||
|
[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/PartialEntities/EFClient.cs#L810)
|
||||||
```csharp
|
```csharp
|
||||||
public void Unlock()
|
public void Unlock()
|
||||||
```
|
```
|
||||||
|
|
||||||
#### Equals
|
#### Equals
|
||||||
|
[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/PartialEntities/EFClient.cs#L818)
|
||||||
```csharp
|
```csharp
|
||||||
public override bool Equals(object obj)
|
public override bool Equals(object obj)
|
||||||
```
|
```
|
||||||
@ -345,6 +365,7 @@ public override bool Equals(object obj)
|
|||||||
| `object` | obj | |
|
| `object` | obj | |
|
||||||
|
|
||||||
#### GetHashCode
|
#### GetHashCode
|
||||||
|
[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/PartialEntities/EFClient.cs#L823)
|
||||||
```csharp
|
```csharp
|
||||||
public override int GetHashCode()
|
public override int GetHashCode()
|
||||||
```
|
```
|
@ -15,12 +15,13 @@
|
|||||||
#### Public properties
|
#### Public properties
|
||||||
| Type | Name | Methods |
|
| Type | Name | Methods |
|
||||||
| --- | --- | --- |
|
| --- | --- | --- |
|
||||||
| `List`<[`ClientCountSnapshot`](./sharedlibrarycoredtos-ClientCountSnapshot)> | [`ClientCounts`](#clientcounts) | `get, set` |
|
| `List`<[`ClientCountSnapshot`](./ClientCountSnapshot.md)> | [`ClientCounts`](#clientcounts) | `get, set` |
|
||||||
| `long` | [`ServerId`](#serverid) | `get, set` |
|
| `long` | [`ServerId`](#serverid) | `get, set` |
|
||||||
|
|
||||||
## Details
|
## Details
|
||||||
### Constructors
|
### Constructors
|
||||||
#### ClientHistoryInfo
|
#### ClientHistoryInfo
|
||||||
|
[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Dtos/ClientHistoryInfo.cs#L9)
|
||||||
```csharp
|
```csharp
|
||||||
public ClientHistoryInfo()
|
public ClientHistoryInfo()
|
||||||
```
|
```
|
@ -19,13 +19,13 @@ This class wraps the information related to a generated event for the API
|
|||||||
| Type | Name | Methods |
|
| Type | Name | Methods |
|
||||||
| --- | --- | --- |
|
| --- | --- | --- |
|
||||||
| `DateTime` | [`EventTime`](#eventtime) | `get, set` |
|
| `DateTime` | [`EventTime`](#eventtime) | `get, set` |
|
||||||
| [`EntityInfo`](./sharedlibrarycoredtos-EntityInfo) | [`EventType`](#eventtype) | `get, set` |
|
| [`EntityInfo`](./EntityInfo.md) | [`EventType`](#eventtype) | `get, set` |
|
||||||
| `string` | [`ExtraInfo`](#extrainfo) | `get, set` |
|
| `string` | [`ExtraInfo`](#extrainfo) | `get, set` |
|
||||||
| [`EntityInfo`](./sharedlibrarycoredtos-EntityInfo) | [`GameInfo`](#gameinfo) | `get, set` |
|
| [`EntityInfo`](./EntityInfo.md) | [`GameInfo`](#gameinfo) | `get, set` |
|
||||||
| `string` | [`Id`](#id) | `get` |
|
| `string` | [`Id`](#id) | `get` |
|
||||||
| [`EntityInfo`](./sharedlibrarycoredtos-EntityInfo) | [`OriginEntity`](#originentity) | `get, set` |
|
| [`EntityInfo`](./EntityInfo.md) | [`OriginEntity`](#originentity) | `get, set` |
|
||||||
| [`EntityInfo`](./sharedlibrarycoredtos-EntityInfo) | [`OwnerEntity`](#ownerentity) | `get, set` |
|
| [`EntityInfo`](./EntityInfo.md) | [`OwnerEntity`](#ownerentity) | `get, set` |
|
||||||
| [`EntityInfo`](./sharedlibrarycoredtos-EntityInfo) | [`TargetEntity`](#targetentity) | `get, set` |
|
| [`EntityInfo`](./EntityInfo.md) | [`TargetEntity`](#targetentity) | `get, set` |
|
||||||
|
|
||||||
## Details
|
## Details
|
||||||
### Summary
|
### Summary
|
||||||
@ -33,6 +33,7 @@ This class wraps the information related to a generated event for the API
|
|||||||
|
|
||||||
### Constructors
|
### Constructors
|
||||||
#### EventInfo
|
#### EventInfo
|
||||||
|
[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Dtos/EventInfo.cs#L17)
|
||||||
```csharp
|
```csharp
|
||||||
public EventInfo()
|
public EventInfo()
|
||||||
```
|
```
|
@ -30,7 +30,7 @@ SharedLibraryCore.Dtos.PaginationRequest --> SharedLibraryCore.Dtos.FindClientRe
|
|||||||
### Inheritance
|
### Inheritance
|
||||||
- [
|
- [
|
||||||
`PaginationRequest`
|
`PaginationRequest`
|
||||||
](./sharedlibrarycoredtos-PaginationRequest)
|
](./PaginationRequest.md)
|
||||||
|
|
||||||
### Constructors
|
### Constructors
|
||||||
#### FindClientRequest
|
#### FindClientRequest
|
||||||
@ -40,6 +40,7 @@ public FindClientRequest()
|
|||||||
|
|
||||||
### Methods
|
### Methods
|
||||||
#### ToDebugString
|
#### ToDebugString
|
||||||
|
[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Dtos/FindClientRequest.cs#L16)
|
||||||
```csharp
|
```csharp
|
||||||
public string ToDebugString()
|
public string ToDebugString()
|
||||||
```
|
```
|
@ -27,7 +27,7 @@ SharedLibraryCore.Interfaces.ILookupValue_1 --> SharedLibraryCore.Dtos.LookupVal
|
|||||||
|
|
||||||
## Details
|
## Details
|
||||||
### Inheritance
|
### Inheritance
|
||||||
- [`ILookupValue`](./sharedlibrarycoreinterfaces-ILookupValueT)<`TObject`>
|
- [`ILookupValue`](../interfaces/ILookupValueT.md)<`TObject`>
|
||||||
|
|
||||||
### Constructors
|
### Constructors
|
||||||
#### LookupValue
|
#### LookupValue
|
@ -21,7 +21,7 @@ pagination information holder class
|
|||||||
| `Nullable`<`DateTime`> | [`After`](#after) | `get, set` |
|
| `Nullable`<`DateTime`> | [`After`](#after) | `get, set` |
|
||||||
| `Nullable`<`DateTime`> | [`Before`](#before) | `get, set` |
|
| `Nullable`<`DateTime`> | [`Before`](#before) | `get, set` |
|
||||||
| `int` | [`Count`](#count)<br>how many items to take | `get, set` |
|
| `int` | [`Count`](#count)<br>how many items to take | `get, set` |
|
||||||
| [`SortDirection`](./sharedlibrarycoredtos-SortDirection) | [`Direction`](#direction)<br>direction of ordering | `get, set` |
|
| [`SortDirection`](./SortDirection.md) | [`Direction`](#direction)<br>direction of ordering | `get, set` |
|
||||||
| `string` | [`Filter`](#filter)<br>filter query | `get, set` |
|
| `string` | [`Filter`](#filter)<br>filter query | `get, set` |
|
||||||
| `int` | [`Offset`](#offset)<br>how many items to skip | `get, set` |
|
| `int` | [`Offset`](#offset)<br>how many items to skip | `get, set` |
|
||||||
|
|
||||||
@ -31,6 +31,7 @@ pagination information holder class
|
|||||||
|
|
||||||
### Constructors
|
### Constructors
|
||||||
#### PaginationRequest
|
#### PaginationRequest
|
||||||
|
[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Dtos/PaginationRequest.cs#L18)
|
||||||
```csharp
|
```csharp
|
||||||
public PaginationRequest()
|
public PaginationRequest()
|
||||||
```
|
```
|
@ -45,7 +45,7 @@ SharedLibraryCore.Dtos.SharedInfo --> SharedLibraryCore.Dtos.PenaltyInfo
|
|||||||
### Inheritance
|
### Inheritance
|
||||||
- [
|
- [
|
||||||
`SharedInfo`
|
`SharedInfo`
|
||||||
](./sharedlibrarycoredtos-SharedInfo)
|
](./SharedInfo.md)
|
||||||
|
|
||||||
### Constructors
|
### Constructors
|
||||||
#### PenaltyInfo
|
#### PenaltyInfo
|
@ -23,21 +23,21 @@
|
|||||||
| `string` | [`ConnectProtocolUrl`](#connectprotocolurl) | `get, set` |
|
| `string` | [`ConnectProtocolUrl`](#connectprotocolurl) | `get, set` |
|
||||||
| `string` | [`CurrentServerName`](#currentservername) | `get, set` |
|
| `string` | [`CurrentServerName`](#currentservername) | `get, set` |
|
||||||
| `Game` | [`Game`](#game) | `get, set` |
|
| `Game` | [`Game`](#game) | `get, set` |
|
||||||
| [`IGeoLocationResult`](./sharedlibrarycoreinterfaces-IGeoLocationResult) | [`GeoLocationInfo`](#geolocationinfo) | `get, set` |
|
| [`IGeoLocationResult`](../interfaces/IGeoLocationResult.md) | [`GeoLocationInfo`](#geolocationinfo) | `get, set` |
|
||||||
| `bool` | [`HasActivePenalty`](#hasactivepenalty) | `get, set` |
|
| `bool` | [`HasActivePenalty`](#hasactivepenalty) | `get, set` |
|
||||||
| `string` | [`IPAddress`](#ipaddress) | `get, set` |
|
| `string` | [`IPAddress`](#ipaddress) | `get, set` |
|
||||||
| `List`<(`string` Item1, `DateTime` Item2)> | [`IPs`](#ips) | `get, set` |
|
| `List`<(`string` Item1, `DateTime` Item2)> | [`IPs`](#ips) | `get, set` |
|
||||||
| `List`<[`IInteractionData`](./sharedlibrarycoreinterfaces-IInteractionData)> | [`Interactions`](#interactions) | `get, set` |
|
| `List`<[`IInteractionData`](../interfaces/IInteractionData.md)> | [`Interactions`](#interactions) | `get, set` |
|
||||||
| `DateTime` | [`LastConnection`](#lastconnection) | `get, set` |
|
| `DateTime` | [`LastConnection`](#lastconnection) | `get, set` |
|
||||||
| `string` | [`LastConnectionText`](#lastconnectiontext) | `get` |
|
| `string` | [`LastConnectionText`](#lastconnectiontext) | `get` |
|
||||||
| `string` | [`Level`](#level) | `get, set` |
|
| `string` | [`Level`](#level) | `get, set` |
|
||||||
| `int` | [`LevelInt`](#levelint) | `get, set` |
|
| `int` | [`LevelInt`](#levelint) | `get, set` |
|
||||||
| `IDictionary`<`int`, `long`> | [`LinkedAccounts`](#linkedaccounts) | `get, set` |
|
| `IDictionary`<`int`, `long`> | [`LinkedAccounts`](#linkedaccounts) | `get, set` |
|
||||||
| `List`<[`InformationResponse`](./sharedlibrarycoredtosmetaresponses-InformationResponse)> | [`Meta`](#meta) | `get, set` |
|
| `List`<[`InformationResponse`](meta/responses/InformationResponse.md)> | [`Meta`](#meta) | `get, set` |
|
||||||
| `Nullable`<[`MetaType`](./sharedlibrarycoreinterfaces-MetaType)> | [`MetaFilterType`](#metafiltertype) | `get, set` |
|
| `Nullable`<[`MetaType`](../interfaces/MetaType.md)> | [`MetaFilterType`](#metafiltertype) | `get, set` |
|
||||||
| `string` | [`Name`](#name) | `get, set` |
|
| `string` | [`Name`](#name) | `get, set` |
|
||||||
| `long` | [`NetworkId`](#networkid) | `get, set` |
|
| `long` | [`NetworkId`](#networkid) | `get, set` |
|
||||||
| [`ClientNoteMetaResponse`](./sharedlibrarycoredtosmetaresponses-ClientNoteMetaResponse) | [`NoteMeta`](#notemeta) | `get, set` |
|
| [`ClientNoteMetaResponse`](meta/responses/ClientNoteMetaResponse.md) | [`NoteMeta`](#notemeta) | `get, set` |
|
||||||
| `bool` | [`Online`](#online) | `get, set` |
|
| `bool` | [`Online`](#online) | `get, set` |
|
||||||
| `string` | [`Tag`](#tag) | `get, set` |
|
| `string` | [`Tag`](#tag) | `get, set` |
|
||||||
| `string` | [`TimeOnline`](#timeonline) | `get, set` |
|
| `string` | [`TimeOnline`](#timeonline) | `get, set` |
|
@ -15,9 +15,9 @@
|
|||||||
#### Public properties
|
#### Public properties
|
||||||
| Type | Name | Methods |
|
| Type | Name | Methods |
|
||||||
| --- | --- | --- |
|
| --- | --- | --- |
|
||||||
| `List`<[`ChatInfo`](./sharedlibrarycoredtos-ChatInfo)> | [`ChatHistory`](#chathistory) | `get, set` |
|
| `List`<[`ChatInfo`](./ChatInfo.md)> | [`ChatHistory`](#chathistory) | `get, set` |
|
||||||
| `int` | [`ClientCount`](#clientcount) | `get, set` |
|
| `int` | [`ClientCount`](#clientcount) | `get, set` |
|
||||||
| [`ClientHistoryInfo`](./sharedlibrarycoredtos-ClientHistoryInfo) | [`ClientHistory`](#clienthistory) | `get, set` |
|
| [`ClientHistoryInfo`](./ClientHistoryInfo.md) | [`ClientHistory`](#clienthistory) | `get, set` |
|
||||||
| `string` | [`ConnectProtocolUrl`](#connectprotocolurl) | `get, set` |
|
| `string` | [`ConnectProtocolUrl`](#connectprotocolurl) | `get, set` |
|
||||||
| `string` | [`Endpoint`](#endpoint) | `get` |
|
| `string` | [`Endpoint`](#endpoint) | `get` |
|
||||||
| `string` | [`ExternalIPAddress`](#externalipaddress) | `get, set` |
|
| `string` | [`ExternalIPAddress`](#externalipaddress) | `get, set` |
|
||||||
@ -31,10 +31,10 @@
|
|||||||
| `int` | [`MaxClients`](#maxclients) | `get, set` |
|
| `int` | [`MaxClients`](#maxclients) | `get, set` |
|
||||||
| `string` | [`Name`](#name) | `get, set` |
|
| `string` | [`Name`](#name) | `get, set` |
|
||||||
| `bool` | [`Online`](#online) | `get, set` |
|
| `bool` | [`Online`](#online) | `get, set` |
|
||||||
| `List`<[`PlayerInfo`](./sharedlibrarycoredtos-PlayerInfo)> | [`Players`](#players) | `get, set` |
|
| `List`<[`PlayerInfo`](./PlayerInfo.md)> | [`Players`](#players) | `get, set` |
|
||||||
| `int` | [`Port`](#port) | `get, set` |
|
| `int` | [`Port`](#port) | `get, set` |
|
||||||
| `int` | [`PrivateClientSlots`](#privateclientslots) | `get, set` |
|
| `int` | [`PrivateClientSlots`](#privateclientslots) | `get, set` |
|
||||||
| `List`<[`Report`](./sharedlibrarycorehelpers-Report)> | [`Reports`](#reports) | `get, set` |
|
| `List`<[`Report`](../helpers/Report.md)> | [`Reports`](#reports) | `get, set` |
|
||||||
|
|
||||||
## Details
|
## Details
|
||||||
### Constructors
|
### Constructors
|
@ -22,6 +22,7 @@
|
|||||||
## Details
|
## Details
|
||||||
### Constructors
|
### Constructors
|
||||||
#### SharedInfo
|
#### SharedInfo
|
||||||
|
[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Dtos/SharedInfo.cs#L6)
|
||||||
```csharp
|
```csharp
|
||||||
public SharedInfo()
|
public SharedInfo()
|
||||||
```
|
```
|
@ -25,7 +25,7 @@ SharedLibraryCore.Dtos.PaginationRequest --> SharedLibraryCore.Dtos.Meta.Request
|
|||||||
### Inheritance
|
### Inheritance
|
||||||
- [
|
- [
|
||||||
`PaginationRequest`
|
`PaginationRequest`
|
||||||
](./sharedlibrarycoredtos-PaginationRequest)
|
](../../PaginationRequest.md)
|
||||||
|
|
||||||
### Constructors
|
### Constructors
|
||||||
#### BaseClientMetaRequest
|
#### BaseClientMetaRequest
|
@ -16,7 +16,7 @@ SharedLibraryCore.Dtos.Meta.Requests.BaseClientMetaRequest --> SharedLibraryCore
|
|||||||
### Inheritance
|
### Inheritance
|
||||||
- [
|
- [
|
||||||
`BaseClientMetaRequest`
|
`BaseClientMetaRequest`
|
||||||
](./sharedlibrarycoredtosmetarequests-BaseClientMetaRequest)
|
](./BaseClientMetaRequest.md)
|
||||||
|
|
||||||
### Constructors
|
### Constructors
|
||||||
#### ReceivedPenaltyRequest
|
#### ReceivedPenaltyRequest
|
@ -16,7 +16,7 @@ SharedLibraryCore.Dtos.Meta.Responses.ReceivedPenaltyResponse --> SharedLibraryC
|
|||||||
### Inheritance
|
### Inheritance
|
||||||
- [
|
- [
|
||||||
`ReceivedPenaltyResponse`
|
`ReceivedPenaltyResponse`
|
||||||
](./sharedlibrarycoredtosmetaresponses-ReceivedPenaltyResponse)
|
](./ReceivedPenaltyResponse.md)
|
||||||
|
|
||||||
### Constructors
|
### Constructors
|
||||||
#### AdministeredPenaltyResponse
|
#### AdministeredPenaltyResponse
|
@ -29,17 +29,17 @@ SharedLibraryCore.Interfaces.IClientMetaResponse --> SharedLibraryCore.Dtos.Meta
|
|||||||
| `long` | [`MetaId`](#metaid) | `get, set` |
|
| `long` | [`MetaId`](#metaid) | `get, set` |
|
||||||
| `Nullable`<`int`> | [`Order`](#order) | `get, set` |
|
| `Nullable`<`int`> | [`Order`](#order) | `get, set` |
|
||||||
| `bool` | [`ShouldDisplay`](#shoulddisplay) | `get, set` |
|
| `bool` | [`ShouldDisplay`](#shoulddisplay) | `get, set` |
|
||||||
| [`MetaType`](./sharedlibrarycoreinterfaces-MetaType) | [`Type`](#type) | `get, set` |
|
| [`MetaType`](../../../interfaces/MetaType.md) | [`Type`](#type) | `get, set` |
|
||||||
| `DateTime` | [`When`](#when) | `get, set` |
|
| `DateTime` | [`When`](#when) | `get, set` |
|
||||||
|
|
||||||
## Details
|
## Details
|
||||||
### Inheritance
|
### Inheritance
|
||||||
- [
|
- [
|
||||||
`IClientMeta`
|
`IClientMeta`
|
||||||
](./sharedlibrarycoreinterfaces-IClientMeta)
|
](../../../interfaces/IClientMeta.md)
|
||||||
- [
|
- [
|
||||||
`IClientMetaResponse`
|
`IClientMetaResponse`
|
||||||
](./sharedlibrarycoreinterfaces-IClientMetaResponse)
|
](../../../interfaces/IClientMetaResponse.md)
|
||||||
|
|
||||||
### Constructors
|
### Constructors
|
||||||
#### BaseMetaResponse
|
#### BaseMetaResponse
|
@ -24,7 +24,7 @@ SharedLibraryCore.Dtos.Meta.Responses.BaseMetaResponse --> SharedLibraryCore.Dto
|
|||||||
### Inheritance
|
### Inheritance
|
||||||
- [
|
- [
|
||||||
`BaseMetaResponse`
|
`BaseMetaResponse`
|
||||||
](./sharedlibrarycoredtosmetaresponses-BaseMetaResponse)
|
](./BaseMetaResponse.md)
|
||||||
|
|
||||||
### Constructors
|
### Constructors
|
||||||
#### ConnectionHistoryResponse
|
#### ConnectionHistoryResponse
|
@ -25,7 +25,7 @@ SharedLibraryCore.Dtos.Meta.Responses.BaseMetaResponse --> SharedLibraryCore.Dto
|
|||||||
### Inheritance
|
### Inheritance
|
||||||
- [
|
- [
|
||||||
`BaseMetaResponse`
|
`BaseMetaResponse`
|
||||||
](./sharedlibrarycoredtosmetaresponses-BaseMetaResponse)
|
](./BaseMetaResponse.md)
|
||||||
|
|
||||||
### Constructors
|
### Constructors
|
||||||
#### InformationResponse
|
#### InformationResponse
|
@ -31,7 +31,7 @@ SharedLibraryCore.Dtos.Meta.Responses.BaseMetaResponse --> SharedLibraryCore.Dto
|
|||||||
### Inheritance
|
### Inheritance
|
||||||
- [
|
- [
|
||||||
`BaseMetaResponse`
|
`BaseMetaResponse`
|
||||||
](./sharedlibrarycoredtosmetaresponses-BaseMetaResponse)
|
](./BaseMetaResponse.md)
|
||||||
|
|
||||||
### Constructors
|
### Constructors
|
||||||
#### MessageResponse
|
#### MessageResponse
|
@ -28,7 +28,7 @@ SharedLibraryCore.Dtos.Meta.Responses.BaseMetaResponse --> SharedLibraryCore.Dto
|
|||||||
### Inheritance
|
### Inheritance
|
||||||
- [
|
- [
|
||||||
`BaseMetaResponse`
|
`BaseMetaResponse`
|
||||||
](./sharedlibrarycoredtosmetaresponses-BaseMetaResponse)
|
](./BaseMetaResponse.md)
|
||||||
|
|
||||||
### Constructors
|
### Constructors
|
||||||
#### PermissionLevelChangedResponse
|
#### PermissionLevelChangedResponse
|
@ -35,7 +35,7 @@ SharedLibraryCore.Dtos.Meta.Responses.BaseMetaResponse --> SharedLibraryCore.Dto
|
|||||||
### Inheritance
|
### Inheritance
|
||||||
- [
|
- [
|
||||||
`BaseMetaResponse`
|
`BaseMetaResponse`
|
||||||
](./sharedlibrarycoredtosmetaresponses-BaseMetaResponse)
|
](./BaseMetaResponse.md)
|
||||||
|
|
||||||
### Constructors
|
### Constructors
|
||||||
#### ReceivedPenaltyResponse
|
#### ReceivedPenaltyResponse
|
@ -31,16 +31,18 @@ SharedLibraryCore.Dtos.Meta.Responses.BaseMetaResponse --> SharedLibraryCore.Dto
|
|||||||
### Inheritance
|
### Inheritance
|
||||||
- [
|
- [
|
||||||
`BaseMetaResponse`
|
`BaseMetaResponse`
|
||||||
](./sharedlibrarycoredtosmetaresponses-BaseMetaResponse)
|
](./BaseMetaResponse.md)
|
||||||
|
|
||||||
### Constructors
|
### Constructors
|
||||||
#### UpdatedAliasResponse
|
#### UpdatedAliasResponse
|
||||||
|
[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Dtos/Meta/Responses/UpdatedAliasResponse.cs#L6)
|
||||||
```csharp
|
```csharp
|
||||||
public UpdatedAliasResponse()
|
public UpdatedAliasResponse()
|
||||||
```
|
```
|
||||||
|
|
||||||
### Methods
|
### Methods
|
||||||
#### Equals
|
#### Equals
|
||||||
|
[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Dtos/Meta/Responses/UpdatedAliasResponse.cs#L9)
|
||||||
```csharp
|
```csharp
|
||||||
public override bool Equals(object obj)
|
public override bool Equals(object obj)
|
||||||
```
|
```
|
||||||
@ -50,6 +52,7 @@ public override bool Equals(object obj)
|
|||||||
| `object` | obj | |
|
| `object` | obj | |
|
||||||
|
|
||||||
#### GetHashCode
|
#### GetHashCode
|
||||||
|
[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Dtos/Meta/Responses/UpdatedAliasResponse.cs#L19)
|
||||||
```csharp
|
```csharp
|
||||||
public override int GetHashCode()
|
public override int GetHashCode()
|
||||||
```
|
```
|
Some files were not shown because too many files have changed in this diff Show More
Loading…
x
Reference in New Issue
Block a user