1 sharedlibrarycoreinterfaces IManager

RaidMax edited this page 2023-05-20 22:09:21 -05:00

Table of Contents

• IManager Public interface
• Diagram
• Members
• Properties
• Public properties
• Methods
• Public methods
• Details
• Methods
• Init
• Start
• Stop
• Restart
• GetLogger
• Arguments
• GetServers
• GetCommands
• GetMessageTokens
• GetActiveClients
• FindActiveClient
• Arguments
• GetApplicationSettings
• GetClientService
• GetPenaltyService
• GetPageList
• Summary
• Returns
• ExecuteSharedDatabaseOperation
• Arguments
• RegisterSharedDatabaseOperation
• Arguments
• GenerateDynamicRConParser
• Arguments
• Summary
• Returns
• GenerateDynamicEventParser
• Arguments
• Summary
• Returns
• ExecuteEvent
• Arguments
• AddEvent
• Arguments
• Summary
• QueueEvent
• Arguments
• Summary
• AddAdditionalCommand
• Arguments
• Summary
• RemoveCommandByName
• Arguments
• Summary
• Properties
• Commands
• Plugins
• Summary
• AdditionalRConParsers
• AdditionalEventParsers
• MiddlewareActionHandler
• CommandInterceptors
• Version
• TokenAuthenticator
• ExternalIPAddress
• CancellationToken
• IsRestartRequested
• IsRunning
• ProcessingEvents
• AlertManager
• InteractionRegistration
• Events
• OnGameEventExecuted
• Summary

IManager Public interface

Diagram

  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>	AdditionalEventParsers	get
IList<IRConParser>	AdditionalRConParsers	get
IAlertManager	AlertManager	get
CancellationToken	CancellationToken	get
IList<Func<GameEvent, bool>>	CommandInterceptors	get
IReadOnlyList<IManagerCommand>	Commands	get
string	ExternalIPAddress	get
IInteractionRegistration	InteractionRegistration	get
bool	IsRestartRequested	get
bool	IsRunning	get
IMiddlewareActionHandler	MiddlewareActionHandler	get
IEnumerable<IPlugin>	Plugins enumerates the registered plugin instances	get
ConcurrentDictionary<long, GameEvent>	ProcessingEvents	get
ITokenAuthentication	TokenAuthenticator	get
string	Version	get

Methods

Public methods

Returns	Name
void	AddAdditionalCommand(IManagerCommand command) adds an additional (script) command to the command list
void	AddEvent(GameEvent gameEvent) queues an event for processing
Task	ExecuteEvent(GameEvent gameEvent)
Task<IList<T>>	ExecuteSharedDatabaseOperation(string operationName)
EFClient	FindActiveClient(EFClient client)
IEventParser	GenerateDynamicEventParser(string name) Generates an event parser that can be configured by script plugins
IRConParser	GenerateDynamicRConParser(string name) generates an rcon parser that can be configured by script plugins
IList<EFClient>	GetActiveClients()
IConfigurationHandler<ApplicationConfiguration>	GetApplicationSettings()
ClientService	GetClientService()
IList<IManagerCommand>	GetCommands()
ILogger	GetLogger(long serverId)
IList<MessageToken>	GetMessageTokens()
IPageList	GetPageList() provides a page list to add and remove from
PenaltyService	GetPenaltyService()
IList<Server>	GetServers()
Task	Init()
void	QueueEvent(CoreEvent coreEvent) queues an event for processing
void	RegisterSharedDatabaseOperation(Task<IList> operation, string operationName)
void	RemoveCommandByName(string name) removes a command by its name
Task	Restart()
Task	Start()
Task	Stop()

Details

Methods

Init

Source code

public Task Init()

Start

Source code

public Task Start()

Stop

Source code

public Task Stop()

Restart

Source code

public Task Restart()

GetLogger

Source code

public ILogger GetLogger(long serverId)

Arguments

Type	Name	Description
long	serverId

GetServers

Source code

public IList<Server> GetServers()

GetCommands

Source code

public IList<IManagerCommand> GetCommands()

GetMessageTokens

Source code

public IList<MessageToken> GetMessageTokens()

GetActiveClients

Source code

public IList<EFClient> GetActiveClients()

FindActiveClient

Source code

public EFClient FindActiveClient(EFClient client)

Arguments

Type	Name	Description
EFClient	client

GetApplicationSettings

Source code

public IConfigurationHandler<ApplicationConfiguration> GetApplicationSettings()

GetClientService

Source code

public ClientService GetClientService()

GetPenaltyService

Source code

public PenaltyService GetPenaltyService()

GetPageList

Source code

public IPageList GetPageList()

Summary

provides a page list to add and remove from

Returns

ExecuteSharedDatabaseOperation

Source code

public Task<IList<T>> ExecuteSharedDatabaseOperation<T>(string operationName)
where T : 

Arguments

Type	Name	Description
string	operationName

RegisterSharedDatabaseOperation

Source code

public void RegisterSharedDatabaseOperation(Task<IList> operation, string operationName)

Arguments

Type	Name	Description
Task<IList>	operation
string	operationName

GenerateDynamicRConParser

Source code

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

Source code

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

Source code

public Task ExecuteEvent(GameEvent gameEvent)

Arguments

Type	Name	Description
GameEvent	gameEvent

AddEvent

Source code

public void AddEvent(GameEvent gameEvent)

Arguments

Type	Name	Description
GameEvent	gameEvent	event to be processed

Summary

queues an event for processing

QueueEvent

Source code

public void QueueEvent(CoreEvent coreEvent)

Arguments

Type	Name	Description
CoreEvent	coreEvent

Summary

queues an event for processing

AddAdditionalCommand

Source code

public void AddAdditionalCommand(IManagerCommand command)

Arguments

Type	Name	Description
IManagerCommand	command

Summary

adds an additional (script) command to the command list

RemoveCommandByName

Source code

public void RemoveCommandByName(string name)

Arguments

Type	Name	Description
string	name	name of command

Summary

removes a command by its name

Properties

Commands

public IReadOnlyList<IManagerCommand> Commands { get; }

Plugins

public IEnumerable<IPlugin> Plugins { get; }

Summary

enumerates the registered plugin instances

AdditionalRConParsers

public IList<IRConParser> AdditionalRConParsers { get; }

AdditionalEventParsers

public IList<IEventParser> AdditionalEventParsers { get; }

MiddlewareActionHandler

public IMiddlewareActionHandler MiddlewareActionHandler { get; }

CommandInterceptors

public IList<Func<GameEvent, bool>> CommandInterceptors { get; }

Version

public string Version { get; }

TokenAuthenticator

public ITokenAuthentication TokenAuthenticator { get; }

ExternalIPAddress

public string ExternalIPAddress { get; }

CancellationToken

public CancellationToken CancellationToken { get; }

IsRestartRequested

public bool IsRestartRequested { get; }

IsRunning

public bool IsRunning { get; }

ProcessingEvents

public ConcurrentDictionary<long, GameEvent> ProcessingEvents { get; }

AlertManager

public IAlertManager AlertManager { get; }

InteractionRegistration

public IInteractionRegistration InteractionRegistration { get; }

Events

OnGameEventExecuted

public event EventHandler<GameEvent> OnGameEventExecuted

Summary

event executed when event has finished executing

Generated with ModularDoc

• Overview
• Getting Started
• FAQ
• Knowledge Base
• Features
  • Commands
  • Webfront
  • Game Interface
  • Permission Sets
  • Plugins
  • API
  • Searching
• Plugin Development
  • Examples
• Configuration
• Game Log Server