[API/Library] Queue API

This is a mod is to be used as a dependency for other mods. If you are not a mod developer, you probably don't care about this description .

---

 

The mod hooks into the vanilla join queue logic and delegates all queue handling functionality to QueueAPI.QueueAPIModSystem.Handler.

 

Basic Usage
Create an implementation of QueueAPI.Handlers.IJoinQueueHandler and assign it to QueueAPI.Handlers.IJoinQueueHandler during StartServerSide(ICoreServerAPI api).

 

Examples:
There are a few samples handlers in the src/SampleHandlers directory but here is a short demonstration.

public override void StartServerSide(ICoreServerAPI api)
{
    api.ModLoader.GetModSystem<QueueAPIModSystem>().Handler = new DummyJoinQueueHandler();
}

 

/// <summary>
/// A simply <see cref="IJoinQueueHandler"/> implementation that simply kicks all joining players immediately.
/// </summary>
public class DummyJoinQueueHandler : IJoinQueueHandler
{
    public int JoinedPlayerCount => 0;
    
    public int QueueSize => 0;
    
    public int GetClientQueueIndex(int clientId) => -1;
    
    public QueuedClient? GetClientAtQueueIndex(int index) => null;

    public QueuedClient? GetNextQueuedClient(bool remove) => null;

    public IJoinQueueHandler.IPlayerConnectResult OnPlayerConnect(Packet_ClientIdentification clientIdentPacket, ConnectedClient client, string entitlements)
    {
        return new IJoinQueueHandler.IPlayerConnectResult.Disconnect("Kicked by the DummyJoinQueueHandler.");
    }

    public void OnPlayerDisconnect(ConnectedClient disconnectingClient) { }

    public void SendPositionUpdate() { }

    public void Reset() { }
}

I may add features for more fine grained control over the queue in the future but for now it's just QueueAPI.Handlers.IJoinQueueHandler.