From a0d240460bee570521b4d7106daa70fc09953603 Mon Sep 17 00:00:00 2001 From: RaidMax Date: Sat, 20 May 2023 20:51:00 -0500 Subject: [PATCH] Add SharedLibraryCore code documentation --- .../sharedlibrarycore-BaseController.md | 102 ++ .../sharedlibrarycore-ColorCode.md | 61 + .../sharedlibrarycore-Command.md | 155 +++ .../sharedlibrarycore-DvarT.md | 58 + .../sharedlibrarycore-GameEvent.md | 172 +++ .../sharedlibrarycore-Gametype.md | 39 + .../sharedlibrarycore-Map.md | 51 + .../sharedlibrarycore-Server.md | 672 +++++++++++ .../sharedlibrarycore-Utilities.md | 1073 +++++++++++++++++ .../sharedlibrarycorealerts-Alert.md | 27 + ...redlibrarycorealertsalert-AlertCategory.md | 27 + ...sharedlibrarycorealertsalert-AlertState.md | 117 ++ .../sharedlibrarycorecommands-BanCommand.md | 59 + ...aredlibrarycorecommands-CommandArgument.md | 49 + ...edlibrarycorecommands-CommandExtensions.md | 41 + ...edlibrarycorecommands-CommandProcessing.md | 39 + ...dlibrarycorecommands-ExecuteRConCommand.md | 58 + ...dlibrarycorecommands-FastRestartCommand.md | 58 + ...edlibrarycorecommands-FlagClientCommand.md | 58 + ...ibrarycorecommands-GetClientPingCommand.md | 58 + .../sharedlibrarycorecommands-KickCommand.md | 59 + ...dlibrarycorecommands-ListBanInfoCommand.md | 58 + ...brarycorecommands-ListExternalIPCommand.md | 58 + ...edlibrarycorecommands-ListRulesCommands.md | 58 + ...haredlibrarycorecommands-LoadMapCommand.md | 58 + ...redlibrarycorecommands-MapRotateCommand.md | 58 + .../sharedlibrarycorecommands-MaskCommand.md | 58 + ...dlibrarycorecommands-MemoryUsageCommand.md | 58 + ...haredlibrarycorecommands-NextMapCommand.md | 73 ++ .../sharedlibrarycorecommands-OwnerCommand.md | 58 + ...orecommands-PrivateMessageAdminsCommand.md | 52 + ...dlibrarycorecommands-PruneAdminsCommand.md | 59 + .../sharedlibrarycorecommands-QuitCommand.md | 58 + ...librarycorecommands-RequestTokenCommand.md | 58 + ...haredlibrarycorecommands-RestartCommand.md | 58 + .../sharedlibrarycorecommands-RunAsCommand.md | 52 + ...dlibrarycorecommands-SetGravatarCommand.md | 59 + ...aredlibrarycorecommands-SetLevelCommand.md | 59 + ...dlibrarycorecommands-SetPasswordCommand.md | 58 + ...haredlibrarycorecommands-TempBanCommand.md | 59 + .../sharedlibrarycorecommands-UnbanCommand.md | 58 + ...librarycorecommands-UnflagClientCommand.md | 58 + ...librarycorecommands-UnlinkClientCommand.md | 66 + ...sharedlibrarycorecommands-UptimeCommand.md | 58 + ...redlibrarycorecommands-WarnClearCommand.md | 58 + .../sharedlibrarycorecommands-WarnCommand.md | 59 + ...econfiguration-ApplicationConfiguration.md | 397 ++++++ ...ycoreconfiguration-CommandConfiguration.md | 85 ++ ...rarycoreconfiguration-CommandProperties.md | 73 ++ ...ation-CommunityInformationConfiguration.md | 57 + ...ibrarycoreconfiguration-DefaultSettings.md | 97 ++ ...reconfiguration-GameStringConfiguration.md | 45 + ...coreconfiguration-GametypeConfiguration.md | 39 + ...brarycoreconfiguration-MapConfiguration.md | 39 + ...configuration-QuickMessageConfiguration.md | 39 + ...rycoreconfiguration-ServerConfiguration.md | 153 +++ ...onfiguration-SocialAccountConfiguration.md | 51 + ...coreconfiguration-WebfrontConfiguration.md | 33 + ...igurationattributes-ConfigurationIgnore.md | 27 + ...igurationattributes-ConfigurationLinked.md | 44 + ...urationattributes-ConfigurationOptional.md | 27 + ...gurationattributes-LocalizedDisplayName.md | 44 + ...ationextensions-ConfigurationExtensions.md | 41 + ...ation-ApplicationConfigurationValidator.md | 33 + ...validation-ServerConfigurationValidator.md | 33 + ...haredlibrarycoredatabasemodels-EFClient.md | 468 +++++++ ...ycoredatabasemodelsefclient-ClientState.md | 33 + ...rarycoredatabasemodelsefclient-TeamType.md | 27 + .../sharedlibrarycoredtos-AuditInfo.md | 105 ++ .../sharedlibrarycoredtos-ChatInfo.md | 75 ++ ...aredlibrarycoredtos-ClientCountSnapshot.md | 63 + ...sharedlibrarycoredtos-ClientHistoryInfo.md | 39 + .../sharedlibrarycoredtos-ClientInfo.md | 69 ++ ...aredlibrarycoredtos-CommandResponseInfo.md | 39 + .../sharedlibrarycoredtos-EntityInfo.md | 45 + .../sharedlibrarycoredtos-ErrorResponse.md | 43 + .../sharedlibrarycoredtos-EventInfo.md | 81 ++ ...sharedlibrarycoredtos-FindClientRequest.md | 62 + .../sharedlibrarycoredtos-FindClientResult.md | 51 + .../sharedlibrarycoredtos-IW4MAdminInfo.md | 79 ++ .../sharedlibrarycoredtos-LookupValueT.md | 49 + .../sharedlibrarycoredtos-Page.md | 39 + ...sharedlibrarycoredtos-PaginationRequest.md | 77 ++ .../sharedlibrarycoredtos-PenaltyInfo.md | 172 +++ .../sharedlibrarycoredtos-PlayerInfo.md | 189 +++ .../sharedlibrarycoredtos-ServerInfo.md | 147 +++ .../sharedlibrarycoredtos-SharedInfo.md | 45 + .../sharedlibrarycoredtos-SortDirection.md | 21 + ...ycoredtosmeta-WebfrontTranslationHelper.md | 45 + ...edtosmetarequests-BaseClientMetaRequest.md | 42 + ...dtosmetarequests-ReceivedPenaltyRequest.md | 27 + ...taresponses-AdministeredPenaltyResponse.md | 27 + ...ycoredtosmetaresponses-BaseMetaResponse.md | 91 ++ ...tosmetaresponses-ClientNoteMetaResponse.md | 51 + ...metaresponses-ConnectionHistoryResponse.md | 46 + ...redtosmetaresponses-InformationResponse.md | 52 + ...rycoredtosmetaresponses-MessageResponse.md | 98 ++ ...esponses-PermissionLevelChangedResponse.md | 70 ++ ...osmetaresponses-ReceivedPenaltyResponse.md | 112 ++ ...edtosmetaresponses-UpdatedAliasResponse.md | 68 ++ .../sharedlibrarycoreevents-CoreEvent.md | 58 + ...sharedlibrarycoreevents-EventExtensions.md | 34 + .../sharedlibrarycoreevents-GameEventArgs.md | 54 + ...ibrarycoreeventsgame-ClientCommandEvent.md | 27 + ...librarycoreeventsgame-ClientDamageEvent.md | 135 +++ ...arycoreeventsgame-ClientEnterMatchEvent.md | 28 + ...rarycoreeventsgame-ClientExitMatchEvent.md | 28 + ...edlibrarycoreeventsgame-ClientGameEvent.md | 60 + ...brarycoreeventsgame-ClientJoinTeamEvent.md | 47 + ...edlibrarycoreeventsgame-ClientKillEvent.md | 27 + ...ibrarycoreeventsgame-ClientMessageEvent.md | 41 + ...sharedlibrarycoreeventsgame-GameEventV2.md | 43 + ...edlibrarycoreeventsgame-GameScriptEvent.md | 41 + ...aredlibrarycoreeventsgame-MatchEndEvent.md | 41 + ...edlibrarycoreeventsgame-MatchStartEvent.md | 41 + ...criptzombie-PlayerConsumedPerkGameEvent.md | 49 + ...egamescriptzombie-PlayerDamageGameEvent.md | 29 + ...egamescriptzombie-PlayerDownedGameEvent.md | 30 + ...iptzombie-PlayerGrabbedPowerupGameEvent.md | 49 + ...egamescriptzombie-PlayerKilledGameEvent.md | 27 + ...gamescriptzombie-PlayerRevivedGameEvent.md | 49 + ...mescriptzombie-PlayerRoundDataGameEvent.md | 55 + ...gamescriptzombie-RoundCompleteGameEvent.md | 43 + ...egamescriptzombie-ZombieDamageGameEvent.md | 29 + ...egamescriptzombie-ZombieKilledGameEvent.md | 27 + ...ntsmanagement-ClientExecuteCommandEvent.md | 47 + ...coreeventsmanagement-ClientPenaltyEvent.md | 46 + ...entsmanagement-ClientPenaltyRevokeEvent.md | 27 + ...smanagement-ClientPermissionChangeEvent.md | 47 + ...nagement-ClientPersistentIdReceiveEvent.md | 46 + ...ntsmanagement-ClientStateAuthorizeEvent.md | 28 + ...ventsmanagement-ClientStateDisposeEvent.md | 28 + ...rycoreeventsmanagement-ClientStateEvent.md | 41 + ...tsmanagement-ClientStateInitializeEvent.md | 28 + ...dlibrarycoreeventsmanagement-LoginEvent.md | 56 + ...librarycoreeventsmanagement-LogoutEvent.md | 27 + ...arycoreeventsmanagement-ManagementEvent.md | 30 + ...ntsmanagementloginevent-LoginSourceType.md | 21 + ...ycoreeventsserver-ClientDataUpdateEvent.md | 41 + ...reeventsserver-ConnectionInterruptEvent.md | 28 + ...coreeventsserver-ConnectionRestoreEvent.md | 28 + ...librarycoreeventsserver-GameServerEvent.md | 44 + ...brarycoreeventsserver-MonitorStartEvent.md | 28 + ...ibrarycoreeventsserver-MonitorStopEvent.md | 28 + ...eeventsserver-ServerCommandExecuteEvent.md | 47 + ...server-ServerCommandRequestExecuteEvent.md | 58 + ...oreeventsserver-ServerValueReceiveEvent.md | 47 + ...oreeventsserver-ServerValueRequestEvent.md | 64 + ...ventsserver-ServerValueSetCompleteEvent.md | 53 + ...eventsserver-ServerValueSetRequestEvent.md | 65 + ...rycoreexceptions-AuthorizationException.md | 31 + ...dlibrarycoreexceptions-CommandException.md | 31 + ...rycoreexceptions-ConfigurationException.md | 50 + ...librarycoreexceptions-DatabaseException.md | 31 + ...aredlibrarycoreexceptions-DvarException.md | 31 + ...dlibrarycoreexceptions-NetworkException.md | 41 + ...edlibrarycoreexceptions-PluginException.md | 44 + ...aredlibrarycoreexceptions-RConException.md | 54 + ...ibrarycoreexceptions-SerializeException.md | 31 + ...edlibrarycoreexceptions-ServerException.md | 31 + ...dlibrarycoreformatting-ColorCodeMapping.md | 27 + .../sharedlibrarycoreformatting-ColorCodes.md | 54 + ...redlibrarycoregameevent-EventFailReason.md | 41 + ...ibrarycoregameevent-EventRequiredEntity.md | 24 + .../sharedlibrarycoregameevent-EventSource.md | 27 + .../sharedlibrarycoregameevent-EventType.md | 166 +++ .../sharedlibrarycorehelpers-BuildNumber.md | 150 +++ ...arycorehelpers-BuildNumberJsonConverter.md | 75 ++ ...haredlibrarycorehelpers-ChangeTrackingT.md | 67 + .../sharedlibrarycorehelpers-Hashing.md | 44 + ...haredlibrarycorehelpers-InteractionData.md | 133 ++ .../sharedlibrarycorehelpers-MessageToken.md | 54 + .../sharedlibrarycorehelpers-ParseEnumT.md | 39 + .../sharedlibrarycorehelpers-Report.md | 51 + ...ycorehelpers-ResourceQueryHelperResultT.md | 63 + ...haredlibrarycorehelpers-TokenIdentifier.md | 49 + .../sharedlibrarycorehelpers-TokenState.md | 51 + ...aredlibrarycoreinterfaces-IAlertManager.md | 109 ++ ...haredlibrarycoreinterfaces-IAuditFields.md | 28 + ...einterfaces-IAuditInformationRepository.md | 44 + ...ibrarycoreinterfaces-IBaseConfiguration.md | 34 + ...librarycoreinterfaces-IBasePathProvider.md | 38 + ...sharedlibrarycoreinterfaces-IClientMeta.md | 64 + ...brarycoreinterfaces-IClientMetaResponse.md | 34 + ...nterfaces-IClientNoticeMessageFormatter.md | 40 + ...interfaces-IConfigurationHandlerFactory.md | 52 + ...rycoreinterfaces-IConfigurationHandlerT.md | 68 ++ ...coreinterfaces-IConfigurationHandlerV2T.md | 55 + ...librarycoreinterfaces-ICoreEventHandler.md | 52 + ...edlibrarycoreinterfaces-IEntityServiceT.md | 84 ++ ...haredlibrarycoreinterfaces-IEventParser.md | 96 ++ ...oreinterfaces-IEventParserConfiguration.md | 134 ++ ...redlibrarycoreinterfaces-IGameLogReader.md | 68 ++ ...arycoreinterfaces-IGameLogReaderFactory.md | 45 + ...sharedlibrarycoreinterfaces-IGameServer.md | 194 +++ ...reinterfaces-IGameServerInstanceFactory.md | 45 + ...ibrarycoreinterfaces-IGeoLocationResult.md | 58 + ...brarycoreinterfaces-IGeoLocationService.md | 32 + ...dlibrarycoreinterfaces-IInteractionData.md | 118 ++ ...coreinterfaces-IInteractionRegistration.md | 83 ++ .../sharedlibrarycoreinterfaces-ILogger.md | 83 ++ ...aredlibrarycoreinterfaces-ILookupValueT.md | 35 + .../sharedlibrarycoreinterfaces-IManager.md | 341 ++++++ ...edlibrarycoreinterfaces-IManagerCommand.md | 122 ++ ...rarycoreinterfaces-IMasterCommunication.md | 55 + ...haredlibrarycoreinterfaces-IMatchResult.md | 44 + ...librarycoreinterfaces-IMetaRegistration.md | 28 + ...haredlibrarycoreinterfaces-IMetaService.md | 216 ++++ ...redlibrarycoreinterfaces-IMetaServiceV2.md | 295 +++++ ...coreinterfaces-IMiddlewareActionHandler.md | 53 + ...ibrarycoreinterfaces-IMiddlewareActionT.md | 44 + ...brarycoreinterfaces-IModelConfiguration.md | 32 + ...dlibrarycoreinterfaces-IModularAssembly.md | 58 + .../sharedlibrarycoreinterfaces-IPageList.md | 28 + ...arycoreinterfaces-IParserPatternMatcher.md | 57 + ...brarycoreinterfaces-IParserRegexFactory.md | 39 + .../sharedlibrarycoreinterfaces-IPlugin.md | 89 ++ ...edlibrarycoreinterfaces-IPluginImporter.md | 50 + .../sharedlibrarycoreinterfaces-IPluginV2.md | 40 + ...edlibrarycoreinterfaces-IRConConnection.md | 53 + ...rycoreinterfaces-IRConConnectionFactory.md | 46 + ...sharedlibrarycoreinterfaces-IRConParser.md | 199 +++ ...coreinterfaces-IRConParserConfiguration.md | 196 +++ ...redlibrarycoreinterfaces-IRegisterEvent.md | 36 + ...rycoreinterfaces-IRemoteAssemblyHandler.md | 42 + ...arycoreinterfaces-IRemoteCommandService.md | 50 + ...rycoreinterfaces-IResourceQueryHelperTT.md | 45 + ...arycoreinterfaces-IScriptCommandFactory.md | 45 + ...rarycoreinterfaces-IScriptPluginFactory.md | 33 + ...interfaces-IScriptPluginServiceResolver.md | 60 + ...coreinterfaces-IScriptPluginTimerHelper.md | 86 ++ ...rarycoreinterfaces-IServerDataCollector.md | 33 + ...librarycoreinterfaces-IServerDataViewer.md | 75 ++ ...edlibrarycoreinterfaces-IStatusResponse.md | 68 ++ ...rarycoreinterfaces-ITokenAuthentication.md | 54 + ...dlibrarycoreinterfaces-ITokenIdentifier.md | 34 + ...ibrarycoreinterfaces-ITranslationLookup.md | 34 + ...edlibrarycoreinterfaces-InteractionType.md | 24 + .../sharedlibrarycoreinterfaces-MetaType.md | 45 + ...sharedlibrarycoreinterfaces-ParserRegex.md | 79 ++ ...nterfacesevents-IGameEventSubscriptions.md | 110 ++ ...cesevents-IGameServerEventSubscriptions.md | 117 ++ ...cesevents-IManagementEventSubscriptions.md | 147 +++ ...rarycoreinterfacesparserregex-GroupType.md | 113 ++ ...ibrarycorelocalization-ClientPermission.md | 39 + .../sharedlibrarycorelocalization-Layout.md | 49 + ...brarycorelocalization-TranslationLookup.md | 49 + ...corequeryhelper-ClientPaginationRequest.md | 42 + .../sharedlibrarycorercon-CommandPrefix.md | 111 ++ .../sharedlibrarycorercon-StaticHelpers.md | 38 + ...dlibrarycorerconstatichelpers-QueryType.md | 52 + ...repositories-AuditInformationRepository.md | 63 + .../sharedlibrarycoreserver-Game.md | 54 + ...ibrarycoreservices-ChangeHistoryService.md | 42 + ...sharedlibrarycoreservices-ClientService.md | 296 +++++ ...haredlibrarycoreservices-PenaltyService.md | 176 +++ 256 files changed, 18307 insertions(+) create mode 100644 CodeDocumentation/SharedLibraryCore/sharedlibrarycore-BaseController.md create mode 100644 CodeDocumentation/SharedLibraryCore/sharedlibrarycore-ColorCode.md create mode 100644 CodeDocumentation/SharedLibraryCore/sharedlibrarycore-Command.md create mode 100644 CodeDocumentation/SharedLibraryCore/sharedlibrarycore-DvarT.md create mode 100644 CodeDocumentation/SharedLibraryCore/sharedlibrarycore-GameEvent.md create mode 100644 CodeDocumentation/SharedLibraryCore/sharedlibrarycore-Gametype.md create mode 100644 CodeDocumentation/SharedLibraryCore/sharedlibrarycore-Map.md create mode 100644 CodeDocumentation/SharedLibraryCore/sharedlibrarycore-Server.md create mode 100644 CodeDocumentation/SharedLibraryCore/sharedlibrarycore-Utilities.md create mode 100644 CodeDocumentation/SharedLibraryCore/sharedlibrarycorealerts-Alert.md create mode 100644 CodeDocumentation/SharedLibraryCore/sharedlibrarycorealertsalert-AlertCategory.md create mode 100644 CodeDocumentation/SharedLibraryCore/sharedlibrarycorealertsalert-AlertState.md create mode 100644 CodeDocumentation/SharedLibraryCore/sharedlibrarycorecommands-BanCommand.md create mode 100644 CodeDocumentation/SharedLibraryCore/sharedlibrarycorecommands-CommandArgument.md create mode 100644 CodeDocumentation/SharedLibraryCore/sharedlibrarycorecommands-CommandExtensions.md create mode 100644 CodeDocumentation/SharedLibraryCore/sharedlibrarycorecommands-CommandProcessing.md create mode 100644 CodeDocumentation/SharedLibraryCore/sharedlibrarycorecommands-ExecuteRConCommand.md create mode 100644 CodeDocumentation/SharedLibraryCore/sharedlibrarycorecommands-FastRestartCommand.md create mode 100644 CodeDocumentation/SharedLibraryCore/sharedlibrarycorecommands-FlagClientCommand.md create mode 100644 CodeDocumentation/SharedLibraryCore/sharedlibrarycorecommands-GetClientPingCommand.md create mode 100644 CodeDocumentation/SharedLibraryCore/sharedlibrarycorecommands-KickCommand.md create mode 100644 CodeDocumentation/SharedLibraryCore/sharedlibrarycorecommands-ListBanInfoCommand.md create mode 100644 CodeDocumentation/SharedLibraryCore/sharedlibrarycorecommands-ListExternalIPCommand.md create mode 100644 CodeDocumentation/SharedLibraryCore/sharedlibrarycorecommands-ListRulesCommands.md create mode 100644 CodeDocumentation/SharedLibraryCore/sharedlibrarycorecommands-LoadMapCommand.md create mode 100644 CodeDocumentation/SharedLibraryCore/sharedlibrarycorecommands-MapRotateCommand.md create mode 100644 CodeDocumentation/SharedLibraryCore/sharedlibrarycorecommands-MaskCommand.md create mode 100644 CodeDocumentation/SharedLibraryCore/sharedlibrarycorecommands-MemoryUsageCommand.md create mode 100644 CodeDocumentation/SharedLibraryCore/sharedlibrarycorecommands-NextMapCommand.md create mode 100644 CodeDocumentation/SharedLibraryCore/sharedlibrarycorecommands-OwnerCommand.md create mode 100644 CodeDocumentation/SharedLibraryCore/sharedlibrarycorecommands-PrivateMessageAdminsCommand.md create mode 100644 CodeDocumentation/SharedLibraryCore/sharedlibrarycorecommands-PruneAdminsCommand.md create mode 100644 CodeDocumentation/SharedLibraryCore/sharedlibrarycorecommands-QuitCommand.md create mode 100644 CodeDocumentation/SharedLibraryCore/sharedlibrarycorecommands-RequestTokenCommand.md create mode 100644 CodeDocumentation/SharedLibraryCore/sharedlibrarycorecommands-RestartCommand.md create mode 100644 CodeDocumentation/SharedLibraryCore/sharedlibrarycorecommands-RunAsCommand.md create mode 100644 CodeDocumentation/SharedLibraryCore/sharedlibrarycorecommands-SetGravatarCommand.md create mode 100644 CodeDocumentation/SharedLibraryCore/sharedlibrarycorecommands-SetLevelCommand.md create mode 100644 CodeDocumentation/SharedLibraryCore/sharedlibrarycorecommands-SetPasswordCommand.md create mode 100644 CodeDocumentation/SharedLibraryCore/sharedlibrarycorecommands-TempBanCommand.md create mode 100644 CodeDocumentation/SharedLibraryCore/sharedlibrarycorecommands-UnbanCommand.md create mode 100644 CodeDocumentation/SharedLibraryCore/sharedlibrarycorecommands-UnflagClientCommand.md create mode 100644 CodeDocumentation/SharedLibraryCore/sharedlibrarycorecommands-UnlinkClientCommand.md create mode 100644 CodeDocumentation/SharedLibraryCore/sharedlibrarycorecommands-UptimeCommand.md create mode 100644 CodeDocumentation/SharedLibraryCore/sharedlibrarycorecommands-WarnClearCommand.md create mode 100644 CodeDocumentation/SharedLibraryCore/sharedlibrarycorecommands-WarnCommand.md create mode 100644 CodeDocumentation/SharedLibraryCore/sharedlibrarycoreconfiguration-ApplicationConfiguration.md create mode 100644 CodeDocumentation/SharedLibraryCore/sharedlibrarycoreconfiguration-CommandConfiguration.md create mode 100644 CodeDocumentation/SharedLibraryCore/sharedlibrarycoreconfiguration-CommandProperties.md create mode 100644 CodeDocumentation/SharedLibraryCore/sharedlibrarycoreconfiguration-CommunityInformationConfiguration.md create mode 100644 CodeDocumentation/SharedLibraryCore/sharedlibrarycoreconfiguration-DefaultSettings.md create mode 100644 CodeDocumentation/SharedLibraryCore/sharedlibrarycoreconfiguration-GameStringConfiguration.md create mode 100644 CodeDocumentation/SharedLibraryCore/sharedlibrarycoreconfiguration-GametypeConfiguration.md create mode 100644 CodeDocumentation/SharedLibraryCore/sharedlibrarycoreconfiguration-MapConfiguration.md create mode 100644 CodeDocumentation/SharedLibraryCore/sharedlibrarycoreconfiguration-QuickMessageConfiguration.md create mode 100644 CodeDocumentation/SharedLibraryCore/sharedlibrarycoreconfiguration-ServerConfiguration.md create mode 100644 CodeDocumentation/SharedLibraryCore/sharedlibrarycoreconfiguration-SocialAccountConfiguration.md create mode 100644 CodeDocumentation/SharedLibraryCore/sharedlibrarycoreconfiguration-WebfrontConfiguration.md create mode 100644 CodeDocumentation/SharedLibraryCore/sharedlibrarycoreconfigurationattributes-ConfigurationIgnore.md create mode 100644 CodeDocumentation/SharedLibraryCore/sharedlibrarycoreconfigurationattributes-ConfigurationLinked.md create mode 100644 CodeDocumentation/SharedLibraryCore/sharedlibrarycoreconfigurationattributes-ConfigurationOptional.md create mode 100644 CodeDocumentation/SharedLibraryCore/sharedlibrarycoreconfigurationattributes-LocalizedDisplayName.md create mode 100644 CodeDocumentation/SharedLibraryCore/sharedlibrarycoreconfigurationextensions-ConfigurationExtensions.md create mode 100644 CodeDocumentation/SharedLibraryCore/sharedlibrarycoreconfigurationvalidation-ApplicationConfigurationValidator.md create mode 100644 CodeDocumentation/SharedLibraryCore/sharedlibrarycoreconfigurationvalidation-ServerConfigurationValidator.md create mode 100644 CodeDocumentation/SharedLibraryCore/sharedlibrarycoredatabasemodels-EFClient.md create mode 100644 CodeDocumentation/SharedLibraryCore/sharedlibrarycoredatabasemodelsefclient-ClientState.md create mode 100644 CodeDocumentation/SharedLibraryCore/sharedlibrarycoredatabasemodelsefclient-TeamType.md create mode 100644 CodeDocumentation/SharedLibraryCore/sharedlibrarycoredtos-AuditInfo.md create mode 100644 CodeDocumentation/SharedLibraryCore/sharedlibrarycoredtos-ChatInfo.md create mode 100644 CodeDocumentation/SharedLibraryCore/sharedlibrarycoredtos-ClientCountSnapshot.md create mode 100644 CodeDocumentation/SharedLibraryCore/sharedlibrarycoredtos-ClientHistoryInfo.md create mode 100644 CodeDocumentation/SharedLibraryCore/sharedlibrarycoredtos-ClientInfo.md create mode 100644 CodeDocumentation/SharedLibraryCore/sharedlibrarycoredtos-CommandResponseInfo.md create mode 100644 CodeDocumentation/SharedLibraryCore/sharedlibrarycoredtos-EntityInfo.md create mode 100644 CodeDocumentation/SharedLibraryCore/sharedlibrarycoredtos-ErrorResponse.md create mode 100644 CodeDocumentation/SharedLibraryCore/sharedlibrarycoredtos-EventInfo.md create mode 100644 CodeDocumentation/SharedLibraryCore/sharedlibrarycoredtos-FindClientRequest.md create mode 100644 CodeDocumentation/SharedLibraryCore/sharedlibrarycoredtos-FindClientResult.md create mode 100644 CodeDocumentation/SharedLibraryCore/sharedlibrarycoredtos-IW4MAdminInfo.md create mode 100644 CodeDocumentation/SharedLibraryCore/sharedlibrarycoredtos-LookupValueT.md create mode 100644 CodeDocumentation/SharedLibraryCore/sharedlibrarycoredtos-Page.md create mode 100644 CodeDocumentation/SharedLibraryCore/sharedlibrarycoredtos-PaginationRequest.md create mode 100644 CodeDocumentation/SharedLibraryCore/sharedlibrarycoredtos-PenaltyInfo.md create mode 100644 CodeDocumentation/SharedLibraryCore/sharedlibrarycoredtos-PlayerInfo.md create mode 100644 CodeDocumentation/SharedLibraryCore/sharedlibrarycoredtos-ServerInfo.md create mode 100644 CodeDocumentation/SharedLibraryCore/sharedlibrarycoredtos-SharedInfo.md create mode 100644 CodeDocumentation/SharedLibraryCore/sharedlibrarycoredtos-SortDirection.md create mode 100644 CodeDocumentation/SharedLibraryCore/sharedlibrarycoredtosmeta-WebfrontTranslationHelper.md create mode 100644 CodeDocumentation/SharedLibraryCore/sharedlibrarycoredtosmetarequests-BaseClientMetaRequest.md create mode 100644 CodeDocumentation/SharedLibraryCore/sharedlibrarycoredtosmetarequests-ReceivedPenaltyRequest.md create mode 100644 CodeDocumentation/SharedLibraryCore/sharedlibrarycoredtosmetaresponses-AdministeredPenaltyResponse.md create mode 100644 CodeDocumentation/SharedLibraryCore/sharedlibrarycoredtosmetaresponses-BaseMetaResponse.md create mode 100644 CodeDocumentation/SharedLibraryCore/sharedlibrarycoredtosmetaresponses-ClientNoteMetaResponse.md create mode 100644 CodeDocumentation/SharedLibraryCore/sharedlibrarycoredtosmetaresponses-ConnectionHistoryResponse.md create mode 100644 CodeDocumentation/SharedLibraryCore/sharedlibrarycoredtosmetaresponses-InformationResponse.md create mode 100644 CodeDocumentation/SharedLibraryCore/sharedlibrarycoredtosmetaresponses-MessageResponse.md create mode 100644 CodeDocumentation/SharedLibraryCore/sharedlibrarycoredtosmetaresponses-PermissionLevelChangedResponse.md create mode 100644 CodeDocumentation/SharedLibraryCore/sharedlibrarycoredtosmetaresponses-ReceivedPenaltyResponse.md create mode 100644 CodeDocumentation/SharedLibraryCore/sharedlibrarycoredtosmetaresponses-UpdatedAliasResponse.md create mode 100644 CodeDocumentation/SharedLibraryCore/sharedlibrarycoreevents-CoreEvent.md create mode 100644 CodeDocumentation/SharedLibraryCore/sharedlibrarycoreevents-EventExtensions.md create mode 100644 CodeDocumentation/SharedLibraryCore/sharedlibrarycoreevents-GameEventArgs.md create mode 100644 CodeDocumentation/SharedLibraryCore/sharedlibrarycoreeventsgame-ClientCommandEvent.md create mode 100644 CodeDocumentation/SharedLibraryCore/sharedlibrarycoreeventsgame-ClientDamageEvent.md create mode 100644 CodeDocumentation/SharedLibraryCore/sharedlibrarycoreeventsgame-ClientEnterMatchEvent.md create mode 100644 CodeDocumentation/SharedLibraryCore/sharedlibrarycoreeventsgame-ClientExitMatchEvent.md create mode 100644 CodeDocumentation/SharedLibraryCore/sharedlibrarycoreeventsgame-ClientGameEvent.md create mode 100644 CodeDocumentation/SharedLibraryCore/sharedlibrarycoreeventsgame-ClientJoinTeamEvent.md create mode 100644 CodeDocumentation/SharedLibraryCore/sharedlibrarycoreeventsgame-ClientKillEvent.md create mode 100644 CodeDocumentation/SharedLibraryCore/sharedlibrarycoreeventsgame-ClientMessageEvent.md create mode 100644 CodeDocumentation/SharedLibraryCore/sharedlibrarycoreeventsgame-GameEventV2.md create mode 100644 CodeDocumentation/SharedLibraryCore/sharedlibrarycoreeventsgame-GameScriptEvent.md create mode 100644 CodeDocumentation/SharedLibraryCore/sharedlibrarycoreeventsgame-MatchEndEvent.md create mode 100644 CodeDocumentation/SharedLibraryCore/sharedlibrarycoreeventsgame-MatchStartEvent.md create mode 100644 CodeDocumentation/SharedLibraryCore/sharedlibrarycoreeventsgamegamescriptzombie-PlayerConsumedPerkGameEvent.md create mode 100644 CodeDocumentation/SharedLibraryCore/sharedlibrarycoreeventsgamegamescriptzombie-PlayerDamageGameEvent.md create mode 100644 CodeDocumentation/SharedLibraryCore/sharedlibrarycoreeventsgamegamescriptzombie-PlayerDownedGameEvent.md create mode 100644 CodeDocumentation/SharedLibraryCore/sharedlibrarycoreeventsgamegamescriptzombie-PlayerGrabbedPowerupGameEvent.md create mode 100644 CodeDocumentation/SharedLibraryCore/sharedlibrarycoreeventsgamegamescriptzombie-PlayerKilledGameEvent.md create mode 100644 CodeDocumentation/SharedLibraryCore/sharedlibrarycoreeventsgamegamescriptzombie-PlayerRevivedGameEvent.md create mode 100644 CodeDocumentation/SharedLibraryCore/sharedlibrarycoreeventsgamegamescriptzombie-PlayerRoundDataGameEvent.md create mode 100644 CodeDocumentation/SharedLibraryCore/sharedlibrarycoreeventsgamegamescriptzombie-RoundCompleteGameEvent.md create mode 100644 CodeDocumentation/SharedLibraryCore/sharedlibrarycoreeventsgamegamescriptzombie-ZombieDamageGameEvent.md create mode 100644 CodeDocumentation/SharedLibraryCore/sharedlibrarycoreeventsgamegamescriptzombie-ZombieKilledGameEvent.md create mode 100644 CodeDocumentation/SharedLibraryCore/sharedlibrarycoreeventsmanagement-ClientExecuteCommandEvent.md create mode 100644 CodeDocumentation/SharedLibraryCore/sharedlibrarycoreeventsmanagement-ClientPenaltyEvent.md create mode 100644 CodeDocumentation/SharedLibraryCore/sharedlibrarycoreeventsmanagement-ClientPenaltyRevokeEvent.md create mode 100644 CodeDocumentation/SharedLibraryCore/sharedlibrarycoreeventsmanagement-ClientPermissionChangeEvent.md create mode 100644 CodeDocumentation/SharedLibraryCore/sharedlibrarycoreeventsmanagement-ClientPersistentIdReceiveEvent.md create mode 100644 CodeDocumentation/SharedLibraryCore/sharedlibrarycoreeventsmanagement-ClientStateAuthorizeEvent.md create mode 100644 CodeDocumentation/SharedLibraryCore/sharedlibrarycoreeventsmanagement-ClientStateDisposeEvent.md create mode 100644 CodeDocumentation/SharedLibraryCore/sharedlibrarycoreeventsmanagement-ClientStateEvent.md create mode 100644 CodeDocumentation/SharedLibraryCore/sharedlibrarycoreeventsmanagement-ClientStateInitializeEvent.md create mode 100644 CodeDocumentation/SharedLibraryCore/sharedlibrarycoreeventsmanagement-LoginEvent.md create mode 100644 CodeDocumentation/SharedLibraryCore/sharedlibrarycoreeventsmanagement-LogoutEvent.md create mode 100644 CodeDocumentation/SharedLibraryCore/sharedlibrarycoreeventsmanagement-ManagementEvent.md create mode 100644 CodeDocumentation/SharedLibraryCore/sharedlibrarycoreeventsmanagementloginevent-LoginSourceType.md create mode 100644 CodeDocumentation/SharedLibraryCore/sharedlibrarycoreeventsserver-ClientDataUpdateEvent.md create mode 100644 CodeDocumentation/SharedLibraryCore/sharedlibrarycoreeventsserver-ConnectionInterruptEvent.md create mode 100644 CodeDocumentation/SharedLibraryCore/sharedlibrarycoreeventsserver-ConnectionRestoreEvent.md create mode 100644 CodeDocumentation/SharedLibraryCore/sharedlibrarycoreeventsserver-GameServerEvent.md create mode 100644 CodeDocumentation/SharedLibraryCore/sharedlibrarycoreeventsserver-MonitorStartEvent.md create mode 100644 CodeDocumentation/SharedLibraryCore/sharedlibrarycoreeventsserver-MonitorStopEvent.md create mode 100644 CodeDocumentation/SharedLibraryCore/sharedlibrarycoreeventsserver-ServerCommandExecuteEvent.md create mode 100644 CodeDocumentation/SharedLibraryCore/sharedlibrarycoreeventsserver-ServerCommandRequestExecuteEvent.md create mode 100644 CodeDocumentation/SharedLibraryCore/sharedlibrarycoreeventsserver-ServerValueReceiveEvent.md create mode 100644 CodeDocumentation/SharedLibraryCore/sharedlibrarycoreeventsserver-ServerValueRequestEvent.md create mode 100644 CodeDocumentation/SharedLibraryCore/sharedlibrarycoreeventsserver-ServerValueSetCompleteEvent.md create mode 100644 CodeDocumentation/SharedLibraryCore/sharedlibrarycoreeventsserver-ServerValueSetRequestEvent.md create mode 100644 CodeDocumentation/SharedLibraryCore/sharedlibrarycoreexceptions-AuthorizationException.md create mode 100644 CodeDocumentation/SharedLibraryCore/sharedlibrarycoreexceptions-CommandException.md create mode 100644 CodeDocumentation/SharedLibraryCore/sharedlibrarycoreexceptions-ConfigurationException.md create mode 100644 CodeDocumentation/SharedLibraryCore/sharedlibrarycoreexceptions-DatabaseException.md create mode 100644 CodeDocumentation/SharedLibraryCore/sharedlibrarycoreexceptions-DvarException.md create mode 100644 CodeDocumentation/SharedLibraryCore/sharedlibrarycoreexceptions-NetworkException.md create mode 100644 CodeDocumentation/SharedLibraryCore/sharedlibrarycoreexceptions-PluginException.md create mode 100644 CodeDocumentation/SharedLibraryCore/sharedlibrarycoreexceptions-RConException.md create mode 100644 CodeDocumentation/SharedLibraryCore/sharedlibrarycoreexceptions-SerializeException.md create mode 100644 CodeDocumentation/SharedLibraryCore/sharedlibrarycoreexceptions-ServerException.md create mode 100644 CodeDocumentation/SharedLibraryCore/sharedlibrarycoreformatting-ColorCodeMapping.md create mode 100644 CodeDocumentation/SharedLibraryCore/sharedlibrarycoreformatting-ColorCodes.md create mode 100644 CodeDocumentation/SharedLibraryCore/sharedlibrarycoregameevent-EventFailReason.md create mode 100644 CodeDocumentation/SharedLibraryCore/sharedlibrarycoregameevent-EventRequiredEntity.md create mode 100644 CodeDocumentation/SharedLibraryCore/sharedlibrarycoregameevent-EventSource.md create mode 100644 CodeDocumentation/SharedLibraryCore/sharedlibrarycoregameevent-EventType.md create mode 100644 CodeDocumentation/SharedLibraryCore/sharedlibrarycorehelpers-BuildNumber.md create mode 100644 CodeDocumentation/SharedLibraryCore/sharedlibrarycorehelpers-BuildNumberJsonConverter.md create mode 100644 CodeDocumentation/SharedLibraryCore/sharedlibrarycorehelpers-ChangeTrackingT.md create mode 100644 CodeDocumentation/SharedLibraryCore/sharedlibrarycorehelpers-Hashing.md create mode 100644 CodeDocumentation/SharedLibraryCore/sharedlibrarycorehelpers-InteractionData.md create mode 100644 CodeDocumentation/SharedLibraryCore/sharedlibrarycorehelpers-MessageToken.md create mode 100644 CodeDocumentation/SharedLibraryCore/sharedlibrarycorehelpers-ParseEnumT.md create mode 100644 CodeDocumentation/SharedLibraryCore/sharedlibrarycorehelpers-Report.md create mode 100644 CodeDocumentation/SharedLibraryCore/sharedlibrarycorehelpers-ResourceQueryHelperResultT.md create mode 100644 CodeDocumentation/SharedLibraryCore/sharedlibrarycorehelpers-TokenIdentifier.md create mode 100644 CodeDocumentation/SharedLibraryCore/sharedlibrarycorehelpers-TokenState.md create mode 100644 CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfaces-IAlertManager.md create mode 100644 CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfaces-IAuditFields.md create mode 100644 CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfaces-IAuditInformationRepository.md create mode 100644 CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfaces-IBaseConfiguration.md create mode 100644 CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfaces-IBasePathProvider.md create mode 100644 CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfaces-IClientMeta.md create mode 100644 CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfaces-IClientMetaResponse.md create mode 100644 CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfaces-IClientNoticeMessageFormatter.md create mode 100644 CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfaces-IConfigurationHandlerFactory.md create mode 100644 CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfaces-IConfigurationHandlerT.md create mode 100644 CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfaces-IConfigurationHandlerV2T.md create mode 100644 CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfaces-ICoreEventHandler.md create mode 100644 CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfaces-IEntityServiceT.md create mode 100644 CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfaces-IEventParser.md create mode 100644 CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfaces-IEventParserConfiguration.md create mode 100644 CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfaces-IGameLogReader.md create mode 100644 CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfaces-IGameLogReaderFactory.md create mode 100644 CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfaces-IGameServer.md create mode 100644 CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfaces-IGameServerInstanceFactory.md create mode 100644 CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfaces-IGeoLocationResult.md create mode 100644 CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfaces-IGeoLocationService.md create mode 100644 CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfaces-IInteractionData.md create mode 100644 CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfaces-IInteractionRegistration.md create mode 100644 CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfaces-ILogger.md create mode 100644 CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfaces-ILookupValueT.md create mode 100644 CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfaces-IManager.md create mode 100644 CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfaces-IManagerCommand.md create mode 100644 CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfaces-IMasterCommunication.md create mode 100644 CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfaces-IMatchResult.md create mode 100644 CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfaces-IMetaRegistration.md create mode 100644 CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfaces-IMetaService.md create mode 100644 CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfaces-IMetaServiceV2.md create mode 100644 CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfaces-IMiddlewareActionHandler.md create mode 100644 CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfaces-IMiddlewareActionT.md create mode 100644 CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfaces-IModelConfiguration.md create mode 100644 CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfaces-IModularAssembly.md create mode 100644 CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfaces-IPageList.md create mode 100644 CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfaces-IParserPatternMatcher.md create mode 100644 CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfaces-IParserRegexFactory.md create mode 100644 CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfaces-IPlugin.md create mode 100644 CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfaces-IPluginImporter.md create mode 100644 CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfaces-IPluginV2.md create mode 100644 CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfaces-IRConConnection.md create mode 100644 CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfaces-IRConConnectionFactory.md create mode 100644 CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfaces-IRConParser.md create mode 100644 CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfaces-IRConParserConfiguration.md create mode 100644 CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfaces-IRegisterEvent.md create mode 100644 CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfaces-IRemoteAssemblyHandler.md create mode 100644 CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfaces-IRemoteCommandService.md create mode 100644 CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfaces-IResourceQueryHelperTT.md create mode 100644 CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfaces-IScriptCommandFactory.md create mode 100644 CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfaces-IScriptPluginFactory.md create mode 100644 CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfaces-IScriptPluginServiceResolver.md create mode 100644 CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfaces-IScriptPluginTimerHelper.md create mode 100644 CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfaces-IServerDataCollector.md create mode 100644 CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfaces-IServerDataViewer.md create mode 100644 CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfaces-IStatusResponse.md create mode 100644 CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfaces-ITokenAuthentication.md create mode 100644 CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfaces-ITokenIdentifier.md create mode 100644 CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfaces-ITranslationLookup.md create mode 100644 CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfaces-InteractionType.md create mode 100644 CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfaces-MetaType.md create mode 100644 CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfaces-ParserRegex.md create mode 100644 CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfacesevents-IGameEventSubscriptions.md create mode 100644 CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfacesevents-IGameServerEventSubscriptions.md create mode 100644 CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfacesevents-IManagementEventSubscriptions.md create mode 100644 CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfacesparserregex-GroupType.md create mode 100644 CodeDocumentation/SharedLibraryCore/sharedlibrarycorelocalization-ClientPermission.md create mode 100644 CodeDocumentation/SharedLibraryCore/sharedlibrarycorelocalization-Layout.md create mode 100644 CodeDocumentation/SharedLibraryCore/sharedlibrarycorelocalization-TranslationLookup.md create mode 100644 CodeDocumentation/SharedLibraryCore/sharedlibrarycorequeryhelper-ClientPaginationRequest.md create mode 100644 CodeDocumentation/SharedLibraryCore/sharedlibrarycorercon-CommandPrefix.md create mode 100644 CodeDocumentation/SharedLibraryCore/sharedlibrarycorercon-StaticHelpers.md create mode 100644 CodeDocumentation/SharedLibraryCore/sharedlibrarycorerconstatichelpers-QueryType.md create mode 100644 CodeDocumentation/SharedLibraryCore/sharedlibrarycorerepositories-AuditInformationRepository.md create mode 100644 CodeDocumentation/SharedLibraryCore/sharedlibrarycoreserver-Game.md create mode 100644 CodeDocumentation/SharedLibraryCore/sharedlibrarycoreservices-ChangeHistoryService.md create mode 100644 CodeDocumentation/SharedLibraryCore/sharedlibrarycoreservices-ClientService.md create mode 100644 CodeDocumentation/SharedLibraryCore/sharedlibrarycoreservices-PenaltyService.md diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycore-BaseController.md b/CodeDocumentation/SharedLibraryCore/sharedlibrarycore-BaseController.md new file mode 100644 index 0000000..7c16700 --- /dev/null +++ b/CodeDocumentation/SharedLibraryCore/sharedlibrarycore-BaseController.md @@ -0,0 +1,102 @@ +# BaseController `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph SharedLibraryCore + SharedLibraryCore.BaseController[[BaseController]] + end + subgraph Microsoft.AspNetCore.Mvc +Microsoft.AspNetCore.Mvc.Controller[[Controller]] + end +Microsoft.AspNetCore.Mvc.Controller --> SharedLibraryCore.BaseController +``` + +## Members +### Properties +#### Protected properties +| Type | Name | Methods | +| --- | --- | --- | +| [`ApplicationConfiguration`](./sharedlibrarycoreconfiguration-ApplicationConfiguration) | [`AppConfig`](#appconfig) | `get` | +| `bool` | [`Authorized`](#authorized) | `get, set` | +| [`EFClient`](./sharedlibrarycoredatabasemodels-EFClient) | [`Client`](#client) | `get` | +| [`TranslationLookup`](./sharedlibrarycorelocalization-TranslationLookup) | [`Localization`](#localization) | `get` | + +#### Public properties +| Type | Name | Methods | +| --- | --- | --- | +| [`IManager`](./sharedlibrarycoreinterfaces-IManager) | [`Manager`](#manager) | `get` | + +### Methods +#### Protected methods +| Returns | Name | +| --- | --- | +| `Task` | [`SignInAsync`](#signinasync)(`ClaimsPrincipal` claimsPrinciple) | + +#### Public methods +| Returns | Name | +| --- | --- | +| `void` | [`OnActionExecuting`](#onactionexecuting)(`ActionExecutingContext` context) | + +## Details +### Inheritance + - `Controller` + +### Constructors +#### BaseController +```csharp +public BaseController(IManager manager) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| [`IManager`](./sharedlibrarycoreinterfaces-IManager) | manager | | + +### Methods +#### SignInAsync +```csharp +protected async Task SignInAsync(ClaimsPrincipal claimsPrinciple) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `ClaimsPrincipal` | claimsPrinciple | | + +#### OnActionExecuting +```csharp +public override async void OnActionExecuting(ActionExecutingContext context) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `ActionExecutingContext` | context | | + +### Properties +#### Authorized +```csharp +protected bool Authorized { get; set; } +``` + +#### Localization +```csharp +protected TranslationLookup Localization { get; } +``` + +#### Client +```csharp +protected EFClient Client { get; } +``` + +#### AppConfig +```csharp +protected ApplicationConfiguration AppConfig { get; } +``` + +#### Manager +```csharp +public IManager Manager { get; } +``` + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycore-ColorCode.md b/CodeDocumentation/SharedLibraryCore/sharedlibrarycore-ColorCode.md new file mode 100644 index 0000000..8097f85 --- /dev/null +++ b/CodeDocumentation/SharedLibraryCore/sharedlibrarycore-ColorCode.md @@ -0,0 +1,61 @@ +# ColorCode `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph SharedLibraryCore + SharedLibraryCore.ColorCode[[ColorCode]] + end + subgraph Microsoft.AspNetCore.Razor.TagHelpers +Microsoft.AspNetCore.Razor.TagHelpers.TagHelper[[TagHelper]] + end +Microsoft.AspNetCore.Razor.TagHelpers.TagHelper --> SharedLibraryCore.ColorCode +``` + +## Members +### Properties +#### Public properties +| Type | Name | Methods | +| --- | --- | --- | +| `string` | [`Value`](#value) | `get, set` | + +### Methods +#### Public methods +| Returns | Name | +| --- | --- | +| `void` | [`Process`](#process)(`TagHelperContext` context, `TagHelperOutput` output) | + +## Details +### Inheritance + - `TagHelper` + +### Constructors +#### ColorCode +```csharp +public ColorCode(ApplicationConfiguration appConfig) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| [`ApplicationConfiguration`](./sharedlibrarycoreconfiguration-ApplicationConfiguration) | appConfig | | + +### Methods +#### Process +```csharp +public override void Process(TagHelperContext context, TagHelperOutput output) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `TagHelperContext` | context | | +| `TagHelperOutput` | output | | + +### Properties +#### Value +```csharp +public string Value { get; set; } +``` + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycore-Command.md b/CodeDocumentation/SharedLibraryCore/sharedlibrarycore-Command.md new file mode 100644 index 0000000..f947aeb --- /dev/null +++ b/CodeDocumentation/SharedLibraryCore/sharedlibrarycore-Command.md @@ -0,0 +1,155 @@ +# Command `Public class` + +## Description +Abstract class for command + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph SharedLibraryCore + SharedLibraryCore.Command[[Command]] + class SharedLibraryCore.Command abstractStyle; + end + subgraph SharedLibraryCore.Interfaces + SharedLibraryCore.Interfaces.IManagerCommand[[IManagerCommand]] + class SharedLibraryCore.Interfaces.IManagerCommand interfaceStyle; + end +SharedLibraryCore.Interfaces.IManagerCommand --> SharedLibraryCore.Command +``` + +## Members +### Properties +#### Public properties +| Type | Name | Methods | +| --- | --- | --- | +| `string` | [`Alias`](#alias)
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` | +| `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` | +| `Permission` | [`Permission`](#permission)
Minimum permission level to execute command | `get, protected set` | +| `int` | [`RequiredArgumentCount`](#requiredargumentcount)
Helper property to determine the number of required args | `get` | +| `bool` | [`RequiresTarget`](#requirestarget)
Indicates if the command requires a target to execute on | `get, protected set` | +| `Game``[]` | [`SupportedGames`](#supportedgames) | `get, protected set` | +| `string` | [`Syntax`](#syntax)
Helper property to provide the syntax of the command | `get` | + +### Methods +#### Public methods +| Returns | Name | +| --- | --- | +| `Task` | [`ExecuteAsync`](#executeasync)([`GameEvent`](./sharedlibrarycore-GameEvent) gameEvent)
Executes the command | + +## Details +### Summary +Abstract class for command + +### Inheritance + - [ +`IManagerCommand` +](./sharedlibrarycoreinterfaces-IManagerCommand) + +### Constructors +#### Command +```csharp +public Command(CommandConfiguration config, ITranslationLookup layout) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| [`CommandConfiguration`](./sharedlibrarycoreconfiguration-CommandConfiguration) | config | | +| [`ITranslationLookup`](./sharedlibrarycoreinterfaces-ITranslationLookup) | layout | | + +### Methods +#### ExecuteAsync +```csharp +public abstract Task ExecuteAsync(GameEvent gameEvent) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| [`GameEvent`](./sharedlibrarycore-GameEvent) | gameEvent | | + +##### Summary +Executes the command + +##### Returns + + +### Properties +#### RequiredArgumentCount +```csharp +public int RequiredArgumentCount { get; } +``` +##### Summary +Helper property to determine the number of required args + +#### Arguments +```csharp +public CommandArgument Arguments { get; protected set; } +``` +##### Summary +Argument list for the command + +#### Name +```csharp +public string Name { get; protected set; } +``` +##### Summary +Specifies the name and string that triggers the command + +#### Description +```csharp +public string Description { get; protected set; } +``` +##### Summary +Specifies the command description + +#### Syntax +```csharp +public virtual string Syntax { get; } +``` +##### Summary +Helper property to provide the syntax of the command + +#### Alias +```csharp +public string Alias { get; protected set; } +``` +##### Summary +Alternate name for this command to be executed by + +#### RequiresTarget +```csharp +public bool RequiresTarget { get; protected set; } +``` +##### Summary +Indicates if the command requires a target to execute on + +#### Permission +```csharp +public Permission Permission { get; protected set; } +``` +##### Summary +Minimum permission level to execute command + +#### SupportedGames +```csharp +public Game SupportedGames { get; protected set; } +``` + +#### AllowImpersonation +```csharp +public bool AllowImpersonation { get; set; } +``` +##### Summary +indicates if this command allows impersonation (run as) + +#### IsBroadcast +```csharp +public virtual bool IsBroadcast { get; set; } +``` + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycore-DvarT.md b/CodeDocumentation/SharedLibraryCore/sharedlibrarycore-DvarT.md new file mode 100644 index 0000000..45119f1 --- /dev/null +++ b/CodeDocumentation/SharedLibraryCore/sharedlibrarycore-DvarT.md @@ -0,0 +1,58 @@ +# Dvar<T> `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph SharedLibraryCore + SharedLibraryCore.Dvar_1[[Dvar< T >]] + + end +``` + +## Members +### Properties +#### Public properties +| Type | Name | Methods | +| --- | --- | --- | +| `T` | [`DefaultValue`](#defaultvalue) | `get, set` | +| `string` | [`Domain`](#domain) | `get, set` | +| `T` | [`LatchedValue`](#latchedvalue) | `get, set` | +| `string` | [`Name`](#name) | `get, set` | +| `T` | [`Value`](#value) | `get, set` | + +## Details +### Constructors +#### Dvar +```csharp +public Dvar() +``` + +### Properties +#### Name +```csharp +public string Name { get; set; } +``` + +#### Value +```csharp +public T Value { get; set; } +``` + +#### DefaultValue +```csharp +public T DefaultValue { get; set; } +``` + +#### LatchedValue +```csharp +public T LatchedValue { get; set; } +``` + +#### Domain +```csharp +public string Domain { get; set; } +``` + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycore-GameEvent.md b/CodeDocumentation/SharedLibraryCore/sharedlibrarycore-GameEvent.md new file mode 100644 index 0000000..08aa08e --- /dev/null +++ b/CodeDocumentation/SharedLibraryCore/sharedlibrarycore-GameEvent.md @@ -0,0 +1,172 @@ +# GameEvent `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph SharedLibraryCore + SharedLibraryCore.GameEvent[[GameEvent]] + end + subgraph SharedLibraryCore.Events + SharedLibraryCore.Events.CoreEvent[[CoreEvent]] + class SharedLibraryCore.Events.CoreEvent abstractStyle; + end +SharedLibraryCore.Events.CoreEvent --> SharedLibraryCore.GameEvent +``` + +## Members +### Properties +#### Public properties +| Type | Name | Methods | +| --- | --- | --- | +| `object` | [`Extra`](#extra) | `get, set` | +| `EventFailReason` | [`FailReason`](#failreason) | `get, set` | +| `bool` | [`Failed`](#failed) | `get` | +| `Nullable`<`long`> | [`GameTime`](#gametime)
Specifies the game time offset as printed in the log | `get, set` | +| [`EFClient`](./sharedlibrarycoredatabasemodels-EFClient) | [`ImpersonationOrigin`](#impersonationorigin) | `get, set` | +| `long` | [`IncrementalId`](#incrementalid) | `get` | +| `bool` | [`IsBlocking`](#isblocking)
Indicates if the event should block until it is complete | `get, set` | +| `bool` | [`IsRemote`](#isremote) | `get, set` | +| `List`<`string`> | [`Output`](#output) | `get, set` | +| `EventRequiredEntity` | [`RequiredEntity`](#requiredentity) | `get, set` | +| `string` | [`Subtype`](#subtype)
suptype of the event for more detailed classification | `get, set` | +| `DateTime` | [`Time`](#time) | `get, set` | +| `string` | [`TypeName`](#typename) | `get` | + +### Methods +#### Protected methods +| Returns | Name | +| --- | --- | +| `void` | [`Finalize`](#finalize)() | + +#### Public methods +| Returns | Name | +| --- | --- | +| `void` | [`Complete`](#complete)() | +| `Task`<[`GameEvent`](sharedlibrarycore-GameEvent)> | [`WaitAsync`](#waitasync-12)(`...`) | + +## Details +### Inheritance + - [ +`CoreEvent` +](./sharedlibrarycoreevents-CoreEvent) + +### Nested types +#### Enums + - `EventFailReason` + - `EventRequiredEntity` + - `EventSource` + - `EventType` + +### Constructors +#### GameEvent +```csharp +public GameEvent() +``` + +### Methods +#### Finalize +```csharp +protected override void Finalize() +``` + +#### Complete +```csharp +public void Complete() +``` + +#### WaitAsync [1/2] +```csharp +public async Task WaitAsync() +``` + +#### WaitAsync [2/2] +```csharp +public async Task WaitAsync(TimeSpan timeSpan, CancellationToken token) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `TimeSpan` | timeSpan | | +| `CancellationToken` | token | | + +##### Summary +asynchronously wait for GameEvent to be processed + +##### Returns +waitable task + +### Properties +#### TypeName +```csharp +public string TypeName { get; } +``` + +#### Subtype +```csharp +public string Subtype { get; set; } +``` +##### Summary +suptype of the event for more detailed classification + +#### RequiredEntity +```csharp +public EventRequiredEntity RequiredEntity { get; set; } +``` + +#### GameTime +```csharp +public Nullable GameTime { get; set; } +``` +##### Summary +Specifies the game time offset as printed in the log + +#### ImpersonationOrigin +```csharp +public EFClient ImpersonationOrigin { get; set; } +``` + +#### IsRemote +```csharp +public bool IsRemote { get; set; } +``` + +#### Extra +```csharp +public object Extra { get; set; } +``` + +#### Time +```csharp +public DateTime Time { get; set; } +``` + +#### IncrementalId +```csharp +public long IncrementalId { get; } +``` + +#### FailReason +```csharp +public EventFailReason FailReason { get; set; } +``` + +#### Failed +```csharp +public bool Failed { get; } +``` + +#### Output +```csharp +public List Output { get; set; } +``` + +#### IsBlocking +```csharp +public bool IsBlocking { get; set; } +``` +##### Summary +Indicates if the event should block until it is complete + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycore-Gametype.md b/CodeDocumentation/SharedLibraryCore/sharedlibrarycore-Gametype.md new file mode 100644 index 0000000..94770b5 --- /dev/null +++ b/CodeDocumentation/SharedLibraryCore/sharedlibrarycore-Gametype.md @@ -0,0 +1,39 @@ +# Gametype `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph SharedLibraryCore + SharedLibraryCore.Gametype[[Gametype]] + end +``` + +## Members +### Properties +#### Public properties +| Type | Name | Methods | +| --- | --- | --- | +| `string` | [`Alias`](#alias) | `get, set` | +| `string` | [`Name`](#name) | `get, set` | + +## Details +### Constructors +#### Gametype +```csharp +public Gametype() +``` + +### Properties +#### Name +```csharp +public string Name { get; set; } +``` + +#### Alias +```csharp +public string Alias { get; set; } +``` + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycore-Map.md b/CodeDocumentation/SharedLibraryCore/sharedlibrarycore-Map.md new file mode 100644 index 0000000..c005cbc --- /dev/null +++ b/CodeDocumentation/SharedLibraryCore/sharedlibrarycore-Map.md @@ -0,0 +1,51 @@ +# Map `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph SharedLibraryCore + SharedLibraryCore.Map[[Map]] + end +``` + +## Members +### Properties +#### Public properties +| Type | Name | Methods | +| --- | --- | --- | +| `string` | [`Alias`](#alias) | `get, set` | +| `string` | [`Name`](#name) | `get, set` | + +### Methods +#### Public methods +| Returns | Name | +| --- | --- | +| `string` | [`ToString`](#tostring)() | + +## Details +### Constructors +#### Map +```csharp +public Map() +``` + +### Methods +#### ToString +```csharp +public override string ToString() +``` + +### Properties +#### Name +```csharp +public string Name { get; set; } +``` + +#### Alias +```csharp +public string Alias { get; set; } +``` + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycore-Server.md b/CodeDocumentation/SharedLibraryCore/sharedlibrarycore-Server.md new file mode 100644 index 0000000..7ddfaa7 --- /dev/null +++ b/CodeDocumentation/SharedLibraryCore/sharedlibrarycore-Server.md @@ -0,0 +1,672 @@ +# Server `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph SharedLibraryCore + SharedLibraryCore.Server[[Server]] + class SharedLibraryCore.Server abstractStyle; + end + subgraph SharedLibraryCore.Interfaces + SharedLibraryCore.Interfaces.IGameServer[[IGameServer]] + class SharedLibraryCore.Interfaces.IGameServer interfaceStyle; + end +SharedLibraryCore.Interfaces.IGameServer --> SharedLibraryCore.Server +``` + +## Members +### Properties +#### Public properties +| Type | Name | Methods | +| --- | --- | --- | +| `List`<[`ChatInfo`](./sharedlibrarycoredtos-ChatInfo)> | [`ChatHistory`](#chathistory) | `get, protected set` | +| [`ClientHistoryInfo`](./sharedlibrarycoredtos-ClientHistoryInfo) | [`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` | +| `bool` | [`CustomCallback`](#customcallback) | `get, protected set` | +| `long` | [`EndPoint`](#endpoint) | `get` | +| [`IEventParser`](./sharedlibrarycoreinterfaces-IEventParser) | [`EventParser`](#eventparser) | `get, set` | +| `SemaphoreSlim` | [`EventProcessing`](#eventprocessing) | `get` | +| `Game` | [`GameCode`](#gamecode) | `get` | +| `Game` | [`GameName`](#gamename) | `get, set` | +| `string` | [`GamePassword`](#gamepassword) | `get, protected set` | +| `string` | [`Gametype`](#gametype) | `get, set` | +| `string` | [`GametypeName`](#gametypename) | `get` | +| `string` | [`Hostname`](#hostname) | `get, protected set` | +| `string` | [`IP`](#ip)
this is actually the listen address now | `get, protected set` | +| `string` | [`Id`](#id) | `get` | +| `bool` | [`IsInitialized`](#isinitialized) | `get, set` | +| `bool` | [`IsLegacyGameIntegrationEnabled`](#islegacygameintegrationenabled) | `get` | +| `long` | [`LegacyDatabaseId`](#legacydatabaseid) | `get` | +| `string` | [`ListenAddress`](#listenaddress) | `get` | +| `int` | [`ListenPort`](#listenport) | `get` | +| `string` | [`LogPath`](#logpath) | `get, protected set` | +| [`ILogger`](./sharedlibrarycoreinterfaces-ILogger) | [`Logger`](#logger) | `get` | +| [`IManager`](./sharedlibrarycoreinterfaces-IManager) | [`Manager`](#manager) | `get, protected set` | +| [`Map`](./sharedlibrarycore-Map) | [`Map`](#map) | `get` | +| `List`<[`Map`](./sharedlibrarycore-Map)> | [`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` | +| `string` | [`Password`](#password) | `get` | +| `string` | [`PerformanceBucket`](#performancebucket) | `get, init` | +| `int` | [`Port`](#port) | `get, protected set` | +| `int` | [`PrivateClientSlots`](#privateclientslots) | `get, protected set` | +| [`IRConParser`](./sharedlibrarycoreinterfaces-IRConParser) | [`RconParser`](#rconparser) | `get, set` | +| [`IRConConnection`](./sharedlibrarycoreinterfaces-IRConConnection) | [`RemoteConnection`](#remoteconnection) | `get, protected set` | +| `List`<[`Report`](./sharedlibrarycorehelpers-Report)> | [`Reports`](#reports) | `get, set` | +| `IPEndPoint` | [`ResolvedIpEndPoint`](#resolvedipendpoint) | `get, protected set` | +| `bool` | [`RestartRequested`](#restartrequested) | `get, set` | +| [`ServerConfiguration`](./sharedlibrarycoreconfiguration-ServerConfiguration) | [`ServerConfig`](#serverconfig) | `get` | +| `string` | [`ServerName`](#servername) | `get` | +| `bool` | [`Throttled`](#throttled) | `get, protected set` | +| `string` | [`Version`](#version) | `get, protected set` | +| `string` | [`Website`](#website) | `get, protected set` | +| `string` | [`WorkingDirectory`](#workingdirectory) | `get, protected set` | + +### Methods +#### Public methods +| Returns | Name | +| --- | --- | +| `Task` | [`Ban`](#ban)(`string` reason, [`EFClient`](./sharedlibrarycoredatabasemodels-EFClient) target, [`EFClient`](./sharedlibrarycoredatabasemodels-EFClient) origin, `bool` isEvade)
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`<`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) | +| `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`<`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 | +| `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) | + +#### 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`> | [`ScriptLoaded`](#scriptloaded)() | +| `Task` | [`Tell`](#tell)(`string` message, [`EFClient`](./sharedlibrarycoredatabasemodels-EFClient) targetClient)
Send a message to a particular players | + +## Details +### Inheritance + - [ +`IGameServer` +](./sharedlibrarycoreinterfaces-IGameServer) + +### Nested types +#### Enums + - `Game` + +### Constructors +#### Server +```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 | | +| `IServiceProvider` | serviceProvider | | + +### Methods +#### Kick [1/2] +```csharp +public abstract Task Kick(string reason, EFClient target, EFClient origin, EFPenalty originalPenalty) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `string` | reason | | +| [`EFClient`](./sharedlibrarycoredatabasemodels-EFClient) | target | | +| [`EFClient`](./sharedlibrarycoredatabasemodels-EFClient) | origin | | +| `EFPenalty` | originalPenalty | | + +#### ExecuteCommandAsync +```csharp +public abstract Task ExecuteCommandAsync(string command, CancellationToken token) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `string` | command | | +| `CancellationToken` | token | | + +#### SetDvarAsync +```csharp +public abstract Task SetDvarAsync(string name, object value, CancellationToken token) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `string` | name | | +| `object` | value | | +| `CancellationToken` | token | | + +#### GetClientsAsList +```csharp +public List GetClientsAsList() +``` +##### Summary +Returns list of all current players + +##### Returns + + +#### OnClientConnected +```csharp +public abstract Task OnClientConnected(EFClient P) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| [`EFClient`](./sharedlibrarycoredatabasemodels-EFClient) | P | EFClient pulled from memory reading | + +##### Summary +Add a player to the server's player list + +##### Returns +True if player added successfully, false otherwise + +#### OnClientDisconnected +```csharp +public abstract Task OnClientDisconnected(EFClient client) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| [`EFClient`](./sharedlibrarycoredatabasemodels-EFClient) | client | | + +##### Summary +Remove player by client number + +##### Returns +true if removal succeeded, false otherwise + +#### GetClientByName +```csharp +public List GetClientByName(string pName) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `string` | pName | EFClient name to search for | + +##### Summary +Get a player by name + todo: make this an extension + +##### Returns +Matching player if found + +#### ProcessUpdatesAsync +```csharp +public virtual Task ProcessUpdatesAsync(CancellationToken token) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `CancellationToken` | token | | + +#### ProcessEvent +```csharp +protected abstract Task ProcessEvent(GameEvent E) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| [`GameEvent`](./sharedlibrarycore-GameEvent) | E | Event | + +##### Summary +Process any server event + +##### Returns +True on sucess + +#### ExecuteEvent +```csharp +public abstract Task ExecuteEvent(GameEvent E) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| [`GameEvent`](./sharedlibrarycore-GameEvent) | E | | + +#### Broadcast [1/2] +```csharp +public GameEvent Broadcast(string message, EFClient sender) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `string` | message | Message to be sent to all players | +| [`EFClient`](./sharedlibrarycoredatabasemodels-EFClient) | sender | Client that initiated the broadcast | + +##### Summary +Send a message to all players + +#### Broadcast [2/2] +```csharp +public void Broadcast(IEnumerable messages, EFClient sender) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `IEnumerable`<`string`> | messages | | +| [`EFClient`](./sharedlibrarycoredatabasemodels-EFClient) | sender | | + +#### BroadcastAsync +```csharp +public async Task BroadcastAsync(IEnumerable messages, EFClient sender, CancellationToken token) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `IEnumerable`<`string`> | messages | | +| [`EFClient`](./sharedlibrarycoredatabasemodels-EFClient) | sender | | +| `CancellationToken` | token | | + +#### Tell +```csharp +protected async Task Tell(string message, EFClient targetClient) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `string` | message | Message to send | +| [`EFClient`](./sharedlibrarycoredatabasemodels-EFClient) | targetClient | EFClient to send message to | + +##### Summary +Send a message to a particular players + +#### ToAdmins +```csharp +public void ToAdmins(string message) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `string` | message | Message to send out | + +##### Summary +Send a message to all admins on the server + +#### Kick [2/2] +```csharp +public Task Kick(string reason, EFClient target, EFClient origin) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `string` | reason | Reason for kicking | +| [`EFClient`](./sharedlibrarycoredatabasemodels-EFClient) | target | EFClient to kick | +| [`EFClient`](./sharedlibrarycoredatabasemodels-EFClient) | origin | Client initating the kick | + +##### Summary +Kick a player from the server + +#### TempBan +```csharp +public abstract Task TempBan(string reason, TimeSpan length, EFClient target, EFClient origin) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `string` | reason | Reason for banning the player | +| `TimeSpan` | length | Duration of the ban | +| [`EFClient`](./sharedlibrarycoredatabasemodels-EFClient) | target | The client to ban | +| [`EFClient`](./sharedlibrarycoredatabasemodels-EFClient) | origin | The client performing the ban | + +##### Summary +Temporarily ban a player ( default 1 hour ) from the server + +#### Ban +```csharp +public abstract Task Ban(string reason, EFClient target, EFClient origin, bool isEvade) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `string` | reason | The reason for the ban | +| [`EFClient`](./sharedlibrarycoredatabasemodels-EFClient) | target | The person to ban | +| [`EFClient`](./sharedlibrarycoredatabasemodels-EFClient) | origin | The person who banned the target | +| `bool` | isEvade | obsolete | + +##### Summary +Perm ban a player from the server + +#### Warn +```csharp +public abstract Task Warn(string reason, EFClient target, EFClient origin) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `string` | reason | | +| [`EFClient`](./sharedlibrarycoredatabasemodels-EFClient) | target | | +| [`EFClient`](./sharedlibrarycoredatabasemodels-EFClient) | origin | | + +#### Unban +```csharp +public abstract Task Unban(string reason, EFClient targetClient, EFClient originClient) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `string` | reason | reason for unban | +| [`EFClient`](./sharedlibrarycoredatabasemodels-EFClient) | targetClient | client being unbanned | +| [`EFClient`](./sharedlibrarycoredatabasemodels-EFClient) | originClient | client performing the unban | + +##### Summary +Unban a player by npID / GUID + +##### Returns + + +#### LoadMap +```csharp +public async Task LoadMap(string mapName) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `string` | mapName | Non-localized map name | + +##### Summary +Change the current server map + +#### InitializeTokens +```csharp +public abstract void InitializeTokens() +``` +##### Summary +Initalize the macro variables + +#### InitializeAutoMessages +```csharp +protected void InitializeAutoMessages() +``` +##### Summary +Initialize the messages to be broadcasted + +#### ToString +```csharp +public override string ToString() +``` + +#### ScriptLoaded +```csharp +protected async Task ScriptLoaded() +``` + +#### GetIdForServer +```csharp +public abstract Task GetIdForServer(Server server) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| [`Server`](sharedlibrarycore-Server) | server | | + +#### GetClientByNumber +```csharp +public EFClient GetClientByNumber(int clientNumber) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `int` | clientNumber | | + +### Properties +#### EndPoint +```csharp +public long EndPoint { get; } +``` + +#### LegacyDatabaseId +```csharp +public abstract long LegacyDatabaseId { get; } +``` + +#### Id +```csharp +public virtual string Id { get; } +``` + +#### Manager +```csharp +public IManager Manager { get; protected set; } +``` + +#### Logger +```csharp +public ILogger Logger { get; } +``` + +#### ServerConfig +```csharp +public ServerConfiguration ServerConfig { get; } +``` + +#### Maps +```csharp +public List Maps { get; protected set; } +``` + +#### Reports +```csharp +public List Reports { get; set; } +``` + +#### ChatHistory +```csharp +public List ChatHistory { get; protected set; } +``` + +#### ClientHistory +```csharp +public ClientHistoryInfo ClientHistory { get; } +``` + +#### GameName +```csharp +public Game GameName { get; set; } +``` + +#### GameCode +```csharp +public virtual Game GameCode { get; } +``` + +#### MatchEndTime +```csharp +public Nullable MatchEndTime { get; protected set; } +``` + +#### MatchStartTime +```csharp +public Nullable MatchStartTime { get; protected set; } +``` + +#### Hostname +```csharp +public string Hostname { get; protected set; } +``` + +#### ServerName +```csharp +public virtual string ServerName { get; } +``` + +#### Website +```csharp +public string Website { get; protected set; } +``` + +#### Gametype +```csharp +public string Gametype { get; set; } +``` + +#### GametypeName +```csharp +public string GametypeName { get; } +``` + +#### GamePassword +```csharp +public string GamePassword { get; protected set; } +``` + +#### PrivateClientSlots +```csharp +public int PrivateClientSlots { get; protected set; } +``` + +#### CurrentMap +```csharp +public Map CurrentMap { get; set; } +``` + +#### Map +```csharp +public virtual Map Map { get; } +``` + +#### ClientNum +```csharp +public int ClientNum { get; } +``` + +#### MaxClients +```csharp +public int MaxClients { get; protected set; } +``` + +#### Clients +```csharp +public List Clients { get; protected set; } +``` + +#### ConnectedClients +```csharp +public virtual IReadOnlyList ConnectedClients { get; } +``` + +#### Password +```csharp +public string Password { get; } +``` + +#### Throttled +```csharp +public bool Throttled { get; protected set; } +``` + +#### CustomCallback +```csharp +public bool CustomCallback { get; protected set; } +``` + +#### IsLegacyGameIntegrationEnabled +```csharp +public virtual bool IsLegacyGameIntegrationEnabled { get; } +``` + +#### WorkingDirectory +```csharp +public string WorkingDirectory { get; protected set; } +``` + +#### RemoteConnection +```csharp +public IRConConnection RemoteConnection { get; protected set; } +``` + +#### RconParser +```csharp +public IRConParser RconParser { get; set; } +``` + +#### EventParser +```csharp +public IEventParser EventParser { get; set; } +``` + +#### LogPath +```csharp +public string LogPath { get; protected set; } +``` + +#### RestartRequested +```csharp +public bool RestartRequested { get; set; } +``` + +#### EventProcessing +```csharp +public SemaphoreSlim EventProcessing { get; } +``` + +#### IP +```csharp +public string IP { get; protected set; } +``` +##### Summary +this is actually the listen address now + +#### ListenAddress +```csharp +public virtual string ListenAddress { get; } +``` + +#### ResolvedIpEndPoint +```csharp +public IPEndPoint ResolvedIpEndPoint { get; protected set; } +``` + +#### Version +```csharp +public string Version { get; protected set; } +``` + +#### IsInitialized +```csharp +public bool IsInitialized { get; set; } +``` + +#### Port +```csharp +public int Port { get; protected set; } +``` + +#### ListenPort +```csharp +public virtual int ListenPort { get; } +``` + +#### PerformanceBucket +```csharp +public string PerformanceBucket { get; init; } +``` + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycore-Utilities.md b/CodeDocumentation/SharedLibraryCore/sharedlibrarycore-Utilities.md new file mode 100644 index 0000000..86690ec --- /dev/null +++ b/CodeDocumentation/SharedLibraryCore/sharedlibrarycore-Utilities.md @@ -0,0 +1,1073 @@ +# Utilities `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph SharedLibraryCore + SharedLibraryCore.Utilities[[Utilities]] + end +``` + +## Members +### Properties +#### Public Static properties +| Type | Name | Methods | +| --- | --- | --- | +| `char` | [`CommandPrefix`](#commandprefix) | `get, set` | +| `TimeSpan` | [`DefaultCommandTimeout`](#defaultcommandtimeout) | `get, set` | +| `ILogger` | [`DefaultLogger`](#defaultlogger) | `get, set` | +| `bool` | [`IsDevelopment`](#isdevelopment)
indicates if running in development mode | `get` | +| `string` | [`OperatingDirectory`](#operatingdirectory) | `get` | +| `Dictionary`<`Permission`, `string`> | [`PermissionLevelOverrides`](#permissionleveloverrides) | `get` | + +### Methods +#### Public Static methods +| Returns | Name | +| --- | --- | +| `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) | +| `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) | +| `string` | [`ConvertLevelToColor`](#convertleveltocolor)(`Permission` level, `string` localizedLevel) | +| `Nullable`<`int`> | [`ConvertToIP`](#converttoip)(`string` str) | +| `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` | [`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``[]` | [`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`<`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) | +| `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) | +| `int` | [`GetStableHashCode`](#getstablehashcode)(`string` str) | +| `Task`<[`IStatusResponse`](./sharedlibrarycoreinterfaces-IStatusResponse)> | [`GetStatusAsync`](#getstatusasync)([`Server`](./sharedlibrarycore-Server) 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) | +| `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` | [`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` | [`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 | +| `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) | +| `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) | +| `string` | [`PromptString`](#promptstring)(`string` question, `string` description, `string` defaultValue)
prompt use to enter a string response | +| `string` | [`RemoveDiacritics`](#removediacritics)(`string` text) | +| `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 | +| `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) | +| `float` | [`ToRadians`](#toradians)(`float` value) | +| `string` | [`ToStandardFormat`](#tostandardformat-12)(`...`) | +| `string` | [`ToTranslatedName`](#totranslatedname)([`MetaType`](./sharedlibrarycoreinterfaces-MetaType) 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`<`T`> | [`WithTimeout`](#withtimeout-12)(`...`) | +| `Task` | [`WithWaitCancellation`](#withwaitcancellation-12)(`...`)
https://www.planetgeek.ch/2016/12/08/async-method-without-cancellation-support-do-it-my-way/ | + +#### Internal Static methods +| Returns | Name | +| --- | --- | +| `string` | [`g__InputOrDefault|55_0`](#promptintginputordefault550)() | +| `string` | [`g__InputOrDefault|56_0`](#promptstringginputordefault560)() | + +## Details +### Methods +#### ToStandardFormat [1/2] +```csharp +public static string ToStandardFormat(Nullable time) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `Nullable`<`DateTime`> | time | | + +#### ToStandardFormat [2/2] +```csharp +public static string ToStandardFormat(DateTime time) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `DateTime` | time | | + +#### IW4MAdminClient +```csharp +public static EFClient IW4MAdminClient(Server server) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| [`Server`](./sharedlibrarycore-Server) | server | | + +#### AsConsoleClient +```csharp +public static EFClient AsConsoleClient(IGameServer server) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| [`IGameServer`](./sharedlibrarycoreinterfaces-IGameServer) | server | | + +#### RemoveWords +```csharp +public static string RemoveWords(string str, int num) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `string` | str | | +| `int` | num | | + +#### CapClientName +```csharp +public static string CapClientName(string name, int maxLength) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `string` | name | client name | +| `int` | maxLength | max number of characters for the name | + +##### Summary +caps client name to the specified character length - 3 + and adds ellipses to the end of the remaining client name + +##### Returns + + +#### MatchPermission +```csharp +public static Permission MatchPermission(string str) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `string` | str | | + +#### StripColors +```csharp +public static string StripColors(string str) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `string` | str | String containing color codes | + +##### Summary +Remove all IW Engine color codes + +##### Returns + + +#### FixIW4ForwardSlash +```csharp +public static string FixIW4ForwardSlash(string str) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `string` | str | | + +##### Summary +returns a "fixed" string that prevents message truncation in IW4 (and probably other Q3 clients) + +##### Returns + + +#### RemoveDiacritics +```csharp +public static string RemoveDiacritics(string text) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `string` | text | | + +#### FormatMessageForEngine +```csharp +public static string FormatMessageForEngine(string str, IRConParserConfiguration config) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `string` | str | | +| [`IRConParserConfiguration`](./sharedlibrarycoreinterfaces-IRConParserConfiguration) | config | | + +#### IsZombieServer +```csharp +public static bool IsZombieServer(Server server) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| [`Server`](./sharedlibrarycore-Server) | server | | + +##### Summary +indicates if the given server is running a zombie game mode + +##### Returns + + +#### IsCodGame +```csharp +public static bool IsCodGame(Server server) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| [`Server`](./sharedlibrarycore-Server) | server | | + +#### ConvertLevelToColor +```csharp +public static string ConvertLevelToColor(Permission level, string localizedLevel) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `Permission` | level | | +| `string` | localizedLevel | | + +#### ToLocalizedLevelName +```csharp +public static string ToLocalizedLevelName(Permission permission) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `Permission` | permission | | + +#### ProcessMessageToken +```csharp +public static async Task ProcessMessageToken(Server server, IList tokens, string str) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| [`Server`](./sharedlibrarycore-Server) | server | | +| `IList`<[`MessageToken`](./sharedlibrarycorehelpers-MessageToken)> | tokens | | +| `string` | str | | + +#### IsBroadcastCommand +```csharp +public static bool IsBroadcastCommand(string str, string broadcastCommandPrefix) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `string` | str | | +| `string` | broadcastCommandPrefix | | + +#### GetLocalizedGametype +```csharp +public static string GetLocalizedGametype(string input) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `string` | input | Shorthand gametype reported from server | + +##### Summary +Get the full gametype name + +##### Returns + + +#### ConvertGuidToLong [1/2] +```csharp +public static long ConvertGuidToLong(string str, NumberStyles numberStyle, Nullable fallback) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `string` | str | | +| `NumberStyles` | numberStyle | | +| `Nullable`<`long`> | fallback | | + +#### ConvertGuidToLong [2/2] +```csharp +public static long ConvertGuidToLong(string str, NumberStyles numberStyle, bool convertSigned, Nullable fallback) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `string` | str | | +| `NumberStyles` | numberStyle | | +| `bool` | convertSigned | | +| `Nullable`<`long`> | fallback | | + +#### IsBotGuid +```csharp +public static bool IsBotGuid(string guid) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `string` | guid | value of the guid | + +##### Summary +determines if the guid provided appears to be a bot guid + "1277538174" - (Pluto?)WaW (T4) + +##### Returns +true if is bot guid, otherwise false + +#### GenerateGuidFromString +```csharp +public static long GenerateGuidFromString(string value) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `string` | value | value string | + +##### Summary +generates a numerical hashcode from a string value + +##### Returns + + +#### GetStableHashCode +```csharp +public static int GetStableHashCode(string str) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `string` | str | | + +#### ConvertToIP +```csharp +public static Nullable ConvertToIP(string str) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `string` | str | | + +#### ConvertIPtoString +```csharp +public static string ConvertIPtoString(Nullable ip) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `Nullable`<`int`> | ip | | + +#### GetGame +```csharp +public static Game GetGame(string gameName) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `string` | gameName | | + +#### ParseTimespan +```csharp +public static TimeSpan ParseTimespan(string input) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `string` | input | | + +#### HasPermission [1/2] +```csharp +public static bool HasPermission(IEnumerable permissionsSet, TEntity entity, TPermission permission) +where TEntity : Enum +where TPermission : Enum +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `IEnumerable`<`string`> | permissionsSet | | +| `TEntity` | entity | | +| `TPermission` | permission | | + +#### HasPermission [2/2] +```csharp +public static bool HasPermission(ApplicationConfiguration appConfig, Permission permissionLevel, TEntity entity, TPermission permission) +where TEntity : Enum +where TPermission : Enum +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| [`ApplicationConfiguration`](./sharedlibrarycoreconfiguration-ApplicationConfiguration) | appConfig | | +| `Permission` | permissionLevel | | +| `TEntity` | entity | | +| `TPermission` | permission | | + +#### LinkedPenaltyTypes +```csharp +public static PenaltyType LinkedPenaltyTypes() +``` +##### Summary +returns a list of penalty types that should be shown across all profiles + +##### Returns + + +#### IsPrivileged +```csharp +public static bool IsPrivileged(EFClient p) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| [`EFClient`](./sharedlibrarycoredatabasemodels-EFClient) | p | | + +##### Summary +Helper extension that determines if a user is a privileged client + +##### Returns + + +#### PromptBool +```csharp +public static bool PromptBool(string question, string description, bool defaultValue) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `string` | question | question to prompt the user with | +| `string` | description | description of the question's value | +| `bool` | defaultValue | default value to set if no input is entered | + +##### Summary +prompt user to answer a yes/no question + +##### Returns + + +#### PromptSelection +```csharp +public static Tuple PromptSelection(string question, T defaultValue, string description, T[] selections) +where T : +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `string` | question | | +| `T` | defaultValue | | +| `string` | description | | +| `T``[]` | selections | | + +#### PromptInt +```csharp +public static int PromptInt(string question, string description, int minValue, int maxValue, Nullable defaultValue) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `string` | question | | +| `string` | description | | +| `int` | minValue | | +| `int` | maxValue | | +| `Nullable`<`int`> | defaultValue | | + +#### PromptString +```csharp +public static string PromptString(string question, string description, string defaultValue) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `string` | question | question to prompt with | +| `string` | description | description of the question's value | +| `string` | defaultValue | default value to set the return value to | + +##### Summary +prompt use to enter a string response + +##### Returns + + +#### DictionaryFromKeyValue +```csharp +public static Dictionary DictionaryFromKeyValue(string eventLine) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `string` | eventLine | | + +#### GetCommandLine +```csharp +public static string GetCommandLine(int pId) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `int` | pId | | + +#### IsRemoteLog +```csharp +public static bool IsRemoteLog(string log) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `string` | log | | + +##### Summary +indicates if the given log path is a remote (http) uri + +##### Returns + + +#### ToBase64UrlSafeString +```csharp +public static string ToBase64UrlSafeString(string src) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `string` | src | | + +#### GetDvarAsync [1/2] +```csharp +public static async Task> GetDvarAsync(Server server, string dvarName, T fallbackValue, CancellationToken token) +where T : +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| [`Server`](./sharedlibrarycore-Server) | server | | +| `string` | dvarName | | +| `T` | fallbackValue | | +| `CancellationToken` | token | | + +#### GetDvarAsync [2/2] +```csharp +public static async Task> GetDvarAsync(Server server, string dvarName, T fallbackValue) +where T : +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| [`Server`](./sharedlibrarycore-Server) | server | | +| `string` | dvarName | | +| `T` | fallbackValue | | + +#### GetMappedDvarValueOrDefaultAsync +```csharp +public static async Task> GetMappedDvarValueOrDefaultAsync(Server server, string dvarName, string infoResponseName, IDictionary infoResponse, T overrideDefault, CancellationToken token) +where T : +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| [`Server`](./sharedlibrarycore-Server) | server | | +| `string` | dvarName | | +| `string` | infoResponseName | | +| `IDictionary`<`string`, `string`> | infoResponse | | +| `T` | overrideDefault | | +| `CancellationToken` | token | | + +#### SetDvarAsync [1/2] +```csharp +public static async Task SetDvarAsync(Server server, string dvarName, object dvarValue, CancellationToken token) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| [`Server`](./sharedlibrarycore-Server) | server | | +| `string` | dvarName | | +| `object` | dvarValue | | +| `CancellationToken` | token | | + +#### SetDvarAsync [2/2] +```csharp +public static async Task SetDvarAsync(Server server, string dvarName, object dvarValue) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| [`Server`](./sharedlibrarycore-Server) | server | | +| `string` | dvarName | | +| `object` | dvarValue | | + +#### ExecuteCommandAsync [1/2] +```csharp +public static async Task ExecuteCommandAsync(Server server, string commandName, CancellationToken token) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| [`Server`](./sharedlibrarycore-Server) | server | | +| `string` | commandName | | +| `CancellationToken` | token | | + +#### ExecuteCommandAsync [2/2] +```csharp +public static async Task ExecuteCommandAsync(Server server, string commandName) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| [`Server`](./sharedlibrarycore-Server) | server | | +| `string` | commandName | | + +#### GetStatusAsync +```csharp +public static async Task GetStatusAsync(Server server, CancellationToken token) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| [`Server`](./sharedlibrarycore-Server) | server | | +| `CancellationToken` | token | | + +#### GetInfoAsync +```csharp +public static async Task> GetInfoAsync(Server server, Nullable delay) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| [`Server`](./sharedlibrarycore-Server) | server | | +| `Nullable`<`TimeSpan`> | delay | | + +#### GetVersionAsDouble +```csharp +public static double GetVersionAsDouble() +``` + +#### GetVersionAsString +```csharp +public static string GetVersionAsString() +``` + +#### FormatExt +```csharp +public static string FormatExt(string input, object[] values) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `string` | input | | +| `object``[]` | values | | + +#### IsInternal +```csharp +public static bool IsInternal(IPAddress toTest) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `IPAddress` | toTest | The IP address that will be tested | + +##### Summary +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 + +##### Returns +Returns true if the IP is internal, false if it is external + +#### GetExternalIP +```csharp +public static async Task GetExternalIP() +``` +##### Summary +retrieves the external IP address of the current running machine + +##### Returns + + +#### IsQuickMessage +```csharp +public static bool IsQuickMessage(string message) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `string` | message | | + +##### Summary +Determines if the given message is a quick message + +##### Returns +true if the + +#### TrimNewLine +```csharp +public static string TrimNewLine(string str) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `string` | str | source string | + +##### Summary +trims new line and whitespace from string + +##### Returns + + +#### FixIW4Angles +```csharp +public static Vector3 FixIW4Angles(Vector3 vector) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `Vector3` | vector | | + +#### ToRadians +```csharp +public static float ToRadians(float value) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `float` | value | | + +#### ToDegrees +```csharp +public static float ToDegrees(float value) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `float` | value | | + +#### AngleStuff +```csharp +public static double AngleStuff(Vector3 a, Vector3 b) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `Vector3` | a | | +| `Vector3` | b | | + +#### TryCreatePenalty +```csharp +public static async Task TryCreatePenalty(EFPenalty penalty, IEntityService penaltyService, ILogger logger) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `EFPenalty` | penalty | | +| [`IEntityService`](./sharedlibrarycoreinterfaces-IEntityServiceT)<`EFPenalty`> | penaltyService | | +| `ILogger` | logger | | + +#### WithWaitCancellation [1/2] +```csharp +public static async Task WithWaitCancellation(Task task, CancellationToken cancellationToken) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `Task` | task | | +| `CancellationToken` | cancellationToken | | + +##### Summary +https://www.planetgeek.ch/2016/12/08/async-method-without-cancellation-support-do-it-my-way/ + +#### WithWaitCancellation [2/2] +```csharp +public static async Task WithWaitCancellation(Task task, CancellationToken cancellationToken) +where T : +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `Task`<`T`> | task | | +| `CancellationToken` | cancellationToken | | + +#### WithTimeout [1/2] +```csharp +public static async Task WithTimeout(Task task, TimeSpan timeout) +where T : +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `Task`<`T`> | task | | +| `TimeSpan` | timeout | | + +#### WithTimeout [2/2] +```csharp +public static async Task WithTimeout(Task task, TimeSpan timeout) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `Task` | task | | +| `TimeSpan` | timeout | | + +#### ShouldHideLevel +```csharp +public static bool ShouldHideLevel(Permission perm) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `Permission` | perm | | + +#### SplitTranslationTokens +```csharp +public static WebfrontTranslationHelper SplitTranslationTokens(string translationKey) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `string` | translationKey | key for translation lookup | + +##### Summary +parses translation string into tokens that are able to be formatted by the webfront + +##### Returns + + +#### FixDirectoryCharacters +```csharp +public static string FixDirectoryCharacters(string path) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `string` | path | original file path | + +##### Summary +replaces any directory separator chars with the platform specific character + +##### Returns + + +#### HumanizeForCurrentCulture [1/2] +```csharp +public static string HumanizeForCurrentCulture(TimeSpan timeSpan, int precision, TimeUnit maxUnit, TimeUnit minUnit, string collectionSeparator, bool toWords) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `TimeSpan` | timeSpan | | +| `int` | precision | | +| `TimeUnit` | maxUnit | | +| `TimeUnit` | minUnit | | +| `string` | collectionSeparator | | +| `bool` | toWords | | + +##### Summary +wrapper method for humanizee that uses current current culture + +#### HumanizeForCurrentCulture [2/2] +```csharp +public static string HumanizeForCurrentCulture(DateTime input, bool utcDate, Nullable dateToCompareAgainst, CultureInfo culture) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `DateTime` | input | | +| `bool` | utcDate | | +| `Nullable`<`DateTime`> | dateToCompareAgainst | | +| `CultureInfo` | culture | | + +#### ToTranslatedName +```csharp +public static string ToTranslatedName(MetaType metaType) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| [`MetaType`](./sharedlibrarycoreinterfaces-MetaType) | metaType | | + +#### ToPartialClient +```csharp +public static EFClient ToPartialClient(EFClient client) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `EFClient` | client | | + +#### ToNumericalString [1/4] +```csharp +public static string ToNumericalString(Nullable value) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `Nullable`<`int`> | value | | + +#### ToNumericalString [2/4] +```csharp +public static string ToNumericalString(int value) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `int` | value | | + +#### ToNumericalString [3/4] +```csharp +public static string ToNumericalString(double value, int precision) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `double` | value | | +| `int` | precision | | + +#### ToNumericalString [4/4] +```csharp +public static string ToNumericalString(Nullable value, int precision) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `Nullable`<`double`> | value | | +| `int` | precision | | + +#### FragmentMessageForDisplay +```csharp +public static string FragmentMessageForDisplay(string message) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `string` | message | | + +#### FindRuleForReason +```csharp +public static string FindRuleForReason(string reason, ApplicationConfiguration appConfig, Server server) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `string` | reason | | +| [`ApplicationConfiguration`](./sharedlibrarycoreconfiguration-ApplicationConfiguration) | appConfig | | +| [`Server`](./sharedlibrarycore-Server) | server | | + +#### MakeAbbreviation +```csharp +public static string MakeAbbreviation(string gameName) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `string` | gameName | | + +#### AddConfiguration +```csharp +public static IServiceCollection AddConfiguration(IServiceCollection serviceCollection, string fileName, TConfigurationType defaultConfig) +where TConfigurationType : +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `IServiceCollection` | serviceCollection | | +| `string` | fileName | | +| `TConfigurationType` | defaultConfig | | + +#### ExecuteAfterDelay [1/3] +```csharp +public static void ExecuteAfterDelay(TimeSpan duration, Func action, CancellationToken token) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `TimeSpan` | duration | | +| `Func`<`CancellationToken`, `Task`> | action | | +| `CancellationToken` | token | | + +#### ExecuteAfterDelay [2/3] +```csharp +public static void ExecuteAfterDelay(int delayMs, Func action, CancellationToken token) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `int` | delayMs | | +| `Func`<`CancellationToken`, `Task`> | action | | +| `CancellationToken` | token | | + +#### ExecuteAfterDelay [3/3] +```csharp +public static void ExecuteAfterDelay(Func action, int delayMs, CancellationToken token) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `Func`<`CancellationToken`, `Task`> | action | | +| `int` | delayMs | | +| `CancellationToken` | token | | + +#### g__InputOrDefault|55_0 +```csharp +internal static string g__InputOrDefault|55_0() +``` + +#### g__InputOrDefault|56_0 +```csharp +internal static string g__InputOrDefault|56_0() +``` + +### Properties +#### DefaultLogger +```csharp +public static ILogger DefaultLogger { get; set; } +``` + +#### OperatingDirectory +```csharp +public static string OperatingDirectory { get; } +``` + +#### DefaultCommandTimeout +```csharp +public static TimeSpan DefaultCommandTimeout { get; set; } +``` + +#### CommandPrefix +```csharp +public static char CommandPrefix { get; set; } +``` + +#### PermissionLevelOverrides +```csharp +public static Dictionary PermissionLevelOverrides { get; } +``` + +#### IsDevelopment +```csharp +public static bool IsDevelopment { get; } +``` +##### Summary +indicates if running in development mode + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycorealerts-Alert.md b/CodeDocumentation/SharedLibraryCore/sharedlibrarycorealerts-Alert.md new file mode 100644 index 0000000..42ab3c8 --- /dev/null +++ b/CodeDocumentation/SharedLibraryCore/sharedlibrarycorealerts-Alert.md @@ -0,0 +1,27 @@ +# Alert `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph SharedLibraryCore.Alerts + SharedLibraryCore.Alerts.Alert[[Alert]] + end +``` + +## Details +### Nested types +#### Enums + - `AlertCategory` + +#### Classes + - `AlertState` + +### Constructors +#### Alert +```csharp +public Alert() +``` + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycorealertsalert-AlertCategory.md b/CodeDocumentation/SharedLibraryCore/sharedlibrarycorealertsalert-AlertCategory.md new file mode 100644 index 0000000..5aeea04 --- /dev/null +++ b/CodeDocumentation/SharedLibraryCore/sharedlibrarycorealertsalert-AlertCategory.md @@ -0,0 +1,27 @@ +# AlertCategory `Public enum` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph SharedLibraryCore.Alerts.Alert + SharedLibraryCore.Alerts.Alert.AlertCategory[[AlertCategory]] + end +``` + +## Details +### Fields +#### Information + + +#### Warning + + +#### Error + + +#### Message + + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycorealertsalert-AlertState.md b/CodeDocumentation/SharedLibraryCore/sharedlibrarycorealertsalert-AlertState.md new file mode 100644 index 0000000..c320c88 --- /dev/null +++ b/CodeDocumentation/SharedLibraryCore/sharedlibrarycorealertsalert-AlertState.md @@ -0,0 +1,117 @@ +# AlertState `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph SharedLibraryCore.Alerts.Alert + SharedLibraryCore.Alerts.Alert.AlertState[[AlertState]] + end +``` + +## Members +### Properties +#### Public properties +| Type | Name | Methods | +| --- | --- | --- | +| `Guid` | [`AlertId`](#alertid) | `get` | +| `AlertCategory` | [`Category`](#category) | `get, set` | +| `Nullable`<`bool`> | [`Consumed`](#consumed) | `get, set` | +| `Nullable`<`bool`> | [`Delivered`](#delivered) | `get, set` | +| `Nullable`<`DateTime`> | [`ExpiresAt`](#expiresat) | `get, set` | +| `string` | [`Message`](#message) | `get, set` | +| `Nullable`<`Permission`> | [`MinimumPermission`](#minimumpermission) | `get, set` | +| `DateTime` | [`OccuredAt`](#occuredat) | `get, set` | +| `Nullable`<`int`> | [`RecipientId`](#recipientid) | `get, set` | +| `Nullable`<`int`> | [`ReferenceId`](#referenceid) | `get, set` | +| `string` | [`Source`](#source) | `get, set` | +| `Nullable`<`int`> | [`SourceId`](#sourceid) | `get, set` | +| `string` | [`Type`](#type) | `get, set` | + +### Methods +#### Public Static methods +| Returns | Name | +| --- | --- | +| `AlertState` | [`Build`](#build)() | + +## Details +### Constructors +#### AlertState +```csharp +public AlertState() +``` + +### Methods +#### Build +```csharp +public static AlertState Build() +``` + +### Properties +#### AlertId +```csharp +public Guid AlertId { get; } +``` + +#### Category +```csharp +public AlertCategory Category { get; set; } +``` + +#### OccuredAt +```csharp +public DateTime OccuredAt { get; set; } +``` + +#### ExpiresAt +```csharp +public Nullable ExpiresAt { get; set; } +``` + +#### Message +```csharp +public string Message { get; set; } +``` + +#### Source +```csharp +public string Source { get; set; } +``` + +#### RecipientId +```csharp +public Nullable RecipientId { get; set; } +``` + +#### SourceId +```csharp +public Nullable SourceId { get; set; } +``` + +#### ReferenceId +```csharp +public Nullable ReferenceId { get; set; } +``` + +#### Delivered +```csharp +public Nullable Delivered { get; set; } +``` + +#### Consumed +```csharp +public Nullable Consumed { get; set; } +``` + +#### MinimumPermission +```csharp +public Nullable MinimumPermission { get; set; } +``` + +#### Type +```csharp +public string Type { get; set; } +``` + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycorecommands-BanCommand.md b/CodeDocumentation/SharedLibraryCore/sharedlibrarycorecommands-BanCommand.md new file mode 100644 index 0000000..a4e78aa --- /dev/null +++ b/CodeDocumentation/SharedLibraryCore/sharedlibrarycorecommands-BanCommand.md @@ -0,0 +1,59 @@ +# BanCommand `Public class` + +## Description +Permanently bans a client + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph SharedLibraryCore.Commands + SharedLibraryCore.Commands.BanCommand[[BanCommand]] + end + subgraph SharedLibraryCore + SharedLibraryCore.Command[[Command]] + class SharedLibraryCore.Command abstractStyle; + end +SharedLibraryCore.Command --> SharedLibraryCore.Commands.BanCommand +``` + +## Members +### Methods +#### Public methods +| Returns | Name | +| --- | --- | +| `Task` | [`ExecuteAsync`](#executeasync)([`GameEvent`](./sharedlibrarycore-GameEvent) gameEvent) | + +## Details +### Summary +Permanently bans a client + +### Inheritance + - [ +`Command` +](./sharedlibrarycore-Command) + +### Constructors +#### BanCommand +```csharp +public BanCommand(ApplicationConfiguration appConfig, CommandConfiguration config, ITranslationLookup translationLookup) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| [`ApplicationConfiguration`](./sharedlibrarycoreconfiguration-ApplicationConfiguration) | appConfig | | +| [`CommandConfiguration`](./sharedlibrarycoreconfiguration-CommandConfiguration) | config | | +| [`ITranslationLookup`](./sharedlibrarycoreinterfaces-ITranslationLookup) | translationLookup | | + +### Methods +#### ExecuteAsync +```csharp +public override async Task ExecuteAsync(GameEvent gameEvent) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| [`GameEvent`](./sharedlibrarycore-GameEvent) | gameEvent | | + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycorecommands-CommandArgument.md b/CodeDocumentation/SharedLibraryCore/sharedlibrarycorecommands-CommandArgument.md new file mode 100644 index 0000000..027b470 --- /dev/null +++ b/CodeDocumentation/SharedLibraryCore/sharedlibrarycorecommands-CommandArgument.md @@ -0,0 +1,49 @@ +# CommandArgument `Public class` + +## Description +Holds information about command args + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph SharedLibraryCore.Commands + SharedLibraryCore.Commands.CommandArgument[[CommandArgument]] + end +``` + +## Members +### Properties +#### Public properties +| Type | Name | Methods | +| --- | --- | --- | +| `string` | [`Name`](#name)
Name of the argument | `get, set` | +| `bool` | [`Required`](#required)
Indicates if the argument is required | `get, set` | + +## Details +### Summary +Holds information about command args + +### Constructors +#### CommandArgument +```csharp +public CommandArgument() +``` + +### Properties +#### Name +```csharp +public string Name { get; set; } +``` +##### Summary +Name of the argument + +#### Required +```csharp +public bool Required { get; set; } +``` +##### Summary +Indicates if the argument is required + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycorecommands-CommandExtensions.md b/CodeDocumentation/SharedLibraryCore/sharedlibrarycorecommands-CommandExtensions.md new file mode 100644 index 0000000..575683e --- /dev/null +++ b/CodeDocumentation/SharedLibraryCore/sharedlibrarycorecommands-CommandExtensions.md @@ -0,0 +1,41 @@ +# CommandExtensions `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph SharedLibraryCore.Commands + SharedLibraryCore.Commands.CommandExtensions[[CommandExtensions]] + end +``` + +## Members +### Methods +#### Public Static methods +| Returns | Name | +| --- | --- | +| `bool` | [`CanPerformActionOnTarget`](#canperformactionontarget)([`GameEvent`](./sharedlibrarycore-GameEvent) gameEvent) | +| `bool` | [`IsTargetingSelf`](#istargetingself)([`GameEvent`](./sharedlibrarycore-GameEvent) gameEvent) | + +## Details +### Methods +#### IsTargetingSelf +```csharp +public static bool IsTargetingSelf(GameEvent gameEvent) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| [`GameEvent`](./sharedlibrarycore-GameEvent) | gameEvent | | + +#### CanPerformActionOnTarget +```csharp +public static bool CanPerformActionOnTarget(GameEvent gameEvent) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| [`GameEvent`](./sharedlibrarycore-GameEvent) | gameEvent | | + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycorecommands-CommandProcessing.md b/CodeDocumentation/SharedLibraryCore/sharedlibrarycorecommands-CommandProcessing.md new file mode 100644 index 0000000..02ef6bb --- /dev/null +++ b/CodeDocumentation/SharedLibraryCore/sharedlibrarycorecommands-CommandProcessing.md @@ -0,0 +1,39 @@ +# CommandProcessing `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph SharedLibraryCore.Commands + SharedLibraryCore.Commands.CommandProcessing[[CommandProcessing]] + end +``` + +## Members +### Methods +#### Public Static methods +| Returns | Name | +| --- | --- | +| `Task`<[`Command`](./sharedlibrarycore-Command)> | [`ValidateCommand`](#validatecommand)([`GameEvent`](./sharedlibrarycore-GameEvent) gameEvent, [`ApplicationConfiguration`](./sharedlibrarycoreconfiguration-ApplicationConfiguration) appConfig, [`CommandConfiguration`](./sharedlibrarycoreconfiguration-CommandConfiguration) commandConfig) | + +## Details +### Constructors +#### CommandProcessing +```csharp +public CommandProcessing() +``` + +### Methods +#### ValidateCommand +```csharp +public static async Task ValidateCommand(GameEvent gameEvent, ApplicationConfiguration appConfig, CommandConfiguration commandConfig) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| [`GameEvent`](./sharedlibrarycore-GameEvent) | gameEvent | | +| [`ApplicationConfiguration`](./sharedlibrarycoreconfiguration-ApplicationConfiguration) | appConfig | | +| [`CommandConfiguration`](./sharedlibrarycoreconfiguration-CommandConfiguration) | commandConfig | | + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycorecommands-ExecuteRConCommand.md b/CodeDocumentation/SharedLibraryCore/sharedlibrarycorecommands-ExecuteRConCommand.md new file mode 100644 index 0000000..be1d6aa --- /dev/null +++ b/CodeDocumentation/SharedLibraryCore/sharedlibrarycorecommands-ExecuteRConCommand.md @@ -0,0 +1,58 @@ +# ExecuteRConCommand `Public class` + +## Description +Executes RCon command + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph SharedLibraryCore.Commands + SharedLibraryCore.Commands.ExecuteRConCommand[[ExecuteRConCommand]] + end + subgraph SharedLibraryCore + SharedLibraryCore.Command[[Command]] + class SharedLibraryCore.Command abstractStyle; + end +SharedLibraryCore.Command --> SharedLibraryCore.Commands.ExecuteRConCommand +``` + +## Members +### Methods +#### Public methods +| Returns | Name | +| --- | --- | +| `Task` | [`ExecuteAsync`](#executeasync)([`GameEvent`](./sharedlibrarycore-GameEvent) E) | + +## Details +### Summary +Executes RCon command + +### Inheritance + - [ +`Command` +](./sharedlibrarycore-Command) + +### Constructors +#### ExecuteRConCommand +```csharp +public ExecuteRConCommand(CommandConfiguration config, ITranslationLookup translationLookup) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| [`CommandConfiguration`](./sharedlibrarycoreconfiguration-CommandConfiguration) | config | | +| [`ITranslationLookup`](./sharedlibrarycoreinterfaces-ITranslationLookup) | translationLookup | | + +### Methods +#### ExecuteAsync +```csharp +public override async Task ExecuteAsync(GameEvent E) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| [`GameEvent`](./sharedlibrarycore-GameEvent) | E | | + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycorecommands-FastRestartCommand.md b/CodeDocumentation/SharedLibraryCore/sharedlibrarycorecommands-FastRestartCommand.md new file mode 100644 index 0000000..237a0ef --- /dev/null +++ b/CodeDocumentation/SharedLibraryCore/sharedlibrarycorecommands-FastRestartCommand.md @@ -0,0 +1,58 @@ +# FastRestartCommand `Public class` + +## Description +Fast restarts the map + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph SharedLibraryCore.Commands + SharedLibraryCore.Commands.FastRestartCommand[[FastRestartCommand]] + end + subgraph SharedLibraryCore + SharedLibraryCore.Command[[Command]] + class SharedLibraryCore.Command abstractStyle; + end +SharedLibraryCore.Command --> SharedLibraryCore.Commands.FastRestartCommand +``` + +## Members +### Methods +#### Public methods +| Returns | Name | +| --- | --- | +| `Task` | [`ExecuteAsync`](#executeasync)([`GameEvent`](./sharedlibrarycore-GameEvent) E) | + +## Details +### Summary +Fast restarts the map + +### Inheritance + - [ +`Command` +](./sharedlibrarycore-Command) + +### Constructors +#### FastRestartCommand +```csharp +public FastRestartCommand(CommandConfiguration config, ITranslationLookup translationLookup) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| [`CommandConfiguration`](./sharedlibrarycoreconfiguration-CommandConfiguration) | config | | +| [`ITranslationLookup`](./sharedlibrarycoreinterfaces-ITranslationLookup) | translationLookup | | + +### Methods +#### ExecuteAsync +```csharp +public override async Task ExecuteAsync(GameEvent E) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| [`GameEvent`](./sharedlibrarycore-GameEvent) | E | | + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycorecommands-FlagClientCommand.md b/CodeDocumentation/SharedLibraryCore/sharedlibrarycorecommands-FlagClientCommand.md new file mode 100644 index 0000000..0bb38d2 --- /dev/null +++ b/CodeDocumentation/SharedLibraryCore/sharedlibrarycorecommands-FlagClientCommand.md @@ -0,0 +1,58 @@ +# FlagClientCommand `Public class` + +## Description +Flag given client for specified reason + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph SharedLibraryCore.Commands + SharedLibraryCore.Commands.FlagClientCommand[[FlagClientCommand]] + end + subgraph SharedLibraryCore + SharedLibraryCore.Command[[Command]] + class SharedLibraryCore.Command abstractStyle; + end +SharedLibraryCore.Command --> SharedLibraryCore.Commands.FlagClientCommand +``` + +## Members +### Methods +#### Public methods +| Returns | Name | +| --- | --- | +| `Task` | [`ExecuteAsync`](#executeasync)([`GameEvent`](./sharedlibrarycore-GameEvent) E) | + +## Details +### Summary +Flag given client for specified reason + +### Inheritance + - [ +`Command` +](./sharedlibrarycore-Command) + +### Constructors +#### FlagClientCommand +```csharp +public FlagClientCommand(CommandConfiguration config, ITranslationLookup translationLookup) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| [`CommandConfiguration`](./sharedlibrarycoreconfiguration-CommandConfiguration) | config | | +| [`ITranslationLookup`](./sharedlibrarycoreinterfaces-ITranslationLookup) | translationLookup | | + +### Methods +#### ExecuteAsync +```csharp +public override async Task ExecuteAsync(GameEvent E) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| [`GameEvent`](./sharedlibrarycore-GameEvent) | E | | + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycorecommands-GetClientPingCommand.md b/CodeDocumentation/SharedLibraryCore/sharedlibrarycorecommands-GetClientPingCommand.md new file mode 100644 index 0000000..fea7b38 --- /dev/null +++ b/CodeDocumentation/SharedLibraryCore/sharedlibrarycorecommands-GetClientPingCommand.md @@ -0,0 +1,58 @@ +# GetClientPingCommand `Public class` + +## Description +Gets the ping of a client + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph SharedLibraryCore.Commands + SharedLibraryCore.Commands.GetClientPingCommand[[GetClientPingCommand]] + end + subgraph SharedLibraryCore + SharedLibraryCore.Command[[Command]] + class SharedLibraryCore.Command abstractStyle; + end +SharedLibraryCore.Command --> SharedLibraryCore.Commands.GetClientPingCommand +``` + +## Members +### Methods +#### Public methods +| Returns | Name | +| --- | --- | +| `Task` | [`ExecuteAsync`](#executeasync)([`GameEvent`](./sharedlibrarycore-GameEvent) E) | + +## Details +### Summary +Gets the ping of a client + +### Inheritance + - [ +`Command` +](./sharedlibrarycore-Command) + +### Constructors +#### GetClientPingCommand +```csharp +public GetClientPingCommand(CommandConfiguration config, ITranslationLookup translationLookup) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| [`CommandConfiguration`](./sharedlibrarycoreconfiguration-CommandConfiguration) | config | | +| [`ITranslationLookup`](./sharedlibrarycoreinterfaces-ITranslationLookup) | translationLookup | | + +### Methods +#### ExecuteAsync +```csharp +public override Task ExecuteAsync(GameEvent E) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| [`GameEvent`](./sharedlibrarycore-GameEvent) | E | | + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycorecommands-KickCommand.md b/CodeDocumentation/SharedLibraryCore/sharedlibrarycorecommands-KickCommand.md new file mode 100644 index 0000000..f367105 --- /dev/null +++ b/CodeDocumentation/SharedLibraryCore/sharedlibrarycorecommands-KickCommand.md @@ -0,0 +1,59 @@ +# KickCommand `Public class` + +## Description +Kicks client for given reason + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph SharedLibraryCore.Commands + SharedLibraryCore.Commands.KickCommand[[KickCommand]] + end + subgraph SharedLibraryCore + SharedLibraryCore.Command[[Command]] + class SharedLibraryCore.Command abstractStyle; + end +SharedLibraryCore.Command --> SharedLibraryCore.Commands.KickCommand +``` + +## Members +### Methods +#### Public methods +| Returns | Name | +| --- | --- | +| `Task` | [`ExecuteAsync`](#executeasync)([`GameEvent`](./sharedlibrarycore-GameEvent) gameEvent) | + +## Details +### Summary +Kicks client for given reason + +### Inheritance + - [ +`Command` +](./sharedlibrarycore-Command) + +### Constructors +#### KickCommand +```csharp +public KickCommand(ApplicationConfiguration appConfig, CommandConfiguration config, ITranslationLookup translationLookup) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| [`ApplicationConfiguration`](./sharedlibrarycoreconfiguration-ApplicationConfiguration) | appConfig | | +| [`CommandConfiguration`](./sharedlibrarycoreconfiguration-CommandConfiguration) | config | | +| [`ITranslationLookup`](./sharedlibrarycoreinterfaces-ITranslationLookup) | translationLookup | | + +### Methods +#### ExecuteAsync +```csharp +public override async Task ExecuteAsync(GameEvent gameEvent) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| [`GameEvent`](./sharedlibrarycore-GameEvent) | gameEvent | | + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycorecommands-ListBanInfoCommand.md b/CodeDocumentation/SharedLibraryCore/sharedlibrarycorecommands-ListBanInfoCommand.md new file mode 100644 index 0000000..b1eb151 --- /dev/null +++ b/CodeDocumentation/SharedLibraryCore/sharedlibrarycorecommands-ListBanInfoCommand.md @@ -0,0 +1,58 @@ +# ListBanInfoCommand `Public class` + +## Description +Lists ban information for given client + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph SharedLibraryCore.Commands + SharedLibraryCore.Commands.ListBanInfoCommand[[ListBanInfoCommand]] + end + subgraph SharedLibraryCore + SharedLibraryCore.Command[[Command]] + class SharedLibraryCore.Command abstractStyle; + end +SharedLibraryCore.Command --> SharedLibraryCore.Commands.ListBanInfoCommand +``` + +## Members +### Methods +#### Public methods +| Returns | Name | +| --- | --- | +| `Task` | [`ExecuteAsync`](#executeasync)([`GameEvent`](./sharedlibrarycore-GameEvent) E) | + +## Details +### Summary +Lists ban information for given client + +### Inheritance + - [ +`Command` +](./sharedlibrarycore-Command) + +### Constructors +#### ListBanInfoCommand +```csharp +public ListBanInfoCommand(CommandConfiguration config, ITranslationLookup translationLookup) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| [`CommandConfiguration`](./sharedlibrarycoreconfiguration-CommandConfiguration) | config | | +| [`ITranslationLookup`](./sharedlibrarycoreinterfaces-ITranslationLookup) | translationLookup | | + +### Methods +#### ExecuteAsync +```csharp +public override async Task ExecuteAsync(GameEvent E) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| [`GameEvent`](./sharedlibrarycore-GameEvent) | E | | + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycorecommands-ListExternalIPCommand.md b/CodeDocumentation/SharedLibraryCore/sharedlibrarycorecommands-ListExternalIPCommand.md new file mode 100644 index 0000000..b5ac9ef --- /dev/null +++ b/CodeDocumentation/SharedLibraryCore/sharedlibrarycorecommands-ListExternalIPCommand.md @@ -0,0 +1,58 @@ +# ListExternalIPCommand `Public class` + +## Description +Lists external IP + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph SharedLibraryCore.Commands + SharedLibraryCore.Commands.ListExternalIPCommand[[ListExternalIPCommand]] + end + subgraph SharedLibraryCore + SharedLibraryCore.Command[[Command]] + class SharedLibraryCore.Command abstractStyle; + end +SharedLibraryCore.Command --> SharedLibraryCore.Commands.ListExternalIPCommand +``` + +## Members +### Methods +#### Public methods +| Returns | Name | +| --- | --- | +| `Task` | [`ExecuteAsync`](#executeasync)([`GameEvent`](./sharedlibrarycore-GameEvent) E) | + +## Details +### Summary +Lists external IP + +### Inheritance + - [ +`Command` +](./sharedlibrarycore-Command) + +### Constructors +#### ListExternalIPCommand +```csharp +public ListExternalIPCommand(CommandConfiguration config, ITranslationLookup translationLookup) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| [`CommandConfiguration`](./sharedlibrarycoreconfiguration-CommandConfiguration) | config | | +| [`ITranslationLookup`](./sharedlibrarycoreinterfaces-ITranslationLookup) | translationLookup | | + +### Methods +#### ExecuteAsync +```csharp +public override Task ExecuteAsync(GameEvent E) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| [`GameEvent`](./sharedlibrarycore-GameEvent) | E | | + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycorecommands-ListRulesCommands.md b/CodeDocumentation/SharedLibraryCore/sharedlibrarycorecommands-ListRulesCommands.md new file mode 100644 index 0000000..daae544 --- /dev/null +++ b/CodeDocumentation/SharedLibraryCore/sharedlibrarycorecommands-ListRulesCommands.md @@ -0,0 +1,58 @@ +# ListRulesCommands `Public class` + +## Description +Lists server and global rules + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph SharedLibraryCore.Commands + SharedLibraryCore.Commands.ListRulesCommands[[ListRulesCommands]] + end + subgraph SharedLibraryCore + SharedLibraryCore.Command[[Command]] + class SharedLibraryCore.Command abstractStyle; + end +SharedLibraryCore.Command --> SharedLibraryCore.Commands.ListRulesCommands +``` + +## Members +### Methods +#### Public methods +| Returns | Name | +| --- | --- | +| `Task` | [`ExecuteAsync`](#executeasync)([`GameEvent`](./sharedlibrarycore-GameEvent) gameEvent) | + +## Details +### Summary +Lists server and global rules + +### Inheritance + - [ +`Command` +](./sharedlibrarycore-Command) + +### Constructors +#### ListRulesCommands +```csharp +public ListRulesCommands(CommandConfiguration config, ITranslationLookup translationLookup) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| [`CommandConfiguration`](./sharedlibrarycoreconfiguration-CommandConfiguration) | config | | +| [`ITranslationLookup`](./sharedlibrarycoreinterfaces-ITranslationLookup) | translationLookup | | + +### Methods +#### ExecuteAsync +```csharp +public override async Task ExecuteAsync(GameEvent gameEvent) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| [`GameEvent`](./sharedlibrarycore-GameEvent) | gameEvent | | + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycorecommands-LoadMapCommand.md b/CodeDocumentation/SharedLibraryCore/sharedlibrarycorecommands-LoadMapCommand.md new file mode 100644 index 0000000..6d895aa --- /dev/null +++ b/CodeDocumentation/SharedLibraryCore/sharedlibrarycorecommands-LoadMapCommand.md @@ -0,0 +1,58 @@ +# LoadMapCommand `Public class` + +## Description +Attempts to load the specified map + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph SharedLibraryCore.Commands + SharedLibraryCore.Commands.LoadMapCommand[[LoadMapCommand]] + end + subgraph SharedLibraryCore + SharedLibraryCore.Command[[Command]] + class SharedLibraryCore.Command abstractStyle; + end +SharedLibraryCore.Command --> SharedLibraryCore.Commands.LoadMapCommand +``` + +## Members +### Methods +#### Public methods +| Returns | Name | +| --- | --- | +| `Task` | [`ExecuteAsync`](#executeasync)([`GameEvent`](./sharedlibrarycore-GameEvent) E) | + +## Details +### Summary +Attempts to load the specified map + +### Inheritance + - [ +`Command` +](./sharedlibrarycore-Command) + +### Constructors +#### LoadMapCommand +```csharp +public LoadMapCommand(CommandConfiguration config, ITranslationLookup translationLookup) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| [`CommandConfiguration`](./sharedlibrarycoreconfiguration-CommandConfiguration) | config | | +| [`ITranslationLookup`](./sharedlibrarycoreinterfaces-ITranslationLookup) | translationLookup | | + +### Methods +#### ExecuteAsync +```csharp +public override async Task ExecuteAsync(GameEvent E) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| [`GameEvent`](./sharedlibrarycore-GameEvent) | E | | + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycorecommands-MapRotateCommand.md b/CodeDocumentation/SharedLibraryCore/sharedlibrarycorecommands-MapRotateCommand.md new file mode 100644 index 0000000..7fda175 --- /dev/null +++ b/CodeDocumentation/SharedLibraryCore/sharedlibrarycorecommands-MapRotateCommand.md @@ -0,0 +1,58 @@ +# MapRotateCommand `Public class` + +## Description +Cycles to the next map in rotation + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph SharedLibraryCore.Commands + SharedLibraryCore.Commands.MapRotateCommand[[MapRotateCommand]] + end + subgraph SharedLibraryCore + SharedLibraryCore.Command[[Command]] + class SharedLibraryCore.Command abstractStyle; + end +SharedLibraryCore.Command --> SharedLibraryCore.Commands.MapRotateCommand +``` + +## Members +### Methods +#### Public methods +| Returns | Name | +| --- | --- | +| `Task` | [`ExecuteAsync`](#executeasync)([`GameEvent`](./sharedlibrarycore-GameEvent) E) | + +## Details +### Summary +Cycles to the next map in rotation + +### Inheritance + - [ +`Command` +](./sharedlibrarycore-Command) + +### Constructors +#### MapRotateCommand +```csharp +public MapRotateCommand(CommandConfiguration config, ITranslationLookup translationLookup) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| [`CommandConfiguration`](./sharedlibrarycoreconfiguration-CommandConfiguration) | config | | +| [`ITranslationLookup`](./sharedlibrarycoreinterfaces-ITranslationLookup) | translationLookup | | + +### Methods +#### ExecuteAsync +```csharp +public override async Task ExecuteAsync(GameEvent E) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| [`GameEvent`](./sharedlibrarycore-GameEvent) | E | | + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycorecommands-MaskCommand.md b/CodeDocumentation/SharedLibraryCore/sharedlibrarycorecommands-MaskCommand.md new file mode 100644 index 0000000..b6848b4 --- /dev/null +++ b/CodeDocumentation/SharedLibraryCore/sharedlibrarycorecommands-MaskCommand.md @@ -0,0 +1,58 @@ +# MaskCommand `Public class` + +## Description +Masks client from announcements and online admin list + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph SharedLibraryCore.Commands + SharedLibraryCore.Commands.MaskCommand[[MaskCommand]] + end + subgraph SharedLibraryCore + SharedLibraryCore.Command[[Command]] + class SharedLibraryCore.Command abstractStyle; + end +SharedLibraryCore.Command --> SharedLibraryCore.Commands.MaskCommand +``` + +## Members +### Methods +#### Public methods +| Returns | Name | +| --- | --- | +| `Task` | [`ExecuteAsync`](#executeasync)([`GameEvent`](./sharedlibrarycore-GameEvent) E) | + +## Details +### Summary +Masks client from announcements and online admin list + +### Inheritance + - [ +`Command` +](./sharedlibrarycore-Command) + +### Constructors +#### MaskCommand +```csharp +public MaskCommand(CommandConfiguration config, ITranslationLookup translationLookup) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| [`CommandConfiguration`](./sharedlibrarycoreconfiguration-CommandConfiguration) | config | | +| [`ITranslationLookup`](./sharedlibrarycoreinterfaces-ITranslationLookup) | translationLookup | | + +### Methods +#### ExecuteAsync +```csharp +public override async Task ExecuteAsync(GameEvent E) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| [`GameEvent`](./sharedlibrarycore-GameEvent) | E | | + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycorecommands-MemoryUsageCommand.md b/CodeDocumentation/SharedLibraryCore/sharedlibrarycorecommands-MemoryUsageCommand.md new file mode 100644 index 0000000..85e0fca --- /dev/null +++ b/CodeDocumentation/SharedLibraryCore/sharedlibrarycorecommands-MemoryUsageCommand.md @@ -0,0 +1,58 @@ +# MemoryUsageCommand `Public class` + +## Description +Prints the amount of memory IW4MAdmin is using + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph SharedLibraryCore.Commands + SharedLibraryCore.Commands.MemoryUsageCommand[[MemoryUsageCommand]] + end + subgraph SharedLibraryCore + SharedLibraryCore.Command[[Command]] + class SharedLibraryCore.Command abstractStyle; + end +SharedLibraryCore.Command --> SharedLibraryCore.Commands.MemoryUsageCommand +``` + +## Members +### Methods +#### Public methods +| Returns | Name | +| --- | --- | +| `Task` | [`ExecuteAsync`](#executeasync)([`GameEvent`](./sharedlibrarycore-GameEvent) E) | + +## Details +### Summary +Prints the amount of memory IW4MAdmin is using + +### Inheritance + - [ +`Command` +](./sharedlibrarycore-Command) + +### Constructors +#### MemoryUsageCommand +```csharp +public MemoryUsageCommand(CommandConfiguration config, ITranslationLookup translationLookup) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| [`CommandConfiguration`](./sharedlibrarycoreconfiguration-CommandConfiguration) | config | | +| [`ITranslationLookup`](./sharedlibrarycoreinterfaces-ITranslationLookup) | translationLookup | | + +### Methods +#### ExecuteAsync +```csharp +public override Task ExecuteAsync(GameEvent E) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| [`GameEvent`](./sharedlibrarycore-GameEvent) | E | | + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycorecommands-NextMapCommand.md b/CodeDocumentation/SharedLibraryCore/sharedlibrarycorecommands-NextMapCommand.md new file mode 100644 index 0000000..e3f7208 --- /dev/null +++ b/CodeDocumentation/SharedLibraryCore/sharedlibrarycorecommands-NextMapCommand.md @@ -0,0 +1,73 @@ +# NextMapCommand `Public class` + +## Description +Retrieves the next map in rotation + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph SharedLibraryCore.Commands + SharedLibraryCore.Commands.NextMapCommand[[NextMapCommand]] + end + subgraph SharedLibraryCore + SharedLibraryCore.Command[[Command]] + class SharedLibraryCore.Command abstractStyle; + end +SharedLibraryCore.Command --> SharedLibraryCore.Commands.NextMapCommand +``` + +## Members +### Methods +#### Public Static methods +| Returns | Name | +| --- | --- | +| `Task`<`string`> | [`GetNextMap`](#getnextmap)([`Server`](./sharedlibrarycore-Server) s, [`ITranslationLookup`](./sharedlibrarycoreinterfaces-ITranslationLookup) lookup) | + +#### Public methods +| Returns | Name | +| --- | --- | +| `Task` | [`ExecuteAsync`](#executeasync)([`GameEvent`](./sharedlibrarycore-GameEvent) E) | + +## Details +### Summary +Retrieves the next map in rotation + +### Inheritance + - [ +`Command` +](./sharedlibrarycore-Command) + +### Constructors +#### NextMapCommand +```csharp +public NextMapCommand(CommandConfiguration config, ITranslationLookup translationLookup) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| [`CommandConfiguration`](./sharedlibrarycoreconfiguration-CommandConfiguration) | config | | +| [`ITranslationLookup`](./sharedlibrarycoreinterfaces-ITranslationLookup) | translationLookup | | + +### Methods +#### GetNextMap +```csharp +public static async Task GetNextMap(Server s, ITranslationLookup lookup) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| [`Server`](./sharedlibrarycore-Server) | s | | +| [`ITranslationLookup`](./sharedlibrarycoreinterfaces-ITranslationLookup) | lookup | | + +#### ExecuteAsync +```csharp +public override async Task ExecuteAsync(GameEvent E) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| [`GameEvent`](./sharedlibrarycore-GameEvent) | E | | + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycorecommands-OwnerCommand.md b/CodeDocumentation/SharedLibraryCore/sharedlibrarycorecommands-OwnerCommand.md new file mode 100644 index 0000000..7e453c4 --- /dev/null +++ b/CodeDocumentation/SharedLibraryCore/sharedlibrarycorecommands-OwnerCommand.md @@ -0,0 +1,58 @@ +# OwnerCommand `Public class` + +## Description +Claims ownership of the server + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph SharedLibraryCore.Commands + SharedLibraryCore.Commands.OwnerCommand[[OwnerCommand]] + end + subgraph SharedLibraryCore + SharedLibraryCore.Command[[Command]] + class SharedLibraryCore.Command abstractStyle; + end +SharedLibraryCore.Command --> SharedLibraryCore.Commands.OwnerCommand +``` + +## Members +### Methods +#### Public methods +| Returns | Name | +| --- | --- | +| `Task` | [`ExecuteAsync`](#executeasync)([`GameEvent`](./sharedlibrarycore-GameEvent) E) | + +## Details +### Summary +Claims ownership of the server + +### Inheritance + - [ +`Command` +](./sharedlibrarycore-Command) + +### Constructors +#### OwnerCommand +```csharp +public OwnerCommand(CommandConfiguration config, ITranslationLookup translationLookup) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| [`CommandConfiguration`](./sharedlibrarycoreconfiguration-CommandConfiguration) | config | | +| [`ITranslationLookup`](./sharedlibrarycoreinterfaces-ITranslationLookup) | translationLookup | | + +### Methods +#### ExecuteAsync +```csharp +public override async Task ExecuteAsync(GameEvent E) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| [`GameEvent`](./sharedlibrarycore-GameEvent) | E | | + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycorecommands-PrivateMessageAdminsCommand.md b/CodeDocumentation/SharedLibraryCore/sharedlibrarycorecommands-PrivateMessageAdminsCommand.md new file mode 100644 index 0000000..c85cb96 --- /dev/null +++ b/CodeDocumentation/SharedLibraryCore/sharedlibrarycorecommands-PrivateMessageAdminsCommand.md @@ -0,0 +1,52 @@ +# PrivateMessageAdminsCommand `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph SharedLibraryCore.Commands + SharedLibraryCore.Commands.PrivateMessageAdminsCommand[[PrivateMessageAdminsCommand]] + end + subgraph SharedLibraryCore + SharedLibraryCore.Command[[Command]] + class SharedLibraryCore.Command abstractStyle; + end +SharedLibraryCore.Command --> SharedLibraryCore.Commands.PrivateMessageAdminsCommand +``` + +## Members +### Methods +#### Public methods +| Returns | Name | +| --- | --- | +| `Task` | [`ExecuteAsync`](#executeasync)([`GameEvent`](./sharedlibrarycore-GameEvent) E) | + +## Details +### Inheritance + - [ +`Command` +](./sharedlibrarycore-Command) + +### Constructors +#### PrivateMessageAdminsCommand +```csharp +public PrivateMessageAdminsCommand(CommandConfiguration config, ITranslationLookup lookup) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| [`CommandConfiguration`](./sharedlibrarycoreconfiguration-CommandConfiguration) | config | | +| [`ITranslationLookup`](./sharedlibrarycoreinterfaces-ITranslationLookup) | lookup | | + +### Methods +#### ExecuteAsync +```csharp +public override Task ExecuteAsync(GameEvent E) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| [`GameEvent`](./sharedlibrarycore-GameEvent) | E | | + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycorecommands-PruneAdminsCommand.md b/CodeDocumentation/SharedLibraryCore/sharedlibrarycorecommands-PruneAdminsCommand.md new file mode 100644 index 0000000..5ce62c4 --- /dev/null +++ b/CodeDocumentation/SharedLibraryCore/sharedlibrarycorecommands-PruneAdminsCommand.md @@ -0,0 +1,59 @@ +# PruneAdminsCommand `Public class` + +## Description +Prunes inactive privileged clients + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph SharedLibraryCore.Commands + SharedLibraryCore.Commands.PruneAdminsCommand[[PruneAdminsCommand]] + end + subgraph SharedLibraryCore + SharedLibraryCore.Command[[Command]] + class SharedLibraryCore.Command abstractStyle; + end +SharedLibraryCore.Command --> SharedLibraryCore.Commands.PruneAdminsCommand +``` + +## Members +### Methods +#### Public methods +| Returns | Name | +| --- | --- | +| `Task` | [`ExecuteAsync`](#executeasync)([`GameEvent`](./sharedlibrarycore-GameEvent) E) | + +## Details +### Summary +Prunes inactive privileged clients + +### Inheritance + - [ +`Command` +](./sharedlibrarycore-Command) + +### Constructors +#### PruneAdminsCommand +```csharp +public PruneAdminsCommand(CommandConfiguration config, ITranslationLookup translationLookup, IDatabaseContextFactory contextFactory) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| [`CommandConfiguration`](./sharedlibrarycoreconfiguration-CommandConfiguration) | config | | +| [`ITranslationLookup`](./sharedlibrarycoreinterfaces-ITranslationLookup) | translationLookup | | +| `IDatabaseContextFactory` | contextFactory | | + +### Methods +#### ExecuteAsync +```csharp +public override async Task ExecuteAsync(GameEvent E) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| [`GameEvent`](./sharedlibrarycore-GameEvent) | E | | + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycorecommands-QuitCommand.md b/CodeDocumentation/SharedLibraryCore/sharedlibrarycorecommands-QuitCommand.md new file mode 100644 index 0000000..03c73d9 --- /dev/null +++ b/CodeDocumentation/SharedLibraryCore/sharedlibrarycorecommands-QuitCommand.md @@ -0,0 +1,58 @@ +# QuitCommand `Public class` + +## Description +Quits IW4MAdmin + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph SharedLibraryCore.Commands + SharedLibraryCore.Commands.QuitCommand[[QuitCommand]] + end + subgraph SharedLibraryCore + SharedLibraryCore.Command[[Command]] + class SharedLibraryCore.Command abstractStyle; + end +SharedLibraryCore.Command --> SharedLibraryCore.Commands.QuitCommand +``` + +## Members +### Methods +#### Public methods +| Returns | Name | +| --- | --- | +| `Task` | [`ExecuteAsync`](#executeasync)([`GameEvent`](./sharedlibrarycore-GameEvent) E) | + +## Details +### Summary +Quits IW4MAdmin + +### Inheritance + - [ +`Command` +](./sharedlibrarycore-Command) + +### Constructors +#### QuitCommand +```csharp +public QuitCommand(CommandConfiguration config, ITranslationLookup translationLookup) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| [`CommandConfiguration`](./sharedlibrarycoreconfiguration-CommandConfiguration) | config | | +| [`ITranslationLookup`](./sharedlibrarycoreinterfaces-ITranslationLookup) | translationLookup | | + +### Methods +#### ExecuteAsync +```csharp +public override async Task ExecuteAsync(GameEvent E) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| [`GameEvent`](./sharedlibrarycore-GameEvent) | E | | + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycorecommands-RequestTokenCommand.md b/CodeDocumentation/SharedLibraryCore/sharedlibrarycorecommands-RequestTokenCommand.md new file mode 100644 index 0000000..42f8f68 --- /dev/null +++ b/CodeDocumentation/SharedLibraryCore/sharedlibrarycorecommands-RequestTokenCommand.md @@ -0,0 +1,58 @@ +# RequestTokenCommand `Public class` + +## Description +Generates a token for use in webfront login + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph SharedLibraryCore.Commands + SharedLibraryCore.Commands.RequestTokenCommand[[RequestTokenCommand]] + end + subgraph SharedLibraryCore + SharedLibraryCore.Command[[Command]] + class SharedLibraryCore.Command abstractStyle; + end +SharedLibraryCore.Command --> SharedLibraryCore.Commands.RequestTokenCommand +``` + +## Members +### Methods +#### Public methods +| Returns | Name | +| --- | --- | +| `Task` | [`ExecuteAsync`](#executeasync)([`GameEvent`](./sharedlibrarycore-GameEvent) gameEvent) | + +## Details +### Summary +Generates a token for use in webfront login + +### Inheritance + - [ +`Command` +](./sharedlibrarycore-Command) + +### Constructors +#### RequestTokenCommand +```csharp +public RequestTokenCommand(CommandConfiguration config, ITranslationLookup lookup) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| [`CommandConfiguration`](./sharedlibrarycoreconfiguration-CommandConfiguration) | config | | +| [`ITranslationLookup`](./sharedlibrarycoreinterfaces-ITranslationLookup) | lookup | | + +### Methods +#### ExecuteAsync +```csharp +public override Task ExecuteAsync(GameEvent gameEvent) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| [`GameEvent`](./sharedlibrarycore-GameEvent) | gameEvent | | + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycorecommands-RestartCommand.md b/CodeDocumentation/SharedLibraryCore/sharedlibrarycorecommands-RestartCommand.md new file mode 100644 index 0000000..33134a5 --- /dev/null +++ b/CodeDocumentation/SharedLibraryCore/sharedlibrarycorecommands-RestartCommand.md @@ -0,0 +1,58 @@ +# RestartCommand `Public class` + +## Description +Restarts IW4MAdmin + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph SharedLibraryCore.Commands + SharedLibraryCore.Commands.RestartCommand[[RestartCommand]] + end + subgraph SharedLibraryCore + SharedLibraryCore.Command[[Command]] + class SharedLibraryCore.Command abstractStyle; + end +SharedLibraryCore.Command --> SharedLibraryCore.Commands.RestartCommand +``` + +## Members +### Methods +#### Public methods +| Returns | Name | +| --- | --- | +| `Task` | [`ExecuteAsync`](#executeasync)([`GameEvent`](./sharedlibrarycore-GameEvent) gameEvent) | + +## Details +### Summary +Restarts IW4MAdmin + +### Inheritance + - [ +`Command` +](./sharedlibrarycore-Command) + +### Constructors +#### RestartCommand +```csharp +public RestartCommand(CommandConfiguration config, ITranslationLookup translationLookup) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| [`CommandConfiguration`](./sharedlibrarycoreconfiguration-CommandConfiguration) | config | | +| [`ITranslationLookup`](./sharedlibrarycoreinterfaces-ITranslationLookup) | translationLookup | | + +### Methods +#### ExecuteAsync +```csharp +public override async Task ExecuteAsync(GameEvent gameEvent) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| [`GameEvent`](./sharedlibrarycore-GameEvent) | gameEvent | | + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycorecommands-RunAsCommand.md b/CodeDocumentation/SharedLibraryCore/sharedlibrarycorecommands-RunAsCommand.md new file mode 100644 index 0000000..5358e84 --- /dev/null +++ b/CodeDocumentation/SharedLibraryCore/sharedlibrarycorecommands-RunAsCommand.md @@ -0,0 +1,52 @@ +# RunAsCommand `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph SharedLibraryCore.Commands + SharedLibraryCore.Commands.RunAsCommand[[RunAsCommand]] + end + subgraph SharedLibraryCore + SharedLibraryCore.Command[[Command]] + class SharedLibraryCore.Command abstractStyle; + end +SharedLibraryCore.Command --> SharedLibraryCore.Commands.RunAsCommand +``` + +## Members +### Methods +#### Public methods +| Returns | Name | +| --- | --- | +| `Task` | [`ExecuteAsync`](#executeasync)([`GameEvent`](./sharedlibrarycore-GameEvent) gameEvent) | + +## Details +### Inheritance + - [ +`Command` +](./sharedlibrarycore-Command) + +### Constructors +#### RunAsCommand +```csharp +public RunAsCommand(CommandConfiguration config, ITranslationLookup lookup) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| [`CommandConfiguration`](./sharedlibrarycoreconfiguration-CommandConfiguration) | config | | +| [`ITranslationLookup`](./sharedlibrarycoreinterfaces-ITranslationLookup) | lookup | | + +### Methods +#### ExecuteAsync +```csharp +public override async Task ExecuteAsync(GameEvent gameEvent) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| [`GameEvent`](./sharedlibrarycore-GameEvent) | gameEvent | | + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycorecommands-SetGravatarCommand.md b/CodeDocumentation/SharedLibraryCore/sharedlibrarycorecommands-SetGravatarCommand.md new file mode 100644 index 0000000..73dcff4 --- /dev/null +++ b/CodeDocumentation/SharedLibraryCore/sharedlibrarycorecommands-SetGravatarCommand.md @@ -0,0 +1,59 @@ +# SetGravatarCommand `Public class` + +## Description +Sets the email for gravatar in webfront + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph SharedLibraryCore.Commands + SharedLibraryCore.Commands.SetGravatarCommand[[SetGravatarCommand]] + end + subgraph SharedLibraryCore + SharedLibraryCore.Command[[Command]] + class SharedLibraryCore.Command abstractStyle; + end +SharedLibraryCore.Command --> SharedLibraryCore.Commands.SetGravatarCommand +``` + +## Members +### Methods +#### Public methods +| Returns | Name | +| --- | --- | +| `Task` | [`ExecuteAsync`](#executeasync)([`GameEvent`](./sharedlibrarycore-GameEvent) E) | + +## Details +### Summary +Sets the email for gravatar in webfront + +### Inheritance + - [ +`Command` +](./sharedlibrarycore-Command) + +### Constructors +#### SetGravatarCommand +```csharp +public SetGravatarCommand(CommandConfiguration config, ITranslationLookup translationLookup, IMetaServiceV2 metaService) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| [`CommandConfiguration`](./sharedlibrarycoreconfiguration-CommandConfiguration) | config | | +| [`ITranslationLookup`](./sharedlibrarycoreinterfaces-ITranslationLookup) | translationLookup | | +| [`IMetaServiceV2`](./sharedlibrarycoreinterfaces-IMetaServiceV2) | metaService | | + +### Methods +#### ExecuteAsync +```csharp +public override async Task ExecuteAsync(GameEvent E) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| [`GameEvent`](./sharedlibrarycore-GameEvent) | E | | + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycorecommands-SetLevelCommand.md b/CodeDocumentation/SharedLibraryCore/sharedlibrarycorecommands-SetLevelCommand.md new file mode 100644 index 0000000..12c3a3b --- /dev/null +++ b/CodeDocumentation/SharedLibraryCore/sharedlibrarycorecommands-SetLevelCommand.md @@ -0,0 +1,59 @@ +# SetLevelCommand `Public class` + +## Description +Sets the level of given client + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph SharedLibraryCore.Commands + SharedLibraryCore.Commands.SetLevelCommand[[SetLevelCommand]] + end + subgraph SharedLibraryCore + SharedLibraryCore.Command[[Command]] + class SharedLibraryCore.Command abstractStyle; + end +SharedLibraryCore.Command --> SharedLibraryCore.Commands.SetLevelCommand +``` + +## Members +### Methods +#### Public methods +| Returns | Name | +| --- | --- | +| `Task` | [`ExecuteAsync`](#executeasync)([`GameEvent`](./sharedlibrarycore-GameEvent) gameEvent) | + +## Details +### Summary +Sets the level of given client + +### Inheritance + - [ +`Command` +](./sharedlibrarycore-Command) + +### Constructors +#### SetLevelCommand +```csharp +public SetLevelCommand(CommandConfiguration config, ITranslationLookup translationLookup, ILogger logger) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| [`CommandConfiguration`](./sharedlibrarycoreconfiguration-CommandConfiguration) | config | | +| [`ITranslationLookup`](./sharedlibrarycoreinterfaces-ITranslationLookup) | translationLookup | | +| `ILogger`<[`SetLevelCommand`](sharedlibrarycorecommands-SetLevelCommand)> | logger | | + +### Methods +#### ExecuteAsync +```csharp +public override async Task ExecuteAsync(GameEvent gameEvent) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| [`GameEvent`](./sharedlibrarycore-GameEvent) | gameEvent | | + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycorecommands-SetPasswordCommand.md b/CodeDocumentation/SharedLibraryCore/sharedlibrarycorecommands-SetPasswordCommand.md new file mode 100644 index 0000000..0c7285e --- /dev/null +++ b/CodeDocumentation/SharedLibraryCore/sharedlibrarycorecommands-SetPasswordCommand.md @@ -0,0 +1,58 @@ +# SetPasswordCommand `Public class` + +## Description +Sets login password + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph SharedLibraryCore.Commands + SharedLibraryCore.Commands.SetPasswordCommand[[SetPasswordCommand]] + end + subgraph SharedLibraryCore + SharedLibraryCore.Command[[Command]] + class SharedLibraryCore.Command abstractStyle; + end +SharedLibraryCore.Command --> SharedLibraryCore.Commands.SetPasswordCommand +``` + +## Members +### Methods +#### Public methods +| Returns | Name | +| --- | --- | +| `Task` | [`ExecuteAsync`](#executeasync)([`GameEvent`](./sharedlibrarycore-GameEvent) E) | + +## Details +### Summary +Sets login password + +### Inheritance + - [ +`Command` +](./sharedlibrarycore-Command) + +### Constructors +#### SetPasswordCommand +```csharp +public SetPasswordCommand(CommandConfiguration config, ITranslationLookup translationLookup) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| [`CommandConfiguration`](./sharedlibrarycoreconfiguration-CommandConfiguration) | config | | +| [`ITranslationLookup`](./sharedlibrarycoreinterfaces-ITranslationLookup) | translationLookup | | + +### Methods +#### ExecuteAsync +```csharp +public override async Task ExecuteAsync(GameEvent E) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| [`GameEvent`](./sharedlibrarycore-GameEvent) | E | | + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycorecommands-TempBanCommand.md b/CodeDocumentation/SharedLibraryCore/sharedlibrarycorecommands-TempBanCommand.md new file mode 100644 index 0000000..59a3566 --- /dev/null +++ b/CodeDocumentation/SharedLibraryCore/sharedlibrarycorecommands-TempBanCommand.md @@ -0,0 +1,59 @@ +# TempBanCommand `Public class` + +## Description +Temporarily bans a client + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph SharedLibraryCore.Commands + SharedLibraryCore.Commands.TempBanCommand[[TempBanCommand]] + end + subgraph SharedLibraryCore + SharedLibraryCore.Command[[Command]] + class SharedLibraryCore.Command abstractStyle; + end +SharedLibraryCore.Command --> SharedLibraryCore.Commands.TempBanCommand +``` + +## Members +### Methods +#### Public methods +| Returns | Name | +| --- | --- | +| `Task` | [`ExecuteAsync`](#executeasync)([`GameEvent`](./sharedlibrarycore-GameEvent) gameEvent) | + +## Details +### Summary +Temporarily bans a client + +### Inheritance + - [ +`Command` +](./sharedlibrarycore-Command) + +### Constructors +#### TempBanCommand +```csharp +public TempBanCommand(ApplicationConfiguration appConfig, CommandConfiguration config, ITranslationLookup translationLookup) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| [`ApplicationConfiguration`](./sharedlibrarycoreconfiguration-ApplicationConfiguration) | appConfig | | +| [`CommandConfiguration`](./sharedlibrarycoreconfiguration-CommandConfiguration) | config | | +| [`ITranslationLookup`](./sharedlibrarycoreinterfaces-ITranslationLookup) | translationLookup | | + +### Methods +#### ExecuteAsync +```csharp +public override async Task ExecuteAsync(GameEvent gameEvent) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| [`GameEvent`](./sharedlibrarycore-GameEvent) | gameEvent | | + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycorecommands-UnbanCommand.md b/CodeDocumentation/SharedLibraryCore/sharedlibrarycorecommands-UnbanCommand.md new file mode 100644 index 0000000..9cc2291 --- /dev/null +++ b/CodeDocumentation/SharedLibraryCore/sharedlibrarycorecommands-UnbanCommand.md @@ -0,0 +1,58 @@ +# UnbanCommand `Public class` + +## Description +Unbans a banned client + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph SharedLibraryCore.Commands + SharedLibraryCore.Commands.UnbanCommand[[UnbanCommand]] + end + subgraph SharedLibraryCore + SharedLibraryCore.Command[[Command]] + class SharedLibraryCore.Command abstractStyle; + end +SharedLibraryCore.Command --> SharedLibraryCore.Commands.UnbanCommand +``` + +## Members +### Methods +#### Public methods +| Returns | Name | +| --- | --- | +| `Task` | [`ExecuteAsync`](#executeasync)([`GameEvent`](./sharedlibrarycore-GameEvent) gameEvent) | + +## Details +### Summary +Unbans a banned client + +### Inheritance + - [ +`Command` +](./sharedlibrarycore-Command) + +### Constructors +#### UnbanCommand +```csharp +public UnbanCommand(CommandConfiguration config, ITranslationLookup translationLookup) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| [`CommandConfiguration`](./sharedlibrarycoreconfiguration-CommandConfiguration) | config | | +| [`ITranslationLookup`](./sharedlibrarycoreinterfaces-ITranslationLookup) | translationLookup | | + +### Methods +#### ExecuteAsync +```csharp +public override async Task ExecuteAsync(GameEvent gameEvent) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| [`GameEvent`](./sharedlibrarycore-GameEvent) | gameEvent | | + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycorecommands-UnflagClientCommand.md b/CodeDocumentation/SharedLibraryCore/sharedlibrarycorecommands-UnflagClientCommand.md new file mode 100644 index 0000000..b221c42 --- /dev/null +++ b/CodeDocumentation/SharedLibraryCore/sharedlibrarycorecommands-UnflagClientCommand.md @@ -0,0 +1,58 @@ +# UnflagClientCommand `Public class` + +## Description +Unflag given client for specified reason + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph SharedLibraryCore.Commands + SharedLibraryCore.Commands.UnflagClientCommand[[UnflagClientCommand]] + end + subgraph SharedLibraryCore + SharedLibraryCore.Command[[Command]] + class SharedLibraryCore.Command abstractStyle; + end +SharedLibraryCore.Command --> SharedLibraryCore.Commands.UnflagClientCommand +``` + +## Members +### Methods +#### Public methods +| Returns | Name | +| --- | --- | +| `Task` | [`ExecuteAsync`](#executeasync)([`GameEvent`](./sharedlibrarycore-GameEvent) E) | + +## Details +### Summary +Unflag given client for specified reason + +### Inheritance + - [ +`Command` +](./sharedlibrarycore-Command) + +### Constructors +#### UnflagClientCommand +```csharp +public UnflagClientCommand(CommandConfiguration config, ITranslationLookup translationLookup) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| [`CommandConfiguration`](./sharedlibrarycoreconfiguration-CommandConfiguration) | config | | +| [`ITranslationLookup`](./sharedlibrarycoreinterfaces-ITranslationLookup) | translationLookup | | + +### Methods +#### ExecuteAsync +```csharp +public override async Task ExecuteAsync(GameEvent E) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| [`GameEvent`](./sharedlibrarycore-GameEvent) | E | | + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycorecommands-UnlinkClientCommand.md b/CodeDocumentation/SharedLibraryCore/sharedlibrarycorecommands-UnlinkClientCommand.md new file mode 100644 index 0000000..6ef7aba --- /dev/null +++ b/CodeDocumentation/SharedLibraryCore/sharedlibrarycorecommands-UnlinkClientCommand.md @@ -0,0 +1,66 @@ +# UnlinkClientCommand `Public class` + +## Description +Provides a way for administrators to "unlink" linked accounts + This problem is common in IW4x where the client identifier is a file + that is commonly transmitted when uploading and sharing the game files + This command creates a new link and assigns the guid, and all aliases with the current IP + associated to the provided client ID to the new link + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph SharedLibraryCore.Commands + SharedLibraryCore.Commands.UnlinkClientCommand[[UnlinkClientCommand]] + end + subgraph SharedLibraryCore + SharedLibraryCore.Command[[Command]] + class SharedLibraryCore.Command abstractStyle; + end +SharedLibraryCore.Command --> SharedLibraryCore.Commands.UnlinkClientCommand +``` + +## Members +### Methods +#### Public methods +| Returns | Name | +| --- | --- | +| `Task` | [`ExecuteAsync`](#executeasync)([`GameEvent`](./sharedlibrarycore-GameEvent) E) | + +## Details +### Summary +Provides a way for administrators to "unlink" linked accounts + This problem is common in IW4x where the client identifier is a file + that is commonly transmitted when uploading and sharing the game files + This command creates a new link and assigns the guid, and all aliases with the current IP + associated to the provided client ID to the new link + +### Inheritance + - [ +`Command` +](./sharedlibrarycore-Command) + +### Constructors +#### UnlinkClientCommand +```csharp +public UnlinkClientCommand(CommandConfiguration config, ITranslationLookup lookup) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| [`CommandConfiguration`](./sharedlibrarycoreconfiguration-CommandConfiguration) | config | | +| [`ITranslationLookup`](./sharedlibrarycoreinterfaces-ITranslationLookup) | lookup | | + +### Methods +#### ExecuteAsync +```csharp +public override async Task ExecuteAsync(GameEvent E) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| [`GameEvent`](./sharedlibrarycore-GameEvent) | E | | + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycorecommands-UptimeCommand.md b/CodeDocumentation/SharedLibraryCore/sharedlibrarycorecommands-UptimeCommand.md new file mode 100644 index 0000000..ad0b7af --- /dev/null +++ b/CodeDocumentation/SharedLibraryCore/sharedlibrarycorecommands-UptimeCommand.md @@ -0,0 +1,58 @@ +# UptimeCommand `Public class` + +## Description +Prints out how long IW4MAdmin has been running + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph SharedLibraryCore.Commands + SharedLibraryCore.Commands.UptimeCommand[[UptimeCommand]] + end + subgraph SharedLibraryCore + SharedLibraryCore.Command[[Command]] + class SharedLibraryCore.Command abstractStyle; + end +SharedLibraryCore.Command --> SharedLibraryCore.Commands.UptimeCommand +``` + +## Members +### Methods +#### Public methods +| Returns | Name | +| --- | --- | +| `Task` | [`ExecuteAsync`](#executeasync)([`GameEvent`](./sharedlibrarycore-GameEvent) E) | + +## Details +### Summary +Prints out how long IW4MAdmin has been running + +### Inheritance + - [ +`Command` +](./sharedlibrarycore-Command) + +### Constructors +#### UptimeCommand +```csharp +public UptimeCommand(CommandConfiguration config, ITranslationLookup translationLookup) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| [`CommandConfiguration`](./sharedlibrarycoreconfiguration-CommandConfiguration) | config | | +| [`ITranslationLookup`](./sharedlibrarycoreinterfaces-ITranslationLookup) | translationLookup | | + +### Methods +#### ExecuteAsync +```csharp +public override Task ExecuteAsync(GameEvent E) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| [`GameEvent`](./sharedlibrarycore-GameEvent) | E | | + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycorecommands-WarnClearCommand.md b/CodeDocumentation/SharedLibraryCore/sharedlibrarycorecommands-WarnClearCommand.md new file mode 100644 index 0000000..9fc0128 --- /dev/null +++ b/CodeDocumentation/SharedLibraryCore/sharedlibrarycorecommands-WarnClearCommand.md @@ -0,0 +1,58 @@ +# WarnClearCommand `Public class` + +## Description +Clears all warnings for given client + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph SharedLibraryCore.Commands + SharedLibraryCore.Commands.WarnClearCommand[[WarnClearCommand]] + end + subgraph SharedLibraryCore + SharedLibraryCore.Command[[Command]] + class SharedLibraryCore.Command abstractStyle; + end +SharedLibraryCore.Command --> SharedLibraryCore.Commands.WarnClearCommand +``` + +## Members +### Methods +#### Public methods +| Returns | Name | +| --- | --- | +| `Task` | [`ExecuteAsync`](#executeasync)([`GameEvent`](./sharedlibrarycore-GameEvent) E) | + +## Details +### Summary +Clears all warnings for given client + +### Inheritance + - [ +`Command` +](./sharedlibrarycore-Command) + +### Constructors +#### WarnClearCommand +```csharp +public WarnClearCommand(CommandConfiguration config, ITranslationLookup translationLookup) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| [`CommandConfiguration`](./sharedlibrarycoreconfiguration-CommandConfiguration) | config | | +| [`ITranslationLookup`](./sharedlibrarycoreinterfaces-ITranslationLookup) | translationLookup | | + +### Methods +#### ExecuteAsync +```csharp +public override Task ExecuteAsync(GameEvent E) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| [`GameEvent`](./sharedlibrarycore-GameEvent) | E | | + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycorecommands-WarnCommand.md b/CodeDocumentation/SharedLibraryCore/sharedlibrarycorecommands-WarnCommand.md new file mode 100644 index 0000000..98626ab --- /dev/null +++ b/CodeDocumentation/SharedLibraryCore/sharedlibrarycorecommands-WarnCommand.md @@ -0,0 +1,59 @@ +# WarnCommand `Public class` + +## Description +Warns given client for reason + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph SharedLibraryCore.Commands + SharedLibraryCore.Commands.WarnCommand[[WarnCommand]] + end + subgraph SharedLibraryCore + SharedLibraryCore.Command[[Command]] + class SharedLibraryCore.Command abstractStyle; + end +SharedLibraryCore.Command --> SharedLibraryCore.Commands.WarnCommand +``` + +## Members +### Methods +#### Public methods +| Returns | Name | +| --- | --- | +| `Task` | [`ExecuteAsync`](#executeasync)([`GameEvent`](./sharedlibrarycore-GameEvent) gameEvent) | + +## Details +### Summary +Warns given client for reason + +### Inheritance + - [ +`Command` +](./sharedlibrarycore-Command) + +### Constructors +#### WarnCommand +```csharp +public WarnCommand(ApplicationConfiguration appConfig, CommandConfiguration config, ITranslationLookup translationLookup) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| [`ApplicationConfiguration`](./sharedlibrarycoreconfiguration-ApplicationConfiguration) | appConfig | | +| [`CommandConfiguration`](./sharedlibrarycoreconfiguration-CommandConfiguration) | config | | +| [`ITranslationLookup`](./sharedlibrarycoreinterfaces-ITranslationLookup) | translationLookup | | + +### Methods +#### ExecuteAsync +```csharp +public override Task ExecuteAsync(GameEvent gameEvent) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| [`GameEvent`](./sharedlibrarycore-GameEvent) | gameEvent | | + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreconfiguration-ApplicationConfiguration.md b/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreconfiguration-ApplicationConfiguration.md new file mode 100644 index 0000000..614b96d --- /dev/null +++ b/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreconfiguration-ApplicationConfiguration.md @@ -0,0 +1,397 @@ +# ApplicationConfiguration `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph SharedLibraryCore.Configuration + SharedLibraryCore.Configuration.ApplicationConfiguration[[ApplicationConfiguration]] + end + subgraph SharedLibraryCore.Interfaces + SharedLibraryCore.Interfaces.IBaseConfiguration[[IBaseConfiguration]] + class SharedLibraryCore.Interfaces.IBaseConfiguration interfaceStyle; + end +SharedLibraryCore.Interfaces.IBaseConfiguration --> SharedLibraryCore.Configuration.ApplicationConfiguration +``` + +## Members +### Properties +#### Public properties +| Type | Name | Methods | +| --- | --- | --- | +| `int` | [`AutoMessagePeriod`](#automessageperiod) | `get, set` | +| `string``[]` | [`AutoMessages`](#automessages) | `get, set` | +| `TimeSpan``[]` | [`BanDurations`](#bandurations) | `get, set` | +| `string` | [`BroadcastCommandPrefix`](#broadcastcommandprefix) | `get, set` | +| `string` | [`CommandPrefix`](#commandprefix) | `get, set` | +| [`CommunityInformationConfiguration`](./sharedlibrarycoreconfiguration-CommunityInformationConfiguration) | [`CommunityInformation`](#communityinformation) | `get, set` | +| `string` | [`ConnectionString`](#connectionstring) | `get, set` | +| `string` | [`ContactUri`](#contacturi) | `get, set` | +| `string` | [`CustomLocale`](#customlocale) | `get, set` | +| `string` | [`CustomParserEncoding`](#customparserencoding) | `get, set` | +| `string` | [`CustomSayName`](#customsayname) | `get, set` | +| `string` | [`DatabaseProvider`](#databaseprovider) | `get, set` | +| `string``[]` | [`DisallowedClientNames`](#disallowedclientnames) | `get, set` | +| `bool` | [`EnableColorCodes`](#enablecolorcodes) | `get, set` | +| `bool` | [`EnableCustomLocale`](#enablecustomlocale) | `get, set` | +| `bool` | [`EnableCustomParserEncoding`](#enablecustomparserencoding) | `get, set` | +| `bool` | [`EnableCustomSayName`](#enablecustomsayname) | `get, set` | +| `bool` | [`EnableImplicitAccountLinking`](#enableimplicitaccountlinking) | `get, set` | +| `bool` | [`EnableMultipleOwners`](#enablemultipleowners) | `get, set` | +| `bool` | [`EnablePrivilegedUserPrivacy`](#enableprivilegeduserprivacy) | `get, set` | +| `bool` | [`EnableSocialLink`](#enablesociallink) | `get, set` | +| `bool` | [`EnableSteppedHierarchy`](#enablesteppedhierarchy) | `get, set` | +| `bool` | [`EnableWebFront`](#enablewebfront) | `get, set` | +| `bool` | [`EnableWebfrontConnectionWhitelist`](#enablewebfrontconnectionwhitelist) | `get, set` | +| `string``[]` | [`GlobalRules`](#globalrules) | `get, set` | +| `string` | [`Id`](#id) | `get, set` | +| `bool` | [`IgnoreBots`](#ignorebots) | `get, set` | +| `bool` | [`IgnoreServerConnectionLost`](#ignoreserverconnectionlost) | `get, set` | +| `string` | [`IngameAccentColorKey`](#ingameaccentcolorkey) | `get, set` | +| `string` | [`ManualWebfrontUrl`](#manualwebfronturl) | `get, set` | +| `int` | [`MapChangeDelaySeconds`](#mapchangedelayseconds) | `get, set` | +| [`MapConfiguration`](./sharedlibrarycoreconfiguration-MapConfiguration)`[]` | [`Maps`](#maps) | `get, set` | +| `Uri` | [`MasterUrl`](#masterurl) | `get, set` | +| `TimeSpan` | [`MaxClientHistoryTime`](#maxclienthistorytime) | `get, set` | +| `TimeSpan` | [`MaximumTempBanTime`](#maximumtempbantime) | `get, set` | +| `Dictionary`<`string`, `Permission`> | [`MinimumAlertPermissions`](#minimumalertpermissions) | `get, set` | +| `int` | [`MinimumNameLength`](#minimumnamelength) | `get, set` | +| `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` | +| `int` | [`RConPollRate`](#rconpollrate) | `get, set` | +| `TimeSpan` | [`RecentAliasIpLinkTimeLimit`](#recentaliasiplinktimelimit) | `get, set` | +| `int` | [`ServerConnectionAttempts`](#serverconnectionattempts) | `get, set` | +| `TimeSpan` | [`ServerDataCollectionInterval`](#serverdatacollectioninterval) | `get, set` | +| [`ServerConfiguration`](./sharedlibrarycoreconfiguration-ServerConfiguration)`[]` | [`Servers`](#servers) | `get, set` | +| `string` | [`SocialLinkAddress`](#sociallinkaddress) | `get, set` | +| `string` | [`SocialLinkTitle`](#sociallinktitle) | `get, set` | +| `string` | [`SubscriptionId`](#subscriptionid) | `get, set` | +| `bool` | [`UseLocalTranslations`](#uselocaltranslations) | `get, set` | +| [`WebfrontConfiguration`](./sharedlibrarycoreconfiguration-WebfrontConfiguration) | [`Webfront`](#webfront) | `get, set` | +| `string` | [`WebfrontBindUrl`](#webfrontbindurl) | `get, set` | +| `string``[]` | [`WebfrontConnectionWhitelist`](#webfrontconnectionwhitelist) | `get, set` | +| `string` | [`WebfrontCustomBranding`](#webfrontcustombranding) | `get, set` | +| `string` | [`WebfrontPrimaryColor`](#webfrontprimarycolor) | `get, set` | +| `string` | [`WebfrontSecondaryColor`](#webfrontsecondarycolor) | `get, set` | +| `string` | [`WebfrontUrl`](#webfronturl) | `get` | + +### Methods +#### Public methods +| Returns | Name | +| --- | --- | +| [`IBaseConfiguration`](./sharedlibrarycoreinterfaces-IBaseConfiguration) | [`Generate`](#generate)() | +| `string` | [`Name`](#name)() | + +## Details +### Inheritance + - [ +`IBaseConfiguration` +](./sharedlibrarycoreinterfaces-IBaseConfiguration) + +### Constructors +#### ApplicationConfiguration +```csharp +public ApplicationConfiguration() +``` + +### Methods +#### Generate +```csharp +public virtual IBaseConfiguration Generate() +``` + +#### Name +```csharp +public virtual string Name() +``` + +### Properties +#### CommunityInformation +```csharp +public CommunityInformationConfiguration CommunityInformation { get; set; } +``` + +#### EnableWebFront +```csharp +public bool EnableWebFront { get; set; } +``` + +#### WebfrontBindUrl +```csharp +public string WebfrontBindUrl { get; set; } +``` + +#### ManualWebfrontUrl +```csharp +public string ManualWebfrontUrl { get; set; } +``` + +#### WebfrontPrimaryColor +```csharp +public string WebfrontPrimaryColor { get; set; } +``` + +#### WebfrontSecondaryColor +```csharp +public string WebfrontSecondaryColor { get; set; } +``` + +#### WebfrontCustomBranding +```csharp +public string WebfrontCustomBranding { get; set; } +``` + +#### Webfront +```csharp +public WebfrontConfiguration Webfront { get; set; } +``` + +#### EnableMultipleOwners +```csharp +public bool EnableMultipleOwners { get; set; } +``` + +#### EnableSteppedHierarchy +```csharp +public bool EnableSteppedHierarchy { get; set; } +``` + +#### UseLocalTranslations +```csharp +public bool UseLocalTranslations { get; set; } +``` + +#### IgnoreBots +```csharp +public bool IgnoreBots { get; set; } +``` + +#### EnableCustomSayName +```csharp +public bool EnableCustomSayName { get; set; } +``` + +#### CustomSayName +```csharp +public string CustomSayName { get; set; } +``` + +#### EnableSocialLink +```csharp +public bool EnableSocialLink { get; set; } +``` + +#### SocialLinkAddress +```csharp +public string SocialLinkAddress { get; set; } +``` + +#### SocialLinkTitle +```csharp +public string SocialLinkTitle { get; set; } +``` + +#### ContactUri +```csharp +public string ContactUri { get; set; } +``` + +#### EnableCustomParserEncoding +```csharp +public bool EnableCustomParserEncoding { get; set; } +``` + +#### CustomParserEncoding +```csharp +public string CustomParserEncoding { get; set; } +``` + +#### EnableWebfrontConnectionWhitelist +```csharp +public bool EnableWebfrontConnectionWhitelist { get; set; } +``` + +#### WebfrontConnectionWhitelist +```csharp +public string WebfrontConnectionWhitelist { get; set; } +``` + +#### EnableCustomLocale +```csharp +public bool EnableCustomLocale { get; set; } +``` + +#### CustomLocale +```csharp +public string CustomLocale { get; set; } +``` + +#### CommandPrefix +```csharp +public string CommandPrefix { get; set; } +``` + +#### BroadcastCommandPrefix +```csharp +public string BroadcastCommandPrefix { get; set; } +``` + +#### DatabaseProvider +```csharp +public string DatabaseProvider { get; set; } +``` + +#### ConnectionString +```csharp +public string ConnectionString { get; set; } +``` + +#### RConPollRate +```csharp +public int RConPollRate { get; set; } +``` + +#### MaximumTempBanTime +```csharp +public TimeSpan MaximumTempBanTime { get; set; } +``` + +#### EnableColorCodes +```csharp +public bool EnableColorCodes { get; set; } +``` + +#### IngameAccentColorKey +```csharp +public string IngameAccentColorKey { get; set; } +``` + +#### AutoMessagePeriod +```csharp +public int AutoMessagePeriod { get; set; } +``` + +#### AutoMessages +```csharp +public string AutoMessages { get; set; } +``` + +#### GlobalRules +```csharp +public string GlobalRules { get; set; } +``` + +#### DisallowedClientNames +```csharp +public string DisallowedClientNames { get; set; } +``` + +#### MapChangeDelaySeconds +```csharp +public int MapChangeDelaySeconds { get; set; } +``` + +#### BanDurations +```csharp +public TimeSpan BanDurations { get; set; } +``` + +#### PermissionSets +```csharp +public Dictionary> PermissionSets { get; set; } +``` + +#### MinimumAlertPermissions +```csharp +public Dictionary MinimumAlertPermissions { get; set; } +``` + +#### PresetPenaltyReasons +```csharp +public Dictionary PresetPenaltyReasons { get; set; } +``` + +#### EnablePrivilegedUserPrivacy +```csharp +public bool EnablePrivilegedUserPrivacy { get; set; } +``` + +#### EnableImplicitAccountLinking +```csharp +public bool EnableImplicitAccountLinking { get; set; } +``` + +#### RecentAliasIpLinkTimeLimit +```csharp +public TimeSpan RecentAliasIpLinkTimeLimit { get; set; } +``` + +#### MaxClientHistoryTime +```csharp +public TimeSpan MaxClientHistoryTime { get; set; } +``` + +#### ServerDataCollectionInterval +```csharp +public TimeSpan ServerDataCollectionInterval { get; set; } +``` + +#### ServerConnectionAttempts +```csharp +public int ServerConnectionAttempts { get; set; } +``` + +#### OverridePermissionLevelNames +```csharp +public Dictionary OverridePermissionLevelNames { get; set; } +``` + +#### Servers +```csharp +public ServerConfiguration Servers { get; set; } +``` + +#### MinimumNameLength +```csharp +public int MinimumNameLength { get; set; } +``` + +#### Id +```csharp +public string Id { get; set; } +``` + +#### SubscriptionId +```csharp +public string SubscriptionId { get; set; } +``` + +#### Maps +```csharp +public MapConfiguration Maps { get; set; } +``` + +#### QuickMessages +```csharp +public QuickMessageConfiguration QuickMessages { get; set; } +``` + +#### WebfrontUrl +```csharp +public string WebfrontUrl { get; } +``` + +#### IgnoreServerConnectionLost +```csharp +public bool IgnoreServerConnectionLost { get; set; } +``` + +#### MasterUrl +```csharp +public Uri MasterUrl { get; set; } +``` + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreconfiguration-CommandConfiguration.md b/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreconfiguration-CommandConfiguration.md new file mode 100644 index 0000000..64ec7ab --- /dev/null +++ b/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreconfiguration-CommandConfiguration.md @@ -0,0 +1,85 @@ +# CommandConfiguration `Public class` + +## Description +Basic command configuration + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph SharedLibraryCore.Configuration + SharedLibraryCore.Configuration.CommandConfiguration[[CommandConfiguration]] + end + subgraph SharedLibraryCore.Interfaces + SharedLibraryCore.Interfaces.IBaseConfiguration[[IBaseConfiguration]] + class SharedLibraryCore.Interfaces.IBaseConfiguration interfaceStyle; + end +SharedLibraryCore.Interfaces.IBaseConfiguration --> SharedLibraryCore.Configuration.CommandConfiguration +``` + +## Members +### Properties +#### Public properties +| Type | Name | Methods | +| --- | --- | --- | +| `string` | [`BroadcastCommandPrefix`](#broadcastcommandprefix)
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` | + +### Methods +#### Public methods +| Returns | Name | +| --- | --- | +| [`IBaseConfiguration`](./sharedlibrarycoreinterfaces-IBaseConfiguration) | [`Generate`](#generate)() | +| `string` | [`Name`](#name)() | + +## Details +### Summary +Basic command configuration + +### Inheritance + - [ +`IBaseConfiguration` +](./sharedlibrarycoreinterfaces-IBaseConfiguration) + +### Constructors +#### CommandConfiguration +```csharp +public CommandConfiguration() +``` + +### Methods +#### Generate +```csharp +public virtual IBaseConfiguration Generate() +``` + +#### Name +```csharp +public virtual string Name() +``` + +### Properties +#### Commands +```csharp +public Dictionary Commands { get; set; } +``` +##### Summary +Dict of command class names mapped to configurable properties + +#### CommandPrefix +```csharp +public string CommandPrefix { get; set; } +``` +##### Summary +prefix indicated the chat message is a command + +#### BroadcastCommandPrefix +```csharp +public string BroadcastCommandPrefix { get; set; } +``` +##### Summary +prefix indicating that the chat message is a broadcast command + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreconfiguration-CommandProperties.md b/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreconfiguration-CommandProperties.md new file mode 100644 index 0000000..4f19abf --- /dev/null +++ b/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreconfiguration-CommandProperties.md @@ -0,0 +1,73 @@ +# CommandProperties `Public class` + +## Description +Config driven command properties + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph SharedLibraryCore.Configuration + SharedLibraryCore.Configuration.CommandProperties[[CommandProperties]] + end +``` + +## Members +### Properties +#### Public properties +| Type | Name | Methods | +| --- | --- | --- | +| `string` | [`Alias`](#alias)
Alias of this command | `get, set` | +| `bool` | [`AllowImpersonation`](#allowimpersonation)
Indicates if the command can be run by another user (impersonation) | `get, set` | +| `Permission` | [`MinimumPermission`](#minimumpermission)
Specifies the minimum permission level needed to execute the | `get, set` | +| `string` | [`Name`](#name)
Specifies the command name | `get, set` | +| `Game``[]` | [`SupportedGames`](#supportedgames)
Specifies the games supporting the functionality of the command | `get, set` | + +## Details +### Summary +Config driven command properties + +### Constructors +#### CommandProperties +```csharp +public CommandProperties() +``` + +### Properties +#### Name +```csharp +public string Name { get; set; } +``` +##### Summary +Specifies the command name + +#### Alias +```csharp +public string Alias { get; set; } +``` +##### Summary +Alias of this command + +#### MinimumPermission +```csharp +public Permission MinimumPermission { get; set; } +``` +##### Summary +Specifies the minimum permission level needed to execute the + +#### AllowImpersonation +```csharp +public bool AllowImpersonation { get; set; } +``` +##### Summary +Indicates if the command can be run by another user (impersonation) + +#### SupportedGames +```csharp +public Game SupportedGames { get; set; } +``` +##### Summary +Specifies the games supporting the functionality of the command + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreconfiguration-CommunityInformationConfiguration.md b/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreconfiguration-CommunityInformationConfiguration.md new file mode 100644 index 0000000..56e2a40 --- /dev/null +++ b/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreconfiguration-CommunityInformationConfiguration.md @@ -0,0 +1,57 @@ +# CommunityInformationConfiguration `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph SharedLibraryCore.Configuration + SharedLibraryCore.Configuration.CommunityInformationConfiguration[[CommunityInformationConfiguration]] + end +``` + +## Members +### Properties +#### Public properties +| Type | Name | Methods | +| --- | --- | --- | +| `string` | [`Description`](#description) | `get, set` | +| `bool` | [`EnableBanner`](#enablebanner) | `get, set` | +| `bool` | [`IsEnabled`](#isenabled) | `get, set` | +| `string` | [`Name`](#name) | `get, set` | +| [`SocialAccountConfiguration`](./sharedlibrarycoreconfiguration-SocialAccountConfiguration)`[]` | [`SocialAccounts`](#socialaccounts) | `get, set` | + +## Details +### Constructors +#### CommunityInformationConfiguration +```csharp +public CommunityInformationConfiguration() +``` + +### Properties +#### Name +```csharp +public string Name { get; set; } +``` + +#### Description +```csharp +public string Description { get; set; } +``` + +#### EnableBanner +```csharp +public bool EnableBanner { get; set; } +``` + +#### SocialAccounts +```csharp +public SocialAccountConfiguration SocialAccounts { get; set; } +``` + +#### IsEnabled +```csharp +public bool IsEnabled { get; set; } +``` + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreconfiguration-DefaultSettings.md b/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreconfiguration-DefaultSettings.md new file mode 100644 index 0000000..a8a3029 --- /dev/null +++ b/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreconfiguration-DefaultSettings.md @@ -0,0 +1,97 @@ +# DefaultSettings `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph SharedLibraryCore.Configuration + SharedLibraryCore.Configuration.DefaultSettings[[DefaultSettings]] + end + subgraph SharedLibraryCore.Interfaces + SharedLibraryCore.Interfaces.IBaseConfiguration[[IBaseConfiguration]] + class SharedLibraryCore.Interfaces.IBaseConfiguration interfaceStyle; + end +SharedLibraryCore.Interfaces.IBaseConfiguration --> SharedLibraryCore.Configuration.DefaultSettings +``` + +## Members +### Properties +#### Public properties +| Type | Name | Methods | +| --- | --- | --- | +| `string``[]` | [`AutoMessages`](#automessages) | `get, set` | +| `string``[]` | [`DisallowedClientNames`](#disallowedclientnames) | `get, set` | +| [`GameStringConfiguration`](./sharedlibrarycoreconfiguration-GameStringConfiguration) | [`GameStrings`](#gamestrings) | `get, set` | +| [`GametypeConfiguration`](./sharedlibrarycoreconfiguration-GametypeConfiguration)`[]` | [`Gametypes`](#gametypes) | `get, set` | +| `string``[]` | [`GlobalRules`](#globalrules) | `get, set` | +| [`MapConfiguration`](./sharedlibrarycoreconfiguration-MapConfiguration)`[]` | [`Maps`](#maps) | `get, set` | +| [`QuickMessageConfiguration`](./sharedlibrarycoreconfiguration-QuickMessageConfiguration)`[]` | [`QuickMessages`](#quickmessages) | `get, set` | + +### Methods +#### Public methods +| Returns | Name | +| --- | --- | +| [`IBaseConfiguration`](./sharedlibrarycoreinterfaces-IBaseConfiguration) | [`Generate`](#generate)() | +| `string` | [`Name`](#name)() | + +## Details +### Inheritance + - [ +`IBaseConfiguration` +](./sharedlibrarycoreinterfaces-IBaseConfiguration) + +### Constructors +#### DefaultSettings +```csharp +public DefaultSettings() +``` + +### Methods +#### Generate +```csharp +public virtual IBaseConfiguration Generate() +``` + +#### Name +```csharp +public virtual string Name() +``` + +### Properties +#### AutoMessages +```csharp +public string AutoMessages { get; set; } +``` + +#### GlobalRules +```csharp +public string GlobalRules { get; set; } +``` + +#### Maps +```csharp +public MapConfiguration Maps { get; set; } +``` + +#### Gametypes +```csharp +public GametypeConfiguration Gametypes { get; set; } +``` + +#### QuickMessages +```csharp +public QuickMessageConfiguration QuickMessages { get; set; } +``` + +#### DisallowedClientNames +```csharp +public string DisallowedClientNames { get; set; } +``` + +#### GameStrings +```csharp +public GameStringConfiguration GameStrings { get; set; } +``` + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreconfiguration-GameStringConfiguration.md b/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreconfiguration-GameStringConfiguration.md new file mode 100644 index 0000000..fd797b4 --- /dev/null +++ b/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreconfiguration-GameStringConfiguration.md @@ -0,0 +1,45 @@ +# GameStringConfiguration `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph SharedLibraryCore.Configuration + SharedLibraryCore.Configuration.GameStringConfiguration[[GameStringConfiguration]] + end + subgraph System.Collections.Generic +System.Collections.Generic.Dictionary_2[[Dictionary]] + end +System.Collections.Generic.Dictionary_2 --> SharedLibraryCore.Configuration.GameStringConfiguration +``` + +## Members +### Methods +#### Public methods +| Returns | Name | +| --- | --- | +| `string` | [`GetStringForGame`](#getstringforgame)(`string` key, `Nullable`<`Game`> game) | + +## Details +### Inheritance + - `Dictionary`<`Game`, `Dictionary`<`string`, `string`>> + +### Constructors +#### GameStringConfiguration +```csharp +public GameStringConfiguration() +``` + +### Methods +#### GetStringForGame +```csharp +public string GetStringForGame(string key, Nullable game) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `string` | key | | +| `Nullable`<`Game`> | game | | + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreconfiguration-GametypeConfiguration.md b/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreconfiguration-GametypeConfiguration.md new file mode 100644 index 0000000..0a7cdeb --- /dev/null +++ b/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreconfiguration-GametypeConfiguration.md @@ -0,0 +1,39 @@ +# GametypeConfiguration `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph SharedLibraryCore.Configuration + SharedLibraryCore.Configuration.GametypeConfiguration[[GametypeConfiguration]] + end +``` + +## Members +### Properties +#### Public properties +| Type | Name | Methods | +| --- | --- | --- | +| `Game` | [`Game`](#game) | `get, set` | +| [`Gametype`](./sharedlibrarycore-Gametype)`[]` | [`Gametypes`](#gametypes) | `get, set` | + +## Details +### Constructors +#### GametypeConfiguration +```csharp +public GametypeConfiguration() +``` + +### Properties +#### Game +```csharp +public Game Game { get; set; } +``` + +#### Gametypes +```csharp +public Gametype Gametypes { get; set; } +``` + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreconfiguration-MapConfiguration.md b/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreconfiguration-MapConfiguration.md new file mode 100644 index 0000000..d628962 --- /dev/null +++ b/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreconfiguration-MapConfiguration.md @@ -0,0 +1,39 @@ +# MapConfiguration `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph SharedLibraryCore.Configuration + SharedLibraryCore.Configuration.MapConfiguration[[MapConfiguration]] + end +``` + +## Members +### Properties +#### Public properties +| Type | Name | Methods | +| --- | --- | --- | +| `Game` | [`Game`](#game) | `get, set` | +| [`Map`](./sharedlibrarycore-Map)`[]` | [`Maps`](#maps) | `get, set` | + +## Details +### Constructors +#### MapConfiguration +```csharp +public MapConfiguration() +``` + +### Properties +#### Game +```csharp +public Game Game { get; set; } +``` + +#### Maps +```csharp +public Map Maps { get; set; } +``` + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreconfiguration-QuickMessageConfiguration.md b/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreconfiguration-QuickMessageConfiguration.md new file mode 100644 index 0000000..52e0d83 --- /dev/null +++ b/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreconfiguration-QuickMessageConfiguration.md @@ -0,0 +1,39 @@ +# QuickMessageConfiguration `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph SharedLibraryCore.Configuration + SharedLibraryCore.Configuration.QuickMessageConfiguration[[QuickMessageConfiguration]] + end +``` + +## Members +### Properties +#### Public properties +| Type | Name | Methods | +| --- | --- | --- | +| `Game` | [`Game`](#game) | `get, set` | +| `Dictionary`<`string`, `string`> | [`Messages`](#messages) | `get, set` | + +## Details +### Constructors +#### QuickMessageConfiguration +```csharp +public QuickMessageConfiguration() +``` + +### Properties +#### Game +```csharp +public Game Game { get; set; } +``` + +#### Messages +```csharp +public Dictionary Messages { get; set; } +``` + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreconfiguration-ServerConfiguration.md b/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreconfiguration-ServerConfiguration.md new file mode 100644 index 0000000..3eb6026 --- /dev/null +++ b/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreconfiguration-ServerConfiguration.md @@ -0,0 +1,153 @@ +# ServerConfiguration `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph SharedLibraryCore.Configuration + SharedLibraryCore.Configuration.ServerConfiguration[[ServerConfiguration]] + end + subgraph SharedLibraryCore.Interfaces + SharedLibraryCore.Interfaces.IBaseConfiguration[[IBaseConfiguration]] + class SharedLibraryCore.Interfaces.IBaseConfiguration interfaceStyle; + end +SharedLibraryCore.Interfaces.IBaseConfiguration --> SharedLibraryCore.Configuration.ServerConfiguration +``` + +## Members +### Properties +#### Public properties +| Type | Name | Methods | +| --- | --- | --- | +| `string``[]` | [`AutoMessages`](#automessages) | `get, set` | +| `string` | [`CustomHostname`](#customhostname) | `get, set` | +| `string` | [`EventParserVersion`](#eventparserversion) | `get, set` | +| `Uri` | [`GameLogServerUrl`](#gamelogserverurl) | `get, set` | +| `string` | [`IPAddress`](#ipaddress) | `get, set` | +| `string` | [`ManualLogPath`](#manuallogpath) | `get, set` | +| `string` | [`Password`](#password) | `get, set` | +| `string` | [`PerformanceBucket`](#performancebucket) | `get, set` | +| `int` | [`Port`](#port) | `get, set` | +| `string` | [`RConParserVersion`](#rconparserversion) | `get, set` | +| `int` | [`ReservedSlotNumber`](#reservedslotnumber) | `get, set` | +| `string``[]` | [`Rules`](#rules) | `get, set` | + +### Methods +#### Public methods +| Returns | Name | +| --- | --- | +| `void` | [`AddEventParser`](#addeventparser)([`IEventParser`](./sharedlibrarycoreinterfaces-IEventParser) parser) | +| `void` | [`AddRConParser`](#addrconparser)([`IRConParser`](./sharedlibrarycoreinterfaces-IRConParser) parser) | +| [`IBaseConfiguration`](./sharedlibrarycoreinterfaces-IBaseConfiguration) | [`Generate`](#generate)() | +| `void` | [`ModifyParsers`](#modifyparsers)() | +| `string` | [`Name`](#name)() | + +## Details +### Inheritance + - [ +`IBaseConfiguration` +](./sharedlibrarycoreinterfaces-IBaseConfiguration) + +### Constructors +#### ServerConfiguration +```csharp +public ServerConfiguration() +``` + +### Methods +#### Generate +```csharp +public virtual IBaseConfiguration Generate() +``` + +#### Name +```csharp +public virtual string Name() +``` + +#### AddRConParser +```csharp +public void AddRConParser(IRConParser parser) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| [`IRConParser`](./sharedlibrarycoreinterfaces-IRConParser) | parser | | + +#### AddEventParser +```csharp +public void AddEventParser(IEventParser parser) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| [`IEventParser`](./sharedlibrarycoreinterfaces-IEventParser) | parser | | + +#### ModifyParsers +```csharp +public void ModifyParsers() +``` + +### Properties +#### IPAddress +```csharp +public string IPAddress { get; set; } +``` + +#### Port +```csharp +public int Port { get; set; } +``` + +#### Password +```csharp +public string Password { get; set; } +``` + +#### Rules +```csharp +public string Rules { get; set; } +``` + +#### AutoMessages +```csharp +public string AutoMessages { get; set; } +``` + +#### ManualLogPath +```csharp +public string ManualLogPath { get; set; } +``` + +#### RConParserVersion +```csharp +public string RConParserVersion { get; set; } +``` + +#### EventParserVersion +```csharp +public string EventParserVersion { get; set; } +``` + +#### ReservedSlotNumber +```csharp +public int ReservedSlotNumber { get; set; } +``` + +#### GameLogServerUrl +```csharp +public Uri GameLogServerUrl { get; set; } +``` + +#### CustomHostname +```csharp +public string CustomHostname { get; set; } +``` + +#### PerformanceBucket +```csharp +public string PerformanceBucket { get; set; } +``` + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreconfiguration-SocialAccountConfiguration.md b/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreconfiguration-SocialAccountConfiguration.md new file mode 100644 index 0000000..df56d2f --- /dev/null +++ b/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreconfiguration-SocialAccountConfiguration.md @@ -0,0 +1,51 @@ +# SocialAccountConfiguration `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph SharedLibraryCore.Configuration + SharedLibraryCore.Configuration.SocialAccountConfiguration[[SocialAccountConfiguration]] + end +``` + +## Members +### Properties +#### Public properties +| Type | Name | Methods | +| --- | --- | --- | +| `string` | [`IconId`](#iconid) | `get, set` | +| `string` | [`IconUrl`](#iconurl) | `get, set` | +| `string` | [`Title`](#title) | `get, set` | +| `string` | [`Url`](#url) | `get, set` | + +## Details +### Constructors +#### SocialAccountConfiguration +```csharp +public SocialAccountConfiguration() +``` + +### Properties +#### Title +```csharp +public string Title { get; set; } +``` + +#### Url +```csharp +public string Url { get; set; } +``` + +#### IconUrl +```csharp +public string IconUrl { get; set; } +``` + +#### IconId +```csharp +public string IconId { get; set; } +``` + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreconfiguration-WebfrontConfiguration.md b/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreconfiguration-WebfrontConfiguration.md new file mode 100644 index 0000000..54c7118 --- /dev/null +++ b/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreconfiguration-WebfrontConfiguration.md @@ -0,0 +1,33 @@ +# WebfrontConfiguration `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph SharedLibraryCore.Configuration + SharedLibraryCore.Configuration.WebfrontConfiguration[[WebfrontConfiguration]] + end +``` + +## Members +### Properties +#### Public properties +| Type | Name | Methods | +| --- | --- | --- | +| `string` | [`ScriptInjection`](#scriptinjection) | `get, set` | + +## Details +### Constructors +#### WebfrontConfiguration +```csharp +public WebfrontConfiguration() +``` + +### Properties +#### ScriptInjection +```csharp +public string ScriptInjection { get; set; } +``` + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreconfigurationattributes-ConfigurationIgnore.md b/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreconfigurationattributes-ConfigurationIgnore.md new file mode 100644 index 0000000..17fc873 --- /dev/null +++ b/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreconfigurationattributes-ConfigurationIgnore.md @@ -0,0 +1,27 @@ +# ConfigurationIgnore `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph SharedLibraryCore.Configuration.Attributes + SharedLibraryCore.Configuration.Attributes.ConfigurationIgnore[[ConfigurationIgnore]] + end + subgraph System +System.Attribute[[Attribute]] + end +System.Attribute --> SharedLibraryCore.Configuration.Attributes.ConfigurationIgnore +``` + +## Details +### Inheritance + - `Attribute` + +### Constructors +#### ConfigurationIgnore +```csharp +public ConfigurationIgnore() +``` + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreconfigurationattributes-ConfigurationLinked.md b/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreconfigurationattributes-ConfigurationLinked.md new file mode 100644 index 0000000..731d234 --- /dev/null +++ b/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreconfigurationattributes-ConfigurationLinked.md @@ -0,0 +1,44 @@ +# ConfigurationLinked `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph SharedLibraryCore.Configuration.Attributes + SharedLibraryCore.Configuration.Attributes.ConfigurationLinked[[ConfigurationLinked]] + end + subgraph System +System.Attribute[[Attribute]] + end +System.Attribute --> SharedLibraryCore.Configuration.Attributes.ConfigurationLinked +``` + +## Members +### Properties +#### Public properties +| Type | Name | Methods | +| --- | --- | --- | +| `string``[]` | [`LinkedPropertyNames`](#linkedpropertynames) | `get, set` | + +## Details +### Inheritance + - `Attribute` + +### Constructors +#### ConfigurationLinked +```csharp +public ConfigurationLinked(string[] linkedPropertyNames) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `string``[]` | linkedPropertyNames | | + +### Properties +#### LinkedPropertyNames +```csharp +public string LinkedPropertyNames { get; set; } +``` + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreconfigurationattributes-ConfigurationOptional.md b/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreconfigurationattributes-ConfigurationOptional.md new file mode 100644 index 0000000..2e6a10b --- /dev/null +++ b/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreconfigurationattributes-ConfigurationOptional.md @@ -0,0 +1,27 @@ +# ConfigurationOptional `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph SharedLibraryCore.Configuration.Attributes + SharedLibraryCore.Configuration.Attributes.ConfigurationOptional[[ConfigurationOptional]] + end + subgraph System +System.Attribute[[Attribute]] + end +System.Attribute --> SharedLibraryCore.Configuration.Attributes.ConfigurationOptional +``` + +## Details +### Inheritance + - `Attribute` + +### Constructors +#### ConfigurationOptional +```csharp +public ConfigurationOptional() +``` + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreconfigurationattributes-LocalizedDisplayName.md b/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreconfigurationattributes-LocalizedDisplayName.md new file mode 100644 index 0000000..368cba4 --- /dev/null +++ b/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreconfigurationattributes-LocalizedDisplayName.md @@ -0,0 +1,44 @@ +# LocalizedDisplayName `Internal class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph SharedLibraryCore.Configuration.Attributes + SharedLibraryCore.Configuration.Attributes.LocalizedDisplayName[[LocalizedDisplayName]] + end + subgraph System.ComponentModel +System.ComponentModel.DisplayNameAttribute[[DisplayNameAttribute]] + end +System.ComponentModel.DisplayNameAttribute --> SharedLibraryCore.Configuration.Attributes.LocalizedDisplayName +``` + +## Members +### Properties +#### Public properties +| Type | Name | Methods | +| --- | --- | --- | +| `string` | [`DisplayName`](#displayname) | `get` | + +## Details +### Inheritance + - `DisplayNameAttribute` + +### Constructors +#### LocalizedDisplayName +```csharp +public LocalizedDisplayName(string localizationKey) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `string` | localizationKey | | + +### Properties +#### DisplayName +```csharp +public override string DisplayName { get; } +``` + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreconfigurationextensions-ConfigurationExtensions.md b/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreconfigurationextensions-ConfigurationExtensions.md new file mode 100644 index 0000000..1f520a0 --- /dev/null +++ b/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreconfigurationextensions-ConfigurationExtensions.md @@ -0,0 +1,41 @@ +# ConfigurationExtensions `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph SharedLibraryCore.Configuration.Extensions + SharedLibraryCore.Configuration.Extensions.ConfigurationExtensions[[ConfigurationExtensions]] + end +``` + +## Members +### Methods +#### Public Static methods +| Returns | Name | +| --- | --- | +| (`string` Item1, `string` Item2)`[]` | [`TryGetRConPasswords`](#trygetrconpasswords)([`IRConParser`](./sharedlibrarycoreinterfaces-IRConParser) parser) | +| `void` | [`TrySetIpAddress`](#trysetipaddress)([`ServerConfiguration`](./sharedlibrarycoreconfiguration-ServerConfiguration) config) | + +## Details +### Methods +#### TrySetIpAddress +```csharp +public static void TrySetIpAddress(ServerConfiguration config) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| [`ServerConfiguration`](./sharedlibrarycoreconfiguration-ServerConfiguration) | config | | + +#### TryGetRConPasswords +```csharp +public static (string Item1, string Item2) TryGetRConPasswords(IRConParser parser) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| [`IRConParser`](./sharedlibrarycoreinterfaces-IRConParser) | parser | | + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreconfigurationvalidation-ApplicationConfigurationValidator.md b/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreconfigurationvalidation-ApplicationConfigurationValidator.md new file mode 100644 index 0000000..83c4963 --- /dev/null +++ b/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreconfigurationvalidation-ApplicationConfigurationValidator.md @@ -0,0 +1,33 @@ +# ApplicationConfigurationValidator `Public class` + +## Description +Validation class for main application configuration + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph SharedLibraryCore.Configuration.Validation + SharedLibraryCore.Configuration.Validation.ApplicationConfigurationValidator[[ApplicationConfigurationValidator]] + end + subgraph FluentValidation +FluentValidation.AbstractValidator_1[[AbstractValidator]] + end +FluentValidation.AbstractValidator_1 --> SharedLibraryCore.Configuration.Validation.ApplicationConfigurationValidator +``` + +## Details +### Summary +Validation class for main application configuration + +### Inheritance + - `AbstractValidator`<[`ApplicationConfiguration`](./sharedlibrarycoreconfiguration-ApplicationConfiguration)> + +### Constructors +#### ApplicationConfigurationValidator +```csharp +public ApplicationConfigurationValidator() +``` + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreconfigurationvalidation-ServerConfigurationValidator.md b/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreconfigurationvalidation-ServerConfigurationValidator.md new file mode 100644 index 0000000..24065ac --- /dev/null +++ b/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreconfigurationvalidation-ServerConfigurationValidator.md @@ -0,0 +1,33 @@ +# ServerConfigurationValidator `Public class` + +## Description +Validation class for server configuration + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph SharedLibraryCore.Configuration.Validation + SharedLibraryCore.Configuration.Validation.ServerConfigurationValidator[[ServerConfigurationValidator]] + end + subgraph FluentValidation +FluentValidation.AbstractValidator_1[[AbstractValidator]] + end +FluentValidation.AbstractValidator_1 --> SharedLibraryCore.Configuration.Validation.ServerConfigurationValidator +``` + +## Details +### Summary +Validation class for server configuration + +### Inheritance + - `AbstractValidator`<[`ServerConfiguration`](./sharedlibrarycoreconfiguration-ServerConfiguration)> + +### Constructors +#### ServerConfigurationValidator +```csharp +public ServerConfigurationValidator() +``` + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoredatabasemodels-EFClient.md b/CodeDocumentation/SharedLibraryCore/sharedlibrarycoredatabasemodels-EFClient.md new file mode 100644 index 0000000..824a95e --- /dev/null +++ b/CodeDocumentation/SharedLibraryCore/sharedlibrarycoredatabasemodels-EFClient.md @@ -0,0 +1,468 @@ +# EFClient `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph SharedLibraryCore.Database.Models + SharedLibraryCore.Database.Models.EFClient[[EFClient]] + end + subgraph Data.Models.Client +Data.Models.Client.EFClient[[EFClient]] + end +Data.Models.Client.EFClient --> SharedLibraryCore.Database.Models.EFClient +``` + +## Members +### Properties +#### Public properties +| Type | Name | Methods | +| --- | --- | --- | +| `string` | [`CleanedName`](#cleanedname) | `get` | +| `int` | [`ClientNumber`](#clientnumber) | `get, set` | +| [`ClientPermission`](./sharedlibrarycorelocalization-ClientPermission) | [`ClientPermission`](#clientpermission) | `get` | +| `int` | [`ConnectionLength`](#connectionlength) | `get` | +| `DateTime` | [`ConnectionTime`](#connectiontime) | `get, set` | +| [`Server`](./sharedlibrarycore-Server) | [`CurrentServer`](#currentserver) | `get, set` | +| `string` | [`GuidString`](#guidstring) | `get` | +| `Nullable`<`int`> | [`IPAddress`](#ipaddress) | `get, set` | +| `string` | [`IPAddressString`](#ipaddressstring) | `get` | +| `bool` | [`IsBot`](#isbot) | `get` | +| `bool` | [`IsIngame`](#isingame) | `get` | +| `bool` | [`IsZombieClient`](#iszombieclient) | `get` | +| `IDictionary`<`int`, `long`> | [`LinkedAccounts`](#linkedaccounts) | `get, set` | +| `string` | [`Name`](#name) | `get, set` | +| `int` | [`Ping`](#ping) | `get, set` | +| `int` | [`Score`](#score) | `get, set` | +| `ClientState` | [`State`](#state) | `get, set` | +| `string` | [`Tag`](#tag) | `get, set` | +| `TeamType` | [`Team`](#team) | `get, set` | +| `string` | [`TeamName`](#teamname) | `get, set` | +| `int` | [`TemporalClientNumber`](#temporalclientnumber) | `get` | +| `int` | [`Warnings`](#warnings) | `get, set` | +| `string` | [`XuidString`](#xuidstring) | `get` | + +### Methods +#### Protected methods +| Returns | Name | +| --- | --- | +| `void` | [`Finalize`](#finalize)() | + +#### Public methods +| Returns | Name | +| --- | --- | +| [`GameEvent`](./sharedlibrarycore-GameEvent) | [`Ban`](#ban)(`string` banReason, [`EFClient`](sharedlibrarycoredatabasemodels-EFClient) sender, `bool` isEvade)
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) | +| `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 | +| `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 | +| `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 | +| `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 | +| `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 | + +## Details +### Inheritance + - `EFClient` + +### Nested types +#### Enums + - `ClientState` + - `TeamType` + +### Constructors +#### EFClient +```csharp +public EFClient() +``` + +### Methods +#### Finalize +```csharp +protected override void Finalize() +``` + +#### ToString +```csharp +public override string ToString() +``` + +#### Tell [1/2] +```csharp +public GameEvent Tell(string message) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `string` | message | message content to send to client | + +##### Summary +send a message directly to the connected client + +#### Tell [2/2] +```csharp +public void Tell(IEnumerable messages) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `IEnumerable`<`string`> | messages | | + +#### TellAsync +```csharp +public async Task TellAsync(IEnumerable messages, CancellationToken token) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `IEnumerable`<`string`> | messages | | +| `CancellationToken` | token | | + +#### Warn +```csharp +public GameEvent Warn(string warnReason, EFClient sender) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `string` | warnReason | reason for warn | +| [`EFClient`](sharedlibrarycoredatabasemodels-EFClient) | sender | client performing the warn | + +##### Summary +warn a client with given reason + +#### WarnClear +```csharp +public GameEvent WarnClear(EFClient sender) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| [`EFClient`](sharedlibrarycoredatabasemodels-EFClient) | sender | client performing the warn clear | + +##### Summary +clear all warnings for a client + +##### Returns + + +#### Report +```csharp +public GameEvent Report(string reportReason, EFClient sender) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `string` | reportReason | reason for the report | +| [`EFClient`](sharedlibrarycoredatabasemodels-EFClient) | sender | client performing the report | + +##### Summary +report a client for a given reason + +##### Returns + + +#### Flag +```csharp +public GameEvent Flag(string flagReason, EFClient sender, Nullable flagLength) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `string` | flagReason | | +| [`EFClient`](sharedlibrarycoredatabasemodels-EFClient) | sender | | +| `Nullable`<`TimeSpan`> | flagLength | | + +#### Unflag +```csharp +public GameEvent Unflag(string unflagReason, EFClient sender) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `string` | unflagReason | reason to unflag a player for | +| [`EFClient`](sharedlibrarycoredatabasemodels-EFClient) | sender | client performing the unflag | + +##### Summary +unflag a client for a given reason + +##### Returns +game event for the un flug + +#### Kick [1/2] +```csharp +public GameEvent Kick(string kickReason, EFClient sender) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `string` | kickReason | reason to kick for | +| [`EFClient`](sharedlibrarycoredatabasemodels-EFClient) | sender | client performing the kick | + +##### Summary +kick a client for the given reason + +#### Kick [2/2] +```csharp +public GameEvent Kick(string kickReason, EFClient sender, EFPenalty originalPenalty) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `string` | kickReason | reason to kick for | +| [`EFClient`](sharedlibrarycoredatabasemodels-EFClient) | sender | client performing the kick | +| `EFPenalty` | originalPenalty | original client penalty | + +##### Summary +kick a client for the given reason + +#### TempBan +```csharp +public GameEvent TempBan(string tempbanReason, TimeSpan banLength, EFClient sender) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `string` | tempbanReason | reason for the temp ban | +| `TimeSpan` | banLength | how long the temp ban lasts | +| [`EFClient`](sharedlibrarycoredatabasemodels-EFClient) | sender | client performing the tempban | + +##### Summary +temporarily ban a client for the given time span + +#### Ban +```csharp +public GameEvent Ban(string banReason, EFClient sender, bool isEvade) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `string` | banReason | reason for the ban | +| [`EFClient`](sharedlibrarycoredatabasemodels-EFClient) | sender | client performing the ban | +| `bool` | isEvade | obsolete | + +##### Summary +permanently ban a client + +#### Unban +```csharp +public GameEvent Unban(string unbanReason, EFClient sender) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `string` | unbanReason | reason for the unban | +| [`EFClient`](sharedlibrarycoredatabasemodels-EFClient) | sender | client performing the unban | + +##### Summary +unban a client + +##### Returns + + +#### SetLevel +```csharp +public GameEvent SetLevel(Permission newPermission, EFClient sender) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `Permission` | newPermission | | +| [`EFClient`](sharedlibrarycoredatabasemodels-EFClient) | sender | | + +#### IsAbleToConnectSimple +```csharp +public bool IsAbleToConnectSimple() +``` +##### Summary +Handles any client related logic on connection + +#### OnDisconnect +```csharp +public async Task OnDisconnect() +``` + +#### OnJoin +```csharp +public async Task OnJoin(Nullable ipAddress, bool enableImplicitLinking) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `Nullable`<`int`> | ipAddress | | +| `bool` | enableImplicitLinking | | + +#### CanConnect +```csharp +public async Task CanConnect(Nullable ipAddress, bool enableImplicitLinking) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `Nullable`<`int`> | ipAddress | | +| `bool` | enableImplicitLinking | | + +#### UpdateTeam +```csharp +public void UpdateTeam(string newTeam) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `string` | newTeam | | + +#### Lock +```csharp +public async Task Lock() +``` + +#### Unlock +```csharp +public void Unlock() +``` + +#### Equals +```csharp +public override bool Equals(object obj) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `object` | obj | | + +#### GetHashCode +```csharp +public override int GetHashCode() +``` + +### Properties +#### Name +```csharp +public virtual string Name { get; set; } +``` + +#### CleanedName +```csharp +public string CleanedName { get; } +``` + +#### IPAddress +```csharp +public virtual Nullable IPAddress { get; set; } +``` + +#### IPAddressString +```csharp +public string IPAddressString { get; } +``` + +#### IsIngame +```csharp +public bool IsIngame { get; } +``` + +#### LinkedAccounts +```csharp +public virtual IDictionary LinkedAccounts { get; set; } +``` + +#### ClientNumber +```csharp +public int ClientNumber { get; set; } +``` + +#### Ping +```csharp +public int Ping { get; set; } +``` + +#### Warnings +```csharp +public int Warnings { get; set; } +``` + +#### ConnectionTime +```csharp +public DateTime ConnectionTime { get; set; } +``` + +#### ConnectionLength +```csharp +public int ConnectionLength { get; } +``` + +#### CurrentServer +```csharp +public Server CurrentServer { get; set; } +``` + +#### Score +```csharp +public int Score { get; set; } +``` + +#### IsBot +```csharp +public bool IsBot { get; } +``` + +#### IsZombieClient +```csharp +public bool IsZombieClient { get; } +``` + +#### XuidString +```csharp +public string XuidString { get; } +``` + +#### GuidString +```csharp +public string GuidString { get; } +``` + +#### State +```csharp +public ClientState State { get; set; } +``` + +#### Team +```csharp +public TeamType Team { get; set; } +``` + +#### TeamName +```csharp +public string TeamName { get; set; } +``` + +#### ClientPermission +```csharp +public ClientPermission ClientPermission { get; } +``` + +#### Tag +```csharp +public string Tag { get; set; } +``` + +#### TemporalClientNumber +```csharp +public int TemporalClientNumber { get; } +``` + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoredatabasemodelsefclient-ClientState.md b/CodeDocumentation/SharedLibraryCore/sharedlibrarycoredatabasemodelsefclient-ClientState.md new file mode 100644 index 0000000..a60acca --- /dev/null +++ b/CodeDocumentation/SharedLibraryCore/sharedlibrarycoredatabasemodelsefclient-ClientState.md @@ -0,0 +1,33 @@ +# ClientState `Public enum` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph SharedLibraryCore.Database.Models.EFClient + SharedLibraryCore.Database.Models.EFClient.ClientState[[ClientState]] + end +``` + +## Details +### Fields +#### Unknown +##### Summary +default client state + +#### Connecting +##### Summary +represents when the client has been detected as joining + by the log file, but has not be authenticated by RCon + +#### Connected +##### Summary +represents when the client has been authenticated by RCon + and validated by the database + +#### Disconnecting +##### Summary +represents when the client is leaving (either through RCon or log file) + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoredatabasemodelsefclient-TeamType.md b/CodeDocumentation/SharedLibraryCore/sharedlibrarycoredatabasemodelsefclient-TeamType.md new file mode 100644 index 0000000..6678eb4 --- /dev/null +++ b/CodeDocumentation/SharedLibraryCore/sharedlibrarycoredatabasemodelsefclient-TeamType.md @@ -0,0 +1,27 @@ +# TeamType `Public enum` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph SharedLibraryCore.Database.Models.EFClient + SharedLibraryCore.Database.Models.EFClient.TeamType[[TeamType]] + end +``` + +## Details +### Fields +#### Unknown + + +#### Spectator + + +#### Allies + + +#### Axis + + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoredtos-AuditInfo.md b/CodeDocumentation/SharedLibraryCore/sharedlibrarycoredtos-AuditInfo.md new file mode 100644 index 0000000..0b0699a --- /dev/null +++ b/CodeDocumentation/SharedLibraryCore/sharedlibrarycoredtos-AuditInfo.md @@ -0,0 +1,105 @@ +# AuditInfo `Public class` + +## Description +data transfer class for audit information + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph SharedLibraryCore.Dtos + SharedLibraryCore.Dtos.AuditInfo[[AuditInfo]] + end +``` + +## Members +### Properties +#### Public properties +| Type | Name | Methods | +| --- | --- | --- | +| `string` | [`Action`](#action)
what audit action occured | `get, set` | +| `string` | [`Data`](#data)
additional comment data about the audit event | `get, set` | +| `string` | [`NewValue`](#newvalue)
new value | `get, set` | +| `string` | [`OldValue`](#oldvalue)
previous value | `get, set` | +| `int` | [`OriginId`](#originid)
id of the origin entity | `get, set` | +| `string` | [`OriginName`](#originname)
name of the origin entity | `get, set` | +| `Nullable`<`int`> | [`TargetId`](#targetid)
id of the target entity | `get, set` | +| `string` | [`TargetName`](#targetname)
name of the target entity | `get, set` | +| `DateTime` | [`When`](#when)
when the audit event occured | `get, set` | + +## Details +### Summary +data transfer class for audit information + +### Constructors +#### AuditInfo +```csharp +public AuditInfo() +``` + +### Properties +#### OriginName +```csharp +public string OriginName { get; set; } +``` +##### Summary +name of the origin entity + +#### OriginId +```csharp +public int OriginId { get; set; } +``` +##### Summary +id of the origin entity + +#### TargetName +```csharp +public string TargetName { get; set; } +``` +##### Summary +name of the target entity + +#### TargetId +```csharp +public Nullable TargetId { get; set; } +``` +##### Summary +id of the target entity + +#### When +```csharp +public DateTime When { get; set; } +``` +##### Summary +when the audit event occured + +#### Action +```csharp +public string Action { get; set; } +``` +##### Summary +what audit action occured + +#### Data +```csharp +public string Data { get; set; } +``` +##### Summary +additional comment data about the audit event + +#### OldValue +```csharp +public string OldValue { get; set; } +``` +##### Summary +previous value + +#### NewValue +```csharp +public string NewValue { get; set; } +``` +##### Summary +new value + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoredtos-ChatInfo.md b/CodeDocumentation/SharedLibraryCore/sharedlibrarycoredtos-ChatInfo.md new file mode 100644 index 0000000..ec23e0d --- /dev/null +++ b/CodeDocumentation/SharedLibraryCore/sharedlibrarycoredtos-ChatInfo.md @@ -0,0 +1,75 @@ +# ChatInfo `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph SharedLibraryCore.Dtos + SharedLibraryCore.Dtos.ChatInfo[[ChatInfo]] + end +``` + +## Members +### Properties +#### Public properties +| Type | Name | Methods | +| --- | --- | --- | +| `int` | [`ClientId`](#clientid) | `get, set` | +| `string` | [`HiddenMessage`](#hiddenmessage) | `get` | +| `bool` | [`IsHidden`](#ishidden) | `get, set` | +| `bool` | [`IsQuickMessage`](#isquickmessage) | `get, set` | +| `string` | [`Message`](#message) | `get, set` | +| `string` | [`Name`](#name) | `get, set` | +| `Game` | [`ServerGame`](#servergame) | `get, set` | +| `DateTime` | [`Time`](#time) | `get, set` | + +## Details +### Constructors +#### ChatInfo +```csharp +public ChatInfo() +``` + +### Properties +#### ClientId +```csharp +public int ClientId { get; set; } +``` + +#### Message +```csharp +public string Message { get; set; } +``` + +#### Time +```csharp +public DateTime Time { get; set; } +``` + +#### Name +```csharp +public string Name { get; set; } +``` + +#### ServerGame +```csharp +public Game ServerGame { get; set; } +``` + +#### IsQuickMessage +```csharp +public bool IsQuickMessage { get; set; } +``` + +#### IsHidden +```csharp +public bool IsHidden { get; set; } +``` + +#### HiddenMessage +```csharp +public string HiddenMessage { get; } +``` + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoredtos-ClientCountSnapshot.md b/CodeDocumentation/SharedLibraryCore/sharedlibrarycoredtos-ClientCountSnapshot.md new file mode 100644 index 0000000..fc1e199 --- /dev/null +++ b/CodeDocumentation/SharedLibraryCore/sharedlibrarycoredtos-ClientCountSnapshot.md @@ -0,0 +1,63 @@ +# ClientCountSnapshot `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph SharedLibraryCore.Dtos + SharedLibraryCore.Dtos.ClientCountSnapshot[[ClientCountSnapshot]] + end +``` + +## Members +### Properties +#### Public properties +| Type | Name | Methods | +| --- | --- | --- | +| `int` | [`ClientCount`](#clientcount) | `get, set` | +| `bool` | [`ConnectionInterrupted`](#connectioninterrupted) | `get, set` | +| `string` | [`Map`](#map) | `get, set` | +| `string` | [`MapAlias`](#mapalias) | `get, set` | +| `DateTime` | [`Time`](#time) | `get, set` | +| `string` | [`TimeString`](#timestring) | `get` | + +## Details +### Constructors +#### ClientCountSnapshot +```csharp +public ClientCountSnapshot() +``` + +### Properties +#### Time +```csharp +public DateTime Time { get; set; } +``` + +#### TimeString +```csharp +public string TimeString { get; } +``` + +#### ClientCount +```csharp +public int ClientCount { get; set; } +``` + +#### ConnectionInterrupted +```csharp +public bool ConnectionInterrupted { get; set; } +``` + +#### Map +```csharp +public string Map { get; set; } +``` + +#### MapAlias +```csharp +public string MapAlias { get; set; } +``` + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoredtos-ClientHistoryInfo.md b/CodeDocumentation/SharedLibraryCore/sharedlibrarycoredtos-ClientHistoryInfo.md new file mode 100644 index 0000000..fb96f42 --- /dev/null +++ b/CodeDocumentation/SharedLibraryCore/sharedlibrarycoredtos-ClientHistoryInfo.md @@ -0,0 +1,39 @@ +# ClientHistoryInfo `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph SharedLibraryCore.Dtos + SharedLibraryCore.Dtos.ClientHistoryInfo[[ClientHistoryInfo]] + end +``` + +## Members +### Properties +#### Public properties +| Type | Name | Methods | +| --- | --- | --- | +| `List`<[`ClientCountSnapshot`](./sharedlibrarycoredtos-ClientCountSnapshot)> | [`ClientCounts`](#clientcounts) | `get, set` | +| `long` | [`ServerId`](#serverid) | `get, set` | + +## Details +### Constructors +#### ClientHistoryInfo +```csharp +public ClientHistoryInfo() +``` + +### Properties +#### ServerId +```csharp +public long ServerId { get; set; } +``` + +#### ClientCounts +```csharp +public List ClientCounts { get; set; } +``` + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoredtos-ClientInfo.md b/CodeDocumentation/SharedLibraryCore/sharedlibrarycoredtos-ClientInfo.md new file mode 100644 index 0000000..174d18e --- /dev/null +++ b/CodeDocumentation/SharedLibraryCore/sharedlibrarycoredtos-ClientInfo.md @@ -0,0 +1,69 @@ +# ClientInfo `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph SharedLibraryCore.Dtos + SharedLibraryCore.Dtos.ClientInfo[[ClientInfo]] + end +``` + +## Members +### Properties +#### Public properties +| Type | Name | Methods | +| --- | --- | --- | +| `int` | [`ClientId`](#clientid) | `get, set` | +| `Game` | [`Game`](#game) | `get, set` | +| `bool` | [`IsMasked`](#ismasked) | `get, set` | +| `DateTime` | [`LastConnection`](#lastconnection) | `get, set` | +| `Permission` | [`Level`](#level) | `get, set` | +| `int` | [`LinkId`](#linkid) | `get, set` | +| `string` | [`Name`](#name) | `get, set` | + +## Details +### Constructors +#### ClientInfo +```csharp +public ClientInfo() +``` + +### Properties +#### Name +```csharp +public string Name { get; set; } +``` + +#### ClientId +```csharp +public int ClientId { get; set; } +``` + +#### LinkId +```csharp +public int LinkId { get; set; } +``` + +#### Level +```csharp +public Permission Level { get; set; } +``` + +#### LastConnection +```csharp +public DateTime LastConnection { get; set; } +``` + +#### Game +```csharp +public Game Game { get; set; } +``` + +#### IsMasked +```csharp +public bool IsMasked { get; set; } +``` + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoredtos-CommandResponseInfo.md b/CodeDocumentation/SharedLibraryCore/sharedlibrarycoredtos-CommandResponseInfo.md new file mode 100644 index 0000000..1851275 --- /dev/null +++ b/CodeDocumentation/SharedLibraryCore/sharedlibrarycoredtos-CommandResponseInfo.md @@ -0,0 +1,39 @@ +# CommandResponseInfo `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph SharedLibraryCore.Dtos + SharedLibraryCore.Dtos.CommandResponseInfo[[CommandResponseInfo]] + end +``` + +## Members +### Properties +#### Public properties +| Type | Name | Methods | +| --- | --- | --- | +| `int` | [`ClientId`](#clientid) | `get, set` | +| `string` | [`Response`](#response) | `get, set` | + +## Details +### Constructors +#### CommandResponseInfo +```csharp +public CommandResponseInfo() +``` + +### Properties +#### Response +```csharp +public string Response { get; set; } +``` + +#### ClientId +```csharp +public int ClientId { get; set; } +``` + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoredtos-EntityInfo.md b/CodeDocumentation/SharedLibraryCore/sharedlibrarycoredtos-EntityInfo.md new file mode 100644 index 0000000..65e32e6 --- /dev/null +++ b/CodeDocumentation/SharedLibraryCore/sharedlibrarycoredtos-EntityInfo.md @@ -0,0 +1,45 @@ +# EntityInfo `Public class` + +## Description +This class holds the basic info for api entities + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph SharedLibraryCore.Dtos + SharedLibraryCore.Dtos.EntityInfo[[EntityInfo]] + end +``` + +## Members +### Properties +#### Public properties +| Type | Name | Methods | +| --- | --- | --- | +| `long` | [`Id`](#id) | `get, set` | +| `string` | [`Name`](#name) | `get, set` | + +## Details +### Summary +This class holds the basic info for api entities + +### Constructors +#### EntityInfo +```csharp +public EntityInfo() +``` + +### Properties +#### Id +```csharp +public long Id { get; set; } +``` + +#### Name +```csharp +public string Name { get; set; } +``` + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoredtos-ErrorResponse.md b/CodeDocumentation/SharedLibraryCore/sharedlibrarycoredtos-ErrorResponse.md new file mode 100644 index 0000000..1e5c76f --- /dev/null +++ b/CodeDocumentation/SharedLibraryCore/sharedlibrarycoredtos-ErrorResponse.md @@ -0,0 +1,43 @@ +# ErrorResponse `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph SharedLibraryCore.Dtos + SharedLibraryCore.Dtos.ErrorResponse[[ErrorResponse]] + end +``` + +## Members +### Properties +#### Public properties +| Type | Name | Methods | +| --- | --- | --- | +| `string``[]` | [`Messages`](#messages)
relevant error messages | `get, set` | +| `string` | [`Type`](#type)
todo: type of error | `get, set` | + +## Details +### Constructors +#### ErrorResponse +```csharp +public ErrorResponse() +``` + +### Properties +#### Type +```csharp +public string Type { get; set; } +``` +##### Summary +todo: type of error + +#### Messages +```csharp +public string Messages { get; set; } +``` +##### Summary +relevant error messages + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoredtos-EventInfo.md b/CodeDocumentation/SharedLibraryCore/sharedlibrarycoredtos-EventInfo.md new file mode 100644 index 0000000..7648f84 --- /dev/null +++ b/CodeDocumentation/SharedLibraryCore/sharedlibrarycoredtos-EventInfo.md @@ -0,0 +1,81 @@ +# EventInfo `Public class` + +## Description +This class wraps the information related to a generated event for the API + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph SharedLibraryCore.Dtos + SharedLibraryCore.Dtos.EventInfo[[EventInfo]] + end +``` + +## Members +### Properties +#### Public properties +| Type | Name | Methods | +| --- | --- | --- | +| `DateTime` | [`EventTime`](#eventtime) | `get, set` | +| [`EntityInfo`](./sharedlibrarycoredtos-EntityInfo) | [`EventType`](#eventtype) | `get, set` | +| `string` | [`ExtraInfo`](#extrainfo) | `get, set` | +| [`EntityInfo`](./sharedlibrarycoredtos-EntityInfo) | [`GameInfo`](#gameinfo) | `get, set` | +| `string` | [`Id`](#id) | `get` | +| [`EntityInfo`](./sharedlibrarycoredtos-EntityInfo) | [`OriginEntity`](#originentity) | `get, set` | +| [`EntityInfo`](./sharedlibrarycoredtos-EntityInfo) | [`OwnerEntity`](#ownerentity) | `get, set` | +| [`EntityInfo`](./sharedlibrarycoredtos-EntityInfo) | [`TargetEntity`](#targetentity) | `get, set` | + +## Details +### Summary +This class wraps the information related to a generated event for the API + +### Constructors +#### EventInfo +```csharp +public EventInfo() +``` + +### Properties +#### GameInfo +```csharp +public EntityInfo GameInfo { get; set; } +``` + +#### OriginEntity +```csharp +public EntityInfo OriginEntity { get; set; } +``` + +#### TargetEntity +```csharp +public EntityInfo TargetEntity { get; set; } +``` + +#### EventType +```csharp +public EntityInfo EventType { get; set; } +``` + +#### OwnerEntity +```csharp +public EntityInfo OwnerEntity { get; set; } +``` + +#### EventTime +```csharp +public DateTime EventTime { get; set; } +``` + +#### ExtraInfo +```csharp +public string ExtraInfo { get; set; } +``` + +#### Id +```csharp +public string Id { get; } +``` + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoredtos-FindClientRequest.md b/CodeDocumentation/SharedLibraryCore/sharedlibrarycoredtos-FindClientRequest.md new file mode 100644 index 0000000..7747cd4 --- /dev/null +++ b/CodeDocumentation/SharedLibraryCore/sharedlibrarycoredtos-FindClientRequest.md @@ -0,0 +1,62 @@ +# FindClientRequest `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph SharedLibraryCore.Dtos + SharedLibraryCore.Dtos.FindClientRequest[[FindClientRequest]] + SharedLibraryCore.Dtos.PaginationRequest[[PaginationRequest]] + end +SharedLibraryCore.Dtos.PaginationRequest --> SharedLibraryCore.Dtos.FindClientRequest +``` + +## Members +### Properties +#### Public properties +| Type | Name | Methods | +| --- | --- | --- | +| `string` | [`Name`](#name)
name of client | `get, set` | +| `string` | [`Xuid`](#xuid)
network id of client | `get, set` | + +### Methods +#### Public methods +| Returns | Name | +| --- | --- | +| `string` | [`ToDebugString`](#todebugstring)() | + +## Details +### Inheritance + - [ +`PaginationRequest` +](./sharedlibrarycoredtos-PaginationRequest) + +### Constructors +#### FindClientRequest +```csharp +public FindClientRequest() +``` + +### Methods +#### ToDebugString +```csharp +public string ToDebugString() +``` + +### Properties +#### Name +```csharp +public string Name { get; set; } +``` +##### Summary +name of client + +#### Xuid +```csharp +public string Xuid { get; set; } +``` +##### Summary +network id of client + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoredtos-FindClientResult.md b/CodeDocumentation/SharedLibraryCore/sharedlibrarycoredtos-FindClientResult.md new file mode 100644 index 0000000..f16459a --- /dev/null +++ b/CodeDocumentation/SharedLibraryCore/sharedlibrarycoredtos-FindClientResult.md @@ -0,0 +1,51 @@ +# FindClientResult `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph SharedLibraryCore.Dtos + SharedLibraryCore.Dtos.FindClientResult[[FindClientResult]] + end +``` + +## Members +### Properties +#### Public properties +| Type | Name | Methods | +| --- | --- | --- | +| `int` | [`ClientId`](#clientid)
client identifier | `get, set` | +| `string` | [`Name`](#name)
name of client | `get, set` | +| `string` | [`Xuid`](#xuid)
networkid of client | `get, set` | + +## Details +### Constructors +#### FindClientResult +```csharp +public FindClientResult() +``` + +### Properties +#### ClientId +```csharp +public int ClientId { get; set; } +``` +##### Summary +client identifier + +#### Xuid +```csharp +public string Xuid { get; set; } +``` +##### Summary +networkid of client + +#### Name +```csharp +public string Name { get; set; } +``` +##### Summary +name of client + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoredtos-IW4MAdminInfo.md b/CodeDocumentation/SharedLibraryCore/sharedlibrarycoredtos-IW4MAdminInfo.md new file mode 100644 index 0000000..b8d5ad0 --- /dev/null +++ b/CodeDocumentation/SharedLibraryCore/sharedlibrarycoredtos-IW4MAdminInfo.md @@ -0,0 +1,79 @@ +# IW4MAdminInfo `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph SharedLibraryCore.Dtos + SharedLibraryCore.Dtos.IW4MAdminInfo[[IW4MAdminInfo]] + end +``` + +## Members +### Properties +#### Public properties +| Type | Name | Methods | +| --- | --- | --- | +| `Game``[]` | [`ActiveServerGames`](#activeservergames)
collection of unique game names being monitored | `get, set` | +| `Nullable`<`Game`> | [`Game`](#game)
specifies the game name filter | `get, set` | +| `int` | [`MaxConcurrentClients`](#maxconcurrentclients) | `get, set` | +| `DateTime` | [`MaxConcurrentClientsTime`](#maxconcurrentclientstime) | `get, set` | +| `int` | [`RecentClientCount`](#recentclientcount) | `get, set` | +| `int` | [`TotalAvailableClientSlots`](#totalavailableclientslots) | `get, set` | +| `int` | [`TotalClientCount`](#totalclientcount) | `get, set` | +| `int` | [`TotalOccupiedClientSlots`](#totaloccupiedclientslots) | `get, set` | + +## Details +### Constructors +#### IW4MAdminInfo +```csharp +public IW4MAdminInfo() +``` + +### Properties +#### TotalClientCount +```csharp +public int TotalClientCount { get; set; } +``` + +#### RecentClientCount +```csharp +public int RecentClientCount { get; set; } +``` + +#### TotalOccupiedClientSlots +```csharp +public int TotalOccupiedClientSlots { get; set; } +``` + +#### TotalAvailableClientSlots +```csharp +public int TotalAvailableClientSlots { get; set; } +``` + +#### MaxConcurrentClients +```csharp +public int MaxConcurrentClients { get; set; } +``` + +#### MaxConcurrentClientsTime +```csharp +public DateTime MaxConcurrentClientsTime { get; set; } +``` + +#### Game +```csharp +public Nullable Game { get; set; } +``` +##### Summary +specifies the game name filter + +#### ActiveServerGames +```csharp +public Game ActiveServerGames { get; set; } +``` +##### Summary +collection of unique game names being monitored + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoredtos-LookupValueT.md b/CodeDocumentation/SharedLibraryCore/sharedlibrarycoredtos-LookupValueT.md new file mode 100644 index 0000000..da99334 --- /dev/null +++ b/CodeDocumentation/SharedLibraryCore/sharedlibrarycoredtos-LookupValueT.md @@ -0,0 +1,49 @@ +# LookupValue<TObject> `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph SharedLibraryCore.Dtos + SharedLibraryCore.Dtos.LookupValue_1[[LookupValue< TObject >]] + + end + subgraph SharedLibraryCore.Interfaces + SharedLibraryCore.Interfaces.ILookupValue_1[[ILookupValue< TObject >]] + class SharedLibraryCore.Interfaces.ILookupValue_1 interfaceStyle; + + end +SharedLibraryCore.Interfaces.ILookupValue_1 --> SharedLibraryCore.Dtos.LookupValue_1 +``` + +## Members +### Properties +#### Public properties +| Type | Name | Methods | +| --- | --- | --- | +| `int` | [`Id`](#id) | `get, set` | +| `TObject` | [`Value`](#value) | `get, set` | + +## Details +### Inheritance + - [`ILookupValue`](./sharedlibrarycoreinterfaces-ILookupValueT)<`TObject`> + +### Constructors +#### LookupValue +```csharp +public LookupValue() +``` + +### Properties +#### Id +```csharp +public int Id { get; set; } +``` + +#### Value +```csharp +public TObject Value { get; set; } +``` + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoredtos-Page.md b/CodeDocumentation/SharedLibraryCore/sharedlibrarycoredtos-Page.md new file mode 100644 index 0000000..dc40173 --- /dev/null +++ b/CodeDocumentation/SharedLibraryCore/sharedlibrarycoredtos-Page.md @@ -0,0 +1,39 @@ +# Page `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph SharedLibraryCore.Dtos + SharedLibraryCore.Dtos.Page[[Page]] + end +``` + +## Members +### Properties +#### Public properties +| Type | Name | Methods | +| --- | --- | --- | +| `string` | [`Location`](#location) | `get, set` | +| `string` | [`Name`](#name) | `get, set` | + +## Details +### Constructors +#### Page +```csharp +public Page() +``` + +### Properties +#### Name +```csharp +public string Name { get; set; } +``` + +#### Location +```csharp +public string Location { get; set; } +``` + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoredtos-PaginationRequest.md b/CodeDocumentation/SharedLibraryCore/sharedlibrarycoredtos-PaginationRequest.md new file mode 100644 index 0000000..ee7fd2e --- /dev/null +++ b/CodeDocumentation/SharedLibraryCore/sharedlibrarycoredtos-PaginationRequest.md @@ -0,0 +1,77 @@ +# PaginationRequest `Public class` + +## Description +pagination information holder class + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph SharedLibraryCore.Dtos + SharedLibraryCore.Dtos.PaginationRequest[[PaginationRequest]] + end +``` + +## Members +### Properties +#### Public properties +| Type | Name | Methods | +| --- | --- | --- | +| `Nullable`<`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` | +| `string` | [`Filter`](#filter)
filter query | `get, set` | +| `int` | [`Offset`](#offset)
how many items to skip | `get, set` | + +## Details +### Summary +pagination information holder class + +### Constructors +#### PaginationRequest +```csharp +public PaginationRequest() +``` + +### Properties +#### Offset +```csharp +public int Offset { get; set; } +``` +##### Summary +how many items to skip + +#### Count +```csharp +public int Count { get; set; } +``` +##### Summary +how many items to take + +#### Filter +```csharp +public string Filter { get; set; } +``` +##### Summary +filter query + +#### Direction +```csharp +public SortDirection Direction { get; set; } +``` +##### Summary +direction of ordering + +#### Before +```csharp +public Nullable Before { get; set; } +``` + +#### After +```csharp +public Nullable After { get; set; } +``` + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoredtos-PenaltyInfo.md b/CodeDocumentation/SharedLibraryCore/sharedlibrarycoredtos-PenaltyInfo.md new file mode 100644 index 0000000..70ca441 --- /dev/null +++ b/CodeDocumentation/SharedLibraryCore/sharedlibrarycoredtos-PenaltyInfo.md @@ -0,0 +1,172 @@ +# PenaltyInfo `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph SharedLibraryCore.Dtos + SharedLibraryCore.Dtos.PenaltyInfo[[PenaltyInfo]] + SharedLibraryCore.Dtos.SharedInfo[[SharedInfo]] + end +SharedLibraryCore.Dtos.SharedInfo --> SharedLibraryCore.Dtos.PenaltyInfo +``` + +## Members +### Properties +#### Public properties +| Type | Name | Methods | +| --- | --- | --- | +| `string` | [`AdditionalPenaltyInformation`](#additionalpenaltyinformation) | `get` | +| `string` | [`AutomatedOffense`](#automatedoffense) | `get, set` | +| `bool` | [`Expired`](#expired) | `get` | +| `Nullable`<`DateTime`> | [`Expires`](#expires) | `get, set` | +| `bool` | [`IsEvade`](#isevade) | `get, set` | +| `string` | [`OffenderIPAddress`](#offenderipaddress) | `get, set` | +| `int` | [`OffenderId`](#offenderid) | `get, set` | +| `Permission` | [`OffenderLevel`](#offenderlevel) | `get, set` | +| `string` | [`OffenderName`](#offendername) | `get, set` | +| `ulong` | [`OffenderNetworkId`](#offendernetworkid) | `get, set` | +| `string` | [`Offense`](#offense) | `get, set` | +| `PenaltyType` | [`PenaltyType`](#penaltytype) | `get, set` | +| `string` | [`PenaltyTypeText`](#penaltytypetext) | `get` | +| `string` | [`PunisherIPAddress`](#punisheripaddress) | `get, set` | +| `int` | [`PunisherId`](#punisherid) | `get, set` | +| `Permission` | [`PunisherLevel`](#punisherlevel) | `get, set` | +| `string` | [`PunisherLevelText`](#punisherleveltext) | `get` | +| `string` | [`PunisherName`](#punishername) | `get, set` | +| `ulong` | [`PunisherNetworkId`](#punishernetworkid) | `get, set` | +| `bool` | [`Sensitive`](#sensitive) | `get` | +| `DateTime` | [`TimePunished`](#timepunished) | `get, set` | +| `string` | [`TimePunishedString`](#timepunishedstring) | `get` | +| `string` | [`TimeRemaining`](#timeremaining) | `get` | + +## Details +### Inheritance + - [ +`SharedInfo` +](./sharedlibrarycoredtos-SharedInfo) + +### Constructors +#### PenaltyInfo +```csharp +public PenaltyInfo() +``` + +### Properties +#### OffenderName +```csharp +public string OffenderName { get; set; } +``` + +#### OffenderLevel +```csharp +public Permission OffenderLevel { get; set; } +``` + +#### OffenderId +```csharp +public int OffenderId { get; set; } +``` + +#### OffenderNetworkId +```csharp +public ulong OffenderNetworkId { get; set; } +``` + +#### OffenderIPAddress +```csharp +public string OffenderIPAddress { get; set; } +``` + +#### PunisherName +```csharp +public string PunisherName { get; set; } +``` + +#### PunisherId +```csharp +public int PunisherId { get; set; } +``` + +#### PunisherNetworkId +```csharp +public ulong PunisherNetworkId { get; set; } +``` + +#### PunisherIPAddress +```csharp +public string PunisherIPAddress { get; set; } +``` + +#### PunisherLevel +```csharp +public Permission PunisherLevel { get; set; } +``` + +#### PunisherLevelText +```csharp +public string PunisherLevelText { get; } +``` + +#### Offense +```csharp +public string Offense { get; set; } +``` + +#### AutomatedOffense +```csharp +public string AutomatedOffense { get; set; } +``` + +#### PenaltyType +```csharp +public PenaltyType PenaltyType { get; set; } +``` + +#### PenaltyTypeText +```csharp +public string PenaltyTypeText { get; } +``` + +#### TimePunished +```csharp +public DateTime TimePunished { get; set; } +``` + +#### TimePunishedString +```csharp +public string TimePunishedString { get; } +``` + +#### TimeRemaining +```csharp +public string TimeRemaining { get; } +``` + +#### Expired +```csharp +public bool Expired { get; } +``` + +#### Expires +```csharp +public Nullable Expires { get; set; } +``` + +#### Sensitive +```csharp +public override bool Sensitive { get; } +``` + +#### IsEvade +```csharp +public bool IsEvade { get; set; } +``` + +#### AdditionalPenaltyInformation +```csharp +public string AdditionalPenaltyInformation { get; } +``` + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoredtos-PlayerInfo.md b/CodeDocumentation/SharedLibraryCore/sharedlibrarycoredtos-PlayerInfo.md new file mode 100644 index 0000000..7c852bc --- /dev/null +++ b/CodeDocumentation/SharedLibraryCore/sharedlibrarycoredtos-PlayerInfo.md @@ -0,0 +1,189 @@ +# PlayerInfo `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph SharedLibraryCore.Dtos + SharedLibraryCore.Dtos.PlayerInfo[[PlayerInfo]] + end +``` + +## Members +### Properties +#### Public properties +| Type | Name | Methods | +| --- | --- | --- | +| `EFPenalty` | [`ActivePenalty`](#activepenalty) | `get, set` | +| `string` | [`ActivePenaltyType`](#activepenaltytype) | `get, set` | +| `List`<(`string` Item1, `DateTime` Item2)> | [`Aliases`](#aliases) | `get, set` | +| `bool` | [`Authenticated`](#authenticated) | `get, set` | +| `int` | [`ClientId`](#clientid) | `get, set` | +| `string` | [`ConnectProtocolUrl`](#connectprotocolurl) | `get, set` | +| `string` | [`CurrentServerName`](#currentservername) | `get, set` | +| `Game` | [`Game`](#game) | `get, set` | +| [`IGeoLocationResult`](./sharedlibrarycoreinterfaces-IGeoLocationResult) | [`GeoLocationInfo`](#geolocationinfo) | `get, set` | +| `bool` | [`HasActivePenalty`](#hasactivepenalty) | `get, set` | +| `string` | [`IPAddress`](#ipaddress) | `get, set` | +| `List`<(`string` Item1, `DateTime` Item2)> | [`IPs`](#ips) | `get, set` | +| `List`<[`IInteractionData`](./sharedlibrarycoreinterfaces-IInteractionData)> | [`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` | +| `string` | [`Name`](#name) | `get, set` | +| `long` | [`NetworkId`](#networkid) | `get, set` | +| [`ClientNoteMetaResponse`](./sharedlibrarycoredtosmetaresponses-ClientNoteMetaResponse) | [`NoteMeta`](#notemeta) | `get, set` | +| `bool` | [`Online`](#online) | `get, set` | +| `string` | [`Tag`](#tag) | `get, set` | +| `string` | [`TimeOnline`](#timeonline) | `get, set` | +| `Nullable`<`double`> | [`ZScore`](#zscore) | `get, set` | + +## Details +### Constructors +#### PlayerInfo +```csharp +public PlayerInfo() +``` + +### Properties +#### Name +```csharp +public string Name { get; set; } +``` + +#### Game +```csharp +public Game Game { get; set; } +``` + +#### ClientId +```csharp +public int ClientId { get; set; } +``` + +#### Level +```csharp +public string Level { get; set; } +``` + +#### Tag +```csharp +public string Tag { get; set; } +``` + +#### LevelInt +```csharp +public int LevelInt { get; set; } +``` + +#### IPAddress +```csharp +public string IPAddress { get; set; } +``` + +#### NetworkId +```csharp +public long NetworkId { get; set; } +``` + +#### Aliases +```csharp +public List<(string Item1, DateTime Item2)> Aliases { get; set; } +``` + +#### IPs +```csharp +public List<(string Item1, DateTime Item2)> IPs { get; set; } +``` + +#### HasActivePenalty +```csharp +public bool HasActivePenalty { get; set; } +``` + +#### ActivePenaltyType +```csharp +public string ActivePenaltyType { get; set; } +``` + +#### Authenticated +```csharp +public bool Authenticated { get; set; } +``` + +#### Meta +```csharp +public List Meta { get; set; } +``` + +#### ActivePenalty +```csharp +public EFPenalty ActivePenalty { get; set; } +``` + +#### Online +```csharp +public bool Online { get; set; } +``` + +#### TimeOnline +```csharp +public string TimeOnline { get; set; } +``` + +#### LastConnection +```csharp +public DateTime LastConnection { get; set; } +``` + +#### LastConnectionText +```csharp +public string LastConnectionText { get; } +``` + +#### LinkedAccounts +```csharp +public IDictionary LinkedAccounts { get; set; } +``` + +#### MetaFilterType +```csharp +public Nullable MetaFilterType { get; set; } +``` + +#### ZScore +```csharp +public Nullable ZScore { get; set; } +``` + +#### ConnectProtocolUrl +```csharp +public string ConnectProtocolUrl { get; set; } +``` + +#### CurrentServerName +```csharp +public string CurrentServerName { get; set; } +``` + +#### GeoLocationInfo +```csharp +public IGeoLocationResult GeoLocationInfo { get; set; } +``` + +#### NoteMeta +```csharp +public ClientNoteMetaResponse NoteMeta { get; set; } +``` + +#### Interactions +```csharp +public List Interactions { get; set; } +``` + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoredtos-ServerInfo.md b/CodeDocumentation/SharedLibraryCore/sharedlibrarycoredtos-ServerInfo.md new file mode 100644 index 0000000..99254cb --- /dev/null +++ b/CodeDocumentation/SharedLibraryCore/sharedlibrarycoredtos-ServerInfo.md @@ -0,0 +1,147 @@ +# ServerInfo `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph SharedLibraryCore.Dtos + SharedLibraryCore.Dtos.ServerInfo[[ServerInfo]] + end +``` + +## Members +### Properties +#### Public properties +| Type | Name | Methods | +| --- | --- | --- | +| `List`<[`ChatInfo`](./sharedlibrarycoredtos-ChatInfo)> | [`ChatHistory`](#chathistory) | `get, set` | +| `int` | [`ClientCount`](#clientcount) | `get, set` | +| [`ClientHistoryInfo`](./sharedlibrarycoredtos-ClientHistoryInfo) | [`ClientHistory`](#clienthistory) | `get, set` | +| `string` | [`ConnectProtocolUrl`](#connectprotocolurl) | `get, set` | +| `string` | [`Endpoint`](#endpoint) | `get` | +| `string` | [`ExternalIPAddress`](#externalipaddress) | `get, set` | +| `Game` | [`Game`](#game) | `get, set` | +| `string` | [`GameType`](#gametype) | `get, set` | +| `long` | [`ID`](#id) | `get, set` | +| `string` | [`IPAddress`](#ipaddress) | `get, set` | +| `bool` | [`IsPasswordProtected`](#ispasswordprotected) | `get, set` | +| `Nullable`<`double`> | [`LobbyZScore`](#lobbyzscore) | `get` | +| `string` | [`Map`](#map) | `get, set` | +| `int` | [`MaxClients`](#maxclients) | `get, set` | +| `string` | [`Name`](#name) | `get, set` | +| `bool` | [`Online`](#online) | `get, set` | +| `List`<[`PlayerInfo`](./sharedlibrarycoredtos-PlayerInfo)> | [`Players`](#players) | `get, set` | +| `int` | [`Port`](#port) | `get, set` | +| `int` | [`PrivateClientSlots`](#privateclientslots) | `get, set` | +| `List`<[`Report`](./sharedlibrarycorehelpers-Report)> | [`Reports`](#reports) | `get, set` | + +## Details +### Constructors +#### ServerInfo +```csharp +public ServerInfo() +``` + +### Properties +#### Name +```csharp +public string Name { get; set; } +``` + +#### Port +```csharp +public int Port { get; set; } +``` + +#### Map +```csharp +public string Map { get; set; } +``` + +#### GameType +```csharp +public string GameType { get; set; } +``` + +#### ClientCount +```csharp +public int ClientCount { get; set; } +``` + +#### MaxClients +```csharp +public int MaxClients { get; set; } +``` + +#### PrivateClientSlots +```csharp +public int PrivateClientSlots { get; set; } +``` + +#### ChatHistory +```csharp +public List ChatHistory { get; set; } +``` + +#### Players +```csharp +public List Players { get; set; } +``` + +#### Reports +```csharp +public List Reports { get; set; } +``` + +#### ClientHistory +```csharp +public ClientHistoryInfo ClientHistory { get; set; } +``` + +#### ID +```csharp +public long ID { get; set; } +``` + +#### Online +```csharp +public bool Online { get; set; } +``` + +#### ConnectProtocolUrl +```csharp +public string ConnectProtocolUrl { get; set; } +``` + +#### IPAddress +```csharp +public string IPAddress { get; set; } +``` + +#### ExternalIPAddress +```csharp +public string ExternalIPAddress { get; set; } +``` + +#### IsPasswordProtected +```csharp +public bool IsPasswordProtected { get; set; } +``` + +#### Endpoint +```csharp +public string Endpoint { get; } +``` + +#### LobbyZScore +```csharp +public Nullable LobbyZScore { get; } +``` + +#### Game +```csharp +public Game Game { get; set; } +``` + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoredtos-SharedInfo.md b/CodeDocumentation/SharedLibraryCore/sharedlibrarycoredtos-SharedInfo.md new file mode 100644 index 0000000..85b0b23 --- /dev/null +++ b/CodeDocumentation/SharedLibraryCore/sharedlibrarycoredtos-SharedInfo.md @@ -0,0 +1,45 @@ +# SharedInfo `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph SharedLibraryCore.Dtos + SharedLibraryCore.Dtos.SharedInfo[[SharedInfo]] + end +``` + +## Members +### Properties +#### Public properties +| Type | Name | Methods | +| --- | --- | --- | +| `int` | [`Id`](#id) | `get, set` | +| `bool` | [`Sensitive`](#sensitive) | `get, set` | +| `bool` | [`Show`](#show) | `get, set` | + +## Details +### Constructors +#### SharedInfo +```csharp +public SharedInfo() +``` + +### Properties +#### Sensitive +```csharp +public virtual bool Sensitive { get; set; } +``` + +#### Show +```csharp +public bool Show { get; set; } +``` + +#### Id +```csharp +public int Id { get; set; } +``` + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoredtos-SortDirection.md b/CodeDocumentation/SharedLibraryCore/sharedlibrarycoredtos-SortDirection.md new file mode 100644 index 0000000..b7a9544 --- /dev/null +++ b/CodeDocumentation/SharedLibraryCore/sharedlibrarycoredtos-SortDirection.md @@ -0,0 +1,21 @@ +# SortDirection `Public enum` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph SharedLibraryCore.Dtos + SharedLibraryCore.Dtos.SortDirection[[SortDirection]] + end +``` + +## Details +### Fields +#### Ascending + + +#### Descending + + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoredtosmeta-WebfrontTranslationHelper.md b/CodeDocumentation/SharedLibraryCore/sharedlibrarycoredtosmeta-WebfrontTranslationHelper.md new file mode 100644 index 0000000..16043ca --- /dev/null +++ b/CodeDocumentation/SharedLibraryCore/sharedlibrarycoredtosmeta-WebfrontTranslationHelper.md @@ -0,0 +1,45 @@ +# WebfrontTranslationHelper `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph SharedLibraryCore.Dtos.Meta + SharedLibraryCore.Dtos.Meta.WebfrontTranslationHelper[[WebfrontTranslationHelper]] + end +``` + +## Members +### Properties +#### Public properties +| Type | Name | Methods | +| --- | --- | --- | +| `bool` | [`IsInterpolation`](#isinterpolation) | `get, set` | +| `string` | [`MatchValue`](#matchvalue) | `get, set` | +| `string` | [`TranslationValue`](#translationvalue) | `get, set` | + +## Details +### Constructors +#### WebfrontTranslationHelper +```csharp +public WebfrontTranslationHelper() +``` + +### Properties +#### IsInterpolation +```csharp +public bool IsInterpolation { get; set; } +``` + +#### MatchValue +```csharp +public string MatchValue { get; set; } +``` + +#### TranslationValue +```csharp +public string TranslationValue { get; set; } +``` + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoredtosmetarequests-BaseClientMetaRequest.md b/CodeDocumentation/SharedLibraryCore/sharedlibrarycoredtosmetarequests-BaseClientMetaRequest.md new file mode 100644 index 0000000..d919ea7 --- /dev/null +++ b/CodeDocumentation/SharedLibraryCore/sharedlibrarycoredtosmetarequests-BaseClientMetaRequest.md @@ -0,0 +1,42 @@ +# BaseClientMetaRequest `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph SharedLibraryCore.Dtos.Meta.Requests + SharedLibraryCore.Dtos.Meta.Requests.BaseClientMetaRequest[[BaseClientMetaRequest]] + end + subgraph SharedLibraryCore.Dtos + SharedLibraryCore.Dtos.PaginationRequest[[PaginationRequest]] + end +SharedLibraryCore.Dtos.PaginationRequest --> SharedLibraryCore.Dtos.Meta.Requests.BaseClientMetaRequest +``` + +## Members +### Properties +#### Public properties +| Type | Name | Methods | +| --- | --- | --- | +| `int` | [`ClientId`](#clientid) | `get, set` | + +## Details +### Inheritance + - [ +`PaginationRequest` +](./sharedlibrarycoredtos-PaginationRequest) + +### Constructors +#### BaseClientMetaRequest +```csharp +public BaseClientMetaRequest() +``` + +### Properties +#### ClientId +```csharp +public int ClientId { get; set; } +``` + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoredtosmetarequests-ReceivedPenaltyRequest.md b/CodeDocumentation/SharedLibraryCore/sharedlibrarycoredtosmetarequests-ReceivedPenaltyRequest.md new file mode 100644 index 0000000..794b547 --- /dev/null +++ b/CodeDocumentation/SharedLibraryCore/sharedlibrarycoredtosmetarequests-ReceivedPenaltyRequest.md @@ -0,0 +1,27 @@ +# ReceivedPenaltyRequest `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph SharedLibraryCore.Dtos.Meta.Requests + SharedLibraryCore.Dtos.Meta.Requests.ReceivedPenaltyRequest[[ReceivedPenaltyRequest]] + SharedLibraryCore.Dtos.Meta.Requests.BaseClientMetaRequest[[BaseClientMetaRequest]] + end +SharedLibraryCore.Dtos.Meta.Requests.BaseClientMetaRequest --> SharedLibraryCore.Dtos.Meta.Requests.ReceivedPenaltyRequest +``` + +## Details +### Inheritance + - [ +`BaseClientMetaRequest` +](./sharedlibrarycoredtosmetarequests-BaseClientMetaRequest) + +### Constructors +#### ReceivedPenaltyRequest +```csharp +public ReceivedPenaltyRequest() +``` + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoredtosmetaresponses-AdministeredPenaltyResponse.md b/CodeDocumentation/SharedLibraryCore/sharedlibrarycoredtosmetaresponses-AdministeredPenaltyResponse.md new file mode 100644 index 0000000..1132f14 --- /dev/null +++ b/CodeDocumentation/SharedLibraryCore/sharedlibrarycoredtosmetaresponses-AdministeredPenaltyResponse.md @@ -0,0 +1,27 @@ +# AdministeredPenaltyResponse `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph SharedLibraryCore.Dtos.Meta.Responses + SharedLibraryCore.Dtos.Meta.Responses.AdministeredPenaltyResponse[[AdministeredPenaltyResponse]] + SharedLibraryCore.Dtos.Meta.Responses.ReceivedPenaltyResponse[[ReceivedPenaltyResponse]] + end +SharedLibraryCore.Dtos.Meta.Responses.ReceivedPenaltyResponse --> SharedLibraryCore.Dtos.Meta.Responses.AdministeredPenaltyResponse +``` + +## Details +### Inheritance + - [ +`ReceivedPenaltyResponse` +](./sharedlibrarycoredtosmetaresponses-ReceivedPenaltyResponse) + +### Constructors +#### AdministeredPenaltyResponse +```csharp +public AdministeredPenaltyResponse() +``` + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoredtosmetaresponses-BaseMetaResponse.md b/CodeDocumentation/SharedLibraryCore/sharedlibrarycoredtosmetaresponses-BaseMetaResponse.md new file mode 100644 index 0000000..1315692 --- /dev/null +++ b/CodeDocumentation/SharedLibraryCore/sharedlibrarycoredtosmetaresponses-BaseMetaResponse.md @@ -0,0 +1,91 @@ +# BaseMetaResponse `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph SharedLibraryCore.Dtos.Meta.Responses + SharedLibraryCore.Dtos.Meta.Responses.BaseMetaResponse[[BaseMetaResponse]] + end + subgraph SharedLibraryCore.Interfaces + SharedLibraryCore.Interfaces.IClientMeta[[IClientMeta]] + class SharedLibraryCore.Interfaces.IClientMeta interfaceStyle; + SharedLibraryCore.Interfaces.IClientMetaResponse[[IClientMetaResponse]] + class SharedLibraryCore.Interfaces.IClientMetaResponse interfaceStyle; + end +SharedLibraryCore.Interfaces.IClientMeta --> SharedLibraryCore.Dtos.Meta.Responses.BaseMetaResponse +SharedLibraryCore.Interfaces.IClientMetaResponse --> SharedLibraryCore.Dtos.Meta.Responses.BaseMetaResponse +``` + +## Members +### Properties +#### Public properties +| Type | Name | Methods | +| --- | --- | --- | +| `int` | [`ClientId`](#clientid) | `get, set` | +| `Nullable`<`int`> | [`Column`](#column) | `get, set` | +| `bool` | [`IsSensitive`](#issensitive) | `get, set` | +| `long` | [`MetaId`](#metaid) | `get, set` | +| `Nullable`<`int`> | [`Order`](#order) | `get, set` | +| `bool` | [`ShouldDisplay`](#shoulddisplay) | `get, set` | +| [`MetaType`](./sharedlibrarycoreinterfaces-MetaType) | [`Type`](#type) | `get, set` | +| `DateTime` | [`When`](#when) | `get, set` | + +## Details +### Inheritance + - [ +`IClientMeta` +](./sharedlibrarycoreinterfaces-IClientMeta) + - [ +`IClientMetaResponse` +](./sharedlibrarycoreinterfaces-IClientMetaResponse) + +### Constructors +#### BaseMetaResponse +```csharp +public BaseMetaResponse() +``` + +### Properties +#### Type +```csharp +public MetaType Type { get; set; } +``` + +#### When +```csharp +public DateTime When { get; set; } +``` + +#### IsSensitive +```csharp +public bool IsSensitive { get; set; } +``` + +#### ShouldDisplay +```csharp +public bool ShouldDisplay { get; set; } +``` + +#### Column +```csharp +public virtual Nullable Column { get; set; } +``` + +#### Order +```csharp +public virtual Nullable Order { get; set; } +``` + +#### MetaId +```csharp +public long MetaId { get; set; } +``` + +#### ClientId +```csharp +public int ClientId { get; set; } +``` + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoredtosmetaresponses-ClientNoteMetaResponse.md b/CodeDocumentation/SharedLibraryCore/sharedlibrarycoredtosmetaresponses-ClientNoteMetaResponse.md new file mode 100644 index 0000000..9e626a1 --- /dev/null +++ b/CodeDocumentation/SharedLibraryCore/sharedlibrarycoredtosmetaresponses-ClientNoteMetaResponse.md @@ -0,0 +1,51 @@ +# ClientNoteMetaResponse `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph SharedLibraryCore.Dtos.Meta.Responses + SharedLibraryCore.Dtos.Meta.Responses.ClientNoteMetaResponse[[ClientNoteMetaResponse]] + end +``` + +## Members +### Properties +#### Public properties +| Type | Name | Methods | +| --- | --- | --- | +| `DateTime` | [`ModifiedDate`](#modifieddate) | `get, set` | +| `string` | [`Note`](#note) | `get, set` | +| `int` | [`OriginEntityId`](#originentityid) | `get, set` | +| `string` | [`OriginEntityName`](#originentityname) | `get, set` | + +## Details +### Constructors +#### ClientNoteMetaResponse +```csharp +public ClientNoteMetaResponse() +``` + +### Properties +#### Note +```csharp +public string Note { get; set; } +``` + +#### OriginEntityId +```csharp +public int OriginEntityId { get; set; } +``` + +#### OriginEntityName +```csharp +public string OriginEntityName { get; set; } +``` + +#### ModifiedDate +```csharp +public DateTime ModifiedDate { get; set; } +``` + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoredtosmetaresponses-ConnectionHistoryResponse.md b/CodeDocumentation/SharedLibraryCore/sharedlibrarycoredtosmetaresponses-ConnectionHistoryResponse.md new file mode 100644 index 0000000..081265a --- /dev/null +++ b/CodeDocumentation/SharedLibraryCore/sharedlibrarycoredtosmetaresponses-ConnectionHistoryResponse.md @@ -0,0 +1,46 @@ +# ConnectionHistoryResponse `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph SharedLibraryCore.Dtos.Meta.Responses + SharedLibraryCore.Dtos.Meta.Responses.ConnectionHistoryResponse[[ConnectionHistoryResponse]] + SharedLibraryCore.Dtos.Meta.Responses.BaseMetaResponse[[BaseMetaResponse]] + end +SharedLibraryCore.Dtos.Meta.Responses.BaseMetaResponse --> SharedLibraryCore.Dtos.Meta.Responses.ConnectionHistoryResponse +``` + +## Members +### Properties +#### Public properties +| Type | Name | Methods | +| --- | --- | --- | +| `ConnectionType` | [`ConnectionType`](#connectiontype) | `get, set` | +| `string` | [`ServerName`](#servername) | `get, set` | + +## Details +### Inheritance + - [ +`BaseMetaResponse` +](./sharedlibrarycoredtosmetaresponses-BaseMetaResponse) + +### Constructors +#### ConnectionHistoryResponse +```csharp +public ConnectionHistoryResponse() +``` + +### Properties +#### ServerName +```csharp +public string ServerName { get; set; } +``` + +#### ConnectionType +```csharp +public ConnectionType ConnectionType { get; set; } +``` + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoredtosmetaresponses-InformationResponse.md b/CodeDocumentation/SharedLibraryCore/sharedlibrarycoredtosmetaresponses-InformationResponse.md new file mode 100644 index 0000000..7456615 --- /dev/null +++ b/CodeDocumentation/SharedLibraryCore/sharedlibrarycoredtosmetaresponses-InformationResponse.md @@ -0,0 +1,52 @@ +# InformationResponse `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph SharedLibraryCore.Dtos.Meta.Responses + SharedLibraryCore.Dtos.Meta.Responses.InformationResponse[[InformationResponse]] + SharedLibraryCore.Dtos.Meta.Responses.BaseMetaResponse[[BaseMetaResponse]] + end +SharedLibraryCore.Dtos.Meta.Responses.BaseMetaResponse --> SharedLibraryCore.Dtos.Meta.Responses.InformationResponse +``` + +## Members +### Properties +#### Public properties +| Type | Name | Methods | +| --- | --- | --- | +| `string` | [`Key`](#key) | `get, set` | +| `string` | [`ToolTipText`](#tooltiptext) | `get, set` | +| `string` | [`Value`](#value) | `get, set` | + +## Details +### Inheritance + - [ +`BaseMetaResponse` +](./sharedlibrarycoredtosmetaresponses-BaseMetaResponse) + +### Constructors +#### InformationResponse +```csharp +public InformationResponse() +``` + +### Properties +#### Key +```csharp +public string Key { get; set; } +``` + +#### Value +```csharp +public string Value { get; set; } +``` + +#### ToolTipText +```csharp +public string ToolTipText { get; set; } +``` + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoredtosmetaresponses-MessageResponse.md b/CodeDocumentation/SharedLibraryCore/sharedlibrarycoredtosmetaresponses-MessageResponse.md new file mode 100644 index 0000000..5e44fa3 --- /dev/null +++ b/CodeDocumentation/SharedLibraryCore/sharedlibrarycoredtosmetaresponses-MessageResponse.md @@ -0,0 +1,98 @@ +# MessageResponse `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph SharedLibraryCore.Dtos.Meta.Responses + SharedLibraryCore.Dtos.Meta.Responses.MessageResponse[[MessageResponse]] + SharedLibraryCore.Dtos.Meta.Responses.BaseMetaResponse[[BaseMetaResponse]] + end +SharedLibraryCore.Dtos.Meta.Responses.BaseMetaResponse --> SharedLibraryCore.Dtos.Meta.Responses.MessageResponse +``` + +## Members +### Properties +#### Public properties +| Type | Name | Methods | +| --- | --- | --- | +| `string` | [`ClientName`](#clientname)
name of the client | `get, set` | +| `Game` | [`GameName`](#gamename)
specifies the game the chat occured on | `get, set` | +| `string` | [`HiddenMessage`](#hiddenmessage) | `get` | +| `bool` | [`IsHidden`](#ishidden) | `get, set` | +| `bool` | [`IsQuickMessage`](#isquickmessage)
indicates if the chat message is a quick message phrase | `get, set` | +| `string` | [`Message`](#message) | `get, set` | +| `bool` | [`SentIngame`](#sentingame)
indicates if the message was sent ingame | `get, set` | +| `long` | [`ServerId`](#serverid) | `get, set` | +| `string` | [`ServerName`](#servername)
hostname of the server | `get, set` | + +## Details +### Inheritance + - [ +`BaseMetaResponse` +](./sharedlibrarycoredtosmetaresponses-BaseMetaResponse) + +### Constructors +#### MessageResponse +```csharp +public MessageResponse() +``` + +### Properties +#### ServerId +```csharp +public long ServerId { get; set; } +``` + +#### Message +```csharp +public string Message { get; set; } +``` + +#### IsHidden +```csharp +public bool IsHidden { get; set; } +``` + +#### ClientName +```csharp +public string ClientName { get; set; } +``` +##### Summary +name of the client + +#### ServerName +```csharp +public string ServerName { get; set; } +``` +##### Summary +hostname of the server + +#### GameName +```csharp +public Game GameName { get; set; } +``` +##### Summary +specifies the game the chat occured on + +#### IsQuickMessage +```csharp +public bool IsQuickMessage { get; set; } +``` +##### Summary +indicates if the chat message is a quick message phrase + +#### SentIngame +```csharp +public bool SentIngame { get; set; } +``` +##### Summary +indicates if the message was sent ingame + +#### HiddenMessage +```csharp +public string HiddenMessage { get; } +``` + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoredtosmetaresponses-PermissionLevelChangedResponse.md b/CodeDocumentation/SharedLibraryCore/sharedlibrarycoredtosmetaresponses-PermissionLevelChangedResponse.md new file mode 100644 index 0000000..42a5a76 --- /dev/null +++ b/CodeDocumentation/SharedLibraryCore/sharedlibrarycoredtosmetaresponses-PermissionLevelChangedResponse.md @@ -0,0 +1,70 @@ +# PermissionLevelChangedResponse `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph SharedLibraryCore.Dtos.Meta.Responses + SharedLibraryCore.Dtos.Meta.Responses.PermissionLevelChangedResponse[[PermissionLevelChangedResponse]] + SharedLibraryCore.Dtos.Meta.Responses.BaseMetaResponse[[BaseMetaResponse]] + end +SharedLibraryCore.Dtos.Meta.Responses.BaseMetaResponse --> SharedLibraryCore.Dtos.Meta.Responses.PermissionLevelChangedResponse +``` + +## Members +### Properties +#### Public properties +| Type | Name | Methods | +| --- | --- | --- | +| `int` | [`ChangedById`](#changedbyid) | `get, set` | +| `string` | [`ChangedByName`](#changedbyname) | `get, set` | +| `Permission` | [`CurrentPermissionLevel`](#currentpermissionlevel) | `get` | +| `string` | [`CurrentPermissionLevelValue`](#currentpermissionlevelvalue) | `get, set` | +| `Permission` | [`PreviousPermissionLevel`](#previouspermissionlevel) | `get` | +| `string` | [`PreviousPermissionLevelValue`](#previouspermissionlevelvalue) | `get, set` | + +## Details +### Inheritance + - [ +`BaseMetaResponse` +](./sharedlibrarycoredtosmetaresponses-BaseMetaResponse) + +### Constructors +#### PermissionLevelChangedResponse +```csharp +public PermissionLevelChangedResponse() +``` + +### Properties +#### PreviousPermissionLevel +```csharp +public Permission PreviousPermissionLevel { get; } +``` + +#### PreviousPermissionLevelValue +```csharp +public string PreviousPermissionLevelValue { get; set; } +``` + +#### CurrentPermissionLevel +```csharp +public Permission CurrentPermissionLevel { get; } +``` + +#### CurrentPermissionLevelValue +```csharp +public string CurrentPermissionLevelValue { get; set; } +``` + +#### ChangedById +```csharp +public int ChangedById { get; set; } +``` + +#### ChangedByName +```csharp +public string ChangedByName { get; set; } +``` + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoredtosmetaresponses-ReceivedPenaltyResponse.md b/CodeDocumentation/SharedLibraryCore/sharedlibrarycoredtosmetaresponses-ReceivedPenaltyResponse.md new file mode 100644 index 0000000..1664e20 --- /dev/null +++ b/CodeDocumentation/SharedLibraryCore/sharedlibrarycoredtosmetaresponses-ReceivedPenaltyResponse.md @@ -0,0 +1,112 @@ +# ReceivedPenaltyResponse `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph SharedLibraryCore.Dtos.Meta.Responses + SharedLibraryCore.Dtos.Meta.Responses.ReceivedPenaltyResponse[[ReceivedPenaltyResponse]] + SharedLibraryCore.Dtos.Meta.Responses.BaseMetaResponse[[BaseMetaResponse]] + end +SharedLibraryCore.Dtos.Meta.Responses.BaseMetaResponse --> SharedLibraryCore.Dtos.Meta.Responses.ReceivedPenaltyResponse +``` + +## Members +### Properties +#### Public properties +| Type | Name | Methods | +| --- | --- | --- | +| `string` | [`AutomatedOffense`](#automatedoffense) | `get, set` | +| `Nullable`<`DateTime`> | [`ExpirationDate`](#expirationdate) | `get, set` | +| `string` | [`ExpiresInText`](#expiresintext) | `get` | +| `bool` | [`IsLinked`](#islinked) | `get, set` | +| `string` | [`LengthText`](#lengthtext) | `get` | +| `int` | [`LinkedClientId`](#linkedclientid) | `get, set` | +| `int` | [`OffenderClientId`](#offenderclientid) | `get, set` | +| `string` | [`OffenderName`](#offendername) | `get, set` | +| `string` | [`Offense`](#offense) | `get, set` | +| `int` | [`PenaltyId`](#penaltyid) | `get, set` | +| `PenaltyType` | [`PenaltyType`](#penaltytype) | `get, set` | +| `int` | [`PunisherClientId`](#punisherclientid) | `get, set` | +| `string` | [`PunisherName`](#punishername) | `get, set` | + +## Details +### Inheritance + - [ +`BaseMetaResponse` +](./sharedlibrarycoredtosmetaresponses-BaseMetaResponse) + +### Constructors +#### ReceivedPenaltyResponse +```csharp +public ReceivedPenaltyResponse() +``` + +### Properties +#### PenaltyId +```csharp +public int PenaltyId { get; set; } +``` + +#### OffenderClientId +```csharp +public int OffenderClientId { get; set; } +``` + +#### OffenderName +```csharp +public string OffenderName { get; set; } +``` + +#### PunisherName +```csharp +public string PunisherName { get; set; } +``` + +#### PunisherClientId +```csharp +public int PunisherClientId { get; set; } +``` + +#### PenaltyType +```csharp +public PenaltyType PenaltyType { get; set; } +``` + +#### Offense +```csharp +public string Offense { get; set; } +``` + +#### AutomatedOffense +```csharp +public string AutomatedOffense { get; set; } +``` + +#### ExpirationDate +```csharp +public Nullable ExpirationDate { get; set; } +``` + +#### ExpiresInText +```csharp +public string ExpiresInText { get; } +``` + +#### LengthText +```csharp +public string LengthText { get; } +``` + +#### IsLinked +```csharp +public bool IsLinked { get; set; } +``` + +#### LinkedClientId +```csharp +public int LinkedClientId { get; set; } +``` + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoredtosmetaresponses-UpdatedAliasResponse.md b/CodeDocumentation/SharedLibraryCore/sharedlibrarycoredtosmetaresponses-UpdatedAliasResponse.md new file mode 100644 index 0000000..b03c485 --- /dev/null +++ b/CodeDocumentation/SharedLibraryCore/sharedlibrarycoredtosmetaresponses-UpdatedAliasResponse.md @@ -0,0 +1,68 @@ +# UpdatedAliasResponse `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph SharedLibraryCore.Dtos.Meta.Responses + SharedLibraryCore.Dtos.Meta.Responses.UpdatedAliasResponse[[UpdatedAliasResponse]] + SharedLibraryCore.Dtos.Meta.Responses.BaseMetaResponse[[BaseMetaResponse]] + end +SharedLibraryCore.Dtos.Meta.Responses.BaseMetaResponse --> SharedLibraryCore.Dtos.Meta.Responses.UpdatedAliasResponse +``` + +## Members +### Properties +#### Public properties +| Type | Name | Methods | +| --- | --- | --- | +| `string` | [`IPAddress`](#ipaddress) | `get, set` | +| `string` | [`Name`](#name) | `get, set` | + +### Methods +#### Public methods +| Returns | Name | +| --- | --- | +| `bool` | [`Equals`](#equals)(`object` obj) | +| `int` | [`GetHashCode`](#gethashcode)() | + +## Details +### Inheritance + - [ +`BaseMetaResponse` +](./sharedlibrarycoredtosmetaresponses-BaseMetaResponse) + +### Constructors +#### UpdatedAliasResponse +```csharp +public UpdatedAliasResponse() +``` + +### Methods +#### Equals +```csharp +public override bool Equals(object obj) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `object` | obj | | + +#### GetHashCode +```csharp +public override int GetHashCode() +``` + +### Properties +#### Name +```csharp +public string Name { get; set; } +``` + +#### IPAddress +```csharp +public string IPAddress { get; set; } +``` + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreevents-CoreEvent.md b/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreevents-CoreEvent.md new file mode 100644 index 0000000..0e8a429 --- /dev/null +++ b/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreevents-CoreEvent.md @@ -0,0 +1,58 @@ +# CoreEvent `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph SharedLibraryCore.Events + SharedLibraryCore.Events.CoreEvent[[CoreEvent]] + class SharedLibraryCore.Events.CoreEvent abstractStyle; + end +``` + +## Members +### Properties +#### Public properties +| Type | Name | Methods | +| --- | --- | --- | +| `Nullable`<`Guid`> | [`CorrelationId`](#correlationid) | `get, init` | +| `DateTimeOffset` | [`CreatedAt`](#createdat) | `get` | +| `Guid` | [`Id`](#id) | `get` | +| `Nullable`<`DateTimeOffset`> | [`ProcessedAt`](#processedat) | `get, set` | +| `object` | [`Source`](#source) | `get, init` | + +## Details +### Constructors +#### CoreEvent +```csharp +protected CoreEvent() +``` + +### Properties +#### Id +```csharp +public Guid Id { get; } +``` + +#### CorrelationId +```csharp +public Nullable CorrelationId { get; init; } +``` + +#### Source +```csharp +public object Source { get; init; } +``` + +#### CreatedAt +```csharp +public DateTimeOffset CreatedAt { get; } +``` + +#### ProcessedAt +```csharp +public Nullable ProcessedAt { get; set; } +``` + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreevents-EventExtensions.md b/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreevents-EventExtensions.md new file mode 100644 index 0000000..e6bfda3 --- /dev/null +++ b/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreevents-EventExtensions.md @@ -0,0 +1,34 @@ +# EventExtensions `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph SharedLibraryCore.Events + SharedLibraryCore.Events.EventExtensions[[EventExtensions]] + end +``` + +## Members +### Methods +#### Public Static methods +| Returns | Name | +| --- | --- | +| `Task` | [`InvokeAsync`](#invokeasync)(`Func`<`TEventType`, `CancellationToken`, `Task`> function, `TEventType` eventArgType, `CancellationToken` token) | + +## Details +### Methods +#### InvokeAsync +```csharp +public static Task InvokeAsync(Func function, TEventType eventArgType, CancellationToken token) +where TEventType : +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `Func`<`TEventType`, `CancellationToken`, `Task`> | function | | +| `TEventType` | eventArgType | | +| `CancellationToken` | token | | + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreevents-GameEventArgs.md b/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreevents-GameEventArgs.md new file mode 100644 index 0000000..b430d57 --- /dev/null +++ b/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreevents-GameEventArgs.md @@ -0,0 +1,54 @@ +# GameEventArgs `Public class` + +## Description +represents the state of a game event for event processing + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph SharedLibraryCore.Events + SharedLibraryCore.Events.GameEventArgs[[GameEventArgs]] + end + subgraph System.ComponentModel +System.ComponentModel.AsyncCompletedEventArgs[[AsyncCompletedEventArgs]] + end +System.ComponentModel.AsyncCompletedEventArgs --> SharedLibraryCore.Events.GameEventArgs +``` + +## Members +### Properties +#### Public properties +| Type | Name | Methods | +| --- | --- | --- | +| [`GameEvent`](./sharedlibrarycore-GameEvent) | [`Event`](#event)
Game event that occured on a server | `get` | + +## Details +### Summary +represents the state of a game event for event processing + +### Inheritance + - `AsyncCompletedEventArgs` + +### Constructors +#### GameEventArgs +```csharp +public GameEventArgs(Exception error, bool cancelled, GameEvent userState) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `Exception` | error | | +| `bool` | cancelled | | +| [`GameEvent`](./sharedlibrarycore-GameEvent) | userState | | + +### Properties +#### Event +```csharp +public GameEvent Event { get; } +``` +##### Summary +Game event that occured on a server + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreeventsgame-ClientCommandEvent.md b/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreeventsgame-ClientCommandEvent.md new file mode 100644 index 0000000..d6c4545 --- /dev/null +++ b/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreeventsgame-ClientCommandEvent.md @@ -0,0 +1,27 @@ +# ClientCommandEvent `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph SharedLibraryCore.Events.Game + SharedLibraryCore.Events.Game.ClientCommandEvent[[ClientCommandEvent]] + SharedLibraryCore.Events.Game.ClientMessageEvent[[ClientMessageEvent]] + end +SharedLibraryCore.Events.Game.ClientMessageEvent --> SharedLibraryCore.Events.Game.ClientCommandEvent +``` + +## Details +### Inheritance + - [ +`ClientMessageEvent` +](./sharedlibrarycoreeventsgame-ClientMessageEvent) + +### Constructors +#### ClientCommandEvent +```csharp +public ClientCommandEvent() +``` + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreeventsgame-ClientDamageEvent.md b/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreeventsgame-ClientDamageEvent.md new file mode 100644 index 0000000..b5cb72f --- /dev/null +++ b/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreeventsgame-ClientDamageEvent.md @@ -0,0 +1,135 @@ +# ClientDamageEvent `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph SharedLibraryCore.Events.Game + SharedLibraryCore.Events.Game.ClientDamageEvent[[ClientDamageEvent]] + SharedLibraryCore.Events.Game.ClientGameEvent[[ClientGameEvent]] + class SharedLibraryCore.Events.Game.ClientGameEvent abstractStyle; + end +SharedLibraryCore.Events.Game.ClientGameEvent --> SharedLibraryCore.Events.Game.ClientDamageEvent +``` + +## Members +### Properties +#### Public properties +| Type | Name | Methods | +| --- | --- | --- | +| [`EFClient`](./sharedlibrarycoredatabasemodels-EFClient) | [`Attacker`](#attacker) | `get` | +| `string` | [`AttackerClientName`](#attackerclientname) | `get` | +| `int` | [`AttackerClientSlotNumber`](#attackerclientslotnumber) | `get` | +| `string` | [`AttackerNetworkId`](#attackernetworkid) | `get` | +| `string` | [`AttackerTeamName`](#attackerteamname) | `get, init` | +| `int` | [`Damage`](#damage) | `get, init` | +| `string` | [`HitLocation`](#hitlocation) | `get, init` | +| `string` | [`MeansOfDeath`](#meansofdeath) | `get, init` | +| [`EFClient`](./sharedlibrarycoredatabasemodels-EFClient) | [`Victim`](#victim) | `get` | +| `string` | [`VictimClientName`](#victimclientname) | `get, init` | +| `int` | [`VictimClientSlotNumber`](#victimclientslotnumber) | `get, init` | +| `string` | [`VictimNetworkId`](#victimnetworkid) | `get, init` | +| `string` | [`VictimTeamName`](#victimteamname) | `get, init` | +| `string` | [`WeaponName`](#weaponname) | `get, init` | + +### Methods +#### Public methods +| Returns | Name | +| --- | --- | +| `void` | [`UpdateAttacker`](#updateattacker)([`EFClient`](./sharedlibrarycoredatabasemodels-EFClient) client) | + +## Details +### Inheritance + - [ +`ClientGameEvent` +](./sharedlibrarycoreeventsgame-ClientGameEvent) + +### Constructors +#### ClientDamageEvent +```csharp +public ClientDamageEvent() +``` + +### Methods +#### UpdateAttacker +```csharp +public void UpdateAttacker(EFClient client) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| [`EFClient`](./sharedlibrarycoredatabasemodels-EFClient) | client | | + +### Properties +#### Attacker +```csharp +public EFClient Attacker { get; } +``` + +#### Victim +```csharp +public EFClient Victim { get; } +``` + +#### AttackerClientName +```csharp +public string AttackerClientName { get; } +``` + +#### AttackerNetworkId +```csharp +public string AttackerNetworkId { get; } +``` + +#### AttackerClientSlotNumber +```csharp +public int AttackerClientSlotNumber { get; } +``` + +#### AttackerTeamName +```csharp +public string AttackerTeamName { get; init; } +``` + +#### VictimClientName +```csharp +public string VictimClientName { get; init; } +``` + +#### VictimNetworkId +```csharp +public string VictimNetworkId { get; init; } +``` + +#### VictimClientSlotNumber +```csharp +public int VictimClientSlotNumber { get; init; } +``` + +#### VictimTeamName +```csharp +public string VictimTeamName { get; init; } +``` + +#### WeaponName +```csharp +public string WeaponName { get; init; } +``` + +#### Damage +```csharp +public int Damage { get; init; } +``` + +#### MeansOfDeath +```csharp +public string MeansOfDeath { get; init; } +``` + +#### HitLocation +```csharp +public string HitLocation { get; init; } +``` + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreeventsgame-ClientEnterMatchEvent.md b/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreeventsgame-ClientEnterMatchEvent.md new file mode 100644 index 0000000..1c9ed6c --- /dev/null +++ b/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreeventsgame-ClientEnterMatchEvent.md @@ -0,0 +1,28 @@ +# ClientEnterMatchEvent `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph SharedLibraryCore.Events.Game + SharedLibraryCore.Events.Game.ClientEnterMatchEvent[[ClientEnterMatchEvent]] + SharedLibraryCore.Events.Game.ClientGameEvent[[ClientGameEvent]] + class SharedLibraryCore.Events.Game.ClientGameEvent abstractStyle; + end +SharedLibraryCore.Events.Game.ClientGameEvent --> SharedLibraryCore.Events.Game.ClientEnterMatchEvent +``` + +## Details +### Inheritance + - [ +`ClientGameEvent` +](./sharedlibrarycoreeventsgame-ClientGameEvent) + +### Constructors +#### ClientEnterMatchEvent +```csharp +public ClientEnterMatchEvent() +``` + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreeventsgame-ClientExitMatchEvent.md b/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreeventsgame-ClientExitMatchEvent.md new file mode 100644 index 0000000..7e82a9b --- /dev/null +++ b/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreeventsgame-ClientExitMatchEvent.md @@ -0,0 +1,28 @@ +# ClientExitMatchEvent `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph SharedLibraryCore.Events.Game + SharedLibraryCore.Events.Game.ClientExitMatchEvent[[ClientExitMatchEvent]] + SharedLibraryCore.Events.Game.ClientGameEvent[[ClientGameEvent]] + class SharedLibraryCore.Events.Game.ClientGameEvent abstractStyle; + end +SharedLibraryCore.Events.Game.ClientGameEvent --> SharedLibraryCore.Events.Game.ClientExitMatchEvent +``` + +## Details +### Inheritance + - [ +`ClientGameEvent` +](./sharedlibrarycoreeventsgame-ClientGameEvent) + +### Constructors +#### ClientExitMatchEvent +```csharp +public ClientExitMatchEvent() +``` + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreeventsgame-ClientGameEvent.md b/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreeventsgame-ClientGameEvent.md new file mode 100644 index 0000000..8079ae4 --- /dev/null +++ b/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreeventsgame-ClientGameEvent.md @@ -0,0 +1,60 @@ +# ClientGameEvent `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph SharedLibraryCore.Events.Game + SharedLibraryCore.Events.Game.ClientGameEvent[[ClientGameEvent]] + class SharedLibraryCore.Events.Game.ClientGameEvent abstractStyle; + SharedLibraryCore.Events.Game.GameEventV2[[GameEventV2]] + class SharedLibraryCore.Events.Game.GameEventV2 abstractStyle; + end +SharedLibraryCore.Events.Game.GameEventV2 --> SharedLibraryCore.Events.Game.ClientGameEvent +``` + +## Members +### Properties +#### Public properties +| Type | Name | Methods | +| --- | --- | --- | +| [`EFClient`](./sharedlibrarycoredatabasemodels-EFClient) | [`Client`](#client) | `get` | +| `string` | [`ClientName`](#clientname) | `get, init` | +| `string` | [`ClientNetworkId`](#clientnetworkid) | `get, init` | +| `int` | [`ClientSlotNumber`](#clientslotnumber) | `get, init` | + +## Details +### Inheritance + - [ +`GameEventV2` +](./sharedlibrarycoreeventsgame-GameEventV2) + +### Constructors +#### ClientGameEvent +```csharp +protected ClientGameEvent() +``` + +### Properties +#### ClientName +```csharp +public string ClientName { get; init; } +``` + +#### ClientNetworkId +```csharp +public string ClientNetworkId { get; init; } +``` + +#### ClientSlotNumber +```csharp +public int ClientSlotNumber { get; init; } +``` + +#### Client +```csharp +public EFClient Client { get; } +``` + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreeventsgame-ClientJoinTeamEvent.md b/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreeventsgame-ClientJoinTeamEvent.md new file mode 100644 index 0000000..1a7046e --- /dev/null +++ b/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreeventsgame-ClientJoinTeamEvent.md @@ -0,0 +1,47 @@ +# ClientJoinTeamEvent `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph SharedLibraryCore.Events.Game + SharedLibraryCore.Events.Game.ClientJoinTeamEvent[[ClientJoinTeamEvent]] + SharedLibraryCore.Events.Game.ClientGameEvent[[ClientGameEvent]] + class SharedLibraryCore.Events.Game.ClientGameEvent abstractStyle; + end +SharedLibraryCore.Events.Game.ClientGameEvent --> SharedLibraryCore.Events.Game.ClientJoinTeamEvent +``` + +## Members +### Properties +#### Public properties +| Type | Name | Methods | +| --- | --- | --- | +| `Nullable`<`TeamType`> | [`Team`](#team) | `get` | +| `string` | [`TeamName`](#teamname) | `get, init` | + +## Details +### Inheritance + - [ +`ClientGameEvent` +](./sharedlibrarycoreeventsgame-ClientGameEvent) + +### Constructors +#### ClientJoinTeamEvent +```csharp +public ClientJoinTeamEvent() +``` + +### Properties +#### TeamName +```csharp +public string TeamName { get; init; } +``` + +#### Team +```csharp +public Nullable Team { get; } +``` + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreeventsgame-ClientKillEvent.md b/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreeventsgame-ClientKillEvent.md new file mode 100644 index 0000000..04681c7 --- /dev/null +++ b/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreeventsgame-ClientKillEvent.md @@ -0,0 +1,27 @@ +# ClientKillEvent `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph SharedLibraryCore.Events.Game + SharedLibraryCore.Events.Game.ClientKillEvent[[ClientKillEvent]] + SharedLibraryCore.Events.Game.ClientDamageEvent[[ClientDamageEvent]] + end +SharedLibraryCore.Events.Game.ClientDamageEvent --> SharedLibraryCore.Events.Game.ClientKillEvent +``` + +## Details +### Inheritance + - [ +`ClientDamageEvent` +](./sharedlibrarycoreeventsgame-ClientDamageEvent) + +### Constructors +#### ClientKillEvent +```csharp +public ClientKillEvent() +``` + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreeventsgame-ClientMessageEvent.md b/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreeventsgame-ClientMessageEvent.md new file mode 100644 index 0000000..2551b4f --- /dev/null +++ b/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreeventsgame-ClientMessageEvent.md @@ -0,0 +1,41 @@ +# ClientMessageEvent `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph SharedLibraryCore.Events.Game + SharedLibraryCore.Events.Game.ClientMessageEvent[[ClientMessageEvent]] + SharedLibraryCore.Events.Game.ClientGameEvent[[ClientGameEvent]] + class SharedLibraryCore.Events.Game.ClientGameEvent abstractStyle; + end +SharedLibraryCore.Events.Game.ClientGameEvent --> SharedLibraryCore.Events.Game.ClientMessageEvent +``` + +## Members +### Properties +#### Public properties +| Type | Name | Methods | +| --- | --- | --- | +| `bool` | [`IsTeamMessage`](#isteammessage) | `get, init` | + +## Details +### Inheritance + - [ +`ClientGameEvent` +](./sharedlibrarycoreeventsgame-ClientGameEvent) + +### Constructors +#### ClientMessageEvent +```csharp +public ClientMessageEvent() +``` + +### Properties +#### IsTeamMessage +```csharp +public bool IsTeamMessage { get; init; } +``` + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreeventsgame-GameEventV2.md b/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreeventsgame-GameEventV2.md new file mode 100644 index 0000000..2a296b5 --- /dev/null +++ b/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreeventsgame-GameEventV2.md @@ -0,0 +1,43 @@ +# GameEventV2 `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph SharedLibraryCore.Events.Game + SharedLibraryCore.Events.Game.GameEventV2[[GameEventV2]] + class SharedLibraryCore.Events.Game.GameEventV2 abstractStyle; + end + subgraph SharedLibraryCore + SharedLibraryCore.GameEvent[[GameEvent]] + end +SharedLibraryCore.GameEvent --> SharedLibraryCore.Events.Game.GameEventV2 +``` + +## Members +### Properties +#### Public properties +| Type | Name | Methods | +| --- | --- | --- | +| [`IGameServer`](./sharedlibrarycoreinterfaces-IGameServer) | [`Server`](#server) | `get` | + +## Details +### Inheritance + - [ +`GameEvent` +](./sharedlibrarycore-GameEvent) + +### Constructors +#### GameEventV2 +```csharp +protected GameEventV2() +``` + +### Properties +#### Server +```csharp +public IGameServer Server { get; } +``` + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreeventsgame-GameScriptEvent.md b/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreeventsgame-GameScriptEvent.md new file mode 100644 index 0000000..1bb7641 --- /dev/null +++ b/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreeventsgame-GameScriptEvent.md @@ -0,0 +1,41 @@ +# GameScriptEvent `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph SharedLibraryCore.Events.Game + SharedLibraryCore.Events.Game.GameScriptEvent[[GameScriptEvent]] + SharedLibraryCore.Events.Game.GameEventV2[[GameEventV2]] + class SharedLibraryCore.Events.Game.GameEventV2 abstractStyle; + end +SharedLibraryCore.Events.Game.GameEventV2 --> SharedLibraryCore.Events.Game.GameScriptEvent +``` + +## Members +### Properties +#### Public properties +| Type | Name | Methods | +| --- | --- | --- | +| `string` | [`ScriptData`](#scriptdata) | `get, init` | + +## Details +### Inheritance + - [ +`GameEventV2` +](./sharedlibrarycoreeventsgame-GameEventV2) + +### Constructors +#### GameScriptEvent +```csharp +public GameScriptEvent() +``` + +### Properties +#### ScriptData +```csharp +public string ScriptData { get; init; } +``` + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreeventsgame-MatchEndEvent.md b/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreeventsgame-MatchEndEvent.md new file mode 100644 index 0000000..d5e3140 --- /dev/null +++ b/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreeventsgame-MatchEndEvent.md @@ -0,0 +1,41 @@ +# MatchEndEvent `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph SharedLibraryCore.Events.Game + SharedLibraryCore.Events.Game.MatchEndEvent[[MatchEndEvent]] + SharedLibraryCore.Events.Game.GameEventV2[[GameEventV2]] + class SharedLibraryCore.Events.Game.GameEventV2 abstractStyle; + end +SharedLibraryCore.Events.Game.GameEventV2 --> SharedLibraryCore.Events.Game.MatchEndEvent +``` + +## Members +### Properties +#### Public properties +| Type | Name | Methods | +| --- | --- | --- | +| `string` | [`SessionData`](#sessiondata) | `get, init` | + +## Details +### Inheritance + - [ +`GameEventV2` +](./sharedlibrarycoreeventsgame-GameEventV2) + +### Constructors +#### MatchEndEvent +```csharp +public MatchEndEvent() +``` + +### Properties +#### SessionData +```csharp +public string SessionData { get; init; } +``` + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreeventsgame-MatchStartEvent.md b/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreeventsgame-MatchStartEvent.md new file mode 100644 index 0000000..07f8b32 --- /dev/null +++ b/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreeventsgame-MatchStartEvent.md @@ -0,0 +1,41 @@ +# MatchStartEvent `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph SharedLibraryCore.Events.Game + SharedLibraryCore.Events.Game.MatchStartEvent[[MatchStartEvent]] + SharedLibraryCore.Events.Game.GameEventV2[[GameEventV2]] + class SharedLibraryCore.Events.Game.GameEventV2 abstractStyle; + end +SharedLibraryCore.Events.Game.GameEventV2 --> SharedLibraryCore.Events.Game.MatchStartEvent +``` + +## Members +### Properties +#### Public properties +| Type | Name | Methods | +| --- | --- | --- | +| `IReadOnlyDictionary`<`string`, `string`> | [`SessionData`](#sessiondata) | `get, init` | + +## Details +### Inheritance + - [ +`GameEventV2` +](./sharedlibrarycoreeventsgame-GameEventV2) + +### Constructors +#### MatchStartEvent +```csharp +public MatchStartEvent() +``` + +### Properties +#### SessionData +```csharp +public IReadOnlyDictionary SessionData { get; init; } +``` + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreeventsgamegamescriptzombie-PlayerConsumedPerkGameEvent.md b/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreeventsgamegamescriptzombie-PlayerConsumedPerkGameEvent.md new file mode 100644 index 0000000..cb47688 --- /dev/null +++ b/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreeventsgamegamescriptzombie-PlayerConsumedPerkGameEvent.md @@ -0,0 +1,49 @@ +# PlayerConsumedPerkGameEvent `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph SharedLibraryCore.Events.Game.GameScript.Zombie + SharedLibraryCore.Events.Game.GameScript.Zombie.PlayerConsumedPerkGameEvent[[PlayerConsumedPerkGameEvent]] + end + subgraph SharedLibraryCore.Events.Game + SharedLibraryCore.Events.Game.ClientGameEvent[[ClientGameEvent]] + class SharedLibraryCore.Events.Game.ClientGameEvent abstractStyle; + end +SharedLibraryCore.Events.Game.ClientGameEvent --> SharedLibraryCore.Events.Game.GameScript.Zombie.PlayerConsumedPerkGameEvent +``` + +## Members +### Properties +#### Public properties +| Type | Name | Methods | +| --- | --- | --- | +| `EFClient` | [`Consumer`](#consumer) | `get` | +| `string` | [`PerkName`](#perkname) | `get, init` | + +## Details +### Inheritance + - [ +`ClientGameEvent` +](./sharedlibrarycoreeventsgame-ClientGameEvent) + +### Constructors +#### PlayerConsumedPerkGameEvent +```csharp +public PlayerConsumedPerkGameEvent() +``` + +### Properties +#### Consumer +```csharp +public EFClient Consumer { get; } +``` + +#### PerkName +```csharp +public string PerkName { get; init; } +``` + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreeventsgamegamescriptzombie-PlayerDamageGameEvent.md b/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreeventsgamegamescriptzombie-PlayerDamageGameEvent.md new file mode 100644 index 0000000..46337e7 --- /dev/null +++ b/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreeventsgamegamescriptzombie-PlayerDamageGameEvent.md @@ -0,0 +1,29 @@ +# PlayerDamageGameEvent `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph SharedLibraryCore.Events.Game.GameScript.Zombie + SharedLibraryCore.Events.Game.GameScript.Zombie.PlayerDamageGameEvent[[PlayerDamageGameEvent]] + end + subgraph SharedLibraryCore.Events.Game + SharedLibraryCore.Events.Game.ClientDamageEvent[[ClientDamageEvent]] + end +SharedLibraryCore.Events.Game.ClientDamageEvent --> SharedLibraryCore.Events.Game.GameScript.Zombie.PlayerDamageGameEvent +``` + +## Details +### Inheritance + - [ +`ClientDamageEvent` +](./sharedlibrarycoreeventsgame-ClientDamageEvent) + +### Constructors +#### PlayerDamageGameEvent +```csharp +public PlayerDamageGameEvent() +``` + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreeventsgamegamescriptzombie-PlayerDownedGameEvent.md b/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreeventsgamegamescriptzombie-PlayerDownedGameEvent.md new file mode 100644 index 0000000..c328720 --- /dev/null +++ b/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreeventsgamegamescriptzombie-PlayerDownedGameEvent.md @@ -0,0 +1,30 @@ +# PlayerDownedGameEvent `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph SharedLibraryCore.Events.Game.GameScript.Zombie + SharedLibraryCore.Events.Game.GameScript.Zombie.PlayerDownedGameEvent[[PlayerDownedGameEvent]] + end + subgraph SharedLibraryCore.Events.Game + SharedLibraryCore.Events.Game.ClientGameEvent[[ClientGameEvent]] + class SharedLibraryCore.Events.Game.ClientGameEvent abstractStyle; + end +SharedLibraryCore.Events.Game.ClientGameEvent --> SharedLibraryCore.Events.Game.GameScript.Zombie.PlayerDownedGameEvent +``` + +## Details +### Inheritance + - [ +`ClientGameEvent` +](./sharedlibrarycoreeventsgame-ClientGameEvent) + +### Constructors +#### PlayerDownedGameEvent +```csharp +public PlayerDownedGameEvent() +``` + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreeventsgamegamescriptzombie-PlayerGrabbedPowerupGameEvent.md b/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreeventsgamegamescriptzombie-PlayerGrabbedPowerupGameEvent.md new file mode 100644 index 0000000..bc2a19a --- /dev/null +++ b/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreeventsgamegamescriptzombie-PlayerGrabbedPowerupGameEvent.md @@ -0,0 +1,49 @@ +# PlayerGrabbedPowerupGameEvent `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph SharedLibraryCore.Events.Game.GameScript.Zombie + SharedLibraryCore.Events.Game.GameScript.Zombie.PlayerGrabbedPowerupGameEvent[[PlayerGrabbedPowerupGameEvent]] + end + subgraph SharedLibraryCore.Events.Game + SharedLibraryCore.Events.Game.ClientGameEvent[[ClientGameEvent]] + class SharedLibraryCore.Events.Game.ClientGameEvent abstractStyle; + end +SharedLibraryCore.Events.Game.ClientGameEvent --> SharedLibraryCore.Events.Game.GameScript.Zombie.PlayerGrabbedPowerupGameEvent +``` + +## Members +### Properties +#### Public properties +| Type | Name | Methods | +| --- | --- | --- | +| `EFClient` | [`Grabber`](#grabber) | `get` | +| `string` | [`PowerupName`](#powerupname) | `get, init` | + +## Details +### Inheritance + - [ +`ClientGameEvent` +](./sharedlibrarycoreeventsgame-ClientGameEvent) + +### Constructors +#### PlayerGrabbedPowerupGameEvent +```csharp +public PlayerGrabbedPowerupGameEvent() +``` + +### Properties +#### Grabber +```csharp +public EFClient Grabber { get; } +``` + +#### PowerupName +```csharp +public string PowerupName { get; init; } +``` + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreeventsgamegamescriptzombie-PlayerKilledGameEvent.md b/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreeventsgamegamescriptzombie-PlayerKilledGameEvent.md new file mode 100644 index 0000000..5b96222 --- /dev/null +++ b/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreeventsgamegamescriptzombie-PlayerKilledGameEvent.md @@ -0,0 +1,27 @@ +# PlayerKilledGameEvent `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph SharedLibraryCore.Events.Game.GameScript.Zombie + SharedLibraryCore.Events.Game.GameScript.Zombie.PlayerKilledGameEvent[[PlayerKilledGameEvent]] + SharedLibraryCore.Events.Game.GameScript.Zombie.PlayerDamageGameEvent[[PlayerDamageGameEvent]] + end +SharedLibraryCore.Events.Game.GameScript.Zombie.PlayerDamageGameEvent --> SharedLibraryCore.Events.Game.GameScript.Zombie.PlayerKilledGameEvent +``` + +## Details +### Inheritance + - [ +`PlayerDamageGameEvent` +](./sharedlibrarycoreeventsgamegamescriptzombie-PlayerDamageGameEvent) + +### Constructors +#### PlayerKilledGameEvent +```csharp +public PlayerKilledGameEvent() +``` + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreeventsgamegamescriptzombie-PlayerRevivedGameEvent.md b/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreeventsgamegamescriptzombie-PlayerRevivedGameEvent.md new file mode 100644 index 0000000..7cb90a4 --- /dev/null +++ b/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreeventsgamegamescriptzombie-PlayerRevivedGameEvent.md @@ -0,0 +1,49 @@ +# PlayerRevivedGameEvent `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph SharedLibraryCore.Events.Game.GameScript.Zombie + SharedLibraryCore.Events.Game.GameScript.Zombie.PlayerRevivedGameEvent[[PlayerRevivedGameEvent]] + end + subgraph SharedLibraryCore.Events.Game + SharedLibraryCore.Events.Game.ClientGameEvent[[ClientGameEvent]] + class SharedLibraryCore.Events.Game.ClientGameEvent abstractStyle; + end +SharedLibraryCore.Events.Game.ClientGameEvent --> SharedLibraryCore.Events.Game.GameScript.Zombie.PlayerRevivedGameEvent +``` + +## Members +### Properties +#### Public properties +| Type | Name | Methods | +| --- | --- | --- | +| `EFClient` | [`Revived`](#revived) | `get` | +| `EFClient` | [`Reviver`](#reviver) | `get` | + +## Details +### Inheritance + - [ +`ClientGameEvent` +](./sharedlibrarycoreeventsgame-ClientGameEvent) + +### Constructors +#### PlayerRevivedGameEvent +```csharp +public PlayerRevivedGameEvent() +``` + +### Properties +#### Reviver +```csharp +public EFClient Reviver { get; } +``` + +#### Revived +```csharp +public EFClient Revived { get; } +``` + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreeventsgamegamescriptzombie-PlayerRoundDataGameEvent.md b/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreeventsgamegamescriptzombie-PlayerRoundDataGameEvent.md new file mode 100644 index 0000000..fb741fb --- /dev/null +++ b/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreeventsgamegamescriptzombie-PlayerRoundDataGameEvent.md @@ -0,0 +1,55 @@ +# PlayerRoundDataGameEvent `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph SharedLibraryCore.Events.Game.GameScript.Zombie + SharedLibraryCore.Events.Game.GameScript.Zombie.PlayerRoundDataGameEvent[[PlayerRoundDataGameEvent]] + end + subgraph SharedLibraryCore.Events.Game + SharedLibraryCore.Events.Game.ClientGameEvent[[ClientGameEvent]] + class SharedLibraryCore.Events.Game.ClientGameEvent abstractStyle; + end +SharedLibraryCore.Events.Game.ClientGameEvent --> SharedLibraryCore.Events.Game.GameScript.Zombie.PlayerRoundDataGameEvent +``` + +## Members +### Properties +#### Public properties +| Type | Name | Methods | +| --- | --- | --- | +| `int` | [`CurrentScore`](#currentscore) | `get, init` | +| `bool` | [`IsGameOver`](#isgameover) | `get, init` | +| `int` | [`TotalScore`](#totalscore) | `get, init` | + +## Details +### Inheritance + - [ +`ClientGameEvent` +](./sharedlibrarycoreeventsgame-ClientGameEvent) + +### Constructors +#### PlayerRoundDataGameEvent +```csharp +public PlayerRoundDataGameEvent() +``` + +### Properties +#### TotalScore +```csharp +public int TotalScore { get; init; } +``` + +#### CurrentScore +```csharp +public int CurrentScore { get; init; } +``` + +#### IsGameOver +```csharp +public bool IsGameOver { get; init; } +``` + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreeventsgamegamescriptzombie-RoundCompleteGameEvent.md b/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreeventsgamegamescriptzombie-RoundCompleteGameEvent.md new file mode 100644 index 0000000..c5bc500 --- /dev/null +++ b/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreeventsgamegamescriptzombie-RoundCompleteGameEvent.md @@ -0,0 +1,43 @@ +# RoundCompleteGameEvent `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph SharedLibraryCore.Events.Game.GameScript.Zombie + SharedLibraryCore.Events.Game.GameScript.Zombie.RoundCompleteGameEvent[[RoundCompleteGameEvent]] + end + subgraph SharedLibraryCore.Events.Game + SharedLibraryCore.Events.Game.GameEventV2[[GameEventV2]] + class SharedLibraryCore.Events.Game.GameEventV2 abstractStyle; + end +SharedLibraryCore.Events.Game.GameEventV2 --> SharedLibraryCore.Events.Game.GameScript.Zombie.RoundCompleteGameEvent +``` + +## Members +### Properties +#### Public properties +| Type | Name | Methods | +| --- | --- | --- | +| `int` | [`RoundNumber`](#roundnumber) | `get, init` | + +## Details +### Inheritance + - [ +`GameEventV2` +](./sharedlibrarycoreeventsgame-GameEventV2) + +### Constructors +#### RoundCompleteGameEvent +```csharp +public RoundCompleteGameEvent() +``` + +### Properties +#### RoundNumber +```csharp +public int RoundNumber { get; init; } +``` + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreeventsgamegamescriptzombie-ZombieDamageGameEvent.md b/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreeventsgamegamescriptzombie-ZombieDamageGameEvent.md new file mode 100644 index 0000000..7e8c65c --- /dev/null +++ b/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreeventsgamegamescriptzombie-ZombieDamageGameEvent.md @@ -0,0 +1,29 @@ +# ZombieDamageGameEvent `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph SharedLibraryCore.Events.Game.GameScript.Zombie + SharedLibraryCore.Events.Game.GameScript.Zombie.ZombieDamageGameEvent[[ZombieDamageGameEvent]] + end + subgraph SharedLibraryCore.Events.Game + SharedLibraryCore.Events.Game.ClientDamageEvent[[ClientDamageEvent]] + end +SharedLibraryCore.Events.Game.ClientDamageEvent --> SharedLibraryCore.Events.Game.GameScript.Zombie.ZombieDamageGameEvent +``` + +## Details +### Inheritance + - [ +`ClientDamageEvent` +](./sharedlibrarycoreeventsgame-ClientDamageEvent) + +### Constructors +#### ZombieDamageGameEvent +```csharp +public ZombieDamageGameEvent() +``` + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreeventsgamegamescriptzombie-ZombieKilledGameEvent.md b/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreeventsgamegamescriptzombie-ZombieKilledGameEvent.md new file mode 100644 index 0000000..eb50152 --- /dev/null +++ b/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreeventsgamegamescriptzombie-ZombieKilledGameEvent.md @@ -0,0 +1,27 @@ +# ZombieKilledGameEvent `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph SharedLibraryCore.Events.Game.GameScript.Zombie + SharedLibraryCore.Events.Game.GameScript.Zombie.ZombieKilledGameEvent[[ZombieKilledGameEvent]] + SharedLibraryCore.Events.Game.GameScript.Zombie.ZombieDamageGameEvent[[ZombieDamageGameEvent]] + end +SharedLibraryCore.Events.Game.GameScript.Zombie.ZombieDamageGameEvent --> SharedLibraryCore.Events.Game.GameScript.Zombie.ZombieKilledGameEvent +``` + +## Details +### Inheritance + - [ +`ZombieDamageGameEvent` +](./sharedlibrarycoreeventsgamegamescriptzombie-ZombieDamageGameEvent) + +### Constructors +#### ZombieKilledGameEvent +```csharp +public ZombieKilledGameEvent() +``` + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreeventsmanagement-ClientExecuteCommandEvent.md b/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreeventsmanagement-ClientExecuteCommandEvent.md new file mode 100644 index 0000000..77dc55d --- /dev/null +++ b/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreeventsmanagement-ClientExecuteCommandEvent.md @@ -0,0 +1,47 @@ +# ClientExecuteCommandEvent `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph SharedLibraryCore.Events.Management + SharedLibraryCore.Events.Management.ClientExecuteCommandEvent[[ClientExecuteCommandEvent]] + SharedLibraryCore.Events.Management.ClientStateEvent[[ClientStateEvent]] + class SharedLibraryCore.Events.Management.ClientStateEvent abstractStyle; + end +SharedLibraryCore.Events.Management.ClientStateEvent --> SharedLibraryCore.Events.Management.ClientExecuteCommandEvent +``` + +## Members +### Properties +#### Public properties +| Type | Name | Methods | +| --- | --- | --- | +| [`IManagerCommand`](./sharedlibrarycoreinterfaces-IManagerCommand) | [`Command`](#command) | `get, init` | +| `string` | [`CommandText`](#commandtext) | `get, init` | + +## Details +### Inheritance + - [ +`ClientStateEvent` +](./sharedlibrarycoreeventsmanagement-ClientStateEvent) + +### Constructors +#### ClientExecuteCommandEvent +```csharp +public ClientExecuteCommandEvent() +``` + +### Properties +#### Command +```csharp +public IManagerCommand Command { get; init; } +``` + +#### CommandText +```csharp +public string CommandText { get; init; } +``` + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreeventsmanagement-ClientPenaltyEvent.md b/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreeventsmanagement-ClientPenaltyEvent.md new file mode 100644 index 0000000..22ac41d --- /dev/null +++ b/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreeventsmanagement-ClientPenaltyEvent.md @@ -0,0 +1,46 @@ +# ClientPenaltyEvent `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph SharedLibraryCore.Events.Management + SharedLibraryCore.Events.Management.ClientPenaltyEvent[[ClientPenaltyEvent]] + SharedLibraryCore.Events.Management.ManagementEvent[[ManagementEvent]] + end +SharedLibraryCore.Events.Management.ManagementEvent --> SharedLibraryCore.Events.Management.ClientPenaltyEvent +``` + +## Members +### Properties +#### Public properties +| Type | Name | Methods | +| --- | --- | --- | +| `EFClient` | [`Client`](#client) | `get, init` | +| `EFPenalty` | [`Penalty`](#penalty) | `get, init` | + +## Details +### Inheritance + - [ +`ManagementEvent` +](./sharedlibrarycoreeventsmanagement-ManagementEvent) + +### Constructors +#### ClientPenaltyEvent +```csharp +public ClientPenaltyEvent() +``` + +### Properties +#### Client +```csharp +public EFClient Client { get; init; } +``` + +#### Penalty +```csharp +public EFPenalty Penalty { get; init; } +``` + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreeventsmanagement-ClientPenaltyRevokeEvent.md b/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreeventsmanagement-ClientPenaltyRevokeEvent.md new file mode 100644 index 0000000..8e9c3e6 --- /dev/null +++ b/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreeventsmanagement-ClientPenaltyRevokeEvent.md @@ -0,0 +1,27 @@ +# ClientPenaltyRevokeEvent `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph SharedLibraryCore.Events.Management + SharedLibraryCore.Events.Management.ClientPenaltyRevokeEvent[[ClientPenaltyRevokeEvent]] + SharedLibraryCore.Events.Management.ClientPenaltyEvent[[ClientPenaltyEvent]] + end +SharedLibraryCore.Events.Management.ClientPenaltyEvent --> SharedLibraryCore.Events.Management.ClientPenaltyRevokeEvent +``` + +## Details +### Inheritance + - [ +`ClientPenaltyEvent` +](./sharedlibrarycoreeventsmanagement-ClientPenaltyEvent) + +### Constructors +#### ClientPenaltyRevokeEvent +```csharp +public ClientPenaltyRevokeEvent() +``` + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreeventsmanagement-ClientPermissionChangeEvent.md b/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreeventsmanagement-ClientPermissionChangeEvent.md new file mode 100644 index 0000000..c283017 --- /dev/null +++ b/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreeventsmanagement-ClientPermissionChangeEvent.md @@ -0,0 +1,47 @@ +# ClientPermissionChangeEvent `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph SharedLibraryCore.Events.Management + SharedLibraryCore.Events.Management.ClientPermissionChangeEvent[[ClientPermissionChangeEvent]] + SharedLibraryCore.Events.Management.ClientStateEvent[[ClientStateEvent]] + class SharedLibraryCore.Events.Management.ClientStateEvent abstractStyle; + end +SharedLibraryCore.Events.Management.ClientStateEvent --> SharedLibraryCore.Events.Management.ClientPermissionChangeEvent +``` + +## Members +### Properties +#### Public properties +| Type | Name | Methods | +| --- | --- | --- | +| `Permission` | [`NewPermission`](#newpermission) | `get, init` | +| `Permission` | [`OldPermission`](#oldpermission) | `get, init` | + +## Details +### Inheritance + - [ +`ClientStateEvent` +](./sharedlibrarycoreeventsmanagement-ClientStateEvent) + +### Constructors +#### ClientPermissionChangeEvent +```csharp +public ClientPermissionChangeEvent() +``` + +### Properties +#### OldPermission +```csharp +public Permission OldPermission { get; init; } +``` + +#### NewPermission +```csharp +public Permission NewPermission { get; init; } +``` + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreeventsmanagement-ClientPersistentIdReceiveEvent.md b/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreeventsmanagement-ClientPersistentIdReceiveEvent.md new file mode 100644 index 0000000..4cf5e00 --- /dev/null +++ b/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreeventsmanagement-ClientPersistentIdReceiveEvent.md @@ -0,0 +1,46 @@ +# ClientPersistentIdReceiveEvent `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph SharedLibraryCore.Events.Management + SharedLibraryCore.Events.Management.ClientPersistentIdReceiveEvent[[ClientPersistentIdReceiveEvent]] + SharedLibraryCore.Events.Management.ClientStateEvent[[ClientStateEvent]] + class SharedLibraryCore.Events.Management.ClientStateEvent abstractStyle; + end +SharedLibraryCore.Events.Management.ClientStateEvent --> SharedLibraryCore.Events.Management.ClientPersistentIdReceiveEvent +``` + +## Members +### Properties +#### Public properties +| Type | Name | Methods | +| --- | --- | --- | +| `string` | [`PersistentId`](#persistentid) | `get, init` | + +## Details +### Inheritance + - [ +`ClientStateEvent` +](./sharedlibrarycoreeventsmanagement-ClientStateEvent) + +### Constructors +#### ClientPersistentIdReceiveEvent +```csharp +public ClientPersistentIdReceiveEvent(EFClient client, string persistentId) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| [`EFClient`](./sharedlibrarycoredatabasemodels-EFClient) | client | | +| `string` | persistentId | | + +### Properties +#### PersistentId +```csharp +public string PersistentId { get; init; } +``` + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreeventsmanagement-ClientStateAuthorizeEvent.md b/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreeventsmanagement-ClientStateAuthorizeEvent.md new file mode 100644 index 0000000..1dc30b0 --- /dev/null +++ b/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreeventsmanagement-ClientStateAuthorizeEvent.md @@ -0,0 +1,28 @@ +# ClientStateAuthorizeEvent `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph SharedLibraryCore.Events.Management + SharedLibraryCore.Events.Management.ClientStateAuthorizeEvent[[ClientStateAuthorizeEvent]] + SharedLibraryCore.Events.Management.ClientStateEvent[[ClientStateEvent]] + class SharedLibraryCore.Events.Management.ClientStateEvent abstractStyle; + end +SharedLibraryCore.Events.Management.ClientStateEvent --> SharedLibraryCore.Events.Management.ClientStateAuthorizeEvent +``` + +## Details +### Inheritance + - [ +`ClientStateEvent` +](./sharedlibrarycoreeventsmanagement-ClientStateEvent) + +### Constructors +#### ClientStateAuthorizeEvent +```csharp +public ClientStateAuthorizeEvent() +``` + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreeventsmanagement-ClientStateDisposeEvent.md b/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreeventsmanagement-ClientStateDisposeEvent.md new file mode 100644 index 0000000..510747a --- /dev/null +++ b/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreeventsmanagement-ClientStateDisposeEvent.md @@ -0,0 +1,28 @@ +# ClientStateDisposeEvent `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph SharedLibraryCore.Events.Management + SharedLibraryCore.Events.Management.ClientStateDisposeEvent[[ClientStateDisposeEvent]] + SharedLibraryCore.Events.Management.ClientStateEvent[[ClientStateEvent]] + class SharedLibraryCore.Events.Management.ClientStateEvent abstractStyle; + end +SharedLibraryCore.Events.Management.ClientStateEvent --> SharedLibraryCore.Events.Management.ClientStateDisposeEvent +``` + +## Details +### Inheritance + - [ +`ClientStateEvent` +](./sharedlibrarycoreeventsmanagement-ClientStateEvent) + +### Constructors +#### ClientStateDisposeEvent +```csharp +public ClientStateDisposeEvent() +``` + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreeventsmanagement-ClientStateEvent.md b/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreeventsmanagement-ClientStateEvent.md new file mode 100644 index 0000000..7ba2249 --- /dev/null +++ b/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreeventsmanagement-ClientStateEvent.md @@ -0,0 +1,41 @@ +# ClientStateEvent `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph SharedLibraryCore.Events.Management + SharedLibraryCore.Events.Management.ClientStateEvent[[ClientStateEvent]] + class SharedLibraryCore.Events.Management.ClientStateEvent abstractStyle; + SharedLibraryCore.Events.Management.ManagementEvent[[ManagementEvent]] + end +SharedLibraryCore.Events.Management.ManagementEvent --> SharedLibraryCore.Events.Management.ClientStateEvent +``` + +## Members +### Properties +#### Public properties +| Type | Name | Methods | +| --- | --- | --- | +| [`EFClient`](./sharedlibrarycoredatabasemodels-EFClient) | [`Client`](#client) | `get, init` | + +## Details +### Inheritance + - [ +`ManagementEvent` +](./sharedlibrarycoreeventsmanagement-ManagementEvent) + +### Constructors +#### ClientStateEvent +```csharp +protected ClientStateEvent() +``` + +### Properties +#### Client +```csharp +public EFClient Client { get; init; } +``` + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreeventsmanagement-ClientStateInitializeEvent.md b/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreeventsmanagement-ClientStateInitializeEvent.md new file mode 100644 index 0000000..3da9566 --- /dev/null +++ b/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreeventsmanagement-ClientStateInitializeEvent.md @@ -0,0 +1,28 @@ +# ClientStateInitializeEvent `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph SharedLibraryCore.Events.Management + SharedLibraryCore.Events.Management.ClientStateInitializeEvent[[ClientStateInitializeEvent]] + SharedLibraryCore.Events.Management.ClientStateEvent[[ClientStateEvent]] + class SharedLibraryCore.Events.Management.ClientStateEvent abstractStyle; + end +SharedLibraryCore.Events.Management.ClientStateEvent --> SharedLibraryCore.Events.Management.ClientStateInitializeEvent +``` + +## Details +### Inheritance + - [ +`ClientStateEvent` +](./sharedlibrarycoreeventsmanagement-ClientStateEvent) + +### Constructors +#### ClientStateInitializeEvent +```csharp +public ClientStateInitializeEvent() +``` + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreeventsmanagement-LoginEvent.md b/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreeventsmanagement-LoginEvent.md new file mode 100644 index 0000000..bc4414f --- /dev/null +++ b/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreeventsmanagement-LoginEvent.md @@ -0,0 +1,56 @@ +# LoginEvent `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph SharedLibraryCore.Events.Management + SharedLibraryCore.Events.Management.LoginEvent[[LoginEvent]] + SharedLibraryCore.Events.Management.ManagementEvent[[ManagementEvent]] + end +SharedLibraryCore.Events.Management.ManagementEvent --> SharedLibraryCore.Events.Management.LoginEvent +``` + +## Members +### Properties +#### Public properties +| Type | Name | Methods | +| --- | --- | --- | +| `string` | [`EntityId`](#entityid) | `get, init` | +| `string` | [`Identifier`](#identifier) | `get, init` | +| `LoginSourceType` | [`LoginSource`](#loginsource) | `get, init` | + +## Details +### Inheritance + - [ +`ManagementEvent` +](./sharedlibrarycoreeventsmanagement-ManagementEvent) + +### Nested types +#### Enums + - `LoginSourceType` + +### Constructors +#### LoginEvent +```csharp +public LoginEvent() +``` + +### Properties +#### EntityId +```csharp +public string EntityId { get; init; } +``` + +#### Identifier +```csharp +public string Identifier { get; init; } +``` + +#### LoginSource +```csharp +public LoginSourceType LoginSource { get; init; } +``` + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreeventsmanagement-LogoutEvent.md b/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreeventsmanagement-LogoutEvent.md new file mode 100644 index 0000000..434c87e --- /dev/null +++ b/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreeventsmanagement-LogoutEvent.md @@ -0,0 +1,27 @@ +# LogoutEvent `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph SharedLibraryCore.Events.Management + SharedLibraryCore.Events.Management.LogoutEvent[[LogoutEvent]] + SharedLibraryCore.Events.Management.LoginEvent[[LoginEvent]] + end +SharedLibraryCore.Events.Management.LoginEvent --> SharedLibraryCore.Events.Management.LogoutEvent +``` + +## Details +### Inheritance + - [ +`LoginEvent` +](./sharedlibrarycoreeventsmanagement-LoginEvent) + +### Constructors +#### LogoutEvent +```csharp +public LogoutEvent() +``` + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreeventsmanagement-ManagementEvent.md b/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreeventsmanagement-ManagementEvent.md new file mode 100644 index 0000000..c5003ea --- /dev/null +++ b/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreeventsmanagement-ManagementEvent.md @@ -0,0 +1,30 @@ +# ManagementEvent `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph SharedLibraryCore.Events.Management + SharedLibraryCore.Events.Management.ManagementEvent[[ManagementEvent]] + end + subgraph SharedLibraryCore.Events + SharedLibraryCore.Events.CoreEvent[[CoreEvent]] + class SharedLibraryCore.Events.CoreEvent abstractStyle; + end +SharedLibraryCore.Events.CoreEvent --> SharedLibraryCore.Events.Management.ManagementEvent +``` + +## Details +### Inheritance + - [ +`CoreEvent` +](./sharedlibrarycoreevents-CoreEvent) + +### Constructors +#### ManagementEvent +```csharp +public ManagementEvent() +``` + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreeventsmanagementloginevent-LoginSourceType.md b/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreeventsmanagementloginevent-LoginSourceType.md new file mode 100644 index 0000000..f111a05 --- /dev/null +++ b/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreeventsmanagementloginevent-LoginSourceType.md @@ -0,0 +1,21 @@ +# LoginSourceType `Public enum` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph SharedLibraryCore.Events.Management.LoginEvent + SharedLibraryCore.Events.Management.LoginEvent.LoginSourceType[[LoginSourceType]] + end +``` + +## Details +### Fields +#### Ingame + + +#### Webfront + + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreeventsserver-ClientDataUpdateEvent.md b/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreeventsserver-ClientDataUpdateEvent.md new file mode 100644 index 0000000..3de1e69 --- /dev/null +++ b/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreeventsserver-ClientDataUpdateEvent.md @@ -0,0 +1,41 @@ +# ClientDataUpdateEvent `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph SharedLibraryCore.Events.Server + SharedLibraryCore.Events.Server.ClientDataUpdateEvent[[ClientDataUpdateEvent]] + SharedLibraryCore.Events.Server.GameServerEvent[[GameServerEvent]] + class SharedLibraryCore.Events.Server.GameServerEvent abstractStyle; + end +SharedLibraryCore.Events.Server.GameServerEvent --> SharedLibraryCore.Events.Server.ClientDataUpdateEvent +``` + +## Members +### Properties +#### Public properties +| Type | Name | Methods | +| --- | --- | --- | +| `IReadOnlyCollection`<[`EFClient`](./sharedlibrarycoredatabasemodels-EFClient)> | [`Clients`](#clients) | `get, init` | + +## Details +### Inheritance + - [ +`GameServerEvent` +](./sharedlibrarycoreeventsserver-GameServerEvent) + +### Constructors +#### ClientDataUpdateEvent +```csharp +public ClientDataUpdateEvent() +``` + +### Properties +#### Clients +```csharp +public IReadOnlyCollection Clients { get; init; } +``` + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreeventsserver-ConnectionInterruptEvent.md b/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreeventsserver-ConnectionInterruptEvent.md new file mode 100644 index 0000000..0ab89c8 --- /dev/null +++ b/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreeventsserver-ConnectionInterruptEvent.md @@ -0,0 +1,28 @@ +# ConnectionInterruptEvent `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph SharedLibraryCore.Events.Server + SharedLibraryCore.Events.Server.ConnectionInterruptEvent[[ConnectionInterruptEvent]] + SharedLibraryCore.Events.Server.GameServerEvent[[GameServerEvent]] + class SharedLibraryCore.Events.Server.GameServerEvent abstractStyle; + end +SharedLibraryCore.Events.Server.GameServerEvent --> SharedLibraryCore.Events.Server.ConnectionInterruptEvent +``` + +## Details +### Inheritance + - [ +`GameServerEvent` +](./sharedlibrarycoreeventsserver-GameServerEvent) + +### Constructors +#### ConnectionInterruptEvent +```csharp +public ConnectionInterruptEvent() +``` + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreeventsserver-ConnectionRestoreEvent.md b/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreeventsserver-ConnectionRestoreEvent.md new file mode 100644 index 0000000..181be78 --- /dev/null +++ b/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreeventsserver-ConnectionRestoreEvent.md @@ -0,0 +1,28 @@ +# ConnectionRestoreEvent `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph SharedLibraryCore.Events.Server + SharedLibraryCore.Events.Server.ConnectionRestoreEvent[[ConnectionRestoreEvent]] + SharedLibraryCore.Events.Server.GameServerEvent[[GameServerEvent]] + class SharedLibraryCore.Events.Server.GameServerEvent abstractStyle; + end +SharedLibraryCore.Events.Server.GameServerEvent --> SharedLibraryCore.Events.Server.ConnectionRestoreEvent +``` + +## Details +### Inheritance + - [ +`GameServerEvent` +](./sharedlibrarycoreeventsserver-GameServerEvent) + +### Constructors +#### ConnectionRestoreEvent +```csharp +public ConnectionRestoreEvent() +``` + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreeventsserver-GameServerEvent.md b/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreeventsserver-GameServerEvent.md new file mode 100644 index 0000000..3a161a4 --- /dev/null +++ b/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreeventsserver-GameServerEvent.md @@ -0,0 +1,44 @@ +# GameServerEvent `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph SharedLibraryCore.Events.Server + SharedLibraryCore.Events.Server.GameServerEvent[[GameServerEvent]] + class SharedLibraryCore.Events.Server.GameServerEvent abstractStyle; + end + subgraph SharedLibraryCore.Events + SharedLibraryCore.Events.CoreEvent[[CoreEvent]] + class SharedLibraryCore.Events.CoreEvent abstractStyle; + end +SharedLibraryCore.Events.CoreEvent --> SharedLibraryCore.Events.Server.GameServerEvent +``` + +## Members +### Properties +#### Public properties +| Type | Name | Methods | +| --- | --- | --- | +| [`IGameServer`](./sharedlibrarycoreinterfaces-IGameServer) | [`Server`](#server) | `get, init` | + +## Details +### Inheritance + - [ +`CoreEvent` +](./sharedlibrarycoreevents-CoreEvent) + +### Constructors +#### GameServerEvent +```csharp +protected GameServerEvent() +``` + +### Properties +#### Server +```csharp +public IGameServer Server { get; init; } +``` + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreeventsserver-MonitorStartEvent.md b/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreeventsserver-MonitorStartEvent.md new file mode 100644 index 0000000..f715f42 --- /dev/null +++ b/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreeventsserver-MonitorStartEvent.md @@ -0,0 +1,28 @@ +# MonitorStartEvent `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph SharedLibraryCore.Events.Server + SharedLibraryCore.Events.Server.MonitorStartEvent[[MonitorStartEvent]] + SharedLibraryCore.Events.Server.GameServerEvent[[GameServerEvent]] + class SharedLibraryCore.Events.Server.GameServerEvent abstractStyle; + end +SharedLibraryCore.Events.Server.GameServerEvent --> SharedLibraryCore.Events.Server.MonitorStartEvent +``` + +## Details +### Inheritance + - [ +`GameServerEvent` +](./sharedlibrarycoreeventsserver-GameServerEvent) + +### Constructors +#### MonitorStartEvent +```csharp +public MonitorStartEvent() +``` + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreeventsserver-MonitorStopEvent.md b/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreeventsserver-MonitorStopEvent.md new file mode 100644 index 0000000..3e16ac8 --- /dev/null +++ b/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreeventsserver-MonitorStopEvent.md @@ -0,0 +1,28 @@ +# MonitorStopEvent `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph SharedLibraryCore.Events.Server + SharedLibraryCore.Events.Server.MonitorStopEvent[[MonitorStopEvent]] + SharedLibraryCore.Events.Server.GameServerEvent[[GameServerEvent]] + class SharedLibraryCore.Events.Server.GameServerEvent abstractStyle; + end +SharedLibraryCore.Events.Server.GameServerEvent --> SharedLibraryCore.Events.Server.MonitorStopEvent +``` + +## Details +### Inheritance + - [ +`GameServerEvent` +](./sharedlibrarycoreeventsserver-GameServerEvent) + +### Constructors +#### MonitorStopEvent +```csharp +public MonitorStopEvent() +``` + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreeventsserver-ServerCommandExecuteEvent.md b/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreeventsserver-ServerCommandExecuteEvent.md new file mode 100644 index 0000000..0883829 --- /dev/null +++ b/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreeventsserver-ServerCommandExecuteEvent.md @@ -0,0 +1,47 @@ +# ServerCommandExecuteEvent `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph SharedLibraryCore.Events.Server + SharedLibraryCore.Events.Server.ServerCommandExecuteEvent[[ServerCommandExecuteEvent]] + SharedLibraryCore.Events.Server.GameServerEvent[[GameServerEvent]] + class SharedLibraryCore.Events.Server.GameServerEvent abstractStyle; + end +SharedLibraryCore.Events.Server.GameServerEvent --> SharedLibraryCore.Events.Server.ServerCommandExecuteEvent +``` + +## Members +### Properties +#### Public properties +| Type | Name | Methods | +| --- | --- | --- | +| `string` | [`Command`](#command) | `get, init` | +| `string``[]` | [`Output`](#output) | `get, init` | + +## Details +### Inheritance + - [ +`GameServerEvent` +](./sharedlibrarycoreeventsserver-GameServerEvent) + +### Constructors +#### ServerCommandExecuteEvent +```csharp +public ServerCommandExecuteEvent() +``` + +### Properties +#### Command +```csharp +public string Command { get; init; } +``` + +#### Output +```csharp +public string Output { get; init; } +``` + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreeventsserver-ServerCommandRequestExecuteEvent.md b/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreeventsserver-ServerCommandRequestExecuteEvent.md new file mode 100644 index 0000000..762e7c7 --- /dev/null +++ b/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreeventsserver-ServerCommandRequestExecuteEvent.md @@ -0,0 +1,58 @@ +# ServerCommandRequestExecuteEvent `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph SharedLibraryCore.Events.Server + SharedLibraryCore.Events.Server.ServerCommandRequestExecuteEvent[[ServerCommandRequestExecuteEvent]] + SharedLibraryCore.Events.Server.GameServerEvent[[GameServerEvent]] + class SharedLibraryCore.Events.Server.GameServerEvent abstractStyle; + end +SharedLibraryCore.Events.Server.GameServerEvent --> SharedLibraryCore.Events.Server.ServerCommandRequestExecuteEvent +``` + +## Members +### Properties +#### Public properties +| Type | Name | Methods | +| --- | --- | --- | +| `string` | [`Command`](#command) | `get, init` | +| `Nullable`<`int`> | [`DelayMs`](#delayms) | `get, init` | +| `Nullable`<`int`> | [`TimeoutMs`](#timeoutms) | `get, init` | + +## Details +### Inheritance + - [ +`GameServerEvent` +](./sharedlibrarycoreeventsserver-GameServerEvent) + +### Constructors +#### ServerCommandRequestExecuteEvent +```csharp +public ServerCommandRequestExecuteEvent(string command, IGameServer server) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `string` | command | | +| [`IGameServer`](./sharedlibrarycoreinterfaces-IGameServer) | server | | + +### Properties +#### Command +```csharp +public string Command { get; init; } +``` + +#### DelayMs +```csharp +public Nullable DelayMs { get; init; } +``` + +#### TimeoutMs +```csharp +public Nullable TimeoutMs { get; init; } +``` + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreeventsserver-ServerValueReceiveEvent.md b/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreeventsserver-ServerValueReceiveEvent.md new file mode 100644 index 0000000..be60b44 --- /dev/null +++ b/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreeventsserver-ServerValueReceiveEvent.md @@ -0,0 +1,47 @@ +# ServerValueReceiveEvent `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph SharedLibraryCore.Events.Server + SharedLibraryCore.Events.Server.ServerValueReceiveEvent[[ServerValueReceiveEvent]] + SharedLibraryCore.Events.Server.GameServerEvent[[GameServerEvent]] + class SharedLibraryCore.Events.Server.GameServerEvent abstractStyle; + end +SharedLibraryCore.Events.Server.GameServerEvent --> SharedLibraryCore.Events.Server.ServerValueReceiveEvent +``` + +## Members +### Properties +#### Public properties +| Type | Name | Methods | +| --- | --- | --- | +| [`Dvar`](./sharedlibrarycore-DvarT)<`string`> | [`Response`](#response) | `get, init` | +| `bool` | [`Success`](#success) | `get, init` | + +## Details +### Inheritance + - [ +`GameServerEvent` +](./sharedlibrarycoreeventsserver-GameServerEvent) + +### Constructors +#### ServerValueReceiveEvent +```csharp +public ServerValueReceiveEvent() +``` + +### Properties +#### Response +```csharp +public Dvar Response { get; init; } +``` + +#### Success +```csharp +public bool Success { get; init; } +``` + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreeventsserver-ServerValueRequestEvent.md b/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreeventsserver-ServerValueRequestEvent.md new file mode 100644 index 0000000..23b14ff --- /dev/null +++ b/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreeventsserver-ServerValueRequestEvent.md @@ -0,0 +1,64 @@ +# ServerValueRequestEvent `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph SharedLibraryCore.Events.Server + SharedLibraryCore.Events.Server.ServerValueRequestEvent[[ServerValueRequestEvent]] + SharedLibraryCore.Events.Server.GameServerEvent[[GameServerEvent]] + class SharedLibraryCore.Events.Server.GameServerEvent abstractStyle; + end +SharedLibraryCore.Events.Server.GameServerEvent --> SharedLibraryCore.Events.Server.ServerValueRequestEvent +``` + +## Members +### Properties +#### Public properties +| Type | Name | Methods | +| --- | --- | --- | +| `Nullable`<`int`> | [`DelayMs`](#delayms) | `get, init` | +| `string` | [`FallbackValue`](#fallbackvalue) | `get, init` | +| `Nullable`<`int`> | [`TimeoutMs`](#timeoutms) | `get, init` | +| `string` | [`ValueName`](#valuename) | `get, init` | + +## Details +### Inheritance + - [ +`GameServerEvent` +](./sharedlibrarycoreeventsserver-GameServerEvent) + +### Constructors +#### ServerValueRequestEvent +```csharp +public ServerValueRequestEvent(string valueName, IGameServer server) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `string` | valueName | | +| [`IGameServer`](./sharedlibrarycoreinterfaces-IGameServer) | server | | + +### Properties +#### ValueName +```csharp +public string ValueName { get; init; } +``` + +#### DelayMs +```csharp +public Nullable DelayMs { get; init; } +``` + +#### TimeoutMs +```csharp +public Nullable TimeoutMs { get; init; } +``` + +#### FallbackValue +```csharp +public string FallbackValue { get; init; } +``` + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreeventsserver-ServerValueSetCompleteEvent.md b/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreeventsserver-ServerValueSetCompleteEvent.md new file mode 100644 index 0000000..fedbc27 --- /dev/null +++ b/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreeventsserver-ServerValueSetCompleteEvent.md @@ -0,0 +1,53 @@ +# ServerValueSetCompleteEvent `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph SharedLibraryCore.Events.Server + SharedLibraryCore.Events.Server.ServerValueSetCompleteEvent[[ServerValueSetCompleteEvent]] + SharedLibraryCore.Events.Server.GameServerEvent[[GameServerEvent]] + class SharedLibraryCore.Events.Server.GameServerEvent abstractStyle; + end +SharedLibraryCore.Events.Server.GameServerEvent --> SharedLibraryCore.Events.Server.ServerValueSetCompleteEvent +``` + +## Members +### Properties +#### Public properties +| Type | Name | Methods | +| --- | --- | --- | +| `bool` | [`Success`](#success) | `get, init` | +| `string` | [`Value`](#value) | `get, set` | +| `string` | [`ValueName`](#valuename) | `get, init` | + +## Details +### Inheritance + - [ +`GameServerEvent` +](./sharedlibrarycoreeventsserver-GameServerEvent) + +### Constructors +#### ServerValueSetCompleteEvent +```csharp +public ServerValueSetCompleteEvent() +``` + +### Properties +#### Success +```csharp +public bool Success { get; init; } +``` + +#### ValueName +```csharp +public string ValueName { get; init; } +``` + +#### Value +```csharp +public string Value { get; set; } +``` + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreeventsserver-ServerValueSetRequestEvent.md b/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreeventsserver-ServerValueSetRequestEvent.md new file mode 100644 index 0000000..ac6e8da --- /dev/null +++ b/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreeventsserver-ServerValueSetRequestEvent.md @@ -0,0 +1,65 @@ +# ServerValueSetRequestEvent `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph SharedLibraryCore.Events.Server + SharedLibraryCore.Events.Server.ServerValueSetRequestEvent[[ServerValueSetRequestEvent]] + SharedLibraryCore.Events.Server.GameServerEvent[[GameServerEvent]] + class SharedLibraryCore.Events.Server.GameServerEvent abstractStyle; + end +SharedLibraryCore.Events.Server.GameServerEvent --> SharedLibraryCore.Events.Server.ServerValueSetRequestEvent +``` + +## Members +### Properties +#### Public properties +| Type | Name | Methods | +| --- | --- | --- | +| `Nullable`<`int`> | [`DelayMs`](#delayms) | `get, init` | +| `Nullable`<`int`> | [`TimeoutMs`](#timeoutms) | `get, init` | +| `string` | [`Value`](#value) | `get, init` | +| `string` | [`ValueName`](#valuename) | `get, init` | + +## Details +### Inheritance + - [ +`GameServerEvent` +](./sharedlibrarycoreeventsserver-GameServerEvent) + +### Constructors +#### ServerValueSetRequestEvent +```csharp +public ServerValueSetRequestEvent(string valueName, string value, IGameServer server) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `string` | valueName | | +| `string` | value | | +| [`IGameServer`](./sharedlibrarycoreinterfaces-IGameServer) | server | | + +### Properties +#### ValueName +```csharp +public string ValueName { get; init; } +``` + +#### Value +```csharp +public string Value { get; init; } +``` + +#### DelayMs +```csharp +public Nullable DelayMs { get; init; } +``` + +#### TimeoutMs +```csharp +public Nullable TimeoutMs { get; init; } +``` + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreexceptions-AuthorizationException.md b/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreexceptions-AuthorizationException.md new file mode 100644 index 0000000..74505da --- /dev/null +++ b/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreexceptions-AuthorizationException.md @@ -0,0 +1,31 @@ +# AuthorizationException `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph SharedLibraryCore.Exceptions + SharedLibraryCore.Exceptions.AuthorizationException[[AuthorizationException]] + end + subgraph System +System.Exception[[Exception]] + end +System.Exception --> SharedLibraryCore.Exceptions.AuthorizationException +``` + +## Details +### Inheritance + - `Exception` + +### Constructors +#### AuthorizationException +```csharp +public AuthorizationException(string message) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `string` | message | | + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreexceptions-CommandException.md b/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreexceptions-CommandException.md new file mode 100644 index 0000000..aa1afae --- /dev/null +++ b/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreexceptions-CommandException.md @@ -0,0 +1,31 @@ +# CommandException `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph SharedLibraryCore.Exceptions + SharedLibraryCore.Exceptions.CommandException[[CommandException]] + SharedLibraryCore.Exceptions.ServerException[[ServerException]] + end +SharedLibraryCore.Exceptions.ServerException --> SharedLibraryCore.Exceptions.CommandException +``` + +## Details +### Inheritance + - [ +`ServerException` +](./sharedlibrarycoreexceptions-ServerException) + +### Constructors +#### CommandException +```csharp +public CommandException(string msg) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `string` | msg | | + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreexceptions-ConfigurationException.md b/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreexceptions-ConfigurationException.md new file mode 100644 index 0000000..b4cf8d1 --- /dev/null +++ b/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreexceptions-ConfigurationException.md @@ -0,0 +1,50 @@ +# ConfigurationException `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph SharedLibraryCore.Exceptions + SharedLibraryCore.Exceptions.ConfigurationException[[ConfigurationException]] + end + subgraph System +System.Exception[[Exception]] + end +System.Exception --> SharedLibraryCore.Exceptions.ConfigurationException +``` + +## Members +### Properties +#### Public properties +| Type | Name | Methods | +| --- | --- | --- | +| `string` | [`ConfigurationFileName`](#configurationfilename) | `get, set` | +| `string``[]` | [`Errors`](#errors) | `get, set` | + +## Details +### Inheritance + - `Exception` + +### Constructors +#### ConfigurationException +```csharp +public ConfigurationException(string message) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `string` | message | | + +### Properties +#### Errors +```csharp +public string Errors { get; set; } +``` + +#### ConfigurationFileName +```csharp +public string ConfigurationFileName { get; set; } +``` + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreexceptions-DatabaseException.md b/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreexceptions-DatabaseException.md new file mode 100644 index 0000000..4ceba7a --- /dev/null +++ b/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreexceptions-DatabaseException.md @@ -0,0 +1,31 @@ +# DatabaseException `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph SharedLibraryCore.Exceptions + SharedLibraryCore.Exceptions.DatabaseException[[DatabaseException]] + end + subgraph System +System.Exception[[Exception]] + end +System.Exception --> SharedLibraryCore.Exceptions.DatabaseException +``` + +## Details +### Inheritance + - `Exception` + +### Constructors +#### DatabaseException +```csharp +public DatabaseException(string msg) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `string` | msg | | + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreexceptions-DvarException.md b/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreexceptions-DvarException.md new file mode 100644 index 0000000..3d9f71e --- /dev/null +++ b/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreexceptions-DvarException.md @@ -0,0 +1,31 @@ +# DvarException `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph SharedLibraryCore.Exceptions + SharedLibraryCore.Exceptions.DvarException[[DvarException]] + SharedLibraryCore.Exceptions.ServerException[[ServerException]] + end +SharedLibraryCore.Exceptions.ServerException --> SharedLibraryCore.Exceptions.DvarException +``` + +## Details +### Inheritance + - [ +`ServerException` +](./sharedlibrarycoreexceptions-ServerException) + +### Constructors +#### DvarException +```csharp +public DvarException(string msg) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `string` | msg | | + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreexceptions-NetworkException.md b/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreexceptions-NetworkException.md new file mode 100644 index 0000000..8c40d8e --- /dev/null +++ b/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreexceptions-NetworkException.md @@ -0,0 +1,41 @@ +# NetworkException `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph SharedLibraryCore.Exceptions + SharedLibraryCore.Exceptions.NetworkException[[NetworkException]] + SharedLibraryCore.Exceptions.ServerException[[ServerException]] + end +SharedLibraryCore.Exceptions.ServerException --> SharedLibraryCore.Exceptions.NetworkException +``` + +## Details +### Inheritance + - [ +`ServerException` +](./sharedlibrarycoreexceptions-ServerException) + +### Constructors +#### NetworkException [1/2] +```csharp +public NetworkException(string msg) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `string` | msg | | + +#### NetworkException [2/2] +```csharp +public NetworkException(string msg, Socket s) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `string` | msg | | +| `Socket` | s | | + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreexceptions-PluginException.md b/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreexceptions-PluginException.md new file mode 100644 index 0000000..e3f5df7 --- /dev/null +++ b/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreexceptions-PluginException.md @@ -0,0 +1,44 @@ +# PluginException `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph SharedLibraryCore.Exceptions + SharedLibraryCore.Exceptions.PluginException[[PluginException]] + end + subgraph System +System.Exception[[Exception]] + end +System.Exception --> SharedLibraryCore.Exceptions.PluginException +``` + +## Members +### Properties +#### Public properties +| Type | Name | Methods | +| --- | --- | --- | +| `string` | [`PluginFile`](#pluginfile) | `get, set` | + +## Details +### Inheritance + - `Exception` + +### Constructors +#### PluginException +```csharp +public PluginException(string message) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `string` | message | | + +### Properties +#### PluginFile +```csharp +public string PluginFile { get; set; } +``` + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreexceptions-RConException.md b/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreexceptions-RConException.md new file mode 100644 index 0000000..04ccdd7 --- /dev/null +++ b/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreexceptions-RConException.md @@ -0,0 +1,54 @@ +# RConException `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph SharedLibraryCore.Exceptions + SharedLibraryCore.Exceptions.RConException[[RConException]] + end + subgraph System +System.Exception[[Exception]] + end +System.Exception --> SharedLibraryCore.Exceptions.RConException +``` + +## Members +### Properties +#### Public properties +| Type | Name | Methods | +| --- | --- | --- | +| `bool` | [`IsOperationCancelled`](#isoperationcancelled) | `get` | + +## Details +### Inheritance + - `Exception` + +### Constructors +#### RConException [1/2] +```csharp +public RConException(string message) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `string` | message | | + +#### RConException [2/2] +```csharp +public RConException(string message, bool isOperationCancelled) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `string` | message | | +| `bool` | isOperationCancelled | | + +### Properties +#### IsOperationCancelled +```csharp +public bool IsOperationCancelled { get; } +``` + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreexceptions-SerializeException.md b/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreexceptions-SerializeException.md new file mode 100644 index 0000000..86b88eb --- /dev/null +++ b/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreexceptions-SerializeException.md @@ -0,0 +1,31 @@ +# SerializeException `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph SharedLibraryCore.Exceptions + SharedLibraryCore.Exceptions.SerializeException[[SerializeException]] + end + subgraph System +System.Exception[[Exception]] + end +System.Exception --> SharedLibraryCore.Exceptions.SerializeException +``` + +## Details +### Inheritance + - `Exception` + +### Constructors +#### SerializeException +```csharp +public SerializeException(string msg) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `string` | msg | | + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreexceptions-ServerException.md b/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreexceptions-ServerException.md new file mode 100644 index 0000000..906c928 --- /dev/null +++ b/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreexceptions-ServerException.md @@ -0,0 +1,31 @@ +# ServerException `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph SharedLibraryCore.Exceptions + SharedLibraryCore.Exceptions.ServerException[[ServerException]] + end + subgraph System +System.Exception[[Exception]] + end +System.Exception --> SharedLibraryCore.Exceptions.ServerException +``` + +## Details +### Inheritance + - `Exception` + +### Constructors +#### ServerException +```csharp +public ServerException(string msg) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `string` | msg | | + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreformatting-ColorCodeMapping.md b/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreformatting-ColorCodeMapping.md new file mode 100644 index 0000000..4520d50 --- /dev/null +++ b/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreformatting-ColorCodeMapping.md @@ -0,0 +1,27 @@ +# ColorCodeMapping `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph SharedLibraryCore.Formatting + SharedLibraryCore.Formatting.ColorCodeMapping[[ColorCodeMapping]] + end + subgraph System.Collections.Generic +System.Collections.Generic.Dictionary_2[[Dictionary]] + end +System.Collections.Generic.Dictionary_2 --> SharedLibraryCore.Formatting.ColorCodeMapping +``` + +## Details +### Inheritance + - `Dictionary`<`string`, `string`> + +### Constructors +#### ColorCodeMapping +```csharp +public ColorCodeMapping() +``` + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreformatting-ColorCodes.md b/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreformatting-ColorCodes.md new file mode 100644 index 0000000..254c5cd --- /dev/null +++ b/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreformatting-ColorCodes.md @@ -0,0 +1,54 @@ +# ColorCodes `Public enum` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph SharedLibraryCore.Formatting + SharedLibraryCore.Formatting.ColorCodes[[ColorCodes]] + end +``` + +## Details +### Fields +#### Black + + +#### Red + + +#### Green + + +#### Yellow + + +#### Blue + + +#### Cyan + + +#### Purple + + +#### Pink + + +#### White + + +#### Map + + +#### Grey + + +#### Wildcard + + +#### Accent + + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoregameevent-EventFailReason.md b/CodeDocumentation/SharedLibraryCore/sharedlibrarycoregameevent-EventFailReason.md new file mode 100644 index 0000000..7a6a6c9 --- /dev/null +++ b/CodeDocumentation/SharedLibraryCore/sharedlibrarycoregameevent-EventFailReason.md @@ -0,0 +1,41 @@ +# EventFailReason `Public enum` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph SharedLibraryCore.GameEvent + SharedLibraryCore.GameEvent.EventFailReason[[EventFailReason]] + end +``` + +## Details +### Fields +#### None +##### Summary +event execution did not fail + +#### Exception +##### Summary +an internal exception prevented the event + from executing + +#### Permission +##### Summary +event origin didn't have the necessary privileges + to execute the command + +#### Invalid +##### Summary +executing the event would cause an invalid state + +#### Throttle +##### Summary +client is doing too much of something + +#### Timeout +##### Summary +the event timed out before completion + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoregameevent-EventRequiredEntity.md b/CodeDocumentation/SharedLibraryCore/sharedlibrarycoregameevent-EventRequiredEntity.md new file mode 100644 index 0000000..f4eef39 --- /dev/null +++ b/CodeDocumentation/SharedLibraryCore/sharedlibrarycoregameevent-EventRequiredEntity.md @@ -0,0 +1,24 @@ +# EventRequiredEntity `Public enum` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph SharedLibraryCore.GameEvent + SharedLibraryCore.GameEvent.EventRequiredEntity[[EventRequiredEntity]] + end +``` + +## Details +### Fields +#### None + + +#### Origin + + +#### Target + + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoregameevent-EventSource.md b/CodeDocumentation/SharedLibraryCore/sharedlibrarycoregameevent-EventSource.md new file mode 100644 index 0000000..2aaf74c --- /dev/null +++ b/CodeDocumentation/SharedLibraryCore/sharedlibrarycoregameevent-EventSource.md @@ -0,0 +1,27 @@ +# EventSource `Public enum` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph SharedLibraryCore.GameEvent + SharedLibraryCore.GameEvent.EventSource[[EventSource]] + end +``` + +## Details +### Fields +#### Unspecified + + +#### Log + + +#### Status + + +#### Internal + + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoregameevent-EventType.md b/CodeDocumentation/SharedLibraryCore/sharedlibrarycoregameevent-EventType.md new file mode 100644 index 0000000..01ba800 --- /dev/null +++ b/CodeDocumentation/SharedLibraryCore/sharedlibrarycoregameevent-EventType.md @@ -0,0 +1,166 @@ +# EventType `Public enum` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph SharedLibraryCore.GameEvent + SharedLibraryCore.GameEvent.EventType[[EventType]] + end +``` + +## Details +### Fields +#### Unknown +##### Summary +the event wasn't parsed properly + +#### Start +##### Summary +a server started being monitored + +#### Stop +##### Summary +a server stopped being monitored + +#### Connect +##### Summary +a client was detecting as connecting via log + +#### Join +##### Summary +a client was detecting joining by RCon + +#### Quit +##### Summary +a client was detected leaving via log + +#### Disconnect +##### Summary +a client was detected leaving by RCon + +#### MapEnd +##### Summary +the current map ended + +#### MapChange +##### Summary +the current map changed + +#### PreConnect +##### Summary +a client was detected as starting to connect + +#### PreDisconnect +##### Summary +a client was detecting as starting to disconnect + +#### Update +##### Summary +a client's information was updated + +#### ConnectionLost +##### Summary +connection was lost to a server (the server has not responded after a number of attempts) + +#### ConnectionRestored +##### Summary +connection was restored to a server (the server began responding again) + +#### SayTeam + + +#### Say +##### Summary +a client sent a message + +#### Warn +##### Summary +a client was warned + +#### WarnClear +##### Summary +all warnings for a client were cleared + +#### Report +##### Summary +a client was reported + +#### Flag +##### Summary +a client was flagged + +#### Unflag +##### Summary +a client was unflagged + +#### Kick +##### Summary +a client was kicked + +#### TempBan +##### Summary +a client was tempbanned + +#### Ban +##### Summary +a client was banned + +#### Unban +##### Summary +a client was unbanned + +#### Command +##### Summary +a client entered a command + +#### ChangePermission +##### Summary +a client's permission was changed + +#### Login +##### Summary +client logged in to webfront + +#### Logout +##### Summary +client logged out of webfront + +#### MetaUpdated +##### Summary +meta value updated on client + +#### Broadcast +##### Summary +a message is sent to all clients + +#### Tell +##### Summary +a message is sent to a specific client + +#### ScriptDamage +##### Summary +AC Damage Log + +#### ScriptKill +##### Summary +AC Kill Log + +#### Damage +##### Summary +damage info printed out by game script + +#### Kill +##### Summary +kill info printed out by game script + +#### JoinTeam +##### Summary +team info printed out by game script + +#### Other +##### Summary +used for community generated plugin events + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycorehelpers-BuildNumber.md b/CodeDocumentation/SharedLibraryCore/sharedlibrarycorehelpers-BuildNumber.md new file mode 100644 index 0000000..b21cbb0 --- /dev/null +++ b/CodeDocumentation/SharedLibraryCore/sharedlibrarycorehelpers-BuildNumber.md @@ -0,0 +1,150 @@ +# BuildNumber `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph SharedLibraryCore.Helpers + SharedLibraryCore.Helpers.BuildNumber[[BuildNumber]] + end + subgraph System +System.IComparable[[IComparable]] + end +System.IComparable --> SharedLibraryCore.Helpers.BuildNumber +``` + +## Members +### Properties +#### Public properties +| Type | Name | Methods | +| --- | --- | --- | +| `int` | [`Build`](#build) | `get, private set` | +| `int` | [`Major`](#major) | `get, private set` | +| `int` | [`Minor`](#minor) | `get, private set` | +| `int` | [`Revision`](#revision) | `get, private set` | + +### Methods +#### Public methods +| Returns | Name | +| --- | --- | +| `int` | [`CompareTo`](#compareto)(`object` obj) | +| `bool` | [`Equals`](#equals)(`object` obj) | +| `int` | [`GetHashCode`](#gethashcode)() | +| `string` | [`ToString`](#tostring)() | + +#### 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) | + +## Details +### Inheritance + - `IComparable` + +### Methods +#### CompareTo +```csharp +public virtual int CompareTo(object obj) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `object` | obj | | + +#### TryParse +```csharp +public static bool TryParse(string input, out BuildNumber buildNumber) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `string` | input | | +| `out` [`BuildNumber`](sharedlibrarycorehelpers-BuildNumber) | buildNumber | | + +#### Parse +```csharp +public static BuildNumber Parse(string buildNumber) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `string` | buildNumber | The build number string to parse | + +##### Summary +Parses a build number string into a BuildNumber class + +##### Returns +A new BuildNumber class set from the buildNumber string + +##### Exceptions +| Name | Description | +| --- | --- | +| ArgumentException | Thrown if there are less than 2 or
more than 4 version parts to the build number | +| FormatException | Thrown if string cannot be parsed
to a series of integers | +| ArgumentOutOfRangeException | Thrown if any version
integer is less than zero | + +#### ToString +```csharp +public override string ToString() +``` + +#### Operator > +```csharp +public static bool operator >(BuildNumber first, BuildNumber second) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| [`BuildNumber`](sharedlibrarycorehelpers-BuildNumber) | first | | +| [`BuildNumber`](sharedlibrarycorehelpers-BuildNumber) | second | | + +#### Operator < +```csharp +public static bool operator <(BuildNumber first, BuildNumber second) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| [`BuildNumber`](sharedlibrarycorehelpers-BuildNumber) | first | | +| [`BuildNumber`](sharedlibrarycorehelpers-BuildNumber) | second | | + +#### Equals +```csharp +public override bool Equals(object obj) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `object` | obj | | + +#### GetHashCode +```csharp +public override int GetHashCode() +``` + +### Properties +#### Major +```csharp +public int Major { get; private set; } +``` + +#### Minor +```csharp +public int Minor { get; private set; } +``` + +#### Build +```csharp +public int Build { get; private set; } +``` + +#### Revision +```csharp +public int Revision { get; private set; } +``` + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycorehelpers-BuildNumberJsonConverter.md b/CodeDocumentation/SharedLibraryCore/sharedlibrarycorehelpers-BuildNumberJsonConverter.md new file mode 100644 index 0000000..b833a31 --- /dev/null +++ b/CodeDocumentation/SharedLibraryCore/sharedlibrarycorehelpers-BuildNumberJsonConverter.md @@ -0,0 +1,75 @@ +# BuildNumberJsonConverter `Public class` + +## Description +JSON converter for the build number + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph SharedLibraryCore.Helpers + SharedLibraryCore.Helpers.BuildNumberJsonConverter[[BuildNumberJsonConverter]] + end + subgraph Newtonsoft.Json +Newtonsoft.Json.JsonConverter[[JsonConverter]] + end +Newtonsoft.Json.JsonConverter --> SharedLibraryCore.Helpers.BuildNumberJsonConverter +``` + +## Members +### Methods +#### Public methods +| Returns | Name | +| --- | --- | +| `bool` | [`CanConvert`](#canconvert)(`Type` objectType) | +| `object` | [`ReadJson`](#readjson)(`JsonReader` reader, `Type` objectType, `object` existingValue, `JsonSerializer` serializer) | +| `void` | [`WriteJson`](#writejson)(`JsonWriter` writer, `object` value, `JsonSerializer` serializer) | + +## Details +### Summary +JSON converter for the build number + +### Inheritance + - `JsonConverter` + +### Constructors +#### BuildNumberJsonConverter +```csharp +public BuildNumberJsonConverter() +``` + +### Methods +#### CanConvert +```csharp +public override bool CanConvert(Type objectType) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `Type` | objectType | | + +#### ReadJson +```csharp +public override object ReadJson(JsonReader reader, Type objectType, object existingValue, JsonSerializer serializer) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `JsonReader` | reader | | +| `Type` | objectType | | +| `object` | existingValue | | +| `JsonSerializer` | serializer | | + +#### WriteJson +```csharp +public override void WriteJson(JsonWriter writer, object value, JsonSerializer serializer) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `JsonWriter` | writer | | +| `object` | value | | +| `JsonSerializer` | serializer | | + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycorehelpers-ChangeTrackingT.md b/CodeDocumentation/SharedLibraryCore/sharedlibrarycorehelpers-ChangeTrackingT.md new file mode 100644 index 0000000..f35084e --- /dev/null +++ b/CodeDocumentation/SharedLibraryCore/sharedlibrarycorehelpers-ChangeTrackingT.md @@ -0,0 +1,67 @@ +# ChangeTracking<T> `Public class` + +## Description +This class provides a way to keep track of changes to an entity + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph SharedLibraryCore.Helpers + SharedLibraryCore.Helpers.ChangeTracking_1[[ChangeTracking< T >]] + + end +``` + +## Members +### Properties +#### Public properties +| Type | Name | Methods | +| --- | --- | --- | +| `bool` | [`HasChanges`](#haschanges) | `get` | + +### Methods +#### Public methods +| Returns | Name | +| --- | --- | +| `T` | [`GetNextChange`](#getnextchange)() | +| `void` | [`OnChange`](#onchange)(`T` value) | + +## Details +### Summary +This class provides a way to keep track of changes to an entity + +### Generic types +| Type | Description | Constraints | +| --- | --- | --- | +| `T` | Type of entity to keep track of changes to | | + +### Constructors +#### ChangeTracking +```csharp +public ChangeTracking() +``` + +### Methods +#### OnChange +```csharp +public void OnChange(T value) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `T` | value | | + +#### GetNextChange +```csharp +public T GetNextChange() +``` + +### Properties +#### HasChanges +```csharp +public bool HasChanges { get; } +``` + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycorehelpers-Hashing.md b/CodeDocumentation/SharedLibraryCore/sharedlibrarycorehelpers-Hashing.md new file mode 100644 index 0000000..50e59ce --- /dev/null +++ b/CodeDocumentation/SharedLibraryCore/sharedlibrarycorehelpers-Hashing.md @@ -0,0 +1,44 @@ +# Hashing `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph SharedLibraryCore.Helpers + SharedLibraryCore.Helpers.Hashing[[Hashing]] + end +``` + +## Members +### Methods +#### Public Static methods +| Returns | Name | +| --- | --- | +| `string``[]` | [`Hash`](#hash)(`string` password, `string` saltStr)
Generate password hash and salt | + +## Details +### Constructors +#### Hashing +```csharp +public Hashing() +``` + +### Methods +#### Hash +```csharp +public static string Hash(string password, string saltStr) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `string` | password | plaintext password | +| `string` | saltStr | salt of password | + +##### Summary +Generate password hash and salt + +##### Returns + + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycorehelpers-InteractionData.md b/CodeDocumentation/SharedLibraryCore/sharedlibrarycorehelpers-InteractionData.md new file mode 100644 index 0000000..77b61d8 --- /dev/null +++ b/CodeDocumentation/SharedLibraryCore/sharedlibrarycorehelpers-InteractionData.md @@ -0,0 +1,133 @@ +# InteractionData `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph SharedLibraryCore.Helpers + SharedLibraryCore.Helpers.InteractionData[[InteractionData]] + end + subgraph SharedLibraryCore.Interfaces + SharedLibraryCore.Interfaces.IInteractionData[[IInteractionData]] + class SharedLibraryCore.Interfaces.IInteractionData interfaceStyle; + end +SharedLibraryCore.Interfaces.IInteractionData --> SharedLibraryCore.Helpers.InteractionData +``` + +## Members +### Properties +#### Public properties +| Type | Name | Methods | +| --- | --- | --- | +| `Func`<`int`, `Nullable`<`int`>, `Nullable`<`Game`>, `IDictionary`<`string`, `string`>, `CancellationToken`, `Task`<`string`>> | [`Action`](#action) | `get, set` | +| `Dictionary`<`string`, `string`> | [`ActionMeta`](#actionmeta) | `get, set` | +| `string` | [`ActionPath`](#actionpath) | `get, set` | +| `string` | [`ActionUri`](#actionuri) | `get` | +| `string` | [`Description`](#description) | `get, set` | +| `string` | [`DisplayMeta`](#displaymeta) | `get, set` | +| `bool` | [`Enabled`](#enabled) | `get, set` | +| `Nullable`<`int`> | [`EntityId`](#entityid) | `get, set` | +| `string` | [`InteractionId`](#interactionid) | `get, set` | +| [`InteractionType`](./sharedlibrarycoreinterfaces-InteractionType) | [`InteractionType`](#interactiontype) | `get, set` | +| `Nullable`<`Permission`> | [`MinimumPermission`](#minimumpermission) | `get, set` | +| `string` | [`Name`](#name) | `get, set` | +| `string` | [`PermissionAccess`](#permissionaccess) | `get, set` | +| `string` | [`PermissionEntity`](#permissionentity) | `get, set` | +| `Delegate` | [`ScriptAction`](#scriptaction) | `get, set` | +| `string` | [`Source`](#source) | `get, set` | + +## Details +### Inheritance + - [ +`IInteractionData` +](./sharedlibrarycoreinterfaces-IInteractionData) + +### Constructors +#### InteractionData +```csharp +public InteractionData() +``` + +### Properties +#### EntityId +```csharp +public Nullable EntityId { get; set; } +``` + +#### InteractionId +```csharp +public string InteractionId { get; set; } +``` + +#### InteractionType +```csharp +public InteractionType InteractionType { get; set; } +``` + +#### Enabled +```csharp +public bool Enabled { get; set; } +``` + +#### Name +```csharp +public string Name { get; set; } +``` + +#### Description +```csharp +public string Description { get; set; } +``` + +#### DisplayMeta +```csharp +public string DisplayMeta { get; set; } +``` + +#### ActionPath +```csharp +public string ActionPath { get; set; } +``` + +#### ActionMeta +```csharp +public Dictionary ActionMeta { get; set; } +``` + +#### ActionUri +```csharp +public virtual string ActionUri { get; } +``` + +#### MinimumPermission +```csharp +public Nullable MinimumPermission { get; set; } +``` + +#### PermissionEntity +```csharp +public string PermissionEntity { get; set; } +``` + +#### PermissionAccess +```csharp +public string PermissionAccess { get; set; } +``` + +#### Source +```csharp +public string Source { get; set; } +``` + +#### Action +```csharp +public Func, Nullable, IDictionary, CancellationToken, Task> Action { get; set; } +``` + +#### ScriptAction +```csharp +public Delegate ScriptAction { get; set; } +``` + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycorehelpers-MessageToken.md b/CodeDocumentation/SharedLibraryCore/sharedlibrarycorehelpers-MessageToken.md new file mode 100644 index 0000000..b31fb64 --- /dev/null +++ b/CodeDocumentation/SharedLibraryCore/sharedlibrarycorehelpers-MessageToken.md @@ -0,0 +1,54 @@ +# MessageToken `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph SharedLibraryCore.Helpers + SharedLibraryCore.Helpers.MessageToken[[MessageToken]] + end +``` + +## Members +### Properties +#### Public properties +| Type | Name | Methods | +| --- | --- | --- | +| `string` | [`Name`](#name) | `get` | + +### Methods +#### Public methods +| Returns | Name | +| --- | --- | +| `Task`<`string`> | [`ProcessAsync`](#processasync)([`Server`](./sharedlibrarycore-Server) server) | + +## Details +### Constructors +#### MessageToken +```csharp +public MessageToken(string Name, Func> Value) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `string` | Name | | +| `Func`<[`Server`](./sharedlibrarycore-Server), `Task`<`string`>> | Value | | + +### Methods +#### ProcessAsync +```csharp +public async Task ProcessAsync(Server server) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| [`Server`](./sharedlibrarycore-Server) | server | | + +### Properties +#### Name +```csharp +public string Name { get; } +``` + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycorehelpers-ParseEnumT.md b/CodeDocumentation/SharedLibraryCore/sharedlibrarycorehelpers-ParseEnumT.md new file mode 100644 index 0000000..a0e340c --- /dev/null +++ b/CodeDocumentation/SharedLibraryCore/sharedlibrarycorehelpers-ParseEnumT.md @@ -0,0 +1,39 @@ +# ParseEnum<T> `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph SharedLibraryCore.Helpers + SharedLibraryCore.Helpers.ParseEnum_1[[ParseEnum< T >]] + + end +``` + +## Members +### Methods +#### Public Static methods +| Returns | Name | +| --- | --- | +| `T` | [`Get`](#get)(`string` e, `Type` type) | + +## Details +### Constructors +#### ParseEnum +```csharp +public ParseEnum() +``` + +### Methods +#### Get +```csharp +public static T Get(string e, Type type) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `string` | e | | +| `Type` | type | | + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycorehelpers-Report.md b/CodeDocumentation/SharedLibraryCore/sharedlibrarycorehelpers-Report.md new file mode 100644 index 0000000..3adb8d8 --- /dev/null +++ b/CodeDocumentation/SharedLibraryCore/sharedlibrarycorehelpers-Report.md @@ -0,0 +1,51 @@ +# Report `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph SharedLibraryCore.Helpers + SharedLibraryCore.Helpers.Report[[Report]] + end +``` + +## Members +### Properties +#### Public properties +| Type | Name | Methods | +| --- | --- | --- | +| [`EFClient`](./sharedlibrarycoredatabasemodels-EFClient) | [`Origin`](#origin) | `get, set` | +| `string` | [`Reason`](#reason) | `get, set` | +| `DateTime` | [`ReportedOn`](#reportedon) | `get, set` | +| [`EFClient`](./sharedlibrarycoredatabasemodels-EFClient) | [`Target`](#target) | `get, set` | + +## Details +### Constructors +#### Report +```csharp +public Report() +``` + +### Properties +#### Target +```csharp +public EFClient Target { get; set; } +``` + +#### Origin +```csharp +public EFClient Origin { get; set; } +``` + +#### Reason +```csharp +public string Reason { get; set; } +``` + +#### ReportedOn +```csharp +public DateTime ReportedOn { get; set; } +``` + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycorehelpers-ResourceQueryHelperResultT.md b/CodeDocumentation/SharedLibraryCore/sharedlibrarycorehelpers-ResourceQueryHelperResultT.md new file mode 100644 index 0000000..e516af0 --- /dev/null +++ b/CodeDocumentation/SharedLibraryCore/sharedlibrarycorehelpers-ResourceQueryHelperResultT.md @@ -0,0 +1,63 @@ +# ResourceQueryHelperResult<QueryResultType> `Public class` + +## Description +generic class for passing information about a resource query + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph SharedLibraryCore.Helpers + SharedLibraryCore.Helpers.ResourceQueryHelperResult_1[[ResourceQueryHelperResult< QueryResultType >]] + + end +``` + +## Members +### Properties +#### Public properties +| Type | Name | Methods | +| --- | --- | --- | +| `IEnumerable`<`QueryResultType`> | [`Results`](#results)
collection of results | `get, set` | +| `int` | [`RetrievedResultCount`](#retrievedresultcount)
indicates the total number of results retrieved | `get, set` | +| `long` | [`TotalResultCount`](#totalresultcount)
indicates the total number of results found | `get, set` | + +## Details +### Summary +generic class for passing information about a resource query + +### Generic types +| Type | Description | Constraints | +| --- | --- | --- | +| `QueryResultType` | Type of query result | | + +### Constructors +#### ResourceQueryHelperResult +```csharp +public ResourceQueryHelperResult() +``` + +### Properties +#### TotalResultCount +```csharp +public long TotalResultCount { get; set; } +``` +##### Summary +indicates the total number of results found + +#### RetrievedResultCount +```csharp +public int RetrievedResultCount { get; set; } +``` +##### Summary +indicates the total number of results retrieved + +#### Results +```csharp +public IEnumerable Results { get; set; } +``` +##### Summary +collection of results + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycorehelpers-TokenIdentifier.md b/CodeDocumentation/SharedLibraryCore/sharedlibrarycorehelpers-TokenIdentifier.md new file mode 100644 index 0000000..529973a --- /dev/null +++ b/CodeDocumentation/SharedLibraryCore/sharedlibrarycorehelpers-TokenIdentifier.md @@ -0,0 +1,49 @@ +# TokenIdentifier `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph SharedLibraryCore.Helpers + SharedLibraryCore.Helpers.TokenIdentifier[[TokenIdentifier]] + end + subgraph SharedLibraryCore.Interfaces + SharedLibraryCore.Interfaces.ITokenIdentifier[[ITokenIdentifier]] + class SharedLibraryCore.Interfaces.ITokenIdentifier interfaceStyle; + end +SharedLibraryCore.Interfaces.ITokenIdentifier --> SharedLibraryCore.Helpers.TokenIdentifier +``` + +## Members +### Properties +#### Public properties +| Type | Name | Methods | +| --- | --- | --- | +| `int` | [`ClientId`](#clientid) | `get, set` | +| `string` | [`Token`](#token) | `get, set` | + +## Details +### Inheritance + - [ +`ITokenIdentifier` +](./sharedlibrarycoreinterfaces-ITokenIdentifier) + +### Constructors +#### TokenIdentifier +```csharp +public TokenIdentifier() +``` + +### Properties +#### ClientId +```csharp +public int ClientId { get; set; } +``` + +#### Token +```csharp +public string Token { get; set; } +``` + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycorehelpers-TokenState.md b/CodeDocumentation/SharedLibraryCore/sharedlibrarycorehelpers-TokenState.md new file mode 100644 index 0000000..75afd00 --- /dev/null +++ b/CodeDocumentation/SharedLibraryCore/sharedlibrarycorehelpers-TokenState.md @@ -0,0 +1,51 @@ +# TokenState `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph SharedLibraryCore.Helpers + SharedLibraryCore.Helpers.TokenState[[TokenState]] + end +``` + +## Members +### Properties +#### Public properties +| Type | Name | Methods | +| --- | --- | --- | +| `string` | [`RemainingTime`](#remainingtime) | `get` | +| `DateTime` | [`RequestTime`](#requesttime) | `get, set` | +| `string` | [`Token`](#token) | `get, set` | +| `TimeSpan` | [`TokenDuration`](#tokenduration) | `get, set` | + +## Details +### Constructors +#### TokenState +```csharp +public TokenState() +``` + +### Properties +#### RequestTime +```csharp +public DateTime RequestTime { get; set; } +``` + +#### TokenDuration +```csharp +public TimeSpan TokenDuration { get; set; } +``` + +#### Token +```csharp +public string Token { get; set; } +``` + +#### RemainingTime +```csharp +public string RemainingTime { get; } +``` + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfaces-IAlertManager.md b/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfaces-IAlertManager.md new file mode 100644 index 0000000..6f9700d --- /dev/null +++ b/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfaces-IAlertManager.md @@ -0,0 +1,109 @@ +# IAlertManager `Public interface` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph SharedLibraryCore.Interfaces + SharedLibraryCore.Interfaces.IAlertManager[[IAlertManager]] + class SharedLibraryCore.Interfaces.IAlertManager interfaceStyle; + end +``` + +## Members +### Properties +#### Public properties +| Type | Name | Methods | +| --- | --- | --- | +| `EventHandler`<`AlertState`> | [`OnAlertConsumed`](#onalertconsumed)
Fires when an alert has been consumed (dimissed) | `get, set` | + +### Methods +#### Public methods +| Returns | Name | +| --- | --- | +| `void` | [`AddAlert`](#addalert)(`AlertState` alert) | +| `Task` | [`Initialize`](#initialize)()
Initializes the manager | +| `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 | + +## Details +### Methods +#### Initialize +```csharp +public Task Initialize() +``` +##### Summary +Initializes the manager + +##### Returns + + +#### RetrieveAlerts +```csharp +public IEnumerable RetrieveAlerts(EFClient client) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| [`EFClient`](./sharedlibrarycoredatabasemodels-EFClient) | client | client to retrieve alerts for | + +##### Summary +Get all the alerts for given client + +##### Returns + + +#### AddAlert +```csharp +public void AddAlert(AlertState alert) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `AlertState` | alert | | + +#### MarkAlertAsRead +```csharp +public void MarkAlertAsRead(Guid alertId) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `Guid` | alertId | Id of the alert to mark as read | + +##### Summary +Marks an alert as read and removes it from the manager + +#### MarkAllAlertsAsRead +```csharp +public void MarkAllAlertsAsRead(int recipientId) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `int` | recipientId | Identifier of the recipient | + +##### Summary +Mark all alerts intended for the given recipientId as read + +#### RegisterStaticAlertSource +```csharp +public void RegisterStaticAlertSource(Func>> alertSource) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `Func`<`Task`<`IEnumerable`<`AlertState`>>> | alertSource | | + +### Properties +#### OnAlertConsumed +```csharp +public EventHandler OnAlertConsumed { get; set; } +``` +##### Summary +Fires when an alert has been consumed (dimissed) + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfaces-IAuditFields.md b/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfaces-IAuditFields.md new file mode 100644 index 0000000..d6a94ff --- /dev/null +++ b/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfaces-IAuditFields.md @@ -0,0 +1,28 @@ +# IAuditFields `Public interface` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph SharedLibraryCore.Interfaces + SharedLibraryCore.Interfaces.IAuditFields[[IAuditFields]] + class SharedLibraryCore.Interfaces.IAuditFields interfaceStyle; + end +``` + +## Members +### Properties +#### Public properties +| Type | Name | Methods | +| --- | --- | --- | +| `DateTime` | [`CreatedDateTime`](#createddatetime) | `get, set` | + +## Details +### Properties +#### CreatedDateTime +```csharp +public DateTime CreatedDateTime { get; set; } +``` + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfaces-IAuditInformationRepository.md b/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfaces-IAuditInformationRepository.md new file mode 100644 index 0000000..4a99ca0 --- /dev/null +++ b/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfaces-IAuditInformationRepository.md @@ -0,0 +1,44 @@ +# IAuditInformationRepository `Public interface` + +## Description +describes the capabilities of the audit info repository + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph SharedLibraryCore.Interfaces + SharedLibraryCore.Interfaces.IAuditInformationRepository[[IAuditInformationRepository]] + class SharedLibraryCore.Interfaces.IAuditInformationRepository interfaceStyle; + end +``` + +## Members +### Methods +#### 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 | + +## Details +### Summary +describes the capabilities of the audit info repository + +### Methods +#### ListAuditInformation +```csharp +public Task> ListAuditInformation(PaginationRequest paginationInfo) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| [`PaginationRequest`](./sharedlibrarycoredtos-PaginationRequest) | paginationInfo | pagination info | + +##### Summary +retrieves a list of audit information for given pagination params + +##### Returns + + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfaces-IBaseConfiguration.md b/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfaces-IBaseConfiguration.md new file mode 100644 index 0000000..6b999eb --- /dev/null +++ b/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfaces-IBaseConfiguration.md @@ -0,0 +1,34 @@ +# IBaseConfiguration `Public interface` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph SharedLibraryCore.Interfaces + SharedLibraryCore.Interfaces.IBaseConfiguration[[IBaseConfiguration]] + class SharedLibraryCore.Interfaces.IBaseConfiguration interfaceStyle; + end +``` + +## Members +### Methods +#### Public methods +| Returns | Name | +| --- | --- | +| [`IBaseConfiguration`](sharedlibrarycoreinterfaces-IBaseConfiguration) | [`Generate`](#generate)() | +| `string` | [`Name`](#name)() | + +## Details +### Methods +#### Name +```csharp +public string Name() +``` + +#### Generate +```csharp +public IBaseConfiguration Generate() +``` + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfaces-IBasePathProvider.md b/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfaces-IBasePathProvider.md new file mode 100644 index 0000000..0928101 --- /dev/null +++ b/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfaces-IBasePathProvider.md @@ -0,0 +1,38 @@ +# IBasePathProvider `Public interface` + +## Description +defines the capabilities for providing a base path + unused as of now, will be used later during refactorying + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph SharedLibraryCore.Interfaces + SharedLibraryCore.Interfaces.IBasePathProvider[[IBasePathProvider]] + class SharedLibraryCore.Interfaces.IBasePathProvider interfaceStyle; + end +``` + +## Members +### Properties +#### Public properties +| Type | Name | Methods | +| --- | --- | --- | +| `string` | [`BasePath`](#basepath)
working directory of IW4MAdmin | `get` | + +## Details +### Summary +defines the capabilities for providing a base path + unused as of now, will be used later during refactorying + +### Properties +#### BasePath +```csharp +public string BasePath { get; } +``` +##### Summary +working directory of IW4MAdmin + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfaces-IClientMeta.md b/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfaces-IClientMeta.md new file mode 100644 index 0000000..507271b --- /dev/null +++ b/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfaces-IClientMeta.md @@ -0,0 +1,64 @@ +# IClientMeta `Public interface` + +## Description +describes all the base attributes of a client meta object + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph SharedLibraryCore.Interfaces + SharedLibraryCore.Interfaces.IClientMeta[[IClientMeta]] + class SharedLibraryCore.Interfaces.IClientMeta interfaceStyle; + end +``` + +## Members +### Properties +#### Public properties +| Type | Name | Methods | +| --- | --- | --- | +| `Nullable`<`int`> | [`Column`](#column) | `get, set` | +| `bool` | [`IsSensitive`](#issensitive) | `get` | +| `Nullable`<`int`> | [`Order`](#order) | `get, set` | +| `bool` | [`ShouldDisplay`](#shoulddisplay) | `get` | +| [`MetaType`](./sharedlibrarycoreinterfaces-MetaType) | [`Type`](#type) | `get` | +| `DateTime` | [`When`](#when) | `get` | + +## Details +### Summary +describes all the base attributes of a client meta object + +### Properties +#### Type +```csharp +public MetaType Type { get; } +``` + +#### When +```csharp +public DateTime When { get; } +``` + +#### IsSensitive +```csharp +public bool IsSensitive { get; } +``` + +#### ShouldDisplay +```csharp +public bool ShouldDisplay { get; } +``` + +#### Column +```csharp +public Nullable Column { get; set; } +``` + +#### Order +```csharp +public Nullable Order { get; set; } +``` + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfaces-IClientMetaResponse.md b/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfaces-IClientMetaResponse.md new file mode 100644 index 0000000..0c80565 --- /dev/null +++ b/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfaces-IClientMetaResponse.md @@ -0,0 +1,34 @@ +# IClientMetaResponse `Public interface` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph SharedLibraryCore.Interfaces + SharedLibraryCore.Interfaces.IClientMetaResponse[[IClientMetaResponse]] + class SharedLibraryCore.Interfaces.IClientMetaResponse interfaceStyle; + end +``` + +## Members +### Properties +#### Public properties +| Type | Name | Methods | +| --- | --- | --- | +| `int` | [`ClientId`](#clientid) | `get` | +| `long` | [`MetaId`](#metaid) | `get` | + +## Details +### Properties +#### ClientId +```csharp +public int ClientId { get; } +``` + +#### MetaId +```csharp +public long MetaId { get; } +``` + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfaces-IClientNoticeMessageFormatter.md b/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfaces-IClientNoticeMessageFormatter.md new file mode 100644 index 0000000..b311abe --- /dev/null +++ b/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfaces-IClientNoticeMessageFormatter.md @@ -0,0 +1,40 @@ +# IClientNoticeMessageFormatter `Public interface` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph SharedLibraryCore.Interfaces + SharedLibraryCore.Interfaces.IClientNoticeMessageFormatter[[IClientNoticeMessageFormatter]] + class SharedLibraryCore.Interfaces.IClientNoticeMessageFormatter interfaceStyle; + end +``` + +## Members +### Methods +#### Public methods +| Returns | Name | +| --- | --- | +| `string` | [`BuildFormattedMessage`](#buildformattedmessage)([`IRConParserConfiguration`](./sharedlibrarycoreinterfaces-IRConParserConfiguration) config, `EFPenalty` currentPenalty, `EFPenalty` originalPenalty)
builds a game formatted notice message | + +## Details +### Methods +#### BuildFormattedMessage +```csharp +public string BuildFormattedMessage(IRConParserConfiguration config, EFPenalty currentPenalty, EFPenalty originalPenalty) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| [`IRConParserConfiguration`](./sharedlibrarycoreinterfaces-IRConParserConfiguration) | config | RCon parser config | +| `EFPenalty` | currentPenalty | current penalty the message is for | +| `EFPenalty` | originalPenalty | previous penalty the current penalty relates to | + +##### Summary +builds a game formatted notice message + +##### Returns + + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfaces-IConfigurationHandlerFactory.md b/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfaces-IConfigurationHandlerFactory.md new file mode 100644 index 0000000..dcf68c7 --- /dev/null +++ b/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfaces-IConfigurationHandlerFactory.md @@ -0,0 +1,52 @@ +# IConfigurationHandlerFactory `Public interface` + +## Description +defines the capabilities of the configuration handler factory + used to generate new instance of configuration handlers + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph SharedLibraryCore.Interfaces + SharedLibraryCore.Interfaces.IConfigurationHandlerFactory[[IConfigurationHandlerFactory]] + class SharedLibraryCore.Interfaces.IConfigurationHandlerFactory interfaceStyle; + end +``` + +## Members +### Methods +#### Public methods +| Returns | Name | +| --- | --- | +| [`IConfigurationHandler`](./sharedlibrarycoreinterfaces-IConfigurationHandlerT)<`T`> | [`GetConfigurationHandler`](#getconfigurationhandler)(`string` name) | +| `Task`<[`IConfigurationHandler`](./sharedlibrarycoreinterfaces-IConfigurationHandlerT)<`T`>> | [`GetConfigurationHandlerAsync`](#getconfigurationhandlerasync)(`string` name) | + +## Details +### Summary +defines the capabilities of the configuration handler factory + used to generate new instance of configuration handlers + +### Methods +#### GetConfigurationHandler +```csharp +public IConfigurationHandler GetConfigurationHandler(string name) +where T : IBaseConfiguration +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `string` | name | | + +#### GetConfigurationHandlerAsync +```csharp +public Task> GetConfigurationHandlerAsync(string name) +where T : IBaseConfiguration +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `string` | name | | + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfaces-IConfigurationHandlerT.md b/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfaces-IConfigurationHandlerT.md new file mode 100644 index 0000000..3a7a126 --- /dev/null +++ b/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfaces-IConfigurationHandlerT.md @@ -0,0 +1,68 @@ +# IConfigurationHandler< T> `Public interface` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph SharedLibraryCore.Interfaces + SharedLibraryCore.Interfaces.IBaseConfiguration[[IBaseConfiguration]] + class SharedLibraryCore.Interfaces.IBaseConfiguration interfaceStyle; + SharedLibraryCore.Interfaces.IConfigurationHandler_1[[IConfigurationHandler< T >]] + class SharedLibraryCore.Interfaces.IConfigurationHandler_1 interfaceStyle; + SharedLibraryCore.Interfaces.IConfigurationHandler_1T((T)); + SharedLibraryCore.Interfaces.IConfigurationHandler_1 -- where --o SharedLibraryCore.Interfaces.IConfigurationHandler_1T +SharedLibraryCore.Interfaces.IBaseConfiguration --> SharedLibraryCore.Interfaces.IConfigurationHandler_1T + + end +``` + +## Members +### Properties +#### Public properties +| Type | Name | Methods | +| --- | --- | --- | +| `string` | [`FileName`](#filename) | `get` | + +### Methods +#### Public methods +| Returns | Name | +| --- | --- | +| `Task` | [`BuildAsync`](#buildasync)() | +| `T` | [`Configuration`](#configuration)() | +| `Task` | [`Save`](#save)() | +| `void` | [`Set`](#set)(`T` config) | + +## Details +### Methods +#### Save +```csharp +public Task Save() +``` + +#### BuildAsync +```csharp +public Task BuildAsync() +``` + +#### Configuration +```csharp +public T Configuration() +``` + +#### Set +```csharp +public void Set(T config) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `T` | config | | + +### Properties +#### FileName +```csharp +public string FileName { get; } +``` + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfaces-IConfigurationHandlerV2T.md b/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfaces-IConfigurationHandlerV2T.md new file mode 100644 index 0000000..fdfefa7 --- /dev/null +++ b/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfaces-IConfigurationHandlerV2T.md @@ -0,0 +1,55 @@ +# IConfigurationHandlerV2< TConfigurationType> `Public interface` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph SharedLibraryCore.Interfaces + SharedLibraryCore.Interfaces.IConfigurationHandlerV2_1[[IConfigurationHandlerV2< TConfigurationType >]] + class SharedLibraryCore.Interfaces.IConfigurationHandlerV2_1 interfaceStyle; + + end +``` + +## Members +### Methods +#### Public methods +| Returns | Name | +| --- | --- | +| `Task`<`TConfigurationType`> | [`Get`](#get)(`string` configurationName, `TConfigurationType` defaultConfiguration) | +| `Task` | [`Set`](#set-12)(`...`) | + +## Details +### Methods +#### Get +```csharp +public Task Get(string configurationName, TConfigurationType defaultConfiguration) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `string` | configurationName | | +| `TConfigurationType` | defaultConfiguration | | + +#### Set [1/2] +```csharp +public Task Set(TConfigurationType configuration) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `TConfigurationType` | configuration | | + +#### Set [2/2] +```csharp +public Task Set() +``` + +### Events +#### Updated +```csharp +public event Action Updated +``` + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfaces-ICoreEventHandler.md b/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfaces-ICoreEventHandler.md new file mode 100644 index 0000000..49fcade --- /dev/null +++ b/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfaces-ICoreEventHandler.md @@ -0,0 +1,52 @@ +# ICoreEventHandler `Public interface` + +## Description +Handles games events (from log, manual events, etc) + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph SharedLibraryCore.Interfaces + SharedLibraryCore.Interfaces.ICoreEventHandler[[ICoreEventHandler]] + class SharedLibraryCore.Interfaces.ICoreEventHandler interfaceStyle; + end +``` + +## Members +### Methods +#### 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` | [`StartProcessing`](#startprocessing)(`CancellationToken` token) | + +## Details +### Summary +Handles games events (from log, manual events, etc) + +### Methods +#### QueueEvent +```csharp +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) | + +##### Summary +Add a core event event to the queue to be processed + +#### StartProcessing +```csharp +public void StartProcessing(CancellationToken token) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `CancellationToken` | token | | + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfaces-IEntityServiceT.md b/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfaces-IEntityServiceT.md new file mode 100644 index 0000000..442e13a --- /dev/null +++ b/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfaces-IEntityServiceT.md @@ -0,0 +1,84 @@ +# IEntityService< T> `Public interface` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph SharedLibraryCore.Interfaces + SharedLibraryCore.Interfaces.IEntityService_1[[IEntityService< T >]] + class SharedLibraryCore.Interfaces.IEntityService_1 interfaceStyle; + + end +``` + +## Members +### Methods +#### Public methods +| Returns | Name | +| --- | --- | +| `Task`<`T`> | [`Create`](#create)(`T` entity) | +| `Task`<`T`> | [`Delete`](#delete)(`T` entity) | +| `Task`<`IList`<`T`>> | [`Find`](#find)(`Func`<`T`, `bool`> expression) | +| `Task`<`T`> | [`Get`](#get)(`int` entityID) | +| `Task`<`T`> | [`GetUnique`](#getunique)(`long` entityProperty, `object` altKey) | +| `Task`<`T`> | [`Update`](#update)(`T` entity) | + +## Details +### Methods +#### Create +```csharp +public Task Create(T entity) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `T` | entity | | + +#### Delete +```csharp +public Task Delete(T entity) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `T` | entity | | + +#### Update +```csharp +public Task Update(T entity) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `T` | entity | | + +#### Get +```csharp +public Task Get(int entityID) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `int` | entityID | | + +#### GetUnique +```csharp +public Task GetUnique(long entityProperty, object altKey) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `long` | entityProperty | | +| `object` | altKey | | + +#### Find +```csharp +public Task> Find(Func expression) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `Func`<`T`, `bool`> | expression | | + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfaces-IEventParser.md b/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfaces-IEventParser.md new file mode 100644 index 0000000..1e58a05 --- /dev/null +++ b/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfaces-IEventParser.md @@ -0,0 +1,96 @@ +# IEventParser `Public interface` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph SharedLibraryCore.Interfaces + SharedLibraryCore.Interfaces.IEventParser[[IEventParser]] + class SharedLibraryCore.Interfaces.IEventParser interfaceStyle; + end +``` + +## Members +### Properties +#### Public properties +| Type | Name | Methods | +| --- | --- | --- | +| [`IEventParserConfiguration`](./sharedlibrarycoreinterfaces-IEventParserConfiguration) | [`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` | +| `string` | [`Version`](#version)
stores the game/client specific version (usually the value of the "version" DVAR) | `get, set` | + +### Methods +#### 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) | + +## Details +### Methods +#### GenerateGameEvent +```csharp +public GameEvent GenerateGameEvent(string logLine) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `string` | logLine | single log line string | + +##### Summary +Generates a game event based on log line input + +##### Returns + + +#### RegisterCustomEvent +```csharp +public void RegisterCustomEvent(string eventSubtype, string eventTriggerValue, Func eventModifier) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `string` | eventSubtype | | +| `string` | eventTriggerValue | | +| `Func`<`string`, [`IEventParserConfiguration`](./sharedlibrarycoreinterfaces-IEventParserConfiguration), [`GameEvent`](./sharedlibrarycore-GameEvent), [`GameEvent`](./sharedlibrarycore-GameEvent)> | eventModifier | | + +### Properties +#### Configuration +```csharp +public IEventParserConfiguration Configuration { get; set; } +``` +##### Summary +Get game specific folder prefix for log files + +#### Version +```csharp +public string Version { get; set; } +``` +##### Summary +stores the game/client specific version (usually the value of the "version" DVAR) + +#### GameName +```csharp +public Game GameName { get; set; } +``` +##### Summary +specifies the game name (usually the internal studio iteration ie: IW4, T5 etc...) + +#### URLProtocolFormat +```csharp +public string URLProtocolFormat { get; set; } +``` +##### Summary +specifies the connect URI used to join game servers via web browser + +#### Name +```csharp +public string Name { get; set; } +``` +##### Summary +specifies the text name of the game the parser is for + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfaces-IEventParserConfiguration.md b/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfaces-IEventParserConfiguration.md new file mode 100644 index 0000000..af7f572 --- /dev/null +++ b/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfaces-IEventParserConfiguration.md @@ -0,0 +1,134 @@ +# IEventParserConfiguration `Public interface` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph SharedLibraryCore.Interfaces + SharedLibraryCore.Interfaces.IEventParserConfiguration[[IEventParserConfiguration]] + class SharedLibraryCore.Interfaces.IEventParserConfiguration interfaceStyle; + end +``` + +## Members +### Properties +#### 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` | +| `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` | +| `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` | +| `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` | + +## Details +### Properties +#### GameDirectory +```csharp +public string GameDirectory { get; set; } +``` +##### Summary +stores the fs_game directory (this folder may vary between different clients) + +#### Say +```csharp +public ParserRegex Say { get; set; } +``` +##### Summary +stores the regex information for a say event printed in the game log + +#### LocalizeText +```csharp +public string LocalizeText { get; set; } +``` +##### Summary +stores the special ASCII value used by CoD games that prevents the text in the chat from being localized + +#### Join +```csharp +public ParserRegex Join { get; set; } +``` +##### Summary +stores the regex information for a join event printed in the game log + +#### JoinTeam +```csharp +public ParserRegex JoinTeam { get; set; } +``` +##### Summary +stores the regex information for a join team event printed in the game log + +#### Quit +```csharp +public ParserRegex Quit { get; set; } +``` +##### Summary +stores the regex information for a quit event printed in the game log + +#### Kill +```csharp +public ParserRegex Kill { get; set; } +``` +##### Summary +stores the regex information for a kill event printed in the game log + +#### Damage +```csharp +public ParserRegex Damage { get; set; } +``` +##### Summary +stores the regex information for a damage event printed in the game log + +#### Action +```csharp +public ParserRegex Action { get; set; } +``` +##### Summary +stores the regex information for an action event printed in the game log + +#### Time +```csharp +public ParserRegex Time { get; set; } +``` +##### Summary +stores the regex information for the time prefix in game log + +#### MapChange +```csharp +public ParserRegex MapChange { get; } +``` +##### Summary +stores the regex information for the map change game log + +#### MapEnd +```csharp +public ParserRegex MapEnd { get; } +``` +##### Summary +stores the regex information for the map end game log + +#### GuidNumberStyle +```csharp +public NumberStyles GuidNumberStyle { get; set; } +``` +##### Summary +indicates the format expected for parsed guids + +#### TeamMapping +```csharp +public Dictionary TeamMapping { get; } +``` +##### Summary +maps the team code name to a type type eg "CT" -> Allies + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfaces-IGameLogReader.md b/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfaces-IGameLogReader.md new file mode 100644 index 0000000..e44da2f --- /dev/null +++ b/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfaces-IGameLogReader.md @@ -0,0 +1,68 @@ +# IGameLogReader `Public interface` + +## Description +represents the abstraction of game log reading + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph SharedLibraryCore.Interfaces + SharedLibraryCore.Interfaces.IGameLogReader[[IGameLogReader]] + class SharedLibraryCore.Interfaces.IGameLogReader interfaceStyle; + end +``` + +## Members +### Properties +#### Public properties +| Type | Name | Methods | +| --- | --- | --- | +| `long` | [`Length`](#length)
how long the log file is | `get` | +| `int` | [`UpdateInterval`](#updateinterval)
how often to poll the log file | `get` | + +### Methods +#### 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 | + +## Details +### Summary +represents the abstraction of game log reading + +### Methods +#### ReadEventsFromLog +```csharp +public Task> ReadEventsFromLog(long fileSizeDiff, long startPosition, Server server) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `long` | fileSizeDiff | | +| `long` | startPosition | | +| [`Server`](./sharedlibrarycore-Server) | server | | + +##### Summary +get new events that have occured since the last poll + +##### Returns + + +### Properties +#### Length +```csharp +public long Length { get; } +``` +##### Summary +how long the log file is + +#### UpdateInterval +```csharp +public int UpdateInterval { get; } +``` +##### Summary +how often to poll the log file + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfaces-IGameLogReaderFactory.md b/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfaces-IGameLogReaderFactory.md new file mode 100644 index 0000000..fc2cd84 --- /dev/null +++ b/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfaces-IGameLogReaderFactory.md @@ -0,0 +1,45 @@ +# IGameLogReaderFactory `Public interface` + +## Description +factory interface to create game log readers based on the log file uri + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph SharedLibraryCore.Interfaces + SharedLibraryCore.Interfaces.IGameLogReaderFactory[[IGameLogReaderFactory]] + class SharedLibraryCore.Interfaces.IGameLogReaderFactory interfaceStyle; + end +``` + +## Members +### Methods +#### 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 | + +## Details +### Summary +factory interface to create game log readers based on the log file uri + +### Methods +#### CreateGameLogReader +```csharp +public IGameLogReader CreateGameLogReader(Uri[] logUris, IEventParser eventParser) +``` +##### Arguments +| 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 | + +##### Summary +generates a new game log reader based on the provided Uri + +##### Returns + + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfaces-IGameServer.md b/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfaces-IGameServer.md new file mode 100644 index 0000000..e4a0cfd --- /dev/null +++ b/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfaces-IGameServer.md @@ -0,0 +1,194 @@ +# IGameServer `Public interface` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph SharedLibraryCore.Interfaces + SharedLibraryCore.Interfaces.IGameServer[[IGameServer]] + class SharedLibraryCore.Interfaces.IGameServer interfaceStyle; + end +``` + +## Members +### Properties +#### Public properties +| Type | Name | Methods | +| --- | --- | --- | +| `IReadOnlyList`<[`EFClient`](./sharedlibrarycoredatabasemodels-EFClient)> | [`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` | +| `string` | [`Id`](#id)
Unique identifier for the server (typically ip:port) | `get` | +| `bool` | [`IsLegacyGameIntegrationEnabled`](#islegacygameintegrationenabled)
Indicates if the anticheat/custom callbacks/live radar integration is enabled | `get` | +| `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` | +| `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` | +| `string` | [`ServerName`](#servername)
Name of the server (hostname) | `get` | + +### Methods +#### Public methods +| 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` | [`SetDvarAsync`](#setdvarasync)(`string` name, `object` value, `CancellationToken` token)
Set value for server dvar | + +## Details +### Methods +#### Kick +```csharp +public Task Kick(string reason, EFClient target, EFClient origin, EFPenalty previousPenalty) +``` +##### Arguments +| 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 | +| `EFPenalty` | previousPenalty | previous penalty the kick is occuring for (if applicable) | + +##### Summary +kicks target on behalf of origin for given reason + +##### Returns + + +#### ExecuteCommandAsync +```csharp +public Task ExecuteCommandAsync(string command, CancellationToken token) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `string` | command | Server command to execute | +| `CancellationToken` | token | CancellationToken | + +##### Summary +Execute a server command + +##### Returns +Collection of console command output lines + +#### SetDvarAsync +```csharp +public Task SetDvarAsync(string name, object value, CancellationToken token) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `string` | name | Name of the server value to set | +| `object` | value | Value of the server value | +| `CancellationToken` | token | CancellationToken | + +##### Summary +Set value for server dvar + +##### Returns + + +### Properties +#### MatchEndTime +```csharp +public Nullable MatchEndTime { get; } +``` +##### Summary +Time the most recent match ended + +#### MatchStartTime +```csharp +public Nullable MatchStartTime { get; } +``` +##### Summary +Time the current match started + +#### ConnectedClients +```csharp +public IReadOnlyList ConnectedClients { get; } +``` +##### Summary +List of connected clients + +#### GameCode +```csharp +public Game GameCode { get; } +``` +##### Summary +Game code corresponding to the development studio project + +#### IsLegacyGameIntegrationEnabled +```csharp +public bool IsLegacyGameIntegrationEnabled { get; } +``` +##### Summary +Indicates if the anticheat/custom callbacks/live radar integration is enabled + +#### Id +```csharp +public string Id { get; } +``` +##### Summary +Unique identifier for the server (typically ip:port) + +#### ListenAddress +```csharp +public string ListenAddress { get; } +``` +##### Summary +Network address the server is listening on + +#### ListenPort +```csharp +public int ListenPort { get; } +``` +##### Summary +Network port the server is listening on + +#### ServerName +```csharp +public string ServerName { get; } +``` +##### Summary +Name of the server (hostname) + +#### Gametype +```csharp +public string Gametype { get; } +``` +##### Summary +Current gametype + +#### GamePassword +```csharp +public string GamePassword { get; } +``` +##### Summary +Game password (required to join) + +#### PrivateClientSlots +```csharp +public int PrivateClientSlots { get; } +``` +##### Summary +Number of private client slots + +#### Map +```csharp +public Map Map { get; } +``` +##### Summary +Current map the game server is running + +#### LegacyDatabaseId +```csharp +public long LegacyDatabaseId { get; } +``` +##### Summary +Database id for EFServer table and references + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfaces-IGameServerInstanceFactory.md b/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfaces-IGameServerInstanceFactory.md new file mode 100644 index 0000000..d61eba9 --- /dev/null +++ b/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfaces-IGameServerInstanceFactory.md @@ -0,0 +1,45 @@ +# IGameServerInstanceFactory `Public interface` + +## Description +defines the capabilities of game server instance factory + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph SharedLibraryCore.Interfaces + SharedLibraryCore.Interfaces.IGameServerInstanceFactory[[IGameServerInstanceFactory]] + class SharedLibraryCore.Interfaces.IGameServerInstanceFactory interfaceStyle; + end +``` + +## Members +### Methods +#### Public methods +| Returns | Name | +| --- | --- | +| [`Server`](./sharedlibrarycore-Server) | [`CreateServer`](#createserver)([`ServerConfiguration`](./sharedlibrarycoreconfiguration-ServerConfiguration) config, [`IManager`](./sharedlibrarycoreinterfaces-IManager) manager)
creates the instance of a game server | + +## Details +### Summary +defines the capabilities of game server instance factory + +### Methods +#### CreateServer +```csharp +public Server CreateServer(ServerConfiguration config, IManager manager) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| [`ServerConfiguration`](./sharedlibrarycoreconfiguration-ServerConfiguration) | config | server configuration | +| [`IManager`](./sharedlibrarycoreinterfaces-IManager) | manager | application manager | + +##### Summary +creates the instance of a game server + +##### Returns + + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfaces-IGeoLocationResult.md b/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfaces-IGeoLocationResult.md new file mode 100644 index 0000000..300d900 --- /dev/null +++ b/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfaces-IGeoLocationResult.md @@ -0,0 +1,58 @@ +# IGeoLocationResult `Public interface` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph SharedLibraryCore.Interfaces + SharedLibraryCore.Interfaces.IGeoLocationResult[[IGeoLocationResult]] + class SharedLibraryCore.Interfaces.IGeoLocationResult interfaceStyle; + end +``` + +## Members +### Properties +#### Public properties +| Type | Name | Methods | +| --- | --- | --- | +| `string` | [`ASN`](#asn) | `get, set` | +| `string` | [`Country`](#country) | `get, set` | +| `string` | [`CountryCode`](#countrycode) | `get, set` | +| `string` | [`Organization`](#organization) | `get, set` | +| `string` | [`Region`](#region) | `get, set` | +| `string` | [`Timezone`](#timezone) | `get, set` | + +## Details +### Properties +#### Country +```csharp +public string Country { get; set; } +``` + +#### CountryCode +```csharp +public string CountryCode { get; set; } +``` + +#### Region +```csharp +public string Region { get; set; } +``` + +#### ASN +```csharp +public string ASN { get; set; } +``` + +#### Timezone +```csharp +public string Timezone { get; set; } +``` + +#### Organization +```csharp +public string Organization { get; set; } +``` + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfaces-IGeoLocationService.md b/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfaces-IGeoLocationService.md new file mode 100644 index 0000000..435d9fa --- /dev/null +++ b/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfaces-IGeoLocationService.md @@ -0,0 +1,32 @@ +# IGeoLocationService `Public interface` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph SharedLibraryCore.Interfaces + SharedLibraryCore.Interfaces.IGeoLocationService[[IGeoLocationService]] + class SharedLibraryCore.Interfaces.IGeoLocationService interfaceStyle; + end +``` + +## Members +### Methods +#### Public methods +| Returns | Name | +| --- | --- | +| `Task`<[`IGeoLocationResult`](./sharedlibrarycoreinterfaces-IGeoLocationResult)> | [`Locate`](#locate)(`string` address) | + +## Details +### Methods +#### Locate +```csharp +public Task Locate(string address) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `string` | address | | + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfaces-IInteractionData.md b/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfaces-IInteractionData.md new file mode 100644 index 0000000..074c830 --- /dev/null +++ b/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfaces-IInteractionData.md @@ -0,0 +1,118 @@ +# IInteractionData `Public interface` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph SharedLibraryCore.Interfaces + SharedLibraryCore.Interfaces.IInteractionData[[IInteractionData]] + class SharedLibraryCore.Interfaces.IInteractionData interfaceStyle; + end +``` + +## Members +### Properties +#### Public properties +| Type | Name | Methods | +| --- | --- | --- | +| `Func`<`int`, `Nullable`<`int`>, `Nullable`<`Game`>, `IDictionary`<`string`, `string`>, `CancellationToken`, `Task`<`string`>> | [`Action`](#action) | `get` | +| `Dictionary`<`string`, `string`> | [`ActionMeta`](#actionmeta) | `get` | +| `string` | [`ActionPath`](#actionpath) | `get` | +| `string` | [`ActionUri`](#actionuri) | `get` | +| `string` | [`Description`](#description) | `get` | +| `string` | [`DisplayMeta`](#displaymeta) | `get` | +| `bool` | [`Enabled`](#enabled) | `get` | +| `Nullable`<`int`> | [`EntityId`](#entityid) | `get` | +| `string` | [`InteractionId`](#interactionid) | `get` | +| [`InteractionType`](./sharedlibrarycoreinterfaces-InteractionType) | [`InteractionType`](#interactiontype) | `get` | +| `Nullable`<`Permission`> | [`MinimumPermission`](#minimumpermission) | `get` | +| `string` | [`Name`](#name) | `get` | +| `string` | [`PermissionAccess`](#permissionaccess) | `get` | +| `string` | [`PermissionEntity`](#permissionentity) | `get` | +| `Delegate` | [`ScriptAction`](#scriptaction) | `get` | +| `string` | [`Source`](#source) | `get` | + +## Details +### Properties +#### EntityId +```csharp +public Nullable EntityId { get; } +``` + +#### InteractionId +```csharp +public string InteractionId { get; } +``` + +#### InteractionType +```csharp +public InteractionType InteractionType { get; } +``` + +#### Enabled +```csharp +public bool Enabled { get; } +``` + +#### Name +```csharp +public string Name { get; } +``` + +#### Description +```csharp +public string Description { get; } +``` + +#### DisplayMeta +```csharp +public string DisplayMeta { get; } +``` + +#### ActionPath +```csharp +public string ActionPath { get; } +``` + +#### ActionMeta +```csharp +public Dictionary ActionMeta { get; } +``` + +#### ActionUri +```csharp +public string ActionUri { get; } +``` + +#### MinimumPermission +```csharp +public Nullable MinimumPermission { get; } +``` + +#### PermissionEntity +```csharp +public string PermissionEntity { get; } +``` + +#### PermissionAccess +```csharp +public string PermissionAccess { get; } +``` + +#### Source +```csharp +public string Source { get; } +``` + +#### Action +```csharp +public Func, Nullable, IDictionary, CancellationToken, Task> Action { get; } +``` + +#### ScriptAction +```csharp +public Delegate ScriptAction { get; } +``` + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfaces-IInteractionRegistration.md b/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfaces-IInteractionRegistration.md new file mode 100644 index 0000000..aa01b22 --- /dev/null +++ b/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfaces-IInteractionRegistration.md @@ -0,0 +1,83 @@ +# IInteractionRegistration `Public interface` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph SharedLibraryCore.Interfaces + SharedLibraryCore.Interfaces.IInteractionRegistration[[IInteractionRegistration]] + class SharedLibraryCore.Interfaces.IInteractionRegistration interfaceStyle; + end +``` + +## Members +### Methods +#### Public methods +| Returns | Name | +| --- | --- | +| `Task`<`IEnumerable`<[`IInteractionData`](./sharedlibrarycoreinterfaces-IInteractionData)>> | [`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` | [`RegisterScriptInteraction`](#registerscriptinteraction)(`string` interactionName, `string` source, `Delegate` interactionRegistration) | +| `void` | [`UnregisterInteraction`](#unregisterinteraction)(`string` interactionName) | + +## Details +### Methods +#### RegisterScriptInteraction +```csharp +public void RegisterScriptInteraction(string interactionName, string source, Delegate interactionRegistration) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `string` | interactionName | | +| `string` | source | | +| `Delegate` | interactionRegistration | | + +#### RegisterInteraction +```csharp +public void RegisterInteraction(string interactionName, Func, Nullable, CancellationToken, Task> interactionRegistration) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `string` | interactionName | | +| `Func`<`Nullable`<`int`>, `Nullable`<`Game`>, `CancellationToken`, `Task`<[`IInteractionData`](./sharedlibrarycoreinterfaces-IInteractionData)>> | interactionRegistration | | + +#### UnregisterInteraction +```csharp +public void UnregisterInteraction(string interactionName) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `string` | interactionName | | + +#### GetInteractions +```csharp +public Task> GetInteractions(string interactionPrefix, Nullable clientId, Nullable game, CancellationToken token) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `string` | interactionPrefix | | +| `Nullable`<`int`> | clientId | | +| `Nullable`<`Game`> | game | | +| `CancellationToken` | token | | + +#### ProcessInteraction +```csharp +public Task ProcessInteraction(string interactionId, int originId, Nullable targetId, Nullable game, IDictionary meta, CancellationToken token) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `string` | interactionId | | +| `int` | originId | | +| `Nullable`<`int`> | targetId | | +| `Nullable`<`Game`> | game | | +| `IDictionary`<`string`, `string`> | meta | | +| `CancellationToken` | token | | + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfaces-ILogger.md b/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfaces-ILogger.md new file mode 100644 index 0000000..a03a28a --- /dev/null +++ b/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfaces-ILogger.md @@ -0,0 +1,83 @@ +# ILogger `Public interface` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph SharedLibraryCore.Interfaces + SharedLibraryCore.Interfaces.ILogger[[ILogger]] + class SharedLibraryCore.Interfaces.ILogger interfaceStyle; + end +``` + +## Members +### Methods +#### Public methods +| Returns | Name | +| --- | --- | +| `void` | [`WriteAssert`](#writeassert)(`bool` condition, `string` msg) | +| `void` | [`WriteDebug`](#writedebug)(`string` msg) | +| `void` | [`WriteError`](#writeerror)(`string` msg) | +| `void` | [`WriteInfo`](#writeinfo)(`string` msg) | +| `void` | [`WriteVerbose`](#writeverbose)(`string` msg) | +| `void` | [`WriteWarning`](#writewarning)(`string` msg) | + +## Details +### Methods +#### WriteVerbose +```csharp +public void WriteVerbose(string msg) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `string` | msg | | + +#### WriteInfo +```csharp +public void WriteInfo(string msg) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `string` | msg | | + +#### WriteDebug +```csharp +public void WriteDebug(string msg) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `string` | msg | | + +#### WriteWarning +```csharp +public void WriteWarning(string msg) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `string` | msg | | + +#### WriteError +```csharp +public void WriteError(string msg) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `string` | msg | | + +#### WriteAssert +```csharp +public void WriteAssert(bool condition, string msg) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `bool` | condition | | +| `string` | msg | | + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfaces-ILookupValueT.md b/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfaces-ILookupValueT.md new file mode 100644 index 0000000..0a8057f --- /dev/null +++ b/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfaces-ILookupValueT.md @@ -0,0 +1,35 @@ +# ILookupValue< TObject> `Public interface` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph SharedLibraryCore.Interfaces + SharedLibraryCore.Interfaces.ILookupValue_1[[ILookupValue< TObject >]] + class SharedLibraryCore.Interfaces.ILookupValue_1 interfaceStyle; + + end +``` + +## Members +### Properties +#### Public properties +| Type | Name | Methods | +| --- | --- | --- | +| `int` | [`Id`](#id) | `get` | +| `TObject` | [`Value`](#value) | `get` | + +## Details +### Properties +#### Id +```csharp +public int Id { get; } +``` + +#### Value +```csharp +public TObject Value { get; } +``` + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfaces-IManager.md b/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfaces-IManager.md new file mode 100644 index 0000000..c493554 --- /dev/null +++ b/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfaces-IManager.md @@ -0,0 +1,341 @@ +# IManager `Public interface` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph SharedLibraryCore.Interfaces + SharedLibraryCore.Interfaces.IManager[[IManager]] + class SharedLibraryCore.Interfaces.IManager interfaceStyle; + end +``` + +## Members +### Properties +#### 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` | +| `CancellationToken` | [`CancellationToken`](#cancellationtoken) | `get` | +| `IList`<`Func`<[`GameEvent`](./sharedlibrarycore-GameEvent), `bool`>> | [`CommandInterceptors`](#commandinterceptors) | `get` | +| `IReadOnlyList`<[`IManagerCommand`](./sharedlibrarycoreinterfaces-IManagerCommand)> | [`Commands`](#commands) | `get` | +| `string` | [`ExternalIPAddress`](#externalipaddress) | `get` | +| [`IInteractionRegistration`](./sharedlibrarycoreinterfaces-IInteractionRegistration) | [`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` | +| `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) | +| `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)() | +| `Task` | [`Init`](#init)() | +| `void` | [`QueueEvent`](#queueevent)([`CoreEvent`](./sharedlibrarycoreevents-CoreEvent) 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)() | +| `Task` | [`Start`](#start)() | +| `Task` | [`Stop`](#stop)() | + +## Details +### Methods +#### Init +```csharp +public Task Init() +``` + +#### Start +```csharp +public Task Start() +``` + +#### Stop +```csharp +public Task Stop() +``` + +#### Restart +```csharp +public Task Restart() +``` + +#### GetLogger +```csharp +public ILogger GetLogger(long serverId) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `long` | serverId | | + +#### GetServers +```csharp +public IList GetServers() +``` + +#### GetCommands +```csharp +public IList GetCommands() +``` + +#### GetMessageTokens +```csharp +public IList GetMessageTokens() +``` + +#### GetActiveClients +```csharp +public IList GetActiveClients() +``` + +#### FindActiveClient +```csharp +public EFClient FindActiveClient(EFClient client) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| [`EFClient`](./sharedlibrarycoredatabasemodels-EFClient) | client | | + +#### GetApplicationSettings +```csharp +public IConfigurationHandler GetApplicationSettings() +``` + +#### GetClientService +```csharp +public ClientService GetClientService() +``` + +#### GetPenaltyService +```csharp +public PenaltyService GetPenaltyService() +``` + +#### GetPageList +```csharp +public IPageList GetPageList() +``` +##### Summary +provides a page list to add and remove from + +##### Returns + + +#### ExecuteSharedDatabaseOperation +```csharp +public Task> ExecuteSharedDatabaseOperation(string operationName) +where T : +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `string` | operationName | | + +#### RegisterSharedDatabaseOperation +```csharp +public void RegisterSharedDatabaseOperation(Task operation, string operationName) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `Task`<`IList`> | operation | | +| `string` | operationName | | + +#### GenerateDynamicRConParser +```csharp +public IRConParser GenerateDynamicRConParser(string name) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `string` | name | name of the RCon parser | + +##### Summary +generates an rcon parser that can be configured by script plugins + +##### Returns +new rcon parser instance + +#### GenerateDynamicEventParser +```csharp +public IEventParser GenerateDynamicEventParser(string name) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `string` | name | name of the event parser | + +##### Summary +Generates an event parser that can be configured by script plugins + +##### Returns +new event parser instance + +#### ExecuteEvent +```csharp +public Task ExecuteEvent(GameEvent gameEvent) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| [`GameEvent`](./sharedlibrarycore-GameEvent) | gameEvent | | + +#### AddEvent +```csharp +public void AddEvent(GameEvent gameEvent) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| [`GameEvent`](./sharedlibrarycore-GameEvent) | gameEvent | event to be processed | + +##### Summary +queues an event for processing + +#### QueueEvent +```csharp +public void QueueEvent(CoreEvent coreEvent) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| [`CoreEvent`](./sharedlibrarycoreevents-CoreEvent) | coreEvent | | + +##### Summary +queues an event for processing + +#### AddAdditionalCommand +```csharp +public void AddAdditionalCommand(IManagerCommand command) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| [`IManagerCommand`](./sharedlibrarycoreinterfaces-IManagerCommand) | command | | + +##### Summary +adds an additional (script) command to the command list + +#### RemoveCommandByName +```csharp +public void RemoveCommandByName(string name) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `string` | name | name of command | + +##### Summary +removes a command by its name + +### Properties +#### Commands +```csharp +public IReadOnlyList Commands { get; } +``` + +#### Plugins +```csharp +public IEnumerable Plugins { get; } +``` +##### Summary +enumerates the registered plugin instances + +#### AdditionalRConParsers +```csharp +public IList AdditionalRConParsers { get; } +``` + +#### AdditionalEventParsers +```csharp +public IList AdditionalEventParsers { get; } +``` + +#### MiddlewareActionHandler +```csharp +public IMiddlewareActionHandler MiddlewareActionHandler { get; } +``` + +#### CommandInterceptors +```csharp +public IList> CommandInterceptors { get; } +``` + +#### Version +```csharp +public string Version { get; } +``` + +#### TokenAuthenticator +```csharp +public ITokenAuthentication TokenAuthenticator { get; } +``` + +#### ExternalIPAddress +```csharp +public string ExternalIPAddress { get; } +``` + +#### CancellationToken +```csharp +public CancellationToken CancellationToken { get; } +``` + +#### IsRestartRequested +```csharp +public bool IsRestartRequested { get; } +``` + +#### IsRunning +```csharp +public bool IsRunning { get; } +``` + +#### ProcessingEvents +```csharp +public ConcurrentDictionary ProcessingEvents { get; } +``` + +#### AlertManager +```csharp +public IAlertManager AlertManager { get; } +``` + +#### InteractionRegistration +```csharp +public IInteractionRegistration InteractionRegistration { get; } +``` + +### Events +#### OnGameEventExecuted +```csharp +public event EventHandler OnGameEventExecuted +``` +##### Summary +event executed when event has finished executing + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfaces-IManagerCommand.md b/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfaces-IManagerCommand.md new file mode 100644 index 0000000..5993cf5 --- /dev/null +++ b/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfaces-IManagerCommand.md @@ -0,0 +1,122 @@ +# IManagerCommand `Public interface` + +## Description +Defines the basic properties of a command + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph SharedLibraryCore.Interfaces + SharedLibraryCore.Interfaces.IManagerCommand[[IManagerCommand]] + class SharedLibraryCore.Interfaces.IManagerCommand interfaceStyle; + end +``` + +## Members +### Properties +#### Public properties +| Type | Name | Methods | +| --- | --- | --- | +| `string` | [`Alias`](#alias)
Alternative name of the command | `get` | +| `bool` | [`AllowImpersonation`](#allowimpersonation)
Indicates if the commands can be run as another client | `get` | +| `string` | [`Description`](#description)
Description of the command | `get` | +| `bool` | [`IsBroadcast`](#isbroadcast)
Indicates if the command result should be broadcasted to all clients | `get, set` | +| `string` | [`Name`](#name)
Name of the command | `get` | +| `Permission` | [`Permission`](#permission)
Minimum permission required to execute the command | `get` | +| `bool` | [`RequiresTarget`](#requirestarget)
Indicates if target is required | `get` | +| `Game``[]` | [`SupportedGames`](#supportedgames)
Games the command is supported on | `get` | +| `string` | [`Syntax`](#syntax)
Syntax for using the command | `get` | + +### Methods +#### Public methods +| Returns | Name | +| --- | --- | +| `Task` | [`ExecuteAsync`](#executeasync)([`GameEvent`](./sharedlibrarycore-GameEvent) gameEvent)
Executes the command | + +## Details +### Summary +Defines the basic properties of a command + +### Methods +#### ExecuteAsync +```csharp +public Task ExecuteAsync(GameEvent gameEvent) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| [`GameEvent`](./sharedlibrarycore-GameEvent) | gameEvent | event corresponding to the command | + +##### Summary +Executes the command + +##### Returns + + +### Properties +#### Name +```csharp +public string Name { get; } +``` +##### Summary +Name of the command + +#### Description +```csharp +public string Description { get; } +``` +##### Summary +Description of the command + +#### Alias +```csharp +public string Alias { get; } +``` +##### Summary +Alternative name of the command + +#### Permission +```csharp +public Permission Permission { get; } +``` +##### Summary +Minimum permission required to execute the command + +#### SupportedGames +```csharp +public Game SupportedGames { get; } +``` +##### Summary +Games the command is supported on + +#### Syntax +```csharp +public string Syntax { get; } +``` +##### Summary +Syntax for using the command + +#### RequiresTarget +```csharp +public bool RequiresTarget { get; } +``` +##### Summary +Indicates if target is required + +#### AllowImpersonation +```csharp +public bool AllowImpersonation { get; } +``` +##### Summary +Indicates if the commands can be run as another client + +#### IsBroadcast +```csharp +public bool IsBroadcast { get; set; } +``` +##### Summary +Indicates if the command result should be broadcasted to all clients + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfaces-IMasterCommunication.md b/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfaces-IMasterCommunication.md new file mode 100644 index 0000000..c2e8192 --- /dev/null +++ b/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfaces-IMasterCommunication.md @@ -0,0 +1,55 @@ +# IMasterCommunication `Public interface` + +## Description +defines the capabilities of the communication to the master server + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph SharedLibraryCore.Interfaces + SharedLibraryCore.Interfaces.IMasterCommunication[[IMasterCommunication]] + class SharedLibraryCore.Interfaces.IMasterCommunication interfaceStyle; + end +``` + +## Members +### Methods +#### Public methods +| Returns | Name | +| --- | --- | +| `Task` | [`CheckVersion`](#checkversion)()
checks the current version of IW4MAdmin against the master version | +| `Task` | [`RunUploadStatus`](#runuploadstatus)(`CancellationToken` token)
Sends heart beats to the master | + +## Details +### Summary +defines the capabilities of the communication to the master server + +### Methods +#### CheckVersion +```csharp +public Task CheckVersion() +``` +##### Summary +checks the current version of IW4MAdmin against the master version + +##### Returns + + +#### RunUploadStatus +```csharp +public Task RunUploadStatus(CancellationToken token) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `CancellationToken` | token | Cancellation token | + +##### Summary +Sends heart beats to the master + +##### Returns + + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfaces-IMatchResult.md b/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfaces-IMatchResult.md new file mode 100644 index 0000000..0782d49 --- /dev/null +++ b/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfaces-IMatchResult.md @@ -0,0 +1,44 @@ +# IMatchResult `Public interface` + +## Description +represents a pattern match result + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph SharedLibraryCore.Interfaces + SharedLibraryCore.Interfaces.IMatchResult[[IMatchResult]] + class SharedLibraryCore.Interfaces.IMatchResult interfaceStyle; + end +``` + +## Members +### Properties +#### Public properties +| Type | Name | Methods | +| --- | --- | --- | +| `bool` | [`Success`](#success)
indicates if the match succeeded | `get, set` | +| `string``[]` | [`Values`](#values)
array of matched pattern groups | `get, set` | + +## Details +### Summary +represents a pattern match result + +### Properties +#### Values +```csharp +public string Values { get; set; } +``` +##### Summary +array of matched pattern groups + +#### Success +```csharp +public bool Success { get; set; } +``` +##### Summary +indicates if the match succeeded + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfaces-IMetaRegistration.md b/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfaces-IMetaRegistration.md new file mode 100644 index 0000000..c16e6b1 --- /dev/null +++ b/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfaces-IMetaRegistration.md @@ -0,0 +1,28 @@ +# IMetaRegistration `Public interface` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph SharedLibraryCore.Interfaces + SharedLibraryCore.Interfaces.IMetaRegistration[[IMetaRegistration]] + class SharedLibraryCore.Interfaces.IMetaRegistration interfaceStyle; + end +``` + +## Members +### Methods +#### Public methods +| Returns | Name | +| --- | --- | +| `void` | [`Register`](#register)() | + +## Details +### Methods +#### Register +```csharp +public void Register() +``` + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfaces-IMetaService.md b/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfaces-IMetaService.md new file mode 100644 index 0000000..802ff49 --- /dev/null +++ b/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfaces-IMetaService.md @@ -0,0 +1,216 @@ +# IMetaService `Public interface` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph SharedLibraryCore.Interfaces + SharedLibraryCore.Interfaces.IMetaService[[IMetaService]] + class SharedLibraryCore.Interfaces.IMetaService interfaceStyle; + end +``` + +## Members +### Methods +#### Public methods +| 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) | +| `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` | [`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 | + +## Details +### Methods +#### AddPersistentMeta [1/2] +```csharp +public Task AddPersistentMeta(string metaKey, string metaValue, EFClient client, EFMeta linkedMeta) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `string` | metaKey | key of meta data | +| `string` | metaValue | value of the meta data | +| [`EFClient`](./sharedlibrarycoredatabasemodels-EFClient) | client | client to save the meta for | +| `EFMeta` | linkedMeta | | + +##### Summary +adds or updates meta key and value to the database + +##### Returns + + +#### SetPersistentMeta +```csharp +public Task SetPersistentMeta(string metaKey, string metaValue, int clientId) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `string` | metaKey | key of meta data | +| `string` | metaValue | value of the meta data | +| `int` | clientId | id of the client to save the meta for | + +##### Summary +adds or updates meta key and value to the database + +##### Returns + + +#### IncrementPersistentMeta +```csharp +public Task IncrementPersistentMeta(string metaKey, int incrementAmount, int clientId) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `string` | metaKey | key of meta data | +| `int` | incrementAmount | value to increment by | +| `int` | clientId | id of the client to save the meta for | + +##### Summary +increments meta value and persists to the database if the meta value does not already exist it will be set to the increment amount + +##### Returns + + +#### DecrementPersistentMeta +```csharp +public Task DecrementPersistentMeta(string metaKey, int decrementAmount, int clientId) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `string` | metaKey | key of meta data | +| `int` | decrementAmount | value to increment by | +| `int` | clientId | id of the client to save the meta for | + +##### Summary +decrements meta value and persists to the database if the meta value does not already exist it will be set to the decrement amount + +##### Returns + + +#### AddPersistentMeta [2/2] +```csharp +public Task AddPersistentMeta(string metaKey, string metaValue) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `string` | metaKey | key of meta data | +| `string` | metaValue | value of the meta data | + +##### Summary +adds or updates meta key and value to the database + +##### Returns + + +#### RemovePersistentMeta [1/2] +```csharp +public Task RemovePersistentMeta(string metaKey, EFClient client) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `string` | metaKey | key of meta data | +| [`EFClient`](./sharedlibrarycoredatabasemodels-EFClient) | client | client to delete the meta for | + +##### Summary +removes meta key with given value + +##### Returns + + +#### RemovePersistentMeta [2/2] +```csharp +public Task RemovePersistentMeta(string metaKey, string metaValue) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `string` | metaKey | key of the meta data | +| `string` | metaValue | value of the meta data | + +##### Summary +removes meta key with given value + +##### Returns + + +#### GetPersistentMeta [1/2] +```csharp +public Task GetPersistentMeta(string metaKey, EFClient client) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `string` | metaKey | key to retrieve value for | +| [`EFClient`](./sharedlibrarycoredatabasemodels-EFClient) | client | client to retrieve meta for | + +##### Summary +retrieves meta data for given client and key + +##### Returns + + +#### GetPersistentMeta [2/2] +```csharp +public Task> GetPersistentMeta(string metaKey) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `string` | metaKey | key to retrieve values for | + +##### Summary +retrieves collection of meta for given key + +##### Returns + + +#### AddRuntimeMeta +```csharp +public void AddRuntimeMeta(MetaType metaKey, Func>> metaAction) +where T : PaginationRequest +where V : IClientMeta +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| [`MetaType`](./sharedlibrarycoreinterfaces-MetaType) | metaKey | | +| `Func`<`T`, `Task`<`IEnumerable`<`V`>>> | metaAction | | + +#### GetRuntimeMeta [1/2] +```csharp +public Task> GetRuntimeMeta(ClientPaginationRequest request) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| [`ClientPaginationRequest`](./sharedlibrarycorequeryhelper-ClientPaginationRequest) | request | request information | + +##### Summary +retrieves all the runtime meta information for given client idea + +##### Returns + + +#### GetRuntimeMeta [2/2] +```csharp +public Task> GetRuntimeMeta(ClientPaginationRequest request, MetaType metaType) +where T : IClientMeta +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| [`ClientPaginationRequest`](./sharedlibrarycorequeryhelper-ClientPaginationRequest) | request | | +| [`MetaType`](./sharedlibrarycoreinterfaces-MetaType) | metaType | | + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfaces-IMetaServiceV2.md b/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfaces-IMetaServiceV2.md new file mode 100644 index 0000000..e863bf6 --- /dev/null +++ b/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfaces-IMetaServiceV2.md @@ -0,0 +1,295 @@ +# IMetaServiceV2 `Public interface` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph SharedLibraryCore.Interfaces + SharedLibraryCore.Interfaces.IMetaServiceV2[[IMetaServiceV2]] + class SharedLibraryCore.Interfaces.IMetaServiceV2 interfaceStyle; + end +``` + +## Members +### Methods +#### Public methods +| Returns | Name | +| --- | --- | +| `void` | [`AddRuntimeMeta`](#addruntimemeta)([`MetaType`](./sharedlibrarycoreinterfaces-MetaType) 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` | [`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 | +| `Task` | [`SetPersistentMetaForLookupKey`](#setpersistentmetaforlookupkey)(`string` metaKey, `string` lookupKey, `int` lookupId, `int` clientId, `CancellationToken` token)
Sets meta key to a linked lookup key and id | +| `Task` | [`SetPersistentMetaValue`](#setpersistentmetavalue-12)(`...`) | + +## Details +### Methods +#### SetPersistentMeta [1/2] +```csharp +public Task SetPersistentMeta(string metaKey, string metaValue, int clientId, CancellationToken token) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `string` | metaKey | key of meta data | +| `string` | metaValue | value of the meta data | +| `int` | clientId | id of the client to save the meta for | +| `CancellationToken` | token | | + +##### Summary +adds or updates meta key and value to the database as simple string + +##### Returns + + +#### SetPersistentMetaValue [1/2] +```csharp +public Task SetPersistentMetaValue(string metaKey, T metaValue, int clientId, CancellationToken token) +where T : +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `string` | metaKey | | +| `T` | metaValue | | +| `int` | clientId | | +| `CancellationToken` | token | | + +#### SetPersistentMetaForLookupKey +```csharp +public Task SetPersistentMetaForLookupKey(string metaKey, string lookupKey, int lookupId, int clientId, CancellationToken token) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `string` | metaKey | Key for the client meta | +| `string` | lookupKey | Key of the global lookup meta | +| `int` | lookupId | Id in the list of lookup values | +| `int` | clientId | id of the client | +| `CancellationToken` | token | | + +##### Summary +Sets meta key to a linked lookup key and id + +##### Returns + + +#### IncrementPersistentMeta +```csharp +public Task IncrementPersistentMeta(string metaKey, int incrementAmount, int clientId, CancellationToken token) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `string` | metaKey | key of meta data | +| `int` | incrementAmount | value to increment by | +| `int` | clientId | id of the client to save the meta for | +| `CancellationToken` | token | | + +##### Summary +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 + +##### Returns + + +#### DecrementPersistentMeta +```csharp +public Task DecrementPersistentMeta(string metaKey, int decrementAmount, int clientId, CancellationToken token) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `string` | metaKey | key of meta data | +| `int` | decrementAmount | value to increment by | +| `int` | clientId | id of the client to save the meta for | +| `CancellationToken` | token | | + +##### Summary +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 + +##### Returns + + +#### GetPersistentMeta [1/2] +```csharp +public Task GetPersistentMeta(string metaKey, int clientId, CancellationToken token) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `string` | metaKey | | +| `int` | clientId | | +| `CancellationToken` | token | | + +##### Summary +retrieves meta entry + +##### Returns + + +#### GetPersistentMetaValue [1/2] +```csharp +public Task GetPersistentMetaValue(string metaKey, int clientId, CancellationToken token) +where T : +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `string` | metaKey | | +| `int` | clientId | | +| `CancellationToken` | token | | + +#### GetPersistentMetaByLookup +```csharp +public Task GetPersistentMetaByLookup(string metaKey, string lookupKey, int clientId, CancellationToken token) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `string` | metaKey | | +| `string` | lookupKey | | +| `int` | clientId | | +| `CancellationToken` | token | | + +##### Summary +retrieves meta entry by with associated lookup value as string + +##### Returns + + +#### RemovePersistentMeta [1/2] +```csharp +public Task RemovePersistentMeta(string metaKey, int clientId, CancellationToken token) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `string` | metaKey | key of meta data | +| `int` | clientId | client to delete the meta for | +| `CancellationToken` | token | | + +##### Summary +removes meta key with given value + +##### Returns + + +#### SetPersistentMeta [2/2] +```csharp +public Task SetPersistentMeta(string metaKey, string metaValue, CancellationToken token) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `string` | metaKey | key of meta data | +| `string` | metaValue | value of the meta data | +| `CancellationToken` | token | | + +##### Summary +adds or updates meta key and value to the database + +##### Returns + + +#### SetPersistentMetaValue [2/2] +```csharp +public Task SetPersistentMetaValue(string metaKey, T metaValue, CancellationToken token) +where T : +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `string` | metaKey | | +| `T` | metaValue | | +| `CancellationToken` | token | | + +#### RemovePersistentMeta [2/2] +```csharp +public Task RemovePersistentMeta(string metaKey, CancellationToken token) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `string` | metaKey | key of the meta data | +| `CancellationToken` | token | | + +##### Summary +removes meta key with given value + +##### Returns + + +#### GetPersistentMeta [2/2] +```csharp +public Task GetPersistentMeta(string metaKey, CancellationToken token) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `string` | metaKey | key to retrieve values for | +| `CancellationToken` | token | | + +##### Summary +retrieves collection of meta for given key + +##### Returns + + +#### GetPersistentMetaValue [2/2] +```csharp +public Task GetPersistentMetaValue(string metaKey, CancellationToken token) +where T : +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `string` | metaKey | | +| `CancellationToken` | token | | + +#### AddRuntimeMeta +```csharp +public void AddRuntimeMeta(MetaType metaKey, Func>> metaAction) +where T : PaginationRequest +where TReturn : IClientMeta +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| [`MetaType`](./sharedlibrarycoreinterfaces-MetaType) | metaKey | | +| `Func`<`T`, `CancellationToken`, `Task`<`IEnumerable`<`TReturn`>>> | metaAction | | + +#### GetRuntimeMeta [1/2] +```csharp +public Task> GetRuntimeMeta(ClientPaginationRequest request, CancellationToken token) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| [`ClientPaginationRequest`](./sharedlibrarycorequeryhelper-ClientPaginationRequest) | request | request information | +| `CancellationToken` | token | | + +##### Summary +retrieves all the runtime meta information for given client idea + +##### Returns + + +#### GetRuntimeMeta [2/2] +```csharp +public Task> GetRuntimeMeta(ClientPaginationRequest request, MetaType metaType, CancellationToken token) +where T : IClientMeta +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| [`ClientPaginationRequest`](./sharedlibrarycorequeryhelper-ClientPaginationRequest) | request | | +| [`MetaType`](./sharedlibrarycoreinterfaces-MetaType) | metaType | | +| `CancellationToken` | token | | + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfaces-IMiddlewareActionHandler.md b/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfaces-IMiddlewareActionHandler.md new file mode 100644 index 0000000..be20aec --- /dev/null +++ b/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfaces-IMiddlewareActionHandler.md @@ -0,0 +1,53 @@ +# IMiddlewareActionHandler `Public interface` + +## Description +used to handle middleware actions registered from arbitrary assemblies + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph SharedLibraryCore.Interfaces + SharedLibraryCore.Interfaces.IMiddlewareActionHandler[[IMiddlewareActionHandler]] + class SharedLibraryCore.Interfaces.IMiddlewareActionHandler interfaceStyle; + end +``` + +## Members +### Methods +#### Public methods +| Returns | Name | +| --- | --- | +| `Task`<`T`> | [`Execute`](#execute)(`T` value, `string` name) | +| `void` | [`Register`](#register)(`T` actionType, [`IMiddlewareAction`](./sharedlibrarycoreinterfaces-IMiddlewareActionT)<`T`> action, `string` name) | + +## Details +### Summary +used to handle middleware actions registered from arbitrary assemblies + +### Methods +#### Register +```csharp +public void Register(T actionType, IMiddlewareAction action, string name) +where T : +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `T` | actionType | | +| [`IMiddlewareAction`](./sharedlibrarycoreinterfaces-IMiddlewareActionT)<`T`> | action | | +| `string` | name | | + +#### Execute +```csharp +public Task Execute(T value, string name) +where T : +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `T` | value | | +| `string` | name | | + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfaces-IMiddlewareActionT.md b/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfaces-IMiddlewareActionT.md new file mode 100644 index 0000000..26913c0 --- /dev/null +++ b/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfaces-IMiddlewareActionT.md @@ -0,0 +1,44 @@ +# IMiddlewareAction< T> `Public interface` + +## Description +represents an invokable middleware action + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph SharedLibraryCore.Interfaces + SharedLibraryCore.Interfaces.IMiddlewareAction_1[[IMiddlewareAction< T >]] + class SharedLibraryCore.Interfaces.IMiddlewareAction_1 interfaceStyle; + + end +``` + +## Members +### Methods +#### Public methods +| Returns | Name | +| --- | --- | +| `Task`<`T`> | [`Invoke`](#invoke)(`T` original) | + +## Details +### Summary +represents an invokable middleware action + +### Generic types +| Type | Description | Constraints | +| --- | --- | --- | +| `T` | | | + +### Methods +#### Invoke +```csharp +public Task Invoke(T original) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `T` | original | | + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfaces-IModelConfiguration.md b/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfaces-IModelConfiguration.md new file mode 100644 index 0000000..f64845b --- /dev/null +++ b/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfaces-IModelConfiguration.md @@ -0,0 +1,32 @@ +# IModelConfiguration `Public interface` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph SharedLibraryCore.Interfaces + SharedLibraryCore.Interfaces.IModelConfiguration[[IModelConfiguration]] + class SharedLibraryCore.Interfaces.IModelConfiguration interfaceStyle; + end +``` + +## Members +### Methods +#### Public methods +| Returns | Name | +| --- | --- | +| `void` | [`Configure`](#configure)(`ModelBuilder` builder) | + +## Details +### Methods +#### Configure +```csharp +public void Configure(ModelBuilder builder) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `ModelBuilder` | builder | | + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfaces-IModularAssembly.md b/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfaces-IModularAssembly.md new file mode 100644 index 0000000..c53d89c --- /dev/null +++ b/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfaces-IModularAssembly.md @@ -0,0 +1,58 @@ +# IModularAssembly `Public interface` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph SharedLibraryCore.Interfaces + SharedLibraryCore.Interfaces.IModularAssembly[[IModularAssembly]] + class SharedLibraryCore.Interfaces.IModularAssembly interfaceStyle; + end +``` + +## Members +### Properties +#### Public properties +| Type | Name | Methods | +| --- | --- | --- | +| `string` | [`Author`](#author) | `get` | +| `string``[]` | [`Claims`](#claims) | `get` | +| `string` | [`Name`](#name) | `get` | +| `string` | [`Role`](#role) | `get` | +| `string` | [`Scope`](#scope) | `get` | +| `string` | [`Version`](#version) | `get` | + +## Details +### Properties +#### Name +```csharp +public string Name { get; } +``` + +#### Author +```csharp +public string Author { get; } +``` + +#### Version +```csharp +public string Version { get; } +``` + +#### Scope +```csharp +public string Scope { get; } +``` + +#### Role +```csharp +public string Role { get; } +``` + +#### Claims +```csharp +public string Claims { get; } +``` + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfaces-IPageList.md b/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfaces-IPageList.md new file mode 100644 index 0000000..4e681da --- /dev/null +++ b/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfaces-IPageList.md @@ -0,0 +1,28 @@ +# IPageList `Public interface` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph SharedLibraryCore.Interfaces + SharedLibraryCore.Interfaces.IPageList[[IPageList]] + class SharedLibraryCore.Interfaces.IPageList interfaceStyle; + end +``` + +## Members +### Properties +#### Public properties +| Type | Name | Methods | +| --- | --- | --- | +| `IDictionary`<`string`, `string`> | [`Pages`](#pages) | `get, set` | + +## Details +### Properties +#### Pages +```csharp +public IDictionary Pages { get; set; } +``` + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfaces-IParserPatternMatcher.md b/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfaces-IParserPatternMatcher.md new file mode 100644 index 0000000..eafb413 --- /dev/null +++ b/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfaces-IParserPatternMatcher.md @@ -0,0 +1,57 @@ +# IParserPatternMatcher `Public interface` + +## Description +defines the capabilities of a parser pattern + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph SharedLibraryCore.Interfaces + SharedLibraryCore.Interfaces.IParserPatternMatcher[[IParserPatternMatcher]] + class SharedLibraryCore.Interfaces.IParserPatternMatcher interfaceStyle; + end +``` + +## Members +### Methods +#### Public methods +| 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 | + +## Details +### Summary +defines the capabilities of a parser pattern + +### Methods +#### Match +```csharp +public IMatchResult Match(string input) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `string` | input | input string | + +##### Summary +converts input string into pattern groups + +##### Returns +group matches + +#### Compile +```csharp +public void Compile(string pattern) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `string` | pattern | | + +##### Summary +compiles the pattern to be used for matching + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfaces-IParserRegexFactory.md b/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfaces-IParserRegexFactory.md new file mode 100644 index 0000000..4a9a199 --- /dev/null +++ b/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfaces-IParserRegexFactory.md @@ -0,0 +1,39 @@ +# IParserRegexFactory `Public interface` + +## Description +defines the capabilities of the parser regex factory + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph SharedLibraryCore.Interfaces + SharedLibraryCore.Interfaces.IParserRegexFactory[[IParserRegexFactory]] + class SharedLibraryCore.Interfaces.IParserRegexFactory interfaceStyle; + end +``` + +## Members +### Methods +#### Public methods +| Returns | Name | +| --- | --- | +| [`ParserRegex`](./sharedlibrarycoreinterfaces-ParserRegex) | [`CreateParserRegex`](#createparserregex)()
creates a new ParserRegex instance | + +## Details +### Summary +defines the capabilities of the parser regex factory + +### Methods +#### CreateParserRegex +```csharp +public ParserRegex CreateParserRegex() +``` +##### Summary +creates a new ParserRegex instance + +##### Returns +ParserRegex instance + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfaces-IPlugin.md b/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfaces-IPlugin.md new file mode 100644 index 0000000..d9e7635 --- /dev/null +++ b/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfaces-IPlugin.md @@ -0,0 +1,89 @@ +# IPlugin `Public interface` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph SharedLibraryCore.Interfaces + SharedLibraryCore.Interfaces.IPlugin[[IPlugin]] + class SharedLibraryCore.Interfaces.IPlugin interfaceStyle; + end +``` + +## Members +### Properties +#### Public properties +| Type | Name | Methods | +| --- | --- | --- | +| `string` | [`Author`](#author) | `get` | +| `bool` | [`IsParser`](#isparser) | `get` | +| `string` | [`Name`](#name) | `get` | +| `float` | [`Version`](#version) | `get` | + +### Methods +#### 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` | [`OnUnloadAsync`](#onunloadasync)() | + +## Details +### Methods +#### OnLoadAsync +```csharp +public Task OnLoadAsync(IManager manager) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| [`IManager`](./sharedlibrarycoreinterfaces-IManager) | manager | | + +#### OnUnloadAsync +```csharp +public Task OnUnloadAsync() +``` + +#### OnEventAsync +```csharp +public Task OnEventAsync(GameEvent gameEvent, Server server) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| [`GameEvent`](./sharedlibrarycore-GameEvent) | gameEvent | | +| [`Server`](./sharedlibrarycore-Server) | server | | + +#### OnTickAsync +```csharp +public Task OnTickAsync(Server S) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| [`Server`](./sharedlibrarycore-Server) | S | | + +### Properties +#### Name +```csharp +public string Name { get; } +``` + +#### Version +```csharp +public float Version { get; } +``` + +#### Author +```csharp +public string Author { get; } +``` + +#### IsParser +```csharp +public bool IsParser { get; } +``` + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfaces-IPluginImporter.md b/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfaces-IPluginImporter.md new file mode 100644 index 0000000..c3c8647 --- /dev/null +++ b/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfaces-IPluginImporter.md @@ -0,0 +1,50 @@ +# IPluginImporter `Public interface` + +## Description +defines the capabilities of the plugin importer + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph SharedLibraryCore.Interfaces + SharedLibraryCore.Interfaces.IPluginImporter[[IPluginImporter]] + class SharedLibraryCore.Interfaces.IPluginImporter interfaceStyle; + end +``` + +## Members +### Methods +#### Public methods +| Returns | Name | +| --- | --- | +| (`IEnumerable`<`Type`> Item1, `IEnumerable`<`Type`> Item2, `IEnumerable`<`Type`> Item3) | [`DiscoverAssemblyPluginImplementations`](#discoverassemblypluginimplementations)()
discovers C# assembly plugin and command types | +| `IEnumerable`<(`Type` Item1, `string` Item2)> | [`DiscoverScriptPlugins`](#discoverscriptplugins)()
discovers the script plugins | + +## Details +### Summary +defines the capabilities of the plugin importer + +### Methods +#### DiscoverAssemblyPluginImplementations +```csharp +public (IEnumerable Item1, IEnumerable Item2, IEnumerable Item3) DiscoverAssemblyPluginImplementations() +``` +##### Summary +discovers C# assembly plugin and command types + +##### Returns +tuple of IPlugin implementation type definitions, and IManagerCommand type definitions + +#### DiscoverScriptPlugins +```csharp +public IEnumerable<(Type Item1, string Item2)> DiscoverScriptPlugins() +``` +##### Summary +discovers the script plugins + +##### Returns +initialized script plugin collection + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfaces-IPluginV2.md b/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfaces-IPluginV2.md new file mode 100644 index 0000000..d5068f2 --- /dev/null +++ b/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfaces-IPluginV2.md @@ -0,0 +1,40 @@ +# IPluginV2 `Public interface` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph SharedLibraryCore.Interfaces + SharedLibraryCore.Interfaces.IPluginV2[[IPluginV2]] + class SharedLibraryCore.Interfaces.IPluginV2 interfaceStyle; + SharedLibraryCore.Interfaces.IModularAssembly[[IModularAssembly]] + class SharedLibraryCore.Interfaces.IModularAssembly interfaceStyle; + end +SharedLibraryCore.Interfaces.IModularAssembly --> SharedLibraryCore.Interfaces.IPluginV2 +``` + +## Members +### Methods +#### Public Static methods +| Returns | Name | +| --- | --- | +| `void` | [`RegisterDependencies`](#registerdependencies)(`IServiceCollection` serviceProvider) | + +## Details +### Inheritance + - [ +`IModularAssembly` +](./sharedlibrarycoreinterfaces-IModularAssembly) + +### Methods +#### RegisterDependencies +```csharp +public static void RegisterDependencies(IServiceCollection serviceProvider) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `IServiceCollection` | serviceProvider | | + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfaces-IRConConnection.md b/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfaces-IRConConnection.md new file mode 100644 index 0000000..3af0bf2 --- /dev/null +++ b/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfaces-IRConConnection.md @@ -0,0 +1,53 @@ +# IRConConnection `Public interface` + +## Description +defines the capabilities of an RCon connection + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph SharedLibraryCore.Interfaces + SharedLibraryCore.Interfaces.IRConConnection[[IRConConnection]] + class SharedLibraryCore.Interfaces.IRConConnection interfaceStyle; + end +``` + +## Members +### Methods +#### Public methods +| Returns | Name | +| --- | --- | +| `Task`<`string``[]`> | [`SendQueryAsync`](#sendqueryasync)(`QueryType` type, `string` parameters, `CancellationToken` token) | +| `void` | [`SetConfiguration`](#setconfiguration)([`IRConParser`](./sharedlibrarycoreinterfaces-IRConParser) config)
sets the rcon parser | + +## Details +### Summary +defines the capabilities of an RCon connection + +### Methods +#### SendQueryAsync +```csharp +public Task SendQueryAsync(QueryType type, string parameters, CancellationToken token) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `QueryType` | type | | +| `string` | parameters | | +| `CancellationToken` | token | | + +#### SetConfiguration +```csharp +public void SetConfiguration(IRConParser config) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| [`IRConParser`](./sharedlibrarycoreinterfaces-IRConParser) | config | parser | + +##### Summary +sets the rcon parser + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfaces-IRConConnectionFactory.md b/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfaces-IRConConnectionFactory.md new file mode 100644 index 0000000..492d910 --- /dev/null +++ b/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfaces-IRConConnectionFactory.md @@ -0,0 +1,46 @@ +# IRConConnectionFactory `Public interface` + +## Description +defines the capabilities of an RCon connection factory + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph SharedLibraryCore.Interfaces + SharedLibraryCore.Interfaces.IRConConnectionFactory[[IRConConnectionFactory]] + class SharedLibraryCore.Interfaces.IRConConnectionFactory interfaceStyle; + end +``` + +## Members +### Methods +#### Public methods +| Returns | Name | +| --- | --- | +| [`IRConConnection`](./sharedlibrarycoreinterfaces-IRConConnection) | [`CreateConnection`](#createconnection)(`IPEndPoint` ipEndpoint, `string` password, `string` rconEngine)
creates an rcon connection instance | + +## Details +### Summary +defines the capabilities of an RCon connection factory + +### Methods +#### CreateConnection +```csharp +public IRConConnection CreateConnection(IPEndPoint ipEndpoint, string password, string rconEngine) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `IPEndPoint` | ipEndpoint | ip address and port of the server | +| `string` | password | password of the server | +| `string` | rconEngine | engine to create the rcon connection to | + +##### Summary +creates an rcon connection instance + +##### Returns +instance of rcon connection + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfaces-IRConParser.md b/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfaces-IRConParser.md new file mode 100644 index 0000000..b74e8bc --- /dev/null +++ b/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfaces-IRConParser.md @@ -0,0 +1,199 @@ +# IRConParser `Public interface` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph SharedLibraryCore.Interfaces + SharedLibraryCore.Interfaces.IRConParser[[IRConParser]] + class SharedLibraryCore.Interfaces.IRConParser interfaceStyle; + end +``` + +## Members +### Properties +#### Public properties +| 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` | +| `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` | +| `string` | [`RConEngine`](#rconengine)
specifies the type of rcon engine
eg: COD, Source | `get` | +| `string` | [`Version`](#version)
stores the game/client specific version (usually the value of the "version" DVAR) | `get` | + +### Methods +#### Public methods +| Returns | Name | +| --- | --- | +| `Task`<`string``[]`> | [`ExecuteCommandAsync`](#executecommandasync)([`IRConConnection`](./sharedlibrarycoreinterfaces-IRConConnection) 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) | +| `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 | +| `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 | + +## Details +### Methods +#### GetDvarAsync +```csharp +public Task> GetDvarAsync(IRConConnection connection, string dvarName, T fallbackValue, CancellationToken token) +where T : +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| [`IRConConnection`](./sharedlibrarycoreinterfaces-IRConConnection) | connection | | +| `string` | dvarName | | +| `T` | fallbackValue | | +| `CancellationToken` | token | | + +#### SetDvarAsync +```csharp +public Task SetDvarAsync(IRConConnection connection, string dvarName, object dvarValue, CancellationToken token) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| [`IRConConnection`](./sharedlibrarycoreinterfaces-IRConConnection) | connection | RCon connection to use | +| `string` | dvarName | name of DVAR to set | +| `object` | dvarValue | value to set DVAR to | +| `CancellationToken` | token | | + +##### Summary +set value of DVAR by name + +##### Returns + + +#### ExecuteCommandAsync +```csharp +public Task ExecuteCommandAsync(IRConConnection connection, string command, CancellationToken token) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| [`IRConConnection`](./sharedlibrarycoreinterfaces-IRConConnection) | connection | RCon connection to use | +| `string` | command | console command to execute | +| `CancellationToken` | token | | + +##### Summary +executes a console command on the server + +##### Returns + + +#### GetStatusAsync +```csharp +public Task GetStatusAsync(IRConConnection connection, CancellationToken token) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| [`IRConConnection`](./sharedlibrarycoreinterfaces-IRConConnection) | connection | RCon connection to use | +| `CancellationToken` | token | | + +##### Summary +get the list of connected clients from status response + +##### Returns +[IStatusResponse](./sharedlibrarycoreinterfaces-IStatusResponse) + +#### GetOverrideDvarName +```csharp +public string GetOverrideDvarName(string dvarName) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `string` | dvarName | name of dvar key | + +##### Summary +retrieves the value of given dvar key if it exists in the override dict + otherwise returns original + +##### Returns + + +#### GetDefaultDvarValue +```csharp +public T GetDefaultDvarValue(string dvarName) +where T : +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `string` | dvarName | | + +#### OverrideTimeoutForCommand +```csharp +public Nullable OverrideTimeoutForCommand(string command) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `string` | command | name of command being executed | + +##### Summary +determines the amount of time to wait for the command to respond + +##### Returns + + +### Properties +#### Configuration +```csharp +public IRConParserConfiguration Configuration { get; set; } +``` +##### Summary +stores the RCon configuration + +#### Version +```csharp +public string Version { get; } +``` +##### Summary +stores the game/client specific version (usually the value of the "version" DVAR) + +#### GameName +```csharp +public Game GameName { get; } +``` +##### Summary +specifies the game name (usually the internal studio iteration ie: IW4, T5 etc...) + +#### CanGenerateLogPath +```csharp +public bool CanGenerateLogPath { get; } +``` +##### Summary +indicates if the game supports generating a log path from DVAR retrieval + of fs_game, fs_basepath, g_log + +#### Name +```csharp +public string Name { get; } +``` +##### Summary +specifies the name of the parser + +#### RConEngine +```csharp +public string RConEngine { get; } +``` +##### Summary +specifies the type of rcon engine + eg: COD, Source + +#### IsOneLog +```csharp +public bool IsOneLog { get; } +``` +##### Summary +indicates that the game does not log to the mods folder (when mod is loaded), + but rather always to the fs_basegame directory + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfaces-IRConParserConfiguration.md b/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfaces-IRConParserConfiguration.md new file mode 100644 index 0000000..2048d74 --- /dev/null +++ b/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfaces-IRConParserConfiguration.md @@ -0,0 +1,196 @@ +# IRConParserConfiguration `Public interface` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph SharedLibraryCore.Interfaces + SharedLibraryCore.Interfaces.IRConParserConfiguration[[IRConParserConfiguration]] + class SharedLibraryCore.Interfaces.IRConParserConfiguration interfaceStyle; + end +``` + +## Members +### Properties +#### Public properties +| Type | Name | Methods | +| --- | --- | --- | +| [`ColorCodeMapping`](./sharedlibrarycoreformatting-ColorCodeMapping) | [`ColorCodeMapping`](#colorcodemapping) | `get` | +| [`CommandPrefix`](./sharedlibrarycorercon-CommandPrefix) | [`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` | +| `short` | [`FloodProtectInterval`](#floodprotectinterval) | `get` | +| [`ParserRegex`](./sharedlibrarycoreinterfaces-ParserRegex) | [`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` | +| `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` | +| `IDictionary`<`string`, `Nullable`<`int`>> | [`OverrideCommandTimeouts`](#overridecommandtimeouts)
contains a setup of commands that have override timeouts | `get` | +| `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` | +| `bool` | [`WaitForResponse`](#waitforresponse)
indicates if the application should wait for response from server
when executing a command | `get` | + +## Details +### Properties +#### CommandPrefixes +```csharp +public CommandPrefix CommandPrefixes { get; } +``` +##### Summary +stores the command format for console commands + +#### Status +```csharp +public ParserRegex Status { get; } +``` +##### Summary +stores the regex info for parsing get status response + +#### MapStatus +```csharp +public ParserRegex MapStatus { get; } +``` +##### Summary +stores regex info for parsing the map line from rcon status response + +#### GametypeStatus +```csharp +public ParserRegex GametypeStatus { get; } +``` +##### Summary +stores regex info for parsing the gametype line from rcon status response + +#### HostnameStatus +```csharp +public ParserRegex HostnameStatus { get; } +``` +##### Summary +stores regex info for parsing hostname line from rcon status response + +#### MaxPlayersStatus +```csharp +public ParserRegex MaxPlayersStatus { get; } +``` +##### Summary +stores regex info for parsing max players line from rcon status response + +#### Dvar +```csharp +public ParserRegex Dvar { get; } +``` +##### Summary +stores the regex info for parsing get DVAR responses + +#### StatusHeader +```csharp +public ParserRegex StatusHeader { get; } +``` +##### Summary +stores the regex info for parsing the header of a status response + +#### ServerNotRunningResponse +```csharp +public string ServerNotRunningResponse { get; } +``` +##### Summary +Specifies the expected response message from rcon when the server is not running + +#### WaitForResponse +```csharp +public bool WaitForResponse { get; } +``` +##### Summary +indicates if the application should wait for response from server + when executing a command + +#### GuidNumberStyle +```csharp +public NumberStyles GuidNumberStyle { get; } +``` +##### Summary +indicates the format expected for parsed guids + +#### OverrideDvarNameMapping +```csharp +public IDictionary OverrideDvarNameMapping { get; } +``` +##### Summary +specifies simple mappings for dvar names in scenarios where the needed + information is not stored in a traditional dvar name + +#### DefaultDvarValues +```csharp +public IDictionary DefaultDvarValues { get; } +``` +##### Summary +specifies the default dvar values for games that don't support certain dvars + +#### OverrideCommandTimeouts +```csharp +public IDictionary> OverrideCommandTimeouts { get; } +``` +##### Summary +contains a setup of commands that have override timeouts + +#### NoticeMaximumLines +```csharp +public int NoticeMaximumLines { get; set; } +``` +##### Summary +specifies how many lines can be used for ingame notice + +#### NoticeMaxCharactersPerLine +```csharp +public int NoticeMaxCharactersPerLine { get; } +``` +##### Summary +specifies how many characters can be displayed per notice line + +#### NoticeLineSeparator +```csharp +public string NoticeLineSeparator { get; } +``` +##### Summary +specifies the characters used to split a line + +#### DefaultRConPort +```csharp +public Nullable DefaultRConPort { get; } +``` +##### Summary +Default port the game listens to RCon requests on + +#### DefaultInstallationDirectoryHint +```csharp +public string DefaultInstallationDirectoryHint { get; } +``` +##### Summary +Default Indicator of where the game is installed (ex file path or registry entry) + +#### ColorCodeMapping +```csharp +public ColorCodeMapping ColorCodeMapping { get; } +``` + +#### FloodProtectInterval +```csharp +public short FloodProtectInterval { get; } +``` + +#### ShouldRemoveDiacritics +```csharp +public bool ShouldRemoveDiacritics { get; } +``` +##### Summary +indicates if diacritics (accented characters) should be normalized + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfaces-IRegisterEvent.md b/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfaces-IRegisterEvent.md new file mode 100644 index 0000000..6155adc --- /dev/null +++ b/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfaces-IRegisterEvent.md @@ -0,0 +1,36 @@ +# IRegisterEvent `Public interface` + +## Description +interface defining the capabilities of a custom event registration + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph SharedLibraryCore.Interfaces + SharedLibraryCore.Interfaces.IRegisterEvent[[IRegisterEvent]] + class SharedLibraryCore.Interfaces.IRegisterEvent interfaceStyle; + end +``` + +## Members +### Properties +#### 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` | + +## Details +### Summary +interface defining the capabilities of a custom event registration + +### Properties +#### Events +```csharp +public IEnumerable<(string Item1, string Item2, Func Item3)> Events { get; } +``` +##### Summary +collection of custom event registrations (Subtype, trigger value, event generator) + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfaces-IRemoteAssemblyHandler.md b/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfaces-IRemoteAssemblyHandler.md new file mode 100644 index 0000000..c6fb61c --- /dev/null +++ b/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfaces-IRemoteAssemblyHandler.md @@ -0,0 +1,42 @@ +# IRemoteAssemblyHandler `Public interface` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph SharedLibraryCore.Interfaces + SharedLibraryCore.Interfaces.IRemoteAssemblyHandler[[IRemoteAssemblyHandler]] + class SharedLibraryCore.Interfaces.IRemoteAssemblyHandler interfaceStyle; + end +``` + +## Members +### Methods +#### Public methods +| Returns | Name | +| --- | --- | +| `IEnumerable`<`Assembly`> | [`DecryptAssemblies`](#decryptassemblies)(`string``[]` encryptedAssemblies) | +| `IEnumerable`<`string`> | [`DecryptScripts`](#decryptscripts)(`string``[]` encryptedScripts) | + +## Details +### Methods +#### DecryptAssemblies +```csharp +public IEnumerable DecryptAssemblies(string[] encryptedAssemblies) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `string``[]` | encryptedAssemblies | | + +#### DecryptScripts +```csharp +public IEnumerable DecryptScripts(string[] encryptedScripts) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `string``[]` | encryptedScripts | | + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfaces-IRemoteCommandService.md b/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfaces-IRemoteCommandService.md new file mode 100644 index 0000000..89f17ae --- /dev/null +++ b/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfaces-IRemoteCommandService.md @@ -0,0 +1,50 @@ +# IRemoteCommandService `Public interface` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph SharedLibraryCore.Interfaces + SharedLibraryCore.Interfaces.IRemoteCommandService[[IRemoteCommandService]] + class SharedLibraryCore.Interfaces.IRemoteCommandService interfaceStyle; + end +``` + +## Members +### Methods +#### 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) | + +## Details +### Methods +#### Execute +```csharp +public Task> Execute(int originId, Nullable targetId, string command, IEnumerable arguments, Server server) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `int` | originId | | +| `Nullable`<`int`> | targetId | | +| `string` | command | | +| `IEnumerable`<`string`> | arguments | | +| [`Server`](./sharedlibrarycore-Server) | server | | + +#### ExecuteWithResult +```csharp +public Task<(bool Item1, IEnumerable Item2)> ExecuteWithResult(int originId, Nullable targetId, string command, IEnumerable arguments, Server server) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `int` | originId | | +| `Nullable`<`int`> | targetId | | +| `string` | command | | +| `IEnumerable`<`string`> | arguments | | +| [`Server`](./sharedlibrarycore-Server) | server | | + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfaces-IResourceQueryHelperTT.md b/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfaces-IResourceQueryHelperTT.md new file mode 100644 index 0000000..bc33bce --- /dev/null +++ b/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfaces-IResourceQueryHelperTT.md @@ -0,0 +1,45 @@ +# IResourceQueryHelper< QueryType, ResultType> `Public interface` + +## Description +defines the capabilities of a resource queryier + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph SharedLibraryCore.Interfaces + SharedLibraryCore.Interfaces.IResourceQueryHelper_2[[IResourceQueryHelper< QueryType,ResultType >]] + class SharedLibraryCore.Interfaces.IResourceQueryHelper_2 interfaceStyle; + + end +``` + +## Members +### Methods +#### Public methods +| Returns | Name | +| --- | --- | +| `Task`<[`ResourceQueryHelperResult`](./sharedlibrarycorehelpers-ResourceQueryHelperResultT)<`ResultType`>> | [`QueryResource`](#queryresource)(`QueryType` query) | + +## Details +### Summary +defines the capabilities of a resource queryier + +### Generic types +| Type | Description | Constraints | +| --- | --- | --- | +| `QueryType` | Type of query | | +| `ResultType` | Type of result | | + +### Methods +#### QueryResource +```csharp +public Task> QueryResource(QueryType query) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `QueryType` | query | | + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfaces-IScriptCommandFactory.md b/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfaces-IScriptCommandFactory.md new file mode 100644 index 0000000..287116d --- /dev/null +++ b/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfaces-IScriptCommandFactory.md @@ -0,0 +1,45 @@ +# IScriptCommandFactory `Public interface` + +## Description +defines capabilities of script command factory + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph SharedLibraryCore.Interfaces + SharedLibraryCore.Interfaces.IScriptCommandFactory[[IScriptCommandFactory]] + class SharedLibraryCore.Interfaces.IScriptCommandFactory interfaceStyle; + end +``` + +## Members +### Methods +#### 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) | + +## Details +### Summary +defines capabilities of script command factory + +### Methods +#### CreateScriptCommand +```csharp +public IManagerCommand CreateScriptCommand(string name, string alias, string description, string permission, bool isTargetRequired, IEnumerable args, Func executeAction, IEnumerable supportedGames) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `string` | name | | +| `string` | alias | | +| `string` | description | | +| `string` | permission | | +| `bool` | isTargetRequired | | +| `IEnumerable`<[`CommandArgument`](./sharedlibrarycorecommands-CommandArgument)> | args | | +| `Func`<[`GameEvent`](./sharedlibrarycore-GameEvent), `Task`> | executeAction | | +| `IEnumerable`<`Game`> | supportedGames | | + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfaces-IScriptPluginFactory.md b/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfaces-IScriptPluginFactory.md new file mode 100644 index 0000000..ba9e9e4 --- /dev/null +++ b/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfaces-IScriptPluginFactory.md @@ -0,0 +1,33 @@ +# IScriptPluginFactory `Public interface` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph SharedLibraryCore.Interfaces + SharedLibraryCore.Interfaces.IScriptPluginFactory[[IScriptPluginFactory]] + class SharedLibraryCore.Interfaces.IScriptPluginFactory interfaceStyle; + end +``` + +## Members +### Methods +#### Public methods +| Returns | Name | +| --- | --- | +| `object` | [`CreateScriptPlugin`](#createscriptplugin)(`Type` type, `string` fileName) | + +## Details +### Methods +#### CreateScriptPlugin +```csharp +public object CreateScriptPlugin(Type type, string fileName) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `Type` | type | | +| `string` | fileName | | + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfaces-IScriptPluginServiceResolver.md b/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfaces-IScriptPluginServiceResolver.md new file mode 100644 index 0000000..2c9c494 --- /dev/null +++ b/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfaces-IScriptPluginServiceResolver.md @@ -0,0 +1,60 @@ +# IScriptPluginServiceResolver `Public interface` + +## Description +interface used to dynamically resolve services by string name + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph SharedLibraryCore.Interfaces + SharedLibraryCore.Interfaces.IScriptPluginServiceResolver[[IScriptPluginServiceResolver]] + class SharedLibraryCore.Interfaces.IScriptPluginServiceResolver interfaceStyle; + end +``` + +## Members +### Methods +#### Public methods +| Returns | Name | +| --- | --- | +| `object` | [`ResolveService`](#resolveservice-12)(`...`)
resolves a service with the given name | + +## Details +### Summary +interface used to dynamically resolve services by string name + +### Methods +#### ResolveService [1/2] +```csharp +public object ResolveService(string serviceName) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `string` | serviceName | class name of service | + +##### Summary +resolves a service with the given name + +##### Returns + + +#### ResolveService [2/2] +```csharp +public object ResolveService(string serviceName, string[] genericParameters) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `string` | serviceName | class name of service | +| `string``[]` | genericParameters | generic class names | + +##### Summary +resolves a service with the given name and generic params + +##### Returns + + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfaces-IScriptPluginTimerHelper.md b/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfaces-IScriptPluginTimerHelper.md new file mode 100644 index 0000000..ba2d107 --- /dev/null +++ b/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfaces-IScriptPluginTimerHelper.md @@ -0,0 +1,86 @@ +# IScriptPluginTimerHelper `Public interface` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph SharedLibraryCore.Interfaces + SharedLibraryCore.Interfaces.IScriptPluginTimerHelper[[IScriptPluginTimerHelper]] + class SharedLibraryCore.Interfaces.IScriptPluginTimerHelper interfaceStyle; + end +``` + +## Members +### Properties +#### Public properties +| Type | Name | Methods | +| --- | --- | --- | +| `bool` | [`IsRunning`](#isrunning) | `get` | + +### Methods +#### Public methods +| Returns | Name | +| --- | --- | +| `void` | [`OnTick`](#ontick)(`Delegate` action, `string` actionName) | +| `void` | [`SetDependency`](#setdependency)(`SemaphoreSlim` dependentSemaphore) | +| `void` | [`Start`](#start-13)(`...`) | +| `void` | [`Stop`](#stop)() | + +## Details +### Methods +#### Start [1/3] +```csharp +public void Start(int delay, int interval) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `int` | delay | | +| `int` | interval | | + +#### Start [2/3] +```csharp +public void Start(int interval) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `int` | interval | | + +#### Start [3/3] +```csharp +public void Start() +``` + +#### Stop +```csharp +public void Stop() +``` + +#### OnTick +```csharp +public void OnTick(Delegate action, string actionName) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `Delegate` | action | | +| `string` | actionName | | + +#### SetDependency +```csharp +public void SetDependency(SemaphoreSlim dependentSemaphore) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `SemaphoreSlim` | dependentSemaphore | | + +### Properties +#### IsRunning +```csharp +public bool IsRunning { get; } +``` + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfaces-IServerDataCollector.md b/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfaces-IServerDataCollector.md new file mode 100644 index 0000000..a29f340 --- /dev/null +++ b/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfaces-IServerDataCollector.md @@ -0,0 +1,33 @@ +# IServerDataCollector `Public interface` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph SharedLibraryCore.Interfaces + SharedLibraryCore.Interfaces.IServerDataCollector[[IServerDataCollector]] + class SharedLibraryCore.Interfaces.IServerDataCollector interfaceStyle; + end +``` + +## Members +### Methods +#### Public methods +| Returns | Name | +| --- | --- | +| `Task` | [`BeginCollectionAsync`](#begincollectionasync)(`Nullable`<`TimeSpan`> period, `CancellationToken` cancellationToken) | + +## Details +### Methods +#### BeginCollectionAsync +```csharp +public Task BeginCollectionAsync(Nullable period, CancellationToken cancellationToken) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `Nullable`<`TimeSpan`> | period | | +| `CancellationToken` | cancellationToken | | + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfaces-IServerDataViewer.md b/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfaces-IServerDataViewer.md new file mode 100644 index 0000000..131a403 --- /dev/null +++ b/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfaces-IServerDataViewer.md @@ -0,0 +1,75 @@ +# IServerDataViewer `Public interface` + +## Description +Exposes methods to get analytical data about server(s) + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph SharedLibraryCore.Interfaces + SharedLibraryCore.Interfaces.IServerDataViewer[[IServerDataViewer]] + class SharedLibraryCore.Interfaces.IServerDataViewer interfaceStyle; + end +``` + +## Members +### Methods +#### Public methods +| 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`<(`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) | + +## Details +### Summary +Exposes methods to get analytical data about server(s) + +### Methods +#### MaxConcurrentClientsAsync +```csharp +public Task<(Nullable Item1, Nullable Item2)> MaxConcurrentClientsAsync(Nullable serverId, Nullable gameCode, Nullable overPeriod, CancellationToken token) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `Nullable`<`long`> | serverId | | +| `Nullable`<`Game`> | gameCode | | +| `Nullable`<`TimeSpan`> | overPeriod | | +| `CancellationToken` | token | | + +#### ClientCountsAsync +```csharp +public Task<(int Item1, int Item2)> ClientCountsAsync(Nullable overPeriod, Nullable gameCode, CancellationToken token) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `Nullable`<`TimeSpan`> | overPeriod | | +| `Nullable`<`Game`> | gameCode | | +| `CancellationToken` | token | | + +#### ClientHistoryAsync +```csharp +public Task> ClientHistoryAsync(Nullable overPeriod, CancellationToken token) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `Nullable`<`TimeSpan`> | overPeriod | | +| `CancellationToken` | token | | + +#### RankedClientsCountAsync +```csharp +public Task RankedClientsCountAsync(Nullable serverId, CancellationToken token) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `Nullable`<`long`> | serverId | | +| `CancellationToken` | token | | + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfaces-IStatusResponse.md b/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfaces-IStatusResponse.md new file mode 100644 index 0000000..da4477b --- /dev/null +++ b/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfaces-IStatusResponse.md @@ -0,0 +1,68 @@ +# IStatusResponse `Public interface` + +## Description +describes the collection of data returned from a status query + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph SharedLibraryCore.Interfaces + SharedLibraryCore.Interfaces.IStatusResponse[[IStatusResponse]] + class SharedLibraryCore.Interfaces.IStatusResponse interfaceStyle; + end +``` + +## Members +### Properties +#### Public properties +| Type | Name | Methods | +| --- | --- | --- | +| [`EFClient`](./sharedlibrarycoredatabasemodels-EFClient)`[]` | [`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` | +| `Nullable`<`int`> | [`MaxClients`](#maxclients)
max number of players | `get` | + +## Details +### Summary +describes the collection of data returned from a status query + +### Properties +#### Map +```csharp +public string Map { get; } +``` +##### Summary +name of the map + +#### GameType +```csharp +public string GameType { get; } +``` +##### Summary +gametype/mode + +#### Hostname +```csharp +public string Hostname { get; } +``` +##### Summary +server name + +#### MaxClients +```csharp +public Nullable MaxClients { get; } +``` +##### Summary +max number of players + +#### Clients +```csharp +public EFClient Clients { get; } +``` +##### Summary +active clients + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfaces-ITokenAuthentication.md b/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfaces-ITokenAuthentication.md new file mode 100644 index 0000000..b212494 --- /dev/null +++ b/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfaces-ITokenAuthentication.md @@ -0,0 +1,54 @@ +# ITokenAuthentication `Public interface` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph SharedLibraryCore.Interfaces + SharedLibraryCore.Interfaces.ITokenAuthentication[[ITokenAuthentication]] + class SharedLibraryCore.Interfaces.ITokenAuthentication interfaceStyle; + end +``` + +## Members +### Methods +#### 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 | + +## Details +### Methods +#### GenerateNextToken +```csharp +public TokenState GenerateNextToken(ITokenIdentifier authInfo) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| [`ITokenIdentifier`](./sharedlibrarycoreinterfaces-ITokenIdentifier) | authInfo | auth information for next token generation | + +##### Summary +generates and returns a token for the given network id + +##### Returns +4 character string token + +#### AuthorizeToken +```csharp +public bool AuthorizeToken(ITokenIdentifier authInfo) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| [`ITokenIdentifier`](./sharedlibrarycoreinterfaces-ITokenIdentifier) | authInfo | auth information | + +##### Summary +authorizes given token + +##### Returns +true if token authorized successfully, false otherwise + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfaces-ITokenIdentifier.md b/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfaces-ITokenIdentifier.md new file mode 100644 index 0000000..4108a67 --- /dev/null +++ b/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfaces-ITokenIdentifier.md @@ -0,0 +1,34 @@ +# ITokenIdentifier `Public interface` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph SharedLibraryCore.Interfaces + SharedLibraryCore.Interfaces.ITokenIdentifier[[ITokenIdentifier]] + class SharedLibraryCore.Interfaces.ITokenIdentifier interfaceStyle; + end +``` + +## Members +### Properties +#### Public properties +| Type | Name | Methods | +| --- | --- | --- | +| `int` | [`ClientId`](#clientid) | `get` | +| `string` | [`Token`](#token) | `get` | + +## Details +### Properties +#### ClientId +```csharp +public int ClientId { get; } +``` + +#### Token +```csharp +public string Token { get; } +``` + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfaces-ITranslationLookup.md b/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfaces-ITranslationLookup.md new file mode 100644 index 0000000..f34ad17 --- /dev/null +++ b/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfaces-ITranslationLookup.md @@ -0,0 +1,34 @@ +# ITranslationLookup `Public interface` + +## Description +Defines the translation lookup capabilities for DI + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph SharedLibraryCore.Interfaces + SharedLibraryCore.Interfaces.ITranslationLookup[[ITranslationLookup]] + class SharedLibraryCore.Interfaces.ITranslationLookup interfaceStyle; + end +``` + +## Members +### Properties +#### Public properties +| Type | Name | Methods | +| --- | --- | --- | +| `string` | [`Item`](#item) | `get` | + +## Details +### Summary +Defines the translation lookup capabilities for DI + +### Properties +#### Item +```csharp +public string Item { get; } +``` + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfaces-InteractionType.md b/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfaces-InteractionType.md new file mode 100644 index 0000000..5aee93f --- /dev/null +++ b/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfaces-InteractionType.md @@ -0,0 +1,24 @@ +# InteractionType `Public enum` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph SharedLibraryCore.Interfaces + SharedLibraryCore.Interfaces.InteractionType[[InteractionType]] + end +``` + +## Details +### Fields +#### ActionButton + + +#### RawContent + + +#### TemplateContent + + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfaces-MetaType.md b/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfaces-MetaType.md new file mode 100644 index 0000000..6f2cb04 --- /dev/null +++ b/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfaces-MetaType.md @@ -0,0 +1,45 @@ +# MetaType `Public enum` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph SharedLibraryCore.Interfaces + SharedLibraryCore.Interfaces.MetaType[[MetaType]] + end +``` + +## Details +### Fields +#### All + + +#### Other + + +#### Information + + +#### AliasUpdate + + +#### ChatMessage + + +#### Penalized + + +#### ReceivedPenalty + + +#### QuickMessage + + +#### ConnectionHistory + + +#### PermissionLevel + + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfaces-ParserRegex.md b/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfaces-ParserRegex.md new file mode 100644 index 0000000..dd960b7 --- /dev/null +++ b/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfaces-ParserRegex.md @@ -0,0 +1,79 @@ +# ParserRegex `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph SharedLibraryCore.Interfaces + SharedLibraryCore.Interfaces.ParserRegex[[ParserRegex]] + end +``` + +## Members +### Properties +#### Public properties +| Type | Name | Methods | +| --- | --- | --- | +| `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` | + +### Methods +#### Public methods +| Returns | Name | +| --- | --- | +| `void` | [`AddMapping`](#addmapping)(`object` mapKey, `object` mapValue)
helper method to enable script parsers to app regex mapping
the first parameter specifies the group type contained in the regex pattern
the second parameter specifies the group index to retrieve in the matched regex pattern | + +## Details +### Nested types +#### Enums + - `GroupType` + +### Constructors +#### ParserRegex +```csharp +public ParserRegex(IParserPatternMatcher pattern) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| [`IParserPatternMatcher`](./sharedlibrarycoreinterfaces-IParserPatternMatcher) | pattern | | + +### Methods +#### AddMapping +```csharp +public void AddMapping(object mapKey, object mapValue) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `object` | mapKey | group type | +| `object` | mapValue | group index | + +##### Summary +helper method to enable script parsers to app regex mapping + the first parameter specifies the group type contained in the regex pattern + the second parameter specifies the group index to retrieve in the matched regex pattern + +### Properties +#### PatternMatcher +```csharp +public IParserPatternMatcher PatternMatcher { get; } +``` + +#### Pattern +```csharp +public string Pattern { get; set; } +``` +##### Summary +stores the regular expression groups that will be mapped to group types + +#### GroupMapping +```csharp +public Dictionary GroupMapping { get; } +``` +##### Summary +stores the mapping from group type to group index in the regular expression + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfacesevents-IGameEventSubscriptions.md b/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfacesevents-IGameEventSubscriptions.md new file mode 100644 index 0000000..e15fe94 --- /dev/null +++ b/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfacesevents-IGameEventSubscriptions.md @@ -0,0 +1,110 @@ +# IGameEventSubscriptions `Public interface` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph SharedLibraryCore.Interfaces.Events + SharedLibraryCore.Interfaces.Events.IGameEventSubscriptions[[IGameEventSubscriptions]] + class SharedLibraryCore.Interfaces.Events.IGameEventSubscriptions interfaceStyle; + end +``` + +## Members +### Methods +#### Public Static methods +| Returns | Name | +| --- | --- | +| `void` | [`ClearEventInvocations`](#cleareventinvocations)() | +| `Task` | [`InvokeEventAsync`](#invokeeventasync)([`CoreEvent`](./sharedlibrarycoreevents-CoreEvent) coreEvent, `CancellationToken` token) | + +## Details +### Methods +#### InvokeEventAsync +```csharp +public static Task InvokeEventAsync(CoreEvent coreEvent, CancellationToken token) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| [`CoreEvent`](./sharedlibrarycoreevents-CoreEvent) | coreEvent | | +| `CancellationToken` | token | | + +#### ClearEventInvocations +```csharp +public static void ClearEventInvocations() +``` + +### Events +#### MatchStarted +```csharp +public static event Func MatchStarted +``` +##### Summary +Raised when game log prints that match has started InitGame [MatchStartEvent](./sharedlibrarycoreeventsgame-MatchStartEvent) + +#### MatchEnded +```csharp +public static event Func MatchEnded +``` +##### Summary +Raised when game log prints that match has ended ShutdownGame: [MatchEndEvent](./sharedlibrarycoreeventsgame-MatchEndEvent) + +#### 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) + +#### 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) + +#### 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) + +#### 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) + +#### 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) + +#### 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) + +#### 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) + +#### 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) + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfacesevents-IGameServerEventSubscriptions.md b/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfacesevents-IGameServerEventSubscriptions.md new file mode 100644 index 0000000..4e54b56 --- /dev/null +++ b/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfacesevents-IGameServerEventSubscriptions.md @@ -0,0 +1,117 @@ +# IGameServerEventSubscriptions `Public interface` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph SharedLibraryCore.Interfaces.Events + SharedLibraryCore.Interfaces.Events.IGameServerEventSubscriptions[[IGameServerEventSubscriptions]] + class SharedLibraryCore.Interfaces.Events.IGameServerEventSubscriptions interfaceStyle; + end +``` + +## Members +### Methods +#### Public Static methods +| Returns | Name | +| --- | --- | +| `void` | [`ClearEventInvocations`](#cleareventinvocations)() | +| `Task` | [`InvokeEventAsync`](#invokeeventasync)([`CoreEvent`](./sharedlibrarycoreevents-CoreEvent) coreEvent, `CancellationToken` token) | + +## Details +### Methods +#### InvokeEventAsync +```csharp +public static Task InvokeEventAsync(CoreEvent coreEvent, CancellationToken token) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| [`CoreEvent`](./sharedlibrarycoreevents-CoreEvent) | coreEvent | | +| `CancellationToken` | token | | + +#### ClearEventInvocations +```csharp +public static void ClearEventInvocations() +``` + +### Events +#### MonitoringStarted +```csharp +public static event Func MonitoringStarted +``` +##### Summary +Raised when IW4MAdmin starts monitoring a game server [MonitorStartEvent](./sharedlibrarycoreeventsserver-MonitorStartEvent) + +#### MonitoringStopped +```csharp +public static event Func MonitoringStopped +``` +##### Summary +Raised when IW4MAdmin stops monitoring a game server [MonitorStopEvent](./sharedlibrarycoreeventsserver-MonitorStopEvent) + +#### ConnectionInterrupted +```csharp +public static event Func ConnectionInterrupted +``` +##### Summary +Raised when communication was interrupted with a game server [ConnectionInterruptEvent](./sharedlibrarycoreeventsserver-ConnectionInterruptEvent) + +#### ConnectionRestored +```csharp +public static event Func ConnectionRestored +``` +##### Summary +Raised when communication was resumed with a game server [ConnectionRestoreEvent](./sharedlibrarycoreeventsserver-ConnectionRestoreEvent) + +#### ClientDataUpdated +```csharp +public static event Func ClientDataUpdated +``` +##### Summary +Raised when updated client data was received from a game server [ClientDataUpdateEvent](./sharedlibrarycoreeventsserver-ClientDataUpdateEvent) + +#### ServerCommandExecuteRequested +```csharp +public static event Func ServerCommandExecuteRequested +``` +##### Summary +Raised when a command is requested to be executed on a game server + +#### ServerCommandExecuted +```csharp +public static event Func ServerCommandExecuted +``` +##### Summary +Raised when a command was executed on a game server [ServerCommandExecuteEvent](./sharedlibrarycoreeventsserver-ServerCommandExecuteEvent) + +#### ServerValueRequested +```csharp +public static event Func ServerValueRequested +``` +##### Summary +Raised when a server value is requested for a game server [ServerValueRequestEvent](./sharedlibrarycoreeventsserver-ServerValueRequestEvent) + +#### 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) + +#### 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) + +#### 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) + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfacesevents-IManagementEventSubscriptions.md b/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfacesevents-IManagementEventSubscriptions.md new file mode 100644 index 0000000..901e532 --- /dev/null +++ b/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfacesevents-IManagementEventSubscriptions.md @@ -0,0 +1,147 @@ +# IManagementEventSubscriptions `Public interface` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph SharedLibraryCore.Interfaces.Events + SharedLibraryCore.Interfaces.Events.IManagementEventSubscriptions[[IManagementEventSubscriptions]] + class SharedLibraryCore.Interfaces.Events.IManagementEventSubscriptions interfaceStyle; + end +``` + +## Members +### Methods +#### Public Static methods +| 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) | + +## Details +### Methods +#### InvokeEventAsync +```csharp +public static Task InvokeEventAsync(CoreEvent coreEvent, CancellationToken token) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| [`CoreEvent`](./sharedlibrarycoreevents-CoreEvent) | coreEvent | | +| `CancellationToken` | token | | + +#### InvokeLoadAsync +```csharp +public static Task InvokeLoadAsync(IManager manager, CancellationToken token) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| [`IManager`](./sharedlibrarycoreinterfaces-IManager) | manager | | +| `CancellationToken` | token | | + +#### InvokeUnloadAsync +```csharp +public static Task InvokeUnloadAsync(IManager manager, CancellationToken token) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| [`IManager`](./sharedlibrarycoreinterfaces-IManager) | manager | | +| `CancellationToken` | token | | + +#### ClearEventInvocations +```csharp +public static void ClearEventInvocations() +``` + +### Events +#### Load +```csharp +public static event Func Load +``` +##### Summary +Raised when [IManager](./sharedlibrarycoreinterfaces-IManager) is loading + +#### Unload +```csharp +public static event Func Unload +``` +##### Summary +Raised when [IManager](./sharedlibrarycoreinterfaces-IManager) is restarting + +#### ClientStateInitialized +```csharp +public static event Func ClientStateInitialized +``` +##### 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) + +#### ClientStateAuthorized +```csharp +public static event Func ClientStateAuthorized +``` +##### Summary +Raised when client enters an authorized state (valid data and no bans) [ClientStateAuthorizeEvent](./sharedlibrarycoreeventsmanagement-ClientStateAuthorizeEvent) + +#### 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) + +#### ClientPenaltyAdministered +```csharp +public static event Func ClientPenaltyAdministered +``` +##### Summary +Raised when a client receives a penalty [ClientPenaltyEvent](./sharedlibrarycoreeventsmanagement-ClientPenaltyEvent) + +#### ClientPenaltyRevoked +```csharp +public static event Func ClientPenaltyRevoked +``` +##### Summary +Raised when a client penalty is revoked (eg unflag/unban) [ClientPenaltyRevokeEvent](./sharedlibrarycoreeventsmanagement-ClientPenaltyRevokeEvent) + +#### ClientCommandExecuted +```csharp +public static event Func ClientCommandExecuted +``` +##### Summary +Raised when a client command is executed (after completion of the command) [ClientExecuteCommandEvent](./sharedlibrarycoreeventsmanagement-ClientExecuteCommandEvent) + +#### ClientPermissionChanged +```csharp +public static event Func ClientPermissionChanged +``` +##### Summary +Raised when a client's permission level changes [ClientPermissionChangeEvent](./sharedlibrarycoreeventsmanagement-ClientPermissionChangeEvent) + +#### ClientLoggedIn +```csharp +public static event Func ClientLoggedIn +``` +##### Summary +Raised when a client logs in to the webfront or ingame [LoginEvent](./sharedlibrarycoreeventsmanagement-LoginEvent) + +#### ClientLoggedOut +```csharp +public static event Func ClientLoggedOut +``` +##### Summary +Raised when a client logs out of the webfront [LogoutEvent](./sharedlibrarycoreeventsmanagement-LogoutEvent) + +#### ClientPersistentIdReceived +```csharp +public static event Func ClientPersistentIdReceived +``` +##### Summary +Raised when a client's persistent id (stats file marker) is received [ClientPersistentIdReceiveEvent](./sharedlibrarycoreeventsmanagement-ClientPersistentIdReceiveEvent) + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfacesparserregex-GroupType.md b/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfacesparserregex-GroupType.md new file mode 100644 index 0000000..247369b --- /dev/null +++ b/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreinterfacesparserregex-GroupType.md @@ -0,0 +1,113 @@ +# GroupType `Public enum` + +## Description +represents the logical mapping of information provided by + game logs, get status, and get dvar information + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph SharedLibraryCore.Interfaces.ParserRegex + SharedLibraryCore.Interfaces.ParserRegex.GroupType[[GroupType]] + end +``` + +## Details +### Summary +represents the logical mapping of information provided by + game logs, get status, and get dvar information + +### Fields +#### EventType + + +#### OriginNetworkId + + +#### TargetNetworkId + + +#### OriginClientNumber + + +#### TargetClientNumber + + +#### OriginName + + +#### TargetName + + +#### OriginTeam + + +#### TargetTeam + + +#### Weapon + + +#### Damage + + +#### MeansOfDeath + + +#### HitLocation + + +#### Message + + +#### RConClientNumber + + +#### RConScore + + +#### RConPing + + +#### RConNetworkId + + +#### RConName + + +#### RConIpAddress + + +#### RConDvarName + + +#### RConDvarValue + + +#### RConDvarDefaultValue + + +#### RConDvarLatchedValue + + +#### RConDvarDomain + + +#### RConStatusMap + + +#### RConStatusGametype + + +#### RConStatusHostname + + +#### RConStatusMaxPlayers + + +#### AdditionalGroup + + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycorelocalization-ClientPermission.md b/CodeDocumentation/SharedLibraryCore/sharedlibrarycorelocalization-ClientPermission.md new file mode 100644 index 0000000..22aafbc --- /dev/null +++ b/CodeDocumentation/SharedLibraryCore/sharedlibrarycorelocalization-ClientPermission.md @@ -0,0 +1,39 @@ +# ClientPermission `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph SharedLibraryCore.Localization + SharedLibraryCore.Localization.ClientPermission[[ClientPermission]] + end +``` + +## Members +### Properties +#### Public properties +| Type | Name | Methods | +| --- | --- | --- | +| `Permission` | [`Level`](#level) | `get, set` | +| `string` | [`Name`](#name) | `get, set` | + +## Details +### Constructors +#### ClientPermission +```csharp +public ClientPermission() +``` + +### Properties +#### Level +```csharp +public Permission Level { get; set; } +``` + +#### Name +```csharp +public string Name { get; set; } +``` + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycorelocalization-Layout.md b/CodeDocumentation/SharedLibraryCore/sharedlibrarycorelocalization-Layout.md new file mode 100644 index 0000000..cacaf29 --- /dev/null +++ b/CodeDocumentation/SharedLibraryCore/sharedlibrarycorelocalization-Layout.md @@ -0,0 +1,49 @@ +# Layout `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph SharedLibraryCore.Localization + SharedLibraryCore.Localization.Layout[[Layout]] + end +``` + +## Members +### Properties +#### Public properties +| Type | Name | Methods | +| --- | --- | --- | +| `CultureInfo` | [`Culture`](#culture) | `get, private set` | +| [`TranslationLookup`](./sharedlibrarycorelocalization-TranslationLookup) | [`LocalizationIndex`](#localizationindex) | `get, set` | +| `string` | [`LocalizationName`](#localizationname) | `get, set` | + +## Details +### Constructors +#### Layout +```csharp +public Layout(Dictionary set) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `Dictionary`<`string`, `string`> | set | | + +### Properties +#### LocalizationName +```csharp +public string LocalizationName { get; set; } +``` + +#### LocalizationIndex +```csharp +public TranslationLookup LocalizationIndex { get; set; } +``` + +#### Culture +```csharp +public CultureInfo Culture { get; private set; } +``` + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycorelocalization-TranslationLookup.md b/CodeDocumentation/SharedLibraryCore/sharedlibrarycorelocalization-TranslationLookup.md new file mode 100644 index 0000000..f3f051d --- /dev/null +++ b/CodeDocumentation/SharedLibraryCore/sharedlibrarycorelocalization-TranslationLookup.md @@ -0,0 +1,49 @@ +# TranslationLookup `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph SharedLibraryCore.Localization + SharedLibraryCore.Localization.TranslationLookup[[TranslationLookup]] + end + subgraph SharedLibraryCore.Interfaces + SharedLibraryCore.Interfaces.ITranslationLookup[[ITranslationLookup]] + class SharedLibraryCore.Interfaces.ITranslationLookup interfaceStyle; + end +SharedLibraryCore.Interfaces.ITranslationLookup --> SharedLibraryCore.Localization.TranslationLookup +``` + +## Members +### Properties +#### Public properties +| Type | Name | Methods | +| --- | --- | --- | +| `string` | [`Item`](#item) | `get` | +| `Dictionary`<`string`, `string`> | [`Set`](#set) | `get, set` | + +## Details +### Inheritance + - [ +`ITranslationLookup` +](./sharedlibrarycoreinterfaces-ITranslationLookup) + +### Constructors +#### TranslationLookup +```csharp +public TranslationLookup() +``` + +### Properties +#### Set +```csharp +public Dictionary Set { get; set; } +``` + +#### Item +```csharp +public virtual string Item { get; } +``` + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycorequeryhelper-ClientPaginationRequest.md b/CodeDocumentation/SharedLibraryCore/sharedlibrarycorequeryhelper-ClientPaginationRequest.md new file mode 100644 index 0000000..141dbc5 --- /dev/null +++ b/CodeDocumentation/SharedLibraryCore/sharedlibrarycorequeryhelper-ClientPaginationRequest.md @@ -0,0 +1,42 @@ +# ClientPaginationRequest `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph SharedLibraryCore.QueryHelper + SharedLibraryCore.QueryHelper.ClientPaginationRequest[[ClientPaginationRequest]] + end + subgraph SharedLibraryCore.Dtos + SharedLibraryCore.Dtos.PaginationRequest[[PaginationRequest]] + end +SharedLibraryCore.Dtos.PaginationRequest --> SharedLibraryCore.QueryHelper.ClientPaginationRequest +``` + +## Members +### Properties +#### Public properties +| Type | Name | Methods | +| --- | --- | --- | +| `int` | [`ClientId`](#clientid) | `get, set` | + +## Details +### Inheritance + - [ +`PaginationRequest` +](./sharedlibrarycoredtos-PaginationRequest) + +### Constructors +#### ClientPaginationRequest +```csharp +public ClientPaginationRequest() +``` + +### Properties +#### ClientId +```csharp +public int ClientId { get; set; } +``` + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycorercon-CommandPrefix.md b/CodeDocumentation/SharedLibraryCore/sharedlibrarycorercon-CommandPrefix.md new file mode 100644 index 0000000..3fa289b --- /dev/null +++ b/CodeDocumentation/SharedLibraryCore/sharedlibrarycorercon-CommandPrefix.md @@ -0,0 +1,111 @@ +# CommandPrefix `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph SharedLibraryCore.RCon + SharedLibraryCore.RCon.CommandPrefix[[CommandPrefix]] + end +``` + +## Members +### Properties +#### Public properties +| Type | Name | Methods | +| --- | --- | --- | +| `string` | [`Ban`](#ban) | `get, set` | +| `string` | [`Kick`](#kick) | `get, set` | +| `string` | [`RConCommand`](#rconcommand) | `get, set` | +| `string` | [`RConGetDvar`](#rcongetdvar) | `get, set` | +| `string` | [`RConGetInfo`](#rcongetinfo) | `get, set` | +| `string` | [`RConGetStatus`](#rcongetstatus) | `get, set` | +| `string` | [`RConResponse`](#rconresponse) | `get, set` | +| `string` | [`RConSetDvar`](#rconsetdvar) | `get, set` | +| `string` | [`RconGetInfoResponseHeader`](#rcongetinforesponseheader) | `get, set` | +| `string` | [`Say`](#say) | `get, set` | +| `string` | [`Set`](#set) | `get, set` | +| `string` | [`Tell`](#tell) | `get, set` | +| `string` | [`TempBan`](#tempban) | `get, set` | +| `string` | [`Unban`](#unban) | `get, set` | + +## Details +### Constructors +#### CommandPrefix +```csharp +public CommandPrefix() +``` + +### Properties +#### Tell +```csharp +public string Tell { get; set; } +``` + +#### Say +```csharp +public string Say { get; set; } +``` + +#### Set +```csharp +public string Set { get; set; } +``` + +#### Kick +```csharp +public string Kick { get; set; } +``` + +#### Ban +```csharp +public string Ban { get; set; } +``` + +#### Unban +```csharp +public string Unban { get; set; } +``` + +#### TempBan +```csharp +public string TempBan { get; set; } +``` + +#### RConCommand +```csharp +public string RConCommand { get; set; } +``` + +#### RConGetDvar +```csharp +public string RConGetDvar { get; set; } +``` + +#### RConSetDvar +```csharp +public string RConSetDvar { get; set; } +``` + +#### RConGetStatus +```csharp +public string RConGetStatus { get; set; } +``` + +#### RConGetInfo +```csharp +public string RConGetInfo { get; set; } +``` + +#### RConResponse +```csharp +public string RConResponse { get; set; } +``` + +#### RconGetInfoResponseHeader +```csharp +public string RconGetInfoResponseHeader { get; set; } +``` + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycorercon-StaticHelpers.md b/CodeDocumentation/SharedLibraryCore/sharedlibrarycorercon-StaticHelpers.md new file mode 100644 index 0000000..a2f8ce4 --- /dev/null +++ b/CodeDocumentation/SharedLibraryCore/sharedlibrarycorercon-StaticHelpers.md @@ -0,0 +1,38 @@ +# StaticHelpers `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph SharedLibraryCore.RCon + SharedLibraryCore.RCon.StaticHelpers[[StaticHelpers]] + end +``` + +## Members +### Methods +#### Public Static methods +| Returns | Name | +| --- | --- | +| `TimeSpan` | [`SocketTimeout`](#sockettimeout)(`int` retryAttempt)
timeout in seconds to wait for a socket send or receive before giving up | + +## Details +### Nested types +#### Enums + - `QueryType` + +### Methods +#### SocketTimeout +```csharp +public static TimeSpan SocketTimeout(int retryAttempt) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `int` | retryAttempt | | + +##### Summary +timeout in seconds to wait for a socket send or receive before giving up + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycorerconstatichelpers-QueryType.md b/CodeDocumentation/SharedLibraryCore/sharedlibrarycorerconstatichelpers-QueryType.md new file mode 100644 index 0000000..e739d0d --- /dev/null +++ b/CodeDocumentation/SharedLibraryCore/sharedlibrarycorerconstatichelpers-QueryType.md @@ -0,0 +1,52 @@ +# QueryType `Public enum` + +## Description +defines the type of RCon query sent to a server + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph SharedLibraryCore.RCon.StaticHelpers + SharedLibraryCore.RCon.StaticHelpers.QueryType[[QueryType]] + end +``` + +## Details +### Summary +defines the type of RCon query sent to a server + +### Fields +#### GET_STATUS +##### Summary +retrieve the status of a server + does not require RCon password + +#### GET_INFO +##### Summary +retrieve the information of a server + server responds with key/value pairs + RCon password is required + +#### GET_DVAR +##### Summary +retrieve the value of a DVAR + RCon password is required + +#### SET_DVAR +##### Summary +set the value of a DVAR + RCon password is required + +#### COMMAND +##### Summary +execute a command + RCon password is required + +#### COMMAND_STATUS +##### Summary +get the full server command information + RCon password is required + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycorerepositories-AuditInformationRepository.md b/CodeDocumentation/SharedLibraryCore/sharedlibrarycorerepositories-AuditInformationRepository.md new file mode 100644 index 0000000..445447f --- /dev/null +++ b/CodeDocumentation/SharedLibraryCore/sharedlibrarycorerepositories-AuditInformationRepository.md @@ -0,0 +1,63 @@ +# AuditInformationRepository `Public class` + +## Description +implementation if IAuditInformationRepository + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph SharedLibraryCore.Repositories + SharedLibraryCore.Repositories.AuditInformationRepository[[AuditInformationRepository]] + end + subgraph SharedLibraryCore.Interfaces + SharedLibraryCore.Interfaces.IAuditInformationRepository[[IAuditInformationRepository]] + class SharedLibraryCore.Interfaces.IAuditInformationRepository interfaceStyle; + end +SharedLibraryCore.Interfaces.IAuditInformationRepository --> SharedLibraryCore.Repositories.AuditInformationRepository +``` + +## Members +### Methods +#### 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 | + +## Details +### Summary +implementation if IAuditInformationRepository + +### Inheritance + - [ +`IAuditInformationRepository` +](./sharedlibrarycoreinterfaces-IAuditInformationRepository) + +### Constructors +#### AuditInformationRepository +```csharp +public AuditInformationRepository(IDatabaseContextFactory contextFactory) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `IDatabaseContextFactory` | contextFactory | | + +### Methods +#### ListAuditInformation +```csharp +public virtual async Task> ListAuditInformation(PaginationRequest paginationInfo) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| [`PaginationRequest`](./sharedlibrarycoredtos-PaginationRequest) | paginationInfo | pagination info | + +##### Summary +retrieves a list of audit information for given pagination params + +##### Returns + + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreserver-Game.md b/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreserver-Game.md new file mode 100644 index 0000000..63d9e00 --- /dev/null +++ b/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreserver-Game.md @@ -0,0 +1,54 @@ +# Game `Public enum` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph SharedLibraryCore.Server + SharedLibraryCore.Server.Game[[Game]] + end +``` + +## Details +### Fields +#### COD + + +#### UKN + + +#### IW3 + + +#### IW4 + + +#### IW5 + + +#### IW6 + + +#### T4 + + +#### T5 + + +#### T6 + + +#### T7 + + +#### SHG1 + + +#### CSGO + + +#### H1 + + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreservices-ChangeHistoryService.md b/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreservices-ChangeHistoryService.md new file mode 100644 index 0000000..c68ec3f --- /dev/null +++ b/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreservices-ChangeHistoryService.md @@ -0,0 +1,42 @@ +# ChangeHistoryService `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph SharedLibraryCore.Services + SharedLibraryCore.Services.ChangeHistoryService[[ChangeHistoryService]] + end +``` + +## Members +### Methods +#### Public methods +| Returns | Name | +| --- | --- | +| `Task` | [`Add`](#add)([`GameEvent`](./sharedlibrarycore-GameEvent) e) | + +## Details +### Constructors +#### ChangeHistoryService +```csharp +public ChangeHistoryService(ILogger logger, IDatabaseContextFactory contextFactory) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `ILogger`<[`ChangeHistoryService`](sharedlibrarycoreservices-ChangeHistoryService)> | logger | | +| `IDatabaseContextFactory` | contextFactory | | + +### Methods +#### Add +```csharp +public async Task Add(GameEvent e) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| [`GameEvent`](./sharedlibrarycore-GameEvent) | e | | + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreservices-ClientService.md b/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreservices-ClientService.md new file mode 100644 index 0000000..752c1d8 --- /dev/null +++ b/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreservices-ClientService.md @@ -0,0 +1,296 @@ +# ClientService `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph SharedLibraryCore.Services + SharedLibraryCore.Services.ClientService[[ClientService]] + end + subgraph SharedLibraryCore.Interfaces + SharedLibraryCore.Interfaces.IEntityService_1[[IEntityService< T >]] + class SharedLibraryCore.Interfaces.IEntityService_1 interfaceStyle; + + SharedLibraryCore.Interfaces.IResourceQueryHelper_2[[IResourceQueryHelper< QueryType,ResultType >]] + class SharedLibraryCore.Interfaces.IResourceQueryHelper_2 interfaceStyle; + + end +SharedLibraryCore.Interfaces.IEntityService_1 --> SharedLibraryCore.Services.ClientService +SharedLibraryCore.Interfaces.IResourceQueryHelper_2 --> SharedLibraryCore.Services.ClientService +``` + +## Members +### Methods +#### Public methods +| 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`<`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`<`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`<`int`> | [`GetTotalClientsAsync`](#gettotalclientsasync)() | +| `Task`<[`EFClient`](./sharedlibrarycoredatabasemodels-EFClient)> | [`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` | [`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) | + +## Details +### Inheritance + - [`IEntityService`](./sharedlibrarycoreinterfaces-IEntityServiceT)<[`EFClient`](./sharedlibrarycoredatabasemodels-EFClient)> + - [`IResourceQueryHelper`](./sharedlibrarycoreinterfaces-IResourceQueryHelperTT)<[`FindClientRequest`](./sharedlibrarycoredtos-FindClientRequest), [`FindClientResult`](./sharedlibrarycoredtos-FindClientResult)> + +### Constructors +#### ClientService +```csharp +public ClientService(ILogger logger, IDatabaseContextFactory databaseContextFactory, ApplicationConfiguration appConfig, IGeoLocationService geoLocationService) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `ILogger`<[`ClientService`](sharedlibrarycoreservices-ClientService)> | logger | | +| `IDatabaseContextFactory` | databaseContextFactory | | +| [`ApplicationConfiguration`](./sharedlibrarycoreconfiguration-ApplicationConfiguration) | appConfig | | +| [`IGeoLocationService`](./sharedlibrarycoreinterfaces-IGeoLocationService) | geoLocationService | | + +### Methods +#### Create +```csharp +public virtual async Task Create(EFClient entity) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| [`EFClient`](./sharedlibrarycoredatabasemodels-EFClient) | entity | | + +#### Delete +```csharp +public virtual Task Delete(EFClient entity) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| [`EFClient`](./sharedlibrarycoredatabasemodels-EFClient) | entity | | + +#### Find +```csharp +public virtual Task> Find(Func e) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `Func`<[`EFClient`](./sharedlibrarycoredatabasemodels-EFClient), `bool`> | e | | + +#### Get +```csharp +public virtual async Task Get(int entityId) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `int` | entityId | | + +#### GetUnique +```csharp +public virtual async Task GetUnique(long entityAttribute, object altKey) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `long` | entityAttribute | | +| `object` | altKey | | + +#### Update +```csharp +public virtual async Task Update(EFClient temporalClient) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| [`EFClient`](./sharedlibrarycoredatabasemodels-EFClient) | temporalClient | | + +#### QueryResource +```csharp +public virtual async Task> QueryResource(FindClientRequest query) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| [`FindClientRequest`](./sharedlibrarycoredtos-FindClientRequest) | query | query filters | + +##### Summary +find clients matching the given query + +##### Returns + + +#### UpdateLevel +```csharp +public virtual async Task UpdateLevel(Permission newPermission, EFClient temporalClient, EFClient origin) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `Permission` | newPermission | | +| [`EFClient`](./sharedlibrarycoredatabasemodels-EFClient) | temporalClient | | +| [`EFClient`](./sharedlibrarycoredatabasemodels-EFClient) | origin | | + +#### UpdateAlias +```csharp +public async Task UpdateAlias(EFClient temporalClient) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| [`EFClient`](./sharedlibrarycoredatabasemodels-EFClient) | temporalClient | | + +#### GetClientReportCount +```csharp +public async Task GetClientReportCount(int clientId) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `int` | clientId | client id to search for report counts of | + +##### Summary +retrieves the number of times the given client id has been reported + +##### Returns + + +#### CanBeAutoFlagged +```csharp +public async Task CanBeAutoFlagged(int clientId) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `int` | clientId | | + +##### Summary +indicates if the given clientid can be autoflagged + +##### Returns + + +#### UnlinkClient +```csharp +public async Task UnlinkClient(int clientId) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `int` | clientId | | + +##### Summary +Unlinks shared GUID account into its own separate account + +##### Returns + + +#### GetOwners +```csharp +public async Task> GetOwners() +``` + +#### HasOwnerAsync +```csharp +public async Task HasOwnerAsync(CancellationToken token) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `CancellationToken` | token | | + +#### GetOwnerCount +```csharp +public virtual async Task GetOwnerCount() +``` +##### Summary +retrieves the number of owners + (client level is owner) + +##### Returns + + +#### GetClientForLogin +```csharp +public async Task GetClientForLogin(int clientId) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `int` | clientId | | + +#### GetPrivilegedClients +```csharp +public async Task> GetPrivilegedClients(bool includeName) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `bool` | includeName | | + +#### FindClientsByIdentifier +```csharp +public async Task> FindClientsByIdentifier(string identifier) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `string` | identifier | | + +#### GetTotalClientsAsync +```csharp +public async Task GetTotalClientsAsync() +``` + +#### GetRecentClientCount +```csharp +public async Task GetRecentClientCount() +``` +##### Summary +Returns the number of clients seen today + +##### Returns + + +#### GetRecentClients +```csharp +public async Task> GetRecentClients(PaginationRequest request) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| [`PaginationRequest`](./sharedlibrarycoredtos-PaginationRequest) | request | | + +##### Summary +gets the 10 most recently added clients to IW4MAdmin + +##### Returns + + +#### GetClientNameById +```csharp +public async Task GetClientNameById(int clientId) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `int` | clientId | | + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc) diff --git a/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreservices-PenaltyService.md b/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreservices-PenaltyService.md new file mode 100644 index 0000000..913421c --- /dev/null +++ b/CodeDocumentation/SharedLibraryCore/sharedlibrarycoreservices-PenaltyService.md @@ -0,0 +1,176 @@ +# PenaltyService `Public class` + +## Diagram +```mermaid + flowchart LR + classDef interfaceStyle stroke-dasharray: 5 5; + classDef abstractStyle stroke-width:4px + subgraph SharedLibraryCore.Services + SharedLibraryCore.Services.PenaltyService[[PenaltyService]] + end + subgraph SharedLibraryCore.Interfaces + SharedLibraryCore.Interfaces.IEntityService_1[[IEntityService< T >]] + class SharedLibraryCore.Interfaces.IEntityService_1 interfaceStyle; + + end +SharedLibraryCore.Interfaces.IEntityService_1 --> SharedLibraryCore.Services.PenaltyService +``` + +## Members +### Methods +#### Public methods +| Returns | Name | +| --- | --- | +| `Task`<`List`<`EFPenalty`>> | [`ActivePenaltiesByRecentIdentifiers`](#activepenaltiesbyrecentidentifiers)(`int` linkId) | +| `Task`<`EFPenalty`> | [`Create`](#create)(`EFPenalty` newEntity) | +| `Task` | [`CreatePenaltyIdentifier`](#createpenaltyidentifier)(`int` penaltyId, `long` networkId, `int` ipv4Address) | +| `Task`<`EFPenalty`> | [`Delete`](#delete)(`EFPenalty` entity) | +| `Task`<`IList`<`EFPenalty`>> | [`Find`](#find)(`Func`<`EFPenalty`, `bool`> expression) | +| `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`<`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`> + +### Constructors +#### PenaltyService +```csharp +public PenaltyService(IDatabaseContextFactory contextFactory, ApplicationConfiguration appConfig) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `IDatabaseContextFactory` | contextFactory | | +| [`ApplicationConfiguration`](./sharedlibrarycoreconfiguration-ApplicationConfiguration) | appConfig | | + +### Methods +#### Create +```csharp +public virtual async Task Create(EFPenalty newEntity) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `EFPenalty` | newEntity | | + +#### CreatePenaltyIdentifier +```csharp +public async Task CreatePenaltyIdentifier(int penaltyId, long networkId, int ipv4Address) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `int` | penaltyId | | +| `long` | networkId | | +| `int` | ipv4Address | | + +#### Delete +```csharp +public virtual Task Delete(EFPenalty entity) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `EFPenalty` | entity | | + +#### Find +```csharp +public virtual async Task> Find(Func expression) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `Func`<`EFPenalty`, `bool`> | expression | | + +#### Get +```csharp +public virtual Task Get(int entityID) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `int` | entityID | | + +#### GetUnique +```csharp +public virtual Task GetUnique(long entityProperty, object altKey) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `long` | entityProperty | | +| `object` | altKey | | + +#### Update +```csharp +public virtual Task Update(EFPenalty entity) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `EFPenalty` | entity | | + +#### GetRecentPenalties +```csharp +public async Task> GetRecentPenalties(int count, int offset, PenaltyType showOnly, bool ignoreAutomated) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `int` | count | | +| `int` | offset | | +| `PenaltyType` | showOnly | | +| `bool` | ignoreAutomated | | + +#### GetActivePenaltiesAsync +```csharp +public async Task> GetActivePenaltiesAsync(int linkId, int currentAliasId, long networkId, Game game, Nullable ip) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `int` | linkId | | +| `int` | currentAliasId | | +| `long` | networkId | | +| `Game` | game | | +| `Nullable`<`int`> | ip | | + +#### GetActivePenaltiesByIdentifier +```csharp +public async Task> GetActivePenaltiesByIdentifier(Nullable ip, long networkId, Game game) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `Nullable`<`int`> | ip | | +| `long` | networkId | | +| `Game` | game | | + +#### ActivePenaltiesByRecentIdentifiers +```csharp +public async Task> ActivePenaltiesByRecentIdentifiers(int linkId) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `int` | linkId | | + +#### RemoveActivePenalties +```csharp +public virtual async Task RemoveActivePenalties(int aliasLinkId, long networkId, Game game, Nullable ipAddress) +``` +##### Arguments +| Type | Name | Description | +| --- | --- | --- | +| `int` | aliasLinkId | | +| `long` | networkId | | +| `Game` | game | | +| `Nullable`<`int`> | ipAddress | | + +*Generated with* [*ModularDoc*](https://github.com/hailstorm75/ModularDoc)