1 sharedlibrarycoreinterfacesevents IManagementEventSubscriptions

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

Table of Contents

• IManagementEventSubscriptions Public interface
• Diagram
• Members
• Methods
• Public Static methods
• Details
• Methods
• InvokeEventAsync
• Arguments
• InvokeLoadAsync
• Arguments
• InvokeUnloadAsync
• Arguments
• ClearEventInvocations
• Events
• Load
• Summary
• Unload
• Summary
• ClientStateInitialized
• Summary
• ClientStateAuthorized
• Summary
• ClientStateDisposed
• Summary
• ClientPenaltyAdministered
• Summary
• ClientPenaltyRevoked
• Summary
• ClientCommandExecuted
• Summary
• ClientPermissionChanged
• Summary
• ClientLoggedIn
• Summary
• ClientLoggedOut
• Summary
• ClientPersistentIdReceived
• Summary

IManagementEventSubscriptions Public interface

Diagram

  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()
Task	InvokeEventAsync(CoreEvent coreEvent, CancellationToken token)
Task	InvokeLoadAsync(IManager manager, CancellationToken token)
Task	InvokeUnloadAsync(IManager manager, CancellationToken token)

Details

Methods

InvokeEventAsync

Source code

public static Task InvokeEventAsync(CoreEvent coreEvent, CancellationToken token)

Arguments

Type	Name	Description
CoreEvent	coreEvent
CancellationToken	token

InvokeLoadAsync

Source code

public static Task InvokeLoadAsync(IManager manager, CancellationToken token)

Arguments

Type	Name	Description
IManager	manager
CancellationToken	token

InvokeUnloadAsync

Source code

public static Task InvokeUnloadAsync(IManager manager, CancellationToken token)

Arguments

Type	Name	Description
IManager	manager
CancellationToken	token

ClearEventInvocations

Source code

public static void ClearEventInvocations()

Events

Load

public static event Func<IManager, CancellationToken, Task> Load

Summary

Raised when IManager is loading

Unload

public static event Func<IManager, CancellationToken, Task> Unload

Summary

Raised when IManager is restarting

ClientStateInitialized

public static event Func<ClientStateInitializeEvent, CancellationToken, Task> 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

ClientStateAuthorized

public static event Func<ClientStateAuthorizeEvent, CancellationToken, Task> ClientStateAuthorized

Summary

Raised when client enters an authorized state (valid data and no bans) ClientStateAuthorizeEvent

ClientStateDisposed

public static event Func<ClientStateDisposeEvent, CancellationToken, Task> ClientStateDisposed

Summary

Raised when client is no longer tracked (unknown state) At this point any references to the client should be dropped ClientStateDisposeEvent

ClientPenaltyAdministered

public static event Func<ClientPenaltyEvent, CancellationToken, Task> ClientPenaltyAdministered

Summary

Raised when a client receives a penalty ClientPenaltyEvent

ClientPenaltyRevoked

public static event Func<ClientPenaltyRevokeEvent, CancellationToken, Task> ClientPenaltyRevoked

Summary

Raised when a client penalty is revoked (eg unflag/unban) ClientPenaltyRevokeEvent

ClientCommandExecuted

public static event Func<ClientExecuteCommandEvent, CancellationToken, Task> ClientCommandExecuted

Summary

Raised when a client command is executed (after completion of the command) ClientExecuteCommandEvent

ClientPermissionChanged

public static event Func<ClientPermissionChangeEvent, CancellationToken, Task> ClientPermissionChanged

Summary

Raised when a client's permission level changes ClientPermissionChangeEvent

ClientLoggedIn

public static event Func<LoginEvent, CancellationToken, Task> ClientLoggedIn

Summary

Raised when a client logs in to the webfront or ingame LoginEvent

ClientLoggedOut

public static event Func<LogoutEvent, CancellationToken, Task> ClientLoggedOut

Summary

Raised when a client logs out of the webfront LogoutEvent

ClientPersistentIdReceived

public static event Func<ClientPersistentIdReceiveEvent, CancellationToken, Task> ClientPersistentIdReceived

Summary

Raised when a client's persistent id (stats file marker) is received ClientPersistentIdReceiveEvent

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