From 20ed2571c42fac67631a14a6a889f019dd4f806f Mon Sep 17 00:00:00 2001 From: RaidMax Date: Sat, 20 May 2023 21:15:15 -0500 Subject: [PATCH] Add folder structure for documentation --- ...re-BaseController.md => BaseController.md} | 11 +- ...dlibrarycore-ColorCode.md => ColorCode.md} | 4 +- ...haredlibrarycore-Command.md => Command.md} | 13 +- .../{sharedlibrarycore-DvarT.md => DvarT.md} | 0 ...dlibrarycore-GameEvent.md => GameEvent.md} | 9 +- ...redlibrarycore-Gametype.md => Gametype.md} | 0 .../{sharedlibrarycore-Map.md => Map.md} | 1 + ...{sharedlibrarycore-Server.md => Server.md} | 125 ++++++++------- ...dlibrarycore-Utilities.md => Utilities.md} | 144 +++++++++++++----- .../Alert.md} | 0 .../alert/AlertCategory.md} | 0 .../alert/AlertState.md} | 2 + .../BanCommand.md} | 13 +- .../CommandArgument.md} | 0 .../CommandExtensions.md} | 10 +- .../CommandProcessing.md} | 8 +- .../ExecuteRConCommand.md} | 11 +- .../FastRestartCommand.md} | 11 +- .../FlagClientCommand.md} | 11 +- .../GetClientPingCommand.md} | 12 +- .../KickCommand.md} | 13 +- .../ListBanInfoCommand.md} | 11 +- .../ListExternalIPCommand.md} | 12 +- .../ListRulesCommands.md} | 11 +- .../LoadMapCommand.md} | 11 +- .../MapRotateCommand.md} | 11 +- .../MaskCommand.md} | 11 +- .../MemoryUsageCommand.md} | 12 +- .../NextMapCommand.md} | 17 ++- .../OwnerCommand.md} | 11 +- .../PrivateMessageAdminsCommand.md} | 12 +- .../PruneAdminsCommand.md} | 11 +- .../QuitCommand.md} | 11 +- .../RequestTokenCommand.md} | 12 +- .../RestartCommand.md} | 11 +- .../RunAsCommand.md} | 11 +- .../SetGravatarCommand.md} | 13 +- .../SetLevelCommand.md} | 13 +- .../SetPasswordCommand.md} | 11 +- .../TempBanCommand.md} | 13 +- .../UnbanCommand.md} | 11 +- .../UnflagClientCommand.md} | 11 +- .../UnlinkClientCommand.md} | 11 +- .../UptimeCommand.md} | 12 +- .../WarnClearCommand.md} | 12 +- .../WarnCommand.md} | 14 +- .../ApplicationConfiguration.md} | 17 ++- .../CommandConfiguration.md} | 9 +- .../CommandProperties.md} | 1 + .../CommunityInformationConfiguration.md} | 3 +- .../DefaultSettings.md} | 14 +- .../GameStringConfiguration.md} | 1 + .../GametypeConfiguration.md} | 2 +- .../MapConfiguration.md} | 2 +- .../QuickMessageConfiguration.md} | 0 .../ServerConfiguration.md} | 18 ++- .../SocialAccountConfiguration.md} | 0 .../WebfrontConfiguration.md} | 0 .../attributes/ConfigurationIgnore.md} | 0 .../attributes/ConfigurationLinked.md} | 1 + .../attributes/ConfigurationOptional.md} | 0 .../attributes/LocalizedDisplayName.md} | 1 + .../extensions/ConfigurationExtensions.md} | 10 +- .../ApplicationConfigurationValidator.md} | 3 +- .../ServerConfigurationValidator.md} | 3 +- .../models/EFClient.md} | 69 ++++++--- .../models/efclient/ClientState.md} | 0 .../models/efclient/TeamType.md} | 0 .../AuditInfo.md} | 0 .../ChatInfo.md} | 0 .../ClientCountSnapshot.md} | 0 .../ClientHistoryInfo.md} | 3 +- .../ClientInfo.md} | 0 .../CommandResponseInfo.md} | 0 .../EntityInfo.md} | 0 .../ErrorResponse.md} | 0 .../EventInfo.md} | 11 +- .../FindClientRequest.md} | 3 +- .../FindClientResult.md} | 0 .../IW4MAdminInfo.md} | 0 .../LookupValueT.md} | 2 +- .../Page.md} | 0 .../PaginationRequest.md} | 3 +- .../PenaltyInfo.md} | 2 +- .../PlayerInfo.md} | 10 +- .../ServerInfo.md} | 8 +- .../SharedInfo.md} | 1 + .../SortDirection.md} | 0 .../meta/WebfrontTranslationHelper.md} | 0 .../meta/requests/BaseClientMetaRequest.md} | 2 +- .../meta/requests/ReceivedPenaltyRequest.md} | 2 +- .../responses/AdministeredPenaltyResponse.md} | 2 +- .../meta/responses/BaseMetaResponse.md} | 6 +- .../meta/responses/ClientNoteMetaResponse.md} | 0 .../responses/ConnectionHistoryResponse.md} | 2 +- .../meta/responses/InformationResponse.md} | 2 +- .../meta/responses/MessageResponse.md} | 2 +- .../PermissionLevelChangedResponse.md} | 2 +- .../responses/ReceivedPenaltyResponse.md} | 2 +- .../meta/responses/UpdatedAliasResponse.md} | 5 +- .../CoreEvent.md} | 1 + .../EventExtensions.md} | 1 + .../GameEventArgs.md} | 5 +- .../game/ClientCommandEvent.md} | 2 +- .../game/ClientDamageEvent.md} | 11 +- .../game/ClientEnterMatchEvent.md} | 2 +- .../game/ClientExitMatchEvent.md} | 2 +- .../game/ClientGameEvent.md} | 4 +- .../game/ClientJoinTeamEvent.md} | 2 +- .../game/ClientKillEvent.md} | 2 +- .../game/ClientMessageEvent.md} | 2 +- .../game/GameEventV2.md} | 4 +- .../game/GameScriptEvent.md} | 2 +- .../game/MatchEndEvent.md} | 2 +- .../game/MatchStartEvent.md} | 3 +- .../zombie/PlayerConsumedPerkGameEvent.md} | 2 +- .../zombie/PlayerDamageGameEvent.md} | 2 +- .../zombie/PlayerDownedGameEvent.md} | 2 +- .../zombie/PlayerGrabbedPowerupGameEvent.md} | 2 +- .../zombie/PlayerKilledGameEvent.md} | 3 +- .../zombie/PlayerRevivedGameEvent.md} | 2 +- .../zombie/PlayerRoundDataGameEvent.md} | 2 +- .../zombie/RoundCompleteGameEvent.md} | 2 +- .../zombie/ZombieDamageGameEvent.md} | 2 +- .../zombie/ZombieKilledGameEvent.md} | 3 +- .../management/ClientExecuteCommandEvent.md} | 4 +- .../management/ClientPenaltyEvent.md} | 2 +- .../management/ClientPenaltyRevokeEvent.md} | 2 +- .../ClientPermissionChangeEvent.md} | 2 +- .../ClientPersistentIdReceiveEvent.md} | 5 +- .../management/ClientStateAuthorizeEvent.md} | 2 +- .../management/ClientStateDisposeEvent.md} | 2 +- .../management/ClientStateEvent.md} | 4 +- .../management/ClientStateInitializeEvent.md} | 2 +- .../management/LoginEvent.md} | 2 +- .../management/LogoutEvent.md} | 2 +- .../management/ManagementEvent.md} | 2 +- .../management/loginevent/LoginSourceType.md} | 0 .../server/ClientDataUpdateEvent.md} | 4 +- .../server/ConnectionInterruptEvent.md} | 2 +- .../server/ConnectionRestoreEvent.md} | 2 +- .../server/GameServerEvent.md} | 4 +- .../server/MonitorStartEvent.md} | 2 +- .../server/MonitorStopEvent.md} | 2 +- .../server/ServerCommandExecuteEvent.md} | 2 +- .../ServerCommandRequestExecuteEvent.md} | 5 +- .../server/ServerValueReceiveEvent.md} | 4 +- .../server/ServerValueRequestEvent.md} | 5 +- .../server/ServerValueSetCompleteEvent.md} | 2 +- .../server/ServerValueSetRequestEvent.md} | 5 +- .../AuthorizationException.md} | 1 + .../CommandException.md} | 3 +- .../ConfigurationException.md} | 1 + .../DatabaseException.md} | 1 + .../DvarException.md} | 3 +- .../NetworkException.md} | 4 +- .../PluginException.md} | 1 + .../RConException.md} | 2 + .../SerializeException.md} | 1 + .../ServerException.md} | 1 + .../ColorCodeMapping.md} | 0 .../ColorCodes.md} | 0 .../EventFailReason.md} | 0 .../EventRequiredEntity.md} | 0 .../EventSource.md} | 0 .../EventType.md} | 0 .../BuildNumber.md} | 26 ++-- .../BuildNumberJsonConverter.md} | 3 + .../ChangeTrackingT.md} | 3 + .../Hashing.md} | 1 + .../InteractionData.md} | 5 +- .../MessageToken.md} | 7 +- .../ParseEnumT.md} | 1 + .../Report.md} | 4 +- .../ResourceQueryHelperResultT.md} | 0 .../TokenIdentifier.md} | 2 +- .../TokenState.md} | 1 + .../IAlertManager.md} | 4 +- .../IAuditFields.md} | 0 .../IAuditInformationRepository.md} | 4 +- .../IBaseConfiguration.md} | 2 +- .../IBasePathProvider.md} | 0 .../IClientMeta.md} | 2 +- .../IClientMetaResponse.md} | 0 .../IClientNoticeMessageFormatter.md} | 4 +- .../IConfigurationHandlerFactory.md} | 4 +- .../IConfigurationHandlerT.md} | 0 .../IConfigurationHandlerV2T.md} | 0 .../ICoreEventHandler.md} | 6 +- .../IEntityServiceT.md} | 0 .../IEventParser.md} | 8 +- .../IEventParserConfiguration.md} | 20 +-- .../IGameLogReader.md} | 4 +- .../IGameLogReaderFactory.md} | 4 +- .../IGameServer.md} | 10 +- .../IGameServerInstanceFactory.md} | 6 +- .../IGeoLocationResult.md} | 0 .../IGeoLocationService.md} | 2 +- .../IInteractionData.md} | 2 +- .../IInteractionRegistration.md} | 6 +- .../ILogger.md} | 0 .../ILookupValueT.md} | 0 .../IManager.md} | 62 ++++---- .../IManagerCommand.md} | 4 +- .../IMasterCommunication.md} | 0 .../IMatchResult.md} | 0 .../IMetaRegistration.md} | 0 .../IMetaService.md} | 18 +-- .../IMetaServiceV2.md} | 12 +- .../IMiddlewareActionHandler.md} | 4 +- .../IMiddlewareActionT.md} | 0 .../IModelConfiguration.md} | 0 .../IModularAssembly.md} | 0 .../IPageList.md} | 0 .../IParserPatternMatcher.md} | 2 +- .../IParserRegexFactory.md} | 2 +- .../IPlugin.md} | 14 +- .../IPluginImporter.md} | 0 .../IPluginV2.md} | 3 +- .../IRConConnection.md} | 4 +- .../IRConConnectionFactory.md} | 2 +- .../IRConParser.md} | 20 +-- .../IRConParserConfiguration.md} | 18 +-- .../IRegisterEvent.md} | 2 +- .../IRemoteAssemblyHandler.md} | 0 .../IRemoteCommandService.md} | 8 +- .../IResourceQueryHelperTT.md} | 2 +- .../IScriptCommandFactory.md} | 6 +- .../IScriptPluginFactory.md} | 0 .../IScriptPluginServiceResolver.md} | 0 .../IScriptPluginTimerHelper.md} | 0 .../IServerDataCollector.md} | 0 .../IServerDataViewer.md} | 2 +- .../IStatusResponse.md} | 2 +- .../ITokenAuthentication.md} | 8 +- .../ITokenIdentifier.md} | 0 .../ITranslationLookup.md} | 0 .../InteractionType.md} | 0 .../MetaType.md} | 0 .../ParserRegex.md} | 6 +- .../events/IGameEventSubscriptions.md} | 26 ++-- .../events/IGameServerEventSubscriptions.md} | 26 ++-- .../events/IManagementEventSubscriptions.md} | 40 ++--- .../parserregex/GroupType.md} | 0 .../ClientPermission.md} | 0 .../Layout.md} | 3 +- .../TranslationLookup.md} | 2 +- .../SharedLibraryCore/modulardoc.mconf | 1 + .../ClientPaginationRequest.md} | 2 +- .../CommandPrefix.md} | 0 .../StaticHelpers.md} | 1 + .../statichelpers/QueryType.md} | 0 .../AuditInformationRepository.md} | 7 +- .../Game.md} | 0 .../ChangeHistoryService.md} | 7 +- .../ClientService.md} | 59 +++---- .../PenaltyService.md} | 11 +- 257 files changed, 924 insertions(+), 676 deletions(-) rename CodeDocumentation/SharedLibraryCore/{sharedlibrarycore-BaseController.md => BaseController.md} (79%) rename CodeDocumentation/SharedLibraryCore/{sharedlibrarycore-ColorCode.md => ColorCode.md} (80%) rename CodeDocumentation/SharedLibraryCore/{sharedlibrarycore-Command.md => Command.md} (86%) rename CodeDocumentation/SharedLibraryCore/{sharedlibrarycore-DvarT.md => DvarT.md} (100%) rename CodeDocumentation/SharedLibraryCore/{sharedlibrarycore-GameEvent.md => GameEvent.md} (86%) rename CodeDocumentation/SharedLibraryCore/{sharedlibrarycore-Gametype.md => Gametype.md} (100%) rename CodeDocumentation/SharedLibraryCore/{sharedlibrarycore-Map.md => Map.md} (89%) rename CodeDocumentation/SharedLibraryCore/{sharedlibrarycore-Server.md => Server.md} (68%) rename CodeDocumentation/SharedLibraryCore/{sharedlibrarycore-Utilities.md => Utilities.md} (73%) rename CodeDocumentation/SharedLibraryCore/{sharedlibrarycorealerts-Alert.md => alerts/Alert.md} (100%) rename CodeDocumentation/SharedLibraryCore/{sharedlibrarycorealertsalert-AlertCategory.md => alerts/alert/AlertCategory.md} (100%) rename CodeDocumentation/SharedLibraryCore/{sharedlibrarycorealertsalert-AlertState.md => alerts/alert/AlertState.md} (91%) rename CodeDocumentation/SharedLibraryCore/{sharedlibrarycorecommands-BanCommand.md => commands/BanCommand.md} (67%) rename CodeDocumentation/SharedLibraryCore/{sharedlibrarycorecommands-CommandArgument.md => commands/CommandArgument.md} (100%) rename CodeDocumentation/SharedLibraryCore/{sharedlibrarycorecommands-CommandExtensions.md => commands/CommandExtensions.md} (68%) rename CodeDocumentation/SharedLibraryCore/{sharedlibrarycorecommands-CommandProcessing.md => commands/CommandProcessing.md} (55%) rename CodeDocumentation/SharedLibraryCore/{sharedlibrarycorecommands-ExecuteRConCommand.md => commands/ExecuteRConCommand.md} (72%) rename CodeDocumentation/SharedLibraryCore/{sharedlibrarycorecommands-FastRestartCommand.md => commands/FastRestartCommand.md} (72%) rename CodeDocumentation/SharedLibraryCore/{sharedlibrarycorecommands-FlagClientCommand.md => commands/FlagClientCommand.md} (72%) rename CodeDocumentation/SharedLibraryCore/{sharedlibrarycorecommands-GetClientPingCommand.md => commands/GetClientPingCommand.md} (67%) rename CodeDocumentation/SharedLibraryCore/{sharedlibrarycorecommands-KickCommand.md => commands/KickCommand.md} (67%) rename CodeDocumentation/SharedLibraryCore/{sharedlibrarycorecommands-ListBanInfoCommand.md => commands/ListBanInfoCommand.md} (72%) rename CodeDocumentation/SharedLibraryCore/{sharedlibrarycorecommands-ListExternalIPCommand.md => commands/ListExternalIPCommand.md} (67%) rename CodeDocumentation/SharedLibraryCore/{sharedlibrarycorecommands-ListRulesCommands.md => commands/ListRulesCommands.md} (71%) rename CodeDocumentation/SharedLibraryCore/{sharedlibrarycorecommands-LoadMapCommand.md => commands/LoadMapCommand.md} (72%) rename CodeDocumentation/SharedLibraryCore/{sharedlibrarycorecommands-MapRotateCommand.md => commands/MapRotateCommand.md} (72%) rename CodeDocumentation/SharedLibraryCore/{sharedlibrarycorecommands-MaskCommand.md => commands/MaskCommand.md} (72%) rename CodeDocumentation/SharedLibraryCore/{sharedlibrarycorecommands-MemoryUsageCommand.md => commands/MemoryUsageCommand.md} (67%) rename CodeDocumentation/SharedLibraryCore/{sharedlibrarycorecommands-NextMapCommand.md => commands/NextMapCommand.md} (69%) rename CodeDocumentation/SharedLibraryCore/{sharedlibrarycorecommands-OwnerCommand.md => commands/OwnerCommand.md} (72%) rename CodeDocumentation/SharedLibraryCore/{sharedlibrarycorecommands-PrivateMessageAdminsCommand.md => commands/PrivateMessageAdminsCommand.md} (65%) rename CodeDocumentation/SharedLibraryCore/{sharedlibrarycorecommands-PruneAdminsCommand.md => commands/PruneAdminsCommand.md} (74%) rename CodeDocumentation/SharedLibraryCore/{sharedlibrarycorecommands-QuitCommand.md => commands/QuitCommand.md} (71%) rename CodeDocumentation/SharedLibraryCore/{sharedlibrarycorecommands-RequestTokenCommand.md => commands/RequestTokenCommand.md} (67%) rename CodeDocumentation/SharedLibraryCore/{sharedlibrarycorecommands-RestartCommand.md => commands/RestartCommand.md} (71%) rename CodeDocumentation/SharedLibraryCore/{sharedlibrarycorecommands-RunAsCommand.md => commands/RunAsCommand.md} (70%) rename CodeDocumentation/SharedLibraryCore/{sharedlibrarycorecommands-SetGravatarCommand.md => commands/SetGravatarCommand.md} (70%) rename CodeDocumentation/SharedLibraryCore/{sharedlibrarycorecommands-SetLevelCommand.md => commands/SetLevelCommand.md} (68%) rename CodeDocumentation/SharedLibraryCore/{sharedlibrarycorecommands-SetPasswordCommand.md => commands/SetPasswordCommand.md} (72%) rename CodeDocumentation/SharedLibraryCore/{sharedlibrarycorecommands-TempBanCommand.md => commands/TempBanCommand.md} (68%) rename CodeDocumentation/SharedLibraryCore/{sharedlibrarycorecommands-UnbanCommand.md => commands/UnbanCommand.md} (71%) rename CodeDocumentation/SharedLibraryCore/{sharedlibrarycorecommands-UnflagClientCommand.md => commands/UnflagClientCommand.md} (73%) rename CodeDocumentation/SharedLibraryCore/{sharedlibrarycorecommands-UnlinkClientCommand.md => commands/UnlinkClientCommand.md} (81%) rename CodeDocumentation/SharedLibraryCore/{sharedlibrarycorecommands-UptimeCommand.md => commands/UptimeCommand.md} (67%) rename CodeDocumentation/SharedLibraryCore/{sharedlibrarycorecommands-WarnClearCommand.md => commands/WarnClearCommand.md} (67%) rename CodeDocumentation/SharedLibraryCore/{sharedlibrarycorecommands-WarnCommand.md => commands/WarnCommand.md} (63%) rename CodeDocumentation/SharedLibraryCore/{sharedlibrarycoreconfiguration-ApplicationConfiguration.md => configuration/ApplicationConfiguration.md} (90%) rename CodeDocumentation/SharedLibraryCore/{sharedlibrarycoreconfiguration-CommandConfiguration.md => configuration/CommandConfiguration.md} (73%) rename CodeDocumentation/SharedLibraryCore/{sharedlibrarycoreconfiguration-CommandProperties.md => configuration/CommandProperties.md} (93%) rename CodeDocumentation/SharedLibraryCore/{sharedlibrarycoreconfiguration-CommunityInformationConfiguration.md => configuration/CommunityInformationConfiguration.md} (82%) rename CodeDocumentation/SharedLibraryCore/{sharedlibrarycoreconfiguration-DefaultSettings.md => configuration/DefaultSettings.md} (70%) rename CodeDocumentation/SharedLibraryCore/{sharedlibrarycoreconfiguration-GameStringConfiguration.md => configuration/GameStringConfiguration.md} (89%) rename CodeDocumentation/SharedLibraryCore/{sharedlibrarycoreconfiguration-GametypeConfiguration.md => configuration/GametypeConfiguration.md} (89%) rename CodeDocumentation/SharedLibraryCore/{sharedlibrarycoreconfiguration-MapConfiguration.md => configuration/MapConfiguration.md} (90%) rename CodeDocumentation/SharedLibraryCore/{sharedlibrarycoreconfiguration-QuickMessageConfiguration.md => configuration/QuickMessageConfiguration.md} (100%) rename CodeDocumentation/SharedLibraryCore/{sharedlibrarycoreconfiguration-ServerConfiguration.md => configuration/ServerConfiguration.md} (73%) rename CodeDocumentation/SharedLibraryCore/{sharedlibrarycoreconfiguration-SocialAccountConfiguration.md => configuration/SocialAccountConfiguration.md} (100%) rename CodeDocumentation/SharedLibraryCore/{sharedlibrarycoreconfiguration-WebfrontConfiguration.md => configuration/WebfrontConfiguration.md} (100%) rename CodeDocumentation/SharedLibraryCore/{sharedlibrarycoreconfigurationattributes-ConfigurationIgnore.md => configuration/attributes/ConfigurationIgnore.md} (100%) rename CodeDocumentation/SharedLibraryCore/{sharedlibrarycoreconfigurationattributes-ConfigurationLinked.md => configuration/attributes/ConfigurationLinked.md} (88%) rename CodeDocumentation/SharedLibraryCore/{sharedlibrarycoreconfigurationattributes-ConfigurationOptional.md => configuration/attributes/ConfigurationOptional.md} (100%) rename CodeDocumentation/SharedLibraryCore/{sharedlibrarycoreconfigurationattributes-LocalizedDisplayName.md => configuration/attributes/LocalizedDisplayName.md} (88%) rename CodeDocumentation/SharedLibraryCore/{sharedlibrarycoreconfigurationextensions-ConfigurationExtensions.md => configuration/extensions/ConfigurationExtensions.md} (64%) rename CodeDocumentation/SharedLibraryCore/{sharedlibrarycoreconfigurationvalidation-ApplicationConfigurationValidator.md => configuration/validation/ApplicationConfigurationValidator.md} (78%) rename CodeDocumentation/SharedLibraryCore/{sharedlibrarycoreconfigurationvalidation-ServerConfigurationValidator.md => configuration/validation/ServerConfigurationValidator.md} (78%) rename CodeDocumentation/SharedLibraryCore/{sharedlibrarycoredatabasemodels-EFClient.md => database/models/EFClient.md} (62%) rename CodeDocumentation/SharedLibraryCore/{sharedlibrarycoredatabasemodelsefclient-ClientState.md => database/models/efclient/ClientState.md} (100%) rename CodeDocumentation/SharedLibraryCore/{sharedlibrarycoredatabasemodelsefclient-TeamType.md => database/models/efclient/TeamType.md} (100%) rename CodeDocumentation/SharedLibraryCore/{sharedlibrarycoredtos-AuditInfo.md => dtos/AuditInfo.md} (100%) rename CodeDocumentation/SharedLibraryCore/{sharedlibrarycoredtos-ChatInfo.md => dtos/ChatInfo.md} (100%) rename CodeDocumentation/SharedLibraryCore/{sharedlibrarycoredtos-ClientCountSnapshot.md => dtos/ClientCountSnapshot.md} (100%) rename CodeDocumentation/SharedLibraryCore/{sharedlibrarycoredtos-ClientHistoryInfo.md => dtos/ClientHistoryInfo.md} (76%) rename CodeDocumentation/SharedLibraryCore/{sharedlibrarycoredtos-ClientInfo.md => dtos/ClientInfo.md} (100%) rename CodeDocumentation/SharedLibraryCore/{sharedlibrarycoredtos-CommandResponseInfo.md => dtos/CommandResponseInfo.md} (100%) rename CodeDocumentation/SharedLibraryCore/{sharedlibrarycoredtos-EntityInfo.md => dtos/EntityInfo.md} (100%) rename CodeDocumentation/SharedLibraryCore/{sharedlibrarycoredtos-ErrorResponse.md => dtos/ErrorResponse.md} (100%) rename CodeDocumentation/SharedLibraryCore/{sharedlibrarycoredtos-EventInfo.md => dtos/EventInfo.md} (73%) rename CodeDocumentation/SharedLibraryCore/{sharedlibrarycoredtos-FindClientRequest.md => dtos/FindClientRequest.md} (89%) rename CodeDocumentation/SharedLibraryCore/{sharedlibrarycoredtos-FindClientResult.md => dtos/FindClientResult.md} (100%) rename CodeDocumentation/SharedLibraryCore/{sharedlibrarycoredtos-IW4MAdminInfo.md => dtos/IW4MAdminInfo.md} (100%) rename CodeDocumentation/SharedLibraryCore/{sharedlibrarycoredtos-LookupValueT.md => dtos/LookupValueT.md} (92%) rename CodeDocumentation/SharedLibraryCore/{sharedlibrarycoredtos-Page.md => dtos/Page.md} (100%) rename CodeDocumentation/SharedLibraryCore/{sharedlibrarycoredtos-PaginationRequest.md => dtos/PaginationRequest.md} (87%) rename CodeDocumentation/SharedLibraryCore/{sharedlibrarycoredtos-PenaltyInfo.md => dtos/PenaltyInfo.md} (99%) rename CodeDocumentation/SharedLibraryCore/{sharedlibrarycoredtos-PlayerInfo.md => dtos/PlayerInfo.md} (85%) rename CodeDocumentation/SharedLibraryCore/{sharedlibrarycoredtos-ServerInfo.md => dtos/ServerInfo.md} (86%) rename CodeDocumentation/SharedLibraryCore/{sharedlibrarycoredtos-SharedInfo.md => dtos/SharedInfo.md} (88%) rename CodeDocumentation/SharedLibraryCore/{sharedlibrarycoredtos-SortDirection.md => dtos/SortDirection.md} (100%) rename CodeDocumentation/SharedLibraryCore/{sharedlibrarycoredtosmeta-WebfrontTranslationHelper.md => dtos/meta/WebfrontTranslationHelper.md} (100%) rename CodeDocumentation/SharedLibraryCore/{sharedlibrarycoredtosmetarequests-BaseClientMetaRequest.md => dtos/meta/requests/BaseClientMetaRequest.md} (95%) rename CodeDocumentation/SharedLibraryCore/{sharedlibrarycoredtosmetarequests-ReceivedPenaltyRequest.md => dtos/meta/requests/ReceivedPenaltyRequest.md} (92%) rename CodeDocumentation/SharedLibraryCore/{sharedlibrarycoredtosmetaresponses-AdministeredPenaltyResponse.md => dtos/meta/responses/AdministeredPenaltyResponse.md} (92%) rename CodeDocumentation/SharedLibraryCore/{sharedlibrarycoredtosmetaresponses-BaseMetaResponse.md => dtos/meta/responses/BaseMetaResponse.md} (91%) rename CodeDocumentation/SharedLibraryCore/{sharedlibrarycoredtosmetaresponses-ClientNoteMetaResponse.md => dtos/meta/responses/ClientNoteMetaResponse.md} (100%) rename CodeDocumentation/SharedLibraryCore/{sharedlibrarycoredtosmetaresponses-ConnectionHistoryResponse.md => dtos/meta/responses/ConnectionHistoryResponse.md} (95%) rename CodeDocumentation/SharedLibraryCore/{sharedlibrarycoredtosmetaresponses-InformationResponse.md => dtos/meta/responses/InformationResponse.md} (95%) rename CodeDocumentation/SharedLibraryCore/{sharedlibrarycoredtosmetaresponses-MessageResponse.md => dtos/meta/responses/MessageResponse.md} (97%) rename CodeDocumentation/SharedLibraryCore/{sharedlibrarycoredtosmetaresponses-PermissionLevelChangedResponse.md => dtos/meta/responses/PermissionLevelChangedResponse.md} (97%) rename CodeDocumentation/SharedLibraryCore/{sharedlibrarycoredtosmetaresponses-ReceivedPenaltyResponse.md => dtos/meta/responses/ReceivedPenaltyResponse.md} (97%) rename CodeDocumentation/SharedLibraryCore/{sharedlibrarycoredtosmetaresponses-UpdatedAliasResponse.md => dtos/meta/responses/UpdatedAliasResponse.md} (76%) rename CodeDocumentation/SharedLibraryCore/{sharedlibrarycoreevents-CoreEvent.md => events/CoreEvent.md} (91%) rename CodeDocumentation/SharedLibraryCore/{sharedlibrarycoreevents-EventExtensions.md => events/EventExtensions.md} (89%) rename CodeDocumentation/SharedLibraryCore/{sharedlibrarycoreevents-GameEventArgs.md => events/GameEventArgs.md} (81%) rename CodeDocumentation/SharedLibraryCore/{sharedlibrarycoreeventsgame-ClientCommandEvent.md => events/game/ClientCommandEvent.md} (92%) rename CodeDocumentation/SharedLibraryCore/{sharedlibrarycoreeventsgame-ClientDamageEvent.md => events/game/ClientDamageEvent.md} (85%) rename CodeDocumentation/SharedLibraryCore/{sharedlibrarycoreeventsgame-ClientEnterMatchEvent.md => events/game/ClientEnterMatchEvent.md} (93%) rename CodeDocumentation/SharedLibraryCore/{sharedlibrarycoreeventsgame-ClientExitMatchEvent.md => events/game/ClientExitMatchEvent.md} (93%) rename CodeDocumentation/SharedLibraryCore/{sharedlibrarycoreeventsgame-ClientGameEvent.md => events/game/ClientGameEvent.md} (90%) rename CodeDocumentation/SharedLibraryCore/{sharedlibrarycoreeventsgame-ClientJoinTeamEvent.md => events/game/ClientJoinTeamEvent.md} (95%) rename CodeDocumentation/SharedLibraryCore/{sharedlibrarycoreeventsgame-ClientKillEvent.md => events/game/ClientKillEvent.md} (92%) rename CodeDocumentation/SharedLibraryCore/{sharedlibrarycoreeventsgame-ClientMessageEvent.md => events/game/ClientMessageEvent.md} (95%) rename CodeDocumentation/SharedLibraryCore/{sharedlibrarycoreeventsgame-GameEventV2.md => events/game/GameEventV2.md} (87%) rename CodeDocumentation/SharedLibraryCore/{sharedlibrarycoreeventsgame-GameScriptEvent.md => events/game/GameScriptEvent.md} (95%) rename CodeDocumentation/SharedLibraryCore/{sharedlibrarycoreeventsgame-MatchEndEvent.md => events/game/MatchEndEvent.md} (95%) rename CodeDocumentation/SharedLibraryCore/{sharedlibrarycoreeventsgame-MatchStartEvent.md => events/game/MatchStartEvent.md} (87%) rename CodeDocumentation/SharedLibraryCore/{sharedlibrarycoreeventsgamegamescriptzombie-PlayerConsumedPerkGameEvent.md => events/game/gamescript/zombie/PlayerConsumedPerkGameEvent.md} (96%) rename CodeDocumentation/SharedLibraryCore/{sharedlibrarycoreeventsgamegamescriptzombie-PlayerDamageGameEvent.md => events/game/gamescript/zombie/PlayerDamageGameEvent.md} (93%) rename CodeDocumentation/SharedLibraryCore/{sharedlibrarycoreeventsgamegamescriptzombie-PlayerDownedGameEvent.md => events/game/gamescript/zombie/PlayerDownedGameEvent.md} (94%) rename CodeDocumentation/SharedLibraryCore/{sharedlibrarycoreeventsgamegamescriptzombie-PlayerGrabbedPowerupGameEvent.md => events/game/gamescript/zombie/PlayerGrabbedPowerupGameEvent.md} (96%) rename CodeDocumentation/SharedLibraryCore/{sharedlibrarycoreeventsgamegamescriptzombie-PlayerKilledGameEvent.md => events/game/gamescript/zombie/PlayerKilledGameEvent.md} (81%) rename CodeDocumentation/SharedLibraryCore/{sharedlibrarycoreeventsgamegamescriptzombie-PlayerRevivedGameEvent.md => events/game/gamescript/zombie/PlayerRevivedGameEvent.md} (96%) rename CodeDocumentation/SharedLibraryCore/{sharedlibrarycoreeventsgamegamescriptzombie-PlayerRoundDataGameEvent.md => events/game/gamescript/zombie/PlayerRoundDataGameEvent.md} (96%) rename CodeDocumentation/SharedLibraryCore/{sharedlibrarycoreeventsgamegamescriptzombie-RoundCompleteGameEvent.md => events/game/gamescript/zombie/RoundCompleteGameEvent.md} (95%) rename CodeDocumentation/SharedLibraryCore/{sharedlibrarycoreeventsgamegamescriptzombie-ZombieDamageGameEvent.md => events/game/gamescript/zombie/ZombieDamageGameEvent.md} (93%) rename CodeDocumentation/SharedLibraryCore/{sharedlibrarycoreeventsgamegamescriptzombie-ZombieKilledGameEvent.md => events/game/gamescript/zombie/ZombieKilledGameEvent.md} (81%) rename CodeDocumentation/SharedLibraryCore/{sharedlibrarycoreeventsmanagement-ClientExecuteCommandEvent.md => events/management/ClientExecuteCommandEvent.md} (87%) rename CodeDocumentation/SharedLibraryCore/{sharedlibrarycoreeventsmanagement-ClientPenaltyEvent.md => events/management/ClientPenaltyEvent.md} (95%) rename CodeDocumentation/SharedLibraryCore/{sharedlibrarycoreeventsmanagement-ClientPenaltyRevokeEvent.md => events/management/ClientPenaltyRevokeEvent.md} (92%) rename CodeDocumentation/SharedLibraryCore/{sharedlibrarycoreeventsmanagement-ClientPermissionChangeEvent.md => events/management/ClientPermissionChangeEvent.md} (95%) rename CodeDocumentation/SharedLibraryCore/{sharedlibrarycoreeventsmanagement-ClientPersistentIdReceiveEvent.md => events/management/ClientPersistentIdReceiveEvent.md} (83%) rename CodeDocumentation/SharedLibraryCore/{sharedlibrarycoreeventsmanagement-ClientStateAuthorizeEvent.md => events/management/ClientStateAuthorizeEvent.md} (93%) rename CodeDocumentation/SharedLibraryCore/{sharedlibrarycoreeventsmanagement-ClientStateDisposeEvent.md => events/management/ClientStateDisposeEvent.md} (93%) rename CodeDocumentation/SharedLibraryCore/{sharedlibrarycoreeventsmanagement-ClientStateEvent.md => events/management/ClientStateEvent.md} (86%) rename CodeDocumentation/SharedLibraryCore/{sharedlibrarycoreeventsmanagement-ClientStateInitializeEvent.md => events/management/ClientStateInitializeEvent.md} (93%) rename CodeDocumentation/SharedLibraryCore/{sharedlibrarycoreeventsmanagement-LoginEvent.md => events/management/LoginEvent.md} (95%) rename CodeDocumentation/SharedLibraryCore/{sharedlibrarycoreeventsmanagement-LogoutEvent.md => events/management/LogoutEvent.md} (92%) rename CodeDocumentation/SharedLibraryCore/{sharedlibrarycoreeventsmanagement-ManagementEvent.md => events/management/ManagementEvent.md} (94%) rename CodeDocumentation/SharedLibraryCore/{sharedlibrarycoreeventsmanagementloginevent-LoginSourceType.md => events/management/loginevent/LoginSourceType.md} (100%) rename CodeDocumentation/SharedLibraryCore/{sharedlibrarycoreeventsserver-ClientDataUpdateEvent.md => events/server/ClientDataUpdateEvent.md} (84%) rename CodeDocumentation/SharedLibraryCore/{sharedlibrarycoreeventsserver-ConnectionInterruptEvent.md => events/server/ConnectionInterruptEvent.md} (93%) rename CodeDocumentation/SharedLibraryCore/{sharedlibrarycoreeventsserver-ConnectionRestoreEvent.md => events/server/ConnectionRestoreEvent.md} (93%) rename CodeDocumentation/SharedLibraryCore/{sharedlibrarycoreeventsserver-GameServerEvent.md => events/server/GameServerEvent.md} (87%) rename CodeDocumentation/SharedLibraryCore/{sharedlibrarycoreeventsserver-MonitorStartEvent.md => events/server/MonitorStartEvent.md} (93%) rename CodeDocumentation/SharedLibraryCore/{sharedlibrarycoreeventsserver-MonitorStopEvent.md => events/server/MonitorStopEvent.md} (93%) rename CodeDocumentation/SharedLibraryCore/{sharedlibrarycoreeventsserver-ServerCommandExecuteEvent.md => events/server/ServerCommandExecuteEvent.md} (95%) rename CodeDocumentation/SharedLibraryCore/{sharedlibrarycoreeventsserver-ServerCommandRequestExecuteEvent.md => events/server/ServerCommandRequestExecuteEvent.md} (86%) rename CodeDocumentation/SharedLibraryCore/{sharedlibrarycoreeventsserver-ServerValueReceiveEvent.md => events/server/ServerValueReceiveEvent.md} (87%) rename CodeDocumentation/SharedLibraryCore/{sharedlibrarycoreeventsserver-ServerValueRequestEvent.md => events/server/ServerValueRequestEvent.md} (87%) rename CodeDocumentation/SharedLibraryCore/{sharedlibrarycoreeventsserver-ServerValueSetCompleteEvent.md => events/server/ServerValueSetCompleteEvent.md} (96%) rename CodeDocumentation/SharedLibraryCore/{sharedlibrarycoreeventsserver-ServerValueSetRequestEvent.md => events/server/ServerValueSetRequestEvent.md} (87%) rename CodeDocumentation/SharedLibraryCore/{sharedlibrarycoreexceptions-AuthorizationException.md => exceptions/AuthorizationException.md} (85%) rename CodeDocumentation/SharedLibraryCore/{sharedlibrarycoreexceptions-CommandException.md => exceptions/CommandException.md} (83%) rename CodeDocumentation/SharedLibraryCore/{sharedlibrarycoreexceptions-ConfigurationException.md => exceptions/ConfigurationException.md} (89%) rename CodeDocumentation/SharedLibraryCore/{sharedlibrarycoreexceptions-DatabaseException.md => exceptions/DatabaseException.md} (84%) rename CodeDocumentation/SharedLibraryCore/{sharedlibrarycoreexceptions-DvarException.md => exceptions/DvarException.md} (83%) rename CodeDocumentation/SharedLibraryCore/{sharedlibrarycoreexceptions-NetworkException.md => exceptions/NetworkException.md} (77%) rename CodeDocumentation/SharedLibraryCore/{sharedlibrarycoreexceptions-PluginException.md => exceptions/PluginException.md} (88%) rename CodeDocumentation/SharedLibraryCore/{sharedlibrarycoreexceptions-RConException.md => exceptions/RConException.md} (83%) rename CodeDocumentation/SharedLibraryCore/{sharedlibrarycoreexceptions-SerializeException.md => exceptions/SerializeException.md} (84%) rename CodeDocumentation/SharedLibraryCore/{sharedlibrarycoreexceptions-ServerException.md => exceptions/ServerException.md} (84%) rename CodeDocumentation/SharedLibraryCore/{sharedlibrarycoreformatting-ColorCodeMapping.md => formatting/ColorCodeMapping.md} (100%) rename CodeDocumentation/SharedLibraryCore/{sharedlibrarycoreformatting-ColorCodes.md => formatting/ColorCodes.md} (100%) rename CodeDocumentation/SharedLibraryCore/{sharedlibrarycoregameevent-EventFailReason.md => gameevent/EventFailReason.md} (100%) rename CodeDocumentation/SharedLibraryCore/{sharedlibrarycoregameevent-EventRequiredEntity.md => gameevent/EventRequiredEntity.md} (100%) rename CodeDocumentation/SharedLibraryCore/{sharedlibrarycoregameevent-EventSource.md => gameevent/EventSource.md} (100%) rename CodeDocumentation/SharedLibraryCore/{sharedlibrarycoregameevent-EventType.md => gameevent/EventType.md} (100%) rename CodeDocumentation/SharedLibraryCore/{sharedlibrarycorehelpers-BuildNumber.md => helpers/BuildNumber.md} (65%) rename CodeDocumentation/SharedLibraryCore/{sharedlibrarycorehelpers-BuildNumberJsonConverter.md => helpers/BuildNumberJsonConverter.md} (83%) rename CodeDocumentation/SharedLibraryCore/{sharedlibrarycorehelpers-ChangeTrackingT.md => helpers/ChangeTrackingT.md} (78%) rename CodeDocumentation/SharedLibraryCore/{sharedlibrarycorehelpers-Hashing.md => helpers/Hashing.md} (88%) rename CodeDocumentation/SharedLibraryCore/{sharedlibrarycorehelpers-InteractionData.md => helpers/InteractionData.md} (92%) rename CodeDocumentation/SharedLibraryCore/{sharedlibrarycorehelpers-MessageToken.md => helpers/MessageToken.md} (79%) rename CodeDocumentation/SharedLibraryCore/{sharedlibrarycorehelpers-ParseEnumT.md => helpers/ParseEnumT.md} (86%) rename CodeDocumentation/SharedLibraryCore/{sharedlibrarycorehelpers-Report.md => helpers/Report.md} (81%) rename CodeDocumentation/SharedLibraryCore/{sharedlibrarycorehelpers-ResourceQueryHelperResultT.md => helpers/ResourceQueryHelperResultT.md} (100%) rename CodeDocumentation/SharedLibraryCore/{sharedlibrarycorehelpers-TokenIdentifier.md => helpers/TokenIdentifier.md} (95%) rename CodeDocumentation/SharedLibraryCore/{sharedlibrarycorehelpers-TokenState.md => helpers/TokenState.md} (89%) rename CodeDocumentation/SharedLibraryCore/{sharedlibrarycoreinterfaces-IAlertManager.md => interfaces/IAlertManager.md} (92%) rename CodeDocumentation/SharedLibraryCore/{sharedlibrarycoreinterfaces-IAuditFields.md => interfaces/IAuditFields.md} (100%) rename CodeDocumentation/SharedLibraryCore/{sharedlibrarycoreinterfaces-IAuditInformationRepository.md => interfaces/IAuditInformationRepository.md} (72%) rename CodeDocumentation/SharedLibraryCore/{sharedlibrarycoreinterfaces-IBaseConfiguration.md => interfaces/IBaseConfiguration.md} (86%) rename CodeDocumentation/SharedLibraryCore/{sharedlibrarycoreinterfaces-IBasePathProvider.md => interfaces/IBasePathProvider.md} (100%) rename CodeDocumentation/SharedLibraryCore/{sharedlibrarycoreinterfaces-IClientMeta.md => interfaces/IClientMeta.md} (94%) rename CodeDocumentation/SharedLibraryCore/{sharedlibrarycoreinterfaces-IClientMetaResponse.md => interfaces/IClientMetaResponse.md} (100%) rename CodeDocumentation/SharedLibraryCore/{sharedlibrarycoreinterfaces-IClientNoticeMessageFormatter.md => interfaces/IClientNoticeMessageFormatter.md} (77%) rename CodeDocumentation/SharedLibraryCore/{sharedlibrarycoreinterfaces-IConfigurationHandlerFactory.md => interfaces/IConfigurationHandlerFactory.md} (79%) rename CodeDocumentation/SharedLibraryCore/{sharedlibrarycoreinterfaces-IConfigurationHandlerT.md => interfaces/IConfigurationHandlerT.md} (100%) rename CodeDocumentation/SharedLibraryCore/{sharedlibrarycoreinterfaces-IConfigurationHandlerV2T.md => interfaces/IConfigurationHandlerV2T.md} (100%) rename CodeDocumentation/SharedLibraryCore/{sharedlibrarycoreinterfaces-ICoreEventHandler.md => interfaces/ICoreEventHandler.md} (71%) rename CodeDocumentation/SharedLibraryCore/{sharedlibrarycoreinterfaces-IEntityServiceT.md => interfaces/IEntityServiceT.md} (100%) rename CodeDocumentation/SharedLibraryCore/{sharedlibrarycoreinterfaces-IEventParser.md => interfaces/IEventParser.md} (77%) rename CodeDocumentation/SharedLibraryCore/{sharedlibrarycoreinterfaces-IEventParserConfiguration.md => interfaces/IEventParserConfiguration.md} (66%) rename CodeDocumentation/SharedLibraryCore/{sharedlibrarycoreinterfaces-IGameLogReader.md => interfaces/IGameLogReader.md} (81%) rename CodeDocumentation/SharedLibraryCore/{sharedlibrarycoreinterfaces-IGameLogReaderFactory.md => interfaces/IGameLogReaderFactory.md} (73%) rename CodeDocumentation/SharedLibraryCore/{sharedlibrarycoreinterfaces-IGameServer.md => interfaces/IGameServer.md} (87%) rename CodeDocumentation/SharedLibraryCore/{sharedlibrarycoreinterfaces-IGameServerInstanceFactory.md => interfaces/IGameServerInstanceFactory.md} (67%) rename CodeDocumentation/SharedLibraryCore/{sharedlibrarycoreinterfaces-IGeoLocationResult.md => interfaces/IGeoLocationResult.md} (100%) rename CodeDocumentation/SharedLibraryCore/{sharedlibrarycoreinterfaces-IGeoLocationService.md => interfaces/IGeoLocationService.md} (84%) rename CodeDocumentation/SharedLibraryCore/{sharedlibrarycoreinterfaces-IInteractionData.md => interfaces/IInteractionData.md} (95%) rename CodeDocumentation/SharedLibraryCore/{sharedlibrarycoreinterfaces-IInteractionRegistration.md => interfaces/IInteractionRegistration.md} (86%) rename CodeDocumentation/SharedLibraryCore/{sharedlibrarycoreinterfaces-ILogger.md => interfaces/ILogger.md} (100%) rename CodeDocumentation/SharedLibraryCore/{sharedlibrarycoreinterfaces-ILookupValueT.md => interfaces/ILookupValueT.md} (100%) rename CodeDocumentation/SharedLibraryCore/{sharedlibrarycoreinterfaces-IManager.md => interfaces/IManager.md} (61%) rename CodeDocumentation/SharedLibraryCore/{sharedlibrarycoreinterfaces-IManagerCommand.md => interfaces/IManagerCommand.md} (92%) rename CodeDocumentation/SharedLibraryCore/{sharedlibrarycoreinterfaces-IMasterCommunication.md => interfaces/IMasterCommunication.md} (100%) rename CodeDocumentation/SharedLibraryCore/{sharedlibrarycoreinterfaces-IMatchResult.md => interfaces/IMatchResult.md} (100%) rename CodeDocumentation/SharedLibraryCore/{sharedlibrarycoreinterfaces-IMetaRegistration.md => interfaces/IMetaRegistration.md} (100%) rename CodeDocumentation/SharedLibraryCore/{sharedlibrarycoreinterfaces-IMetaService.md => interfaces/IMetaService.md} (84%) rename CodeDocumentation/SharedLibraryCore/{sharedlibrarycoreinterfaces-IMetaServiceV2.md => interfaces/IMetaServiceV2.md} (91%) rename CodeDocumentation/SharedLibraryCore/{sharedlibrarycoreinterfaces-IMiddlewareActionHandler.md => interfaces/IMiddlewareActionHandler.md} (86%) rename CodeDocumentation/SharedLibraryCore/{sharedlibrarycoreinterfaces-IMiddlewareActionT.md => interfaces/IMiddlewareActionT.md} (100%) rename CodeDocumentation/SharedLibraryCore/{sharedlibrarycoreinterfaces-IModelConfiguration.md => interfaces/IModelConfiguration.md} (100%) rename CodeDocumentation/SharedLibraryCore/{sharedlibrarycoreinterfaces-IModularAssembly.md => interfaces/IModularAssembly.md} (100%) rename CodeDocumentation/SharedLibraryCore/{sharedlibrarycoreinterfaces-IPageList.md => interfaces/IPageList.md} (100%) rename CodeDocumentation/SharedLibraryCore/{sharedlibrarycoreinterfaces-IParserPatternMatcher.md => interfaces/IParserPatternMatcher.md} (89%) rename CodeDocumentation/SharedLibraryCore/{sharedlibrarycoreinterfaces-IParserRegexFactory.md => interfaces/IParserRegexFactory.md} (85%) rename CodeDocumentation/SharedLibraryCore/{sharedlibrarycoreinterfaces-IPlugin.md => interfaces/IPlugin.md} (72%) rename CodeDocumentation/SharedLibraryCore/{sharedlibrarycoreinterfaces-IPluginImporter.md => interfaces/IPluginImporter.md} (100%) rename CodeDocumentation/SharedLibraryCore/{sharedlibrarycoreinterfaces-IPluginV2.md => interfaces/IPluginV2.md} (88%) rename CodeDocumentation/SharedLibraryCore/{sharedlibrarycoreinterfaces-IRConConnection.md => interfaces/IRConConnection.md} (89%) rename CodeDocumentation/SharedLibraryCore/{sharedlibrarycoreinterfaces-IRConConnectionFactory.md => interfaces/IRConConnectionFactory.md} (84%) rename CodeDocumentation/SharedLibraryCore/{sharedlibrarycoreinterfaces-IRConParser.md => interfaces/IRConParser.md} (78%) rename CodeDocumentation/SharedLibraryCore/{sharedlibrarycoreinterfaces-IRConParserConfiguration.md => interfaces/IRConParserConfiguration.md} (80%) rename CodeDocumentation/SharedLibraryCore/{sharedlibrarycoreinterfaces-IRegisterEvent.md => interfaces/IRegisterEvent.md} (76%) rename CodeDocumentation/SharedLibraryCore/{sharedlibrarycoreinterfaces-IRemoteAssemblyHandler.md => interfaces/IRemoteAssemblyHandler.md} (100%) rename CodeDocumentation/SharedLibraryCore/{sharedlibrarycoreinterfaces-IRemoteCommandService.md => interfaces/IRemoteCommandService.md} (68%) rename CodeDocumentation/SharedLibraryCore/{sharedlibrarycoreinterfaces-IResourceQueryHelperTT.md => interfaces/IResourceQueryHelperTT.md} (85%) rename CodeDocumentation/SharedLibraryCore/{sharedlibrarycoreinterfaces-IScriptCommandFactory.md => interfaces/IScriptCommandFactory.md} (65%) rename CodeDocumentation/SharedLibraryCore/{sharedlibrarycoreinterfaces-IScriptPluginFactory.md => interfaces/IScriptPluginFactory.md} (100%) rename CodeDocumentation/SharedLibraryCore/{sharedlibrarycoreinterfaces-IScriptPluginServiceResolver.md => interfaces/IScriptPluginServiceResolver.md} (100%) rename CodeDocumentation/SharedLibraryCore/{sharedlibrarycoreinterfaces-IScriptPluginTimerHelper.md => interfaces/IScriptPluginTimerHelper.md} (100%) rename CodeDocumentation/SharedLibraryCore/{sharedlibrarycoreinterfaces-IServerDataCollector.md => interfaces/IServerDataCollector.md} (100%) rename CodeDocumentation/SharedLibraryCore/{sharedlibrarycoreinterfaces-IServerDataViewer.md => interfaces/IServerDataViewer.md} (92%) rename CodeDocumentation/SharedLibraryCore/{sharedlibrarycoreinterfaces-IStatusResponse.md => interfaces/IStatusResponse.md} (92%) rename CodeDocumentation/SharedLibraryCore/{sharedlibrarycoreinterfaces-ITokenAuthentication.md => interfaces/ITokenAuthentication.md} (67%) rename CodeDocumentation/SharedLibraryCore/{sharedlibrarycoreinterfaces-ITokenIdentifier.md => interfaces/ITokenIdentifier.md} (100%) rename CodeDocumentation/SharedLibraryCore/{sharedlibrarycoreinterfaces-ITranslationLookup.md => interfaces/ITranslationLookup.md} (100%) rename CodeDocumentation/SharedLibraryCore/{sharedlibrarycoreinterfaces-InteractionType.md => interfaces/InteractionType.md} (100%) rename CodeDocumentation/SharedLibraryCore/{sharedlibrarycoreinterfaces-MetaType.md => interfaces/MetaType.md} (100%) rename CodeDocumentation/SharedLibraryCore/{sharedlibrarycoreinterfaces-ParserRegex.md => interfaces/ParserRegex.md} (84%) rename CodeDocumentation/SharedLibraryCore/{sharedlibrarycoreinterfacesevents-IGameEventSubscriptions.md => interfaces/events/IGameEventSubscriptions.md} (78%) rename CodeDocumentation/SharedLibraryCore/{sharedlibrarycoreinterfacesevents-IGameServerEventSubscriptions.md => interfaces/events/IGameServerEventSubscriptions.md} (75%) rename CodeDocumentation/SharedLibraryCore/{sharedlibrarycoreinterfacesevents-IManagementEventSubscriptions.md => interfaces/events/IManagementEventSubscriptions.md} (67%) rename CodeDocumentation/SharedLibraryCore/{sharedlibrarycoreinterfacesparserregex-GroupType.md => interfaces/parserregex/GroupType.md} (100%) rename CodeDocumentation/SharedLibraryCore/{sharedlibrarycorelocalization-ClientPermission.md => localization/ClientPermission.md} (100%) rename CodeDocumentation/SharedLibraryCore/{sharedlibrarycorelocalization-Layout.md => localization/Layout.md} (82%) rename CodeDocumentation/SharedLibraryCore/{sharedlibrarycorelocalization-TranslationLookup.md => localization/TranslationLookup.md} (95%) create mode 100644 CodeDocumentation/SharedLibraryCore/modulardoc.mconf rename CodeDocumentation/SharedLibraryCore/{sharedlibrarycorequeryhelper-ClientPaginationRequest.md => queryhelper/ClientPaginationRequest.md} (95%) rename CodeDocumentation/SharedLibraryCore/{sharedlibrarycorercon-CommandPrefix.md => rcon/CommandPrefix.md} (100%) rename CodeDocumentation/SharedLibraryCore/{sharedlibrarycorercon-StaticHelpers.md => rcon/StaticHelpers.md} (88%) rename CodeDocumentation/SharedLibraryCore/{sharedlibrarycorerconstatichelpers-QueryType.md => rcon/statichelpers/QueryType.md} (100%) rename CodeDocumentation/SharedLibraryCore/{sharedlibrarycorerepositories-AuditInformationRepository.md => repositories/AuditInformationRepository.md} (74%) rename CodeDocumentation/SharedLibraryCore/{sharedlibrarycoreserver-Game.md => server/Game.md} (100%) rename CodeDocumentation/SharedLibraryCore/{sharedlibrarycoreservices-ChangeHistoryService.md => services/ChangeHistoryService.md} (71%) rename CodeDocumentation/SharedLibraryCore/{sharedlibrarycoreservices-ClientService.md => services/ClientService.md} (64%) rename CodeDocumentation/SharedLibraryCore/{sharedlibrarycoreservices-PenaltyService.md => services/PenaltyService.md} (84%) diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycore-BaseController.md b/CodeDocumentation/SharedLibraryCore/BaseController.md similarity index 79% rename from CodeDocumentation/SharedLibraryCore/sharedlibrarycore-BaseController.md rename to CodeDocumentation/SharedLibraryCore/BaseController.md index 7c16700..675a661 100644 --- a/CodeDocumentation/SharedLibraryCore/sharedlibrarycore-BaseController.md +++ b/CodeDocumentation/SharedLibraryCore/BaseController.md @@ -19,15 +19,15 @@ Microsoft.AspNetCore.Mvc.Controller --> SharedLibraryCore.BaseController #### Protected properties | Type | Name | Methods | | --- | --- | --- | -| [`ApplicationConfiguration`](./sharedlibrarycoreconfiguration-ApplicationConfiguration) | [`AppConfig`](#appconfig) | `get` | +| [`ApplicationConfiguration`](configuration/ApplicationConfiguration.md) | [`AppConfig`](#appconfig) | `get` | | `bool` | [`Authorized`](#authorized) | `get, set` | -| [`EFClient`](./sharedlibrarycoredatabasemodels-EFClient) | [`Client`](#client) | `get` | -| [`TranslationLookup`](./sharedlibrarycorelocalization-TranslationLookup) | [`Localization`](#localization) | `get` | +| [`EFClient`](database/models/EFClient.md) | [`Client`](#client) | `get` | +| [`TranslationLookup`](localization/TranslationLookup.md) | [`Localization`](#localization) | `get` | #### Public properties | Type | Name | Methods | | --- | --- | --- | -| [`IManager`](./sharedlibrarycoreinterfaces-IManager) | [`Manager`](#manager) | `get` | +| [`IManager`](interfaces/IManager.md) | [`Manager`](#manager) | `get` | ### Methods #### Protected methods @@ -46,13 +46,14 @@ Microsoft.AspNetCore.Mvc.Controller --> SharedLibraryCore.BaseController ### Constructors #### BaseController +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/BaseController.cs#L43) ```csharp public BaseController(IManager manager) ``` ##### Arguments | Type | Name | Description | | --- | --- | --- | -| [`IManager`](./sharedlibrarycoreinterfaces-IManager) | manager | | +| [`IManager`](interfaces/IManager.md) | manager | | ### Methods #### SignInAsync diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycore-ColorCode.md b/CodeDocumentation/SharedLibraryCore/ColorCode.md similarity index 80% rename from CodeDocumentation/SharedLibraryCore/sharedlibrarycore-ColorCode.md rename to CodeDocumentation/SharedLibraryCore/ColorCode.md index 8097f85..f4f77cd 100644 --- a/CodeDocumentation/SharedLibraryCore/sharedlibrarycore-ColorCode.md +++ b/CodeDocumentation/SharedLibraryCore/ColorCode.md @@ -33,16 +33,18 @@ Microsoft.AspNetCore.Razor.TagHelpers.TagHelper --> SharedLibraryCore.ColorCode ### Constructors #### ColorCode +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/TagHelpers/ColorCode.cs#L13) ```csharp public ColorCode(ApplicationConfiguration appConfig) ``` ##### Arguments | Type | Name | Description | | --- | --- | --- | -| [`ApplicationConfiguration`](./sharedlibrarycoreconfiguration-ApplicationConfiguration) | appConfig | | +| [`ApplicationConfiguration`](configuration/ApplicationConfiguration.md) | appConfig | | ### Methods #### Process +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/TagHelpers/ColorCode.cs#L21) ```csharp public override void Process(TagHelperContext context, TagHelperOutput output) ``` diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycore-Command.md b/CodeDocumentation/SharedLibraryCore/Command.md similarity index 86% rename from CodeDocumentation/SharedLibraryCore/sharedlibrarycore-Command.md rename to CodeDocumentation/SharedLibraryCore/Command.md index f947aeb..cc7e332 100644 --- a/CodeDocumentation/SharedLibraryCore/sharedlibrarycore-Command.md +++ b/CodeDocumentation/SharedLibraryCore/Command.md @@ -26,7 +26,7 @@ SharedLibraryCore.Interfaces.IManagerCommand --> SharedLibraryCore.Command | --- | --- | --- | | `string` | [`Alias`](#alias)
Alternate name for this command to be executed by | `get, protected set` | | `bool` | [`AllowImpersonation`](#allowimpersonation)
indicates if this command allows impersonation (run as) | `get, set` | -| [`CommandArgument`](./sharedlibrarycorecommands-CommandArgument)`[]` | [`Arguments`](#arguments)
Argument list for the command | `get, protected set` | +| [`CommandArgument`](commands/CommandArgument.md)`[]` | [`Arguments`](#arguments)
Argument list for the command | `get, protected set` | | `string` | [`Description`](#description)
Specifies the command description | `get, protected set` | | `bool` | [`IsBroadcast`](#isbroadcast) | `get, set` | | `string` | [`Name`](#name)
Specifies the name and string that triggers the command | `get, protected set` | @@ -40,7 +40,7 @@ SharedLibraryCore.Interfaces.IManagerCommand --> SharedLibraryCore.Command #### Public methods | Returns | Name | | --- | --- | -| `Task` | [`ExecuteAsync`](#executeasync)([`GameEvent`](./sharedlibrarycore-GameEvent) gameEvent)
Executes the command | +| `Task` | [`ExecuteAsync`](#executeasync)([`GameEvent`](./GameEvent.md) gameEvent)
Executes the command | ## Details ### Summary @@ -49,18 +49,19 @@ Abstract class for command ### Inheritance - [ `IManagerCommand` -](./sharedlibrarycoreinterfaces-IManagerCommand) +](interfaces/IManagerCommand.md) ### Constructors #### Command +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Command.cs#L42) ```csharp public Command(CommandConfiguration config, ITranslationLookup layout) ``` ##### Arguments | Type | Name | Description | | --- | --- | --- | -| [`CommandConfiguration`](./sharedlibrarycoreconfiguration-CommandConfiguration) | config | | -| [`ITranslationLookup`](./sharedlibrarycoreinterfaces-ITranslationLookup) | layout | | +| [`CommandConfiguration`](configuration/CommandConfiguration.md) | config | | +| [`ITranslationLookup`](interfaces/ITranslationLookup.md) | layout | | ### Methods #### ExecuteAsync @@ -70,7 +71,7 @@ public abstract Task ExecuteAsync(GameEvent gameEvent) ##### Arguments | Type | Name | Description | | --- | --- | --- | -| [`GameEvent`](./sharedlibrarycore-GameEvent) | gameEvent | | +| [`GameEvent`](./GameEvent.md) | gameEvent | | ##### Summary Executes the command diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycore-DvarT.md b/CodeDocumentation/SharedLibraryCore/DvarT.md similarity index 100% rename from CodeDocumentation/SharedLibraryCore/sharedlibrarycore-DvarT.md rename to CodeDocumentation/SharedLibraryCore/DvarT.md diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycore-GameEvent.md b/CodeDocumentation/SharedLibraryCore/GameEvent.md similarity index 86% rename from CodeDocumentation/SharedLibraryCore/sharedlibrarycore-GameEvent.md rename to CodeDocumentation/SharedLibraryCore/GameEvent.md index 08aa08e..e228ca0 100644 --- a/CodeDocumentation/SharedLibraryCore/sharedlibrarycore-GameEvent.md +++ b/CodeDocumentation/SharedLibraryCore/GameEvent.md @@ -24,7 +24,7 @@ SharedLibraryCore.Events.CoreEvent --> SharedLibraryCore.GameEvent | `EventFailReason` | [`FailReason`](#failreason) | `get, set` | | `bool` | [`Failed`](#failed) | `get` | | `Nullable`<`long`> | [`GameTime`](#gametime)
Specifies the game time offset as printed in the log | `get, set` | -| [`EFClient`](./sharedlibrarycoredatabasemodels-EFClient) | [`ImpersonationOrigin`](#impersonationorigin) | `get, set` | +| [`EFClient`](database/models/EFClient.md) | [`ImpersonationOrigin`](#impersonationorigin) | `get, set` | | `long` | [`IncrementalId`](#incrementalid) | `get` | | `bool` | [`IsBlocking`](#isblocking)
Indicates if the event should block until it is complete | `get, set` | | `bool` | [`IsRemote`](#isremote) | `get, set` | @@ -44,13 +44,13 @@ SharedLibraryCore.Events.CoreEvent --> SharedLibraryCore.GameEvent | Returns | Name | | --- | --- | | `void` | [`Complete`](#complete)() | -| `Task`<[`GameEvent`](sharedlibrarycore-GameEvent)> | [`WaitAsync`](#waitasync-12)(`...`) | +| `Task`<[`GameEvent`](sharedlibrarycore/GameEvent.md)> | [`WaitAsync`](#waitasync-12)(`...`) | ## Details ### Inheritance - [ `CoreEvent` -](./sharedlibrarycoreevents-CoreEvent) +](events/CoreEvent.md) ### Nested types #### Enums @@ -61,17 +61,20 @@ SharedLibraryCore.Events.CoreEvent --> SharedLibraryCore.GameEvent ### Constructors #### GameEvent +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Events/GameEvent.cs#L260) ```csharp public GameEvent() ``` ### Methods #### Finalize +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Events/GameEvent.cs#L277) ```csharp protected override void Finalize() ``` #### Complete +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Events/GameEvent.cs#L313) ```csharp public void Complete() ``` diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycore-Gametype.md b/CodeDocumentation/SharedLibraryCore/Gametype.md similarity index 100% rename from CodeDocumentation/SharedLibraryCore/sharedlibrarycore-Gametype.md rename to CodeDocumentation/SharedLibraryCore/Gametype.md diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycore-Map.md b/CodeDocumentation/SharedLibraryCore/Map.md similarity index 89% rename from CodeDocumentation/SharedLibraryCore/sharedlibrarycore-Map.md rename to CodeDocumentation/SharedLibraryCore/Map.md index c005cbc..6cbd705 100644 --- a/CodeDocumentation/SharedLibraryCore/sharedlibrarycore-Map.md +++ b/CodeDocumentation/SharedLibraryCore/Map.md @@ -33,6 +33,7 @@ public Map() ### Methods #### ToString +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Game/Map.cs#L9) ```csharp public override string ToString() ``` diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycore-Server.md b/CodeDocumentation/SharedLibraryCore/Server.md similarity index 68% rename from CodeDocumentation/SharedLibraryCore/sharedlibrarycore-Server.md rename to CodeDocumentation/SharedLibraryCore/Server.md index 7ddfaa7..d772755 100644 --- a/CodeDocumentation/SharedLibraryCore/sharedlibrarycore-Server.md +++ b/CodeDocumentation/SharedLibraryCore/Server.md @@ -21,15 +21,15 @@ SharedLibraryCore.Interfaces.IGameServer --> SharedLibraryCore.Server #### Public properties | Type | Name | Methods | | --- | --- | --- | -| `List`<[`ChatInfo`](./sharedlibrarycoredtos-ChatInfo)> | [`ChatHistory`](#chathistory) | `get, protected set` | -| [`ClientHistoryInfo`](./sharedlibrarycoredtos-ClientHistoryInfo) | [`ClientHistory`](#clienthistory) | `get` | +| `List`<[`ChatInfo`](dtos/ChatInfo.md)> | [`ChatHistory`](#chathistory) | `get, protected set` | +| [`ClientHistoryInfo`](dtos/ClientHistoryInfo.md) | [`ClientHistory`](#clienthistory) | `get` | | `int` | [`ClientNum`](#clientnum) | `get` | -| `List`<[`EFClient`](./sharedlibrarycoredatabasemodels-EFClient)> | [`Clients`](#clients) | `get, protected set` | -| `IReadOnlyList`<[`EFClient`](./sharedlibrarycoredatabasemodels-EFClient)> | [`ConnectedClients`](#connectedclients) | `get` | -| [`Map`](./sharedlibrarycore-Map) | [`CurrentMap`](#currentmap) | `get, set` | +| `List`<[`EFClient`](database/models/EFClient.md)> | [`Clients`](#clients) | `get, protected set` | +| `IReadOnlyList`<[`EFClient`](database/models/EFClient.md)> | [`ConnectedClients`](#connectedclients) | `get` | +| [`Map`](./Map.md) | [`CurrentMap`](#currentmap) | `get, set` | | `bool` | [`CustomCallback`](#customcallback) | `get, protected set` | | `long` | [`EndPoint`](#endpoint) | `get` | -| [`IEventParser`](./sharedlibrarycoreinterfaces-IEventParser) | [`EventParser`](#eventparser) | `get, set` | +| [`IEventParser`](interfaces/IEventParser.md) | [`EventParser`](#eventparser) | `get, set` | | `SemaphoreSlim` | [`EventProcessing`](#eventprocessing) | `get` | | `Game` | [`GameCode`](#gamecode) | `get` | | `Game` | [`GameName`](#gamename) | `get, set` | @@ -45,10 +45,10 @@ SharedLibraryCore.Interfaces.IGameServer --> SharedLibraryCore.Server | `string` | [`ListenAddress`](#listenaddress) | `get` | | `int` | [`ListenPort`](#listenport) | `get` | | `string` | [`LogPath`](#logpath) | `get, protected set` | -| [`ILogger`](./sharedlibrarycoreinterfaces-ILogger) | [`Logger`](#logger) | `get` | -| [`IManager`](./sharedlibrarycoreinterfaces-IManager) | [`Manager`](#manager) | `get, protected set` | -| [`Map`](./sharedlibrarycore-Map) | [`Map`](#map) | `get` | -| `List`<[`Map`](./sharedlibrarycore-Map)> | [`Maps`](#maps) | `get, protected set` | +| [`ILogger`](interfaces/ILogger.md) | [`Logger`](#logger) | `get` | +| [`IManager`](interfaces/IManager.md) | [`Manager`](#manager) | `get, protected set` | +| [`Map`](./Map.md) | [`Map`](#map) | `get` | +| `List`<[`Map`](./Map.md)> | [`Maps`](#maps) | `get, protected set` | | `Nullable`<`DateTime`> | [`MatchEndTime`](#matchendtime) | `get, protected set` | | `Nullable`<`DateTime`> | [`MatchStartTime`](#matchstarttime) | `get, protected set` | | `int` | [`MaxClients`](#maxclients) | `get, protected set` | @@ -56,12 +56,12 @@ SharedLibraryCore.Interfaces.IGameServer --> SharedLibraryCore.Server | `string` | [`PerformanceBucket`](#performancebucket) | `get, init` | | `int` | [`Port`](#port) | `get, protected set` | | `int` | [`PrivateClientSlots`](#privateclientslots) | `get, protected set` | -| [`IRConParser`](./sharedlibrarycoreinterfaces-IRConParser) | [`RconParser`](#rconparser) | `get, set` | -| [`IRConConnection`](./sharedlibrarycoreinterfaces-IRConConnection) | [`RemoteConnection`](#remoteconnection) | `get, protected set` | -| `List`<[`Report`](./sharedlibrarycorehelpers-Report)> | [`Reports`](#reports) | `get, set` | +| [`IRConParser`](interfaces/IRConParser.md) | [`RconParser`](#rconparser) | `get, set` | +| [`IRConConnection`](interfaces/IRConConnection.md) | [`RemoteConnection`](#remoteconnection) | `get, protected set` | +| `List`<[`Report`](helpers/Report.md)> | [`Reports`](#reports) | `get, set` | | `IPEndPoint` | [`ResolvedIpEndPoint`](#resolvedipendpoint) | `get, protected set` | | `bool` | [`RestartRequested`](#restartrequested) | `get, set` | -| [`ServerConfiguration`](./sharedlibrarycoreconfiguration-ServerConfiguration) | [`ServerConfig`](#serverconfig) | `get` | +| [`ServerConfiguration`](configuration/ServerConfiguration.md) | [`ServerConfig`](#serverconfig) | `get` | | `string` | [`ServerName`](#servername) | `get` | | `bool` | [`Throttled`](#throttled) | `get, protected set` | | `string` | [`Version`](#version) | `get, protected set` | @@ -72,41 +72,41 @@ SharedLibraryCore.Interfaces.IGameServer --> SharedLibraryCore.Server #### Public methods | Returns | Name | | --- | --- | -| `Task` | [`Ban`](#ban)(`string` reason, [`EFClient`](./sharedlibrarycoredatabasemodels-EFClient) target, [`EFClient`](./sharedlibrarycoredatabasemodels-EFClient) origin, `bool` isEvade)
Perm ban a player from the server | -| [`GameEvent`](./sharedlibrarycore-GameEvent) | [`Broadcast`](#broadcast-12)(`...`)
Send a message to all players | -| `Task` | [`BroadcastAsync`](#broadcastasync)(`IEnumerable`<`string`> messages, [`EFClient`](./sharedlibrarycoredatabasemodels-EFClient) sender, `CancellationToken` token) | +| `Task` | [`Ban`](#ban)(`string` reason, [`EFClient`](database/models/EFClient.md) target, [`EFClient`](database/models/EFClient.md) origin, `bool` isEvade)
Perm ban a player from the server | +| [`GameEvent`](./GameEvent.md) | [`Broadcast`](#broadcast-12)(`...`)
Send a message to all players | +| `Task` | [`BroadcastAsync`](#broadcastasync)(`IEnumerable`<`string`> messages, [`EFClient`](database/models/EFClient.md) sender, `CancellationToken` token) | | `Task`<`string``[]`> | [`ExecuteCommandAsync`](#executecommandasync)(`string` command, `CancellationToken` token) | -| `Task` | [`ExecuteEvent`](#executeevent)([`GameEvent`](./sharedlibrarycore-GameEvent) E) | -| `List`<[`EFClient`](./sharedlibrarycoredatabasemodels-EFClient)> | [`GetClientByName`](#getclientbyname)(`string` pName)
Get a player by name
todo: make this an extension | -| [`EFClient`](./sharedlibrarycoredatabasemodels-EFClient) | [`GetClientByNumber`](#getclientbynumber)(`int` clientNumber) | -| `List`<[`EFClient`](./sharedlibrarycoredatabasemodels-EFClient)> | [`GetClientsAsList`](#getclientsaslist)()
Returns list of all current players | -| `Task`<`long`> | [`GetIdForServer`](#getidforserver)([`Server`](sharedlibrarycore-Server) server) | +| `Task` | [`ExecuteEvent`](#executeevent)([`GameEvent`](./GameEvent.md) E) | +| `List`<[`EFClient`](database/models/EFClient.md)> | [`GetClientByName`](#getclientbyname)(`string` pName)
Get a player by name
todo: make this an extension | +| [`EFClient`](database/models/EFClient.md) | [`GetClientByNumber`](#getclientbynumber)(`int` clientNumber) | +| `List`<[`EFClient`](database/models/EFClient.md)> | [`GetClientsAsList`](#getclientsaslist)()
Returns list of all current players | +| `Task`<`long`> | [`GetIdForServer`](#getidforserver)([`Server`](sharedlibrarycore/Server.md) server) | | `void` | [`InitializeTokens`](#initializetokens)()
Initalize the macro variables | | `Task` | [`Kick`](#kick-12)(`...`) | | `Task` | [`LoadMap`](#loadmap)(`string` mapName)
Change the current server map | -| `Task`<[`EFClient`](./sharedlibrarycoredatabasemodels-EFClient)> | [`OnClientConnected`](#onclientconnected)([`EFClient`](./sharedlibrarycoredatabasemodels-EFClient) P)
Add a player to the server's player list | -| `Task` | [`OnClientDisconnected`](#onclientdisconnected)([`EFClient`](./sharedlibrarycoredatabasemodels-EFClient) client)
Remove player by client number | +| `Task`<[`EFClient`](database/models/EFClient.md)> | [`OnClientConnected`](#onclientconnected)([`EFClient`](database/models/EFClient.md) P)
Add a player to the server's player list | +| `Task` | [`OnClientDisconnected`](#onclientdisconnected)([`EFClient`](database/models/EFClient.md) client)
Remove player by client number | | `Task`<`bool`> | [`ProcessUpdatesAsync`](#processupdatesasync)(`CancellationToken` token) | | `Task` | [`SetDvarAsync`](#setdvarasync)(`string` name, `object` value, `CancellationToken` token) | -| `Task` | [`TempBan`](#tempban)(`string` reason, `TimeSpan` length, [`EFClient`](./sharedlibrarycoredatabasemodels-EFClient) target, [`EFClient`](./sharedlibrarycoredatabasemodels-EFClient) origin)
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)
Temporarily ban a player ( default 1 hour ) from the server | | `void` | [`ToAdmins`](#toadmins)(`string` message)
Send a message to all admins on the server | | `string` | [`ToString`](#tostring)() | -| `Task` | [`Unban`](#unban)(`string` reason, [`EFClient`](./sharedlibrarycoredatabasemodels-EFClient) targetClient, [`EFClient`](./sharedlibrarycoredatabasemodels-EFClient) originClient)
Unban a player by npID / GUID | -| `Task` | [`Warn`](#warn)(`string` reason, [`EFClient`](./sharedlibrarycoredatabasemodels-EFClient) target, [`EFClient`](./sharedlibrarycoredatabasemodels-EFClient) origin) | +| `Task` | [`Unban`](#unban)(`string` reason, [`EFClient`](database/models/EFClient.md) targetClient, [`EFClient`](database/models/EFClient.md) originClient)
Unban a player by npID / GUID | +| `Task` | [`Warn`](#warn)(`string` reason, [`EFClient`](database/models/EFClient.md) target, [`EFClient`](database/models/EFClient.md) origin) | #### Protected methods | Returns | Name | | --- | --- | | `void` | [`InitializeAutoMessages`](#initializeautomessages)()
Initialize the messages to be broadcasted | -| `Task`<`bool`> | [`ProcessEvent`](#processevent)([`GameEvent`](./sharedlibrarycore-GameEvent) E)
Process any server event | +| `Task`<`bool`> | [`ProcessEvent`](#processevent)([`GameEvent`](./GameEvent.md) E)
Process any server event | | `Task`<`bool`> | [`ScriptLoaded`](#scriptloaded)() | -| `Task` | [`Tell`](#tell)(`string` message, [`EFClient`](./sharedlibrarycoredatabasemodels-EFClient) targetClient)
Send a message to a particular players | +| `Task` | [`Tell`](#tell)(`string` message, [`EFClient`](database/models/EFClient.md) targetClient)
Send a message to a particular players | ## Details ### Inheritance - [ `IGameServer` -](./sharedlibrarycoreinterfaces-IGameServer) +](interfaces/IGameServer.md) ### Nested types #### Enums @@ -114,18 +114,19 @@ SharedLibraryCore.Interfaces.IGameServer --> SharedLibraryCore.Server ### Constructors #### Server +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Server.cs#L103) ```csharp public Server(ILogger logger, ILogger deprecatedLogger, ServerConfiguration config, IManager mgr, IRConConnectionFactory rconConnectionFactory, IGameLogReaderFactory gameLogReaderFactory, IServiceProvider serviceProvider) ``` ##### Arguments | Type | Name | Description | | --- | --- | --- | -| `ILogger`<[`Server`](sharedlibrarycore-Server)> | logger | | -| [`ILogger`](./sharedlibrarycoreinterfaces-ILogger) | deprecatedLogger | | -| [`ServerConfiguration`](./sharedlibrarycoreconfiguration-ServerConfiguration) | config | | -| [`IManager`](./sharedlibrarycoreinterfaces-IManager) | mgr | | -| [`IRConConnectionFactory`](./sharedlibrarycoreinterfaces-IRConConnectionFactory) | rconConnectionFactory | | -| [`IGameLogReaderFactory`](./sharedlibrarycoreinterfaces-IGameLogReaderFactory) | gameLogReaderFactory | | +| `ILogger`<[`Server`](sharedlibrarycore/Server.md)> | logger | | +| [`ILogger`](interfaces/ILogger.md) | deprecatedLogger | | +| [`ServerConfiguration`](configuration/ServerConfiguration.md) | config | | +| [`IManager`](interfaces/IManager.md) | mgr | | +| [`IRConConnectionFactory`](interfaces/IRConConnectionFactory.md) | rconConnectionFactory | | +| [`IGameLogReaderFactory`](interfaces/IGameLogReaderFactory.md) | gameLogReaderFactory | | | `IServiceProvider` | serviceProvider | | ### Methods @@ -137,8 +138,8 @@ public abstract Task Kick(string reason, EFClient target, EFClient origin, EFPen | Type | Name | Description | | --- | --- | --- | | `string` | reason | | -| [`EFClient`](./sharedlibrarycoredatabasemodels-EFClient) | target | | -| [`EFClient`](./sharedlibrarycoredatabasemodels-EFClient) | origin | | +| [`EFClient`](database/models/EFClient.md) | target | | +| [`EFClient`](database/models/EFClient.md) | origin | | | `EFPenalty` | originalPenalty | | #### ExecuteCommandAsync @@ -163,6 +164,7 @@ public abstract Task SetDvarAsync(string name, object value, CancellationToken t | `CancellationToken` | token | | #### GetClientsAsList +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Server.cs#L176) ```csharp public List GetClientsAsList() ``` @@ -179,7 +181,7 @@ public abstract Task OnClientConnected(EFClient P) ##### Arguments | Type | Name | Description | | --- | --- | --- | -| [`EFClient`](./sharedlibrarycoredatabasemodels-EFClient) | P | EFClient pulled from memory reading | +| [`EFClient`](database/models/EFClient.md) | P | EFClient pulled from memory reading | ##### Summary Add a player to the server's player list @@ -194,7 +196,7 @@ public abstract Task OnClientDisconnected(EFClient client) ##### Arguments | Type | Name | Description | | --- | --- | --- | -| [`EFClient`](./sharedlibrarycoredatabasemodels-EFClient) | client | | +| [`EFClient`](database/models/EFClient.md) | client | | ##### Summary Remove player by client number @@ -203,6 +205,7 @@ Remove player by client number true if removal succeeded, false otherwise #### GetClientByName +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Server.cs#L16707566) ```csharp public List GetClientByName(string pName) ``` @@ -219,6 +222,7 @@ Get a player by name Matching player if found #### ProcessUpdatesAsync +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Server.cs#L229) ```csharp public virtual Task ProcessUpdatesAsync(CancellationToken token) ``` @@ -234,7 +238,7 @@ protected abstract Task ProcessEvent(GameEvent E) ##### Arguments | Type | Name | Description | | --- | --- | --- | -| [`GameEvent`](./sharedlibrarycore-GameEvent) | E | Event | +| [`GameEvent`](./GameEvent.md) | E | Event | ##### Summary Process any server event @@ -249,9 +253,10 @@ public abstract Task ExecuteEvent(GameEvent E) ##### Arguments | Type | Name | Description | | --- | --- | --- | -| [`GameEvent`](./sharedlibrarycore-GameEvent) | E | | +| [`GameEvent`](./GameEvent.md) | E | | #### Broadcast [1/2] +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Server.cs#L248) ```csharp public GameEvent Broadcast(string message, EFClient sender) ``` @@ -259,12 +264,13 @@ public GameEvent Broadcast(string message, EFClient sender) | Type | Name | Description | | --- | --- | --- | | `string` | message | Message to be sent to all players | -| [`EFClient`](./sharedlibrarycoredatabasemodels-EFClient) | sender | Client that initiated the broadcast | +| [`EFClient`](database/models/EFClient.md) | sender | Client that initiated the broadcast | ##### Summary Send a message to all players #### Broadcast [2/2] +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Server.cs#L270) ```csharp public void Broadcast(IEnumerable messages, EFClient sender) ``` @@ -272,7 +278,7 @@ public void Broadcast(IEnumerable messages, EFClient sender) | Type | Name | Description | | --- | --- | --- | | `IEnumerable`<`string`> | messages | | -| [`EFClient`](./sharedlibrarycoredatabasemodels-EFClient) | sender | | +| [`EFClient`](database/models/EFClient.md) | sender | | #### BroadcastAsync ```csharp @@ -282,7 +288,7 @@ public async Task BroadcastAsync(IEnumerable messages, EFClient sender, | Type | Name | Description | | --- | --- | --- | | `IEnumerable`<`string`> | messages | | -| [`EFClient`](./sharedlibrarycoredatabasemodels-EFClient) | sender | | +| [`EFClient`](database/models/EFClient.md) | sender | | | `CancellationToken` | token | | #### Tell @@ -293,12 +299,13 @@ protected async Task Tell(string message, EFClient targetClient) | Type | Name | Description | | --- | --- | --- | | `string` | message | Message to send | -| [`EFClient`](./sharedlibrarycoredatabasemodels-EFClient) | targetClient | EFClient to send message to | +| [`EFClient`](database/models/EFClient.md) | targetClient | EFClient to send message to | ##### Summary Send a message to a particular players #### ToAdmins +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Server.cs#L343) ```csharp public void ToAdmins(string message) ``` @@ -311,6 +318,7 @@ public void ToAdmins(string message) Send a message to all admins on the server #### Kick [2/2] +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Server.cs#L356) ```csharp public Task Kick(string reason, EFClient target, EFClient origin) ``` @@ -318,8 +326,8 @@ public Task Kick(string reason, EFClient target, EFClient origin) | Type | Name | Description | | --- | --- | --- | | `string` | reason | Reason for kicking | -| [`EFClient`](./sharedlibrarycoredatabasemodels-EFClient) | target | EFClient to kick | -| [`EFClient`](./sharedlibrarycoredatabasemodels-EFClient) | origin | Client initating the kick | +| [`EFClient`](database/models/EFClient.md) | target | EFClient to kick | +| [`EFClient`](database/models/EFClient.md) | origin | Client initating the kick | ##### Summary Kick a player from the server @@ -333,8 +341,8 @@ public abstract Task TempBan(string reason, TimeSpan length, EFClient target, EF | --- | --- | --- | | `string` | reason | Reason for banning the player | | `TimeSpan` | length | Duration of the ban | -| [`EFClient`](./sharedlibrarycoredatabasemodels-EFClient) | target | The client to ban | -| [`EFClient`](./sharedlibrarycoredatabasemodels-EFClient) | origin | The client performing the ban | +| [`EFClient`](database/models/EFClient.md) | target | The client to ban | +| [`EFClient`](database/models/EFClient.md) | origin | The client performing the ban | ##### Summary Temporarily ban a player ( default 1 hour ) from the server @@ -347,8 +355,8 @@ public abstract Task Ban(string reason, EFClient target, EFClient origin, bool i | Type | Name | Description | | --- | --- | --- | | `string` | reason | The reason for the ban | -| [`EFClient`](./sharedlibrarycoredatabasemodels-EFClient) | target | The person to ban | -| [`EFClient`](./sharedlibrarycoredatabasemodels-EFClient) | origin | The person who banned the target | +| [`EFClient`](database/models/EFClient.md) | target | The person to ban | +| [`EFClient`](database/models/EFClient.md) | origin | The person who banned the target | | `bool` | isEvade | obsolete | ##### Summary @@ -362,8 +370,8 @@ public abstract Task Warn(string reason, EFClient target, EFClient origin) | Type | Name | Description | | --- | --- | --- | | `string` | reason | | -| [`EFClient`](./sharedlibrarycoredatabasemodels-EFClient) | target | | -| [`EFClient`](./sharedlibrarycoredatabasemodels-EFClient) | origin | | +| [`EFClient`](database/models/EFClient.md) | target | | +| [`EFClient`](database/models/EFClient.md) | origin | | #### Unban ```csharp @@ -373,8 +381,8 @@ public abstract Task Unban(string reason, EFClient targetClient, EFClient origin | Type | Name | Description | | --- | --- | --- | | `string` | reason | reason for unban | -| [`EFClient`](./sharedlibrarycoredatabasemodels-EFClient) | targetClient | client being unbanned | -| [`EFClient`](./sharedlibrarycoredatabasemodels-EFClient) | originClient | client performing the unban | +| [`EFClient`](database/models/EFClient.md) | targetClient | client being unbanned | +| [`EFClient`](database/models/EFClient.md) | originClient | client performing the unban | ##### Summary Unban a player by npID / GUID @@ -402,6 +410,7 @@ public abstract void InitializeTokens() Initalize the macro variables #### InitializeAutoMessages +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Server.cs#L407) ```csharp protected void InitializeAutoMessages() ``` @@ -409,6 +418,7 @@ protected void InitializeAutoMessages() Initialize the messages to be broadcasted #### ToString +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Server.cs#L419) ```csharp public override string ToString() ``` @@ -425,9 +435,10 @@ public abstract Task GetIdForServer(Server server) ##### Arguments | Type | Name | Description | | --- | --- | --- | -| [`Server`](sharedlibrarycore-Server) | server | | +| [`Server`](sharedlibrarycore/Server.md) | server | | #### GetClientByNumber +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Server.cs#L16707566) ```csharp public EFClient GetClientByNumber(int clientNumber) ``` diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycore-Utilities.md b/CodeDocumentation/SharedLibraryCore/Utilities.md similarity index 73% rename from CodeDocumentation/SharedLibraryCore/sharedlibrarycore-Utilities.md rename to CodeDocumentation/SharedLibraryCore/Utilities.md index 86690ec..d4f8a8b 100644 --- a/CodeDocumentation/SharedLibraryCore/sharedlibrarycore-Utilities.md +++ b/CodeDocumentation/SharedLibraryCore/Utilities.md @@ -28,7 +28,7 @@ | --- | --- | | `IServiceCollection` | [`AddConfiguration`](#addconfiguration)(`IServiceCollection` serviceCollection, `string` fileName, `TConfigurationType` defaultConfig) | | `double``[]` | [`AngleStuff`](#anglestuff)(`Vector3` a, `Vector3` b) | -| [`EFClient`](./sharedlibrarycoredatabasemodels-EFClient) | [`AsConsoleClient`](#asconsoleclient)([`IGameServer`](./sharedlibrarycoreinterfaces-IGameServer) server) | +| [`EFClient`](database/models/EFClient.md) | [`AsConsoleClient`](#asconsoleclient)([`IGameServer`](interfaces/IGameServer.md) server) | | `string` | [`CapClientName`](#capclientname)(`string` name, `int` maxLength)
caps client name to the specified character length - 3
and adds ellipses to the end of the remaining client name | | `long` | [`ConvertGuidToLong`](#convertguidtolong-12)(`...`) | | `string` | [`ConvertIPtoString`](#convertiptostring)(`Nullable`<`int`> ip) | @@ -37,41 +37,41 @@ | `Dictionary`<`string`, `string`> | [`DictionaryFromKeyValue`](#dictionaryfromkeyvalue)(`string` eventLine) | | `void` | [`ExecuteAfterDelay`](#executeafterdelay-13)(`...`) | | `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)
replaces any directory separator chars with the platform specific character | | `Vector3` | [`FixIW4Angles`](#fixiw4angles)(`Vector3` vector) | | `string` | [`FixIW4ForwardSlash`](#fixiw4forwardslash)(`string` str)
returns a "fixed" string that prevents message truncation in IW4 (and probably other Q3 clients) | | `string` | [`FormatExt`](#formatext)(`string` input, `object``[]` values) | -| `string` | [`FormatMessageForEngine`](#formatmessageforengine)(`string` str, [`IRConParserConfiguration`](./sharedlibrarycoreinterfaces-IRConParserConfiguration) config) | +| `string` | [`FormatMessageForEngine`](#formatmessageforengine)(`string` str, [`IRConParserConfiguration`](interfaces/IRConParserConfiguration.md) config) | | `string``[]` | [`FragmentMessageForDisplay`](#fragmentmessagefordisplay)(`string` message) | | `long` | [`GenerateGuidFromString`](#generateguidfromstring)(`string` value)
generates a numerical hashcode from a string value | | `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)()
retrieves the external IP address of the current running machine | | `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)
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) | -| `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)() | | `string` | [`GetVersionAsString`](#getversionasstring)() | | `bool` | [`HasPermission`](#haspermission-12)(`...`) | | `string` | [`HumanizeForCurrentCulture`](#humanizeforcurrentculture-12)(`...`)
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)
determines if the guid provided appears to be a bot guid
"1277538174" - (Pluto?)WaW (T4) | | `bool` | [`IsBroadcastCommand`](#isbroadcastcommand)(`string` str, `string` broadcastCommandPrefix) | -| `bool` | [`IsCodGame`](#iscodgame)([`Server`](./sharedlibrarycore-Server) server) | +| `bool` | [`IsCodGame`](#iscodgame)([`Server`](./Server.md) server) | | `bool` | [`IsInternal`](#isinternal)(`IPAddress` toTest)
https://stackoverflow.com/questions/8113546/how-to-determine-whether-an-ip-address-in-private/39120248
An extension method to determine if an IP address is internal, as specified in RFC1918 | -| `bool` | [`IsPrivileged`](#isprivileged)([`EFClient`](./sharedlibrarycoredatabasemodels-EFClient) p)
Helper extension that determines if a user is a privileged client | +| `bool` | [`IsPrivileged`](#isprivileged)([`EFClient`](database/models/EFClient.md) p)
Helper extension that determines if a user is a privileged client | | `bool` | [`IsQuickMessage`](#isquickmessage)(`string` message)
Determines if the given message is a quick message | | `bool` | [`IsRemoteLog`](#isremotelog)(`string` log)
indicates if the given log path is a remote (http) uri | -| `bool` | [`IsZombieServer`](#iszombieserver)([`Server`](./sharedlibrarycore-Server) server)
indicates if the given server is running a zombie game mode | +| `bool` | [`IsZombieServer`](#iszombieserver)([`Server`](./Server.md) server)
indicates if the given server is running a zombie game mode | | `PenaltyType``[]` | [`LinkedPenaltyTypes`](#linkedpenaltytypes)()
returns a list of penalty types that should be shown across all profiles | | `string` | [`MakeAbbreviation`](#makeabbreviation)(`string` gameName) | | `Permission` | [`MatchPermission`](#matchpermission)(`string` str) | | `TimeSpan` | [`ParseTimespan`](#parsetimespan)(`string` input) | -| `Task`<`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)
prompt user to answer a yes/no question | | `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) | @@ -80,18 +80,18 @@ | `string` | [`RemoveWords`](#removewords)(`string` str, `int` num) | | `Task` | [`SetDvarAsync`](#setdvarasync-12)(`...`) | | `bool` | [`ShouldHideLevel`](#shouldhidelevel)(`Permission` perm) | -| [`WebfrontTranslationHelper`](./sharedlibrarycoredtosmeta-WebfrontTranslationHelper)`[]` | [`SplitTranslationTokens`](#splittranslationtokens)(`string` translationKey)
parses translation string into tokens that are able to be formatted by the webfront | +| [`WebfrontTranslationHelper`](dtos/meta/WebfrontTranslationHelper.md)`[]` | [`SplitTranslationTokens`](#splittranslationtokens)(`string` translationKey)
parses translation string into tokens that are able to be formatted by the webfront | | `string` | [`StripColors`](#stripcolors)(`string` str)
Remove all IW Engine color codes | | `string` | [`ToBase64UrlSafeString`](#tobase64urlsafestring)(`string` src) | | `float` | [`ToDegrees`](#todegrees)(`float` value) | | `string` | [`ToLocalizedLevelName`](#tolocalizedlevelname)(`Permission` permission) | | `string` | [`ToNumericalString`](#tonumericalstring-14)(`...`) | -| [`EFClient`](./sharedlibrarycoredatabasemodels-EFClient) | [`ToPartialClient`](#topartialclient)(`EFClient` client) | +| [`EFClient`](database/models/EFClient.md) | [`ToPartialClient`](#topartialclient)(`EFClient` client) | | `float` | [`ToRadians`](#toradians)(`float` value) | | `string` | [`ToStandardFormat`](#tostandardformat-12)(`...`) | -| `string` | [`ToTranslatedName`](#totranslatedname)([`MetaType`](./sharedlibrarycoreinterfaces-MetaType) metaType) | +| `string` | [`ToTranslatedName`](#totranslatedname)([`MetaType`](interfaces/MetaType.md) metaType) | | `string` | [`TrimNewLine`](#trimnewline)(`string` str)
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` | [`WithWaitCancellation`](#withwaitcancellation-12)(`...`)
https://www.planetgeek.ch/2016/12/08/async-method-without-cancellation-support-do-it-my-way/ | @@ -104,6 +104,7 @@ ## Details ### Methods #### ToStandardFormat [1/2] +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Utilities.cs#L53) ```csharp public static string ToStandardFormat(Nullable time) ``` @@ -113,6 +114,7 @@ public static string ToStandardFormat(Nullable time) | `Nullable`<`DateTime`> | time | | #### ToStandardFormat [2/2] +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Utilities.cs#L54) ```csharp public static string ToStandardFormat(DateTime time) ``` @@ -122,24 +124,27 @@ public static string ToStandardFormat(DateTime time) | `DateTime` | time | | #### IW4MAdminClient +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Utilities.cs#L57) ```csharp public static EFClient IW4MAdminClient(Server server) ``` ##### Arguments | Type | Name | Description | | --- | --- | --- | -| [`Server`](./sharedlibrarycore-Server) | server | | +| [`Server`](./Server.md) | server | | #### AsConsoleClient +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Utilities.cs#L73) ```csharp public static EFClient AsConsoleClient(IGameServer server) ``` ##### Arguments | Type | Name | Description | | --- | --- | --- | -| [`IGameServer`](./sharedlibrarycoreinterfaces-IGameServer) | server | | +| [`IGameServer`](interfaces/IGameServer.md) | server | | #### RemoveWords +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Utilities.cs#L97) ```csharp public static string RemoveWords(string str, int num) ``` @@ -150,6 +155,7 @@ public static string RemoveWords(string str, int num) | `int` | num | | #### CapClientName +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Utilities.cs#L123) ```csharp public static string CapClientName(string name, int maxLength) ``` @@ -167,6 +173,7 @@ caps client name to the specified character length - 3 #### MatchPermission +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Utilities.cs#L133) ```csharp public static Permission MatchPermission(string str) ``` @@ -176,6 +183,7 @@ public static Permission MatchPermission(string str) | `string` | str | | #### StripColors +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Utilities.cs#L153) ```csharp public static string StripColors(string str) ``` @@ -191,6 +199,7 @@ Remove all IW Engine color codes #### FixIW4ForwardSlash +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Utilities.cs#L170) ```csharp public static string FixIW4ForwardSlash(string str) ``` @@ -206,6 +215,7 @@ returns a "fixed" string that prevents message truncation in IW4 (and probably o #### RemoveDiacritics +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Utilities.cs#L175) ```csharp public static string RemoveDiacritics(string text) ``` @@ -215,6 +225,7 @@ public static string RemoveDiacritics(string text) | `string` | text | | #### FormatMessageForEngine +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Utilities.cs#L191) ```csharp public static string FormatMessageForEngine(string str, IRConParserConfiguration config) ``` @@ -222,16 +233,17 @@ public static string FormatMessageForEngine(string str, IRConParserConfiguration | Type | Name | Description | | --- | --- | --- | | `string` | str | | -| [`IRConParserConfiguration`](./sharedlibrarycoreinterfaces-IRConParserConfiguration) | config | | +| [`IRConParserConfiguration`](interfaces/IRConParserConfiguration.md) | config | | #### IsZombieServer +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Utilities.cs#L223) ```csharp public static bool IsZombieServer(Server server) ``` ##### Arguments | Type | Name | Description | | --- | --- | --- | -| [`Server`](./sharedlibrarycore-Server) | server | | +| [`Server`](./Server.md) | server | | ##### Summary indicates if the given server is running a zombie game mode @@ -240,15 +252,17 @@ indicates if the given server is running a zombie game mode #### IsCodGame +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Utilities.cs#L229) ```csharp public static bool IsCodGame(Server server) ``` ##### Arguments | Type | Name | Description | | --- | --- | --- | -| [`Server`](./sharedlibrarycore-Server) | server | | +| [`Server`](./Server.md) | server | | #### ConvertLevelToColor +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Utilities.cs#L240) ```csharp public static string ConvertLevelToColor(Permission level, string localizedLevel) ``` @@ -259,6 +273,7 @@ public static string ConvertLevelToColor(Permission level, string localizedLevel | `string` | localizedLevel | | #### ToLocalizedLevelName +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Utilities.cs#L256) ```csharp public static string ToLocalizedLevelName(Permission permission) ``` @@ -274,11 +289,12 @@ public static async Task ProcessMessageToken(Server server, IList fallback) ``` @@ -315,6 +333,7 @@ public static long ConvertGuidToLong(string str, NumberStyles numberStyle, Nulla | `Nullable`<`long`> | fallback | | #### ConvertGuidToLong [2/2] +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Utilities.cs#L358) ```csharp public static long ConvertGuidToLong(string str, NumberStyles numberStyle, bool convertSigned, Nullable fallback) ``` @@ -327,6 +346,7 @@ public static long ConvertGuidToLong(string str, NumberStyles numberStyle, bool | `Nullable`<`long`> | fallback | | #### IsBotGuid +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Utilities.cs#L419) ```csharp public static bool IsBotGuid(string guid) ``` @@ -343,6 +363,7 @@ determines if the guid provided appears to be a bot guid true if is bot guid, otherwise false #### GenerateGuidFromString +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Utilities.cs#L429) ```csharp public static long GenerateGuidFromString(string value) ``` @@ -358,6 +379,7 @@ generates a numerical hashcode from a string value #### GetStableHashCode +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Utilities.cs#L435) ```csharp public static int GetStableHashCode(string str) ``` @@ -367,6 +389,7 @@ public static int GetStableHashCode(string str) | `string` | str | | #### ConvertToIP +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Utilities.cs#L457) ```csharp public static Nullable ConvertToIP(string str) ``` @@ -376,6 +399,7 @@ public static Nullable ConvertToIP(string str) | `string` | str | | #### ConvertIPtoString +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Utilities.cs#L465) ```csharp public static string ConvertIPtoString(Nullable ip) ``` @@ -385,6 +409,7 @@ public static string ConvertIPtoString(Nullable ip) | `Nullable`<`int`> | ip | | #### GetGame +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Utilities.cs#L470) ```csharp public static Game GetGame(string gameName) ``` @@ -394,6 +419,7 @@ public static Game GetGame(string gameName) | `string` | gameName | | #### ParseTimespan +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Utilities.cs#L510) ```csharp public static TimeSpan ParseTimespan(string input) ``` @@ -403,6 +429,7 @@ public static TimeSpan ParseTimespan(string input) | `string` | input | | #### HasPermission [1/2] +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Utilities.cs#L16707566) ```csharp public static bool HasPermission(IEnumerable permissionsSet, TEntity entity, TPermission permission) where TEntity : Enum @@ -416,6 +443,7 @@ where TPermission : Enum | `TPermission` | permission | | #### HasPermission [2/2] +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Utilities.cs#L589) ```csharp public static bool HasPermission(ApplicationConfiguration appConfig, Permission permissionLevel, TEntity entity, TPermission permission) where TEntity : Enum @@ -424,12 +452,13 @@ where TPermission : Enum ##### Arguments | Type | Name | Description | | --- | --- | --- | -| [`ApplicationConfiguration`](./sharedlibrarycoreconfiguration-ApplicationConfiguration) | appConfig | | +| [`ApplicationConfiguration`](configuration/ApplicationConfiguration.md) | appConfig | | | `Permission` | permissionLevel | | | `TEntity` | entity | | | `TPermission` | permission | | #### LinkedPenaltyTypes +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Utilities.cs#L599) ```csharp public static PenaltyType LinkedPenaltyTypes() ``` @@ -440,13 +469,14 @@ returns a list of penalty types that should be shown across all profiles #### IsPrivileged +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Utilities.cs#L616) ```csharp public static bool IsPrivileged(EFClient p) ``` ##### Arguments | Type | Name | Description | | --- | --- | --- | -| [`EFClient`](./sharedlibrarycoredatabasemodels-EFClient) | p | | +| [`EFClient`](database/models/EFClient.md) | p | | ##### Summary Helper extension that determines if a user is a privileged client @@ -455,6 +485,7 @@ Helper extension that determines if a user is a privileged client #### PromptBool +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Utilities.cs#L628) ```csharp public static bool PromptBool(string question, string description, bool defaultValue) ``` @@ -472,6 +503,7 @@ prompt user to answer a yes/no question #### PromptSelection +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Utilities.cs#L645) ```csharp public static Tuple PromptSelection(string question, T defaultValue, string description, T[] selections) where T : @@ -485,6 +517,7 @@ where T : | `T``[]` | selections | | #### PromptInt +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Utilities.cs#L16707566) ```csharp public static int PromptInt(string question, string description, int minValue, int maxValue, Nullable defaultValue) ``` @@ -498,6 +531,7 @@ public static int PromptInt(string question, string description, int minValue, i | `Nullable`<`int`> | defaultValue | | #### PromptString +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Utilities.cs#L16707566) ```csharp public static string PromptString(string question, string description, string defaultValue) ``` @@ -515,6 +549,7 @@ prompt use to enter a string response #### DictionaryFromKeyValue +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Utilities.cs#L738) ```csharp public static Dictionary DictionaryFromKeyValue(string eventLine) ``` @@ -524,6 +559,7 @@ public static Dictionary DictionaryFromKeyValue(string eventLine | `string` | eventLine | | #### GetCommandLine +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Utilities.cs#L761) ```csharp public static string GetCommandLine(int pId) ``` @@ -533,6 +569,7 @@ public static string GetCommandLine(int pId) | `int` | pId | | #### IsRemoteLog +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Utilities.cs#L789) ```csharp public static bool IsRemoteLog(string log) ``` @@ -548,6 +585,7 @@ indicates if the given log path is a remote (http) uri #### ToBase64UrlSafeString +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Utilities.cs#L794) ```csharp public static string ToBase64UrlSafeString(string src) ``` @@ -564,7 +602,7 @@ where T : ##### Arguments | Type | Name | Description | | --- | --- | --- | -| [`Server`](./sharedlibrarycore-Server) | server | | +| [`Server`](./Server.md) | server | | | `string` | dvarName | | | `T` | fallbackValue | | | `CancellationToken` | token | | @@ -577,7 +615,7 @@ where T : ##### Arguments | Type | Name | Description | | --- | --- | --- | -| [`Server`](./sharedlibrarycore-Server) | server | | +| [`Server`](./Server.md) | server | | | `string` | dvarName | | | `T` | fallbackValue | | @@ -589,7 +627,7 @@ where T : ##### Arguments | Type | Name | Description | | --- | --- | --- | -| [`Server`](./sharedlibrarycore-Server) | server | | +| [`Server`](./Server.md) | server | | | `string` | dvarName | | | `string` | infoResponseName | | | `IDictionary`<`string`, `string`> | infoResponse | | @@ -603,7 +641,7 @@ public static async Task SetDvarAsync(Server server, string dvarName, object dva ##### Arguments | Type | Name | Description | | --- | --- | --- | -| [`Server`](./sharedlibrarycore-Server) | server | | +| [`Server`](./Server.md) | server | | | `string` | dvarName | | | `object` | dvarValue | | | `CancellationToken` | token | | @@ -615,7 +653,7 @@ public static async Task SetDvarAsync(Server server, string dvarName, object dva ##### Arguments | Type | Name | Description | | --- | --- | --- | -| [`Server`](./sharedlibrarycore-Server) | server | | +| [`Server`](./Server.md) | server | | | `string` | dvarName | | | `object` | dvarValue | | @@ -626,7 +664,7 @@ public static async Task ExecuteCommandAsync(Server server, string comma ##### Arguments | Type | Name | Description | | --- | --- | --- | -| [`Server`](./sharedlibrarycore-Server) | server | | +| [`Server`](./Server.md) | server | | | `string` | commandName | | | `CancellationToken` | token | | @@ -637,7 +675,7 @@ public static async Task ExecuteCommandAsync(Server server, string comma ##### Arguments | Type | Name | Description | | --- | --- | --- | -| [`Server`](./sharedlibrarycore-Server) | server | | +| [`Server`](./Server.md) | server | | | `string` | commandName | | #### GetStatusAsync @@ -647,7 +685,7 @@ public static async Task GetStatusAsync(Server server, Cancella ##### Arguments | Type | Name | Description | | --- | --- | --- | -| [`Server`](./sharedlibrarycore-Server) | server | | +| [`Server`](./Server.md) | server | | | `CancellationToken` | token | | #### GetInfoAsync @@ -657,20 +695,23 @@ public static async Task> GetInfoAsync(Server server ##### Arguments | Type | Name | Description | | --- | --- | --- | -| [`Server`](./sharedlibrarycore-Server) | server | | +| [`Server`](./Server.md) | server | | | `Nullable`<`TimeSpan`> | delay | | #### GetVersionAsDouble +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Utilities.cs#L901) ```csharp public static double GetVersionAsDouble() ``` #### GetVersionAsString +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Utilities.cs#L908) ```csharp public static string GetVersionAsString() ``` #### FormatExt +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Utilities.cs#L913) ```csharp public static string FormatExt(string input, object[] values) ``` @@ -681,6 +722,7 @@ public static string FormatExt(string input, object[] values) | `object``[]` | values | | #### IsInternal +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Utilities.cs#L940) ```csharp public static bool IsInternal(IPAddress toTest) ``` @@ -707,6 +749,7 @@ retrieves the external IP address of the current running machine #### IsQuickMessage +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Utilities.cs#L986) ```csharp public static bool IsQuickMessage(string message) ``` @@ -722,6 +765,7 @@ Determines if the given message is a quick message true if the #### TrimNewLine +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Utilities.cs#L996) ```csharp public static string TrimNewLine(string str) ``` @@ -737,6 +781,7 @@ trims new line and whitespace from string #### FixIW4Angles +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Utilities.cs#L1001) ```csharp public static Vector3 FixIW4Angles(Vector3 vector) ``` @@ -746,6 +791,7 @@ public static Vector3 FixIW4Angles(Vector3 vector) | `Vector3` | vector | | #### ToRadians +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Utilities.cs#L1010) ```csharp public static float ToRadians(float value) ``` @@ -755,6 +801,7 @@ public static float ToRadians(float value) | `float` | value | | #### ToDegrees +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Utilities.cs#L1015) ```csharp public static float ToDegrees(float value) ``` @@ -764,6 +811,7 @@ public static float ToDegrees(float value) | `float` | value | | #### AngleStuff +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Utilities.cs#L1020) ```csharp public static double AngleStuff(Vector3 a, Vector3 b) ``` @@ -781,7 +829,7 @@ public static async Task TryCreatePenalty(EFPenalty penalty, IEntityServic | Type | Name | Description | | --- | --- | --- | | `EFPenalty` | penalty | | -| [`IEntityService`](./sharedlibrarycoreinterfaces-IEntityServiceT)<`EFPenalty`> | penaltyService | | +| [`IEntityService`](interfaces/IEntityServiceT.md)<`EFPenalty`> | penaltyService | | | `ILogger` | logger | | #### WithWaitCancellation [1/2] @@ -830,6 +878,7 @@ public static async Task WithTimeout(Task task, TimeSpan timeout) | `TimeSpan` | timeout | | #### ShouldHideLevel +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Utilities.cs#L1094) ```csharp public static bool ShouldHideLevel(Permission perm) ``` @@ -839,6 +888,7 @@ public static bool ShouldHideLevel(Permission perm) | `Permission` | perm | | #### SplitTranslationTokens +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Utilities.cs#L1104) ```csharp public static WebfrontTranslationHelper SplitTranslationTokens(string translationKey) ``` @@ -854,6 +904,7 @@ parses translation string into tokens that are able to be formatted by the webfr #### FixDirectoryCharacters +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Utilities.cs#L1156) ```csharp public static string FixDirectoryCharacters(string path) ``` @@ -869,6 +920,7 @@ replaces any directory separator chars with the platform specific character #### HumanizeForCurrentCulture [1/2] +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Utilities.cs#L1169) ```csharp public static string HumanizeForCurrentCulture(TimeSpan timeSpan, int precision, TimeUnit maxUnit, TimeUnit minUnit, string collectionSeparator, bool toWords) ``` @@ -886,6 +938,7 @@ public static string HumanizeForCurrentCulture(TimeSpan timeSpan, int precision, wrapper method for humanizee that uses current current culture #### HumanizeForCurrentCulture [2/2] +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Utilities.cs#L1179) ```csharp public static string HumanizeForCurrentCulture(DateTime input, bool utcDate, Nullable dateToCompareAgainst, CultureInfo culture) ``` @@ -898,15 +951,17 @@ public static string HumanizeForCurrentCulture(DateTime input, bool utcDate, Nul | `CultureInfo` | culture | | #### ToTranslatedName +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Utilities.cs#L1184) ```csharp public static string ToTranslatedName(MetaType metaType) ``` ##### Arguments | Type | Name | Description | | --- | --- | --- | -| [`MetaType`](./sharedlibrarycoreinterfaces-MetaType) | metaType | | +| [`MetaType`](interfaces/MetaType.md) | metaType | | #### ToPartialClient +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Utilities.cs#L1189) ```csharp public static EFClient ToPartialClient(EFClient client) ``` @@ -916,6 +971,7 @@ public static EFClient ToPartialClient(EFClient client) | `EFClient` | client | | #### ToNumericalString [1/4] +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Utilities.cs#L1215) ```csharp public static string ToNumericalString(Nullable value) ``` @@ -925,6 +981,7 @@ public static string ToNumericalString(Nullable value) | `Nullable`<`int`> | value | | #### ToNumericalString [2/4] +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Utilities.cs#L1220) ```csharp public static string ToNumericalString(int value) ``` @@ -934,6 +991,7 @@ public static string ToNumericalString(int value) | `int` | value | | #### ToNumericalString [3/4] +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Utilities.cs#L1225) ```csharp public static string ToNumericalString(double value, int precision) ``` @@ -944,6 +1002,7 @@ public static string ToNumericalString(double value, int precision) | `int` | precision | | #### ToNumericalString [4/4] +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Utilities.cs#L1232) ```csharp public static string ToNumericalString(Nullable value, int precision) ``` @@ -954,6 +1013,7 @@ public static string ToNumericalString(Nullable value, int precision) | `int` | precision | | #### FragmentMessageForDisplay +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Utilities.cs#L1237) ```csharp public static string FragmentMessageForDisplay(string message) ``` @@ -963,6 +1023,7 @@ public static string FragmentMessageForDisplay(string message) | `string` | message | | #### FindRuleForReason +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Utilities.cs#L16707566) ```csharp public static string FindRuleForReason(string reason, ApplicationConfiguration appConfig, Server server) ``` @@ -970,10 +1031,11 @@ public static string FindRuleForReason(string reason, ApplicationConfiguration a | Type | Name | Description | | --- | --- | --- | | `string` | reason | | -| [`ApplicationConfiguration`](./sharedlibrarycoreconfiguration-ApplicationConfiguration) | appConfig | | -| [`Server`](./sharedlibrarycore-Server) | server | | +| [`ApplicationConfiguration`](configuration/ApplicationConfiguration.md) | appConfig | | +| [`Server`](./Server.md) | server | | #### MakeAbbreviation +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Utilities.cs#L1294) ```csharp public static string MakeAbbreviation(string gameName) ``` @@ -983,6 +1045,7 @@ public static string MakeAbbreviation(string gameName) | `string` | gameName | | #### AddConfiguration +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Utilities.cs#L16707566) ```csharp public static IServiceCollection AddConfiguration(IServiceCollection serviceCollection, string fileName, TConfigurationType defaultConfig) where TConfigurationType : @@ -995,6 +1058,7 @@ where TConfigurationType : | `TConfigurationType` | defaultConfig | | #### ExecuteAfterDelay [1/3] +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Utilities.cs#L1337) ```csharp public static void ExecuteAfterDelay(TimeSpan duration, Func action, CancellationToken token) ``` @@ -1006,6 +1070,7 @@ public static void ExecuteAfterDelay(TimeSpan duration, Func action, CancellationToken token) ``` @@ -1017,6 +1082,7 @@ public static void ExecuteAfterDelay(int delayMs, Func | `CancellationToken` | token | | #### ExecuteAfterDelay [3/3] +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Utilities.cs#L1359) ```csharp public static void ExecuteAfterDelay(Func action, int delayMs, CancellationToken token) ``` @@ -1028,11 +1094,13 @@ public static void ExecuteAfterDelay(Func action, int d | `CancellationToken` | token | | #### g__InputOrDefault|55_0 +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Utilities.cs#L690) ```csharp internal static string g__InputOrDefault|55_0() ``` #### g__InputOrDefault|56_0 +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Utilities.cs#L721) ```csharp internal static string g__InputOrDefault|56_0() ``` diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycorealerts-Alert.md b/CodeDocumentation/SharedLibraryCore/alerts/Alert.md similarity index 100% rename from CodeDocumentation/SharedLibraryCore/sharedlibrarycorealerts-Alert.md rename to CodeDocumentation/SharedLibraryCore/alerts/Alert.md diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycorealertsalert-AlertCategory.md b/CodeDocumentation/SharedLibraryCore/alerts/alert/AlertCategory.md similarity index 100% rename from CodeDocumentation/SharedLibraryCore/sharedlibrarycorealertsalert-AlertCategory.md rename to CodeDocumentation/SharedLibraryCore/alerts/alert/AlertCategory.md diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycorealertsalert-AlertState.md b/CodeDocumentation/SharedLibraryCore/alerts/alert/AlertState.md similarity index 91% rename from CodeDocumentation/SharedLibraryCore/sharedlibrarycorealertsalert-AlertState.md rename to CodeDocumentation/SharedLibraryCore/alerts/alert/AlertState.md index c320c88..3737b30 100644 --- a/CodeDocumentation/SharedLibraryCore/sharedlibrarycorealertsalert-AlertState.md +++ b/CodeDocumentation/SharedLibraryCore/alerts/alert/AlertState.md @@ -38,12 +38,14 @@ ## Details ### Constructors #### AlertState +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Alerts/Alert.cs#L18) ```csharp public AlertState() ``` ### Methods #### Build +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Alerts/Alert.cs#L31) ```csharp public static AlertState Build() ``` diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycorecommands-BanCommand.md b/CodeDocumentation/SharedLibraryCore/commands/BanCommand.md similarity index 67% rename from CodeDocumentation/SharedLibraryCore/sharedlibrarycorecommands-BanCommand.md rename to CodeDocumentation/SharedLibraryCore/commands/BanCommand.md index a4e78aa..9814de4 100644 --- a/CodeDocumentation/SharedLibraryCore/sharedlibrarycorecommands-BanCommand.md +++ b/CodeDocumentation/SharedLibraryCore/commands/BanCommand.md @@ -23,7 +23,7 @@ SharedLibraryCore.Command --> SharedLibraryCore.Commands.BanCommand #### Public methods | Returns | Name | | --- | --- | -| `Task` | [`ExecuteAsync`](#executeasync)([`GameEvent`](./sharedlibrarycore-GameEvent) gameEvent) | +| `Task` | [`ExecuteAsync`](#executeasync)([`GameEvent`](../GameEvent.md) gameEvent) | ## Details ### Summary @@ -32,19 +32,20 @@ Permanently bans a client ### Inheritance - [ `Command` -](./sharedlibrarycore-Command) +](../Command.md) ### Constructors #### BanCommand +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Commands/NativeCommands.cs#L308) ```csharp public BanCommand(ApplicationConfiguration appConfig, CommandConfiguration config, ITranslationLookup translationLookup) ``` ##### Arguments | Type | Name | Description | | --- | --- | --- | -| [`ApplicationConfiguration`](./sharedlibrarycoreconfiguration-ApplicationConfiguration) | appConfig | | -| [`CommandConfiguration`](./sharedlibrarycoreconfiguration-CommandConfiguration) | config | | -| [`ITranslationLookup`](./sharedlibrarycoreinterfaces-ITranslationLookup) | translationLookup | | +| [`ApplicationConfiguration`](../configuration/ApplicationConfiguration.md) | appConfig | | +| [`CommandConfiguration`](../configuration/CommandConfiguration.md) | config | | +| [`ITranslationLookup`](../interfaces/ITranslationLookup.md) | translationLookup | | ### Methods #### ExecuteAsync @@ -54,6 +55,6 @@ public override async Task ExecuteAsync(GameEvent gameEvent) ##### Arguments | Type | Name | Description | | --- | --- | --- | -| [`GameEvent`](./sharedlibrarycore-GameEvent) | gameEvent | | +| [`GameEvent`](../GameEvent.md) | gameEvent | | *Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycorecommands-CommandArgument.md b/CodeDocumentation/SharedLibraryCore/commands/CommandArgument.md similarity index 100% rename from CodeDocumentation/SharedLibraryCore/sharedlibrarycorecommands-CommandArgument.md rename to CodeDocumentation/SharedLibraryCore/commands/CommandArgument.md diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycorecommands-CommandExtensions.md b/CodeDocumentation/SharedLibraryCore/commands/CommandExtensions.md similarity index 68% rename from CodeDocumentation/SharedLibraryCore/sharedlibrarycorecommands-CommandExtensions.md rename to CodeDocumentation/SharedLibraryCore/commands/CommandExtensions.md index 575683e..f427463 100644 --- a/CodeDocumentation/SharedLibraryCore/sharedlibrarycorecommands-CommandExtensions.md +++ b/CodeDocumentation/SharedLibraryCore/commands/CommandExtensions.md @@ -15,27 +15,29 @@ #### Public Static methods | Returns | Name | | --- | --- | -| `bool` | [`CanPerformActionOnTarget`](#canperformactionontarget)([`GameEvent`](./sharedlibrarycore-GameEvent) gameEvent) | -| `bool` | [`IsTargetingSelf`](#istargetingself)([`GameEvent`](./sharedlibrarycore-GameEvent) gameEvent) | +| `bool` | [`CanPerformActionOnTarget`](#canperformactionontarget)([`GameEvent`](../GameEvent.md) gameEvent) | +| `bool` | [`IsTargetingSelf`](#istargetingself)([`GameEvent`](../GameEvent.md) gameEvent) | ## Details ### Methods #### IsTargetingSelf +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Commands/CommandExtensions.cs#L6) ```csharp public static bool IsTargetingSelf(GameEvent gameEvent) ``` ##### Arguments | Type | Name | Description | | --- | --- | --- | -| [`GameEvent`](./sharedlibrarycore-GameEvent) | gameEvent | | +| [`GameEvent`](../GameEvent.md) | gameEvent | | #### CanPerformActionOnTarget +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Commands/CommandExtensions.cs#L11) ```csharp public static bool CanPerformActionOnTarget(GameEvent gameEvent) ``` ##### Arguments | Type | Name | Description | | --- | --- | --- | -| [`GameEvent`](./sharedlibrarycore-GameEvent) | gameEvent | | +| [`GameEvent`](../GameEvent.md) | gameEvent | | *Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycorecommands-CommandProcessing.md b/CodeDocumentation/SharedLibraryCore/commands/CommandProcessing.md similarity index 55% rename from CodeDocumentation/SharedLibraryCore/sharedlibrarycorecommands-CommandProcessing.md rename to CodeDocumentation/SharedLibraryCore/commands/CommandProcessing.md index 02ef6bb..0e99412 100644 --- a/CodeDocumentation/SharedLibraryCore/sharedlibrarycorecommands-CommandProcessing.md +++ b/CodeDocumentation/SharedLibraryCore/commands/CommandProcessing.md @@ -15,7 +15,7 @@ #### Public Static methods | 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 ### Constructors @@ -32,8 +32,8 @@ public static async Task ValidateCommand(GameEvent gameEvent, Applicati ##### Arguments | Type | Name | Description | | --- | --- | --- | -| [`GameEvent`](./sharedlibrarycore-GameEvent) | gameEvent | | -| [`ApplicationConfiguration`](./sharedlibrarycoreconfiguration-ApplicationConfiguration) | appConfig | | -| [`CommandConfiguration`](./sharedlibrarycoreconfiguration-CommandConfiguration) | commandConfig | | +| [`GameEvent`](../GameEvent.md) | gameEvent | | +| [`ApplicationConfiguration`](../configuration/ApplicationConfiguration.md) | appConfig | | +| [`CommandConfiguration`](../configuration/CommandConfiguration.md) | commandConfig | | *Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycorecommands-ExecuteRConCommand.md b/CodeDocumentation/SharedLibraryCore/commands/ExecuteRConCommand.md similarity index 72% rename from CodeDocumentation/SharedLibraryCore/sharedlibrarycorecommands-ExecuteRConCommand.md rename to CodeDocumentation/SharedLibraryCore/commands/ExecuteRConCommand.md index be1d6aa..a84977a 100644 --- a/CodeDocumentation/SharedLibraryCore/sharedlibrarycorecommands-ExecuteRConCommand.md +++ b/CodeDocumentation/SharedLibraryCore/commands/ExecuteRConCommand.md @@ -23,7 +23,7 @@ SharedLibraryCore.Command --> SharedLibraryCore.Commands.ExecuteRConCommand #### Public methods | Returns | Name | | --- | --- | -| `Task` | [`ExecuteAsync`](#executeasync)([`GameEvent`](./sharedlibrarycore-GameEvent) E) | +| `Task` | [`ExecuteAsync`](#executeasync)([`GameEvent`](../GameEvent.md) E) | ## Details ### Summary @@ -32,18 +32,19 @@ Executes RCon command ### Inheritance - [ `Command` -](./sharedlibrarycore-Command) +](../Command.md) ### Constructors #### ExecuteRConCommand +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Commands/NativeCommands.cs#L927) ```csharp public ExecuteRConCommand(CommandConfiguration config, ITranslationLookup translationLookup) ``` ##### Arguments | Type | Name | Description | | --- | --- | --- | -| [`CommandConfiguration`](./sharedlibrarycoreconfiguration-CommandConfiguration) | config | | -| [`ITranslationLookup`](./sharedlibrarycoreinterfaces-ITranslationLookup) | translationLookup | | +| [`CommandConfiguration`](../configuration/CommandConfiguration.md) | config | | +| [`ITranslationLookup`](../interfaces/ITranslationLookup.md) | translationLookup | | ### Methods #### ExecuteAsync @@ -53,6 +54,6 @@ public override async Task ExecuteAsync(GameEvent E) ##### Arguments | Type | Name | Description | | --- | --- | --- | -| [`GameEvent`](./sharedlibrarycore-GameEvent) | E | | +| [`GameEvent`](../GameEvent.md) | E | | *Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycorecommands-FastRestartCommand.md b/CodeDocumentation/SharedLibraryCore/commands/FastRestartCommand.md similarity index 72% rename from CodeDocumentation/SharedLibraryCore/sharedlibrarycorecommands-FastRestartCommand.md rename to CodeDocumentation/SharedLibraryCore/commands/FastRestartCommand.md index 237a0ef..ed83313 100644 --- a/CodeDocumentation/SharedLibraryCore/sharedlibrarycorecommands-FastRestartCommand.md +++ b/CodeDocumentation/SharedLibraryCore/commands/FastRestartCommand.md @@ -23,7 +23,7 @@ SharedLibraryCore.Command --> SharedLibraryCore.Commands.FastRestartCommand #### Public methods | Returns | Name | | --- | --- | -| `Task` | [`ExecuteAsync`](#executeasync)([`GameEvent`](./sharedlibrarycore-GameEvent) E) | +| `Task` | [`ExecuteAsync`](#executeasync)([`GameEvent`](../GameEvent.md) E) | ## Details ### Summary @@ -32,18 +32,19 @@ Fast restarts the map ### Inheritance - [ `Command` -](./sharedlibrarycore-Command) +](../Command.md) ### Constructors #### FastRestartCommand +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Commands/NativeCommands.cs#L413) ```csharp public FastRestartCommand(CommandConfiguration config, ITranslationLookup translationLookup) ``` ##### Arguments | Type | Name | Description | | --- | --- | --- | -| [`CommandConfiguration`](./sharedlibrarycoreconfiguration-CommandConfiguration) | config | | -| [`ITranslationLookup`](./sharedlibrarycoreinterfaces-ITranslationLookup) | translationLookup | | +| [`CommandConfiguration`](../configuration/CommandConfiguration.md) | config | | +| [`ITranslationLookup`](../interfaces/ITranslationLookup.md) | translationLookup | | ### Methods #### ExecuteAsync @@ -53,6 +54,6 @@ public override async Task ExecuteAsync(GameEvent E) ##### Arguments | Type | Name | Description | | --- | --- | --- | -| [`GameEvent`](./sharedlibrarycore-GameEvent) | E | | +| [`GameEvent`](../GameEvent.md) | E | | *Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycorecommands-FlagClientCommand.md b/CodeDocumentation/SharedLibraryCore/commands/FlagClientCommand.md similarity index 72% rename from CodeDocumentation/SharedLibraryCore/sharedlibrarycorecommands-FlagClientCommand.md rename to CodeDocumentation/SharedLibraryCore/commands/FlagClientCommand.md index 0bb38d2..0021c12 100644 --- a/CodeDocumentation/SharedLibraryCore/sharedlibrarycorecommands-FlagClientCommand.md +++ b/CodeDocumentation/SharedLibraryCore/commands/FlagClientCommand.md @@ -23,7 +23,7 @@ SharedLibraryCore.Command --> SharedLibraryCore.Commands.FlagClientCommand #### Public methods | Returns | Name | | --- | --- | -| `Task` | [`ExecuteAsync`](#executeasync)([`GameEvent`](./sharedlibrarycore-GameEvent) E) | +| `Task` | [`ExecuteAsync`](#executeasync)([`GameEvent`](../GameEvent.md) E) | ## Details ### Summary @@ -32,18 +32,19 @@ Flag given client for specified reason ### Inheritance - [ `Command` -](./sharedlibrarycore-Command) +](../Command.md) ### Constructors #### FlagClientCommand +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Commands/NativeCommands.cs#L748) ```csharp public FlagClientCommand(CommandConfiguration config, ITranslationLookup translationLookup) ``` ##### Arguments | Type | Name | Description | | --- | --- | --- | -| [`CommandConfiguration`](./sharedlibrarycoreconfiguration-CommandConfiguration) | config | | -| [`ITranslationLookup`](./sharedlibrarycoreinterfaces-ITranslationLookup) | translationLookup | | +| [`CommandConfiguration`](../configuration/CommandConfiguration.md) | config | | +| [`ITranslationLookup`](../interfaces/ITranslationLookup.md) | translationLookup | | ### Methods #### ExecuteAsync @@ -53,6 +54,6 @@ public override async Task ExecuteAsync(GameEvent E) ##### Arguments | Type | Name | Description | | --- | --- | --- | -| [`GameEvent`](./sharedlibrarycore-GameEvent) | E | | +| [`GameEvent`](../GameEvent.md) | E | | *Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycorecommands-GetClientPingCommand.md b/CodeDocumentation/SharedLibraryCore/commands/GetClientPingCommand.md similarity index 67% rename from CodeDocumentation/SharedLibraryCore/sharedlibrarycorecommands-GetClientPingCommand.md rename to CodeDocumentation/SharedLibraryCore/commands/GetClientPingCommand.md index fea7b38..b99e08c 100644 --- a/CodeDocumentation/SharedLibraryCore/sharedlibrarycorecommands-GetClientPingCommand.md +++ b/CodeDocumentation/SharedLibraryCore/commands/GetClientPingCommand.md @@ -23,7 +23,7 @@ SharedLibraryCore.Command --> SharedLibraryCore.Commands.GetClientPingCommand #### Public methods | Returns | Name | | --- | --- | -| `Task` | [`ExecuteAsync`](#executeasync)([`GameEvent`](./sharedlibrarycore-GameEvent) E) | +| `Task` | [`ExecuteAsync`](#executeasync)([`GameEvent`](../GameEvent.md) E) | ## Details ### Summary @@ -32,27 +32,29 @@ Gets the ping of a client ### Inheritance - [ `Command` -](./sharedlibrarycore-Command) +](../Command.md) ### Constructors #### GetClientPingCommand +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Commands/NativeCommands.cs#L1093) ```csharp public GetClientPingCommand(CommandConfiguration config, ITranslationLookup translationLookup) ``` ##### Arguments | Type | Name | Description | | --- | --- | --- | -| [`CommandConfiguration`](./sharedlibrarycoreconfiguration-CommandConfiguration) | config | | -| [`ITranslationLookup`](./sharedlibrarycoreinterfaces-ITranslationLookup) | translationLookup | | +| [`CommandConfiguration`](../configuration/CommandConfiguration.md) | config | | +| [`ITranslationLookup`](../interfaces/ITranslationLookup.md) | translationLookup | | ### Methods #### ExecuteAsync +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Commands/NativeCommands.cs#L1112) ```csharp public override Task ExecuteAsync(GameEvent E) ``` ##### Arguments | Type | Name | Description | | --- | --- | --- | -| [`GameEvent`](./sharedlibrarycore-GameEvent) | E | | +| [`GameEvent`](../GameEvent.md) | E | | *Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycorecommands-KickCommand.md b/CodeDocumentation/SharedLibraryCore/commands/KickCommand.md similarity index 67% rename from CodeDocumentation/SharedLibraryCore/sharedlibrarycorecommands-KickCommand.md rename to CodeDocumentation/SharedLibraryCore/commands/KickCommand.md index f367105..917587a 100644 --- a/CodeDocumentation/SharedLibraryCore/sharedlibrarycorecommands-KickCommand.md +++ b/CodeDocumentation/SharedLibraryCore/commands/KickCommand.md @@ -23,7 +23,7 @@ SharedLibraryCore.Command --> SharedLibraryCore.Commands.KickCommand #### Public methods | Returns | Name | | --- | --- | -| `Task` | [`ExecuteAsync`](#executeasync)([`GameEvent`](./sharedlibrarycore-GameEvent) gameEvent) | +| `Task` | [`ExecuteAsync`](#executeasync)([`GameEvent`](../GameEvent.md) gameEvent) | ## Details ### Summary @@ -32,19 +32,20 @@ Kicks client for given reason ### Inheritance - [ `Command` -](./sharedlibrarycore-Command) +](../Command.md) ### Constructors #### KickCommand +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Commands/NativeCommands.cs#L185) ```csharp public KickCommand(ApplicationConfiguration appConfig, CommandConfiguration config, ITranslationLookup translationLookup) ``` ##### Arguments | Type | Name | Description | | --- | --- | --- | -| [`ApplicationConfiguration`](./sharedlibrarycoreconfiguration-ApplicationConfiguration) | appConfig | | -| [`CommandConfiguration`](./sharedlibrarycoreconfiguration-CommandConfiguration) | config | | -| [`ITranslationLookup`](./sharedlibrarycoreinterfaces-ITranslationLookup) | translationLookup | | +| [`ApplicationConfiguration`](../configuration/ApplicationConfiguration.md) | appConfig | | +| [`CommandConfiguration`](../configuration/CommandConfiguration.md) | config | | +| [`ITranslationLookup`](../interfaces/ITranslationLookup.md) | translationLookup | | ### Methods #### ExecuteAsync @@ -54,6 +55,6 @@ public override async Task ExecuteAsync(GameEvent gameEvent) ##### Arguments | Type | Name | Description | | --- | --- | --- | -| [`GameEvent`](./sharedlibrarycore-GameEvent) | gameEvent | | +| [`GameEvent`](../GameEvent.md) | gameEvent | | *Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycorecommands-ListBanInfoCommand.md b/CodeDocumentation/SharedLibraryCore/commands/ListBanInfoCommand.md similarity index 72% rename from CodeDocumentation/SharedLibraryCore/sharedlibrarycorecommands-ListBanInfoCommand.md rename to CodeDocumentation/SharedLibraryCore/commands/ListBanInfoCommand.md index b1eb151..7b0f67f 100644 --- a/CodeDocumentation/SharedLibraryCore/sharedlibrarycorecommands-ListBanInfoCommand.md +++ b/CodeDocumentation/SharedLibraryCore/commands/ListBanInfoCommand.md @@ -23,7 +23,7 @@ SharedLibraryCore.Command --> SharedLibraryCore.Commands.ListBanInfoCommand #### Public methods | Returns | Name | | --- | --- | -| `Task` | [`ExecuteAsync`](#executeasync)([`GameEvent`](./sharedlibrarycore-GameEvent) E) | +| `Task` | [`ExecuteAsync`](#executeasync)([`GameEvent`](../GameEvent.md) E) | ## Details ### Summary @@ -32,18 +32,19 @@ Lists ban information for given client ### Inheritance - [ `Command` -](./sharedlibrarycore-Command) +](../Command.md) ### Constructors #### ListBanInfoCommand +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Commands/NativeCommands.cs#L878) ```csharp public ListBanInfoCommand(CommandConfiguration config, ITranslationLookup translationLookup) ``` ##### Arguments | Type | Name | Description | | --- | --- | --- | -| [`CommandConfiguration`](./sharedlibrarycoreconfiguration-CommandConfiguration) | config | | -| [`ITranslationLookup`](./sharedlibrarycoreinterfaces-ITranslationLookup) | translationLookup | | +| [`CommandConfiguration`](../configuration/CommandConfiguration.md) | config | | +| [`ITranslationLookup`](../interfaces/ITranslationLookup.md) | translationLookup | | ### Methods #### ExecuteAsync @@ -53,6 +54,6 @@ public override async Task ExecuteAsync(GameEvent E) ##### Arguments | Type | Name | Description | | --- | --- | --- | -| [`GameEvent`](./sharedlibrarycore-GameEvent) | E | | +| [`GameEvent`](../GameEvent.md) | E | | *Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycorecommands-ListExternalIPCommand.md b/CodeDocumentation/SharedLibraryCore/commands/ListExternalIPCommand.md similarity index 67% rename from CodeDocumentation/SharedLibraryCore/sharedlibrarycorecommands-ListExternalIPCommand.md rename to CodeDocumentation/SharedLibraryCore/commands/ListExternalIPCommand.md index b5ac9ef..d3b6328 100644 --- a/CodeDocumentation/SharedLibraryCore/sharedlibrarycorecommands-ListExternalIPCommand.md +++ b/CodeDocumentation/SharedLibraryCore/commands/ListExternalIPCommand.md @@ -23,7 +23,7 @@ SharedLibraryCore.Command --> SharedLibraryCore.Commands.ListExternalIPCommand #### Public methods | Returns | Name | | --- | --- | -| `Task` | [`ExecuteAsync`](#executeasync)([`GameEvent`](./sharedlibrarycore-GameEvent) E) | +| `Task` | [`ExecuteAsync`](#executeasync)([`GameEvent`](../GameEvent.md) E) | ## Details ### Summary @@ -32,27 +32,29 @@ Lists external IP ### Inheritance - [ `Command` -](./sharedlibrarycore-Command) +](../Command.md) ### Constructors #### ListExternalIPCommand +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Commands/NativeCommands.cs#L963) ```csharp public ListExternalIPCommand(CommandConfiguration config, ITranslationLookup translationLookup) ``` ##### Arguments | Type | Name | Description | | --- | --- | --- | -| [`CommandConfiguration`](./sharedlibrarycoreconfiguration-CommandConfiguration) | config | | -| [`ITranslationLookup`](./sharedlibrarycoreinterfaces-ITranslationLookup) | translationLookup | | +| [`CommandConfiguration`](../configuration/CommandConfiguration.md) | config | | +| [`ITranslationLookup`](../interfaces/ITranslationLookup.md) | translationLookup | | ### Methods #### ExecuteAsync +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Commands/NativeCommands.cs#L974) ```csharp public override Task ExecuteAsync(GameEvent E) ``` ##### Arguments | Type | Name | Description | | --- | --- | --- | -| [`GameEvent`](./sharedlibrarycore-GameEvent) | E | | +| [`GameEvent`](../GameEvent.md) | E | | *Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycorecommands-ListRulesCommands.md b/CodeDocumentation/SharedLibraryCore/commands/ListRulesCommands.md similarity index 71% rename from CodeDocumentation/SharedLibraryCore/sharedlibrarycorecommands-ListRulesCommands.md rename to CodeDocumentation/SharedLibraryCore/commands/ListRulesCommands.md index daae544..8e12065 100644 --- a/CodeDocumentation/SharedLibraryCore/sharedlibrarycorecommands-ListRulesCommands.md +++ b/CodeDocumentation/SharedLibraryCore/commands/ListRulesCommands.md @@ -23,7 +23,7 @@ SharedLibraryCore.Command --> SharedLibraryCore.Commands.ListRulesCommands #### Public methods | Returns | Name | | --- | --- | -| `Task` | [`ExecuteAsync`](#executeasync)([`GameEvent`](./sharedlibrarycore-GameEvent) gameEvent) | +| `Task` | [`ExecuteAsync`](#executeasync)([`GameEvent`](../GameEvent.md) gameEvent) | ## Details ### Summary @@ -32,18 +32,19 @@ Lists server and global rules ### Inheritance - [ `Command` -](./sharedlibrarycore-Command) +](../Command.md) ### Constructors #### ListRulesCommands +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Commands/NativeCommands.cs#L700) ```csharp public ListRulesCommands(CommandConfiguration config, ITranslationLookup translationLookup) ``` ##### Arguments | Type | Name | Description | | --- | --- | --- | -| [`CommandConfiguration`](./sharedlibrarycoreconfiguration-CommandConfiguration) | config | | -| [`ITranslationLookup`](./sharedlibrarycoreinterfaces-ITranslationLookup) | translationLookup | | +| [`CommandConfiguration`](../configuration/CommandConfiguration.md) | config | | +| [`ITranslationLookup`](../interfaces/ITranslationLookup.md) | translationLookup | | ### Methods #### ExecuteAsync @@ -53,6 +54,6 @@ public override async Task ExecuteAsync(GameEvent gameEvent) ##### Arguments | Type | Name | Description | | --- | --- | --- | -| [`GameEvent`](./sharedlibrarycore-GameEvent) | gameEvent | | +| [`GameEvent`](../GameEvent.md) | gameEvent | | *Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycorecommands-LoadMapCommand.md b/CodeDocumentation/SharedLibraryCore/commands/LoadMapCommand.md similarity index 72% rename from CodeDocumentation/SharedLibraryCore/sharedlibrarycorecommands-LoadMapCommand.md rename to CodeDocumentation/SharedLibraryCore/commands/LoadMapCommand.md index 6d895aa..b295218 100644 --- a/CodeDocumentation/SharedLibraryCore/sharedlibrarycorecommands-LoadMapCommand.md +++ b/CodeDocumentation/SharedLibraryCore/commands/LoadMapCommand.md @@ -23,7 +23,7 @@ SharedLibraryCore.Command --> SharedLibraryCore.Commands.LoadMapCommand #### Public methods | Returns | Name | | --- | --- | -| `Task` | [`ExecuteAsync`](#executeasync)([`GameEvent`](./sharedlibrarycore-GameEvent) E) | +| `Task` | [`ExecuteAsync`](#executeasync)([`GameEvent`](../GameEvent.md) E) | ## Details ### Summary @@ -32,18 +32,19 @@ Attempts to load the specified map ### Inheritance - [ `Command` -](./sharedlibrarycore-Command) +](../Command.md) ### Constructors #### LoadMapCommand +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Commands/NativeCommands.cs#L658) ```csharp public LoadMapCommand(CommandConfiguration config, ITranslationLookup translationLookup) ``` ##### Arguments | Type | Name | Description | | --- | --- | --- | -| [`CommandConfiguration`](./sharedlibrarycoreconfiguration-CommandConfiguration) | config | | -| [`ITranslationLookup`](./sharedlibrarycoreinterfaces-ITranslationLookup) | translationLookup | | +| [`CommandConfiguration`](../configuration/CommandConfiguration.md) | config | | +| [`ITranslationLookup`](../interfaces/ITranslationLookup.md) | translationLookup | | ### Methods #### ExecuteAsync @@ -53,6 +54,6 @@ public override async Task ExecuteAsync(GameEvent E) ##### Arguments | Type | Name | Description | | --- | --- | --- | -| [`GameEvent`](./sharedlibrarycore-GameEvent) | E | | +| [`GameEvent`](../GameEvent.md) | E | | *Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycorecommands-MapRotateCommand.md b/CodeDocumentation/SharedLibraryCore/commands/MapRotateCommand.md similarity index 72% rename from CodeDocumentation/SharedLibraryCore/sharedlibrarycorecommands-MapRotateCommand.md rename to CodeDocumentation/SharedLibraryCore/commands/MapRotateCommand.md index 7fda175..f0c6e2c 100644 --- a/CodeDocumentation/SharedLibraryCore/sharedlibrarycorecommands-MapRotateCommand.md +++ b/CodeDocumentation/SharedLibraryCore/commands/MapRotateCommand.md @@ -23,7 +23,7 @@ SharedLibraryCore.Command --> SharedLibraryCore.Commands.MapRotateCommand #### Public methods | Returns | Name | | --- | --- | -| `Task` | [`ExecuteAsync`](#executeasync)([`GameEvent`](./sharedlibrarycore-GameEvent) E) | +| `Task` | [`ExecuteAsync`](#executeasync)([`GameEvent`](../GameEvent.md) E) | ## Details ### Summary @@ -32,18 +32,19 @@ Cycles to the next map in rotation ### Inheritance - [ `Command` -](./sharedlibrarycore-Command) +](../Command.md) ### Constructors #### MapRotateCommand +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Commands/NativeCommands.cs#L439) ```csharp public MapRotateCommand(CommandConfiguration config, ITranslationLookup translationLookup) ``` ##### Arguments | Type | Name | Description | | --- | --- | --- | -| [`CommandConfiguration`](./sharedlibrarycoreconfiguration-CommandConfiguration) | config | | -| [`ITranslationLookup`](./sharedlibrarycoreinterfaces-ITranslationLookup) | translationLookup | | +| [`CommandConfiguration`](../configuration/CommandConfiguration.md) | config | | +| [`ITranslationLookup`](../interfaces/ITranslationLookup.md) | translationLookup | | ### Methods #### ExecuteAsync @@ -53,6 +54,6 @@ public override async Task ExecuteAsync(GameEvent E) ##### Arguments | Type | Name | Description | | --- | --- | --- | -| [`GameEvent`](./sharedlibrarycore-GameEvent) | E | | +| [`GameEvent`](../GameEvent.md) | E | | *Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycorecommands-MaskCommand.md b/CodeDocumentation/SharedLibraryCore/commands/MaskCommand.md similarity index 72% rename from CodeDocumentation/SharedLibraryCore/sharedlibrarycorecommands-MaskCommand.md rename to CodeDocumentation/SharedLibraryCore/commands/MaskCommand.md index b6848b4..a12f44e 100644 --- a/CodeDocumentation/SharedLibraryCore/sharedlibrarycorecommands-MaskCommand.md +++ b/CodeDocumentation/SharedLibraryCore/commands/MaskCommand.md @@ -23,7 +23,7 @@ SharedLibraryCore.Command --> SharedLibraryCore.Commands.MaskCommand #### Public methods | Returns | Name | | --- | --- | -| `Task` | [`ExecuteAsync`](#executeasync)([`GameEvent`](./sharedlibrarycore-GameEvent) E) | +| `Task` | [`ExecuteAsync`](#executeasync)([`GameEvent`](../GameEvent.md) E) | ## Details ### Summary @@ -32,18 +32,19 @@ Masks client from announcements and online admin list ### Inheritance - [ `Command` -](./sharedlibrarycore-Command) +](../Command.md) ### Constructors #### MaskCommand +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Commands/NativeCommands.cs#L846) ```csharp public MaskCommand(CommandConfiguration config, ITranslationLookup translationLookup) ``` ##### Arguments | Type | Name | Description | | --- | --- | --- | -| [`CommandConfiguration`](./sharedlibrarycoreconfiguration-CommandConfiguration) | config | | -| [`ITranslationLookup`](./sharedlibrarycoreinterfaces-ITranslationLookup) | translationLookup | | +| [`CommandConfiguration`](../configuration/CommandConfiguration.md) | config | | +| [`ITranslationLookup`](../interfaces/ITranslationLookup.md) | translationLookup | | ### Methods #### ExecuteAsync @@ -53,6 +54,6 @@ public override async Task ExecuteAsync(GameEvent E) ##### Arguments | Type | Name | Description | | --- | --- | --- | -| [`GameEvent`](./sharedlibrarycore-GameEvent) | E | | +| [`GameEvent`](../GameEvent.md) | E | | *Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycorecommands-MemoryUsageCommand.md b/CodeDocumentation/SharedLibraryCore/commands/MemoryUsageCommand.md similarity index 67% rename from CodeDocumentation/SharedLibraryCore/sharedlibrarycorecommands-MemoryUsageCommand.md rename to CodeDocumentation/SharedLibraryCore/commands/MemoryUsageCommand.md index 85e0fca..2f14df8 100644 --- a/CodeDocumentation/SharedLibraryCore/sharedlibrarycorecommands-MemoryUsageCommand.md +++ b/CodeDocumentation/SharedLibraryCore/commands/MemoryUsageCommand.md @@ -23,7 +23,7 @@ SharedLibraryCore.Command --> SharedLibraryCore.Commands.MemoryUsageCommand #### Public methods | Returns | Name | | --- | --- | -| `Task` | [`ExecuteAsync`](#executeasync)([`GameEvent`](./sharedlibrarycore-GameEvent) E) | +| `Task` | [`ExecuteAsync`](#executeasync)([`GameEvent`](../GameEvent.md) E) | ## Details ### Summary @@ -32,27 +32,29 @@ Prints the amount of memory IW4MAdmin is using ### Inheritance - [ `Command` -](./sharedlibrarycore-Command) +](../Command.md) ### Constructors #### MemoryUsageCommand +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Commands/NativeCommands.cs#L610) ```csharp public MemoryUsageCommand(CommandConfiguration config, ITranslationLookup translationLookup) ``` ##### Arguments | Type | Name | Description | | --- | --- | --- | -| [`CommandConfiguration`](./sharedlibrarycoreconfiguration-CommandConfiguration) | config | | -| [`ITranslationLookup`](./sharedlibrarycoreinterfaces-ITranslationLookup) | translationLookup | | +| [`CommandConfiguration`](../configuration/CommandConfiguration.md) | config | | +| [`ITranslationLookup`](../interfaces/ITranslationLookup.md) | translationLookup | | ### Methods #### ExecuteAsync +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Commands/NativeCommands.cs#L621) ```csharp public override Task ExecuteAsync(GameEvent E) ``` ##### Arguments | Type | Name | Description | | --- | --- | --- | -| [`GameEvent`](./sharedlibrarycore-GameEvent) | E | | +| [`GameEvent`](../GameEvent.md) | E | | *Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycorecommands-NextMapCommand.md b/CodeDocumentation/SharedLibraryCore/commands/NextMapCommand.md similarity index 69% rename from CodeDocumentation/SharedLibraryCore/sharedlibrarycorecommands-NextMapCommand.md rename to CodeDocumentation/SharedLibraryCore/commands/NextMapCommand.md index e3f7208..c25e2b5 100644 --- a/CodeDocumentation/SharedLibraryCore/sharedlibrarycorecommands-NextMapCommand.md +++ b/CodeDocumentation/SharedLibraryCore/commands/NextMapCommand.md @@ -23,12 +23,12 @@ SharedLibraryCore.Command --> SharedLibraryCore.Commands.NextMapCommand #### Public Static methods | 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 | Returns | Name | | --- | --- | -| `Task` | [`ExecuteAsync`](#executeasync)([`GameEvent`](./sharedlibrarycore-GameEvent) E) | +| `Task` | [`ExecuteAsync`](#executeasync)([`GameEvent`](../GameEvent.md) E) | ## Details ### Summary @@ -37,18 +37,19 @@ Retrieves the next map in rotation ### Inheritance - [ `Command` -](./sharedlibrarycore-Command) +](../Command.md) ### Constructors #### NextMapCommand +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Commands/NativeCommands.cs#L1178) ```csharp public NextMapCommand(CommandConfiguration config, ITranslationLookup translationLookup) ``` ##### Arguments | Type | Name | Description | | --- | --- | --- | -| [`CommandConfiguration`](./sharedlibrarycoreconfiguration-CommandConfiguration) | config | | -| [`ITranslationLookup`](./sharedlibrarycoreinterfaces-ITranslationLookup) | translationLookup | | +| [`CommandConfiguration`](../configuration/CommandConfiguration.md) | config | | +| [`ITranslationLookup`](../interfaces/ITranslationLookup.md) | translationLookup | | ### Methods #### GetNextMap @@ -58,8 +59,8 @@ public static async Task GetNextMap(Server s, ITranslationLookup lookup) ##### Arguments | Type | Name | Description | | --- | --- | --- | -| [`Server`](./sharedlibrarycore-Server) | s | | -| [`ITranslationLookup`](./sharedlibrarycoreinterfaces-ITranslationLookup) | lookup | | +| [`Server`](../Server.md) | s | | +| [`ITranslationLookup`](../interfaces/ITranslationLookup.md) | lookup | | #### ExecuteAsync ```csharp @@ -68,6 +69,6 @@ public override async Task ExecuteAsync(GameEvent E) ##### Arguments | Type | Name | Description | | --- | --- | --- | -| [`GameEvent`](./sharedlibrarycore-GameEvent) | E | | +| [`GameEvent`](../GameEvent.md) | E | | *Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycorecommands-OwnerCommand.md b/CodeDocumentation/SharedLibraryCore/commands/OwnerCommand.md similarity index 72% rename from CodeDocumentation/SharedLibraryCore/sharedlibrarycorecommands-OwnerCommand.md rename to CodeDocumentation/SharedLibraryCore/commands/OwnerCommand.md index 7e453c4..8d86363 100644 --- a/CodeDocumentation/SharedLibraryCore/sharedlibrarycorecommands-OwnerCommand.md +++ b/CodeDocumentation/SharedLibraryCore/commands/OwnerCommand.md @@ -23,7 +23,7 @@ SharedLibraryCore.Command --> SharedLibraryCore.Commands.OwnerCommand #### Public methods | Returns | Name | | --- | --- | -| `Task` | [`ExecuteAsync`](#executeasync)([`GameEvent`](./sharedlibrarycore-GameEvent) E) | +| `Task` | [`ExecuteAsync`](#executeasync)([`GameEvent`](../GameEvent.md) E) | ## Details ### Summary @@ -32,18 +32,19 @@ Claims ownership of the server ### Inheritance - [ `Command` -](./sharedlibrarycore-Command) +](../Command.md) ### Constructors #### OwnerCommand +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Commands/NativeCommands.cs#L69) ```csharp public OwnerCommand(CommandConfiguration config, ITranslationLookup translationLookup) ``` ##### Arguments | Type | Name | Description | | --- | --- | --- | -| [`CommandConfiguration`](./sharedlibrarycoreconfiguration-CommandConfiguration) | config | | -| [`ITranslationLookup`](./sharedlibrarycoreinterfaces-ITranslationLookup) | translationLookup | | +| [`CommandConfiguration`](../configuration/CommandConfiguration.md) | config | | +| [`ITranslationLookup`](../interfaces/ITranslationLookup.md) | translationLookup | | ### Methods #### ExecuteAsync @@ -53,6 +54,6 @@ public override async Task ExecuteAsync(GameEvent E) ##### Arguments | Type | Name | Description | | --- | --- | --- | -| [`GameEvent`](./sharedlibrarycore-GameEvent) | E | | +| [`GameEvent`](../GameEvent.md) | E | | *Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycorecommands-PrivateMessageAdminsCommand.md b/CodeDocumentation/SharedLibraryCore/commands/PrivateMessageAdminsCommand.md similarity index 65% rename from CodeDocumentation/SharedLibraryCore/sharedlibrarycorecommands-PrivateMessageAdminsCommand.md rename to CodeDocumentation/SharedLibraryCore/commands/PrivateMessageAdminsCommand.md index c85cb96..faa1a41 100644 --- a/CodeDocumentation/SharedLibraryCore/sharedlibrarycorecommands-PrivateMessageAdminsCommand.md +++ b/CodeDocumentation/SharedLibraryCore/commands/PrivateMessageAdminsCommand.md @@ -20,33 +20,35 @@ SharedLibraryCore.Command --> SharedLibraryCore.Commands.PrivateMessageAdminsCom #### Public methods | Returns | Name | | --- | --- | -| `Task` | [`ExecuteAsync`](#executeasync)([`GameEvent`](./sharedlibrarycore-GameEvent) E) | +| `Task` | [`ExecuteAsync`](#executeasync)([`GameEvent`](../GameEvent.md) E) | ## Details ### Inheritance - [ `Command` -](./sharedlibrarycore-Command) +](../Command.md) ### Constructors #### PrivateMessageAdminsCommand +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Commands/PrivateMessageAdminsCommand.cs#L12) ```csharp public PrivateMessageAdminsCommand(CommandConfiguration config, ITranslationLookup lookup) ``` ##### Arguments | Type | Name | Description | | --- | --- | --- | -| [`CommandConfiguration`](./sharedlibrarycoreconfiguration-CommandConfiguration) | config | | -| [`ITranslationLookup`](./sharedlibrarycoreinterfaces-ITranslationLookup) | lookup | | +| [`CommandConfiguration`](../configuration/CommandConfiguration.md) | config | | +| [`ITranslationLookup`](../interfaces/ITranslationLookup.md) | lookup | | ### Methods #### ExecuteAsync +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Commands/PrivateMessageAdminsCommand.cs#L23) ```csharp public override Task ExecuteAsync(GameEvent E) ``` ##### Arguments | Type | Name | Description | | --- | --- | --- | -| [`GameEvent`](./sharedlibrarycore-GameEvent) | E | | +| [`GameEvent`](../GameEvent.md) | E | | *Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycorecommands-PruneAdminsCommand.md b/CodeDocumentation/SharedLibraryCore/commands/PruneAdminsCommand.md similarity index 74% rename from CodeDocumentation/SharedLibraryCore/sharedlibrarycorecommands-PruneAdminsCommand.md rename to CodeDocumentation/SharedLibraryCore/commands/PruneAdminsCommand.md index 5ce62c4..f7fcee4 100644 --- a/CodeDocumentation/SharedLibraryCore/sharedlibrarycorecommands-PruneAdminsCommand.md +++ b/CodeDocumentation/SharedLibraryCore/commands/PruneAdminsCommand.md @@ -23,7 +23,7 @@ SharedLibraryCore.Command --> SharedLibraryCore.Commands.PruneAdminsCommand #### Public methods | Returns | Name | | --- | --- | -| `Task` | [`ExecuteAsync`](#executeasync)([`GameEvent`](./sharedlibrarycore-GameEvent) E) | +| `Task` | [`ExecuteAsync`](#executeasync)([`GameEvent`](../GameEvent.md) E) | ## Details ### Summary @@ -32,18 +32,19 @@ Prunes inactive privileged clients ### Inheritance - [ `Command` -](./sharedlibrarycore-Command) +](../Command.md) ### Constructors #### PruneAdminsCommand +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Commands/NativeCommands.cs#L988) ```csharp public PruneAdminsCommand(CommandConfiguration config, ITranslationLookup translationLookup, IDatabaseContextFactory contextFactory) ``` ##### Arguments | Type | Name | Description | | --- | --- | --- | -| [`CommandConfiguration`](./sharedlibrarycoreconfiguration-CommandConfiguration) | config | | -| [`ITranslationLookup`](./sharedlibrarycoreinterfaces-ITranslationLookup) | translationLookup | | +| [`CommandConfiguration`](../configuration/CommandConfiguration.md) | config | | +| [`ITranslationLookup`](../interfaces/ITranslationLookup.md) | translationLookup | | | `IDatabaseContextFactory` | contextFactory | | ### Methods @@ -54,6 +55,6 @@ public override async Task ExecuteAsync(GameEvent E) ##### Arguments | Type | Name | Description | | --- | --- | --- | -| [`GameEvent`](./sharedlibrarycore-GameEvent) | E | | +| [`GameEvent`](../GameEvent.md) | E | | *Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycorecommands-QuitCommand.md b/CodeDocumentation/SharedLibraryCore/commands/QuitCommand.md similarity index 71% rename from CodeDocumentation/SharedLibraryCore/sharedlibrarycorecommands-QuitCommand.md rename to CodeDocumentation/SharedLibraryCore/commands/QuitCommand.md index 03c73d9..38886a3 100644 --- a/CodeDocumentation/SharedLibraryCore/sharedlibrarycorecommands-QuitCommand.md +++ b/CodeDocumentation/SharedLibraryCore/commands/QuitCommand.md @@ -23,7 +23,7 @@ SharedLibraryCore.Command --> SharedLibraryCore.Commands.QuitCommand #### Public methods | Returns | Name | | --- | --- | -| `Task` | [`ExecuteAsync`](#executeasync)([`GameEvent`](./sharedlibrarycore-GameEvent) E) | +| `Task` | [`ExecuteAsync`](#executeasync)([`GameEvent`](../GameEvent.md) E) | ## Details ### Summary @@ -32,18 +32,19 @@ Quits IW4MAdmin ### Inheritance - [ `Command` -](./sharedlibrarycore-Command) +](../Command.md) ### Constructors #### QuitCommand +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Commands/NativeCommands.cs#L26) ```csharp public QuitCommand(CommandConfiguration config, ITranslationLookup translationLookup) ``` ##### Arguments | Type | Name | Description | | --- | --- | --- | -| [`CommandConfiguration`](./sharedlibrarycoreconfiguration-CommandConfiguration) | config | | -| [`ITranslationLookup`](./sharedlibrarycoreinterfaces-ITranslationLookup) | translationLookup | | +| [`CommandConfiguration`](../configuration/CommandConfiguration.md) | config | | +| [`ITranslationLookup`](../interfaces/ITranslationLookup.md) | translationLookup | | ### Methods #### ExecuteAsync @@ -53,6 +54,6 @@ public override async Task ExecuteAsync(GameEvent E) ##### Arguments | Type | Name | Description | | --- | --- | --- | -| [`GameEvent`](./sharedlibrarycore-GameEvent) | E | | +| [`GameEvent`](../GameEvent.md) | E | | *Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycorecommands-RequestTokenCommand.md b/CodeDocumentation/SharedLibraryCore/commands/RequestTokenCommand.md similarity index 67% rename from CodeDocumentation/SharedLibraryCore/sharedlibrarycorecommands-RequestTokenCommand.md rename to CodeDocumentation/SharedLibraryCore/commands/RequestTokenCommand.md index 42f8f68..0367f8e 100644 --- a/CodeDocumentation/SharedLibraryCore/sharedlibrarycorecommands-RequestTokenCommand.md +++ b/CodeDocumentation/SharedLibraryCore/commands/RequestTokenCommand.md @@ -23,7 +23,7 @@ SharedLibraryCore.Command --> SharedLibraryCore.Commands.RequestTokenCommand #### Public methods | Returns | Name | | --- | --- | -| `Task` | [`ExecuteAsync`](#executeasync)([`GameEvent`](./sharedlibrarycore-GameEvent) gameEvent) | +| `Task` | [`ExecuteAsync`](#executeasync)([`GameEvent`](../GameEvent.md) gameEvent) | ## Details ### Summary @@ -32,27 +32,29 @@ Generates a token for use in webfront login ### Inheritance - [ `Command` -](./sharedlibrarycore-Command) +](../Command.md) ### Constructors #### RequestTokenCommand +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Commands/RequestTokenCommand.cs#L14) ```csharp public RequestTokenCommand(CommandConfiguration config, ITranslationLookup lookup) ``` ##### Arguments | Type | Name | Description | | --- | --- | --- | -| [`CommandConfiguration`](./sharedlibrarycoreconfiguration-CommandConfiguration) | config | | -| [`ITranslationLookup`](./sharedlibrarycoreinterfaces-ITranslationLookup) | lookup | | +| [`CommandConfiguration`](../configuration/CommandConfiguration.md) | config | | +| [`ITranslationLookup`](../interfaces/ITranslationLookup.md) | lookup | | ### Methods #### ExecuteAsync +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Commands/RequestTokenCommand.cs#L24) ```csharp public override Task ExecuteAsync(GameEvent gameEvent) ``` ##### Arguments | Type | Name | Description | | --- | --- | --- | -| [`GameEvent`](./sharedlibrarycore-GameEvent) | gameEvent | | +| [`GameEvent`](../GameEvent.md) | gameEvent | | *Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycorecommands-RestartCommand.md b/CodeDocumentation/SharedLibraryCore/commands/RestartCommand.md similarity index 71% rename from CodeDocumentation/SharedLibraryCore/sharedlibrarycorecommands-RestartCommand.md rename to CodeDocumentation/SharedLibraryCore/commands/RestartCommand.md index 33134a5..61d518a 100644 --- a/CodeDocumentation/SharedLibraryCore/sharedlibrarycorecommands-RestartCommand.md +++ b/CodeDocumentation/SharedLibraryCore/commands/RestartCommand.md @@ -23,7 +23,7 @@ SharedLibraryCore.Command --> SharedLibraryCore.Commands.RestartCommand #### Public methods | Returns | Name | | --- | --- | -| `Task` | [`ExecuteAsync`](#executeasync)([`GameEvent`](./sharedlibrarycore-GameEvent) gameEvent) | +| `Task` | [`ExecuteAsync`](#executeasync)([`GameEvent`](../GameEvent.md) gameEvent) | ## Details ### Summary @@ -32,18 +32,19 @@ Restarts IW4MAdmin ### Inheritance - [ `Command` -](./sharedlibrarycore-Command) +](../Command.md) ### Constructors #### RestartCommand +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Commands/NativeCommands.cs#L47) ```csharp public RestartCommand(CommandConfiguration config, ITranslationLookup translationLookup) ``` ##### Arguments | Type | Name | Description | | --- | --- | --- | -| [`CommandConfiguration`](./sharedlibrarycoreconfiguration-CommandConfiguration) | config | | -| [`ITranslationLookup`](./sharedlibrarycoreinterfaces-ITranslationLookup) | translationLookup | | +| [`CommandConfiguration`](../configuration/CommandConfiguration.md) | config | | +| [`ITranslationLookup`](../interfaces/ITranslationLookup.md) | translationLookup | | ### Methods #### ExecuteAsync @@ -53,6 +54,6 @@ public override async Task ExecuteAsync(GameEvent gameEvent) ##### Arguments | Type | Name | Description | | --- | --- | --- | -| [`GameEvent`](./sharedlibrarycore-GameEvent) | gameEvent | | +| [`GameEvent`](../GameEvent.md) | gameEvent | | *Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycorecommands-RunAsCommand.md b/CodeDocumentation/SharedLibraryCore/commands/RunAsCommand.md similarity index 70% rename from CodeDocumentation/SharedLibraryCore/sharedlibrarycorecommands-RunAsCommand.md rename to CodeDocumentation/SharedLibraryCore/commands/RunAsCommand.md index 5358e84..83d67af 100644 --- a/CodeDocumentation/SharedLibraryCore/sharedlibrarycorecommands-RunAsCommand.md +++ b/CodeDocumentation/SharedLibraryCore/commands/RunAsCommand.md @@ -20,24 +20,25 @@ SharedLibraryCore.Command --> SharedLibraryCore.Commands.RunAsCommand #### Public methods | Returns | Name | | --- | --- | -| `Task` | [`ExecuteAsync`](#executeasync)([`GameEvent`](./sharedlibrarycore-GameEvent) gameEvent) | +| `Task` | [`ExecuteAsync`](#executeasync)([`GameEvent`](../GameEvent.md) gameEvent) | ## Details ### Inheritance - [ `Command` -](./sharedlibrarycore-Command) +](../Command.md) ### Constructors #### RunAsCommand +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Commands/RunAsCommand.cs#L11) ```csharp public RunAsCommand(CommandConfiguration config, ITranslationLookup lookup) ``` ##### Arguments | Type | Name | Description | | --- | --- | --- | -| [`CommandConfiguration`](./sharedlibrarycoreconfiguration-CommandConfiguration) | config | | -| [`ITranslationLookup`](./sharedlibrarycoreinterfaces-ITranslationLookup) | lookup | | +| [`CommandConfiguration`](../configuration/CommandConfiguration.md) | config | | +| [`ITranslationLookup`](../interfaces/ITranslationLookup.md) | lookup | | ### Methods #### ExecuteAsync @@ -47,6 +48,6 @@ public override async Task ExecuteAsync(GameEvent gameEvent) ##### Arguments | Type | Name | Description | | --- | --- | --- | -| [`GameEvent`](./sharedlibrarycore-GameEvent) | gameEvent | | +| [`GameEvent`](../GameEvent.md) | gameEvent | | *Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycorecommands-SetGravatarCommand.md b/CodeDocumentation/SharedLibraryCore/commands/SetGravatarCommand.md similarity index 70% rename from CodeDocumentation/SharedLibraryCore/sharedlibrarycorecommands-SetGravatarCommand.md rename to CodeDocumentation/SharedLibraryCore/commands/SetGravatarCommand.md index 73dcff4..be8d9a5 100644 --- a/CodeDocumentation/SharedLibraryCore/sharedlibrarycorecommands-SetGravatarCommand.md +++ b/CodeDocumentation/SharedLibraryCore/commands/SetGravatarCommand.md @@ -23,7 +23,7 @@ SharedLibraryCore.Command --> SharedLibraryCore.Commands.SetGravatarCommand #### Public methods | Returns | Name | | --- | --- | -| `Task` | [`ExecuteAsync`](#executeasync)([`GameEvent`](./sharedlibrarycore-GameEvent) E) | +| `Task` | [`ExecuteAsync`](#executeasync)([`GameEvent`](../GameEvent.md) E) | ## Details ### Summary @@ -32,19 +32,20 @@ Sets the email for gravatar in webfront ### Inheritance - [ `Command` -](./sharedlibrarycore-Command) +](../Command.md) ### Constructors #### SetGravatarCommand +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Commands/NativeCommands.cs#L1139) ```csharp public SetGravatarCommand(CommandConfiguration config, ITranslationLookup translationLookup, IMetaServiceV2 metaService) ``` ##### Arguments | Type | Name | Description | | --- | --- | --- | -| [`CommandConfiguration`](./sharedlibrarycoreconfiguration-CommandConfiguration) | config | | -| [`ITranslationLookup`](./sharedlibrarycoreinterfaces-ITranslationLookup) | translationLookup | | -| [`IMetaServiceV2`](./sharedlibrarycoreinterfaces-IMetaServiceV2) | metaService | | +| [`CommandConfiguration`](../configuration/CommandConfiguration.md) | config | | +| [`ITranslationLookup`](../interfaces/ITranslationLookup.md) | translationLookup | | +| [`IMetaServiceV2`](../interfaces/IMetaServiceV2.md) | metaService | | ### Methods #### ExecuteAsync @@ -54,6 +55,6 @@ public override async Task ExecuteAsync(GameEvent E) ##### Arguments | Type | Name | Description | | --- | --- | --- | -| [`GameEvent`](./sharedlibrarycore-GameEvent) | E | | +| [`GameEvent`](../GameEvent.md) | E | | *Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycorecommands-SetLevelCommand.md b/CodeDocumentation/SharedLibraryCore/commands/SetLevelCommand.md similarity index 68% rename from CodeDocumentation/SharedLibraryCore/sharedlibrarycorecommands-SetLevelCommand.md rename to CodeDocumentation/SharedLibraryCore/commands/SetLevelCommand.md index 12c3a3b..6308db9 100644 --- a/CodeDocumentation/SharedLibraryCore/sharedlibrarycorecommands-SetLevelCommand.md +++ b/CodeDocumentation/SharedLibraryCore/commands/SetLevelCommand.md @@ -23,7 +23,7 @@ SharedLibraryCore.Command --> SharedLibraryCore.Commands.SetLevelCommand #### Public methods | Returns | Name | | --- | --- | -| `Task` | [`ExecuteAsync`](#executeasync)([`GameEvent`](./sharedlibrarycore-GameEvent) gameEvent) | +| `Task` | [`ExecuteAsync`](#executeasync)([`GameEvent`](../GameEvent.md) gameEvent) | ## Details ### Summary @@ -32,19 +32,20 @@ Sets the level of given client ### Inheritance - [ `Command` -](./sharedlibrarycore-Command) +](../Command.md) ### Constructors #### SetLevelCommand +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Commands/NativeCommands.cs#L468) ```csharp public SetLevelCommand(CommandConfiguration config, ITranslationLookup translationLookup, ILogger logger) ``` ##### Arguments | Type | Name | Description | | --- | --- | --- | -| [`CommandConfiguration`](./sharedlibrarycoreconfiguration-CommandConfiguration) | config | | -| [`ITranslationLookup`](./sharedlibrarycoreinterfaces-ITranslationLookup) | translationLookup | | -| `ILogger`<[`SetLevelCommand`](sharedlibrarycorecommands-SetLevelCommand)> | logger | | +| [`CommandConfiguration`](../configuration/CommandConfiguration.md) | config | | +| [`ITranslationLookup`](../interfaces/ITranslationLookup.md) | translationLookup | | +| `ILogger`<[`SetLevelCommand`](sharedlibrarycore/commands/SetLevelCommand.md)> | logger | | ### Methods #### ExecuteAsync @@ -54,6 +55,6 @@ public override async Task ExecuteAsync(GameEvent gameEvent) ##### Arguments | Type | Name | Description | | --- | --- | --- | -| [`GameEvent`](./sharedlibrarycore-GameEvent) | gameEvent | | +| [`GameEvent`](../GameEvent.md) | gameEvent | | *Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycorecommands-SetPasswordCommand.md b/CodeDocumentation/SharedLibraryCore/commands/SetPasswordCommand.md similarity index 72% rename from CodeDocumentation/SharedLibraryCore/sharedlibrarycorecommands-SetPasswordCommand.md rename to CodeDocumentation/SharedLibraryCore/commands/SetPasswordCommand.md index 0c7285e..428f635 100644 --- a/CodeDocumentation/SharedLibraryCore/sharedlibrarycorecommands-SetPasswordCommand.md +++ b/CodeDocumentation/SharedLibraryCore/commands/SetPasswordCommand.md @@ -23,7 +23,7 @@ SharedLibraryCore.Command --> SharedLibraryCore.Commands.SetPasswordCommand #### Public methods | Returns | Name | | --- | --- | -| `Task` | [`ExecuteAsync`](#executeasync)([`GameEvent`](./sharedlibrarycore-GameEvent) E) | +| `Task` | [`ExecuteAsync`](#executeasync)([`GameEvent`](../GameEvent.md) E) | ## Details ### Summary @@ -32,18 +32,19 @@ Sets login password ### Inheritance - [ `Command` -](./sharedlibrarycore-Command) +](../Command.md) ### Constructors #### SetPasswordCommand +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Commands/NativeCommands.cs#L1051) ```csharp public SetPasswordCommand(CommandConfiguration config, ITranslationLookup translationLookup) ``` ##### Arguments | Type | Name | Description | | --- | --- | --- | -| [`CommandConfiguration`](./sharedlibrarycoreconfiguration-CommandConfiguration) | config | | -| [`ITranslationLookup`](./sharedlibrarycoreinterfaces-ITranslationLookup) | translationLookup | | +| [`CommandConfiguration`](../configuration/CommandConfiguration.md) | config | | +| [`ITranslationLookup`](../interfaces/ITranslationLookup.md) | translationLookup | | ### Methods #### ExecuteAsync @@ -53,6 +54,6 @@ public override async Task ExecuteAsync(GameEvent E) ##### Arguments | Type | Name | Description | | --- | --- | --- | -| [`GameEvent`](./sharedlibrarycore-GameEvent) | E | | +| [`GameEvent`](../GameEvent.md) | E | | *Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycorecommands-TempBanCommand.md b/CodeDocumentation/SharedLibraryCore/commands/TempBanCommand.md similarity index 68% rename from CodeDocumentation/SharedLibraryCore/sharedlibrarycorecommands-TempBanCommand.md rename to CodeDocumentation/SharedLibraryCore/commands/TempBanCommand.md index 59a3566..9b4065a 100644 --- a/CodeDocumentation/SharedLibraryCore/sharedlibrarycorecommands-TempBanCommand.md +++ b/CodeDocumentation/SharedLibraryCore/commands/TempBanCommand.md @@ -23,7 +23,7 @@ SharedLibraryCore.Command --> SharedLibraryCore.Commands.TempBanCommand #### Public methods | Returns | Name | | --- | --- | -| `Task` | [`ExecuteAsync`](#executeasync)([`GameEvent`](./sharedlibrarycore-GameEvent) gameEvent) | +| `Task` | [`ExecuteAsync`](#executeasync)([`GameEvent`](../GameEvent.md) gameEvent) | ## Details ### Summary @@ -32,19 +32,20 @@ Temporarily bans a client ### Inheritance - [ `Command` -](./sharedlibrarycore-Command) +](../Command.md) ### Constructors #### TempBanCommand +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Commands/NativeCommands.cs#L236) ```csharp public TempBanCommand(ApplicationConfiguration appConfig, CommandConfiguration config, ITranslationLookup translationLookup) ``` ##### Arguments | Type | Name | Description | | --- | --- | --- | -| [`ApplicationConfiguration`](./sharedlibrarycoreconfiguration-ApplicationConfiguration) | appConfig | | -| [`CommandConfiguration`](./sharedlibrarycoreconfiguration-CommandConfiguration) | config | | -| [`ITranslationLookup`](./sharedlibrarycoreinterfaces-ITranslationLookup) | translationLookup | | +| [`ApplicationConfiguration`](../configuration/ApplicationConfiguration.md) | appConfig | | +| [`CommandConfiguration`](../configuration/CommandConfiguration.md) | config | | +| [`ITranslationLookup`](../interfaces/ITranslationLookup.md) | translationLookup | | ### Methods #### ExecuteAsync @@ -54,6 +55,6 @@ public override async Task ExecuteAsync(GameEvent gameEvent) ##### Arguments | Type | Name | Description | | --- | --- | --- | -| [`GameEvent`](./sharedlibrarycore-GameEvent) | gameEvent | | +| [`GameEvent`](../GameEvent.md) | gameEvent | | *Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycorecommands-UnbanCommand.md b/CodeDocumentation/SharedLibraryCore/commands/UnbanCommand.md similarity index 71% rename from CodeDocumentation/SharedLibraryCore/sharedlibrarycorecommands-UnbanCommand.md rename to CodeDocumentation/SharedLibraryCore/commands/UnbanCommand.md index 9cc2291..3eeb129 100644 --- a/CodeDocumentation/SharedLibraryCore/sharedlibrarycorecommands-UnbanCommand.md +++ b/CodeDocumentation/SharedLibraryCore/commands/UnbanCommand.md @@ -23,7 +23,7 @@ SharedLibraryCore.Command --> SharedLibraryCore.Commands.UnbanCommand #### Public methods | Returns | Name | | --- | --- | -| `Task` | [`ExecuteAsync`](#executeasync)([`GameEvent`](./sharedlibrarycore-GameEvent) gameEvent) | +| `Task` | [`ExecuteAsync`](#executeasync)([`GameEvent`](../GameEvent.md) gameEvent) | ## Details ### Summary @@ -32,18 +32,19 @@ Unbans a banned client ### Inheritance - [ `Command` -](./sharedlibrarycore-Command) +](../Command.md) ### Constructors #### UnbanCommand +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Commands/NativeCommands.cs#L356) ```csharp public UnbanCommand(CommandConfiguration config, ITranslationLookup translationLookup) ``` ##### Arguments | Type | Name | Description | | --- | --- | --- | -| [`CommandConfiguration`](./sharedlibrarycoreconfiguration-CommandConfiguration) | config | | -| [`ITranslationLookup`](./sharedlibrarycoreinterfaces-ITranslationLookup) | translationLookup | | +| [`CommandConfiguration`](../configuration/CommandConfiguration.md) | config | | +| [`ITranslationLookup`](../interfaces/ITranslationLookup.md) | translationLookup | | ### Methods #### ExecuteAsync @@ -53,6 +54,6 @@ public override async Task ExecuteAsync(GameEvent gameEvent) ##### Arguments | Type | Name | Description | | --- | --- | --- | -| [`GameEvent`](./sharedlibrarycore-GameEvent) | gameEvent | | +| [`GameEvent`](../GameEvent.md) | gameEvent | | *Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycorecommands-UnflagClientCommand.md b/CodeDocumentation/SharedLibraryCore/commands/UnflagClientCommand.md similarity index 73% rename from CodeDocumentation/SharedLibraryCore/sharedlibrarycorecommands-UnflagClientCommand.md rename to CodeDocumentation/SharedLibraryCore/commands/UnflagClientCommand.md index b221c42..a1149fa 100644 --- a/CodeDocumentation/SharedLibraryCore/sharedlibrarycorecommands-UnflagClientCommand.md +++ b/CodeDocumentation/SharedLibraryCore/commands/UnflagClientCommand.md @@ -23,7 +23,7 @@ SharedLibraryCore.Command --> SharedLibraryCore.Commands.UnflagClientCommand #### Public methods | Returns | Name | | --- | --- | -| `Task` | [`ExecuteAsync`](#executeasync)([`GameEvent`](./sharedlibrarycore-GameEvent) E) | +| `Task` | [`ExecuteAsync`](#executeasync)([`GameEvent`](../GameEvent.md) E) | ## Details ### Summary @@ -32,18 +32,19 @@ Unflag given client for specified reason ### Inheritance - [ `Command` -](./sharedlibrarycore-Command) +](../Command.md) ### Constructors #### UnflagClientCommand +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Commands/NativeCommands.cs#L797) ```csharp public UnflagClientCommand(CommandConfiguration config, ITranslationLookup translationLookup) ``` ##### Arguments | Type | Name | Description | | --- | --- | --- | -| [`CommandConfiguration`](./sharedlibrarycoreconfiguration-CommandConfiguration) | config | | -| [`ITranslationLookup`](./sharedlibrarycoreinterfaces-ITranslationLookup) | translationLookup | | +| [`CommandConfiguration`](../configuration/CommandConfiguration.md) | config | | +| [`ITranslationLookup`](../interfaces/ITranslationLookup.md) | translationLookup | | ### Methods #### ExecuteAsync @@ -53,6 +54,6 @@ public override async Task ExecuteAsync(GameEvent E) ##### Arguments | Type | Name | Description | | --- | --- | --- | -| [`GameEvent`](./sharedlibrarycore-GameEvent) | E | | +| [`GameEvent`](../GameEvent.md) | E | | *Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycorecommands-UnlinkClientCommand.md b/CodeDocumentation/SharedLibraryCore/commands/UnlinkClientCommand.md similarity index 81% rename from CodeDocumentation/SharedLibraryCore/sharedlibrarycorecommands-UnlinkClientCommand.md rename to CodeDocumentation/SharedLibraryCore/commands/UnlinkClientCommand.md index 6ef7aba..ad5329c 100644 --- a/CodeDocumentation/SharedLibraryCore/sharedlibrarycorecommands-UnlinkClientCommand.md +++ b/CodeDocumentation/SharedLibraryCore/commands/UnlinkClientCommand.md @@ -27,7 +27,7 @@ SharedLibraryCore.Command --> SharedLibraryCore.Commands.UnlinkClientCommand #### Public methods | Returns | Name | | --- | --- | -| `Task` | [`ExecuteAsync`](#executeasync)([`GameEvent`](./sharedlibrarycore-GameEvent) E) | +| `Task` | [`ExecuteAsync`](#executeasync)([`GameEvent`](../GameEvent.md) E) | ## Details ### Summary @@ -40,18 +40,19 @@ Provides a way for administrators to "unlink" linked accounts ### Inheritance - [ `Command` -](./sharedlibrarycore-Command) +](../Command.md) ### Constructors #### UnlinkClientCommand +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Commands/UnlinkClientCommand.cs#L17) ```csharp public UnlinkClientCommand(CommandConfiguration config, ITranslationLookup lookup) ``` ##### Arguments | Type | Name | Description | | --- | --- | --- | -| [`CommandConfiguration`](./sharedlibrarycoreconfiguration-CommandConfiguration) | config | | -| [`ITranslationLookup`](./sharedlibrarycoreinterfaces-ITranslationLookup) | lookup | | +| [`CommandConfiguration`](../configuration/CommandConfiguration.md) | config | | +| [`ITranslationLookup`](../interfaces/ITranslationLookup.md) | lookup | | ### Methods #### ExecuteAsync @@ -61,6 +62,6 @@ public override async Task ExecuteAsync(GameEvent E) ##### Arguments | Type | Name | Description | | --- | --- | --- | -| [`GameEvent`](./sharedlibrarycore-GameEvent) | E | | +| [`GameEvent`](../GameEvent.md) | E | | *Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycorecommands-UptimeCommand.md b/CodeDocumentation/SharedLibraryCore/commands/UptimeCommand.md similarity index 67% rename from CodeDocumentation/SharedLibraryCore/sharedlibrarycorecommands-UptimeCommand.md rename to CodeDocumentation/SharedLibraryCore/commands/UptimeCommand.md index ad0b7af..e5f33bc 100644 --- a/CodeDocumentation/SharedLibraryCore/sharedlibrarycorecommands-UptimeCommand.md +++ b/CodeDocumentation/SharedLibraryCore/commands/UptimeCommand.md @@ -23,7 +23,7 @@ SharedLibraryCore.Command --> SharedLibraryCore.Commands.UptimeCommand #### Public methods | Returns | Name | | --- | --- | -| `Task` | [`ExecuteAsync`](#executeasync)([`GameEvent`](./sharedlibrarycore-GameEvent) E) | +| `Task` | [`ExecuteAsync`](#executeasync)([`GameEvent`](../GameEvent.md) E) | ## Details ### Summary @@ -32,27 +32,29 @@ Prints out how long IW4MAdmin has been running ### Inheritance - [ `Command` -](./sharedlibrarycore-Command) +](../Command.md) ### Constructors #### UptimeCommand +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Commands/NativeCommands.cs#L633) ```csharp public UptimeCommand(CommandConfiguration config, ITranslationLookup translationLookup) ``` ##### Arguments | Type | Name | Description | | --- | --- | --- | -| [`CommandConfiguration`](./sharedlibrarycoreconfiguration-CommandConfiguration) | config | | -| [`ITranslationLookup`](./sharedlibrarycoreinterfaces-ITranslationLookup) | translationLookup | | +| [`CommandConfiguration`](../configuration/CommandConfiguration.md) | config | | +| [`ITranslationLookup`](../interfaces/ITranslationLookup.md) | translationLookup | | ### Methods #### ExecuteAsync +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Commands/NativeCommands.cs#L644) ```csharp public override Task ExecuteAsync(GameEvent E) ``` ##### Arguments | Type | Name | Description | | --- | --- | --- | -| [`GameEvent`](./sharedlibrarycore-GameEvent) | E | | +| [`GameEvent`](../GameEvent.md) | E | | *Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycorecommands-WarnClearCommand.md b/CodeDocumentation/SharedLibraryCore/commands/WarnClearCommand.md similarity index 67% rename from CodeDocumentation/SharedLibraryCore/sharedlibrarycorecommands-WarnClearCommand.md rename to CodeDocumentation/SharedLibraryCore/commands/WarnClearCommand.md index 9fc0128..909d4ed 100644 --- a/CodeDocumentation/SharedLibraryCore/sharedlibrarycorecommands-WarnClearCommand.md +++ b/CodeDocumentation/SharedLibraryCore/commands/WarnClearCommand.md @@ -23,7 +23,7 @@ SharedLibraryCore.Command --> SharedLibraryCore.Commands.WarnClearCommand #### Public methods | Returns | Name | | --- | --- | -| `Task` | [`ExecuteAsync`](#executeasync)([`GameEvent`](./sharedlibrarycore-GameEvent) E) | +| `Task` | [`ExecuteAsync`](#executeasync)([`GameEvent`](../GameEvent.md) E) | ## Details ### Summary @@ -32,27 +32,29 @@ Clears all warnings for given client ### Inheritance - [ `Command` -](./sharedlibrarycore-Command) +](../Command.md) ### Constructors #### WarnClearCommand +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Commands/NativeCommands.cs#L148) ```csharp public WarnClearCommand(CommandConfiguration config, ITranslationLookup translationLookup) ``` ##### Arguments | Type | Name | Description | | --- | --- | --- | -| [`CommandConfiguration`](./sharedlibrarycoreconfiguration-CommandConfiguration) | config | | -| [`ITranslationLookup`](./sharedlibrarycoreinterfaces-ITranslationLookup) | translationLookup | | +| [`CommandConfiguration`](../configuration/CommandConfiguration.md) | config | | +| [`ITranslationLookup`](../interfaces/ITranslationLookup.md) | translationLookup | | ### Methods #### ExecuteAsync +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Commands/NativeCommands.cs#L167) ```csharp public override Task ExecuteAsync(GameEvent E) ``` ##### Arguments | Type | Name | Description | | --- | --- | --- | -| [`GameEvent`](./sharedlibrarycore-GameEvent) | E | | +| [`GameEvent`](../GameEvent.md) | E | | *Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycorecommands-WarnCommand.md b/CodeDocumentation/SharedLibraryCore/commands/WarnCommand.md similarity index 63% rename from CodeDocumentation/SharedLibraryCore/sharedlibrarycorecommands-WarnCommand.md rename to CodeDocumentation/SharedLibraryCore/commands/WarnCommand.md index 98626ab..5b60506 100644 --- a/CodeDocumentation/SharedLibraryCore/sharedlibrarycorecommands-WarnCommand.md +++ b/CodeDocumentation/SharedLibraryCore/commands/WarnCommand.md @@ -23,7 +23,7 @@ SharedLibraryCore.Command --> SharedLibraryCore.Commands.WarnCommand #### Public methods | Returns | Name | | --- | --- | -| `Task` | [`ExecuteAsync`](#executeasync)([`GameEvent`](./sharedlibrarycore-GameEvent) gameEvent) | +| `Task` | [`ExecuteAsync`](#executeasync)([`GameEvent`](../GameEvent.md) gameEvent) | ## Details ### Summary @@ -32,28 +32,30 @@ Warns given client for reason ### Inheritance - [ `Command` -](./sharedlibrarycore-Command) +](../Command.md) ### Constructors #### WarnCommand +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Commands/NativeCommands.cs#L108) ```csharp public WarnCommand(ApplicationConfiguration appConfig, CommandConfiguration config, ITranslationLookup translationLookup) ``` ##### Arguments | Type | Name | Description | | --- | --- | --- | -| [`ApplicationConfiguration`](./sharedlibrarycoreconfiguration-ApplicationConfiguration) | appConfig | | -| [`CommandConfiguration`](./sharedlibrarycoreconfiguration-CommandConfiguration) | config | | -| [`ITranslationLookup`](./sharedlibrarycoreinterfaces-ITranslationLookup) | translationLookup | | +| [`ApplicationConfiguration`](../configuration/ApplicationConfiguration.md) | appConfig | | +| [`CommandConfiguration`](../configuration/CommandConfiguration.md) | config | | +| [`ITranslationLookup`](../interfaces/ITranslationLookup.md) | translationLookup | | ### Methods #### ExecuteAsync +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Commands/NativeCommands.cs#L132) ```csharp public override Task ExecuteAsync(GameEvent gameEvent) ``` ##### Arguments | Type | Name | Description | | --- | --- | --- | -| [`GameEvent`](./sharedlibrarycore-GameEvent) | gameEvent | | +| [`GameEvent`](../GameEvent.md) | gameEvent | | *Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreconfiguration-ApplicationConfiguration.md b/CodeDocumentation/SharedLibraryCore/configuration/ApplicationConfiguration.md similarity index 90% rename from CodeDocumentation/SharedLibraryCore/sharedlibrarycoreconfiguration-ApplicationConfiguration.md rename to CodeDocumentation/SharedLibraryCore/configuration/ApplicationConfiguration.md index 614b96d..d7e54a0 100644 --- a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreconfiguration-ApplicationConfiguration.md +++ b/CodeDocumentation/SharedLibraryCore/configuration/ApplicationConfiguration.md @@ -25,7 +25,7 @@ SharedLibraryCore.Interfaces.IBaseConfiguration --> SharedLibraryCore.Configurat | `TimeSpan``[]` | [`BanDurations`](#bandurations) | `get, set` | | `string` | [`BroadcastCommandPrefix`](#broadcastcommandprefix) | `get, set` | | `string` | [`CommandPrefix`](#commandprefix) | `get, set` | -| [`CommunityInformationConfiguration`](./sharedlibrarycoreconfiguration-CommunityInformationConfiguration) | [`CommunityInformation`](#communityinformation) | `get, set` | +| [`CommunityInformationConfiguration`](./CommunityInformationConfiguration.md) | [`CommunityInformation`](#communityinformation) | `get, set` | | `string` | [`ConnectionString`](#connectionstring) | `get, set` | | `string` | [`ContactUri`](#contacturi) | `get, set` | | `string` | [`CustomLocale`](#customlocale) | `get, set` | @@ -51,7 +51,7 @@ SharedLibraryCore.Interfaces.IBaseConfiguration --> SharedLibraryCore.Configurat | `string` | [`IngameAccentColorKey`](#ingameaccentcolorkey) | `get, set` | | `string` | [`ManualWebfrontUrl`](#manualwebfronturl) | `get, set` | | `int` | [`MapChangeDelaySeconds`](#mapchangedelayseconds) | `get, set` | -| [`MapConfiguration`](./sharedlibrarycoreconfiguration-MapConfiguration)`[]` | [`Maps`](#maps) | `get, set` | +| [`MapConfiguration`](./MapConfiguration.md)`[]` | [`Maps`](#maps) | `get, set` | | `Uri` | [`MasterUrl`](#masterurl) | `get, set` | | `TimeSpan` | [`MaxClientHistoryTime`](#maxclienthistorytime) | `get, set` | | `TimeSpan` | [`MaximumTempBanTime`](#maximumtempbantime) | `get, set` | @@ -60,17 +60,17 @@ SharedLibraryCore.Interfaces.IBaseConfiguration --> SharedLibraryCore.Configurat | `Dictionary`<`Permission`, `string`> | [`OverridePermissionLevelNames`](#overridepermissionlevelnames) | `get, set` | | `Dictionary`<`string`, `List`<`string`>> | [`PermissionSets`](#permissionsets) | `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` | | `TimeSpan` | [`RecentAliasIpLinkTimeLimit`](#recentaliasiplinktimelimit) | `get, set` | | `int` | [`ServerConnectionAttempts`](#serverconnectionattempts) | `get, set` | | `TimeSpan` | [`ServerDataCollectionInterval`](#serverdatacollectioninterval) | `get, set` | -| [`ServerConfiguration`](./sharedlibrarycoreconfiguration-ServerConfiguration)`[]` | [`Servers`](#servers) | `get, set` | +| [`ServerConfiguration`](./ServerConfiguration.md)`[]` | [`Servers`](#servers) | `get, set` | | `string` | [`SocialLinkAddress`](#sociallinkaddress) | `get, set` | | `string` | [`SocialLinkTitle`](#sociallinktitle) | `get, set` | | `string` | [`SubscriptionId`](#subscriptionid) | `get, set` | | `bool` | [`UseLocalTranslations`](#uselocaltranslations) | `get, set` | -| [`WebfrontConfiguration`](./sharedlibrarycoreconfiguration-WebfrontConfiguration) | [`Webfront`](#webfront) | `get, set` | +| [`WebfrontConfiguration`](./WebfrontConfiguration.md) | [`Webfront`](#webfront) | `get, set` | | `string` | [`WebfrontBindUrl`](#webfrontbindurl) | `get, set` | | `string``[]` | [`WebfrontConnectionWhitelist`](#webfrontconnectionwhitelist) | `get, set` | | `string` | [`WebfrontCustomBranding`](#webfrontcustombranding) | `get, set` | @@ -82,28 +82,31 @@ SharedLibraryCore.Interfaces.IBaseConfiguration --> SharedLibraryCore.Configurat #### Public methods | Returns | Name | | --- | --- | -| [`IBaseConfiguration`](./sharedlibrarycoreinterfaces-IBaseConfiguration) | [`Generate`](#generate)() | +| [`IBaseConfiguration`](../interfaces/IBaseConfiguration.md) | [`Generate`](#generate)() | | `string` | [`Name`](#name)() | ## Details ### Inheritance - [ `IBaseConfiguration` -](./sharedlibrarycoreinterfaces-IBaseConfiguration) +](../interfaces/IBaseConfiguration.md) ### Constructors #### ApplicationConfiguration +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Configuration/ApplicationConfiguration.cs#L17) ```csharp public ApplicationConfiguration() ``` ### Methods #### Generate +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Configuration/ApplicationConfiguration.cs#L212) ```csharp public virtual IBaseConfiguration Generate() ``` #### Name +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Configuration/ApplicationConfiguration.cs#L233) ```csharp public virtual string Name() ``` diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreconfiguration-CommandConfiguration.md b/CodeDocumentation/SharedLibraryCore/configuration/CommandConfiguration.md similarity index 73% rename from CodeDocumentation/SharedLibraryCore/sharedlibrarycoreconfiguration-CommandConfiguration.md rename to CodeDocumentation/SharedLibraryCore/configuration/CommandConfiguration.md index 64ec7ab..15eb38f 100644 --- a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreconfiguration-CommandConfiguration.md +++ b/CodeDocumentation/SharedLibraryCore/configuration/CommandConfiguration.md @@ -25,13 +25,13 @@ SharedLibraryCore.Interfaces.IBaseConfiguration --> SharedLibraryCore.Configurat | --- | --- | --- | | `string` | [`BroadcastCommandPrefix`](#broadcastcommandprefix)
prefix indicating that the chat message is a broadcast command | `get, set` | | `string` | [`CommandPrefix`](#commandprefix)
prefix indicated the chat message is a command | `get, set` | -| `Dictionary`<`string`, [`CommandProperties`](./sharedlibrarycoreconfiguration-CommandProperties)> | [`Commands`](#commands)
Dict of command class names mapped to configurable properties | `get, set` | +| `Dictionary`<`string`, [`CommandProperties`](./CommandProperties.md)> | [`Commands`](#commands)
Dict of command class names mapped to configurable properties | `get, set` | ### Methods #### Public methods | Returns | Name | | --- | --- | -| [`IBaseConfiguration`](./sharedlibrarycoreinterfaces-IBaseConfiguration) | [`Generate`](#generate)() | +| [`IBaseConfiguration`](../interfaces/IBaseConfiguration.md) | [`Generate`](#generate)() | | `string` | [`Name`](#name)() | ## Details @@ -41,21 +41,24 @@ Basic command configuration ### Inheritance - [ `IBaseConfiguration` -](./sharedlibrarycoreinterfaces-IBaseConfiguration) +](../interfaces/IBaseConfiguration.md) ### Constructors #### CommandConfiguration +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Configuration/CommandConfiguration.cs#L17) ```csharp public CommandConfiguration() ``` ### Methods #### Generate +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Configuration/CommandConfiguration.cs#L32) ```csharp public virtual IBaseConfiguration Generate() ``` #### Name +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Configuration/CommandConfiguration.cs#L37) ```csharp public virtual string Name() ``` diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreconfiguration-CommandProperties.md b/CodeDocumentation/SharedLibraryCore/configuration/CommandProperties.md similarity index 93% rename from CodeDocumentation/SharedLibraryCore/sharedlibrarycoreconfiguration-CommandProperties.md rename to CodeDocumentation/SharedLibraryCore/configuration/CommandProperties.md index 4f19abf..d686a3c 100644 --- a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreconfiguration-CommandProperties.md +++ b/CodeDocumentation/SharedLibraryCore/configuration/CommandProperties.md @@ -30,6 +30,7 @@ Config driven command properties ### Constructors #### CommandProperties +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Configuration/CommandProperties.cs#L39) ```csharp public CommandProperties() ``` diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreconfiguration-CommunityInformationConfiguration.md b/CodeDocumentation/SharedLibraryCore/configuration/CommunityInformationConfiguration.md similarity index 82% rename from CodeDocumentation/SharedLibraryCore/sharedlibrarycoreconfiguration-CommunityInformationConfiguration.md rename to CodeDocumentation/SharedLibraryCore/configuration/CommunityInformationConfiguration.md index 56e2a40..8048b1e 100644 --- a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreconfiguration-CommunityInformationConfiguration.md +++ b/CodeDocumentation/SharedLibraryCore/configuration/CommunityInformationConfiguration.md @@ -19,11 +19,12 @@ | `bool` | [`EnableBanner`](#enablebanner) | `get, set` | | `bool` | [`IsEnabled`](#isenabled) | `get, set` | | `string` | [`Name`](#name) | `get, set` | -| [`SocialAccountConfiguration`](./sharedlibrarycoreconfiguration-SocialAccountConfiguration)`[]` | [`SocialAccounts`](#socialaccounts) | `get, set` | +| [`SocialAccountConfiguration`](./SocialAccountConfiguration.md)`[]` | [`SocialAccounts`](#socialaccounts) | `get, set` | ## Details ### Constructors #### CommunityInformationConfiguration +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Configuration/CommunityInformationConfiguration.cs#L5) ```csharp public CommunityInformationConfiguration() ``` diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreconfiguration-DefaultSettings.md b/CodeDocumentation/SharedLibraryCore/configuration/DefaultSettings.md similarity index 70% rename from CodeDocumentation/SharedLibraryCore/sharedlibrarycoreconfiguration-DefaultSettings.md rename to CodeDocumentation/SharedLibraryCore/configuration/DefaultSettings.md index a8a3029..29285c5 100644 --- a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreconfiguration-DefaultSettings.md +++ b/CodeDocumentation/SharedLibraryCore/configuration/DefaultSettings.md @@ -22,24 +22,24 @@ SharedLibraryCore.Interfaces.IBaseConfiguration --> SharedLibraryCore.Configurat | --- | --- | --- | | `string``[]` | [`AutoMessages`](#automessages) | `get, set` | | `string``[]` | [`DisallowedClientNames`](#disallowedclientnames) | `get, set` | -| [`GameStringConfiguration`](./sharedlibrarycoreconfiguration-GameStringConfiguration) | [`GameStrings`](#gamestrings) | `get, set` | -| [`GametypeConfiguration`](./sharedlibrarycoreconfiguration-GametypeConfiguration)`[]` | [`Gametypes`](#gametypes) | `get, set` | +| [`GameStringConfiguration`](./GameStringConfiguration.md) | [`GameStrings`](#gamestrings) | `get, set` | +| [`GametypeConfiguration`](./GametypeConfiguration.md)`[]` | [`Gametypes`](#gametypes) | `get, set` | | `string``[]` | [`GlobalRules`](#globalrules) | `get, set` | -| [`MapConfiguration`](./sharedlibrarycoreconfiguration-MapConfiguration)`[]` | [`Maps`](#maps) | `get, set` | -| [`QuickMessageConfiguration`](./sharedlibrarycoreconfiguration-QuickMessageConfiguration)`[]` | [`QuickMessages`](#quickmessages) | `get, set` | +| [`MapConfiguration`](./MapConfiguration.md)`[]` | [`Maps`](#maps) | `get, set` | +| [`QuickMessageConfiguration`](./QuickMessageConfiguration.md)`[]` | [`QuickMessages`](#quickmessages) | `get, set` | ### Methods #### Public methods | Returns | Name | | --- | --- | -| [`IBaseConfiguration`](./sharedlibrarycoreinterfaces-IBaseConfiguration) | [`Generate`](#generate)() | +| [`IBaseConfiguration`](../interfaces/IBaseConfiguration.md) | [`Generate`](#generate)() | | `string` | [`Name`](#name)() | ## Details ### Inheritance - [ `IBaseConfiguration` -](./sharedlibrarycoreinterfaces-IBaseConfiguration) +](../interfaces/IBaseConfiguration.md) ### Constructors #### DefaultSettings @@ -49,11 +49,13 @@ public DefaultSettings() ### Methods #### Generate +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Configuration/DefaultSettings.cs#L16) ```csharp public virtual IBaseConfiguration Generate() ``` #### Name +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Configuration/DefaultSettings.cs#L21) ```csharp public virtual string Name() ``` diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreconfiguration-GameStringConfiguration.md b/CodeDocumentation/SharedLibraryCore/configuration/GameStringConfiguration.md similarity index 89% rename from CodeDocumentation/SharedLibraryCore/sharedlibrarycoreconfiguration-GameStringConfiguration.md rename to CodeDocumentation/SharedLibraryCore/configuration/GameStringConfiguration.md index fd797b4..fe123fb 100644 --- a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreconfiguration-GameStringConfiguration.md +++ b/CodeDocumentation/SharedLibraryCore/configuration/GameStringConfiguration.md @@ -33,6 +33,7 @@ public GameStringConfiguration() ### Methods #### GetStringForGame +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Configuration/GameStringConfiguration.cs#L10) ```csharp public string GetStringForGame(string key, Nullable game) ``` diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreconfiguration-GametypeConfiguration.md b/CodeDocumentation/SharedLibraryCore/configuration/GametypeConfiguration.md similarity index 89% rename from CodeDocumentation/SharedLibraryCore/sharedlibrarycoreconfiguration-GametypeConfiguration.md rename to CodeDocumentation/SharedLibraryCore/configuration/GametypeConfiguration.md index 0a7cdeb..aa8ccdc 100644 --- a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreconfiguration-GametypeConfiguration.md +++ b/CodeDocumentation/SharedLibraryCore/configuration/GametypeConfiguration.md @@ -16,7 +16,7 @@ | Type | Name | Methods | | --- | --- | --- | | `Game` | [`Game`](#game) | `get, set` | -| [`Gametype`](./sharedlibrarycore-Gametype)`[]` | [`Gametypes`](#gametypes) | `get, set` | +| [`Gametype`](../Gametype.md)`[]` | [`Gametypes`](#gametypes) | `get, set` | ## Details ### Constructors diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreconfiguration-MapConfiguration.md b/CodeDocumentation/SharedLibraryCore/configuration/MapConfiguration.md similarity index 90% rename from CodeDocumentation/SharedLibraryCore/sharedlibrarycoreconfiguration-MapConfiguration.md rename to CodeDocumentation/SharedLibraryCore/configuration/MapConfiguration.md index d628962..6e7c87c 100644 --- a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreconfiguration-MapConfiguration.md +++ b/CodeDocumentation/SharedLibraryCore/configuration/MapConfiguration.md @@ -16,7 +16,7 @@ | Type | Name | Methods | | --- | --- | --- | | `Game` | [`Game`](#game) | `get, set` | -| [`Map`](./sharedlibrarycore-Map)`[]` | [`Maps`](#maps) | `get, set` | +| [`Map`](../Map.md)`[]` | [`Maps`](#maps) | `get, set` | ## Details ### Constructors diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreconfiguration-QuickMessageConfiguration.md b/CodeDocumentation/SharedLibraryCore/configuration/QuickMessageConfiguration.md similarity index 100% rename from CodeDocumentation/SharedLibraryCore/sharedlibrarycoreconfiguration-QuickMessageConfiguration.md rename to CodeDocumentation/SharedLibraryCore/configuration/QuickMessageConfiguration.md diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreconfiguration-ServerConfiguration.md b/CodeDocumentation/SharedLibraryCore/configuration/ServerConfiguration.md similarity index 73% rename from CodeDocumentation/SharedLibraryCore/sharedlibrarycoreconfiguration-ServerConfiguration.md rename to CodeDocumentation/SharedLibraryCore/configuration/ServerConfiguration.md index 3eb6026..68b7a99 100644 --- a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreconfiguration-ServerConfiguration.md +++ b/CodeDocumentation/SharedLibraryCore/configuration/ServerConfiguration.md @@ -37,9 +37,9 @@ SharedLibraryCore.Interfaces.IBaseConfiguration --> SharedLibraryCore.Configurat #### Public methods | Returns | Name | | --- | --- | -| `void` | [`AddEventParser`](#addeventparser)([`IEventParser`](./sharedlibrarycoreinterfaces-IEventParser) parser) | -| `void` | [`AddRConParser`](#addrconparser)([`IRConParser`](./sharedlibrarycoreinterfaces-IRConParser) parser) | -| [`IBaseConfiguration`](./sharedlibrarycoreinterfaces-IBaseConfiguration) | [`Generate`](#generate)() | +| `void` | [`AddEventParser`](#addeventparser)([`IEventParser`](../interfaces/IEventParser.md) parser) | +| `void` | [`AddRConParser`](#addrconparser)([`IRConParser`](../interfaces/IRConParser.md) parser) | +| [`IBaseConfiguration`](../interfaces/IBaseConfiguration.md) | [`Generate`](#generate)() | | `void` | [`ModifyParsers`](#modifyparsers)() | | `string` | [`Name`](#name)() | @@ -47,44 +47,50 @@ SharedLibraryCore.Interfaces.IBaseConfiguration --> SharedLibraryCore.Configurat ### Inheritance - [ `IBaseConfiguration` -](./sharedlibrarycoreinterfaces-IBaseConfiguration) +](../interfaces/IBaseConfiguration.md) ### Constructors #### ServerConfiguration +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Configuration/ServerConfiguration.cs#L32) ```csharp public ServerConfiguration() ``` ### Methods #### Generate +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Configuration/ServerConfiguration.cs#L60) ```csharp public virtual IBaseConfiguration Generate() ``` #### Name +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Configuration/ServerConfiguration.cs#L125) ```csharp public virtual string Name() ``` #### AddRConParser +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Configuration/ServerConfiguration.cs#L130) ```csharp public void AddRConParser(IRConParser parser) ``` ##### Arguments | Type | Name | Description | | --- | --- | --- | -| [`IRConParser`](./sharedlibrarycoreinterfaces-IRConParser) | parser | | +| [`IRConParser`](../interfaces/IRConParser.md) | parser | | #### AddEventParser +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Configuration/ServerConfiguration.cs#L135) ```csharp public void AddEventParser(IEventParser parser) ``` ##### Arguments | Type | Name | Description | | --- | --- | --- | -| [`IEventParser`](./sharedlibrarycoreinterfaces-IEventParser) | parser | | +| [`IEventParser`](../interfaces/IEventParser.md) | parser | | #### ModifyParsers +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Configuration/ServerConfiguration.cs#L16707566) ```csharp public void ModifyParsers() ``` diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreconfiguration-SocialAccountConfiguration.md b/CodeDocumentation/SharedLibraryCore/configuration/SocialAccountConfiguration.md similarity index 100% rename from CodeDocumentation/SharedLibraryCore/sharedlibrarycoreconfiguration-SocialAccountConfiguration.md rename to CodeDocumentation/SharedLibraryCore/configuration/SocialAccountConfiguration.md diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreconfiguration-WebfrontConfiguration.md b/CodeDocumentation/SharedLibraryCore/configuration/WebfrontConfiguration.md similarity index 100% rename from CodeDocumentation/SharedLibraryCore/sharedlibrarycoreconfiguration-WebfrontConfiguration.md rename to CodeDocumentation/SharedLibraryCore/configuration/WebfrontConfiguration.md diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreconfigurationattributes-ConfigurationIgnore.md b/CodeDocumentation/SharedLibraryCore/configuration/attributes/ConfigurationIgnore.md similarity index 100% rename from CodeDocumentation/SharedLibraryCore/sharedlibrarycoreconfigurationattributes-ConfigurationIgnore.md rename to CodeDocumentation/SharedLibraryCore/configuration/attributes/ConfigurationIgnore.md diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreconfigurationattributes-ConfigurationLinked.md b/CodeDocumentation/SharedLibraryCore/configuration/attributes/ConfigurationLinked.md similarity index 88% rename from CodeDocumentation/SharedLibraryCore/sharedlibrarycoreconfigurationattributes-ConfigurationLinked.md rename to CodeDocumentation/SharedLibraryCore/configuration/attributes/ConfigurationLinked.md index 731d234..5654431 100644 --- a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreconfigurationattributes-ConfigurationLinked.md +++ b/CodeDocumentation/SharedLibraryCore/configuration/attributes/ConfigurationLinked.md @@ -27,6 +27,7 @@ System.Attribute --> SharedLibraryCore.Configuration.Attributes.ConfigurationLin ### Constructors #### ConfigurationLinked +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Configuration/Attributes/ConfigurationLinked.cs#L8) ```csharp public ConfigurationLinked(string[] linkedPropertyNames) ``` diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreconfigurationattributes-ConfigurationOptional.md b/CodeDocumentation/SharedLibraryCore/configuration/attributes/ConfigurationOptional.md similarity index 100% rename from CodeDocumentation/SharedLibraryCore/sharedlibrarycoreconfigurationattributes-ConfigurationOptional.md rename to CodeDocumentation/SharedLibraryCore/configuration/attributes/ConfigurationOptional.md diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreconfigurationattributes-LocalizedDisplayName.md b/CodeDocumentation/SharedLibraryCore/configuration/attributes/LocalizedDisplayName.md similarity index 88% rename from CodeDocumentation/SharedLibraryCore/sharedlibrarycoreconfigurationattributes-LocalizedDisplayName.md rename to CodeDocumentation/SharedLibraryCore/configuration/attributes/LocalizedDisplayName.md index 368cba4..ddfc7b5 100644 --- a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreconfigurationattributes-LocalizedDisplayName.md +++ b/CodeDocumentation/SharedLibraryCore/configuration/attributes/LocalizedDisplayName.md @@ -27,6 +27,7 @@ System.ComponentModel.DisplayNameAttribute --> SharedLibraryCore.Configuration.A ### Constructors #### LocalizedDisplayName +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Configuration/Attributes/LocalizedDisplayName.cs#L9) ```csharp public LocalizedDisplayName(string localizationKey) ``` diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreconfigurationextensions-ConfigurationExtensions.md b/CodeDocumentation/SharedLibraryCore/configuration/extensions/ConfigurationExtensions.md similarity index 64% rename from CodeDocumentation/SharedLibraryCore/sharedlibrarycoreconfigurationextensions-ConfigurationExtensions.md rename to CodeDocumentation/SharedLibraryCore/configuration/extensions/ConfigurationExtensions.md index 1f520a0..0505442 100644 --- a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreconfigurationextensions-ConfigurationExtensions.md +++ b/CodeDocumentation/SharedLibraryCore/configuration/extensions/ConfigurationExtensions.md @@ -15,27 +15,29 @@ #### Public Static methods | Returns | Name | | --- | --- | -| (`string` Item1, `string` Item2)`[]` | [`TryGetRConPasswords`](#trygetrconpasswords)([`IRConParser`](./sharedlibrarycoreinterfaces-IRConParser) parser) | -| `void` | [`TrySetIpAddress`](#trysetipaddress)([`ServerConfiguration`](./sharedlibrarycoreconfiguration-ServerConfiguration) config) | +| (`string` Item1, `string` Item2)`[]` | [`TryGetRConPasswords`](#trygetrconpasswords)([`IRConParser`](../../interfaces/IRConParser.md) parser) | +| `void` | [`TrySetIpAddress`](#trysetipaddress)([`ServerConfiguration`](../ServerConfiguration.md) config) | ## Details ### Methods #### TrySetIpAddress +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Configuration/Extensions/ConfigurationExtensions.cs#L17) ```csharp public static void TrySetIpAddress(ServerConfiguration config) ``` ##### Arguments | Type | Name | Description | | --- | --- | --- | -| [`ServerConfiguration`](./sharedlibrarycoreconfiguration-ServerConfiguration) | config | | +| [`ServerConfiguration`](../ServerConfiguration.md) | config | | #### TryGetRConPasswords +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Configuration/Extensions/ConfigurationExtensions.cs#L42) ```csharp public static (string Item1, string Item2) TryGetRConPasswords(IRConParser parser) ``` ##### Arguments | Type | Name | Description | | --- | --- | --- | -| [`IRConParser`](./sharedlibrarycoreinterfaces-IRConParser) | parser | | +| [`IRConParser`](../../interfaces/IRConParser.md) | parser | | *Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreconfigurationvalidation-ApplicationConfigurationValidator.md b/CodeDocumentation/SharedLibraryCore/configuration/validation/ApplicationConfigurationValidator.md similarity index 78% rename from CodeDocumentation/SharedLibraryCore/sharedlibrarycoreconfigurationvalidation-ApplicationConfigurationValidator.md rename to CodeDocumentation/SharedLibraryCore/configuration/validation/ApplicationConfigurationValidator.md index 83c4963..c0a9038 100644 --- a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreconfigurationvalidation-ApplicationConfigurationValidator.md +++ b/CodeDocumentation/SharedLibraryCore/configuration/validation/ApplicationConfigurationValidator.md @@ -22,10 +22,11 @@ FluentValidation.AbstractValidator_1 --> SharedLibraryCore.Configuration.Validat Validation class for main application configuration ### Inheritance - - `AbstractValidator`<[`ApplicationConfiguration`](./sharedlibrarycoreconfiguration-ApplicationConfiguration)> + - `AbstractValidator`<[`ApplicationConfiguration`](../ApplicationConfiguration.md)> ### Constructors #### ApplicationConfigurationValidator +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Configuration/Validation/ApplicationConfigurationValidator.cs#L13) ```csharp public ApplicationConfigurationValidator() ``` diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreconfigurationvalidation-ServerConfigurationValidator.md b/CodeDocumentation/SharedLibraryCore/configuration/validation/ServerConfigurationValidator.md similarity index 78% rename from CodeDocumentation/SharedLibraryCore/sharedlibrarycoreconfigurationvalidation-ServerConfigurationValidator.md rename to CodeDocumentation/SharedLibraryCore/configuration/validation/ServerConfigurationValidator.md index 24065ac..02ef329 100644 --- a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreconfigurationvalidation-ServerConfigurationValidator.md +++ b/CodeDocumentation/SharedLibraryCore/configuration/validation/ServerConfigurationValidator.md @@ -22,10 +22,11 @@ FluentValidation.AbstractValidator_1 --> SharedLibraryCore.Configuration.Validat Validation class for server configuration ### Inheritance - - `AbstractValidator`<[`ServerConfiguration`](./sharedlibrarycoreconfiguration-ServerConfiguration)> + - `AbstractValidator`<[`ServerConfiguration`](../ServerConfiguration.md)> ### Constructors #### ServerConfigurationValidator +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Configuration/Validation/ServerConfigurationValidator.cs#L10) ```csharp public ServerConfigurationValidator() ``` diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoredatabasemodels-EFClient.md b/CodeDocumentation/SharedLibraryCore/database/models/EFClient.md similarity index 62% rename from CodeDocumentation/SharedLibraryCore/sharedlibrarycoredatabasemodels-EFClient.md rename to CodeDocumentation/SharedLibraryCore/database/models/EFClient.md index 824a95e..e99e78b 100644 --- a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoredatabasemodels-EFClient.md +++ b/CodeDocumentation/SharedLibraryCore/database/models/EFClient.md @@ -21,10 +21,10 @@ Data.Models.Client.EFClient --> SharedLibraryCore.Database.Models.EFClient | --- | --- | --- | | `string` | [`CleanedName`](#cleanedname) | `get` | | `int` | [`ClientNumber`](#clientnumber) | `get, set` | -| [`ClientPermission`](./sharedlibrarycorelocalization-ClientPermission) | [`ClientPermission`](#clientpermission) | `get` | +| [`ClientPermission`](../../localization/ClientPermission.md) | [`ClientPermission`](#clientpermission) | `get` | | `int` | [`ConnectionLength`](#connectionlength) | `get` | | `DateTime` | [`ConnectionTime`](#connectiontime) | `get, set` | -| [`Server`](./sharedlibrarycore-Server) | [`CurrentServer`](#currentserver) | `get, set` | +| [`Server`](../../Server.md) | [`CurrentServer`](#currentserver) | `get, set` | | `string` | [`GuidString`](#guidstring) | `get` | | `Nullable`<`int`> | [`IPAddress`](#ipaddress) | `get, set` | | `string` | [`IPAddressString`](#ipaddressstring) | `get` | @@ -52,28 +52,28 @@ Data.Models.Client.EFClient --> SharedLibraryCore.Database.Models.EFClient #### Public methods | Returns | Name | | --- | --- | -| [`GameEvent`](./sharedlibrarycore-GameEvent) | [`Ban`](#ban)(`string` banReason, [`EFClient`](sharedlibrarycoredatabasemodels-EFClient) sender, `bool` isEvade)
permanently ban a client | +| [`GameEvent`](../../GameEvent.md) | [`Ban`](#ban)(`string` banReason, [`EFClient`](sharedlibrarycore/database/models/EFClient.md) sender, `bool` isEvade)
permanently ban a client | | `Task`<`bool`> | [`CanConnect`](#canconnect)(`Nullable`<`int`> ipAddress, `bool` enableImplicitLinking) | | `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)() | | `bool` | [`IsAbleToConnectSimple`](#isabletoconnectsimple)()
Handles any client related logic on connection | -| [`GameEvent`](./sharedlibrarycore-GameEvent) | [`Kick`](#kick-12)(`...`)
kick a client for the given reason | +| [`GameEvent`](../../GameEvent.md) | [`Kick`](#kick-12)(`...`)
kick a client for the given reason | | `Task` | [`Lock`](#lock)() | | `Task` | [`OnDisconnect`](#ondisconnect)() | | `Task` | [`OnJoin`](#onjoin)(`Nullable`<`int`> ipAddress, `bool` enableImplicitLinking) | -| [`GameEvent`](./sharedlibrarycore-GameEvent) | [`Report`](#report)(`string` reportReason, [`EFClient`](sharedlibrarycoredatabasemodels-EFClient) sender)
report a client for a given reason | -| [`GameEvent`](./sharedlibrarycore-GameEvent) | [`SetLevel`](#setlevel)(`Permission` newPermission, [`EFClient`](sharedlibrarycoredatabasemodels-EFClient) sender) | -| [`GameEvent`](./sharedlibrarycore-GameEvent) | [`Tell`](#tell-12)(`...`)
send a message directly to the connected client | +| [`GameEvent`](../../GameEvent.md) | [`Report`](#report)(`string` reportReason, [`EFClient`](sharedlibrarycore/database/models/EFClient.md) sender)
report a client for a given reason | +| [`GameEvent`](../../GameEvent.md) | [`SetLevel`](#setlevel)(`Permission` newPermission, [`EFClient`](sharedlibrarycore/database/models/EFClient.md) sender) | +| [`GameEvent`](../../GameEvent.md) | [`Tell`](#tell-12)(`...`)
send a message directly to the connected client | | `Task` | [`TellAsync`](#tellasync)(`IEnumerable`<`string`> messages, `CancellationToken` token) | -| [`GameEvent`](./sharedlibrarycore-GameEvent) | [`TempBan`](#tempban)(`string` tempbanReason, `TimeSpan` banLength, [`EFClient`](sharedlibrarycoredatabasemodels-EFClient) sender)
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)
temporarily ban a client for the given time span | | `string` | [`ToString`](#tostring)() | -| [`GameEvent`](./sharedlibrarycore-GameEvent) | [`Unban`](#unban)(`string` unbanReason, [`EFClient`](sharedlibrarycoredatabasemodels-EFClient) sender)
unban a client | -| [`GameEvent`](./sharedlibrarycore-GameEvent) | [`Unflag`](#unflag)(`string` unflagReason, [`EFClient`](sharedlibrarycoredatabasemodels-EFClient) sender)
unflag a client for a given reason | +| [`GameEvent`](../../GameEvent.md) | [`Unban`](#unban)(`string` unbanReason, [`EFClient`](sharedlibrarycore/database/models/EFClient.md) sender)
unban a client | +| [`GameEvent`](../../GameEvent.md) | [`Unflag`](#unflag)(`string` unflagReason, [`EFClient`](sharedlibrarycore/database/models/EFClient.md) sender)
unflag a client for a given reason | | `void` | [`Unlock`](#unlock)() | | `void` | [`UpdateTeam`](#updateteam)(`string` newTeam) | -| [`GameEvent`](./sharedlibrarycore-GameEvent) | [`Warn`](#warn)(`string` warnReason, [`EFClient`](sharedlibrarycoredatabasemodels-EFClient) sender)
warn a client with given reason | -| [`GameEvent`](./sharedlibrarycore-GameEvent) | [`WarnClear`](#warnclear)([`EFClient`](sharedlibrarycoredatabasemodels-EFClient) sender)
clear all warnings for a client | +| [`GameEvent`](../../GameEvent.md) | [`Warn`](#warn)(`string` warnReason, [`EFClient`](sharedlibrarycore/database/models/EFClient.md) sender)
warn a client with given reason | +| [`GameEvent`](../../GameEvent.md) | [`WarnClear`](#warnclear)([`EFClient`](sharedlibrarycore/database/models/EFClient.md) sender)
clear all warnings for a client | ## Details ### Inheritance @@ -86,22 +86,26 @@ Data.Models.Client.EFClient --> SharedLibraryCore.Database.Models.EFClient ### Constructors #### EFClient +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/PartialEntities/EFClient.cs#L53) ```csharp public EFClient() ``` ### Methods #### Finalize +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/PartialEntities/EFClient.cs#L147) ```csharp protected override void Finalize() ``` #### ToString +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/PartialEntities/EFClient.cs#L152) ```csharp public override string ToString() ``` #### Tell [1/2] +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/PartialEntities/EFClient.cs#L162) ```csharp public GameEvent Tell(string message) ``` @@ -114,6 +118,7 @@ public GameEvent Tell(string message) send a message directly to the connected client #### Tell [2/2] +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/PartialEntities/EFClient.cs#L186) ```csharp public void Tell(IEnumerable messages) ``` @@ -133,6 +138,7 @@ public async Task TellAsync(IEnumerable messages, CancellationToken toke | `CancellationToken` | token | | #### Warn +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/PartialEntities/EFClient.cs#L214) ```csharp public GameEvent Warn(string warnReason, EFClient sender) ``` @@ -140,19 +146,20 @@ public GameEvent Warn(string warnReason, EFClient sender) | Type | Name | Description | | --- | --- | --- | | `string` | warnReason | reason for warn | -| [`EFClient`](sharedlibrarycoredatabasemodels-EFClient) | sender | client performing the warn | +| [`EFClient`](sharedlibrarycore/database/models/EFClient.md) | sender | client performing the warn | ##### Summary warn a client with given reason #### WarnClear +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/PartialEntities/EFClient.cs#L246) ```csharp public GameEvent WarnClear(EFClient sender) ``` ##### Arguments | Type | Name | Description | | --- | --- | --- | -| [`EFClient`](sharedlibrarycoredatabasemodels-EFClient) | sender | client performing the warn clear | +| [`EFClient`](sharedlibrarycore/database/models/EFClient.md) | sender | client performing the warn clear | ##### Summary clear all warnings for a client @@ -161,6 +168,7 @@ clear all warnings for a client #### Report +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/PartialEntities/EFClient.cs#L16707566) ```csharp public GameEvent Report(string reportReason, EFClient sender) ``` @@ -168,7 +176,7 @@ public GameEvent Report(string reportReason, EFClient sender) | Type | Name | Description | | --- | --- | --- | | `string` | reportReason | reason for the report | -| [`EFClient`](sharedlibrarycoredatabasemodels-EFClient) | sender | client performing the report | +| [`EFClient`](sharedlibrarycore/database/models/EFClient.md) | sender | client performing the report | ##### Summary report a client for a given reason @@ -177,6 +185,7 @@ report a client for a given reason #### Flag +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/PartialEntities/EFClient.cs#L317) ```csharp public GameEvent Flag(string flagReason, EFClient sender, Nullable flagLength) ``` @@ -184,10 +193,11 @@ public GameEvent Flag(string flagReason, EFClient sender, Nullable fla | Type | Name | Description | | --- | --- | --- | | `string` | flagReason | | -| [`EFClient`](sharedlibrarycoredatabasemodels-EFClient) | sender | | +| [`EFClient`](sharedlibrarycore/database/models/EFClient.md) | sender | | | `Nullable`<`TimeSpan`> | flagLength | | #### Unflag +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/PartialEntities/EFClient.cs#L350) ```csharp public GameEvent Unflag(string unflagReason, EFClient sender) ``` @@ -195,7 +205,7 @@ public GameEvent Unflag(string unflagReason, EFClient sender) | Type | Name | Description | | --- | --- | --- | | `string` | unflagReason | reason to unflag a player for | -| [`EFClient`](sharedlibrarycoredatabasemodels-EFClient) | sender | client performing the unflag | +| [`EFClient`](sharedlibrarycore/database/models/EFClient.md) | sender | client performing the unflag | ##### Summary unflag a client for a given reason @@ -204,6 +214,7 @@ unflag a client for a given reason game event for the un flug #### Kick [1/2] +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/PartialEntities/EFClient.cs#L381) ```csharp public GameEvent Kick(string kickReason, EFClient sender) ``` @@ -211,12 +222,13 @@ public GameEvent Kick(string kickReason, EFClient sender) | Type | Name | Description | | --- | --- | --- | | `string` | kickReason | reason to kick for | -| [`EFClient`](sharedlibrarycoredatabasemodels-EFClient) | sender | client performing the kick | +| [`EFClient`](sharedlibrarycore/database/models/EFClient.md) | sender | client performing the kick | ##### Summary kick a client for the given reason #### Kick [2/2] +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/PartialEntities/EFClient.cs#L392) ```csharp public GameEvent Kick(string kickReason, EFClient sender, EFPenalty originalPenalty) ``` @@ -224,13 +236,14 @@ public GameEvent Kick(string kickReason, EFClient sender, EFPenalty originalPena | Type | Name | Description | | --- | --- | --- | | `string` | kickReason | reason to kick for | -| [`EFClient`](sharedlibrarycoredatabasemodels-EFClient) | sender | client performing the kick | +| [`EFClient`](sharedlibrarycore/database/models/EFClient.md) | sender | client performing the kick | | `EFPenalty` | originalPenalty | original client penalty | ##### Summary kick a client for the given reason #### TempBan +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/PartialEntities/EFClient.cs#L422) ```csharp public GameEvent TempBan(string tempbanReason, TimeSpan banLength, EFClient sender) ``` @@ -239,12 +252,13 @@ public GameEvent TempBan(string tempbanReason, TimeSpan banLength, EFClient send | --- | --- | --- | | `string` | tempbanReason | reason for the temp ban | | `TimeSpan` | banLength | how long the temp ban lasts | -| [`EFClient`](sharedlibrarycoredatabasemodels-EFClient) | sender | client performing the tempban | +| [`EFClient`](sharedlibrarycore/database/models/EFClient.md) | sender | client performing the tempban | ##### Summary temporarily ban a client for the given time span #### Ban +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/PartialEntities/EFClient.cs#L452) ```csharp public GameEvent Ban(string banReason, EFClient sender, bool isEvade) ``` @@ -252,13 +266,14 @@ public GameEvent Ban(string banReason, EFClient sender, bool isEvade) | Type | Name | Description | | --- | --- | --- | | `string` | banReason | reason for the ban | -| [`EFClient`](sharedlibrarycoredatabasemodels-EFClient) | sender | client performing the ban | +| [`EFClient`](sharedlibrarycore/database/models/EFClient.md) | sender | client performing the ban | | `bool` | isEvade | obsolete | ##### Summary permanently ban a client #### Unban +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/PartialEntities/EFClient.cs#L487) ```csharp public GameEvent Unban(string unbanReason, EFClient sender) ``` @@ -266,7 +281,7 @@ public GameEvent Unban(string unbanReason, EFClient sender) | Type | Name | Description | | --- | --- | --- | | `string` | unbanReason | reason for the unban | -| [`EFClient`](sharedlibrarycoredatabasemodels-EFClient) | sender | client performing the unban | +| [`EFClient`](sharedlibrarycore/database/models/EFClient.md) | sender | client performing the unban | ##### Summary unban a client @@ -275,6 +290,7 @@ unban a client #### SetLevel +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/PartialEntities/EFClient.cs#L515) ```csharp public GameEvent SetLevel(Permission newPermission, EFClient sender) ``` @@ -282,9 +298,10 @@ public GameEvent SetLevel(Permission newPermission, EFClient sender) | Type | Name | Description | | --- | --- | --- | | `Permission` | newPermission | | -| [`EFClient`](sharedlibrarycoredatabasemodels-EFClient) | sender | | +| [`EFClient`](sharedlibrarycore/database/models/EFClient.md) | sender | | #### IsAbleToConnectSimple +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/PartialEntities/EFClient.cs#L548) ```csharp public bool IsAbleToConnectSimple() ``` @@ -317,6 +334,7 @@ public async Task CanConnect(Nullable ipAddress, bool enableImplicitL | `bool` | enableImplicitLinking | | #### UpdateTeam +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/PartialEntities/EFClient.cs#L787) ```csharp public void UpdateTeam(string newTeam) ``` @@ -331,11 +349,13 @@ public async Task Lock() ``` #### Unlock +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/PartialEntities/EFClient.cs#L810) ```csharp public void Unlock() ``` #### Equals +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/PartialEntities/EFClient.cs#L818) ```csharp public override bool Equals(object obj) ``` @@ -345,6 +365,7 @@ public override bool Equals(object obj) | `object` | obj | | #### GetHashCode +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/PartialEntities/EFClient.cs#L823) ```csharp public override int GetHashCode() ``` diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoredatabasemodelsefclient-ClientState.md b/CodeDocumentation/SharedLibraryCore/database/models/efclient/ClientState.md similarity index 100% rename from CodeDocumentation/SharedLibraryCore/sharedlibrarycoredatabasemodelsefclient-ClientState.md rename to CodeDocumentation/SharedLibraryCore/database/models/efclient/ClientState.md diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoredatabasemodelsefclient-TeamType.md b/CodeDocumentation/SharedLibraryCore/database/models/efclient/TeamType.md similarity index 100% rename from CodeDocumentation/SharedLibraryCore/sharedlibrarycoredatabasemodelsefclient-TeamType.md rename to CodeDocumentation/SharedLibraryCore/database/models/efclient/TeamType.md diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoredtos-AuditInfo.md b/CodeDocumentation/SharedLibraryCore/dtos/AuditInfo.md similarity index 100% rename from CodeDocumentation/SharedLibraryCore/sharedlibrarycoredtos-AuditInfo.md rename to CodeDocumentation/SharedLibraryCore/dtos/AuditInfo.md diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoredtos-ChatInfo.md b/CodeDocumentation/SharedLibraryCore/dtos/ChatInfo.md similarity index 100% rename from CodeDocumentation/SharedLibraryCore/sharedlibrarycoredtos-ChatInfo.md rename to CodeDocumentation/SharedLibraryCore/dtos/ChatInfo.md diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoredtos-ClientCountSnapshot.md b/CodeDocumentation/SharedLibraryCore/dtos/ClientCountSnapshot.md similarity index 100% rename from CodeDocumentation/SharedLibraryCore/sharedlibrarycoredtos-ClientCountSnapshot.md rename to CodeDocumentation/SharedLibraryCore/dtos/ClientCountSnapshot.md diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoredtos-ClientHistoryInfo.md b/CodeDocumentation/SharedLibraryCore/dtos/ClientHistoryInfo.md similarity index 76% rename from CodeDocumentation/SharedLibraryCore/sharedlibrarycoredtos-ClientHistoryInfo.md rename to CodeDocumentation/SharedLibraryCore/dtos/ClientHistoryInfo.md index fb96f42..38b5f55 100644 --- a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoredtos-ClientHistoryInfo.md +++ b/CodeDocumentation/SharedLibraryCore/dtos/ClientHistoryInfo.md @@ -15,12 +15,13 @@ #### Public properties | Type | Name | Methods | | --- | --- | --- | -| `List`<[`ClientCountSnapshot`](./sharedlibrarycoredtos-ClientCountSnapshot)> | [`ClientCounts`](#clientcounts) | `get, set` | +| `List`<[`ClientCountSnapshot`](./ClientCountSnapshot.md)> | [`ClientCounts`](#clientcounts) | `get, set` | | `long` | [`ServerId`](#serverid) | `get, set` | ## Details ### Constructors #### ClientHistoryInfo +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Dtos/ClientHistoryInfo.cs#L9) ```csharp public ClientHistoryInfo() ``` diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoredtos-ClientInfo.md b/CodeDocumentation/SharedLibraryCore/dtos/ClientInfo.md similarity index 100% rename from CodeDocumentation/SharedLibraryCore/sharedlibrarycoredtos-ClientInfo.md rename to CodeDocumentation/SharedLibraryCore/dtos/ClientInfo.md diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoredtos-CommandResponseInfo.md b/CodeDocumentation/SharedLibraryCore/dtos/CommandResponseInfo.md similarity index 100% rename from CodeDocumentation/SharedLibraryCore/sharedlibrarycoredtos-CommandResponseInfo.md rename to CodeDocumentation/SharedLibraryCore/dtos/CommandResponseInfo.md diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoredtos-EntityInfo.md b/CodeDocumentation/SharedLibraryCore/dtos/EntityInfo.md similarity index 100% rename from CodeDocumentation/SharedLibraryCore/sharedlibrarycoredtos-EntityInfo.md rename to CodeDocumentation/SharedLibraryCore/dtos/EntityInfo.md diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoredtos-ErrorResponse.md b/CodeDocumentation/SharedLibraryCore/dtos/ErrorResponse.md similarity index 100% rename from CodeDocumentation/SharedLibraryCore/sharedlibrarycoredtos-ErrorResponse.md rename to CodeDocumentation/SharedLibraryCore/dtos/ErrorResponse.md diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoredtos-EventInfo.md b/CodeDocumentation/SharedLibraryCore/dtos/EventInfo.md similarity index 73% rename from CodeDocumentation/SharedLibraryCore/sharedlibrarycoredtos-EventInfo.md rename to CodeDocumentation/SharedLibraryCore/dtos/EventInfo.md index 7648f84..84a6f8e 100644 --- a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoredtos-EventInfo.md +++ b/CodeDocumentation/SharedLibraryCore/dtos/EventInfo.md @@ -19,13 +19,13 @@ This class wraps the information related to a generated event for the API | Type | Name | Methods | | --- | --- | --- | | `DateTime` | [`EventTime`](#eventtime) | `get, set` | -| [`EntityInfo`](./sharedlibrarycoredtos-EntityInfo) | [`EventType`](#eventtype) | `get, set` | +| [`EntityInfo`](./EntityInfo.md) | [`EventType`](#eventtype) | `get, set` | | `string` | [`ExtraInfo`](#extrainfo) | `get, set` | -| [`EntityInfo`](./sharedlibrarycoredtos-EntityInfo) | [`GameInfo`](#gameinfo) | `get, set` | +| [`EntityInfo`](./EntityInfo.md) | [`GameInfo`](#gameinfo) | `get, set` | | `string` | [`Id`](#id) | `get` | -| [`EntityInfo`](./sharedlibrarycoredtos-EntityInfo) | [`OriginEntity`](#originentity) | `get, set` | -| [`EntityInfo`](./sharedlibrarycoredtos-EntityInfo) | [`OwnerEntity`](#ownerentity) | `get, set` | -| [`EntityInfo`](./sharedlibrarycoredtos-EntityInfo) | [`TargetEntity`](#targetentity) | `get, set` | +| [`EntityInfo`](./EntityInfo.md) | [`OriginEntity`](#originentity) | `get, set` | +| [`EntityInfo`](./EntityInfo.md) | [`OwnerEntity`](#ownerentity) | `get, set` | +| [`EntityInfo`](./EntityInfo.md) | [`TargetEntity`](#targetentity) | `get, set` | ## Details ### Summary @@ -33,6 +33,7 @@ This class wraps the information related to a generated event for the API ### Constructors #### EventInfo +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Dtos/EventInfo.cs#L17) ```csharp public EventInfo() ``` diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoredtos-FindClientRequest.md b/CodeDocumentation/SharedLibraryCore/dtos/FindClientRequest.md similarity index 89% rename from CodeDocumentation/SharedLibraryCore/sharedlibrarycoredtos-FindClientRequest.md rename to CodeDocumentation/SharedLibraryCore/dtos/FindClientRequest.md index 7747cd4..1710951 100644 --- a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoredtos-FindClientRequest.md +++ b/CodeDocumentation/SharedLibraryCore/dtos/FindClientRequest.md @@ -30,7 +30,7 @@ SharedLibraryCore.Dtos.PaginationRequest --> SharedLibraryCore.Dtos.FindClientRe ### Inheritance - [ `PaginationRequest` -](./sharedlibrarycoredtos-PaginationRequest) +](./PaginationRequest.md) ### Constructors #### FindClientRequest @@ -40,6 +40,7 @@ public FindClientRequest() ### Methods #### ToDebugString +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Dtos/FindClientRequest.cs#L16) ```csharp public string ToDebugString() ``` diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoredtos-FindClientResult.md b/CodeDocumentation/SharedLibraryCore/dtos/FindClientResult.md similarity index 100% rename from CodeDocumentation/SharedLibraryCore/sharedlibrarycoredtos-FindClientResult.md rename to CodeDocumentation/SharedLibraryCore/dtos/FindClientResult.md diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoredtos-IW4MAdminInfo.md b/CodeDocumentation/SharedLibraryCore/dtos/IW4MAdminInfo.md similarity index 100% rename from CodeDocumentation/SharedLibraryCore/sharedlibrarycoredtos-IW4MAdminInfo.md rename to CodeDocumentation/SharedLibraryCore/dtos/IW4MAdminInfo.md diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoredtos-LookupValueT.md b/CodeDocumentation/SharedLibraryCore/dtos/LookupValueT.md similarity index 92% rename from CodeDocumentation/SharedLibraryCore/sharedlibrarycoredtos-LookupValueT.md rename to CodeDocumentation/SharedLibraryCore/dtos/LookupValueT.md index da99334..b149f5f 100644 --- a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoredtos-LookupValueT.md +++ b/CodeDocumentation/SharedLibraryCore/dtos/LookupValueT.md @@ -27,7 +27,7 @@ SharedLibraryCore.Interfaces.ILookupValue_1 --> SharedLibraryCore.Dtos.LookupVal ## Details ### Inheritance - - [`ILookupValue`](./sharedlibrarycoreinterfaces-ILookupValueT)<`TObject`> + - [`ILookupValue`](../interfaces/ILookupValueT.md)<`TObject`> ### Constructors #### LookupValue diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoredtos-Page.md b/CodeDocumentation/SharedLibraryCore/dtos/Page.md similarity index 100% rename from CodeDocumentation/SharedLibraryCore/sharedlibrarycoredtos-Page.md rename to CodeDocumentation/SharedLibraryCore/dtos/Page.md diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoredtos-PaginationRequest.md b/CodeDocumentation/SharedLibraryCore/dtos/PaginationRequest.md similarity index 87% rename from CodeDocumentation/SharedLibraryCore/sharedlibrarycoredtos-PaginationRequest.md rename to CodeDocumentation/SharedLibraryCore/dtos/PaginationRequest.md index ee7fd2e..e55995f 100644 --- a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoredtos-PaginationRequest.md +++ b/CodeDocumentation/SharedLibraryCore/dtos/PaginationRequest.md @@ -21,7 +21,7 @@ pagination information holder class | `Nullable`<`DateTime`> | [`After`](#after) | `get, set` | | `Nullable`<`DateTime`> | [`Before`](#before) | `get, set` | | `int` | [`Count`](#count)
how many items to take | `get, set` | -| [`SortDirection`](./sharedlibrarycoredtos-SortDirection) | [`Direction`](#direction)
direction of ordering | `get, set` | +| [`SortDirection`](./SortDirection.md) | [`Direction`](#direction)
direction of ordering | `get, set` | | `string` | [`Filter`](#filter)
filter query | `get, set` | | `int` | [`Offset`](#offset)
how many items to skip | `get, set` | @@ -31,6 +31,7 @@ pagination information holder class ### Constructors #### PaginationRequest +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Dtos/PaginationRequest.cs#L18) ```csharp public PaginationRequest() ``` diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoredtos-PenaltyInfo.md b/CodeDocumentation/SharedLibraryCore/dtos/PenaltyInfo.md similarity index 99% rename from CodeDocumentation/SharedLibraryCore/sharedlibrarycoredtos-PenaltyInfo.md rename to CodeDocumentation/SharedLibraryCore/dtos/PenaltyInfo.md index 70ca441..aac4c2b 100644 --- a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoredtos-PenaltyInfo.md +++ b/CodeDocumentation/SharedLibraryCore/dtos/PenaltyInfo.md @@ -45,7 +45,7 @@ SharedLibraryCore.Dtos.SharedInfo --> SharedLibraryCore.Dtos.PenaltyInfo ### Inheritance - [ `SharedInfo` -](./sharedlibrarycoredtos-SharedInfo) +](./SharedInfo.md) ### Constructors #### PenaltyInfo diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoredtos-PlayerInfo.md b/CodeDocumentation/SharedLibraryCore/dtos/PlayerInfo.md similarity index 85% rename from CodeDocumentation/SharedLibraryCore/sharedlibrarycoredtos-PlayerInfo.md rename to CodeDocumentation/SharedLibraryCore/dtos/PlayerInfo.md index 7c852bc..30a20e8 100644 --- a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoredtos-PlayerInfo.md +++ b/CodeDocumentation/SharedLibraryCore/dtos/PlayerInfo.md @@ -23,21 +23,21 @@ | `string` | [`ConnectProtocolUrl`](#connectprotocolurl) | `get, set` | | `string` | [`CurrentServerName`](#currentservername) | `get, set` | | `Game` | [`Game`](#game) | `get, set` | -| [`IGeoLocationResult`](./sharedlibrarycoreinterfaces-IGeoLocationResult) | [`GeoLocationInfo`](#geolocationinfo) | `get, set` | +| [`IGeoLocationResult`](../interfaces/IGeoLocationResult.md) | [`GeoLocationInfo`](#geolocationinfo) | `get, set` | | `bool` | [`HasActivePenalty`](#hasactivepenalty) | `get, set` | | `string` | [`IPAddress`](#ipaddress) | `get, set` | | `List`<(`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` | | `string` | [`LastConnectionText`](#lastconnectiontext) | `get` | | `string` | [`Level`](#level) | `get, set` | | `int` | [`LevelInt`](#levelint) | `get, set` | | `IDictionary`<`int`, `long`> | [`LinkedAccounts`](#linkedaccounts) | `get, set` | -| `List`<[`InformationResponse`](./sharedlibrarycoredtosmetaresponses-InformationResponse)> | [`Meta`](#meta) | `get, set` | -| `Nullable`<[`MetaType`](./sharedlibrarycoreinterfaces-MetaType)> | [`MetaFilterType`](#metafiltertype) | `get, set` | +| `List`<[`InformationResponse`](meta/responses/InformationResponse.md)> | [`Meta`](#meta) | `get, set` | +| `Nullable`<[`MetaType`](../interfaces/MetaType.md)> | [`MetaFilterType`](#metafiltertype) | `get, set` | | `string` | [`Name`](#name) | `get, set` | | `long` | [`NetworkId`](#networkid) | `get, set` | -| [`ClientNoteMetaResponse`](./sharedlibrarycoredtosmetaresponses-ClientNoteMetaResponse) | [`NoteMeta`](#notemeta) | `get, set` | +| [`ClientNoteMetaResponse`](meta/responses/ClientNoteMetaResponse.md) | [`NoteMeta`](#notemeta) | `get, set` | | `bool` | [`Online`](#online) | `get, set` | | `string` | [`Tag`](#tag) | `get, set` | | `string` | [`TimeOnline`](#timeonline) | `get, set` | diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoredtos-ServerInfo.md b/CodeDocumentation/SharedLibraryCore/dtos/ServerInfo.md similarity index 86% rename from CodeDocumentation/SharedLibraryCore/sharedlibrarycoredtos-ServerInfo.md rename to CodeDocumentation/SharedLibraryCore/dtos/ServerInfo.md index 99254cb..0aea53e 100644 --- a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoredtos-ServerInfo.md +++ b/CodeDocumentation/SharedLibraryCore/dtos/ServerInfo.md @@ -15,9 +15,9 @@ #### Public properties | Type | Name | Methods | | --- | --- | --- | -| `List`<[`ChatInfo`](./sharedlibrarycoredtos-ChatInfo)> | [`ChatHistory`](#chathistory) | `get, set` | +| `List`<[`ChatInfo`](./ChatInfo.md)> | [`ChatHistory`](#chathistory) | `get, set` | | `int` | [`ClientCount`](#clientcount) | `get, set` | -| [`ClientHistoryInfo`](./sharedlibrarycoredtos-ClientHistoryInfo) | [`ClientHistory`](#clienthistory) | `get, set` | +| [`ClientHistoryInfo`](./ClientHistoryInfo.md) | [`ClientHistory`](#clienthistory) | `get, set` | | `string` | [`ConnectProtocolUrl`](#connectprotocolurl) | `get, set` | | `string` | [`Endpoint`](#endpoint) | `get` | | `string` | [`ExternalIPAddress`](#externalipaddress) | `get, set` | @@ -31,10 +31,10 @@ | `int` | [`MaxClients`](#maxclients) | `get, set` | | `string` | [`Name`](#name) | `get, set` | | `bool` | [`Online`](#online) | `get, set` | -| `List`<[`PlayerInfo`](./sharedlibrarycoredtos-PlayerInfo)> | [`Players`](#players) | `get, set` | +| `List`<[`PlayerInfo`](./PlayerInfo.md)> | [`Players`](#players) | `get, set` | | `int` | [`Port`](#port) | `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 ### Constructors diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoredtos-SharedInfo.md b/CodeDocumentation/SharedLibraryCore/dtos/SharedInfo.md similarity index 88% rename from CodeDocumentation/SharedLibraryCore/sharedlibrarycoredtos-SharedInfo.md rename to CodeDocumentation/SharedLibraryCore/dtos/SharedInfo.md index 85b0b23..e20c32a 100644 --- a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoredtos-SharedInfo.md +++ b/CodeDocumentation/SharedLibraryCore/dtos/SharedInfo.md @@ -22,6 +22,7 @@ ## Details ### Constructors #### SharedInfo +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Dtos/SharedInfo.cs#L6) ```csharp public SharedInfo() ``` diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoredtos-SortDirection.md b/CodeDocumentation/SharedLibraryCore/dtos/SortDirection.md similarity index 100% rename from CodeDocumentation/SharedLibraryCore/sharedlibrarycoredtos-SortDirection.md rename to CodeDocumentation/SharedLibraryCore/dtos/SortDirection.md diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoredtosmeta-WebfrontTranslationHelper.md b/CodeDocumentation/SharedLibraryCore/dtos/meta/WebfrontTranslationHelper.md similarity index 100% rename from CodeDocumentation/SharedLibraryCore/sharedlibrarycoredtosmeta-WebfrontTranslationHelper.md rename to CodeDocumentation/SharedLibraryCore/dtos/meta/WebfrontTranslationHelper.md diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoredtosmetarequests-BaseClientMetaRequest.md b/CodeDocumentation/SharedLibraryCore/dtos/meta/requests/BaseClientMetaRequest.md similarity index 95% rename from CodeDocumentation/SharedLibraryCore/sharedlibrarycoredtosmetarequests-BaseClientMetaRequest.md rename to CodeDocumentation/SharedLibraryCore/dtos/meta/requests/BaseClientMetaRequest.md index d919ea7..5389693 100644 --- a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoredtosmetarequests-BaseClientMetaRequest.md +++ b/CodeDocumentation/SharedLibraryCore/dtos/meta/requests/BaseClientMetaRequest.md @@ -25,7 +25,7 @@ SharedLibraryCore.Dtos.PaginationRequest --> SharedLibraryCore.Dtos.Meta.Request ### Inheritance - [ `PaginationRequest` -](./sharedlibrarycoredtos-PaginationRequest) +](../../PaginationRequest.md) ### Constructors #### BaseClientMetaRequest diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoredtosmetarequests-ReceivedPenaltyRequest.md b/CodeDocumentation/SharedLibraryCore/dtos/meta/requests/ReceivedPenaltyRequest.md similarity index 92% rename from CodeDocumentation/SharedLibraryCore/sharedlibrarycoredtosmetarequests-ReceivedPenaltyRequest.md rename to CodeDocumentation/SharedLibraryCore/dtos/meta/requests/ReceivedPenaltyRequest.md index 794b547..870a350 100644 --- a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoredtosmetarequests-ReceivedPenaltyRequest.md +++ b/CodeDocumentation/SharedLibraryCore/dtos/meta/requests/ReceivedPenaltyRequest.md @@ -16,7 +16,7 @@ SharedLibraryCore.Dtos.Meta.Requests.BaseClientMetaRequest --> SharedLibraryCore ### Inheritance - [ `BaseClientMetaRequest` -](./sharedlibrarycoredtosmetarequests-BaseClientMetaRequest) +](./BaseClientMetaRequest.md) ### Constructors #### ReceivedPenaltyRequest diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoredtosmetaresponses-AdministeredPenaltyResponse.md b/CodeDocumentation/SharedLibraryCore/dtos/meta/responses/AdministeredPenaltyResponse.md similarity index 92% rename from CodeDocumentation/SharedLibraryCore/sharedlibrarycoredtosmetaresponses-AdministeredPenaltyResponse.md rename to CodeDocumentation/SharedLibraryCore/dtos/meta/responses/AdministeredPenaltyResponse.md index 1132f14..01814ba 100644 --- a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoredtosmetaresponses-AdministeredPenaltyResponse.md +++ b/CodeDocumentation/SharedLibraryCore/dtos/meta/responses/AdministeredPenaltyResponse.md @@ -16,7 +16,7 @@ SharedLibraryCore.Dtos.Meta.Responses.ReceivedPenaltyResponse --> SharedLibraryC ### Inheritance - [ `ReceivedPenaltyResponse` -](./sharedlibrarycoredtosmetaresponses-ReceivedPenaltyResponse) +](./ReceivedPenaltyResponse.md) ### Constructors #### AdministeredPenaltyResponse diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoredtosmetaresponses-BaseMetaResponse.md b/CodeDocumentation/SharedLibraryCore/dtos/meta/responses/BaseMetaResponse.md similarity index 91% rename from CodeDocumentation/SharedLibraryCore/sharedlibrarycoredtosmetaresponses-BaseMetaResponse.md rename to CodeDocumentation/SharedLibraryCore/dtos/meta/responses/BaseMetaResponse.md index 1315692..90fed89 100644 --- a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoredtosmetaresponses-BaseMetaResponse.md +++ b/CodeDocumentation/SharedLibraryCore/dtos/meta/responses/BaseMetaResponse.md @@ -29,17 +29,17 @@ SharedLibraryCore.Interfaces.IClientMetaResponse --> SharedLibraryCore.Dtos.Meta | `long` | [`MetaId`](#metaid) | `get, set` | | `Nullable`<`int`> | [`Order`](#order) | `get, set` | | `bool` | [`ShouldDisplay`](#shoulddisplay) | `get, set` | -| [`MetaType`](./sharedlibrarycoreinterfaces-MetaType) | [`Type`](#type) | `get, set` | +| [`MetaType`](../../../interfaces/MetaType.md) | [`Type`](#type) | `get, set` | | `DateTime` | [`When`](#when) | `get, set` | ## Details ### Inheritance - [ `IClientMeta` -](./sharedlibrarycoreinterfaces-IClientMeta) +](../../../interfaces/IClientMeta.md) - [ `IClientMetaResponse` -](./sharedlibrarycoreinterfaces-IClientMetaResponse) +](../../../interfaces/IClientMetaResponse.md) ### Constructors #### BaseMetaResponse diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoredtosmetaresponses-ClientNoteMetaResponse.md b/CodeDocumentation/SharedLibraryCore/dtos/meta/responses/ClientNoteMetaResponse.md similarity index 100% rename from CodeDocumentation/SharedLibraryCore/sharedlibrarycoredtosmetaresponses-ClientNoteMetaResponse.md rename to CodeDocumentation/SharedLibraryCore/dtos/meta/responses/ClientNoteMetaResponse.md diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoredtosmetaresponses-ConnectionHistoryResponse.md b/CodeDocumentation/SharedLibraryCore/dtos/meta/responses/ConnectionHistoryResponse.md similarity index 95% rename from CodeDocumentation/SharedLibraryCore/sharedlibrarycoredtosmetaresponses-ConnectionHistoryResponse.md rename to CodeDocumentation/SharedLibraryCore/dtos/meta/responses/ConnectionHistoryResponse.md index 081265a..ee4c92b 100644 --- a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoredtosmetaresponses-ConnectionHistoryResponse.md +++ b/CodeDocumentation/SharedLibraryCore/dtos/meta/responses/ConnectionHistoryResponse.md @@ -24,7 +24,7 @@ SharedLibraryCore.Dtos.Meta.Responses.BaseMetaResponse --> SharedLibraryCore.Dto ### Inheritance - [ `BaseMetaResponse` -](./sharedlibrarycoredtosmetaresponses-BaseMetaResponse) +](./BaseMetaResponse.md) ### Constructors #### ConnectionHistoryResponse diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoredtosmetaresponses-InformationResponse.md b/CodeDocumentation/SharedLibraryCore/dtos/meta/responses/InformationResponse.md similarity index 95% rename from CodeDocumentation/SharedLibraryCore/sharedlibrarycoredtosmetaresponses-InformationResponse.md rename to CodeDocumentation/SharedLibraryCore/dtos/meta/responses/InformationResponse.md index 7456615..69c5770 100644 --- a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoredtosmetaresponses-InformationResponse.md +++ b/CodeDocumentation/SharedLibraryCore/dtos/meta/responses/InformationResponse.md @@ -25,7 +25,7 @@ SharedLibraryCore.Dtos.Meta.Responses.BaseMetaResponse --> SharedLibraryCore.Dto ### Inheritance - [ `BaseMetaResponse` -](./sharedlibrarycoredtosmetaresponses-BaseMetaResponse) +](./BaseMetaResponse.md) ### Constructors #### InformationResponse diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoredtosmetaresponses-MessageResponse.md b/CodeDocumentation/SharedLibraryCore/dtos/meta/responses/MessageResponse.md similarity index 97% rename from CodeDocumentation/SharedLibraryCore/sharedlibrarycoredtosmetaresponses-MessageResponse.md rename to CodeDocumentation/SharedLibraryCore/dtos/meta/responses/MessageResponse.md index 5e44fa3..4e02fce 100644 --- a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoredtosmetaresponses-MessageResponse.md +++ b/CodeDocumentation/SharedLibraryCore/dtos/meta/responses/MessageResponse.md @@ -31,7 +31,7 @@ SharedLibraryCore.Dtos.Meta.Responses.BaseMetaResponse --> SharedLibraryCore.Dto ### Inheritance - [ `BaseMetaResponse` -](./sharedlibrarycoredtosmetaresponses-BaseMetaResponse) +](./BaseMetaResponse.md) ### Constructors #### MessageResponse diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoredtosmetaresponses-PermissionLevelChangedResponse.md b/CodeDocumentation/SharedLibraryCore/dtos/meta/responses/PermissionLevelChangedResponse.md similarity index 97% rename from CodeDocumentation/SharedLibraryCore/sharedlibrarycoredtosmetaresponses-PermissionLevelChangedResponse.md rename to CodeDocumentation/SharedLibraryCore/dtos/meta/responses/PermissionLevelChangedResponse.md index 42a5a76..777f21b 100644 --- a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoredtosmetaresponses-PermissionLevelChangedResponse.md +++ b/CodeDocumentation/SharedLibraryCore/dtos/meta/responses/PermissionLevelChangedResponse.md @@ -28,7 +28,7 @@ SharedLibraryCore.Dtos.Meta.Responses.BaseMetaResponse --> SharedLibraryCore.Dto ### Inheritance - [ `BaseMetaResponse` -](./sharedlibrarycoredtosmetaresponses-BaseMetaResponse) +](./BaseMetaResponse.md) ### Constructors #### PermissionLevelChangedResponse diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoredtosmetaresponses-ReceivedPenaltyResponse.md b/CodeDocumentation/SharedLibraryCore/dtos/meta/responses/ReceivedPenaltyResponse.md similarity index 97% rename from CodeDocumentation/SharedLibraryCore/sharedlibrarycoredtosmetaresponses-ReceivedPenaltyResponse.md rename to CodeDocumentation/SharedLibraryCore/dtos/meta/responses/ReceivedPenaltyResponse.md index 1664e20..9503d2f 100644 --- a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoredtosmetaresponses-ReceivedPenaltyResponse.md +++ b/CodeDocumentation/SharedLibraryCore/dtos/meta/responses/ReceivedPenaltyResponse.md @@ -35,7 +35,7 @@ SharedLibraryCore.Dtos.Meta.Responses.BaseMetaResponse --> SharedLibraryCore.Dto ### Inheritance - [ `BaseMetaResponse` -](./sharedlibrarycoredtosmetaresponses-BaseMetaResponse) +](./BaseMetaResponse.md) ### Constructors #### ReceivedPenaltyResponse diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoredtosmetaresponses-UpdatedAliasResponse.md b/CodeDocumentation/SharedLibraryCore/dtos/meta/responses/UpdatedAliasResponse.md similarity index 76% rename from CodeDocumentation/SharedLibraryCore/sharedlibrarycoredtosmetaresponses-UpdatedAliasResponse.md rename to CodeDocumentation/SharedLibraryCore/dtos/meta/responses/UpdatedAliasResponse.md index b03c485..e9e7e83 100644 --- a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoredtosmetaresponses-UpdatedAliasResponse.md +++ b/CodeDocumentation/SharedLibraryCore/dtos/meta/responses/UpdatedAliasResponse.md @@ -31,16 +31,18 @@ SharedLibraryCore.Dtos.Meta.Responses.BaseMetaResponse --> SharedLibraryCore.Dto ### Inheritance - [ `BaseMetaResponse` -](./sharedlibrarycoredtosmetaresponses-BaseMetaResponse) +](./BaseMetaResponse.md) ### Constructors #### UpdatedAliasResponse +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Dtos/Meta/Responses/UpdatedAliasResponse.cs#L6) ```csharp public UpdatedAliasResponse() ``` ### Methods #### Equals +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Dtos/Meta/Responses/UpdatedAliasResponse.cs#L9) ```csharp public override bool Equals(object obj) ``` @@ -50,6 +52,7 @@ public override bool Equals(object obj) | `object` | obj | | #### GetHashCode +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Dtos/Meta/Responses/UpdatedAliasResponse.cs#L19) ```csharp public override int GetHashCode() ``` diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreevents-CoreEvent.md b/CodeDocumentation/SharedLibraryCore/events/CoreEvent.md similarity index 91% rename from CodeDocumentation/SharedLibraryCore/sharedlibrarycoreevents-CoreEvent.md rename to CodeDocumentation/SharedLibraryCore/events/CoreEvent.md index 0e8a429..ed34f03 100644 --- a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreevents-CoreEvent.md +++ b/CodeDocumentation/SharedLibraryCore/events/CoreEvent.md @@ -25,6 +25,7 @@ ## Details ### Constructors #### CoreEvent +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Events/CoreEvent.cs#L7) ```csharp protected CoreEvent() ``` diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreevents-EventExtensions.md b/CodeDocumentation/SharedLibraryCore/events/EventExtensions.md similarity index 89% rename from CodeDocumentation/SharedLibraryCore/sharedlibrarycoreevents-EventExtensions.md rename to CodeDocumentation/SharedLibraryCore/events/EventExtensions.md index e6bfda3..9f92bd4 100644 --- a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreevents-EventExtensions.md +++ b/CodeDocumentation/SharedLibraryCore/events/EventExtensions.md @@ -20,6 +20,7 @@ ## Details ### Methods #### InvokeAsync +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Events/EventExtensions.cs#L16707566) ```csharp public static Task InvokeAsync(Func function, TEventType eventArgType, CancellationToken token) where TEventType : diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreevents-GameEventArgs.md b/CodeDocumentation/SharedLibraryCore/events/GameEventArgs.md similarity index 81% rename from CodeDocumentation/SharedLibraryCore/sharedlibrarycoreevents-GameEventArgs.md rename to CodeDocumentation/SharedLibraryCore/events/GameEventArgs.md index b430d57..181791b 100644 --- a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreevents-GameEventArgs.md +++ b/CodeDocumentation/SharedLibraryCore/events/GameEventArgs.md @@ -22,7 +22,7 @@ System.ComponentModel.AsyncCompletedEventArgs --> SharedLibraryCore.Events.GameE #### Public properties | Type | Name | Methods | | --- | --- | --- | -| [`GameEvent`](./sharedlibrarycore-GameEvent) | [`Event`](#event)
Game event that occured on a server | `get` | +| [`GameEvent`](../GameEvent.md) | [`Event`](#event)
Game event that occured on a server | `get` | ## Details ### Summary @@ -33,6 +33,7 @@ represents the state of a game event for event processing ### Constructors #### GameEventArgs +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Events/GameEventArgs.cs#L11) ```csharp public GameEventArgs(Exception error, bool cancelled, GameEvent userState) ``` @@ -41,7 +42,7 @@ public GameEventArgs(Exception error, bool cancelled, GameEvent userState) | --- | --- | --- | | `Exception` | error | | | `bool` | cancelled | | -| [`GameEvent`](./sharedlibrarycore-GameEvent) | userState | | +| [`GameEvent`](../GameEvent.md) | userState | | ### Properties #### Event diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreeventsgame-ClientCommandEvent.md b/CodeDocumentation/SharedLibraryCore/events/game/ClientCommandEvent.md similarity index 92% rename from CodeDocumentation/SharedLibraryCore/sharedlibrarycoreeventsgame-ClientCommandEvent.md rename to CodeDocumentation/SharedLibraryCore/events/game/ClientCommandEvent.md index d6c4545..efd883b 100644 --- a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreeventsgame-ClientCommandEvent.md +++ b/CodeDocumentation/SharedLibraryCore/events/game/ClientCommandEvent.md @@ -16,7 +16,7 @@ SharedLibraryCore.Events.Game.ClientMessageEvent --> SharedLibraryCore.Events.Ga ### Inheritance - [ `ClientMessageEvent` -](./sharedlibrarycoreeventsgame-ClientMessageEvent) +](./ClientMessageEvent.md) ### Constructors #### ClientCommandEvent diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreeventsgame-ClientDamageEvent.md b/CodeDocumentation/SharedLibraryCore/events/game/ClientDamageEvent.md similarity index 85% rename from CodeDocumentation/SharedLibraryCore/sharedlibrarycoreeventsgame-ClientDamageEvent.md rename to CodeDocumentation/SharedLibraryCore/events/game/ClientDamageEvent.md index b5cb72f..69ba739 100644 --- a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreeventsgame-ClientDamageEvent.md +++ b/CodeDocumentation/SharedLibraryCore/events/game/ClientDamageEvent.md @@ -18,7 +18,7 @@ SharedLibraryCore.Events.Game.ClientGameEvent --> SharedLibraryCore.Events.Game. #### Public properties | Type | Name | Methods | | --- | --- | --- | -| [`EFClient`](./sharedlibrarycoredatabasemodels-EFClient) | [`Attacker`](#attacker) | `get` | +| [`EFClient`](../../database/models/EFClient.md) | [`Attacker`](#attacker) | `get` | | `string` | [`AttackerClientName`](#attackerclientname) | `get` | | `int` | [`AttackerClientSlotNumber`](#attackerclientslotnumber) | `get` | | `string` | [`AttackerNetworkId`](#attackernetworkid) | `get` | @@ -26,7 +26,7 @@ SharedLibraryCore.Events.Game.ClientGameEvent --> SharedLibraryCore.Events.Game. | `int` | [`Damage`](#damage) | `get, init` | | `string` | [`HitLocation`](#hitlocation) | `get, init` | | `string` | [`MeansOfDeath`](#meansofdeath) | `get, init` | -| [`EFClient`](./sharedlibrarycoredatabasemodels-EFClient) | [`Victim`](#victim) | `get` | +| [`EFClient`](../../database/models/EFClient.md) | [`Victim`](#victim) | `get` | | `string` | [`VictimClientName`](#victimclientname) | `get, init` | | `int` | [`VictimClientSlotNumber`](#victimclientslotnumber) | `get, init` | | `string` | [`VictimNetworkId`](#victimnetworkid) | `get, init` | @@ -37,13 +37,13 @@ SharedLibraryCore.Events.Game.ClientGameEvent --> SharedLibraryCore.Events.Game. #### Public methods | Returns | Name | | --- | --- | -| `void` | [`UpdateAttacker`](#updateattacker)([`EFClient`](./sharedlibrarycoredatabasemodels-EFClient) client) | +| `void` | [`UpdateAttacker`](#updateattacker)([`EFClient`](../../database/models/EFClient.md) client) | ## Details ### Inheritance - [ `ClientGameEvent` -](./sharedlibrarycoreeventsgame-ClientGameEvent) +](./ClientGameEvent.md) ### Constructors #### ClientDamageEvent @@ -53,13 +53,14 @@ public ClientDamageEvent() ### Methods #### UpdateAttacker +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Events/Game/ClientDamageEvent.cs#L10) ```csharp public void UpdateAttacker(EFClient client) ``` ##### Arguments | Type | Name | Description | | --- | --- | --- | -| [`EFClient`](./sharedlibrarycoredatabasemodels-EFClient) | client | | +| [`EFClient`](../../database/models/EFClient.md) | client | | ### Properties #### Attacker diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreeventsgame-ClientEnterMatchEvent.md b/CodeDocumentation/SharedLibraryCore/events/game/ClientEnterMatchEvent.md similarity index 93% rename from CodeDocumentation/SharedLibraryCore/sharedlibrarycoreeventsgame-ClientEnterMatchEvent.md rename to CodeDocumentation/SharedLibraryCore/events/game/ClientEnterMatchEvent.md index 1c9ed6c..d801bfb 100644 --- a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreeventsgame-ClientEnterMatchEvent.md +++ b/CodeDocumentation/SharedLibraryCore/events/game/ClientEnterMatchEvent.md @@ -17,7 +17,7 @@ SharedLibraryCore.Events.Game.ClientGameEvent --> SharedLibraryCore.Events.Game. ### Inheritance - [ `ClientGameEvent` -](./sharedlibrarycoreeventsgame-ClientGameEvent) +](./ClientGameEvent.md) ### Constructors #### ClientEnterMatchEvent diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreeventsgame-ClientExitMatchEvent.md b/CodeDocumentation/SharedLibraryCore/events/game/ClientExitMatchEvent.md similarity index 93% rename from CodeDocumentation/SharedLibraryCore/sharedlibrarycoreeventsgame-ClientExitMatchEvent.md rename to CodeDocumentation/SharedLibraryCore/events/game/ClientExitMatchEvent.md index 7e82a9b..249fe80 100644 --- a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreeventsgame-ClientExitMatchEvent.md +++ b/CodeDocumentation/SharedLibraryCore/events/game/ClientExitMatchEvent.md @@ -17,7 +17,7 @@ SharedLibraryCore.Events.Game.ClientGameEvent --> SharedLibraryCore.Events.Game. ### Inheritance - [ `ClientGameEvent` -](./sharedlibrarycoreeventsgame-ClientGameEvent) +](./ClientGameEvent.md) ### Constructors #### ClientExitMatchEvent diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreeventsgame-ClientGameEvent.md b/CodeDocumentation/SharedLibraryCore/events/game/ClientGameEvent.md similarity index 90% rename from CodeDocumentation/SharedLibraryCore/sharedlibrarycoreeventsgame-ClientGameEvent.md rename to CodeDocumentation/SharedLibraryCore/events/game/ClientGameEvent.md index 8079ae4..c9700a8 100644 --- a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreeventsgame-ClientGameEvent.md +++ b/CodeDocumentation/SharedLibraryCore/events/game/ClientGameEvent.md @@ -19,7 +19,7 @@ SharedLibraryCore.Events.Game.GameEventV2 --> SharedLibraryCore.Events.Game.Clie #### Public properties | Type | Name | Methods | | --- | --- | --- | -| [`EFClient`](./sharedlibrarycoredatabasemodels-EFClient) | [`Client`](#client) | `get` | +| [`EFClient`](../../database/models/EFClient.md) | [`Client`](#client) | `get` | | `string` | [`ClientName`](#clientname) | `get, init` | | `string` | [`ClientNetworkId`](#clientnetworkid) | `get, init` | | `int` | [`ClientSlotNumber`](#clientslotnumber) | `get, init` | @@ -28,7 +28,7 @@ SharedLibraryCore.Events.Game.GameEventV2 --> SharedLibraryCore.Events.Game.Clie ### Inheritance - [ `GameEventV2` -](./sharedlibrarycoreeventsgame-GameEventV2) +](./GameEventV2.md) ### Constructors #### ClientGameEvent diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreeventsgame-ClientJoinTeamEvent.md b/CodeDocumentation/SharedLibraryCore/events/game/ClientJoinTeamEvent.md similarity index 95% rename from CodeDocumentation/SharedLibraryCore/sharedlibrarycoreeventsgame-ClientJoinTeamEvent.md rename to CodeDocumentation/SharedLibraryCore/events/game/ClientJoinTeamEvent.md index 1a7046e..ce027f8 100644 --- a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreeventsgame-ClientJoinTeamEvent.md +++ b/CodeDocumentation/SharedLibraryCore/events/game/ClientJoinTeamEvent.md @@ -25,7 +25,7 @@ SharedLibraryCore.Events.Game.ClientGameEvent --> SharedLibraryCore.Events.Game. ### Inheritance - [ `ClientGameEvent` -](./sharedlibrarycoreeventsgame-ClientGameEvent) +](./ClientGameEvent.md) ### Constructors #### ClientJoinTeamEvent diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreeventsgame-ClientKillEvent.md b/CodeDocumentation/SharedLibraryCore/events/game/ClientKillEvent.md similarity index 92% rename from CodeDocumentation/SharedLibraryCore/sharedlibrarycoreeventsgame-ClientKillEvent.md rename to CodeDocumentation/SharedLibraryCore/events/game/ClientKillEvent.md index 04681c7..0244d67 100644 --- a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreeventsgame-ClientKillEvent.md +++ b/CodeDocumentation/SharedLibraryCore/events/game/ClientKillEvent.md @@ -16,7 +16,7 @@ SharedLibraryCore.Events.Game.ClientDamageEvent --> SharedLibraryCore.Events.Gam ### Inheritance - [ `ClientDamageEvent` -](./sharedlibrarycoreeventsgame-ClientDamageEvent) +](./ClientDamageEvent.md) ### Constructors #### ClientKillEvent diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreeventsgame-ClientMessageEvent.md b/CodeDocumentation/SharedLibraryCore/events/game/ClientMessageEvent.md similarity index 95% rename from CodeDocumentation/SharedLibraryCore/sharedlibrarycoreeventsgame-ClientMessageEvent.md rename to CodeDocumentation/SharedLibraryCore/events/game/ClientMessageEvent.md index 2551b4f..54ed3d6 100644 --- a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreeventsgame-ClientMessageEvent.md +++ b/CodeDocumentation/SharedLibraryCore/events/game/ClientMessageEvent.md @@ -24,7 +24,7 @@ SharedLibraryCore.Events.Game.ClientGameEvent --> SharedLibraryCore.Events.Game. ### Inheritance - [ `ClientGameEvent` -](./sharedlibrarycoreeventsgame-ClientGameEvent) +](./ClientGameEvent.md) ### Constructors #### ClientMessageEvent diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreeventsgame-GameEventV2.md b/CodeDocumentation/SharedLibraryCore/events/game/GameEventV2.md similarity index 87% rename from CodeDocumentation/SharedLibraryCore/sharedlibrarycoreeventsgame-GameEventV2.md rename to CodeDocumentation/SharedLibraryCore/events/game/GameEventV2.md index 2a296b5..9929edb 100644 --- a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreeventsgame-GameEventV2.md +++ b/CodeDocumentation/SharedLibraryCore/events/game/GameEventV2.md @@ -20,13 +20,13 @@ SharedLibraryCore.GameEvent --> SharedLibraryCore.Events.Game.GameEventV2 #### Public properties | Type | Name | Methods | | --- | --- | --- | -| [`IGameServer`](./sharedlibrarycoreinterfaces-IGameServer) | [`Server`](#server) | `get` | +| [`IGameServer`](../../interfaces/IGameServer.md) | [`Server`](#server) | `get` | ## Details ### Inheritance - [ `GameEvent` -](./sharedlibrarycore-GameEvent) +](../../GameEvent.md) ### Constructors #### GameEventV2 diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreeventsgame-GameScriptEvent.md b/CodeDocumentation/SharedLibraryCore/events/game/GameScriptEvent.md similarity index 95% rename from CodeDocumentation/SharedLibraryCore/sharedlibrarycoreeventsgame-GameScriptEvent.md rename to CodeDocumentation/SharedLibraryCore/events/game/GameScriptEvent.md index 1bb7641..2d25c14 100644 --- a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreeventsgame-GameScriptEvent.md +++ b/CodeDocumentation/SharedLibraryCore/events/game/GameScriptEvent.md @@ -24,7 +24,7 @@ SharedLibraryCore.Events.Game.GameEventV2 --> SharedLibraryCore.Events.Game.Game ### Inheritance - [ `GameEventV2` -](./sharedlibrarycoreeventsgame-GameEventV2) +](./GameEventV2.md) ### Constructors #### GameScriptEvent diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreeventsgame-MatchEndEvent.md b/CodeDocumentation/SharedLibraryCore/events/game/MatchEndEvent.md similarity index 95% rename from CodeDocumentation/SharedLibraryCore/sharedlibrarycoreeventsgame-MatchEndEvent.md rename to CodeDocumentation/SharedLibraryCore/events/game/MatchEndEvent.md index d5e3140..5ec4ae3 100644 --- a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreeventsgame-MatchEndEvent.md +++ b/CodeDocumentation/SharedLibraryCore/events/game/MatchEndEvent.md @@ -24,7 +24,7 @@ SharedLibraryCore.Events.Game.GameEventV2 --> SharedLibraryCore.Events.Game.Matc ### Inheritance - [ `GameEventV2` -](./sharedlibrarycoreeventsgame-GameEventV2) +](./GameEventV2.md) ### Constructors #### MatchEndEvent diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreeventsgame-MatchStartEvent.md b/CodeDocumentation/SharedLibraryCore/events/game/MatchStartEvent.md similarity index 87% rename from CodeDocumentation/SharedLibraryCore/sharedlibrarycoreeventsgame-MatchStartEvent.md rename to CodeDocumentation/SharedLibraryCore/events/game/MatchStartEvent.md index 07f8b32..f9a73c6 100644 --- a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreeventsgame-MatchStartEvent.md +++ b/CodeDocumentation/SharedLibraryCore/events/game/MatchStartEvent.md @@ -24,10 +24,11 @@ SharedLibraryCore.Events.Game.GameEventV2 --> SharedLibraryCore.Events.Game.Matc ### Inheritance - [ `GameEventV2` -](./sharedlibrarycoreeventsgame-GameEventV2) +](./GameEventV2.md) ### Constructors #### MatchStartEvent +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Events/Game/MatchStartEvent.cs#L7) ```csharp public MatchStartEvent() ``` diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreeventsgamegamescriptzombie-PlayerConsumedPerkGameEvent.md b/CodeDocumentation/SharedLibraryCore/events/game/gamescript/zombie/PlayerConsumedPerkGameEvent.md similarity index 96% rename from CodeDocumentation/SharedLibraryCore/sharedlibrarycoreeventsgamegamescriptzombie-PlayerConsumedPerkGameEvent.md rename to CodeDocumentation/SharedLibraryCore/events/game/gamescript/zombie/PlayerConsumedPerkGameEvent.md index cb47688..857c7d7 100644 --- a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreeventsgamegamescriptzombie-PlayerConsumedPerkGameEvent.md +++ b/CodeDocumentation/SharedLibraryCore/events/game/gamescript/zombie/PlayerConsumedPerkGameEvent.md @@ -27,7 +27,7 @@ SharedLibraryCore.Events.Game.ClientGameEvent --> SharedLibraryCore.Events.Game. ### Inheritance - [ `ClientGameEvent` -](./sharedlibrarycoreeventsgame-ClientGameEvent) +](../../ClientGameEvent.md) ### Constructors #### PlayerConsumedPerkGameEvent diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreeventsgamegamescriptzombie-PlayerDamageGameEvent.md b/CodeDocumentation/SharedLibraryCore/events/game/gamescript/zombie/PlayerDamageGameEvent.md similarity index 93% rename from CodeDocumentation/SharedLibraryCore/sharedlibrarycoreeventsgamegamescriptzombie-PlayerDamageGameEvent.md rename to CodeDocumentation/SharedLibraryCore/events/game/gamescript/zombie/PlayerDamageGameEvent.md index 46337e7..fce177d 100644 --- a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreeventsgamegamescriptzombie-PlayerDamageGameEvent.md +++ b/CodeDocumentation/SharedLibraryCore/events/game/gamescript/zombie/PlayerDamageGameEvent.md @@ -18,7 +18,7 @@ SharedLibraryCore.Events.Game.ClientDamageEvent --> SharedLibraryCore.Events.Gam ### Inheritance - [ `ClientDamageEvent` -](./sharedlibrarycoreeventsgame-ClientDamageEvent) +](../../ClientDamageEvent.md) ### Constructors #### PlayerDamageGameEvent diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreeventsgamegamescriptzombie-PlayerDownedGameEvent.md b/CodeDocumentation/SharedLibraryCore/events/game/gamescript/zombie/PlayerDownedGameEvent.md similarity index 94% rename from CodeDocumentation/SharedLibraryCore/sharedlibrarycoreeventsgamegamescriptzombie-PlayerDownedGameEvent.md rename to CodeDocumentation/SharedLibraryCore/events/game/gamescript/zombie/PlayerDownedGameEvent.md index c328720..48a8a1b 100644 --- a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreeventsgamegamescriptzombie-PlayerDownedGameEvent.md +++ b/CodeDocumentation/SharedLibraryCore/events/game/gamescript/zombie/PlayerDownedGameEvent.md @@ -19,7 +19,7 @@ SharedLibraryCore.Events.Game.ClientGameEvent --> SharedLibraryCore.Events.Game. ### Inheritance - [ `ClientGameEvent` -](./sharedlibrarycoreeventsgame-ClientGameEvent) +](../../ClientGameEvent.md) ### Constructors #### PlayerDownedGameEvent diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreeventsgamegamescriptzombie-PlayerGrabbedPowerupGameEvent.md b/CodeDocumentation/SharedLibraryCore/events/game/gamescript/zombie/PlayerGrabbedPowerupGameEvent.md similarity index 96% rename from CodeDocumentation/SharedLibraryCore/sharedlibrarycoreeventsgamegamescriptzombie-PlayerGrabbedPowerupGameEvent.md rename to CodeDocumentation/SharedLibraryCore/events/game/gamescript/zombie/PlayerGrabbedPowerupGameEvent.md index bc2a19a..1a5e584 100644 --- a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreeventsgamegamescriptzombie-PlayerGrabbedPowerupGameEvent.md +++ b/CodeDocumentation/SharedLibraryCore/events/game/gamescript/zombie/PlayerGrabbedPowerupGameEvent.md @@ -27,7 +27,7 @@ SharedLibraryCore.Events.Game.ClientGameEvent --> SharedLibraryCore.Events.Game. ### Inheritance - [ `ClientGameEvent` -](./sharedlibrarycoreeventsgame-ClientGameEvent) +](../../ClientGameEvent.md) ### Constructors #### PlayerGrabbedPowerupGameEvent diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreeventsgamegamescriptzombie-PlayerKilledGameEvent.md b/CodeDocumentation/SharedLibraryCore/events/game/gamescript/zombie/PlayerKilledGameEvent.md similarity index 81% rename from CodeDocumentation/SharedLibraryCore/sharedlibrarycoreeventsgamegamescriptzombie-PlayerKilledGameEvent.md rename to CodeDocumentation/SharedLibraryCore/events/game/gamescript/zombie/PlayerKilledGameEvent.md index 5b96222..cc38cd4 100644 --- a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreeventsgamegamescriptzombie-PlayerKilledGameEvent.md +++ b/CodeDocumentation/SharedLibraryCore/events/game/gamescript/zombie/PlayerKilledGameEvent.md @@ -16,10 +16,11 @@ SharedLibraryCore.Events.Game.GameScript.Zombie.PlayerDamageGameEvent --> Shared ### Inheritance - [ `PlayerDamageGameEvent` -](./sharedlibrarycoreeventsgamegamescriptzombie-PlayerDamageGameEvent) +](./PlayerDamageGameEvent.md) ### Constructors #### PlayerKilledGameEvent +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Events/Game/GameScript/Zombie/PlayerKilledGameEvent.cs#L5) ```csharp public PlayerKilledGameEvent() ``` diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreeventsgamegamescriptzombie-PlayerRevivedGameEvent.md b/CodeDocumentation/SharedLibraryCore/events/game/gamescript/zombie/PlayerRevivedGameEvent.md similarity index 96% rename from CodeDocumentation/SharedLibraryCore/sharedlibrarycoreeventsgamegamescriptzombie-PlayerRevivedGameEvent.md rename to CodeDocumentation/SharedLibraryCore/events/game/gamescript/zombie/PlayerRevivedGameEvent.md index 7cb90a4..dc3d7e0 100644 --- a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreeventsgamegamescriptzombie-PlayerRevivedGameEvent.md +++ b/CodeDocumentation/SharedLibraryCore/events/game/gamescript/zombie/PlayerRevivedGameEvent.md @@ -27,7 +27,7 @@ SharedLibraryCore.Events.Game.ClientGameEvent --> SharedLibraryCore.Events.Game. ### Inheritance - [ `ClientGameEvent` -](./sharedlibrarycoreeventsgame-ClientGameEvent) +](../../ClientGameEvent.md) ### Constructors #### PlayerRevivedGameEvent diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreeventsgamegamescriptzombie-PlayerRoundDataGameEvent.md b/CodeDocumentation/SharedLibraryCore/events/game/gamescript/zombie/PlayerRoundDataGameEvent.md similarity index 96% rename from CodeDocumentation/SharedLibraryCore/sharedlibrarycoreeventsgamegamescriptzombie-PlayerRoundDataGameEvent.md rename to CodeDocumentation/SharedLibraryCore/events/game/gamescript/zombie/PlayerRoundDataGameEvent.md index fb741fb..e6abb00 100644 --- a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreeventsgamegamescriptzombie-PlayerRoundDataGameEvent.md +++ b/CodeDocumentation/SharedLibraryCore/events/game/gamescript/zombie/PlayerRoundDataGameEvent.md @@ -28,7 +28,7 @@ SharedLibraryCore.Events.Game.ClientGameEvent --> SharedLibraryCore.Events.Game. ### Inheritance - [ `ClientGameEvent` -](./sharedlibrarycoreeventsgame-ClientGameEvent) +](../../ClientGameEvent.md) ### Constructors #### PlayerRoundDataGameEvent diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreeventsgamegamescriptzombie-RoundCompleteGameEvent.md b/CodeDocumentation/SharedLibraryCore/events/game/gamescript/zombie/RoundCompleteGameEvent.md similarity index 95% rename from CodeDocumentation/SharedLibraryCore/sharedlibrarycoreeventsgamegamescriptzombie-RoundCompleteGameEvent.md rename to CodeDocumentation/SharedLibraryCore/events/game/gamescript/zombie/RoundCompleteGameEvent.md index c5bc500..8627735 100644 --- a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreeventsgamegamescriptzombie-RoundCompleteGameEvent.md +++ b/CodeDocumentation/SharedLibraryCore/events/game/gamescript/zombie/RoundCompleteGameEvent.md @@ -26,7 +26,7 @@ SharedLibraryCore.Events.Game.GameEventV2 --> SharedLibraryCore.Events.Game.Game ### Inheritance - [ `GameEventV2` -](./sharedlibrarycoreeventsgame-GameEventV2) +](../../GameEventV2.md) ### Constructors #### RoundCompleteGameEvent diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreeventsgamegamescriptzombie-ZombieDamageGameEvent.md b/CodeDocumentation/SharedLibraryCore/events/game/gamescript/zombie/ZombieDamageGameEvent.md similarity index 93% rename from CodeDocumentation/SharedLibraryCore/sharedlibrarycoreeventsgamegamescriptzombie-ZombieDamageGameEvent.md rename to CodeDocumentation/SharedLibraryCore/events/game/gamescript/zombie/ZombieDamageGameEvent.md index 7e8c65c..39e83df 100644 --- a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreeventsgamegamescriptzombie-ZombieDamageGameEvent.md +++ b/CodeDocumentation/SharedLibraryCore/events/game/gamescript/zombie/ZombieDamageGameEvent.md @@ -18,7 +18,7 @@ SharedLibraryCore.Events.Game.ClientDamageEvent --> SharedLibraryCore.Events.Gam ### Inheritance - [ `ClientDamageEvent` -](./sharedlibrarycoreeventsgame-ClientDamageEvent) +](../../ClientDamageEvent.md) ### Constructors #### ZombieDamageGameEvent diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreeventsgamegamescriptzombie-ZombieKilledGameEvent.md b/CodeDocumentation/SharedLibraryCore/events/game/gamescript/zombie/ZombieKilledGameEvent.md similarity index 81% rename from CodeDocumentation/SharedLibraryCore/sharedlibrarycoreeventsgamegamescriptzombie-ZombieKilledGameEvent.md rename to CodeDocumentation/SharedLibraryCore/events/game/gamescript/zombie/ZombieKilledGameEvent.md index eb50152..624b68d 100644 --- a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreeventsgamegamescriptzombie-ZombieKilledGameEvent.md +++ b/CodeDocumentation/SharedLibraryCore/events/game/gamescript/zombie/ZombieKilledGameEvent.md @@ -16,10 +16,11 @@ SharedLibraryCore.Events.Game.GameScript.Zombie.ZombieDamageGameEvent --> Shared ### Inheritance - [ `ZombieDamageGameEvent` -](./sharedlibrarycoreeventsgamegamescriptzombie-ZombieDamageGameEvent) +](./ZombieDamageGameEvent.md) ### Constructors #### ZombieKilledGameEvent +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Events/Game/GameScript/Zombie/ZombieKilledGameEvent.cs#L5) ```csharp public ZombieKilledGameEvent() ``` diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreeventsmanagement-ClientExecuteCommandEvent.md b/CodeDocumentation/SharedLibraryCore/events/management/ClientExecuteCommandEvent.md similarity index 87% rename from CodeDocumentation/SharedLibraryCore/sharedlibrarycoreeventsmanagement-ClientExecuteCommandEvent.md rename to CodeDocumentation/SharedLibraryCore/events/management/ClientExecuteCommandEvent.md index 77dc55d..131f653 100644 --- a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreeventsmanagement-ClientExecuteCommandEvent.md +++ b/CodeDocumentation/SharedLibraryCore/events/management/ClientExecuteCommandEvent.md @@ -18,14 +18,14 @@ SharedLibraryCore.Events.Management.ClientStateEvent --> SharedLibraryCore.Event #### Public properties | Type | Name | Methods | | --- | --- | --- | -| [`IManagerCommand`](./sharedlibrarycoreinterfaces-IManagerCommand) | [`Command`](#command) | `get, init` | +| [`IManagerCommand`](../../interfaces/IManagerCommand.md) | [`Command`](#command) | `get, init` | | `string` | [`CommandText`](#commandtext) | `get, init` | ## Details ### Inheritance - [ `ClientStateEvent` -](./sharedlibrarycoreeventsmanagement-ClientStateEvent) +](./ClientStateEvent.md) ### Constructors #### ClientExecuteCommandEvent diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreeventsmanagement-ClientPenaltyEvent.md b/CodeDocumentation/SharedLibraryCore/events/management/ClientPenaltyEvent.md similarity index 95% rename from CodeDocumentation/SharedLibraryCore/sharedlibrarycoreeventsmanagement-ClientPenaltyEvent.md rename to CodeDocumentation/SharedLibraryCore/events/management/ClientPenaltyEvent.md index 22ac41d..55266f9 100644 --- a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreeventsmanagement-ClientPenaltyEvent.md +++ b/CodeDocumentation/SharedLibraryCore/events/management/ClientPenaltyEvent.md @@ -24,7 +24,7 @@ SharedLibraryCore.Events.Management.ManagementEvent --> SharedLibraryCore.Events ### Inheritance - [ `ManagementEvent` -](./sharedlibrarycoreeventsmanagement-ManagementEvent) +](./ManagementEvent.md) ### Constructors #### ClientPenaltyEvent diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreeventsmanagement-ClientPenaltyRevokeEvent.md b/CodeDocumentation/SharedLibraryCore/events/management/ClientPenaltyRevokeEvent.md similarity index 92% rename from CodeDocumentation/SharedLibraryCore/sharedlibrarycoreeventsmanagement-ClientPenaltyRevokeEvent.md rename to CodeDocumentation/SharedLibraryCore/events/management/ClientPenaltyRevokeEvent.md index 8e9c3e6..f7d5bbc 100644 --- a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreeventsmanagement-ClientPenaltyRevokeEvent.md +++ b/CodeDocumentation/SharedLibraryCore/events/management/ClientPenaltyRevokeEvent.md @@ -16,7 +16,7 @@ SharedLibraryCore.Events.Management.ClientPenaltyEvent --> SharedLibraryCore.Eve ### Inheritance - [ `ClientPenaltyEvent` -](./sharedlibrarycoreeventsmanagement-ClientPenaltyEvent) +](./ClientPenaltyEvent.md) ### Constructors #### ClientPenaltyRevokeEvent diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreeventsmanagement-ClientPermissionChangeEvent.md b/CodeDocumentation/SharedLibraryCore/events/management/ClientPermissionChangeEvent.md similarity index 95% rename from CodeDocumentation/SharedLibraryCore/sharedlibrarycoreeventsmanagement-ClientPermissionChangeEvent.md rename to CodeDocumentation/SharedLibraryCore/events/management/ClientPermissionChangeEvent.md index c283017..2887051 100644 --- a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreeventsmanagement-ClientPermissionChangeEvent.md +++ b/CodeDocumentation/SharedLibraryCore/events/management/ClientPermissionChangeEvent.md @@ -25,7 +25,7 @@ SharedLibraryCore.Events.Management.ClientStateEvent --> SharedLibraryCore.Event ### Inheritance - [ `ClientStateEvent` -](./sharedlibrarycoreeventsmanagement-ClientStateEvent) +](./ClientStateEvent.md) ### Constructors #### ClientPermissionChangeEvent diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreeventsmanagement-ClientPersistentIdReceiveEvent.md b/CodeDocumentation/SharedLibraryCore/events/management/ClientPersistentIdReceiveEvent.md similarity index 83% rename from CodeDocumentation/SharedLibraryCore/sharedlibrarycoreeventsmanagement-ClientPersistentIdReceiveEvent.md rename to CodeDocumentation/SharedLibraryCore/events/management/ClientPersistentIdReceiveEvent.md index 4cf5e00..eb23501 100644 --- a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreeventsmanagement-ClientPersistentIdReceiveEvent.md +++ b/CodeDocumentation/SharedLibraryCore/events/management/ClientPersistentIdReceiveEvent.md @@ -24,17 +24,18 @@ SharedLibraryCore.Events.Management.ClientStateEvent --> SharedLibraryCore.Event ### Inheritance - [ `ClientStateEvent` -](./sharedlibrarycoreeventsmanagement-ClientStateEvent) +](./ClientStateEvent.md) ### Constructors #### ClientPersistentIdReceiveEvent +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Events/Management/ClientPersistentIdReceiveEvent.cs#L7) ```csharp public ClientPersistentIdReceiveEvent(EFClient client, string persistentId) ``` ##### Arguments | Type | Name | Description | | --- | --- | --- | -| [`EFClient`](./sharedlibrarycoredatabasemodels-EFClient) | client | | +| [`EFClient`](../../database/models/EFClient.md) | client | | | `string` | persistentId | | ### Properties diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreeventsmanagement-ClientStateAuthorizeEvent.md b/CodeDocumentation/SharedLibraryCore/events/management/ClientStateAuthorizeEvent.md similarity index 93% rename from CodeDocumentation/SharedLibraryCore/sharedlibrarycoreeventsmanagement-ClientStateAuthorizeEvent.md rename to CodeDocumentation/SharedLibraryCore/events/management/ClientStateAuthorizeEvent.md index 1dc30b0..90393e5 100644 --- a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreeventsmanagement-ClientStateAuthorizeEvent.md +++ b/CodeDocumentation/SharedLibraryCore/events/management/ClientStateAuthorizeEvent.md @@ -17,7 +17,7 @@ SharedLibraryCore.Events.Management.ClientStateEvent --> SharedLibraryCore.Event ### Inheritance - [ `ClientStateEvent` -](./sharedlibrarycoreeventsmanagement-ClientStateEvent) +](./ClientStateEvent.md) ### Constructors #### ClientStateAuthorizeEvent diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreeventsmanagement-ClientStateDisposeEvent.md b/CodeDocumentation/SharedLibraryCore/events/management/ClientStateDisposeEvent.md similarity index 93% rename from CodeDocumentation/SharedLibraryCore/sharedlibrarycoreeventsmanagement-ClientStateDisposeEvent.md rename to CodeDocumentation/SharedLibraryCore/events/management/ClientStateDisposeEvent.md index 510747a..88f3bd0 100644 --- a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreeventsmanagement-ClientStateDisposeEvent.md +++ b/CodeDocumentation/SharedLibraryCore/events/management/ClientStateDisposeEvent.md @@ -17,7 +17,7 @@ SharedLibraryCore.Events.Management.ClientStateEvent --> SharedLibraryCore.Event ### Inheritance - [ `ClientStateEvent` -](./sharedlibrarycoreeventsmanagement-ClientStateEvent) +](./ClientStateEvent.md) ### Constructors #### ClientStateDisposeEvent diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreeventsmanagement-ClientStateEvent.md b/CodeDocumentation/SharedLibraryCore/events/management/ClientStateEvent.md similarity index 86% rename from CodeDocumentation/SharedLibraryCore/sharedlibrarycoreeventsmanagement-ClientStateEvent.md rename to CodeDocumentation/SharedLibraryCore/events/management/ClientStateEvent.md index 7ba2249..90efb14 100644 --- a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreeventsmanagement-ClientStateEvent.md +++ b/CodeDocumentation/SharedLibraryCore/events/management/ClientStateEvent.md @@ -18,13 +18,13 @@ SharedLibraryCore.Events.Management.ManagementEvent --> SharedLibraryCore.Events #### Public properties | Type | Name | Methods | | --- | --- | --- | -| [`EFClient`](./sharedlibrarycoredatabasemodels-EFClient) | [`Client`](#client) | `get, init` | +| [`EFClient`](../../database/models/EFClient.md) | [`Client`](#client) | `get, init` | ## Details ### Inheritance - [ `ManagementEvent` -](./sharedlibrarycoreeventsmanagement-ManagementEvent) +](./ManagementEvent.md) ### Constructors #### ClientStateEvent diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreeventsmanagement-ClientStateInitializeEvent.md b/CodeDocumentation/SharedLibraryCore/events/management/ClientStateInitializeEvent.md similarity index 93% rename from CodeDocumentation/SharedLibraryCore/sharedlibrarycoreeventsmanagement-ClientStateInitializeEvent.md rename to CodeDocumentation/SharedLibraryCore/events/management/ClientStateInitializeEvent.md index 3da9566..5de6c68 100644 --- a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreeventsmanagement-ClientStateInitializeEvent.md +++ b/CodeDocumentation/SharedLibraryCore/events/management/ClientStateInitializeEvent.md @@ -17,7 +17,7 @@ SharedLibraryCore.Events.Management.ClientStateEvent --> SharedLibraryCore.Event ### Inheritance - [ `ClientStateEvent` -](./sharedlibrarycoreeventsmanagement-ClientStateEvent) +](./ClientStateEvent.md) ### Constructors #### ClientStateInitializeEvent diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreeventsmanagement-LoginEvent.md b/CodeDocumentation/SharedLibraryCore/events/management/LoginEvent.md similarity index 95% rename from CodeDocumentation/SharedLibraryCore/sharedlibrarycoreeventsmanagement-LoginEvent.md rename to CodeDocumentation/SharedLibraryCore/events/management/LoginEvent.md index bc4414f..da27bb4 100644 --- a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreeventsmanagement-LoginEvent.md +++ b/CodeDocumentation/SharedLibraryCore/events/management/LoginEvent.md @@ -25,7 +25,7 @@ SharedLibraryCore.Events.Management.ManagementEvent --> SharedLibraryCore.Events ### Inheritance - [ `ManagementEvent` -](./sharedlibrarycoreeventsmanagement-ManagementEvent) +](./ManagementEvent.md) ### Nested types #### Enums diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreeventsmanagement-LogoutEvent.md b/CodeDocumentation/SharedLibraryCore/events/management/LogoutEvent.md similarity index 92% rename from CodeDocumentation/SharedLibraryCore/sharedlibrarycoreeventsmanagement-LogoutEvent.md rename to CodeDocumentation/SharedLibraryCore/events/management/LogoutEvent.md index 434c87e..7b66347 100644 --- a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreeventsmanagement-LogoutEvent.md +++ b/CodeDocumentation/SharedLibraryCore/events/management/LogoutEvent.md @@ -16,7 +16,7 @@ SharedLibraryCore.Events.Management.LoginEvent --> SharedLibraryCore.Events.Mana ### Inheritance - [ `LoginEvent` -](./sharedlibrarycoreeventsmanagement-LoginEvent) +](./LoginEvent.md) ### Constructors #### LogoutEvent diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreeventsmanagement-ManagementEvent.md b/CodeDocumentation/SharedLibraryCore/events/management/ManagementEvent.md similarity index 94% rename from CodeDocumentation/SharedLibraryCore/sharedlibrarycoreeventsmanagement-ManagementEvent.md rename to CodeDocumentation/SharedLibraryCore/events/management/ManagementEvent.md index c5003ea..92d69e7 100644 --- a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreeventsmanagement-ManagementEvent.md +++ b/CodeDocumentation/SharedLibraryCore/events/management/ManagementEvent.md @@ -19,7 +19,7 @@ SharedLibraryCore.Events.CoreEvent --> SharedLibraryCore.Events.Management.Manag ### Inheritance - [ `CoreEvent` -](./sharedlibrarycoreevents-CoreEvent) +](../CoreEvent.md) ### Constructors #### ManagementEvent diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreeventsmanagementloginevent-LoginSourceType.md b/CodeDocumentation/SharedLibraryCore/events/management/loginevent/LoginSourceType.md similarity index 100% rename from CodeDocumentation/SharedLibraryCore/sharedlibrarycoreeventsmanagementloginevent-LoginSourceType.md rename to CodeDocumentation/SharedLibraryCore/events/management/loginevent/LoginSourceType.md diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreeventsserver-ClientDataUpdateEvent.md b/CodeDocumentation/SharedLibraryCore/events/server/ClientDataUpdateEvent.md similarity index 84% rename from CodeDocumentation/SharedLibraryCore/sharedlibrarycoreeventsserver-ClientDataUpdateEvent.md rename to CodeDocumentation/SharedLibraryCore/events/server/ClientDataUpdateEvent.md index 3de1e69..23a67b8 100644 --- a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreeventsserver-ClientDataUpdateEvent.md +++ b/CodeDocumentation/SharedLibraryCore/events/server/ClientDataUpdateEvent.md @@ -18,13 +18,13 @@ SharedLibraryCore.Events.Server.GameServerEvent --> SharedLibraryCore.Events.Ser #### Public properties | Type | Name | Methods | | --- | --- | --- | -| `IReadOnlyCollection`<[`EFClient`](./sharedlibrarycoredatabasemodels-EFClient)> | [`Clients`](#clients) | `get, init` | +| `IReadOnlyCollection`<[`EFClient`](../../database/models/EFClient.md)> | [`Clients`](#clients) | `get, init` | ## Details ### Inheritance - [ `GameServerEvent` -](./sharedlibrarycoreeventsserver-GameServerEvent) +](./GameServerEvent.md) ### Constructors #### ClientDataUpdateEvent diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreeventsserver-ConnectionInterruptEvent.md b/CodeDocumentation/SharedLibraryCore/events/server/ConnectionInterruptEvent.md similarity index 93% rename from CodeDocumentation/SharedLibraryCore/sharedlibrarycoreeventsserver-ConnectionInterruptEvent.md rename to CodeDocumentation/SharedLibraryCore/events/server/ConnectionInterruptEvent.md index 0ab89c8..e9c8a86 100644 --- a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreeventsserver-ConnectionInterruptEvent.md +++ b/CodeDocumentation/SharedLibraryCore/events/server/ConnectionInterruptEvent.md @@ -17,7 +17,7 @@ SharedLibraryCore.Events.Server.GameServerEvent --> SharedLibraryCore.Events.Ser ### Inheritance - [ `GameServerEvent` -](./sharedlibrarycoreeventsserver-GameServerEvent) +](./GameServerEvent.md) ### Constructors #### ConnectionInterruptEvent diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreeventsserver-ConnectionRestoreEvent.md b/CodeDocumentation/SharedLibraryCore/events/server/ConnectionRestoreEvent.md similarity index 93% rename from CodeDocumentation/SharedLibraryCore/sharedlibrarycoreeventsserver-ConnectionRestoreEvent.md rename to CodeDocumentation/SharedLibraryCore/events/server/ConnectionRestoreEvent.md index 181be78..f9e8e26 100644 --- a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreeventsserver-ConnectionRestoreEvent.md +++ b/CodeDocumentation/SharedLibraryCore/events/server/ConnectionRestoreEvent.md @@ -17,7 +17,7 @@ SharedLibraryCore.Events.Server.GameServerEvent --> SharedLibraryCore.Events.Ser ### Inheritance - [ `GameServerEvent` -](./sharedlibrarycoreeventsserver-GameServerEvent) +](./GameServerEvent.md) ### Constructors #### ConnectionRestoreEvent diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreeventsserver-GameServerEvent.md b/CodeDocumentation/SharedLibraryCore/events/server/GameServerEvent.md similarity index 87% rename from CodeDocumentation/SharedLibraryCore/sharedlibrarycoreeventsserver-GameServerEvent.md rename to CodeDocumentation/SharedLibraryCore/events/server/GameServerEvent.md index 3a161a4..870d80f 100644 --- a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreeventsserver-GameServerEvent.md +++ b/CodeDocumentation/SharedLibraryCore/events/server/GameServerEvent.md @@ -21,13 +21,13 @@ SharedLibraryCore.Events.CoreEvent --> SharedLibraryCore.Events.Server.GameServe #### Public properties | Type | Name | Methods | | --- | --- | --- | -| [`IGameServer`](./sharedlibrarycoreinterfaces-IGameServer) | [`Server`](#server) | `get, init` | +| [`IGameServer`](../../interfaces/IGameServer.md) | [`Server`](#server) | `get, init` | ## Details ### Inheritance - [ `CoreEvent` -](./sharedlibrarycoreevents-CoreEvent) +](../CoreEvent.md) ### Constructors #### GameServerEvent diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreeventsserver-MonitorStartEvent.md b/CodeDocumentation/SharedLibraryCore/events/server/MonitorStartEvent.md similarity index 93% rename from CodeDocumentation/SharedLibraryCore/sharedlibrarycoreeventsserver-MonitorStartEvent.md rename to CodeDocumentation/SharedLibraryCore/events/server/MonitorStartEvent.md index f715f42..7f32e98 100644 --- a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreeventsserver-MonitorStartEvent.md +++ b/CodeDocumentation/SharedLibraryCore/events/server/MonitorStartEvent.md @@ -17,7 +17,7 @@ SharedLibraryCore.Events.Server.GameServerEvent --> SharedLibraryCore.Events.Ser ### Inheritance - [ `GameServerEvent` -](./sharedlibrarycoreeventsserver-GameServerEvent) +](./GameServerEvent.md) ### Constructors #### MonitorStartEvent diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreeventsserver-MonitorStopEvent.md b/CodeDocumentation/SharedLibraryCore/events/server/MonitorStopEvent.md similarity index 93% rename from CodeDocumentation/SharedLibraryCore/sharedlibrarycoreeventsserver-MonitorStopEvent.md rename to CodeDocumentation/SharedLibraryCore/events/server/MonitorStopEvent.md index 3e16ac8..2402980 100644 --- a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreeventsserver-MonitorStopEvent.md +++ b/CodeDocumentation/SharedLibraryCore/events/server/MonitorStopEvent.md @@ -17,7 +17,7 @@ SharedLibraryCore.Events.Server.GameServerEvent --> SharedLibraryCore.Events.Ser ### Inheritance - [ `GameServerEvent` -](./sharedlibrarycoreeventsserver-GameServerEvent) +](./GameServerEvent.md) ### Constructors #### MonitorStopEvent diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreeventsserver-ServerCommandExecuteEvent.md b/CodeDocumentation/SharedLibraryCore/events/server/ServerCommandExecuteEvent.md similarity index 95% rename from CodeDocumentation/SharedLibraryCore/sharedlibrarycoreeventsserver-ServerCommandExecuteEvent.md rename to CodeDocumentation/SharedLibraryCore/events/server/ServerCommandExecuteEvent.md index 0883829..1d242d0 100644 --- a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreeventsserver-ServerCommandExecuteEvent.md +++ b/CodeDocumentation/SharedLibraryCore/events/server/ServerCommandExecuteEvent.md @@ -25,7 +25,7 @@ SharedLibraryCore.Events.Server.GameServerEvent --> SharedLibraryCore.Events.Ser ### Inheritance - [ `GameServerEvent` -](./sharedlibrarycoreeventsserver-GameServerEvent) +](./GameServerEvent.md) ### Constructors #### ServerCommandExecuteEvent diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreeventsserver-ServerCommandRequestExecuteEvent.md b/CodeDocumentation/SharedLibraryCore/events/server/ServerCommandRequestExecuteEvent.md similarity index 86% rename from CodeDocumentation/SharedLibraryCore/sharedlibrarycoreeventsserver-ServerCommandRequestExecuteEvent.md rename to CodeDocumentation/SharedLibraryCore/events/server/ServerCommandRequestExecuteEvent.md index 762e7c7..5ab8cea 100644 --- a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreeventsserver-ServerCommandRequestExecuteEvent.md +++ b/CodeDocumentation/SharedLibraryCore/events/server/ServerCommandRequestExecuteEvent.md @@ -26,10 +26,11 @@ SharedLibraryCore.Events.Server.GameServerEvent --> SharedLibraryCore.Events.Ser ### Inheritance - [ `GameServerEvent` -](./sharedlibrarycoreeventsserver-GameServerEvent) +](./GameServerEvent.md) ### Constructors #### ServerCommandRequestExecuteEvent +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Events/Server/ServerCommandRequestExecuteEvent.cs#L7) ```csharp public ServerCommandRequestExecuteEvent(string command, IGameServer server) ``` @@ -37,7 +38,7 @@ public ServerCommandRequestExecuteEvent(string command, IGameServer server) | Type | Name | Description | | --- | --- | --- | | `string` | command | | -| [`IGameServer`](./sharedlibrarycoreinterfaces-IGameServer) | server | | +| [`IGameServer`](../../interfaces/IGameServer.md) | server | | ### Properties #### Command diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreeventsserver-ServerValueReceiveEvent.md b/CodeDocumentation/SharedLibraryCore/events/server/ServerValueReceiveEvent.md similarity index 87% rename from CodeDocumentation/SharedLibraryCore/sharedlibrarycoreeventsserver-ServerValueReceiveEvent.md rename to CodeDocumentation/SharedLibraryCore/events/server/ServerValueReceiveEvent.md index be60b44..52f26df 100644 --- a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreeventsserver-ServerValueReceiveEvent.md +++ b/CodeDocumentation/SharedLibraryCore/events/server/ServerValueReceiveEvent.md @@ -18,14 +18,14 @@ SharedLibraryCore.Events.Server.GameServerEvent --> SharedLibraryCore.Events.Ser #### Public properties | Type | Name | Methods | | --- | --- | --- | -| [`Dvar`](./sharedlibrarycore-DvarT)<`string`> | [`Response`](#response) | `get, init` | +| [`Dvar`](../../DvarT.md)<`string`> | [`Response`](#response) | `get, init` | | `bool` | [`Success`](#success) | `get, init` | ## Details ### Inheritance - [ `GameServerEvent` -](./sharedlibrarycoreeventsserver-GameServerEvent) +](./GameServerEvent.md) ### Constructors #### ServerValueReceiveEvent diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreeventsserver-ServerValueRequestEvent.md b/CodeDocumentation/SharedLibraryCore/events/server/ServerValueRequestEvent.md similarity index 87% rename from CodeDocumentation/SharedLibraryCore/sharedlibrarycoreeventsserver-ServerValueRequestEvent.md rename to CodeDocumentation/SharedLibraryCore/events/server/ServerValueRequestEvent.md index 23b14ff..5e3530e 100644 --- a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreeventsserver-ServerValueRequestEvent.md +++ b/CodeDocumentation/SharedLibraryCore/events/server/ServerValueRequestEvent.md @@ -27,10 +27,11 @@ SharedLibraryCore.Events.Server.GameServerEvent --> SharedLibraryCore.Events.Ser ### Inheritance - [ `GameServerEvent` -](./sharedlibrarycoreeventsserver-GameServerEvent) +](./GameServerEvent.md) ### Constructors #### ServerValueRequestEvent +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Events/Server/ServerValueRequestEvent.cs#L7) ```csharp public ServerValueRequestEvent(string valueName, IGameServer server) ``` @@ -38,7 +39,7 @@ public ServerValueRequestEvent(string valueName, IGameServer server) | Type | Name | Description | | --- | --- | --- | | `string` | valueName | | -| [`IGameServer`](./sharedlibrarycoreinterfaces-IGameServer) | server | | +| [`IGameServer`](../../interfaces/IGameServer.md) | server | | ### Properties #### ValueName diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreeventsserver-ServerValueSetCompleteEvent.md b/CodeDocumentation/SharedLibraryCore/events/server/ServerValueSetCompleteEvent.md similarity index 96% rename from CodeDocumentation/SharedLibraryCore/sharedlibrarycoreeventsserver-ServerValueSetCompleteEvent.md rename to CodeDocumentation/SharedLibraryCore/events/server/ServerValueSetCompleteEvent.md index fedbc27..79d204c 100644 --- a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreeventsserver-ServerValueSetCompleteEvent.md +++ b/CodeDocumentation/SharedLibraryCore/events/server/ServerValueSetCompleteEvent.md @@ -26,7 +26,7 @@ SharedLibraryCore.Events.Server.GameServerEvent --> SharedLibraryCore.Events.Ser ### Inheritance - [ `GameServerEvent` -](./sharedlibrarycoreeventsserver-GameServerEvent) +](./GameServerEvent.md) ### Constructors #### ServerValueSetCompleteEvent diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreeventsserver-ServerValueSetRequestEvent.md b/CodeDocumentation/SharedLibraryCore/events/server/ServerValueSetRequestEvent.md similarity index 87% rename from CodeDocumentation/SharedLibraryCore/sharedlibrarycoreeventsserver-ServerValueSetRequestEvent.md rename to CodeDocumentation/SharedLibraryCore/events/server/ServerValueSetRequestEvent.md index ac6e8da..89b58eb 100644 --- a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreeventsserver-ServerValueSetRequestEvent.md +++ b/CodeDocumentation/SharedLibraryCore/events/server/ServerValueSetRequestEvent.md @@ -27,10 +27,11 @@ SharedLibraryCore.Events.Server.GameServerEvent --> SharedLibraryCore.Events.Ser ### Inheritance - [ `GameServerEvent` -](./sharedlibrarycoreeventsserver-GameServerEvent) +](./GameServerEvent.md) ### Constructors #### ServerValueSetRequestEvent +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Events/Server/ServerValueSetRequestEvent.cs#L7) ```csharp public ServerValueSetRequestEvent(string valueName, string value, IGameServer server) ``` @@ -39,7 +40,7 @@ public ServerValueSetRequestEvent(string valueName, string value, IGameServer se | --- | --- | --- | | `string` | valueName | | | `string` | value | | -| [`IGameServer`](./sharedlibrarycoreinterfaces-IGameServer) | server | | +| [`IGameServer`](../../interfaces/IGameServer.md) | server | | ### Properties #### ValueName diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreexceptions-AuthorizationException.md b/CodeDocumentation/SharedLibraryCore/exceptions/AuthorizationException.md similarity index 85% rename from CodeDocumentation/SharedLibraryCore/sharedlibrarycoreexceptions-AuthorizationException.md rename to CodeDocumentation/SharedLibraryCore/exceptions/AuthorizationException.md index 74505da..b8ab0fd 100644 --- a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreexceptions-AuthorizationException.md +++ b/CodeDocumentation/SharedLibraryCore/exceptions/AuthorizationException.md @@ -20,6 +20,7 @@ System.Exception --> SharedLibraryCore.Exceptions.AuthorizationException ### Constructors #### AuthorizationException +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Exceptions/AuthorizationException.cs#L7) ```csharp public AuthorizationException(string message) ``` diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreexceptions-CommandException.md b/CodeDocumentation/SharedLibraryCore/exceptions/CommandException.md similarity index 83% rename from CodeDocumentation/SharedLibraryCore/sharedlibrarycoreexceptions-CommandException.md rename to CodeDocumentation/SharedLibraryCore/exceptions/CommandException.md index aa1afae..75a70d4 100644 --- a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreexceptions-CommandException.md +++ b/CodeDocumentation/SharedLibraryCore/exceptions/CommandException.md @@ -16,10 +16,11 @@ SharedLibraryCore.Exceptions.ServerException --> SharedLibraryCore.Exceptions.Co ### Inheritance - [ `ServerException` -](./sharedlibrarycoreexceptions-ServerException) +](./ServerException.md) ### Constructors #### CommandException +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Exceptions/CommandException.cs#L5) ```csharp public CommandException(string msg) ``` diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreexceptions-ConfigurationException.md b/CodeDocumentation/SharedLibraryCore/exceptions/ConfigurationException.md similarity index 89% rename from CodeDocumentation/SharedLibraryCore/sharedlibrarycoreexceptions-ConfigurationException.md rename to CodeDocumentation/SharedLibraryCore/exceptions/ConfigurationException.md index b4cf8d1..0a4683e 100644 --- a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreexceptions-ConfigurationException.md +++ b/CodeDocumentation/SharedLibraryCore/exceptions/ConfigurationException.md @@ -28,6 +28,7 @@ System.Exception --> SharedLibraryCore.Exceptions.ConfigurationException ### Constructors #### ConfigurationException +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Exceptions/ConfigurationException.cs#L7) ```csharp public ConfigurationException(string message) ``` diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreexceptions-DatabaseException.md b/CodeDocumentation/SharedLibraryCore/exceptions/DatabaseException.md similarity index 84% rename from CodeDocumentation/SharedLibraryCore/sharedlibrarycoreexceptions-DatabaseException.md rename to CodeDocumentation/SharedLibraryCore/exceptions/DatabaseException.md index 4ceba7a..1ab7e8d 100644 --- a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreexceptions-DatabaseException.md +++ b/CodeDocumentation/SharedLibraryCore/exceptions/DatabaseException.md @@ -20,6 +20,7 @@ System.Exception --> SharedLibraryCore.Exceptions.DatabaseException ### Constructors #### DatabaseException +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Exceptions/DatabaseException.cs#L7) ```csharp public DatabaseException(string msg) ``` diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreexceptions-DvarException.md b/CodeDocumentation/SharedLibraryCore/exceptions/DvarException.md similarity index 83% rename from CodeDocumentation/SharedLibraryCore/sharedlibrarycoreexceptions-DvarException.md rename to CodeDocumentation/SharedLibraryCore/exceptions/DvarException.md index 3d9f71e..0462083 100644 --- a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreexceptions-DvarException.md +++ b/CodeDocumentation/SharedLibraryCore/exceptions/DvarException.md @@ -16,10 +16,11 @@ SharedLibraryCore.Exceptions.ServerException --> SharedLibraryCore.Exceptions.Dv ### Inheritance - [ `ServerException` -](./sharedlibrarycoreexceptions-ServerException) +](./ServerException.md) ### Constructors #### DvarException +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Exceptions/DvarException.cs#L5) ```csharp public DvarException(string msg) ``` diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreexceptions-NetworkException.md b/CodeDocumentation/SharedLibraryCore/exceptions/NetworkException.md similarity index 77% rename from CodeDocumentation/SharedLibraryCore/sharedlibrarycoreexceptions-NetworkException.md rename to CodeDocumentation/SharedLibraryCore/exceptions/NetworkException.md index 8c40d8e..b205076 100644 --- a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreexceptions-NetworkException.md +++ b/CodeDocumentation/SharedLibraryCore/exceptions/NetworkException.md @@ -16,10 +16,11 @@ SharedLibraryCore.Exceptions.ServerException --> SharedLibraryCore.Exceptions.Ne ### Inheritance - [ `ServerException` -](./sharedlibrarycoreexceptions-ServerException) +](./ServerException.md) ### Constructors #### NetworkException [1/2] +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Exceptions/NetworkException.cs#L7) ```csharp public NetworkException(string msg) ``` @@ -29,6 +30,7 @@ public NetworkException(string msg) | `string` | msg | | #### NetworkException [2/2] +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Exceptions/NetworkException.cs#L11) ```csharp public NetworkException(string msg, Socket s) ``` diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreexceptions-PluginException.md b/CodeDocumentation/SharedLibraryCore/exceptions/PluginException.md similarity index 88% rename from CodeDocumentation/SharedLibraryCore/sharedlibrarycoreexceptions-PluginException.md rename to CodeDocumentation/SharedLibraryCore/exceptions/PluginException.md index e3f5df7..9730759 100644 --- a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreexceptions-PluginException.md +++ b/CodeDocumentation/SharedLibraryCore/exceptions/PluginException.md @@ -27,6 +27,7 @@ System.Exception --> SharedLibraryCore.Exceptions.PluginException ### Constructors #### PluginException +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Exceptions/PluginException.cs#L7) ```csharp public PluginException(string message) ``` diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreexceptions-RConException.md b/CodeDocumentation/SharedLibraryCore/exceptions/RConException.md similarity index 83% rename from CodeDocumentation/SharedLibraryCore/sharedlibrarycoreexceptions-RConException.md rename to CodeDocumentation/SharedLibraryCore/exceptions/RConException.md index 04ccdd7..021e57e 100644 --- a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreexceptions-RConException.md +++ b/CodeDocumentation/SharedLibraryCore/exceptions/RConException.md @@ -27,6 +27,7 @@ System.Exception --> SharedLibraryCore.Exceptions.RConException ### Constructors #### RConException [1/2] +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Exceptions/RConException.cs#L9) ```csharp public RConException(string message) ``` @@ -36,6 +37,7 @@ public RConException(string message) | `string` | message | | #### RConException [2/2] +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Exceptions/RConException.cs#L13) ```csharp public RConException(string message, bool isOperationCancelled) ``` diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreexceptions-SerializeException.md b/CodeDocumentation/SharedLibraryCore/exceptions/SerializeException.md similarity index 84% rename from CodeDocumentation/SharedLibraryCore/sharedlibrarycoreexceptions-SerializeException.md rename to CodeDocumentation/SharedLibraryCore/exceptions/SerializeException.md index 86b88eb..c82a53f 100644 --- a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreexceptions-SerializeException.md +++ b/CodeDocumentation/SharedLibraryCore/exceptions/SerializeException.md @@ -20,6 +20,7 @@ System.Exception --> SharedLibraryCore.Exceptions.SerializeException ### Constructors #### SerializeException +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Exceptions/SerializationException.cs#L7) ```csharp public SerializeException(string msg) ``` diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreexceptions-ServerException.md b/CodeDocumentation/SharedLibraryCore/exceptions/ServerException.md similarity index 84% rename from CodeDocumentation/SharedLibraryCore/sharedlibrarycoreexceptions-ServerException.md rename to CodeDocumentation/SharedLibraryCore/exceptions/ServerException.md index 906c928..7d91ca1 100644 --- a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreexceptions-ServerException.md +++ b/CodeDocumentation/SharedLibraryCore/exceptions/ServerException.md @@ -20,6 +20,7 @@ System.Exception --> SharedLibraryCore.Exceptions.ServerException ### Constructors #### ServerException +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Exceptions/ServerException.cs#L7) ```csharp public ServerException(string msg) ``` diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreformatting-ColorCodeMapping.md b/CodeDocumentation/SharedLibraryCore/formatting/ColorCodeMapping.md similarity index 100% rename from CodeDocumentation/SharedLibraryCore/sharedlibrarycoreformatting-ColorCodeMapping.md rename to CodeDocumentation/SharedLibraryCore/formatting/ColorCodeMapping.md diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreformatting-ColorCodes.md b/CodeDocumentation/SharedLibraryCore/formatting/ColorCodes.md similarity index 100% rename from CodeDocumentation/SharedLibraryCore/sharedlibrarycoreformatting-ColorCodes.md rename to CodeDocumentation/SharedLibraryCore/formatting/ColorCodes.md diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoregameevent-EventFailReason.md b/CodeDocumentation/SharedLibraryCore/gameevent/EventFailReason.md similarity index 100% rename from CodeDocumentation/SharedLibraryCore/sharedlibrarycoregameevent-EventFailReason.md rename to CodeDocumentation/SharedLibraryCore/gameevent/EventFailReason.md diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoregameevent-EventRequiredEntity.md b/CodeDocumentation/SharedLibraryCore/gameevent/EventRequiredEntity.md similarity index 100% rename from CodeDocumentation/SharedLibraryCore/sharedlibrarycoregameevent-EventRequiredEntity.md rename to CodeDocumentation/SharedLibraryCore/gameevent/EventRequiredEntity.md diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoregameevent-EventSource.md b/CodeDocumentation/SharedLibraryCore/gameevent/EventSource.md similarity index 100% rename from CodeDocumentation/SharedLibraryCore/sharedlibrarycoregameevent-EventSource.md rename to CodeDocumentation/SharedLibraryCore/gameevent/EventSource.md diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoregameevent-EventType.md b/CodeDocumentation/SharedLibraryCore/gameevent/EventType.md similarity index 100% rename from CodeDocumentation/SharedLibraryCore/sharedlibrarycoregameevent-EventType.md rename to CodeDocumentation/SharedLibraryCore/gameevent/EventType.md diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycorehelpers-BuildNumber.md b/CodeDocumentation/SharedLibraryCore/helpers/BuildNumber.md similarity index 65% rename from CodeDocumentation/SharedLibraryCore/sharedlibrarycorehelpers-BuildNumber.md rename to CodeDocumentation/SharedLibraryCore/helpers/BuildNumber.md index b21cbb0..b8eaf58 100644 --- a/CodeDocumentation/SharedLibraryCore/sharedlibrarycorehelpers-BuildNumber.md +++ b/CodeDocumentation/SharedLibraryCore/helpers/BuildNumber.md @@ -36,10 +36,10 @@ System.IComparable --> SharedLibraryCore.Helpers.BuildNumber #### Public Static methods | Returns | Name | | --- | --- | -| `bool` | `operator` [`<`](#operator-)([`BuildNumber`](sharedlibrarycorehelpers-BuildNumber) first, [`BuildNumber`](sharedlibrarycorehelpers-BuildNumber) second) | -| `bool` | `operator` [`>`](#operator-)([`BuildNumber`](sharedlibrarycorehelpers-BuildNumber) first, [`BuildNumber`](sharedlibrarycorehelpers-BuildNumber) second) | -| [`BuildNumber`](sharedlibrarycorehelpers-BuildNumber) | [`Parse`](#parse)(`string` buildNumber)
Parses a build number string into a BuildNumber class | -| `bool` | [`TryParse`](#tryparse)(`string` input, out [`BuildNumber`](sharedlibrarycorehelpers-BuildNumber) buildNumber) | +| `bool` | `operator` [`<`](#operator-)([`BuildNumber`](sharedlibrarycore/helpers/BuildNumber.md) first, [`BuildNumber`](sharedlibrarycore/helpers/BuildNumber.md) second) | +| `bool` | `operator` [`>`](#operator-)([`BuildNumber`](sharedlibrarycore/helpers/BuildNumber.md) first, [`BuildNumber`](sharedlibrarycore/helpers/BuildNumber.md) second) | +| [`BuildNumber`](sharedlibrarycore/helpers/BuildNumber.md) | [`Parse`](#parse)(`string` buildNumber)
Parses a build number string into a BuildNumber class | +| `bool` | [`TryParse`](#tryparse)(`string` input, out [`BuildNumber`](sharedlibrarycore/helpers/BuildNumber.md) buildNumber) | ## Details ### Inheritance @@ -47,6 +47,7 @@ System.IComparable --> SharedLibraryCore.Helpers.BuildNumber ### Methods #### CompareTo +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Helpers/BuildNumber.cs#L19) ```csharp public virtual int CompareTo(object obj) ``` @@ -56,6 +57,7 @@ public virtual int CompareTo(object obj) | `object` | obj | | #### TryParse +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Helpers/BuildNumber.cs#L46) ```csharp public static bool TryParse(string input, out BuildNumber buildNumber) ``` @@ -63,9 +65,10 @@ public static bool TryParse(string input, out BuildNumber buildNumber) | Type | Name | Description | | --- | --- | --- | | `string` | input | | -| `out` [`BuildNumber`](sharedlibrarycorehelpers-BuildNumber) | buildNumber | | +| `out` [`BuildNumber`](sharedlibrarycore/helpers/BuildNumber.md) | buildNumber | | #### Parse +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Helpers/BuildNumber.cs#L77) ```csharp public static BuildNumber Parse(string buildNumber) ``` @@ -88,31 +91,35 @@ A new BuildNumber class set from the buildNumber string | ArgumentOutOfRangeException | Thrown if any version
integer is less than zero | #### ToString +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Helpers/BuildNumber.cs#L129) ```csharp public override string ToString() ``` #### Operator > +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Helpers/BuildNumber.cs#L136) ```csharp public static bool operator >(BuildNumber first, BuildNumber second) ``` ##### Arguments | Type | Name | Description | | --- | --- | --- | -| [`BuildNumber`](sharedlibrarycorehelpers-BuildNumber) | first | | -| [`BuildNumber`](sharedlibrarycorehelpers-BuildNumber) | second | | +| [`BuildNumber`](sharedlibrarycore/helpers/BuildNumber.md) | first | | +| [`BuildNumber`](sharedlibrarycore/helpers/BuildNumber.md) | second | | #### Operator < +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Helpers/BuildNumber.cs#L141) ```csharp public static bool operator <(BuildNumber first, BuildNumber second) ``` ##### Arguments | Type | Name | Description | | --- | --- | --- | -| [`BuildNumber`](sharedlibrarycorehelpers-BuildNumber) | first | | -| [`BuildNumber`](sharedlibrarycorehelpers-BuildNumber) | second | | +| [`BuildNumber`](sharedlibrarycore/helpers/BuildNumber.md) | first | | +| [`BuildNumber`](sharedlibrarycore/helpers/BuildNumber.md) | second | | #### Equals +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Helpers/BuildNumber.cs#L146) ```csharp public override bool Equals(object obj) ``` @@ -122,6 +129,7 @@ public override bool Equals(object obj) | `object` | obj | | #### GetHashCode +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Helpers/BuildNumber.cs#L151) ```csharp public override int GetHashCode() ``` diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycorehelpers-BuildNumberJsonConverter.md b/CodeDocumentation/SharedLibraryCore/helpers/BuildNumberJsonConverter.md similarity index 83% rename from CodeDocumentation/SharedLibraryCore/sharedlibrarycorehelpers-BuildNumberJsonConverter.md rename to CodeDocumentation/SharedLibraryCore/helpers/BuildNumberJsonConverter.md index b833a31..0bbf4c0 100644 --- a/CodeDocumentation/SharedLibraryCore/sharedlibrarycorehelpers-BuildNumberJsonConverter.md +++ b/CodeDocumentation/SharedLibraryCore/helpers/BuildNumberJsonConverter.md @@ -41,6 +41,7 @@ public BuildNumberJsonConverter() ### Methods #### CanConvert +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Helpers/BuildNumberJsonConverter.cs#L12) ```csharp public override bool CanConvert(Type objectType) ``` @@ -50,6 +51,7 @@ public override bool CanConvert(Type objectType) | `Type` | objectType | | #### ReadJson +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Helpers/BuildNumberJsonConverter.cs#L18) ```csharp public override object ReadJson(JsonReader reader, Type objectType, object existingValue, JsonSerializer serializer) ``` @@ -62,6 +64,7 @@ public override object ReadJson(JsonReader reader, Type objectType, object exist | `JsonSerializer` | serializer | | #### WriteJson +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Helpers/BuildNumberJsonConverter.cs#L23) ```csharp public override void WriteJson(JsonWriter writer, object value, JsonSerializer serializer) ``` diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycorehelpers-ChangeTrackingT.md b/CodeDocumentation/SharedLibraryCore/helpers/ChangeTrackingT.md similarity index 78% rename from CodeDocumentation/SharedLibraryCore/sharedlibrarycorehelpers-ChangeTrackingT.md rename to CodeDocumentation/SharedLibraryCore/helpers/ChangeTrackingT.md index f35084e..7c1c755 100644 --- a/CodeDocumentation/SharedLibraryCore/sharedlibrarycorehelpers-ChangeTrackingT.md +++ b/CodeDocumentation/SharedLibraryCore/helpers/ChangeTrackingT.md @@ -39,12 +39,14 @@ This class provides a way to keep track of changes to an entity ### Constructors #### ChangeTracking +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Helpers/ChangeTracking.cs#L13) ```csharp public ChangeTracking() ``` ### Methods #### OnChange +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Helpers/ChangeTracking.cs#L21) ```csharp public void OnChange(T value) ``` @@ -54,6 +56,7 @@ public void OnChange(T value) | `T` | value | | #### GetNextChange +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Helpers/ChangeTracking.cs#L31) ```csharp public T GetNextChange() ``` diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycorehelpers-Hashing.md b/CodeDocumentation/SharedLibraryCore/helpers/Hashing.md similarity index 88% rename from CodeDocumentation/SharedLibraryCore/sharedlibrarycorehelpers-Hashing.md rename to CodeDocumentation/SharedLibraryCore/helpers/Hashing.md index 50e59ce..517fb50 100644 --- a/CodeDocumentation/SharedLibraryCore/sharedlibrarycorehelpers-Hashing.md +++ b/CodeDocumentation/SharedLibraryCore/helpers/Hashing.md @@ -26,6 +26,7 @@ public Hashing() ### Methods #### Hash +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Helpers/Hashing.cs#L14) ```csharp public static string Hash(string password, string saltStr) ``` diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycorehelpers-InteractionData.md b/CodeDocumentation/SharedLibraryCore/helpers/InteractionData.md similarity index 92% rename from CodeDocumentation/SharedLibraryCore/sharedlibrarycorehelpers-InteractionData.md rename to CodeDocumentation/SharedLibraryCore/helpers/InteractionData.md index 77b61d8..505b89e 100644 --- a/CodeDocumentation/SharedLibraryCore/sharedlibrarycorehelpers-InteractionData.md +++ b/CodeDocumentation/SharedLibraryCore/helpers/InteractionData.md @@ -29,7 +29,7 @@ SharedLibraryCore.Interfaces.IInteractionData --> SharedLibraryCore.Helpers.Inte | `bool` | [`Enabled`](#enabled) | `get, set` | | `Nullable`<`int`> | [`EntityId`](#entityid) | `get, set` | | `string` | [`InteractionId`](#interactionid) | `get, set` | -| [`InteractionType`](./sharedlibrarycoreinterfaces-InteractionType) | [`InteractionType`](#interactiontype) | `get, set` | +| [`InteractionType`](../interfaces/InteractionType.md) | [`InteractionType`](#interactiontype) | `get, set` | | `Nullable`<`Permission`> | [`MinimumPermission`](#minimumpermission) | `get, set` | | `string` | [`Name`](#name) | `get, set` | | `string` | [`PermissionAccess`](#permissionaccess) | `get, set` | @@ -41,10 +41,11 @@ SharedLibraryCore.Interfaces.IInteractionData --> SharedLibraryCore.Helpers.Inte ### Inheritance - [ `IInteractionData` -](./sharedlibrarycoreinterfaces-IInteractionData) +](../interfaces/IInteractionData.md) ### Constructors #### InteractionData +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Helpers/InteractionData.cs#L20) ```csharp public InteractionData() ``` diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycorehelpers-MessageToken.md b/CodeDocumentation/SharedLibraryCore/helpers/MessageToken.md similarity index 79% rename from CodeDocumentation/SharedLibraryCore/sharedlibrarycorehelpers-MessageToken.md rename to CodeDocumentation/SharedLibraryCore/helpers/MessageToken.md index b31fb64..089c026 100644 --- a/CodeDocumentation/SharedLibraryCore/sharedlibrarycorehelpers-MessageToken.md +++ b/CodeDocumentation/SharedLibraryCore/helpers/MessageToken.md @@ -21,11 +21,12 @@ #### Public methods | Returns | Name | | --- | --- | -| `Task`<`string`> | [`ProcessAsync`](#processasync)([`Server`](./sharedlibrarycore-Server) server) | +| `Task`<`string`> | [`ProcessAsync`](#processasync)([`Server`](../Server.md) server) | ## Details ### Constructors #### MessageToken +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Helpers/MessageToken.cs#L11) ```csharp public MessageToken(string Name, Func> Value) ``` @@ -33,7 +34,7 @@ public MessageToken(string Name, Func> Value) | Type | Name | Description | | --- | --- | --- | | `string` | Name | | -| `Func`<[`Server`](./sharedlibrarycore-Server), `Task`<`string`>> | Value | | +| `Func`<[`Server`](../Server.md), `Task`<`string`>> | Value | | ### Methods #### ProcessAsync @@ -43,7 +44,7 @@ public async Task ProcessAsync(Server server) ##### Arguments | Type | Name | Description | | --- | --- | --- | -| [`Server`](./sharedlibrarycore-Server) | server | | +| [`Server`](../Server.md) | server | | ### Properties #### Name diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycorehelpers-ParseEnumT.md b/CodeDocumentation/SharedLibraryCore/helpers/ParseEnumT.md similarity index 86% rename from CodeDocumentation/SharedLibraryCore/sharedlibrarycorehelpers-ParseEnumT.md rename to CodeDocumentation/SharedLibraryCore/helpers/ParseEnumT.md index a0e340c..8157e4d 100644 --- a/CodeDocumentation/SharedLibraryCore/sharedlibrarycorehelpers-ParseEnumT.md +++ b/CodeDocumentation/SharedLibraryCore/helpers/ParseEnumT.md @@ -27,6 +27,7 @@ public ParseEnum() ### Methods #### Get +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Helpers/ParseEnum.cs#L8) ```csharp public static T Get(string e, Type type) ``` diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycorehelpers-Report.md b/CodeDocumentation/SharedLibraryCore/helpers/Report.md similarity index 81% rename from CodeDocumentation/SharedLibraryCore/sharedlibrarycorehelpers-Report.md rename to CodeDocumentation/SharedLibraryCore/helpers/Report.md index 3adb8d8..6006119 100644 --- a/CodeDocumentation/SharedLibraryCore/sharedlibrarycorehelpers-Report.md +++ b/CodeDocumentation/SharedLibraryCore/helpers/Report.md @@ -15,10 +15,10 @@ #### Public properties | Type | Name | Methods | | --- | --- | --- | -| [`EFClient`](./sharedlibrarycoredatabasemodels-EFClient) | [`Origin`](#origin) | `get, set` | +| [`EFClient`](../database/models/EFClient.md) | [`Origin`](#origin) | `get, set` | | `string` | [`Reason`](#reason) | `get, set` | | `DateTime` | [`ReportedOn`](#reportedon) | `get, set` | -| [`EFClient`](./sharedlibrarycoredatabasemodels-EFClient) | [`Target`](#target) | `get, set` | +| [`EFClient`](../database/models/EFClient.md) | [`Target`](#target) | `get, set` | ## Details ### Constructors diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycorehelpers-ResourceQueryHelperResultT.md b/CodeDocumentation/SharedLibraryCore/helpers/ResourceQueryHelperResultT.md similarity index 100% rename from CodeDocumentation/SharedLibraryCore/sharedlibrarycorehelpers-ResourceQueryHelperResultT.md rename to CodeDocumentation/SharedLibraryCore/helpers/ResourceQueryHelperResultT.md diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycorehelpers-TokenIdentifier.md b/CodeDocumentation/SharedLibraryCore/helpers/TokenIdentifier.md similarity index 95% rename from CodeDocumentation/SharedLibraryCore/sharedlibrarycorehelpers-TokenIdentifier.md rename to CodeDocumentation/SharedLibraryCore/helpers/TokenIdentifier.md index 529973a..f20afd5 100644 --- a/CodeDocumentation/SharedLibraryCore/sharedlibrarycorehelpers-TokenIdentifier.md +++ b/CodeDocumentation/SharedLibraryCore/helpers/TokenIdentifier.md @@ -27,7 +27,7 @@ SharedLibraryCore.Interfaces.ITokenIdentifier --> SharedLibraryCore.Helpers.Toke ### Inheritance - [ `ITokenIdentifier` -](./sharedlibrarycoreinterfaces-ITokenIdentifier) +](../interfaces/ITokenIdentifier.md) ### Constructors #### TokenIdentifier diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycorehelpers-TokenState.md b/CodeDocumentation/SharedLibraryCore/helpers/TokenState.md similarity index 89% rename from CodeDocumentation/SharedLibraryCore/sharedlibrarycorehelpers-TokenState.md rename to CodeDocumentation/SharedLibraryCore/helpers/TokenState.md index 75afd00..c3713b0 100644 --- a/CodeDocumentation/SharedLibraryCore/sharedlibrarycorehelpers-TokenState.md +++ b/CodeDocumentation/SharedLibraryCore/helpers/TokenState.md @@ -23,6 +23,7 @@ ## Details ### Constructors #### TokenState +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Helpers/TokenState.cs#L7) ```csharp public TokenState() ``` diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfaces-IAlertManager.md b/CodeDocumentation/SharedLibraryCore/interfaces/IAlertManager.md similarity index 92% rename from CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfaces-IAlertManager.md rename to CodeDocumentation/SharedLibraryCore/interfaces/IAlertManager.md index 6f9700d..099e900 100644 --- a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfaces-IAlertManager.md +++ b/CodeDocumentation/SharedLibraryCore/interfaces/IAlertManager.md @@ -27,7 +27,7 @@ | `void` | [`MarkAlertAsRead`](#markalertasread)(`Guid` alertId)
Marks an alert as read and removes it from the manager | | `void` | [`MarkAllAlertsAsRead`](#markallalertsasread)(`int` recipientId)
Mark all alerts intended for the given recipientId as read | | `void` | [`RegisterStaticAlertSource`](#registerstaticalertsource)(`Func`<`Task`<`IEnumerable`<`AlertState`>>> alertSource) | -| `IEnumerable`<`AlertState`> | [`RetrieveAlerts`](#retrievealerts)([`EFClient`](./sharedlibrarycoredatabasemodels-EFClient) client)
Get all the alerts for given client | +| `IEnumerable`<`AlertState`> | [`RetrieveAlerts`](#retrievealerts)([`EFClient`](../database/models/EFClient.md) client)
Get all the alerts for given client | ## Details ### Methods @@ -48,7 +48,7 @@ public IEnumerable RetrieveAlerts(EFClient client) ##### Arguments | Type | Name | Description | | --- | --- | --- | -| [`EFClient`](./sharedlibrarycoredatabasemodels-EFClient) | client | client to retrieve alerts for | +| [`EFClient`](../database/models/EFClient.md) | client | client to retrieve alerts for | ##### Summary Get all the alerts for given client diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfaces-IAuditFields.md b/CodeDocumentation/SharedLibraryCore/interfaces/IAuditFields.md similarity index 100% rename from CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfaces-IAuditFields.md rename to CodeDocumentation/SharedLibraryCore/interfaces/IAuditFields.md diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfaces-IAuditInformationRepository.md b/CodeDocumentation/SharedLibraryCore/interfaces/IAuditInformationRepository.md similarity index 72% rename from CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfaces-IAuditInformationRepository.md rename to CodeDocumentation/SharedLibraryCore/interfaces/IAuditInformationRepository.md index 4a99ca0..ed94a0f 100644 --- a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfaces-IAuditInformationRepository.md +++ b/CodeDocumentation/SharedLibraryCore/interfaces/IAuditInformationRepository.md @@ -19,7 +19,7 @@ describes the capabilities of the audit info repository #### Public methods | Returns | Name | | --- | --- | -| `Task`<`IList`<[`AuditInfo`](./sharedlibrarycoredtos-AuditInfo)>> | [`ListAuditInformation`](#listauditinformation)([`PaginationRequest`](./sharedlibrarycoredtos-PaginationRequest) paginationInfo)
retrieves a list of audit information for given pagination params | +| `Task`<`IList`<[`AuditInfo`](../dtos/AuditInfo.md)>> | [`ListAuditInformation`](#listauditinformation)([`PaginationRequest`](../dtos/PaginationRequest.md) paginationInfo)
retrieves a list of audit information for given pagination params | ## Details ### Summary @@ -33,7 +33,7 @@ public Task> ListAuditInformation(PaginationRequest paginationI ##### Arguments | Type | Name | Description | | --- | --- | --- | -| [`PaginationRequest`](./sharedlibrarycoredtos-PaginationRequest) | paginationInfo | pagination info | +| [`PaginationRequest`](../dtos/PaginationRequest.md) | paginationInfo | pagination info | ##### Summary retrieves a list of audit information for given pagination params diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfaces-IBaseConfiguration.md b/CodeDocumentation/SharedLibraryCore/interfaces/IBaseConfiguration.md similarity index 86% rename from CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfaces-IBaseConfiguration.md rename to CodeDocumentation/SharedLibraryCore/interfaces/IBaseConfiguration.md index 6b999eb..a0e8be2 100644 --- a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfaces-IBaseConfiguration.md +++ b/CodeDocumentation/SharedLibraryCore/interfaces/IBaseConfiguration.md @@ -16,7 +16,7 @@ #### Public methods | Returns | Name | | --- | --- | -| [`IBaseConfiguration`](sharedlibrarycoreinterfaces-IBaseConfiguration) | [`Generate`](#generate)() | +| [`IBaseConfiguration`](sharedlibrarycore/interfaces/IBaseConfiguration.md) | [`Generate`](#generate)() | | `string` | [`Name`](#name)() | ## Details diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfaces-IBasePathProvider.md b/CodeDocumentation/SharedLibraryCore/interfaces/IBasePathProvider.md similarity index 100% rename from CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfaces-IBasePathProvider.md rename to CodeDocumentation/SharedLibraryCore/interfaces/IBasePathProvider.md diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfaces-IClientMeta.md b/CodeDocumentation/SharedLibraryCore/interfaces/IClientMeta.md similarity index 94% rename from CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfaces-IClientMeta.md rename to CodeDocumentation/SharedLibraryCore/interfaces/IClientMeta.md index 507271b..e8121c8 100644 --- a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfaces-IClientMeta.md +++ b/CodeDocumentation/SharedLibraryCore/interfaces/IClientMeta.md @@ -23,7 +23,7 @@ describes all the base attributes of a client meta object | `bool` | [`IsSensitive`](#issensitive) | `get` | | `Nullable`<`int`> | [`Order`](#order) | `get, set` | | `bool` | [`ShouldDisplay`](#shoulddisplay) | `get` | -| [`MetaType`](./sharedlibrarycoreinterfaces-MetaType) | [`Type`](#type) | `get` | +| [`MetaType`](./MetaType.md) | [`Type`](#type) | `get` | | `DateTime` | [`When`](#when) | `get` | ## Details diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfaces-IClientMetaResponse.md b/CodeDocumentation/SharedLibraryCore/interfaces/IClientMetaResponse.md similarity index 100% rename from CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfaces-IClientMetaResponse.md rename to CodeDocumentation/SharedLibraryCore/interfaces/IClientMetaResponse.md diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfaces-IClientNoticeMessageFormatter.md b/CodeDocumentation/SharedLibraryCore/interfaces/IClientNoticeMessageFormatter.md similarity index 77% rename from CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfaces-IClientNoticeMessageFormatter.md rename to CodeDocumentation/SharedLibraryCore/interfaces/IClientNoticeMessageFormatter.md index b311abe..72932cf 100644 --- a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfaces-IClientNoticeMessageFormatter.md +++ b/CodeDocumentation/SharedLibraryCore/interfaces/IClientNoticeMessageFormatter.md @@ -16,7 +16,7 @@ #### Public methods | Returns | Name | | --- | --- | -| `string` | [`BuildFormattedMessage`](#buildformattedmessage)([`IRConParserConfiguration`](./sharedlibrarycoreinterfaces-IRConParserConfiguration) config, `EFPenalty` currentPenalty, `EFPenalty` originalPenalty)
builds a game formatted notice message | +| `string` | [`BuildFormattedMessage`](#buildformattedmessage)([`IRConParserConfiguration`](./IRConParserConfiguration.md) config, `EFPenalty` currentPenalty, `EFPenalty` originalPenalty)
builds a game formatted notice message | ## Details ### Methods @@ -27,7 +27,7 @@ public string BuildFormattedMessage(IRConParserConfiguration config, EFPenalty c ##### Arguments | Type | Name | Description | | --- | --- | --- | -| [`IRConParserConfiguration`](./sharedlibrarycoreinterfaces-IRConParserConfiguration) | config | RCon parser config | +| [`IRConParserConfiguration`](./IRConParserConfiguration.md) | config | RCon parser config | | `EFPenalty` | currentPenalty | current penalty the message is for | | `EFPenalty` | originalPenalty | previous penalty the current penalty relates to | diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfaces-IConfigurationHandlerFactory.md b/CodeDocumentation/SharedLibraryCore/interfaces/IConfigurationHandlerFactory.md similarity index 79% rename from CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfaces-IConfigurationHandlerFactory.md rename to CodeDocumentation/SharedLibraryCore/interfaces/IConfigurationHandlerFactory.md index dcf68c7..9782f5f 100644 --- a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfaces-IConfigurationHandlerFactory.md +++ b/CodeDocumentation/SharedLibraryCore/interfaces/IConfigurationHandlerFactory.md @@ -20,8 +20,8 @@ defines the capabilities of the configuration handler factory #### Public methods | Returns | Name | | --- | --- | -| [`IConfigurationHandler`](./sharedlibrarycoreinterfaces-IConfigurationHandlerT)<`T`> | [`GetConfigurationHandler`](#getconfigurationhandler)(`string` name) | -| `Task`<[`IConfigurationHandler`](./sharedlibrarycoreinterfaces-IConfigurationHandlerT)<`T`>> | [`GetConfigurationHandlerAsync`](#getconfigurationhandlerasync)(`string` name) | +| [`IConfigurationHandler`](./IConfigurationHandlerT.md)<`T`> | [`GetConfigurationHandler`](#getconfigurationhandler)(`string` name) | +| `Task`<[`IConfigurationHandler`](./IConfigurationHandlerT.md)<`T`>> | [`GetConfigurationHandlerAsync`](#getconfigurationhandlerasync)(`string` name) | ## Details ### Summary diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfaces-IConfigurationHandlerT.md b/CodeDocumentation/SharedLibraryCore/interfaces/IConfigurationHandlerT.md similarity index 100% rename from CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfaces-IConfigurationHandlerT.md rename to CodeDocumentation/SharedLibraryCore/interfaces/IConfigurationHandlerT.md diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfaces-IConfigurationHandlerV2T.md b/CodeDocumentation/SharedLibraryCore/interfaces/IConfigurationHandlerV2T.md similarity index 100% rename from CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfaces-IConfigurationHandlerV2T.md rename to CodeDocumentation/SharedLibraryCore/interfaces/IConfigurationHandlerV2T.md diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfaces-ICoreEventHandler.md b/CodeDocumentation/SharedLibraryCore/interfaces/ICoreEventHandler.md similarity index 71% rename from CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfaces-ICoreEventHandler.md rename to CodeDocumentation/SharedLibraryCore/interfaces/ICoreEventHandler.md index 49fcade..c6b2d97 100644 --- a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfaces-ICoreEventHandler.md +++ b/CodeDocumentation/SharedLibraryCore/interfaces/ICoreEventHandler.md @@ -19,7 +19,7 @@ Handles games events (from log, manual events, etc) #### Public methods | Returns | Name | | --- | --- | -| `void` | [`QueueEvent`](#queueevent)([`IManager`](./sharedlibrarycoreinterfaces-IManager) manager, [`CoreEvent`](./sharedlibrarycoreevents-CoreEvent) coreEvent)
Add a core event event to the queue to be processed | +| `void` | [`QueueEvent`](#queueevent)([`IManager`](./IManager.md) manager, [`CoreEvent`](../events/CoreEvent.md) coreEvent)
Add a core event event to the queue to be processed | | `void` | [`StartProcessing`](#startprocessing)(`CancellationToken` token) | ## Details @@ -34,8 +34,8 @@ public void QueueEvent(IManager manager, CoreEvent coreEvent) ##### Arguments | Type | Name | Description | | --- | --- | --- | -| [`IManager`](./sharedlibrarycoreinterfaces-IManager) | manager | [IManager](./sharedlibrarycoreinterfaces-IManager) | -| [`CoreEvent`](./sharedlibrarycoreevents-CoreEvent) | coreEvent | [CoreEvent](./sharedlibrarycoreevents-CoreEvent) | +| [`IManager`](./IManager.md) | manager | [IManager](./IManager.md) | +| [`CoreEvent`](../events/CoreEvent.md) | coreEvent | [CoreEvent](../events/CoreEvent.md) | ##### Summary Add a core event event to the queue to be processed diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfaces-IEntityServiceT.md b/CodeDocumentation/SharedLibraryCore/interfaces/IEntityServiceT.md similarity index 100% rename from CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfaces-IEntityServiceT.md rename to CodeDocumentation/SharedLibraryCore/interfaces/IEntityServiceT.md diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfaces-IEventParser.md b/CodeDocumentation/SharedLibraryCore/interfaces/IEventParser.md similarity index 77% rename from CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfaces-IEventParser.md rename to CodeDocumentation/SharedLibraryCore/interfaces/IEventParser.md index 1e58a05..81cf08e 100644 --- a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfaces-IEventParser.md +++ b/CodeDocumentation/SharedLibraryCore/interfaces/IEventParser.md @@ -16,7 +16,7 @@ #### Public properties | Type | Name | Methods | | --- | --- | --- | -| [`IEventParserConfiguration`](./sharedlibrarycoreinterfaces-IEventParserConfiguration) | [`Configuration`](#configuration)
Get game specific folder prefix for log files | `get, set` | +| [`IEventParserConfiguration`](./IEventParserConfiguration.md) | [`Configuration`](#configuration)
Get game specific folder prefix for log files | `get, set` | | `Game` | [`GameName`](#gamename)
specifies the game name (usually the internal studio iteration ie: IW4, T5 etc...) | `get, set` | | `string` | [`Name`](#name)
specifies the text name of the game the parser is for | `get, set` | | `string` | [`URLProtocolFormat`](#urlprotocolformat)
specifies the connect URI used to join game servers via web browser | `get, set` | @@ -26,8 +26,8 @@ #### Public methods | Returns | Name | | --- | --- | -| [`GameEvent`](./sharedlibrarycore-GameEvent) | [`GenerateGameEvent`](#generategameevent)(`string` logLine)
Generates a game event based on log line input | -| `void` | [`RegisterCustomEvent`](#registercustomevent)(`string` eventSubtype, `string` eventTriggerValue, `Func`<`string`, [`IEventParserConfiguration`](./sharedlibrarycoreinterfaces-IEventParserConfiguration), [`GameEvent`](./sharedlibrarycore-GameEvent), [`GameEvent`](./sharedlibrarycore-GameEvent)> eventModifier) | +| [`GameEvent`](../GameEvent.md) | [`GenerateGameEvent`](#generategameevent)(`string` logLine)
Generates a game event based on log line input | +| `void` | [`RegisterCustomEvent`](#registercustomevent)(`string` eventSubtype, `string` eventTriggerValue, `Func`<`string`, [`IEventParserConfiguration`](./IEventParserConfiguration.md), [`GameEvent`](../GameEvent.md), [`GameEvent`](../GameEvent.md)> eventModifier) | ## Details ### Methods @@ -55,7 +55,7 @@ public void RegisterCustomEvent(string eventSubtype, string eventTriggerValue, F | --- | --- | --- | | `string` | eventSubtype | | | `string` | eventTriggerValue | | -| `Func`<`string`, [`IEventParserConfiguration`](./sharedlibrarycoreinterfaces-IEventParserConfiguration), [`GameEvent`](./sharedlibrarycore-GameEvent), [`GameEvent`](./sharedlibrarycore-GameEvent)> | eventModifier | | +| `Func`<`string`, [`IEventParserConfiguration`](./IEventParserConfiguration.md), [`GameEvent`](../GameEvent.md), [`GameEvent`](../GameEvent.md)> | eventModifier | | ### Properties #### Configuration diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfaces-IEventParserConfiguration.md b/CodeDocumentation/SharedLibraryCore/interfaces/IEventParserConfiguration.md similarity index 66% rename from CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfaces-IEventParserConfiguration.md rename to CodeDocumentation/SharedLibraryCore/interfaces/IEventParserConfiguration.md index af7f572..27fd9af 100644 --- a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfaces-IEventParserConfiguration.md +++ b/CodeDocumentation/SharedLibraryCore/interfaces/IEventParserConfiguration.md @@ -16,20 +16,20 @@ #### Public properties | Type | Name | Methods | | --- | --- | --- | -| [`ParserRegex`](./sharedlibrarycoreinterfaces-ParserRegex) | [`Action`](#action)
stores the regex information for an action event printed in the game log | `get, set` | -| [`ParserRegex`](./sharedlibrarycoreinterfaces-ParserRegex) | [`Damage`](#damage)
stores the regex information for a damage event printed in the game log | `get, set` | +| [`ParserRegex`](./ParserRegex.md) | [`Action`](#action)
stores the regex information for an action event printed in the game log | `get, set` | +| [`ParserRegex`](./ParserRegex.md) | [`Damage`](#damage)
stores the regex information for a damage event printed in the game log | `get, set` | | `string` | [`GameDirectory`](#gamedirectory)
stores the fs_game directory (this folder may vary between different clients) | `get, set` | | `NumberStyles` | [`GuidNumberStyle`](#guidnumberstyle)
indicates the format expected for parsed guids | `get, set` | -| [`ParserRegex`](./sharedlibrarycoreinterfaces-ParserRegex) | [`Join`](#join)
stores the regex information for a join event printed in the game log | `get, set` | -| [`ParserRegex`](./sharedlibrarycoreinterfaces-ParserRegex) | [`JoinTeam`](#jointeam)
stores the regex information for a join team event printed in the game log | `get, set` | -| [`ParserRegex`](./sharedlibrarycoreinterfaces-ParserRegex) | [`Kill`](#kill)
stores the regex information for a kill event printed in the game log | `get, set` | +| [`ParserRegex`](./ParserRegex.md) | [`Join`](#join)
stores the regex information for a join event printed in the game log | `get, set` | +| [`ParserRegex`](./ParserRegex.md) | [`JoinTeam`](#jointeam)
stores the regex information for a join team event printed in the game log | `get, set` | +| [`ParserRegex`](./ParserRegex.md) | [`Kill`](#kill)
stores the regex information for a kill event printed in the game log | `get, set` | | `string` | [`LocalizeText`](#localizetext)
stores the special ASCII value used by CoD games that prevents the text in the chat from being localized | `get, set` | -| [`ParserRegex`](./sharedlibrarycoreinterfaces-ParserRegex) | [`MapChange`](#mapchange)
stores the regex information for the map change game log | `get` | -| [`ParserRegex`](./sharedlibrarycoreinterfaces-ParserRegex) | [`MapEnd`](#mapend)
stores the regex information for the map end game log | `get` | -| [`ParserRegex`](./sharedlibrarycoreinterfaces-ParserRegex) | [`Quit`](#quit)
stores the regex information for a quit event printed in the game log | `get, set` | -| [`ParserRegex`](./sharedlibrarycoreinterfaces-ParserRegex) | [`Say`](#say)
stores the regex information for a say event printed in the game log | `get, set` | +| [`ParserRegex`](./ParserRegex.md) | [`MapChange`](#mapchange)
stores the regex information for the map change game log | `get` | +| [`ParserRegex`](./ParserRegex.md) | [`MapEnd`](#mapend)
stores the regex information for the map end game log | `get` | +| [`ParserRegex`](./ParserRegex.md) | [`Quit`](#quit)
stores the regex information for a quit event printed in the game log | `get, set` | +| [`ParserRegex`](./ParserRegex.md) | [`Say`](#say)
stores the regex information for a say event printed in the game log | `get, set` | | `Dictionary`<`string`, `TeamType`> | [`TeamMapping`](#teammapping)
maps the team code name to a type type eg "CT" -> Allies | `get` | -| [`ParserRegex`](./sharedlibrarycoreinterfaces-ParserRegex) | [`Time`](#time)
stores the regex information for the time prefix in game log | `get, set` | +| [`ParserRegex`](./ParserRegex.md) | [`Time`](#time)
stores the regex information for the time prefix in game log | `get, set` | ## Details ### Properties diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfaces-IGameLogReader.md b/CodeDocumentation/SharedLibraryCore/interfaces/IGameLogReader.md similarity index 81% rename from CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfaces-IGameLogReader.md rename to CodeDocumentation/SharedLibraryCore/interfaces/IGameLogReader.md index e44da2f..7f8f89c 100644 --- a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfaces-IGameLogReader.md +++ b/CodeDocumentation/SharedLibraryCore/interfaces/IGameLogReader.md @@ -26,7 +26,7 @@ represents the abstraction of game log reading #### Public methods | Returns | Name | | --- | --- | -| `Task`<`IEnumerable`<[`GameEvent`](./sharedlibrarycore-GameEvent)>> | [`ReadEventsFromLog`](#readeventsfromlog)(`long` fileSizeDiff, `long` startPosition, [`Server`](./sharedlibrarycore-Server) server)
get new events that have occured since the last poll | +| `Task`<`IEnumerable`<[`GameEvent`](../GameEvent.md)>> | [`ReadEventsFromLog`](#readeventsfromlog)(`long` fileSizeDiff, `long` startPosition, [`Server`](../Server.md) server)
get new events that have occured since the last poll | ## Details ### Summary @@ -42,7 +42,7 @@ public Task> ReadEventsFromLog(long fileSizeDiff, long st | --- | --- | --- | | `long` | fileSizeDiff | | | `long` | startPosition | | -| [`Server`](./sharedlibrarycore-Server) | server | | +| [`Server`](../Server.md) | server | | ##### Summary get new events that have occured since the last poll diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfaces-IGameLogReaderFactory.md b/CodeDocumentation/SharedLibraryCore/interfaces/IGameLogReaderFactory.md similarity index 73% rename from CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfaces-IGameLogReaderFactory.md rename to CodeDocumentation/SharedLibraryCore/interfaces/IGameLogReaderFactory.md index fc2cd84..87b8566 100644 --- a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfaces-IGameLogReaderFactory.md +++ b/CodeDocumentation/SharedLibraryCore/interfaces/IGameLogReaderFactory.md @@ -19,7 +19,7 @@ factory interface to create game log readers based on the log file uri #### Public methods | Returns | Name | | --- | --- | -| [`IGameLogReader`](./sharedlibrarycoreinterfaces-IGameLogReader) | [`CreateGameLogReader`](#creategamelogreader)(`Uri``[]` logUris, [`IEventParser`](./sharedlibrarycoreinterfaces-IEventParser) eventParser)
generates a new game log reader based on the provided Uri | +| [`IGameLogReader`](./IGameLogReader.md) | [`CreateGameLogReader`](#creategamelogreader)(`Uri``[]` logUris, [`IEventParser`](./IEventParser.md) eventParser)
generates a new game log reader based on the provided Uri | ## Details ### Summary @@ -34,7 +34,7 @@ public IGameLogReader CreateGameLogReader(Uri[] logUris, IEventParser eventParse | Type | Name | Description | | --- | --- | --- | | `Uri``[]` | logUris | collection of log uri used to generate the log reader | -| [`IEventParser`](./sharedlibrarycoreinterfaces-IEventParser) | eventParser | event parser for the log reader | +| [`IEventParser`](./IEventParser.md) | eventParser | event parser for the log reader | ##### Summary generates a new game log reader based on the provided Uri diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfaces-IGameServer.md b/CodeDocumentation/SharedLibraryCore/interfaces/IGameServer.md similarity index 87% rename from CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfaces-IGameServer.md rename to CodeDocumentation/SharedLibraryCore/interfaces/IGameServer.md index e4a0cfd..2372944 100644 --- a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfaces-IGameServer.md +++ b/CodeDocumentation/SharedLibraryCore/interfaces/IGameServer.md @@ -16,7 +16,7 @@ #### Public properties | Type | Name | Methods | | --- | --- | --- | -| `IReadOnlyList`<[`EFClient`](./sharedlibrarycoredatabasemodels-EFClient)> | [`ConnectedClients`](#connectedclients)
List of connected clients | `get` | +| `IReadOnlyList`<[`EFClient`](../database/models/EFClient.md)> | [`ConnectedClients`](#connectedclients)
List of connected clients | `get` | | `Game` | [`GameCode`](#gamecode)
Game code corresponding to the development studio project | `get` | | `string` | [`GamePassword`](#gamepassword)
Game password (required to join) | `get` | | `string` | [`Gametype`](#gametype)
Current gametype | `get` | @@ -25,7 +25,7 @@ | `long` | [`LegacyDatabaseId`](#legacydatabaseid)
Database id for EFServer table and references | `get` | | `string` | [`ListenAddress`](#listenaddress)
Network address the server is listening on | `get` | | `int` | [`ListenPort`](#listenport)
Network port the server is listening on | `get` | -| [`Map`](./sharedlibrarycore-Map) | [`Map`](#map)
Current map the game server is running | `get` | +| [`Map`](../Map.md) | [`Map`](#map)
Current map the game server is running | `get` | | `Nullable`<`DateTime`> | [`MatchEndTime`](#matchendtime)
Time the most recent match ended | `get` | | `Nullable`<`DateTime`> | [`MatchStartTime`](#matchstarttime)
Time the current match started | `get` | | `int` | [`PrivateClientSlots`](#privateclientslots)
Number of private client slots | `get` | @@ -36,7 +36,7 @@ | Returns | Name | | --- | --- | | `Task`<`string``[]`> | [`ExecuteCommandAsync`](#executecommandasync)(`string` command, `CancellationToken` token)
Execute a server command | -| `Task` | [`Kick`](#kick)(`string` reason, [`EFClient`](./sharedlibrarycoredatabasemodels-EFClient) target, [`EFClient`](./sharedlibrarycoredatabasemodels-EFClient) origin, `EFPenalty` previousPenalty)
kicks target on behalf of origin for given reason | +| `Task` | [`Kick`](#kick)(`string` reason, [`EFClient`](../database/models/EFClient.md) target, [`EFClient`](../database/models/EFClient.md) origin, `EFPenalty` previousPenalty)
kicks target on behalf of origin for given reason | | `Task` | [`SetDvarAsync`](#setdvarasync)(`string` name, `object` value, `CancellationToken` token)
Set value for server dvar | ## Details @@ -49,8 +49,8 @@ public Task Kick(string reason, EFClient target, EFClient origin, EFPenalty prev | Type | Name | Description | | --- | --- | --- | | `string` | reason | reason client is being kicked | -| [`EFClient`](./sharedlibrarycoredatabasemodels-EFClient) | target | client to kick | -| [`EFClient`](./sharedlibrarycoredatabasemodels-EFClient) | origin | source of kick action | +| [`EFClient`](../database/models/EFClient.md) | target | client to kick | +| [`EFClient`](../database/models/EFClient.md) | origin | source of kick action | | `EFPenalty` | previousPenalty | previous penalty the kick is occuring for (if applicable) | ##### Summary diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfaces-IGameServerInstanceFactory.md b/CodeDocumentation/SharedLibraryCore/interfaces/IGameServerInstanceFactory.md similarity index 67% rename from CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfaces-IGameServerInstanceFactory.md rename to CodeDocumentation/SharedLibraryCore/interfaces/IGameServerInstanceFactory.md index d61eba9..7c6b250 100644 --- a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfaces-IGameServerInstanceFactory.md +++ b/CodeDocumentation/SharedLibraryCore/interfaces/IGameServerInstanceFactory.md @@ -19,7 +19,7 @@ defines the capabilities of game server instance factory #### Public methods | Returns | Name | | --- | --- | -| [`Server`](./sharedlibrarycore-Server) | [`CreateServer`](#createserver)([`ServerConfiguration`](./sharedlibrarycoreconfiguration-ServerConfiguration) config, [`IManager`](./sharedlibrarycoreinterfaces-IManager) manager)
creates the instance of a game server | +| [`Server`](../Server.md) | [`CreateServer`](#createserver)([`ServerConfiguration`](../configuration/ServerConfiguration.md) config, [`IManager`](./IManager.md) manager)
creates the instance of a game server | ## Details ### Summary @@ -33,8 +33,8 @@ public Server CreateServer(ServerConfiguration config, IManager manager) ##### Arguments | Type | Name | Description | | --- | --- | --- | -| [`ServerConfiguration`](./sharedlibrarycoreconfiguration-ServerConfiguration) | config | server configuration | -| [`IManager`](./sharedlibrarycoreinterfaces-IManager) | manager | application manager | +| [`ServerConfiguration`](../configuration/ServerConfiguration.md) | config | server configuration | +| [`IManager`](./IManager.md) | manager | application manager | ##### Summary creates the instance of a game server diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfaces-IGeoLocationResult.md b/CodeDocumentation/SharedLibraryCore/interfaces/IGeoLocationResult.md similarity index 100% rename from CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfaces-IGeoLocationResult.md rename to CodeDocumentation/SharedLibraryCore/interfaces/IGeoLocationResult.md diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfaces-IGeoLocationService.md b/CodeDocumentation/SharedLibraryCore/interfaces/IGeoLocationService.md similarity index 84% rename from CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfaces-IGeoLocationService.md rename to CodeDocumentation/SharedLibraryCore/interfaces/IGeoLocationService.md index 435d9fa..7cf6859 100644 --- a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfaces-IGeoLocationService.md +++ b/CodeDocumentation/SharedLibraryCore/interfaces/IGeoLocationService.md @@ -16,7 +16,7 @@ #### Public methods | Returns | Name | | --- | --- | -| `Task`<[`IGeoLocationResult`](./sharedlibrarycoreinterfaces-IGeoLocationResult)> | [`Locate`](#locate)(`string` address) | +| `Task`<[`IGeoLocationResult`](./IGeoLocationResult.md)> | [`Locate`](#locate)(`string` address) | ## Details ### Methods diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfaces-IInteractionData.md b/CodeDocumentation/SharedLibraryCore/interfaces/IInteractionData.md similarity index 95% rename from CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfaces-IInteractionData.md rename to CodeDocumentation/SharedLibraryCore/interfaces/IInteractionData.md index 074c830..f9fd56a 100644 --- a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfaces-IInteractionData.md +++ b/CodeDocumentation/SharedLibraryCore/interfaces/IInteractionData.md @@ -25,7 +25,7 @@ | `bool` | [`Enabled`](#enabled) | `get` | | `Nullable`<`int`> | [`EntityId`](#entityid) | `get` | | `string` | [`InteractionId`](#interactionid) | `get` | -| [`InteractionType`](./sharedlibrarycoreinterfaces-InteractionType) | [`InteractionType`](#interactiontype) | `get` | +| [`InteractionType`](./InteractionType.md) | [`InteractionType`](#interactiontype) | `get` | | `Nullable`<`Permission`> | [`MinimumPermission`](#minimumpermission) | `get` | | `string` | [`Name`](#name) | `get` | | `string` | [`PermissionAccess`](#permissionaccess) | `get` | diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfaces-IInteractionRegistration.md b/CodeDocumentation/SharedLibraryCore/interfaces/IInteractionRegistration.md similarity index 86% rename from CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfaces-IInteractionRegistration.md rename to CodeDocumentation/SharedLibraryCore/interfaces/IInteractionRegistration.md index aa01b22..63d2188 100644 --- a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfaces-IInteractionRegistration.md +++ b/CodeDocumentation/SharedLibraryCore/interfaces/IInteractionRegistration.md @@ -16,9 +16,9 @@ #### Public methods | Returns | Name | | --- | --- | -| `Task`<`IEnumerable`<[`IInteractionData`](./sharedlibrarycoreinterfaces-IInteractionData)>> | [`GetInteractions`](#getinteractions)(`string` interactionPrefix, `Nullable`<`int`> clientId, `Nullable`<`Game`> game, `CancellationToken` token) | +| `Task`<`IEnumerable`<[`IInteractionData`](./IInteractionData.md)>> | [`GetInteractions`](#getinteractions)(`string` interactionPrefix, `Nullable`<`int`> clientId, `Nullable`<`Game`> game, `CancellationToken` token) | | `Task`<`string`> | [`ProcessInteraction`](#processinteraction)(`string` interactionId, `int` originId, `Nullable`<`int`> targetId, `Nullable`<`Game`> game, `IDictionary`<`string`, `string`> meta, `CancellationToken` token) | -| `void` | [`RegisterInteraction`](#registerinteraction)(`string` interactionName, `Func`<`Nullable`<`int`>, `Nullable`<`Game`>, `CancellationToken`, `Task`<[`IInteractionData`](./sharedlibrarycoreinterfaces-IInteractionData)>> interactionRegistration) | +| `void` | [`RegisterInteraction`](#registerinteraction)(`string` interactionName, `Func`<`Nullable`<`int`>, `Nullable`<`Game`>, `CancellationToken`, `Task`<[`IInteractionData`](./IInteractionData.md)>> interactionRegistration) | | `void` | [`RegisterScriptInteraction`](#registerscriptinteraction)(`string` interactionName, `string` source, `Delegate` interactionRegistration) | | `void` | [`UnregisterInteraction`](#unregisterinteraction)(`string` interactionName) | @@ -43,7 +43,7 @@ public void RegisterInteraction(string interactionName, Func, Null | Type | Name | Description | | --- | --- | --- | | `string` | interactionName | | -| `Func`<`Nullable`<`int`>, `Nullable`<`Game`>, `CancellationToken`, `Task`<[`IInteractionData`](./sharedlibrarycoreinterfaces-IInteractionData)>> | interactionRegistration | | +| `Func`<`Nullable`<`int`>, `Nullable`<`Game`>, `CancellationToken`, `Task`<[`IInteractionData`](./IInteractionData.md)>> | interactionRegistration | | #### UnregisterInteraction ```csharp diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfaces-ILogger.md b/CodeDocumentation/SharedLibraryCore/interfaces/ILogger.md similarity index 100% rename from CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfaces-ILogger.md rename to CodeDocumentation/SharedLibraryCore/interfaces/ILogger.md diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfaces-ILookupValueT.md b/CodeDocumentation/SharedLibraryCore/interfaces/ILookupValueT.md similarity index 100% rename from CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfaces-ILookupValueT.md rename to CodeDocumentation/SharedLibraryCore/interfaces/ILookupValueT.md diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfaces-IManager.md b/CodeDocumentation/SharedLibraryCore/interfaces/IManager.md similarity index 61% rename from CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfaces-IManager.md rename to CodeDocumentation/SharedLibraryCore/interfaces/IManager.md index c493554..0a4c039 100644 --- a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfaces-IManager.md +++ b/CodeDocumentation/SharedLibraryCore/interfaces/IManager.md @@ -16,44 +16,44 @@ #### Public properties | Type | Name | Methods | | --- | --- | --- | -| `IList`<[`IEventParser`](./sharedlibrarycoreinterfaces-IEventParser)> | [`AdditionalEventParsers`](#additionaleventparsers) | `get` | -| `IList`<[`IRConParser`](./sharedlibrarycoreinterfaces-IRConParser)> | [`AdditionalRConParsers`](#additionalrconparsers) | `get` | -| [`IAlertManager`](./sharedlibrarycoreinterfaces-IAlertManager) | [`AlertManager`](#alertmanager) | `get` | +| `IList`<[`IEventParser`](./IEventParser.md)> | [`AdditionalEventParsers`](#additionaleventparsers) | `get` | +| `IList`<[`IRConParser`](./IRConParser.md)> | [`AdditionalRConParsers`](#additionalrconparsers) | `get` | +| [`IAlertManager`](./IAlertManager.md) | [`AlertManager`](#alertmanager) | `get` | | `CancellationToken` | [`CancellationToken`](#cancellationtoken) | `get` | -| `IList`<`Func`<[`GameEvent`](./sharedlibrarycore-GameEvent), `bool`>> | [`CommandInterceptors`](#commandinterceptors) | `get` | -| `IReadOnlyList`<[`IManagerCommand`](./sharedlibrarycoreinterfaces-IManagerCommand)> | [`Commands`](#commands) | `get` | +| `IList`<`Func`<[`GameEvent`](../GameEvent.md), `bool`>> | [`CommandInterceptors`](#commandinterceptors) | `get` | +| `IReadOnlyList`<[`IManagerCommand`](./IManagerCommand.md)> | [`Commands`](#commands) | `get` | | `string` | [`ExternalIPAddress`](#externalipaddress) | `get` | -| [`IInteractionRegistration`](./sharedlibrarycoreinterfaces-IInteractionRegistration) | [`InteractionRegistration`](#interactionregistration) | `get` | +| [`IInteractionRegistration`](./IInteractionRegistration.md) | [`InteractionRegistration`](#interactionregistration) | `get` | | `bool` | [`IsRestartRequested`](#isrestartrequested) | `get` | | `bool` | [`IsRunning`](#isrunning) | `get` | -| [`IMiddlewareActionHandler`](./sharedlibrarycoreinterfaces-IMiddlewareActionHandler) | [`MiddlewareActionHandler`](#middlewareactionhandler) | `get` | -| `IEnumerable`<[`IPlugin`](./sharedlibrarycoreinterfaces-IPlugin)> | [`Plugins`](#plugins)
enumerates the registered plugin instances | `get` | -| `ConcurrentDictionary`<`long`, [`GameEvent`](./sharedlibrarycore-GameEvent)> | [`ProcessingEvents`](#processingevents) | `get` | -| [`ITokenAuthentication`](./sharedlibrarycoreinterfaces-ITokenAuthentication) | [`TokenAuthenticator`](#tokenauthenticator) | `get` | +| [`IMiddlewareActionHandler`](./IMiddlewareActionHandler.md) | [`MiddlewareActionHandler`](#middlewareactionhandler) | `get` | +| `IEnumerable`<[`IPlugin`](./IPlugin.md)> | [`Plugins`](#plugins)
enumerates the registered plugin instances | `get` | +| `ConcurrentDictionary`<`long`, [`GameEvent`](../GameEvent.md)> | [`ProcessingEvents`](#processingevents) | `get` | +| [`ITokenAuthentication`](./ITokenAuthentication.md) | [`TokenAuthenticator`](#tokenauthenticator) | `get` | | `string` | [`Version`](#version) | `get` | ### Methods #### Public methods | Returns | Name | | --- | --- | -| `void` | [`AddAdditionalCommand`](#addadditionalcommand)([`IManagerCommand`](./sharedlibrarycoreinterfaces-IManagerCommand) command)
adds an additional (script) command to the command list | -| `void` | [`AddEvent`](#addevent)([`GameEvent`](./sharedlibrarycore-GameEvent) gameEvent)
queues an event for processing | -| `Task` | [`ExecuteEvent`](#executeevent)([`GameEvent`](./sharedlibrarycore-GameEvent) gameEvent) | +| `void` | [`AddAdditionalCommand`](#addadditionalcommand)([`IManagerCommand`](./IManagerCommand.md) command)
adds an additional (script) command to the command list | +| `void` | [`AddEvent`](#addevent)([`GameEvent`](../GameEvent.md) gameEvent)
queues an event for processing | +| `Task` | [`ExecuteEvent`](#executeevent)([`GameEvent`](../GameEvent.md) gameEvent) | | `Task`<`IList`<`T`>> | [`ExecuteSharedDatabaseOperation`](#executeshareddatabaseoperation)(`string` operationName) | -| [`EFClient`](./sharedlibrarycoredatabasemodels-EFClient) | [`FindActiveClient`](#findactiveclient)([`EFClient`](./sharedlibrarycoredatabasemodels-EFClient) client) | -| [`IEventParser`](./sharedlibrarycoreinterfaces-IEventParser) | [`GenerateDynamicEventParser`](#generatedynamiceventparser)(`string` name)
Generates an event parser that can be configured by script plugins | -| [`IRConParser`](./sharedlibrarycoreinterfaces-IRConParser) | [`GenerateDynamicRConParser`](#generatedynamicrconparser)(`string` name)
generates an rcon parser that can be configured by script plugins | -| `IList`<[`EFClient`](./sharedlibrarycoredatabasemodels-EFClient)> | [`GetActiveClients`](#getactiveclients)() | -| [`IConfigurationHandler`](./sharedlibrarycoreinterfaces-IConfigurationHandlerT)<[`ApplicationConfiguration`](./sharedlibrarycoreconfiguration-ApplicationConfiguration)> | [`GetApplicationSettings`](#getapplicationsettings)() | -| [`ClientService`](./sharedlibrarycoreservices-ClientService) | [`GetClientService`](#getclientservice)() | -| `IList`<[`IManagerCommand`](./sharedlibrarycoreinterfaces-IManagerCommand)> | [`GetCommands`](#getcommands)() | -| [`ILogger`](./sharedlibrarycoreinterfaces-ILogger) | [`GetLogger`](#getlogger)(`long` serverId) | -| `IList`<[`MessageToken`](./sharedlibrarycorehelpers-MessageToken)> | [`GetMessageTokens`](#getmessagetokens)() | -| [`IPageList`](./sharedlibrarycoreinterfaces-IPageList) | [`GetPageList`](#getpagelist)()
provides a page list to add and remove from | -| [`PenaltyService`](./sharedlibrarycoreservices-PenaltyService) | [`GetPenaltyService`](#getpenaltyservice)() | -| `IList`<[`Server`](./sharedlibrarycore-Server)> | [`GetServers`](#getservers)() | +| [`EFClient`](../database/models/EFClient.md) | [`FindActiveClient`](#findactiveclient)([`EFClient`](../database/models/EFClient.md) client) | +| [`IEventParser`](./IEventParser.md) | [`GenerateDynamicEventParser`](#generatedynamiceventparser)(`string` name)
Generates an event parser that can be configured by script plugins | +| [`IRConParser`](./IRConParser.md) | [`GenerateDynamicRConParser`](#generatedynamicrconparser)(`string` name)
generates an rcon parser that can be configured by script plugins | +| `IList`<[`EFClient`](../database/models/EFClient.md)> | [`GetActiveClients`](#getactiveclients)() | +| [`IConfigurationHandler`](./IConfigurationHandlerT.md)<[`ApplicationConfiguration`](../configuration/ApplicationConfiguration.md)> | [`GetApplicationSettings`](#getapplicationsettings)() | +| [`ClientService`](../services/ClientService.md) | [`GetClientService`](#getclientservice)() | +| `IList`<[`IManagerCommand`](./IManagerCommand.md)> | [`GetCommands`](#getcommands)() | +| [`ILogger`](./ILogger.md) | [`GetLogger`](#getlogger)(`long` serverId) | +| `IList`<[`MessageToken`](../helpers/MessageToken.md)> | [`GetMessageTokens`](#getmessagetokens)() | +| [`IPageList`](./IPageList.md) | [`GetPageList`](#getpagelist)()
provides a page list to add and remove from | +| [`PenaltyService`](../services/PenaltyService.md) | [`GetPenaltyService`](#getpenaltyservice)() | +| `IList`<[`Server`](../Server.md)> | [`GetServers`](#getservers)() | | `Task` | [`Init`](#init)() | -| `void` | [`QueueEvent`](#queueevent)([`CoreEvent`](./sharedlibrarycoreevents-CoreEvent) coreEvent)
queues an event for processing | +| `void` | [`QueueEvent`](#queueevent)([`CoreEvent`](../events/CoreEvent.md) coreEvent)
queues an event for processing | | `void` | [`RegisterSharedDatabaseOperation`](#registershareddatabaseoperation)(`Task`<`IList`> operation, `string` operationName) | | `void` | [`RemoveCommandByName`](#removecommandbyname)(`string` name)
removes a command by its name | | `Task` | [`Restart`](#restart)() | @@ -118,7 +118,7 @@ public EFClient FindActiveClient(EFClient client) ##### Arguments | Type | Name | Description | | --- | --- | --- | -| [`EFClient`](./sharedlibrarycoredatabasemodels-EFClient) | client | | +| [`EFClient`](../database/models/EFClient.md) | client | | #### GetApplicationSettings ```csharp @@ -202,7 +202,7 @@ public Task ExecuteEvent(GameEvent gameEvent) ##### Arguments | Type | Name | Description | | --- | --- | --- | -| [`GameEvent`](./sharedlibrarycore-GameEvent) | gameEvent | | +| [`GameEvent`](../GameEvent.md) | gameEvent | | #### AddEvent ```csharp @@ -211,7 +211,7 @@ public void AddEvent(GameEvent gameEvent) ##### Arguments | Type | Name | Description | | --- | --- | --- | -| [`GameEvent`](./sharedlibrarycore-GameEvent) | gameEvent | event to be processed | +| [`GameEvent`](../GameEvent.md) | gameEvent | event to be processed | ##### Summary queues an event for processing @@ -223,7 +223,7 @@ public void QueueEvent(CoreEvent coreEvent) ##### Arguments | Type | Name | Description | | --- | --- | --- | -| [`CoreEvent`](./sharedlibrarycoreevents-CoreEvent) | coreEvent | | +| [`CoreEvent`](../events/CoreEvent.md) | coreEvent | | ##### Summary queues an event for processing @@ -235,7 +235,7 @@ public void AddAdditionalCommand(IManagerCommand command) ##### Arguments | Type | Name | Description | | --- | --- | --- | -| [`IManagerCommand`](./sharedlibrarycoreinterfaces-IManagerCommand) | command | | +| [`IManagerCommand`](./IManagerCommand.md) | command | | ##### Summary adds an additional (script) command to the command list diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfaces-IManagerCommand.md b/CodeDocumentation/SharedLibraryCore/interfaces/IManagerCommand.md similarity index 92% rename from CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfaces-IManagerCommand.md rename to CodeDocumentation/SharedLibraryCore/interfaces/IManagerCommand.md index 5993cf5..5abe3ac 100644 --- a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfaces-IManagerCommand.md +++ b/CodeDocumentation/SharedLibraryCore/interfaces/IManagerCommand.md @@ -33,7 +33,7 @@ Defines the basic properties of a command #### Public methods | Returns | Name | | --- | --- | -| `Task` | [`ExecuteAsync`](#executeasync)([`GameEvent`](./sharedlibrarycore-GameEvent) gameEvent)
Executes the command | +| `Task` | [`ExecuteAsync`](#executeasync)([`GameEvent`](../GameEvent.md) gameEvent)
Executes the command | ## Details ### Summary @@ -47,7 +47,7 @@ public Task ExecuteAsync(GameEvent gameEvent) ##### Arguments | Type | Name | Description | | --- | --- | --- | -| [`GameEvent`](./sharedlibrarycore-GameEvent) | gameEvent | event corresponding to the command | +| [`GameEvent`](../GameEvent.md) | gameEvent | event corresponding to the command | ##### Summary Executes the command diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfaces-IMasterCommunication.md b/CodeDocumentation/SharedLibraryCore/interfaces/IMasterCommunication.md similarity index 100% rename from CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfaces-IMasterCommunication.md rename to CodeDocumentation/SharedLibraryCore/interfaces/IMasterCommunication.md diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfaces-IMatchResult.md b/CodeDocumentation/SharedLibraryCore/interfaces/IMatchResult.md similarity index 100% rename from CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfaces-IMatchResult.md rename to CodeDocumentation/SharedLibraryCore/interfaces/IMatchResult.md diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfaces-IMetaRegistration.md b/CodeDocumentation/SharedLibraryCore/interfaces/IMetaRegistration.md similarity index 100% rename from CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfaces-IMetaRegistration.md rename to CodeDocumentation/SharedLibraryCore/interfaces/IMetaRegistration.md diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfaces-IMetaService.md b/CodeDocumentation/SharedLibraryCore/interfaces/IMetaService.md similarity index 84% rename from CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfaces-IMetaService.md rename to CodeDocumentation/SharedLibraryCore/interfaces/IMetaService.md index 802ff49..fe49c11 100644 --- a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfaces-IMetaService.md +++ b/CodeDocumentation/SharedLibraryCore/interfaces/IMetaService.md @@ -17,10 +17,10 @@ | Returns | Name | | --- | --- | | `Task` | [`AddPersistentMeta`](#addpersistentmeta-12)(`...`)
adds or updates meta key and value to the database | -| `void` | [`AddRuntimeMeta`](#addruntimemeta)([`MetaType`](./sharedlibrarycoreinterfaces-MetaType) metaKey, `Func`<`T`, `Task`<`IEnumerable`<`V`>>> metaAction) | +| `void` | [`AddRuntimeMeta`](#addruntimemeta)([`MetaType`](./MetaType.md) metaKey, `Func`<`T`, `Task`<`IEnumerable`<`V`>>> metaAction) | | `Task` | [`DecrementPersistentMeta`](#decrementpersistentmeta)(`string` metaKey, `int` decrementAmount, `int` clientId)
decrements meta value and persists to the database if the meta value does not already exist it will be set to the decrement amount | | `Task`<`EFMeta`> | [`GetPersistentMeta`](#getpersistentmeta-12)(`...`)
retrieves meta data for given client and key | -| `Task`<`IEnumerable`<[`IClientMeta`](./sharedlibrarycoreinterfaces-IClientMeta)>> | [`GetRuntimeMeta`](#getruntimemeta-12)(`...`)
retrieves all the runtime meta information for given client idea | +| `Task`<`IEnumerable`<[`IClientMeta`](./IClientMeta.md)>> | [`GetRuntimeMeta`](#getruntimemeta-12)(`...`)
retrieves all the runtime meta information for given client idea | | `Task` | [`IncrementPersistentMeta`](#incrementpersistentmeta)(`string` metaKey, `int` incrementAmount, `int` clientId)
increments meta value and persists to the database if the meta value does not already exist it will be set to the increment amount | | `Task` | [`RemovePersistentMeta`](#removepersistentmeta-12)(`...`)
removes meta key with given value | | `Task` | [`SetPersistentMeta`](#setpersistentmeta)(`string` metaKey, `string` metaValue, `int` clientId)
adds or updates meta key and value to the database | @@ -36,7 +36,7 @@ public Task AddPersistentMeta(string metaKey, string metaValue, EFClient client, | --- | --- | --- | | `string` | metaKey | key of meta data | | `string` | metaValue | value of the meta data | -| [`EFClient`](./sharedlibrarycoredatabasemodels-EFClient) | client | client to save the meta for | +| [`EFClient`](../database/models/EFClient.md) | client | client to save the meta for | | `EFMeta` | linkedMeta | | ##### Summary @@ -120,7 +120,7 @@ public Task RemovePersistentMeta(string metaKey, EFClient client) | Type | Name | Description | | --- | --- | --- | | `string` | metaKey | key of meta data | -| [`EFClient`](./sharedlibrarycoredatabasemodels-EFClient) | client | client to delete the meta for | +| [`EFClient`](../database/models/EFClient.md) | client | client to delete the meta for | ##### Summary removes meta key with given value @@ -152,7 +152,7 @@ public Task GetPersistentMeta(string metaKey, EFClient client) | Type | Name | Description | | --- | --- | --- | | `string` | metaKey | key to retrieve value for | -| [`EFClient`](./sharedlibrarycoredatabasemodels-EFClient) | client | client to retrieve meta for | +| [`EFClient`](../database/models/EFClient.md) | client | client to retrieve meta for | ##### Summary retrieves meta data for given client and key @@ -184,7 +184,7 @@ where V : IClientMeta ##### Arguments | Type | Name | Description | | --- | --- | --- | -| [`MetaType`](./sharedlibrarycoreinterfaces-MetaType) | metaKey | | +| [`MetaType`](./MetaType.md) | metaKey | | | `Func`<`T`, `Task`<`IEnumerable`<`V`>>> | metaAction | | #### GetRuntimeMeta [1/2] @@ -194,7 +194,7 @@ public Task> GetRuntimeMeta(ClientPaginationRequest req ##### Arguments | Type | Name | Description | | --- | --- | --- | -| [`ClientPaginationRequest`](./sharedlibrarycorequeryhelper-ClientPaginationRequest) | request | request information | +| [`ClientPaginationRequest`](../queryhelper/ClientPaginationRequest.md) | request | request information | ##### Summary retrieves all the runtime meta information for given client idea @@ -210,7 +210,7 @@ where T : IClientMeta ##### Arguments | Type | Name | Description | | --- | --- | --- | -| [`ClientPaginationRequest`](./sharedlibrarycorequeryhelper-ClientPaginationRequest) | request | | -| [`MetaType`](./sharedlibrarycoreinterfaces-MetaType) | metaType | | +| [`ClientPaginationRequest`](../queryhelper/ClientPaginationRequest.md) | request | | +| [`MetaType`](./MetaType.md) | metaType | | *Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfaces-IMetaServiceV2.md b/CodeDocumentation/SharedLibraryCore/interfaces/IMetaServiceV2.md similarity index 91% rename from CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfaces-IMetaServiceV2.md rename to CodeDocumentation/SharedLibraryCore/interfaces/IMetaServiceV2.md index e863bf6..50e891e 100644 --- a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfaces-IMetaServiceV2.md +++ b/CodeDocumentation/SharedLibraryCore/interfaces/IMetaServiceV2.md @@ -16,12 +16,12 @@ #### Public methods | Returns | Name | | --- | --- | -| `void` | [`AddRuntimeMeta`](#addruntimemeta)([`MetaType`](./sharedlibrarycoreinterfaces-MetaType) metaKey, `Func`<`T`, `CancellationToken`, `Task`<`IEnumerable`<`TReturn`>>> metaAction) | +| `void` | [`AddRuntimeMeta`](#addruntimemeta)([`MetaType`](./MetaType.md) metaKey, `Func`<`T`, `CancellationToken`, `Task`<`IEnumerable`<`TReturn`>>> metaAction) | | `Task` | [`DecrementPersistentMeta`](#decrementpersistentmeta)(`string` metaKey, `int` decrementAmount, `int` clientId, `CancellationToken` token)
decrements meta value and persists to the database if the meta value does not already exist it will be set to the decrement amount the assumption is made that the existing value is Int32 | | `Task`<`EFMeta`> | [`GetPersistentMeta`](#getpersistentmeta-12)(`...`)
retrieves meta entry | | `Task`<`EFMeta`> | [`GetPersistentMetaByLookup`](#getpersistentmetabylookup)(`string` metaKey, `string` lookupKey, `int` clientId, `CancellationToken` token)
retrieves meta entry by with associated lookup value as string | | `Task`<`T`> | [`GetPersistentMetaValue`](#getpersistentmetavalue-12)(`...`) | -| `Task`<`IEnumerable`<[`IClientMeta`](./sharedlibrarycoreinterfaces-IClientMeta)>> | [`GetRuntimeMeta`](#getruntimemeta-12)(`...`)
retrieves all the runtime meta information for given client idea | +| `Task`<`IEnumerable`<[`IClientMeta`](./IClientMeta.md)>> | [`GetRuntimeMeta`](#getruntimemeta-12)(`...`)
retrieves all the runtime meta information for given client idea | | `Task` | [`IncrementPersistentMeta`](#incrementpersistentmeta)(`string` metaKey, `int` incrementAmount, `int` clientId, `CancellationToken` token)
increments meta value and persists to the database if the meta value does not already exist it will be set to the increment amount the assumption is made that the existing value is Int32 | | `Task` | [`RemovePersistentMeta`](#removepersistentmeta-12)(`...`)
removes meta key with given value | | `Task` | [`SetPersistentMeta`](#setpersistentmeta-12)(`...`)
adds or updates meta key and value to the database as simple string | @@ -261,7 +261,7 @@ where TReturn : IClientMeta ##### Arguments | Type | Name | Description | | --- | --- | --- | -| [`MetaType`](./sharedlibrarycoreinterfaces-MetaType) | metaKey | | +| [`MetaType`](./MetaType.md) | metaKey | | | `Func`<`T`, `CancellationToken`, `Task`<`IEnumerable`<`TReturn`>>> | metaAction | | #### GetRuntimeMeta [1/2] @@ -271,7 +271,7 @@ public Task> GetRuntimeMeta(ClientPaginationRequest req ##### Arguments | Type | Name | Description | | --- | --- | --- | -| [`ClientPaginationRequest`](./sharedlibrarycorequeryhelper-ClientPaginationRequest) | request | request information | +| [`ClientPaginationRequest`](../queryhelper/ClientPaginationRequest.md) | request | request information | | `CancellationToken` | token | | ##### Summary @@ -288,8 +288,8 @@ where T : IClientMeta ##### Arguments | Type | Name | Description | | --- | --- | --- | -| [`ClientPaginationRequest`](./sharedlibrarycorequeryhelper-ClientPaginationRequest) | request | | -| [`MetaType`](./sharedlibrarycoreinterfaces-MetaType) | metaType | | +| [`ClientPaginationRequest`](../queryhelper/ClientPaginationRequest.md) | request | | +| [`MetaType`](./MetaType.md) | metaType | | | `CancellationToken` | token | | *Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfaces-IMiddlewareActionHandler.md b/CodeDocumentation/SharedLibraryCore/interfaces/IMiddlewareActionHandler.md similarity index 86% rename from CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfaces-IMiddlewareActionHandler.md rename to CodeDocumentation/SharedLibraryCore/interfaces/IMiddlewareActionHandler.md index be20aec..d9d8519 100644 --- a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfaces-IMiddlewareActionHandler.md +++ b/CodeDocumentation/SharedLibraryCore/interfaces/IMiddlewareActionHandler.md @@ -20,7 +20,7 @@ used to handle middleware actions registered from arbitrary assemblies | Returns | Name | | --- | --- | | `Task`<`T`> | [`Execute`](#execute)(`T` value, `string` name) | -| `void` | [`Register`](#register)(`T` actionType, [`IMiddlewareAction`](./sharedlibrarycoreinterfaces-IMiddlewareActionT)<`T`> action, `string` name) | +| `void` | [`Register`](#register)(`T` actionType, [`IMiddlewareAction`](./IMiddlewareActionT.md)<`T`> action, `string` name) | ## Details ### Summary @@ -36,7 +36,7 @@ where T : | Type | Name | Description | | --- | --- | --- | | `T` | actionType | | -| [`IMiddlewareAction`](./sharedlibrarycoreinterfaces-IMiddlewareActionT)<`T`> | action | | +| [`IMiddlewareAction`](./IMiddlewareActionT.md)<`T`> | action | | | `string` | name | | #### Execute diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfaces-IMiddlewareActionT.md b/CodeDocumentation/SharedLibraryCore/interfaces/IMiddlewareActionT.md similarity index 100% rename from CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfaces-IMiddlewareActionT.md rename to CodeDocumentation/SharedLibraryCore/interfaces/IMiddlewareActionT.md diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfaces-IModelConfiguration.md b/CodeDocumentation/SharedLibraryCore/interfaces/IModelConfiguration.md similarity index 100% rename from CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfaces-IModelConfiguration.md rename to CodeDocumentation/SharedLibraryCore/interfaces/IModelConfiguration.md diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfaces-IModularAssembly.md b/CodeDocumentation/SharedLibraryCore/interfaces/IModularAssembly.md similarity index 100% rename from CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfaces-IModularAssembly.md rename to CodeDocumentation/SharedLibraryCore/interfaces/IModularAssembly.md diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfaces-IPageList.md b/CodeDocumentation/SharedLibraryCore/interfaces/IPageList.md similarity index 100% rename from CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfaces-IPageList.md rename to CodeDocumentation/SharedLibraryCore/interfaces/IPageList.md diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfaces-IParserPatternMatcher.md b/CodeDocumentation/SharedLibraryCore/interfaces/IParserPatternMatcher.md similarity index 89% rename from CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfaces-IParserPatternMatcher.md rename to CodeDocumentation/SharedLibraryCore/interfaces/IParserPatternMatcher.md index eafb413..f52bedc 100644 --- a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfaces-IParserPatternMatcher.md +++ b/CodeDocumentation/SharedLibraryCore/interfaces/IParserPatternMatcher.md @@ -20,7 +20,7 @@ defines the capabilities of a parser pattern | Returns | Name | | --- | --- | | `void` | [`Compile`](#compile)(`string` pattern)
compiles the pattern to be used for matching | -| [`IMatchResult`](./sharedlibrarycoreinterfaces-IMatchResult) | [`Match`](#match)(`string` input)
converts input string into pattern groups | +| [`IMatchResult`](./IMatchResult.md) | [`Match`](#match)(`string` input)
converts input string into pattern groups | ## Details ### Summary diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfaces-IParserRegexFactory.md b/CodeDocumentation/SharedLibraryCore/interfaces/IParserRegexFactory.md similarity index 85% rename from CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfaces-IParserRegexFactory.md rename to CodeDocumentation/SharedLibraryCore/interfaces/IParserRegexFactory.md index 4a9a199..e35972a 100644 --- a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfaces-IParserRegexFactory.md +++ b/CodeDocumentation/SharedLibraryCore/interfaces/IParserRegexFactory.md @@ -19,7 +19,7 @@ defines the capabilities of the parser regex factory #### Public methods | Returns | Name | | --- | --- | -| [`ParserRegex`](./sharedlibrarycoreinterfaces-ParserRegex) | [`CreateParserRegex`](#createparserregex)()
creates a new ParserRegex instance | +| [`ParserRegex`](./ParserRegex.md) | [`CreateParserRegex`](#createparserregex)()
creates a new ParserRegex instance | ## Details ### Summary diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfaces-IPlugin.md b/CodeDocumentation/SharedLibraryCore/interfaces/IPlugin.md similarity index 72% rename from CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfaces-IPlugin.md rename to CodeDocumentation/SharedLibraryCore/interfaces/IPlugin.md index d9e7635..33301e3 100644 --- a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfaces-IPlugin.md +++ b/CodeDocumentation/SharedLibraryCore/interfaces/IPlugin.md @@ -25,9 +25,9 @@ #### Public methods | Returns | Name | | --- | --- | -| `Task` | [`OnEventAsync`](#oneventasync)([`GameEvent`](./sharedlibrarycore-GameEvent) gameEvent, [`Server`](./sharedlibrarycore-Server) server) | -| `Task` | [`OnLoadAsync`](#onloadasync)([`IManager`](./sharedlibrarycoreinterfaces-IManager) manager) | -| `Task` | [`OnTickAsync`](#ontickasync)([`Server`](./sharedlibrarycore-Server) S) | +| `Task` | [`OnEventAsync`](#oneventasync)([`GameEvent`](../GameEvent.md) gameEvent, [`Server`](../Server.md) server) | +| `Task` | [`OnLoadAsync`](#onloadasync)([`IManager`](./IManager.md) manager) | +| `Task` | [`OnTickAsync`](#ontickasync)([`Server`](../Server.md) S) | | `Task` | [`OnUnloadAsync`](#onunloadasync)() | ## Details @@ -39,7 +39,7 @@ public Task OnLoadAsync(IManager manager) ##### Arguments | Type | Name | Description | | --- | --- | --- | -| [`IManager`](./sharedlibrarycoreinterfaces-IManager) | manager | | +| [`IManager`](./IManager.md) | manager | | #### OnUnloadAsync ```csharp @@ -53,8 +53,8 @@ public Task OnEventAsync(GameEvent gameEvent, Server server) ##### Arguments | Type | Name | Description | | --- | --- | --- | -| [`GameEvent`](./sharedlibrarycore-GameEvent) | gameEvent | | -| [`Server`](./sharedlibrarycore-Server) | server | | +| [`GameEvent`](../GameEvent.md) | gameEvent | | +| [`Server`](../Server.md) | server | | #### OnTickAsync ```csharp @@ -63,7 +63,7 @@ public Task OnTickAsync(Server S) ##### Arguments | Type | Name | Description | | --- | --- | --- | -| [`Server`](./sharedlibrarycore-Server) | S | | +| [`Server`](../Server.md) | S | | ### Properties #### Name diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfaces-IPluginImporter.md b/CodeDocumentation/SharedLibraryCore/interfaces/IPluginImporter.md similarity index 100% rename from CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfaces-IPluginImporter.md rename to CodeDocumentation/SharedLibraryCore/interfaces/IPluginImporter.md diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfaces-IPluginV2.md b/CodeDocumentation/SharedLibraryCore/interfaces/IPluginV2.md similarity index 88% rename from CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfaces-IPluginV2.md rename to CodeDocumentation/SharedLibraryCore/interfaces/IPluginV2.md index d5068f2..5bf1ab8 100644 --- a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfaces-IPluginV2.md +++ b/CodeDocumentation/SharedLibraryCore/interfaces/IPluginV2.md @@ -25,10 +25,11 @@ SharedLibraryCore.Interfaces.IModularAssembly --> SharedLibraryCore.Interfaces.I ### Inheritance - [ `IModularAssembly` -](./sharedlibrarycoreinterfaces-IModularAssembly) +](./IModularAssembly.md) ### Methods #### RegisterDependencies +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Interfaces/IPluginV2.cs#L9) ```csharp public static void RegisterDependencies(IServiceCollection serviceProvider) ``` diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfaces-IRConConnection.md b/CodeDocumentation/SharedLibraryCore/interfaces/IRConConnection.md similarity index 89% rename from CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfaces-IRConConnection.md rename to CodeDocumentation/SharedLibraryCore/interfaces/IRConConnection.md index 3af0bf2..778015b 100644 --- a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfaces-IRConConnection.md +++ b/CodeDocumentation/SharedLibraryCore/interfaces/IRConConnection.md @@ -20,7 +20,7 @@ defines the capabilities of an RCon connection | Returns | Name | | --- | --- | | `Task`<`string``[]`> | [`SendQueryAsync`](#sendqueryasync)(`QueryType` type, `string` parameters, `CancellationToken` token) | -| `void` | [`SetConfiguration`](#setconfiguration)([`IRConParser`](./sharedlibrarycoreinterfaces-IRConParser) config)
sets the rcon parser | +| `void` | [`SetConfiguration`](#setconfiguration)([`IRConParser`](./IRConParser.md) config)
sets the rcon parser | ## Details ### Summary @@ -45,7 +45,7 @@ public void SetConfiguration(IRConParser config) ##### Arguments | Type | Name | Description | | --- | --- | --- | -| [`IRConParser`](./sharedlibrarycoreinterfaces-IRConParser) | config | parser | +| [`IRConParser`](./IRConParser.md) | config | parser | ##### Summary sets the rcon parser diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfaces-IRConConnectionFactory.md b/CodeDocumentation/SharedLibraryCore/interfaces/IRConConnectionFactory.md similarity index 84% rename from CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfaces-IRConConnectionFactory.md rename to CodeDocumentation/SharedLibraryCore/interfaces/IRConConnectionFactory.md index 492d910..56d6269 100644 --- a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfaces-IRConConnectionFactory.md +++ b/CodeDocumentation/SharedLibraryCore/interfaces/IRConConnectionFactory.md @@ -19,7 +19,7 @@ defines the capabilities of an RCon connection factory #### Public methods | Returns | Name | | --- | --- | -| [`IRConConnection`](./sharedlibrarycoreinterfaces-IRConConnection) | [`CreateConnection`](#createconnection)(`IPEndPoint` ipEndpoint, `string` password, `string` rconEngine)
creates an rcon connection instance | +| [`IRConConnection`](./IRConConnection.md) | [`CreateConnection`](#createconnection)(`IPEndPoint` ipEndpoint, `string` password, `string` rconEngine)
creates an rcon connection instance | ## Details ### Summary diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfaces-IRConParser.md b/CodeDocumentation/SharedLibraryCore/interfaces/IRConParser.md similarity index 78% rename from CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfaces-IRConParser.md rename to CodeDocumentation/SharedLibraryCore/interfaces/IRConParser.md index b74e8bc..a4be919 100644 --- a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfaces-IRConParser.md +++ b/CodeDocumentation/SharedLibraryCore/interfaces/IRConParser.md @@ -17,7 +17,7 @@ | Type | Name | Methods | | --- | --- | --- | | `bool` | [`CanGenerateLogPath`](#cangeneratelogpath)
indicates if the game supports generating a log path from DVAR retrieval
of fs_game, fs_basepath, g_log | `get` | -| [`IRConParserConfiguration`](./sharedlibrarycoreinterfaces-IRConParserConfiguration) | [`Configuration`](#configuration)
stores the RCon configuration | `get, set` | +| [`IRConParserConfiguration`](./IRConParserConfiguration.md) | [`Configuration`](#configuration)
stores the RCon configuration | `get, set` | | `Game` | [`GameName`](#gamename)
specifies the game name (usually the internal studio iteration ie: IW4, T5 etc...) | `get` | | `bool` | [`IsOneLog`](#isonelog)
indicates that the game does not log to the mods folder (when mod is loaded),
but rather always to the fs_basegame directory | `get` | | `string` | [`Name`](#name)
specifies the name of the parser | `get` | @@ -28,13 +28,13 @@ #### Public methods | Returns | Name | | --- | --- | -| `Task`<`string``[]`> | [`ExecuteCommandAsync`](#executecommandasync)([`IRConConnection`](./sharedlibrarycoreinterfaces-IRConConnection) connection, `string` command, `CancellationToken` token)
executes a console command on the server | +| `Task`<`string``[]`> | [`ExecuteCommandAsync`](#executecommandasync)([`IRConConnection`](./IRConConnection.md) connection, `string` command, `CancellationToken` token)
executes a console command on the server | | `T` | [`GetDefaultDvarValue`](#getdefaultdvarvalue)(`string` dvarName) | -| `Task`<[`Dvar`](./sharedlibrarycore-DvarT)<`T`>> | [`GetDvarAsync`](#getdvarasync)([`IRConConnection`](./sharedlibrarycoreinterfaces-IRConConnection) connection, `string` dvarName, `T` fallbackValue, `CancellationToken` token) | +| `Task`<[`Dvar`](../DvarT.md)<`T`>> | [`GetDvarAsync`](#getdvarasync)([`IRConConnection`](./IRConConnection.md) connection, `string` dvarName, `T` fallbackValue, `CancellationToken` token) | | `string` | [`GetOverrideDvarName`](#getoverridedvarname)(`string` dvarName)
retrieves the value of given dvar key if it exists in the override dict
otherwise returns original | -| `Task`<[`IStatusResponse`](./sharedlibrarycoreinterfaces-IStatusResponse)> | [`GetStatusAsync`](#getstatusasync)([`IRConConnection`](./sharedlibrarycoreinterfaces-IRConConnection) connection, `CancellationToken` token)
get the list of connected clients from status response | +| `Task`<[`IStatusResponse`](./IStatusResponse.md)> | [`GetStatusAsync`](#getstatusasync)([`IRConConnection`](./IRConConnection.md) connection, `CancellationToken` token)
get the list of connected clients from status response | | `Nullable`<`TimeSpan`> | [`OverrideTimeoutForCommand`](#overridetimeoutforcommand)(`string` command)
determines the amount of time to wait for the command to respond | -| `Task`<`bool`> | [`SetDvarAsync`](#setdvarasync)([`IRConConnection`](./sharedlibrarycoreinterfaces-IRConConnection) connection, `string` dvarName, `object` dvarValue, `CancellationToken` token)
set value of DVAR by name | +| `Task`<`bool`> | [`SetDvarAsync`](#setdvarasync)([`IRConConnection`](./IRConConnection.md) connection, `string` dvarName, `object` dvarValue, `CancellationToken` token)
set value of DVAR by name | ## Details ### Methods @@ -46,7 +46,7 @@ where T : ##### Arguments | Type | Name | Description | | --- | --- | --- | -| [`IRConConnection`](./sharedlibrarycoreinterfaces-IRConConnection) | connection | | +| [`IRConConnection`](./IRConConnection.md) | connection | | | `string` | dvarName | | | `T` | fallbackValue | | | `CancellationToken` | token | | @@ -58,7 +58,7 @@ public Task SetDvarAsync(IRConConnection connection, string dvarName, obje ##### Arguments | Type | Name | Description | | --- | --- | --- | -| [`IRConConnection`](./sharedlibrarycoreinterfaces-IRConConnection) | connection | RCon connection to use | +| [`IRConConnection`](./IRConConnection.md) | connection | RCon connection to use | | `string` | dvarName | name of DVAR to set | | `object` | dvarValue | value to set DVAR to | | `CancellationToken` | token | | @@ -76,7 +76,7 @@ public Task ExecuteCommandAsync(IRConConnection connection, string comma ##### Arguments | Type | Name | Description | | --- | --- | --- | -| [`IRConConnection`](./sharedlibrarycoreinterfaces-IRConConnection) | connection | RCon connection to use | +| [`IRConConnection`](./IRConConnection.md) | connection | RCon connection to use | | `string` | command | console command to execute | | `CancellationToken` | token | | @@ -93,14 +93,14 @@ public Task GetStatusAsync(IRConConnection connection, Cancella ##### Arguments | Type | Name | Description | | --- | --- | --- | -| [`IRConConnection`](./sharedlibrarycoreinterfaces-IRConConnection) | connection | RCon connection to use | +| [`IRConConnection`](./IRConConnection.md) | connection | RCon connection to use | | `CancellationToken` | token | | ##### Summary get the list of connected clients from status response ##### Returns -[IStatusResponse](./sharedlibrarycoreinterfaces-IStatusResponse) +[IStatusResponse](./IStatusResponse.md) #### GetOverrideDvarName ```csharp diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfaces-IRConParserConfiguration.md b/CodeDocumentation/SharedLibraryCore/interfaces/IRConParserConfiguration.md similarity index 80% rename from CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfaces-IRConParserConfiguration.md rename to CodeDocumentation/SharedLibraryCore/interfaces/IRConParserConfiguration.md index 2048d74..b107ebb 100644 --- a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfaces-IRConParserConfiguration.md +++ b/CodeDocumentation/SharedLibraryCore/interfaces/IRConParserConfiguration.md @@ -16,18 +16,18 @@ #### Public properties | Type | Name | Methods | | --- | --- | --- | -| [`ColorCodeMapping`](./sharedlibrarycoreformatting-ColorCodeMapping) | [`ColorCodeMapping`](#colorcodemapping) | `get` | -| [`CommandPrefix`](./sharedlibrarycorercon-CommandPrefix) | [`CommandPrefixes`](#commandprefixes)
stores the command format for console commands | `get` | +| [`ColorCodeMapping`](../formatting/ColorCodeMapping.md) | [`ColorCodeMapping`](#colorcodemapping) | `get` | +| [`CommandPrefix`](../rcon/CommandPrefix.md) | [`CommandPrefixes`](#commandprefixes)
stores the command format for console commands | `get` | | `IDictionary`<`string`, `string`> | [`DefaultDvarValues`](#defaultdvarvalues)
specifies the default dvar values for games that don't support certain dvars | `get` | | `string` | [`DefaultInstallationDirectoryHint`](#defaultinstallationdirectoryhint)
Default Indicator of where the game is installed (ex file path or registry entry) | `get` | | `Nullable`<`int`> | [`DefaultRConPort`](#defaultrconport)
Default port the game listens to RCon requests on | `get` | -| [`ParserRegex`](./sharedlibrarycoreinterfaces-ParserRegex) | [`Dvar`](#dvar)
stores the regex info for parsing get DVAR responses | `get` | +| [`ParserRegex`](./ParserRegex.md) | [`Dvar`](#dvar)
stores the regex info for parsing get DVAR responses | `get` | | `short` | [`FloodProtectInterval`](#floodprotectinterval) | `get` | -| [`ParserRegex`](./sharedlibrarycoreinterfaces-ParserRegex) | [`GametypeStatus`](#gametypestatus)
stores regex info for parsing the gametype line from rcon status response | `get` | +| [`ParserRegex`](./ParserRegex.md) | [`GametypeStatus`](#gametypestatus)
stores regex info for parsing the gametype line from rcon status response | `get` | | `NumberStyles` | [`GuidNumberStyle`](#guidnumberstyle)
indicates the format expected for parsed guids | `get` | -| [`ParserRegex`](./sharedlibrarycoreinterfaces-ParserRegex) | [`HostnameStatus`](#hostnamestatus)
stores regex info for parsing hostname line from rcon status response | `get` | -| [`ParserRegex`](./sharedlibrarycoreinterfaces-ParserRegex) | [`MapStatus`](#mapstatus)
stores regex info for parsing the map line from rcon status response | `get` | -| [`ParserRegex`](./sharedlibrarycoreinterfaces-ParserRegex) | [`MaxPlayersStatus`](#maxplayersstatus)
stores regex info for parsing max players line from rcon status response | `get` | +| [`ParserRegex`](./ParserRegex.md) | [`HostnameStatus`](#hostnamestatus)
stores regex info for parsing hostname line from rcon status response | `get` | +| [`ParserRegex`](./ParserRegex.md) | [`MapStatus`](#mapstatus)
stores regex info for parsing the map line from rcon status response | `get` | +| [`ParserRegex`](./ParserRegex.md) | [`MaxPlayersStatus`](#maxplayersstatus)
stores regex info for parsing max players line from rcon status response | `get` | | `string` | [`NoticeLineSeparator`](#noticelineseparator)
specifies the characters used to split a line | `get` | | `int` | [`NoticeMaxCharactersPerLine`](#noticemaxcharactersperline)
specifies how many characters can be displayed per notice line | `get` | | `int` | [`NoticeMaximumLines`](#noticemaximumlines)
specifies how many lines can be used for ingame notice | `get, set` | @@ -35,8 +35,8 @@ | `IDictionary`<`string`, `string`> | [`OverrideDvarNameMapping`](#overridedvarnamemapping)
specifies simple mappings for dvar names in scenarios where the needed
information is not stored in a traditional dvar name | `get` | | `string` | [`ServerNotRunningResponse`](#servernotrunningresponse)
Specifies the expected response message from rcon when the server is not running | `get` | | `bool` | [`ShouldRemoveDiacritics`](#shouldremovediacritics)
indicates if diacritics (accented characters) should be normalized | `get` | -| [`ParserRegex`](./sharedlibrarycoreinterfaces-ParserRegex) | [`Status`](#status)
stores the regex info for parsing get status response | `get` | -| [`ParserRegex`](./sharedlibrarycoreinterfaces-ParserRegex) | [`StatusHeader`](#statusheader)
stores the regex info for parsing the header of a status response | `get` | +| [`ParserRegex`](./ParserRegex.md) | [`Status`](#status)
stores the regex info for parsing get status response | `get` | +| [`ParserRegex`](./ParserRegex.md) | [`StatusHeader`](#statusheader)
stores the regex info for parsing the header of a status response | `get` | | `bool` | [`WaitForResponse`](#waitforresponse)
indicates if the application should wait for response from server
when executing a command | `get` | ## Details diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfaces-IRegisterEvent.md b/CodeDocumentation/SharedLibraryCore/interfaces/IRegisterEvent.md similarity index 76% rename from CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfaces-IRegisterEvent.md rename to CodeDocumentation/SharedLibraryCore/interfaces/IRegisterEvent.md index 6155adc..47d6923 100644 --- a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfaces-IRegisterEvent.md +++ b/CodeDocumentation/SharedLibraryCore/interfaces/IRegisterEvent.md @@ -19,7 +19,7 @@ interface defining the capabilities of a custom event registration #### Public properties | Type | Name | Methods | | --- | --- | --- | -| `IEnumerable`<(`string` Item1, `string` Item2, `Func`<`string`, [`IEventParserConfiguration`](./sharedlibrarycoreinterfaces-IEventParserConfiguration), [`GameEvent`](./sharedlibrarycore-GameEvent), [`GameEvent`](./sharedlibrarycore-GameEvent)> Item3)> | [`Events`](#events)
collection of custom event registrations (Subtype, trigger value, event generator) | `get` | +| `IEnumerable`<(`string` Item1, `string` Item2, `Func`<`string`, [`IEventParserConfiguration`](./IEventParserConfiguration.md), [`GameEvent`](../GameEvent.md), [`GameEvent`](../GameEvent.md)> Item3)> | [`Events`](#events)
collection of custom event registrations (Subtype, trigger value, event generator) | `get` | ## Details ### Summary diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfaces-IRemoteAssemblyHandler.md b/CodeDocumentation/SharedLibraryCore/interfaces/IRemoteAssemblyHandler.md similarity index 100% rename from CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfaces-IRemoteAssemblyHandler.md rename to CodeDocumentation/SharedLibraryCore/interfaces/IRemoteAssemblyHandler.md diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfaces-IRemoteCommandService.md b/CodeDocumentation/SharedLibraryCore/interfaces/IRemoteCommandService.md similarity index 68% rename from CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfaces-IRemoteCommandService.md rename to CodeDocumentation/SharedLibraryCore/interfaces/IRemoteCommandService.md index 89f17ae..d4e9577 100644 --- a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfaces-IRemoteCommandService.md +++ b/CodeDocumentation/SharedLibraryCore/interfaces/IRemoteCommandService.md @@ -16,8 +16,8 @@ #### Public methods | Returns | Name | | --- | --- | -| `Task`<`IEnumerable`<[`CommandResponseInfo`](./sharedlibrarycoredtos-CommandResponseInfo)>> | [`Execute`](#execute)(`int` originId, `Nullable`<`int`> targetId, `string` command, `IEnumerable`<`string`> arguments, [`Server`](./sharedlibrarycore-Server) server) | -| `Task`<(`bool` Item1, `IEnumerable`<[`CommandResponseInfo`](./sharedlibrarycoredtos-CommandResponseInfo)> Item2)> | [`ExecuteWithResult`](#executewithresult)(`int` originId, `Nullable`<`int`> targetId, `string` command, `IEnumerable`<`string`> arguments, [`Server`](./sharedlibrarycore-Server) server) | +| `Task`<`IEnumerable`<[`CommandResponseInfo`](../dtos/CommandResponseInfo.md)>> | [`Execute`](#execute)(`int` originId, `Nullable`<`int`> targetId, `string` command, `IEnumerable`<`string`> arguments, [`Server`](../Server.md) server) | +| `Task`<(`bool` Item1, `IEnumerable`<[`CommandResponseInfo`](../dtos/CommandResponseInfo.md)> Item2)> | [`ExecuteWithResult`](#executewithresult)(`int` originId, `Nullable`<`int`> targetId, `string` command, `IEnumerable`<`string`> arguments, [`Server`](../Server.md) server) | ## Details ### Methods @@ -32,7 +32,7 @@ public Task> Execute(int originId, Nullable Item2)> ExecuteWithRes | `Nullable`<`int`> | targetId | | | `string` | command | | | `IEnumerable`<`string`> | arguments | | -| [`Server`](./sharedlibrarycore-Server) | server | | +| [`Server`](../Server.md) | server | | *Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfaces-IResourceQueryHelperTT.md b/CodeDocumentation/SharedLibraryCore/interfaces/IResourceQueryHelperTT.md similarity index 85% rename from CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfaces-IResourceQueryHelperTT.md rename to CodeDocumentation/SharedLibraryCore/interfaces/IResourceQueryHelperTT.md index bc33bce..728a980 100644 --- a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfaces-IResourceQueryHelperTT.md +++ b/CodeDocumentation/SharedLibraryCore/interfaces/IResourceQueryHelperTT.md @@ -20,7 +20,7 @@ defines the capabilities of a resource queryier #### Public methods | Returns | Name | | --- | --- | -| `Task`<[`ResourceQueryHelperResult`](./sharedlibrarycorehelpers-ResourceQueryHelperResultT)<`ResultType`>> | [`QueryResource`](#queryresource)(`QueryType` query) | +| `Task`<[`ResourceQueryHelperResult`](../helpers/ResourceQueryHelperResultT.md)<`ResultType`>> | [`QueryResource`](#queryresource)(`QueryType` query) | ## Details ### Summary diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfaces-IScriptCommandFactory.md b/CodeDocumentation/SharedLibraryCore/interfaces/IScriptCommandFactory.md similarity index 65% rename from CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfaces-IScriptCommandFactory.md rename to CodeDocumentation/SharedLibraryCore/interfaces/IScriptCommandFactory.md index 287116d..e81cd7e 100644 --- a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfaces-IScriptCommandFactory.md +++ b/CodeDocumentation/SharedLibraryCore/interfaces/IScriptCommandFactory.md @@ -19,7 +19,7 @@ defines capabilities of script command factory #### Public methods | Returns | Name | | --- | --- | -| [`IManagerCommand`](./sharedlibrarycoreinterfaces-IManagerCommand) | [`CreateScriptCommand`](#createscriptcommand)(`string` name, `string` alias, `string` description, `string` permission, `bool` isTargetRequired, `IEnumerable`<[`CommandArgument`](./sharedlibrarycorecommands-CommandArgument)> args, `Func`<[`GameEvent`](./sharedlibrarycore-GameEvent), `Task`> executeAction, `IEnumerable`<`Game`> supportedGames) | +| [`IManagerCommand`](./IManagerCommand.md) | [`CreateScriptCommand`](#createscriptcommand)(`string` name, `string` alias, `string` description, `string` permission, `bool` isTargetRequired, `IEnumerable`<[`CommandArgument`](../commands/CommandArgument.md)> args, `Func`<[`GameEvent`](../GameEvent.md), `Task`> executeAction, `IEnumerable`<`Game`> supportedGames) | ## Details ### Summary @@ -38,8 +38,8 @@ public IManagerCommand CreateScriptCommand(string name, string alias, string des | `string` | description | | | `string` | permission | | | `bool` | isTargetRequired | | -| `IEnumerable`<[`CommandArgument`](./sharedlibrarycorecommands-CommandArgument)> | args | | -| `Func`<[`GameEvent`](./sharedlibrarycore-GameEvent), `Task`> | executeAction | | +| `IEnumerable`<[`CommandArgument`](../commands/CommandArgument.md)> | args | | +| `Func`<[`GameEvent`](../GameEvent.md), `Task`> | executeAction | | | `IEnumerable`<`Game`> | supportedGames | | *Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfaces-IScriptPluginFactory.md b/CodeDocumentation/SharedLibraryCore/interfaces/IScriptPluginFactory.md similarity index 100% rename from CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfaces-IScriptPluginFactory.md rename to CodeDocumentation/SharedLibraryCore/interfaces/IScriptPluginFactory.md diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfaces-IScriptPluginServiceResolver.md b/CodeDocumentation/SharedLibraryCore/interfaces/IScriptPluginServiceResolver.md similarity index 100% rename from CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfaces-IScriptPluginServiceResolver.md rename to CodeDocumentation/SharedLibraryCore/interfaces/IScriptPluginServiceResolver.md diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfaces-IScriptPluginTimerHelper.md b/CodeDocumentation/SharedLibraryCore/interfaces/IScriptPluginTimerHelper.md similarity index 100% rename from CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfaces-IScriptPluginTimerHelper.md rename to CodeDocumentation/SharedLibraryCore/interfaces/IScriptPluginTimerHelper.md diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfaces-IServerDataCollector.md b/CodeDocumentation/SharedLibraryCore/interfaces/IServerDataCollector.md similarity index 100% rename from CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfaces-IServerDataCollector.md rename to CodeDocumentation/SharedLibraryCore/interfaces/IServerDataCollector.md diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfaces-IServerDataViewer.md b/CodeDocumentation/SharedLibraryCore/interfaces/IServerDataViewer.md similarity index 92% rename from CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfaces-IServerDataViewer.md rename to CodeDocumentation/SharedLibraryCore/interfaces/IServerDataViewer.md index 131a403..4f63dad 100644 --- a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfaces-IServerDataViewer.md +++ b/CodeDocumentation/SharedLibraryCore/interfaces/IServerDataViewer.md @@ -20,7 +20,7 @@ Exposes methods to get analytical data about server(s) | Returns | Name | | --- | --- | | `Task`<(`int` Item1, `int` Item2)> | [`ClientCountsAsync`](#clientcountsasync)(`Nullable`<`TimeSpan`> overPeriod, `Nullable`<`Game`> gameCode, `CancellationToken` token) | -| `Task`<`IEnumerable`<[`ClientHistoryInfo`](./sharedlibrarycoredtos-ClientHistoryInfo)>> | [`ClientHistoryAsync`](#clienthistoryasync)(`Nullable`<`TimeSpan`> overPeriod, `CancellationToken` token) | +| `Task`<`IEnumerable`<[`ClientHistoryInfo`](../dtos/ClientHistoryInfo.md)>> | [`ClientHistoryAsync`](#clienthistoryasync)(`Nullable`<`TimeSpan`> overPeriod, `CancellationToken` token) | | `Task`<(`Nullable`<`int`> Item1, `Nullable`<`DateTime`> Item2)> | [`MaxConcurrentClientsAsync`](#maxconcurrentclientsasync)(`Nullable`<`long`> serverId, `Nullable`<`Game`> gameCode, `Nullable`<`TimeSpan`> overPeriod, `CancellationToken` token) | | `Task`<`int`> | [`RankedClientsCountAsync`](#rankedclientscountasync)(`Nullable`<`long`> serverId, `CancellationToken` token) | diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfaces-IStatusResponse.md b/CodeDocumentation/SharedLibraryCore/interfaces/IStatusResponse.md similarity index 92% rename from CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfaces-IStatusResponse.md rename to CodeDocumentation/SharedLibraryCore/interfaces/IStatusResponse.md index da4477b..88a9609 100644 --- a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfaces-IStatusResponse.md +++ b/CodeDocumentation/SharedLibraryCore/interfaces/IStatusResponse.md @@ -19,7 +19,7 @@ describes the collection of data returned from a status query #### Public properties | Type | Name | Methods | | --- | --- | --- | -| [`EFClient`](./sharedlibrarycoredatabasemodels-EFClient)`[]` | [`Clients`](#clients)
active clients | `get` | +| [`EFClient`](../database/models/EFClient.md)`[]` | [`Clients`](#clients)
active clients | `get` | | `string` | [`GameType`](#gametype)
gametype/mode | `get` | | `string` | [`Hostname`](#hostname)
server name | `get` | | `string` | [`Map`](#map)
name of the map | `get` | diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfaces-ITokenAuthentication.md b/CodeDocumentation/SharedLibraryCore/interfaces/ITokenAuthentication.md similarity index 67% rename from CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfaces-ITokenAuthentication.md rename to CodeDocumentation/SharedLibraryCore/interfaces/ITokenAuthentication.md index b212494..8cdf5bc 100644 --- a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfaces-ITokenAuthentication.md +++ b/CodeDocumentation/SharedLibraryCore/interfaces/ITokenAuthentication.md @@ -16,8 +16,8 @@ #### Public methods | Returns | Name | | --- | --- | -| `bool` | [`AuthorizeToken`](#authorizetoken)([`ITokenIdentifier`](./sharedlibrarycoreinterfaces-ITokenIdentifier) authInfo)
authorizes given token | -| [`TokenState`](./sharedlibrarycorehelpers-TokenState) | [`GenerateNextToken`](#generatenexttoken)([`ITokenIdentifier`](./sharedlibrarycoreinterfaces-ITokenIdentifier) authInfo)
generates and returns a token for the given network id | +| `bool` | [`AuthorizeToken`](#authorizetoken)([`ITokenIdentifier`](./ITokenIdentifier.md) authInfo)
authorizes given token | +| [`TokenState`](../helpers/TokenState.md) | [`GenerateNextToken`](#generatenexttoken)([`ITokenIdentifier`](./ITokenIdentifier.md) authInfo)
generates and returns a token for the given network id | ## Details ### Methods @@ -28,7 +28,7 @@ public TokenState GenerateNextToken(ITokenIdentifier authInfo) ##### Arguments | Type | Name | Description | | --- | --- | --- | -| [`ITokenIdentifier`](./sharedlibrarycoreinterfaces-ITokenIdentifier) | authInfo | auth information for next token generation | +| [`ITokenIdentifier`](./ITokenIdentifier.md) | authInfo | auth information for next token generation | ##### Summary generates and returns a token for the given network id @@ -43,7 +43,7 @@ public bool AuthorizeToken(ITokenIdentifier authInfo) ##### Arguments | Type | Name | Description | | --- | --- | --- | -| [`ITokenIdentifier`](./sharedlibrarycoreinterfaces-ITokenIdentifier) | authInfo | auth information | +| [`ITokenIdentifier`](./ITokenIdentifier.md) | authInfo | auth information | ##### Summary authorizes given token diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfaces-ITokenIdentifier.md b/CodeDocumentation/SharedLibraryCore/interfaces/ITokenIdentifier.md similarity index 100% rename from CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfaces-ITokenIdentifier.md rename to CodeDocumentation/SharedLibraryCore/interfaces/ITokenIdentifier.md diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfaces-ITranslationLookup.md b/CodeDocumentation/SharedLibraryCore/interfaces/ITranslationLookup.md similarity index 100% rename from CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfaces-ITranslationLookup.md rename to CodeDocumentation/SharedLibraryCore/interfaces/ITranslationLookup.md diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfaces-InteractionType.md b/CodeDocumentation/SharedLibraryCore/interfaces/InteractionType.md similarity index 100% rename from CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfaces-InteractionType.md rename to CodeDocumentation/SharedLibraryCore/interfaces/InteractionType.md diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfaces-MetaType.md b/CodeDocumentation/SharedLibraryCore/interfaces/MetaType.md similarity index 100% rename from CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfaces-MetaType.md rename to CodeDocumentation/SharedLibraryCore/interfaces/MetaType.md diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfaces-ParserRegex.md b/CodeDocumentation/SharedLibraryCore/interfaces/ParserRegex.md similarity index 84% rename from CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfaces-ParserRegex.md rename to CodeDocumentation/SharedLibraryCore/interfaces/ParserRegex.md index dd960b7..b6406b6 100644 --- a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfaces-ParserRegex.md +++ b/CodeDocumentation/SharedLibraryCore/interfaces/ParserRegex.md @@ -17,7 +17,7 @@ | --- | --- | --- | | `Dictionary`<`GroupType`, `int`> | [`GroupMapping`](#groupmapping)
stores the mapping from group type to group index in the regular expression | `get` | | `string` | [`Pattern`](#pattern)
stores the regular expression groups that will be mapped to group types | `get, set` | -| [`IParserPatternMatcher`](./sharedlibrarycoreinterfaces-IParserPatternMatcher) | [`PatternMatcher`](#patternmatcher) | `get` | +| [`IParserPatternMatcher`](./IParserPatternMatcher.md) | [`PatternMatcher`](#patternmatcher) | `get` | ### Methods #### Public methods @@ -32,16 +32,18 @@ ### Constructors #### ParserRegex +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Helpers/ParserRegex.cs#L48) ```csharp public ParserRegex(IParserPatternMatcher pattern) ``` ##### Arguments | Type | Name | Description | | --- | --- | --- | -| [`IParserPatternMatcher`](./sharedlibrarycoreinterfaces-IParserPatternMatcher) | pattern | | +| [`IParserPatternMatcher`](./IParserPatternMatcher.md) | pattern | | ### Methods #### AddMapping +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Helpers/ParserRegex.cs#L82) ```csharp public void AddMapping(object mapKey, object mapValue) ``` diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfacesevents-IGameEventSubscriptions.md b/CodeDocumentation/SharedLibraryCore/interfaces/events/IGameEventSubscriptions.md similarity index 78% rename from CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfacesevents-IGameEventSubscriptions.md rename to CodeDocumentation/SharedLibraryCore/interfaces/events/IGameEventSubscriptions.md index e15fe94..c10d431 100644 --- a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfacesevents-IGameEventSubscriptions.md +++ b/CodeDocumentation/SharedLibraryCore/interfaces/events/IGameEventSubscriptions.md @@ -17,21 +17,23 @@ | Returns | Name | | --- | --- | | `void` | [`ClearEventInvocations`](#cleareventinvocations)() | -| `Task` | [`InvokeEventAsync`](#invokeeventasync)([`CoreEvent`](./sharedlibrarycoreevents-CoreEvent) coreEvent, `CancellationToken` token) | +| `Task` | [`InvokeEventAsync`](#invokeeventasync)([`CoreEvent`](../../events/CoreEvent.md) coreEvent, `CancellationToken` token) | ## Details ### Methods #### InvokeEventAsync +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Interfaces/Events/IGameEventSubscriptions.cs#L90) ```csharp public static Task InvokeEventAsync(CoreEvent coreEvent, CancellationToken token) ``` ##### Arguments | Type | Name | Description | | --- | --- | --- | -| [`CoreEvent`](./sharedlibrarycoreevents-CoreEvent) | coreEvent | | +| [`CoreEvent`](../../events/CoreEvent.md) | coreEvent | | | `CancellationToken` | token | | #### ClearEventInvocations +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Interfaces/Events/IGameEventSubscriptions.cs#L108) ```csharp public static void ClearEventInvocations() ``` @@ -42,69 +44,69 @@ public static void ClearEventInvocations() public static event Func MatchStarted ``` ##### Summary -Raised when game log prints that match has started InitGame [MatchStartEvent](./sharedlibrarycoreeventsgame-MatchStartEvent) +Raised when game log prints that match has started InitGame [MatchStartEvent](../../events/game/MatchStartEvent.md) #### MatchEnded ```csharp public static event Func MatchEnded ``` ##### Summary -Raised when game log prints that match has ended ShutdownGame: [MatchEndEvent](./sharedlibrarycoreeventsgame-MatchEndEvent) +Raised when game log prints that match has ended ShutdownGame: [MatchEndEvent](../../events/game/MatchEndEvent.md) #### ClientEnteredMatch ```csharp public static event Func ClientEnteredMatch ``` ##### Summary -Raised when game log printed that client has entered the match J;clientNetworkId;clientSlotNumber;clientName J;110000100000000;0;bot [ClientEnterMatchEvent](./sharedlibrarycoreeventsgame-ClientEnterMatchEvent) +Raised when game log printed that client has entered the match J;clientNetworkId;clientSlotNumber;clientName J;110000100000000;0;bot [ClientEnterMatchEvent](../../events/game/ClientEnterMatchEvent.md) #### ClientExitedMatch ```csharp public static event Func ClientExitedMatch ``` ##### Summary -Raised when game log prints that client has exited the match Q;clientNetworkId;clientSlotNumber;clientName Q;110000100000000;0;bot [ClientExitMatchEvent](./sharedlibrarycoreeventsgame-ClientExitMatchEvent) +Raised when game log prints that client has exited the match Q;clientNetworkId;clientSlotNumber;clientName Q;110000100000000;0;bot [ClientExitMatchEvent](../../events/game/ClientExitMatchEvent.md) #### ClientJoinedTeam ```csharp public static event Func ClientJoinedTeam ``` ##### Summary -Raised when game log prints that client has joined a team JT;clientNetworkId;clientSlotNumber;clientTeam;clientName JT;110000100000000;0;axis;bot [ClientJoinTeamEvent](./sharedlibrarycoreeventsgame-ClientJoinTeamEvent) +Raised when game log prints that client has joined a team JT;clientNetworkId;clientSlotNumber;clientTeam;clientName JT;110000100000000;0;axis;bot [ClientJoinTeamEvent](../../events/game/ClientJoinTeamEvent.md) #### ClientDamaged ```csharp public static event Func ClientDamaged ``` ##### Summary -Raised when game log prints that client has been damaged D;victimNetworkId;victimSlotNumber;victimTeam;victimName;attackerNetworkId;attackerSlotNumber;attackerTeam;attackerName;weapon;damage;meansOfDeath;hitLocation D;110000100000000;17;axis;bot_0;110000100000001;4;allies;bot_1;scar_mp;38;MOD_HEAD_SHOT;head [ClientDamageEvent](./sharedlibrarycoreeventsgame-ClientDamageEvent) +Raised when game log prints that client has been damaged D;victimNetworkId;victimSlotNumber;victimTeam;victimName;attackerNetworkId;attackerSlotNumber;attackerTeam;attackerName;weapon;damage;meansOfDeath;hitLocation D;110000100000000;17;axis;bot_0;110000100000001;4;allies;bot_1;scar_mp;38;MOD_HEAD_SHOT;head [ClientDamageEvent](../../events/game/ClientDamageEvent.md) #### ClientKilled ```csharp public static event Func ClientKilled ``` ##### Summary -Raised when game log prints that client has been killed K;victimNetworkId;victimSlotNumber;victimTeam;victimName;attackerNetworkId;attackerSlotNumber;attackerTeam;attackerName;weapon;damage;meansOfDeath;hitLocation K;110000100000000;17;axis;bot_0;110000100000001;4;allies;bot_1;scar_mp;100;MOD_HEAD_SHOT;head [ClientKillEvent](./sharedlibrarycoreeventsgame-ClientKillEvent) +Raised when game log prints that client has been killed K;victimNetworkId;victimSlotNumber;victimTeam;victimName;attackerNetworkId;attackerSlotNumber;attackerTeam;attackerName;weapon;damage;meansOfDeath;hitLocation K;110000100000000;17;axis;bot_0;110000100000001;4;allies;bot_1;scar_mp;100;MOD_HEAD_SHOT;head [ClientKillEvent](../../events/game/ClientKillEvent.md) #### ClientMessaged ```csharp public static event Func ClientMessaged ``` ##### Summary -Raised when game log prints that client entered a chat message say;clientNetworkId;clientSlotNumber;clientName;message say;110000100000000;0;bot;hello world! [ClientMessageEvent](./sharedlibrarycoreeventsgame-ClientMessageEvent) +Raised when game log prints that client entered a chat message say;clientNetworkId;clientSlotNumber;clientName;message say;110000100000000;0;bot;hello world! [ClientMessageEvent](../../events/game/ClientMessageEvent.md) #### ClientEnteredCommand ```csharp public static event Func ClientEnteredCommand ``` ##### Summary -Raised when game log prints that client entered a command (chat message prefixed with command character(s)) say;clientNetworkId;clientSlotNumber;clientName;command say;110000100000000;0;bot;!command [ClientCommandEvent](./sharedlibrarycoreeventsgame-ClientCommandEvent) +Raised when game log prints that client entered a command (chat message prefixed with command character(s)) say;clientNetworkId;clientSlotNumber;clientName;command say;110000100000000;0;bot;!command [ClientCommandEvent](../../events/game/ClientCommandEvent.md) #### ScriptEventTriggered ```csharp public static event Func ScriptEventTriggered ``` ##### Summary -Raised when game log prints user generated script event GSE;data GSE;loadBank=1 [GameScriptEvent](./sharedlibrarycoreeventsgame-GameScriptEvent) +Raised when game log prints user generated script event GSE;data GSE;loadBank=1 [GameScriptEvent](../../events/game/GameScriptEvent.md) *Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfacesevents-IGameServerEventSubscriptions.md b/CodeDocumentation/SharedLibraryCore/interfaces/events/IGameServerEventSubscriptions.md similarity index 75% rename from CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfacesevents-IGameServerEventSubscriptions.md rename to CodeDocumentation/SharedLibraryCore/interfaces/events/IGameServerEventSubscriptions.md index 4e54b56..da5701c 100644 --- a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfacesevents-IGameServerEventSubscriptions.md +++ b/CodeDocumentation/SharedLibraryCore/interfaces/events/IGameServerEventSubscriptions.md @@ -17,21 +17,23 @@ | Returns | Name | | --- | --- | | `void` | [`ClearEventInvocations`](#cleareventinvocations)() | -| `Task` | [`InvokeEventAsync`](#invokeeventasync)([`CoreEvent`](./sharedlibrarycoreevents-CoreEvent) coreEvent, `CancellationToken` token) | +| `Task` | [`InvokeEventAsync`](#invokeeventasync)([`CoreEvent`](../../events/CoreEvent.md) coreEvent, `CancellationToken` token) | ## Details ### Methods #### InvokeEventAsync +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Interfaces/Events/IGameServerEventSubscriptions.cs#L77) ```csharp public static Task InvokeEventAsync(CoreEvent coreEvent, CancellationToken token) ``` ##### Arguments | Type | Name | Description | | --- | --- | --- | -| [`CoreEvent`](./sharedlibrarycoreevents-CoreEvent) | coreEvent | | +| [`CoreEvent`](../../events/CoreEvent.md) | coreEvent | | | `CancellationToken` | token | | #### ClearEventInvocations +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Interfaces/Events/IGameServerEventSubscriptions.cs#L96) ```csharp public static void ClearEventInvocations() ``` @@ -42,35 +44,35 @@ public static void ClearEventInvocations() public static event Func MonitoringStarted ``` ##### Summary -Raised when IW4MAdmin starts monitoring a game server [MonitorStartEvent](./sharedlibrarycoreeventsserver-MonitorStartEvent) +Raised when IW4MAdmin starts monitoring a game server [MonitorStartEvent](../../events/server/MonitorStartEvent.md) #### MonitoringStopped ```csharp public static event Func MonitoringStopped ``` ##### Summary -Raised when IW4MAdmin stops monitoring a game server [MonitorStopEvent](./sharedlibrarycoreeventsserver-MonitorStopEvent) +Raised when IW4MAdmin stops monitoring a game server [MonitorStopEvent](../../events/server/MonitorStopEvent.md) #### ConnectionInterrupted ```csharp public static event Func ConnectionInterrupted ``` ##### Summary -Raised when communication was interrupted with a game server [ConnectionInterruptEvent](./sharedlibrarycoreeventsserver-ConnectionInterruptEvent) +Raised when communication was interrupted with a game server [ConnectionInterruptEvent](../../events/server/ConnectionInterruptEvent.md) #### ConnectionRestored ```csharp public static event Func ConnectionRestored ``` ##### Summary -Raised when communication was resumed with a game server [ConnectionRestoreEvent](./sharedlibrarycoreeventsserver-ConnectionRestoreEvent) +Raised when communication was resumed with a game server [ConnectionRestoreEvent](../../events/server/ConnectionRestoreEvent.md) #### ClientDataUpdated ```csharp public static event Func ClientDataUpdated ``` ##### Summary -Raised when updated client data was received from a game server [ClientDataUpdateEvent](./sharedlibrarycoreeventsserver-ClientDataUpdateEvent) +Raised when updated client data was received from a game server [ClientDataUpdateEvent](../../events/server/ClientDataUpdateEvent.md) #### ServerCommandExecuteRequested ```csharp @@ -84,34 +86,34 @@ Raised when a command is requested to be executed on a game server public static event Func ServerCommandExecuted ``` ##### Summary -Raised when a command was executed on a game server [ServerCommandExecuteEvent](./sharedlibrarycoreeventsserver-ServerCommandExecuteEvent) +Raised when a command was executed on a game server [ServerCommandExecuteEvent](../../events/server/ServerCommandExecuteEvent.md) #### ServerValueRequested ```csharp public static event Func ServerValueRequested ``` ##### Summary -Raised when a server value is requested for a game server [ServerValueRequestEvent](./sharedlibrarycoreeventsserver-ServerValueRequestEvent) +Raised when a server value is requested for a game server [ServerValueRequestEvent](../../events/server/ServerValueRequestEvent.md) #### ServerValueReceived ```csharp public static event Func ServerValueReceived ``` ##### Summary -Raised when a server value was received from a game server (success or fail) [ServerValueReceiveEvent](./sharedlibrarycoreeventsserver-ServerValueReceiveEvent) +Raised when a server value was received from a game server (success or fail) [ServerValueReceiveEvent](../../events/server/ServerValueReceiveEvent.md) #### ServerValueSetRequested ```csharp public static event Func ServerValueSetRequested ``` ##### Summary -Raised when a request to set a server value on a game server is received [ServerValueSetRequestEvent](./sharedlibrarycoreeventsserver-ServerValueSetRequestEvent) +Raised when a request to set a server value on a game server is received [ServerValueSetRequestEvent](../../events/server/ServerValueSetRequestEvent.md) #### ServerValueSetCompleted ```csharp public static event Func ServerValueSetCompleted ``` ##### Summary -Raised when a setting server value on a game server is completed (success or fail) [ServerValueSetRequestEvent](./sharedlibrarycoreeventsserver-ServerValueSetRequestEvent) +Raised when a setting server value on a game server is completed (success or fail) [ServerValueSetRequestEvent](../../events/server/ServerValueSetRequestEvent.md) *Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfacesevents-IManagementEventSubscriptions.md b/CodeDocumentation/SharedLibraryCore/interfaces/events/IManagementEventSubscriptions.md similarity index 67% rename from CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfacesevents-IManagementEventSubscriptions.md rename to CodeDocumentation/SharedLibraryCore/interfaces/events/IManagementEventSubscriptions.md index 901e532..8e3023a 100644 --- a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfacesevents-IManagementEventSubscriptions.md +++ b/CodeDocumentation/SharedLibraryCore/interfaces/events/IManagementEventSubscriptions.md @@ -17,43 +17,47 @@ | Returns | Name | | --- | --- | | `void` | [`ClearEventInvocations`](#cleareventinvocations)() | -| `Task` | [`InvokeEventAsync`](#invokeeventasync)([`CoreEvent`](./sharedlibrarycoreevents-CoreEvent) coreEvent, `CancellationToken` token) | -| `Task` | [`InvokeLoadAsync`](#invokeloadasync)([`IManager`](./sharedlibrarycoreinterfaces-IManager) manager, `CancellationToken` token) | -| `Task` | [`InvokeUnloadAsync`](#invokeunloadasync)([`IManager`](./sharedlibrarycoreinterfaces-IManager) manager, `CancellationToken` token) | +| `Task` | [`InvokeEventAsync`](#invokeeventasync)([`CoreEvent`](../../events/CoreEvent.md) coreEvent, `CancellationToken` token) | +| `Task` | [`InvokeLoadAsync`](#invokeloadasync)([`IManager`](../IManager.md) manager, `CancellationToken` token) | +| `Task` | [`InvokeUnloadAsync`](#invokeunloadasync)([`IManager`](../IManager.md) manager, `CancellationToken` token) | ## Details ### Methods #### InvokeEventAsync +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Interfaces/Events/IManagementEventSubscriptions.cs#L87) ```csharp public static Task InvokeEventAsync(CoreEvent coreEvent, CancellationToken token) ``` ##### Arguments | Type | Name | Description | | --- | --- | --- | -| [`CoreEvent`](./sharedlibrarycoreevents-CoreEvent) | coreEvent | | +| [`CoreEvent`](../../events/CoreEvent.md) | coreEvent | | | `CancellationToken` | token | | #### InvokeLoadAsync +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Interfaces/Events/IManagementEventSubscriptions.cs#L112) ```csharp public static Task InvokeLoadAsync(IManager manager, CancellationToken token) ``` ##### Arguments | Type | Name | Description | | --- | --- | --- | -| [`IManager`](./sharedlibrarycoreinterfaces-IManager) | manager | | +| [`IManager`](../IManager.md) | manager | | | `CancellationToken` | token | | #### InvokeUnloadAsync +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Interfaces/Events/IManagementEventSubscriptions.cs#L113) ```csharp public static Task InvokeUnloadAsync(IManager manager, CancellationToken token) ``` ##### Arguments | Type | Name | Description | | --- | --- | --- | -| [`IManager`](./sharedlibrarycoreinterfaces-IManager) | manager | | +| [`IManager`](../IManager.md) | manager | | | `CancellationToken` | token | | #### ClearEventInvocations +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Interfaces/Events/IManagementEventSubscriptions.cs#L116) ```csharp public static void ClearEventInvocations() ``` @@ -64,14 +68,14 @@ public static void ClearEventInvocations() public static event Func Load ``` ##### Summary -Raised when [IManager](./sharedlibrarycoreinterfaces-IManager) is loading +Raised when [IManager](../IManager.md) is loading #### Unload ```csharp public static event Func Unload ``` ##### Summary -Raised when [IManager](./sharedlibrarycoreinterfaces-IManager) is restarting +Raised when [IManager](../IManager.md) is restarting #### ClientStateInitialized ```csharp @@ -79,69 +83,69 @@ public static event Func Cl ``` ##### Summary Raised when client enters a tracked state At this point, the client is not guaranteed to be allowed to play on the server. - See ClientStateAuthorized for final state. [ClientStateInitializeEvent](./sharedlibrarycoreeventsmanagement-ClientStateInitializeEvent) + See ClientStateAuthorized for final state. [ClientStateInitializeEvent](../../events/management/ClientStateInitializeEvent.md) #### ClientStateAuthorized ```csharp public static event Func ClientStateAuthorized ``` ##### Summary -Raised when client enters an authorized state (valid data and no bans) [ClientStateAuthorizeEvent](./sharedlibrarycoreeventsmanagement-ClientStateAuthorizeEvent) +Raised when client enters an authorized state (valid data and no bans) [ClientStateAuthorizeEvent](../../events/management/ClientStateAuthorizeEvent.md) #### ClientStateDisposed ```csharp public static event Func ClientStateDisposed ``` ##### Summary -Raised when client is no longer tracked (unknown state) At this point any references to the client should be dropped [ClientStateDisposeEvent](./sharedlibrarycoreeventsmanagement-ClientStateDisposeEvent) +Raised when client is no longer tracked (unknown state) At this point any references to the client should be dropped [ClientStateDisposeEvent](../../events/management/ClientStateDisposeEvent.md) #### ClientPenaltyAdministered ```csharp public static event Func ClientPenaltyAdministered ``` ##### Summary -Raised when a client receives a penalty [ClientPenaltyEvent](./sharedlibrarycoreeventsmanagement-ClientPenaltyEvent) +Raised when a client receives a penalty [ClientPenaltyEvent](../../events/management/ClientPenaltyEvent.md) #### ClientPenaltyRevoked ```csharp public static event Func ClientPenaltyRevoked ``` ##### Summary -Raised when a client penalty is revoked (eg unflag/unban) [ClientPenaltyRevokeEvent](./sharedlibrarycoreeventsmanagement-ClientPenaltyRevokeEvent) +Raised when a client penalty is revoked (eg unflag/unban) [ClientPenaltyRevokeEvent](../../events/management/ClientPenaltyRevokeEvent.md) #### ClientCommandExecuted ```csharp public static event Func ClientCommandExecuted ``` ##### Summary -Raised when a client command is executed (after completion of the command) [ClientExecuteCommandEvent](./sharedlibrarycoreeventsmanagement-ClientExecuteCommandEvent) +Raised when a client command is executed (after completion of the command) [ClientExecuteCommandEvent](../../events/management/ClientExecuteCommandEvent.md) #### ClientPermissionChanged ```csharp public static event Func ClientPermissionChanged ``` ##### Summary -Raised when a client's permission level changes [ClientPermissionChangeEvent](./sharedlibrarycoreeventsmanagement-ClientPermissionChangeEvent) +Raised when a client's permission level changes [ClientPermissionChangeEvent](../../events/management/ClientPermissionChangeEvent.md) #### ClientLoggedIn ```csharp public static event Func ClientLoggedIn ``` ##### Summary -Raised when a client logs in to the webfront or ingame [LoginEvent](./sharedlibrarycoreeventsmanagement-LoginEvent) +Raised when a client logs in to the webfront or ingame [LoginEvent](../../events/management/LoginEvent.md) #### ClientLoggedOut ```csharp public static event Func ClientLoggedOut ``` ##### Summary -Raised when a client logs out of the webfront [LogoutEvent](./sharedlibrarycoreeventsmanagement-LogoutEvent) +Raised when a client logs out of the webfront [LogoutEvent](../../events/management/LogoutEvent.md) #### ClientPersistentIdReceived ```csharp public static event Func ClientPersistentIdReceived ``` ##### Summary -Raised when a client's persistent id (stats file marker) is received [ClientPersistentIdReceiveEvent](./sharedlibrarycoreeventsmanagement-ClientPersistentIdReceiveEvent) +Raised when a client's persistent id (stats file marker) is received [ClientPersistentIdReceiveEvent](../../events/management/ClientPersistentIdReceiveEvent.md) *Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfacesparserregex-GroupType.md b/CodeDocumentation/SharedLibraryCore/interfaces/parserregex/GroupType.md similarity index 100% rename from CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfacesparserregex-GroupType.md rename to CodeDocumentation/SharedLibraryCore/interfaces/parserregex/GroupType.md diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycorelocalization-ClientPermission.md b/CodeDocumentation/SharedLibraryCore/localization/ClientPermission.md similarity index 100% rename from CodeDocumentation/SharedLibraryCore/sharedlibrarycorelocalization-ClientPermission.md rename to CodeDocumentation/SharedLibraryCore/localization/ClientPermission.md diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycorelocalization-Layout.md b/CodeDocumentation/SharedLibraryCore/localization/Layout.md similarity index 82% rename from CodeDocumentation/SharedLibraryCore/sharedlibrarycorelocalization-Layout.md rename to CodeDocumentation/SharedLibraryCore/localization/Layout.md index cacaf29..40a089d 100644 --- a/CodeDocumentation/SharedLibraryCore/sharedlibrarycorelocalization-Layout.md +++ b/CodeDocumentation/SharedLibraryCore/localization/Layout.md @@ -16,12 +16,13 @@ | Type | Name | Methods | | --- | --- | --- | | `CultureInfo` | [`Culture`](#culture) | `get, private set` | -| [`TranslationLookup`](./sharedlibrarycorelocalization-TranslationLookup) | [`LocalizationIndex`](#localizationindex) | `get, set` | +| [`TranslationLookup`](./TranslationLookup.md) | [`LocalizationIndex`](#localizationindex) | `get, set` | | `string` | [`LocalizationName`](#localizationname) | `get, set` | ## Details ### Constructors #### Layout +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Localization/Layout.cs#L11) ```csharp public Layout(Dictionary set) ``` diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycorelocalization-TranslationLookup.md b/CodeDocumentation/SharedLibraryCore/localization/TranslationLookup.md similarity index 95% rename from CodeDocumentation/SharedLibraryCore/sharedlibrarycorelocalization-TranslationLookup.md rename to CodeDocumentation/SharedLibraryCore/localization/TranslationLookup.md index f3f051d..b1182fa 100644 --- a/CodeDocumentation/SharedLibraryCore/sharedlibrarycorelocalization-TranslationLookup.md +++ b/CodeDocumentation/SharedLibraryCore/localization/TranslationLookup.md @@ -27,7 +27,7 @@ SharedLibraryCore.Interfaces.ITranslationLookup --> SharedLibraryCore.Localizati ### Inheritance - [ `ITranslationLookup` -](./sharedlibrarycoreinterfaces-ITranslationLookup) +](../interfaces/ITranslationLookup.md) ### Constructors #### TranslationLookup diff --git a/CodeDocumentation/SharedLibraryCore/modulardoc.mconf b/CodeDocumentation/SharedLibraryCore/modulardoc.mconf new file mode 100644 index 0000000..0c400cd --- /dev/null +++ b/CodeDocumentation/SharedLibraryCore/modulardoc.mconf @@ -0,0 +1 @@ +{"PluginId":"34C7AA14-E6FE-4684-BBE3-03C00F567297","Settings":{"99B731AC-941C-42A6-BD77-AFADB3EC156B":{"assemblyPaths":"C:\\Users\\Developer\\AppData\\Local\\Development\\IW4M-Admin\\SharedLibraryCore\\bin\\Debug\\net6.0\\SharedLibraryCore.dll","processPrivate":"False","processFields":"False"},"A59A49C1-F12E-40D5-AE2B-EFEBFF76B10D":{"paths":"C:\\Users\\Developer\\AppData\\Local\\Development\\IW4M-Admin\\SharedLibraryCore\\bin\\Debug\\net6.0\\SharedLibraryCore.xml"},"B05E71DB-7CB9-4855-8B4D-9A334677FEEB":{"platform":"0","platformUser":"RaidMax","platformBranch":"release/pre","rootRepo":"IW4M-Admin","toggleLinksToSource":"False","outputTargetWiki":"False","outputStructured":"True"},"12452BF9-2863-4AB6-8742-056F124CE409":{"IgnoredNamespaces":"","IgnoredTypes":"","CheckedIgnoredNamespaces":"","CheckedIgnoredTypes":"","OutputPath":"C:\\Users\\Developer\\AppData\\Local\\Development\\IW4M-Admin.wiki\\CodeDocumentation"}}} \ No newline at end of file diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycorequeryhelper-ClientPaginationRequest.md b/CodeDocumentation/SharedLibraryCore/queryhelper/ClientPaginationRequest.md similarity index 95% rename from CodeDocumentation/SharedLibraryCore/sharedlibrarycorequeryhelper-ClientPaginationRequest.md rename to CodeDocumentation/SharedLibraryCore/queryhelper/ClientPaginationRequest.md index 141dbc5..2cbf322 100644 --- a/CodeDocumentation/SharedLibraryCore/sharedlibrarycorequeryhelper-ClientPaginationRequest.md +++ b/CodeDocumentation/SharedLibraryCore/queryhelper/ClientPaginationRequest.md @@ -25,7 +25,7 @@ SharedLibraryCore.Dtos.PaginationRequest --> SharedLibraryCore.QueryHelper.Clien ### Inheritance - [ `PaginationRequest` -](./sharedlibrarycoredtos-PaginationRequest) +](../dtos/PaginationRequest.md) ### Constructors #### ClientPaginationRequest diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycorercon-CommandPrefix.md b/CodeDocumentation/SharedLibraryCore/rcon/CommandPrefix.md similarity index 100% rename from CodeDocumentation/SharedLibraryCore/sharedlibrarycorercon-CommandPrefix.md rename to CodeDocumentation/SharedLibraryCore/rcon/CommandPrefix.md diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycorercon-StaticHelpers.md b/CodeDocumentation/SharedLibraryCore/rcon/StaticHelpers.md similarity index 88% rename from CodeDocumentation/SharedLibraryCore/sharedlibrarycorercon-StaticHelpers.md rename to CodeDocumentation/SharedLibraryCore/rcon/StaticHelpers.md index a2f8ce4..ead35bd 100644 --- a/CodeDocumentation/SharedLibraryCore/sharedlibrarycorercon-StaticHelpers.md +++ b/CodeDocumentation/SharedLibraryCore/rcon/StaticHelpers.md @@ -24,6 +24,7 @@ ### Methods #### SocketTimeout +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/RCon/StaticHelpers.cs#L54) ```csharp public static TimeSpan SocketTimeout(int retryAttempt) ``` diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycorerconstatichelpers-QueryType.md b/CodeDocumentation/SharedLibraryCore/rcon/statichelpers/QueryType.md similarity index 100% rename from CodeDocumentation/SharedLibraryCore/sharedlibrarycorerconstatichelpers-QueryType.md rename to CodeDocumentation/SharedLibraryCore/rcon/statichelpers/QueryType.md diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycorerepositories-AuditInformationRepository.md b/CodeDocumentation/SharedLibraryCore/repositories/AuditInformationRepository.md similarity index 74% rename from CodeDocumentation/SharedLibraryCore/sharedlibrarycorerepositories-AuditInformationRepository.md rename to CodeDocumentation/SharedLibraryCore/repositories/AuditInformationRepository.md index 445447f..57ab116 100644 --- a/CodeDocumentation/SharedLibraryCore/sharedlibrarycorerepositories-AuditInformationRepository.md +++ b/CodeDocumentation/SharedLibraryCore/repositories/AuditInformationRepository.md @@ -23,7 +23,7 @@ SharedLibraryCore.Interfaces.IAuditInformationRepository --> SharedLibraryCore.R #### Public methods | Returns | Name | | --- | --- | -| `Task`<`IList`<[`AuditInfo`](./sharedlibrarycoredtos-AuditInfo)>> | [`ListAuditInformation`](#listauditinformation)([`PaginationRequest`](./sharedlibrarycoredtos-PaginationRequest) paginationInfo)
retrieves a list of audit information for given pagination params | +| `Task`<`IList`<[`AuditInfo`](../dtos/AuditInfo.md)>> | [`ListAuditInformation`](#listauditinformation)([`PaginationRequest`](../dtos/PaginationRequest.md) paginationInfo)
retrieves a list of audit information for given pagination params | ## Details ### Summary @@ -32,10 +32,11 @@ implementation if IAuditInformationRepository ### Inheritance - [ `IAuditInformationRepository` -](./sharedlibrarycoreinterfaces-IAuditInformationRepository) +](../interfaces/IAuditInformationRepository.md) ### Constructors #### AuditInformationRepository +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Repositories/AuditInformationRepository.cs#L19) ```csharp public AuditInformationRepository(IDatabaseContextFactory contextFactory) ``` @@ -52,7 +53,7 @@ public virtual async Task> ListAuditInformation(PaginationReque ##### Arguments | Type | Name | Description | | --- | --- | --- | -| [`PaginationRequest`](./sharedlibrarycoredtos-PaginationRequest) | paginationInfo | pagination info | +| [`PaginationRequest`](../dtos/PaginationRequest.md) | paginationInfo | pagination info | ##### Summary retrieves a list of audit information for given pagination params diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreserver-Game.md b/CodeDocumentation/SharedLibraryCore/server/Game.md similarity index 100% rename from CodeDocumentation/SharedLibraryCore/sharedlibrarycoreserver-Game.md rename to CodeDocumentation/SharedLibraryCore/server/Game.md diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreservices-ChangeHistoryService.md b/CodeDocumentation/SharedLibraryCore/services/ChangeHistoryService.md similarity index 71% rename from CodeDocumentation/SharedLibraryCore/sharedlibrarycoreservices-ChangeHistoryService.md rename to CodeDocumentation/SharedLibraryCore/services/ChangeHistoryService.md index c68ec3f..86f210e 100644 --- a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreservices-ChangeHistoryService.md +++ b/CodeDocumentation/SharedLibraryCore/services/ChangeHistoryService.md @@ -15,18 +15,19 @@ #### Public methods | Returns | Name | | --- | --- | -| `Task` | [`Add`](#add)([`GameEvent`](./sharedlibrarycore-GameEvent) e) | +| `Task` | [`Add`](#add)([`GameEvent`](../GameEvent.md) e) | ## Details ### Constructors #### ChangeHistoryService +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Services/ChangeHistoryService.cs#L16) ```csharp public ChangeHistoryService(ILogger logger, IDatabaseContextFactory contextFactory) ``` ##### Arguments | Type | Name | Description | | --- | --- | --- | -| `ILogger`<[`ChangeHistoryService`](sharedlibrarycoreservices-ChangeHistoryService)> | logger | | +| `ILogger`<[`ChangeHistoryService`](sharedlibrarycore/services/ChangeHistoryService.md)> | logger | | | `IDatabaseContextFactory` | contextFactory | | ### Methods @@ -37,6 +38,6 @@ public async Task Add(GameEvent e) ##### Arguments | Type | Name | Description | | --- | --- | --- | -| [`GameEvent`](./sharedlibrarycore-GameEvent) | e | | +| [`GameEvent`](../GameEvent.md) | e | | *Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreservices-ClientService.md b/CodeDocumentation/SharedLibraryCore/services/ClientService.md similarity index 64% rename from CodeDocumentation/SharedLibraryCore/sharedlibrarycoreservices-ClientService.md rename to CodeDocumentation/SharedLibraryCore/services/ClientService.md index 752c1d8..596a169 100644 --- a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreservices-ClientService.md +++ b/CodeDocumentation/SharedLibraryCore/services/ClientService.md @@ -26,45 +26,46 @@ SharedLibraryCore.Interfaces.IResourceQueryHelper_2 --> SharedLibraryCore.Servic | Returns | Name | | --- | --- | | `Task`<`bool`> | [`CanBeAutoFlagged`](#canbeautoflagged)(`int` clientId)
indicates if the given clientid can be autoflagged | -| `Task`<[`EFClient`](./sharedlibrarycoredatabasemodels-EFClient)> | [`Create`](#create)([`EFClient`](./sharedlibrarycoredatabasemodels-EFClient) entity) | -| `Task`<[`EFClient`](./sharedlibrarycoredatabasemodels-EFClient)> | [`Delete`](#delete)([`EFClient`](./sharedlibrarycoredatabasemodels-EFClient) entity) | -| `Task`<`IList`<[`EFClient`](./sharedlibrarycoredatabasemodels-EFClient)>> | [`Find`](#find)(`Func`<[`EFClient`](./sharedlibrarycoredatabasemodels-EFClient), `bool`> e) | -| `Task`<`IList`<[`PlayerInfo`](./sharedlibrarycoredtos-PlayerInfo)>> | [`FindClientsByIdentifier`](#findclientsbyidentifier)(`string` identifier) | -| `Task`<[`EFClient`](./sharedlibrarycoredatabasemodels-EFClient)> | [`Get`](#get)(`int` entityId) | -| `Task`<[`EFClient`](./sharedlibrarycoredatabasemodels-EFClient)> | [`GetClientForLogin`](#getclientforlogin)(`int` clientId) | +| `Task`<[`EFClient`](../database/models/EFClient.md)> | [`Create`](#create)([`EFClient`](../database/models/EFClient.md) entity) | +| `Task`<[`EFClient`](../database/models/EFClient.md)> | [`Delete`](#delete)([`EFClient`](../database/models/EFClient.md) entity) | +| `Task`<`IList`<[`EFClient`](../database/models/EFClient.md)>> | [`Find`](#find)(`Func`<[`EFClient`](../database/models/EFClient.md), `bool`> e) | +| `Task`<`IList`<[`PlayerInfo`](../dtos/PlayerInfo.md)>> | [`FindClientsByIdentifier`](#findclientsbyidentifier)(`string` identifier) | +| `Task`<[`EFClient`](../database/models/EFClient.md)> | [`Get`](#get)(`int` entityId) | +| `Task`<[`EFClient`](../database/models/EFClient.md)> | [`GetClientForLogin`](#getclientforlogin)(`int` clientId) | | `Task`<`string`> | [`GetClientNameById`](#getclientnamebyid)(`int` clientId) | | `Task`<`int`> | [`GetClientReportCount`](#getclientreportcount)(`int` clientId)
retrieves the number of times the given client id has been reported | | `Task`<`int`> | [`GetOwnerCount`](#getownercount)()
retrieves the number of owners
(client level is owner) | -| `Task`<`IList`<[`EFClient`](./sharedlibrarycoredatabasemodels-EFClient)>> | [`GetOwners`](#getowners)() | -| `Task`<`List`<[`EFClient`](./sharedlibrarycoredatabasemodels-EFClient)>> | [`GetPrivilegedClients`](#getprivilegedclients)(`bool` includeName) | +| `Task`<`IList`<[`EFClient`](../database/models/EFClient.md)>> | [`GetOwners`](#getowners)() | +| `Task`<`List`<[`EFClient`](../database/models/EFClient.md)>> | [`GetPrivilegedClients`](#getprivilegedclients)(`bool` includeName) | | `Task`<`int`> | [`GetRecentClientCount`](#getrecentclientcount)()
Returns the number of clients seen today | -| `Task`<`IList`<[`PlayerInfo`](./sharedlibrarycoredtos-PlayerInfo)>> | [`GetRecentClients`](#getrecentclients)([`PaginationRequest`](./sharedlibrarycoredtos-PaginationRequest) request)
gets the 10 most recently added clients to IW4MAdmin | +| `Task`<`IList`<[`PlayerInfo`](../dtos/PlayerInfo.md)>> | [`GetRecentClients`](#getrecentclients)([`PaginationRequest`](../dtos/PaginationRequest.md) request)
gets the 10 most recently added clients to IW4MAdmin | | `Task`<`int`> | [`GetTotalClientsAsync`](#gettotalclientsasync)() | -| `Task`<[`EFClient`](./sharedlibrarycoredatabasemodels-EFClient)> | [`GetUnique`](#getunique)(`long` entityAttribute, `object` altKey) | +| `Task`<[`EFClient`](../database/models/EFClient.md)> | [`GetUnique`](#getunique)(`long` entityAttribute, `object` altKey) | | `Task`<`bool`> | [`HasOwnerAsync`](#hasownerasync)(`CancellationToken` token) | -| `Task`<[`ResourceQueryHelperResult`](./sharedlibrarycorehelpers-ResourceQueryHelperResultT)<[`FindClientResult`](./sharedlibrarycoredtos-FindClientResult)>> | [`QueryResource`](#queryresource)([`FindClientRequest`](./sharedlibrarycoredtos-FindClientRequest) query)
find clients matching the given query | +| `Task`<[`ResourceQueryHelperResult`](../helpers/ResourceQueryHelperResultT.md)<[`FindClientResult`](../dtos/FindClientResult.md)>> | [`QueryResource`](#queryresource)([`FindClientRequest`](../dtos/FindClientRequest.md) query)
find clients matching the given query | | `Task` | [`UnlinkClient`](#unlinkclient)(`int` clientId)
Unlinks shared GUID account into its own separate account | -| `Task`<[`EFClient`](./sharedlibrarycoredatabasemodels-EFClient)> | [`Update`](#update)([`EFClient`](./sharedlibrarycoredatabasemodels-EFClient) temporalClient) | -| `Task` | [`UpdateAlias`](#updatealias)([`EFClient`](./sharedlibrarycoredatabasemodels-EFClient) temporalClient) | -| `Task` | [`UpdateLevel`](#updatelevel)(`Permission` newPermission, [`EFClient`](./sharedlibrarycoredatabasemodels-EFClient) temporalClient, [`EFClient`](./sharedlibrarycoredatabasemodels-EFClient) origin) | +| `Task`<[`EFClient`](../database/models/EFClient.md)> | [`Update`](#update)([`EFClient`](../database/models/EFClient.md) temporalClient) | +| `Task` | [`UpdateAlias`](#updatealias)([`EFClient`](../database/models/EFClient.md) temporalClient) | +| `Task` | [`UpdateLevel`](#updatelevel)(`Permission` newPermission, [`EFClient`](../database/models/EFClient.md) temporalClient, [`EFClient`](../database/models/EFClient.md) origin) | ## Details ### Inheritance - - [`IEntityService`](./sharedlibrarycoreinterfaces-IEntityServiceT)<[`EFClient`](./sharedlibrarycoredatabasemodels-EFClient)> - - [`IResourceQueryHelper`](./sharedlibrarycoreinterfaces-IResourceQueryHelperTT)<[`FindClientRequest`](./sharedlibrarycoredtos-FindClientRequest), [`FindClientResult`](./sharedlibrarycoredtos-FindClientResult)> + - [`IEntityService`](../interfaces/IEntityServiceT.md)<[`EFClient`](../database/models/EFClient.md)> + - [`IResourceQueryHelper`](../interfaces/IResourceQueryHelperTT.md)<[`FindClientRequest`](../dtos/FindClientRequest.md), [`FindClientResult`](../dtos/FindClientResult.md)> ### Constructors #### ClientService +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Services/ClientService.cs#L53) ```csharp public ClientService(ILogger logger, IDatabaseContextFactory databaseContextFactory, ApplicationConfiguration appConfig, IGeoLocationService geoLocationService) ``` ##### Arguments | Type | Name | Description | | --- | --- | --- | -| `ILogger`<[`ClientService`](sharedlibrarycoreservices-ClientService)> | logger | | +| `ILogger`<[`ClientService`](sharedlibrarycore/services/ClientService.md)> | logger | | | `IDatabaseContextFactory` | databaseContextFactory | | -| [`ApplicationConfiguration`](./sharedlibrarycoreconfiguration-ApplicationConfiguration) | appConfig | | -| [`IGeoLocationService`](./sharedlibrarycoreinterfaces-IGeoLocationService) | geoLocationService | | +| [`ApplicationConfiguration`](../configuration/ApplicationConfiguration.md) | appConfig | | +| [`IGeoLocationService`](../interfaces/IGeoLocationService.md) | geoLocationService | | ### Methods #### Create @@ -74,25 +75,27 @@ public virtual async Task Create(EFClient entity) ##### Arguments | Type | Name | Description | | --- | --- | --- | -| [`EFClient`](./sharedlibrarycoredatabasemodels-EFClient) | entity | | +| [`EFClient`](../database/models/EFClient.md) | entity | | #### Delete +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Services/ClientService.cs#L165) ```csharp public virtual Task Delete(EFClient entity) ``` ##### Arguments | Type | Name | Description | | --- | --- | --- | -| [`EFClient`](./sharedlibrarycoredatabasemodels-EFClient) | entity | | +| [`EFClient`](../database/models/EFClient.md) | entity | | #### Find +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Services/ClientService.cs#L170) ```csharp public virtual Task> Find(Func e) ``` ##### Arguments | Type | Name | Description | | --- | --- | --- | -| `Func`<[`EFClient`](./sharedlibrarycoredatabasemodels-EFClient), `bool`> | e | | +| `Func`<[`EFClient`](../database/models/EFClient.md), `bool`> | e | | #### Get ```csharp @@ -120,7 +123,7 @@ public virtual async Task Update(EFClient temporalClient) ##### Arguments | Type | Name | Description | | --- | --- | --- | -| [`EFClient`](./sharedlibrarycoredatabasemodels-EFClient) | temporalClient | | +| [`EFClient`](../database/models/EFClient.md) | temporalClient | | #### QueryResource ```csharp @@ -129,7 +132,7 @@ public virtual async Task> QueryReso ##### Arguments | Type | Name | Description | | --- | --- | --- | -| [`FindClientRequest`](./sharedlibrarycoredtos-FindClientRequest) | query | query filters | +| [`FindClientRequest`](../dtos/FindClientRequest.md) | query | query filters | ##### Summary find clients matching the given query @@ -145,8 +148,8 @@ public virtual async Task UpdateLevel(Permission newPermission, EFClient tempora | Type | Name | Description | | --- | --- | --- | | `Permission` | newPermission | | -| [`EFClient`](./sharedlibrarycoredatabasemodels-EFClient) | temporalClient | | -| [`EFClient`](./sharedlibrarycoredatabasemodels-EFClient) | origin | | +| [`EFClient`](../database/models/EFClient.md) | temporalClient | | +| [`EFClient`](../database/models/EFClient.md) | origin | | #### UpdateAlias ```csharp @@ -155,7 +158,7 @@ public async Task UpdateAlias(EFClient temporalClient) ##### Arguments | Type | Name | Description | | --- | --- | --- | -| [`EFClient`](./sharedlibrarycoredatabasemodels-EFClient) | temporalClient | | +| [`EFClient`](../database/models/EFClient.md) | temporalClient | | #### GetClientReportCount ```csharp @@ -276,7 +279,7 @@ public async Task> GetRecentClients(PaginationRequest request) ##### Arguments | Type | Name | Description | | --- | --- | --- | -| [`PaginationRequest`](./sharedlibrarycoredtos-PaginationRequest) | request | | +| [`PaginationRequest`](../dtos/PaginationRequest.md) | request | | ##### Summary gets the 10 most recently added clients to IW4MAdmin diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreservices-PenaltyService.md b/CodeDocumentation/SharedLibraryCore/services/PenaltyService.md similarity index 84% rename from CodeDocumentation/SharedLibraryCore/sharedlibrarycoreservices-PenaltyService.md rename to CodeDocumentation/SharedLibraryCore/services/PenaltyService.md index 913421c..0f19dab 100644 --- a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreservices-PenaltyService.md +++ b/CodeDocumentation/SharedLibraryCore/services/PenaltyService.md @@ -29,17 +29,18 @@ SharedLibraryCore.Interfaces.IEntityService_1 --> SharedLibraryCore.Services.Pen | `Task`<`EFPenalty`> | [`Get`](#get)(`int` entityID) | | `Task`<`List`<`EFPenalty`>> | [`GetActivePenaltiesAsync`](#getactivepenaltiesasync)(`int` linkId, `int` currentAliasId, `long` networkId, `Game` game, `Nullable`<`int`> ip) | | `Task`<`List`<`EFPenalty`>> | [`GetActivePenaltiesByIdentifier`](#getactivepenaltiesbyidentifier)(`Nullable`<`int`> ip, `long` networkId, `Game` game) | -| `Task`<`IList`<[`PenaltyInfo`](./sharedlibrarycoredtos-PenaltyInfo)>> | [`GetRecentPenalties`](#getrecentpenalties)(`int` count, `int` offset, `PenaltyType` showOnly, `bool` ignoreAutomated) | +| `Task`<`IList`<[`PenaltyInfo`](../dtos/PenaltyInfo.md)>> | [`GetRecentPenalties`](#getrecentpenalties)(`int` count, `int` offset, `PenaltyType` showOnly, `bool` ignoreAutomated) | | `Task`<`EFPenalty`> | [`GetUnique`](#getunique)(`long` entityProperty, `object` altKey) | | `Task` | [`RemoveActivePenalties`](#removeactivepenalties)(`int` aliasLinkId, `long` networkId, `Game` game, `Nullable`<`int`> ipAddress) | | `Task`<`EFPenalty`> | [`Update`](#update)(`EFPenalty` entity) | ## Details ### Inheritance - - [`IEntityService`](./sharedlibrarycoreinterfaces-IEntityServiceT)<`EFPenalty`> + - [`IEntityService`](../interfaces/IEntityServiceT.md)<`EFPenalty`> ### Constructors #### PenaltyService +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Services/PenaltyService.cs#L20) ```csharp public PenaltyService(IDatabaseContextFactory contextFactory, ApplicationConfiguration appConfig) ``` @@ -47,7 +48,7 @@ public PenaltyService(IDatabaseContextFactory contextFactory, ApplicationConfigu | Type | Name | Description | | --- | --- | --- | | `IDatabaseContextFactory` | contextFactory | | -| [`ApplicationConfiguration`](./sharedlibrarycoreconfiguration-ApplicationConfiguration) | appConfig | | +| [`ApplicationConfiguration`](../configuration/ApplicationConfiguration.md) | appConfig | | ### Methods #### Create @@ -71,6 +72,7 @@ public async Task CreatePenaltyIdentifier(int penaltyId, long networkId, int ipv | `int` | ipv4Address | | #### Delete +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Services/PenaltyService.cs#L77) ```csharp public virtual Task Delete(EFPenalty entity) ``` @@ -89,6 +91,7 @@ public virtual async Task> Find(Func expressio | `Func`<`EFPenalty`, `bool`> | expression | | #### Get +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Services/PenaltyService.cs#L87) ```csharp public virtual Task Get(int entityID) ``` @@ -98,6 +101,7 @@ public virtual Task Get(int entityID) | `int` | entityID | | #### GetUnique +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Services/PenaltyService.cs#L92) ```csharp public virtual Task GetUnique(long entityProperty, object altKey) ``` @@ -108,6 +112,7 @@ public virtual Task GetUnique(long entityProperty, object altKey) | `object` | altKey | | #### Update +[*Source code*](https://github.com/RaidMax/IW4M-Admin/blob/release/pre/SharedLibraryCore/Services/PenaltyService.cs#L97) ```csharp public virtual Task Update(EFPenalty entity) ```