Queues and matches

Create your queue first. See Setting Up Matchmaking.

Enter and cancel the queue

Call	What it does
`EnterQueue`	Puts your lobby in the queue. Host only.
`CancelQueue`	Takes your lobby out of the queue. Host only.
`GetQueueStats`	Reads how many players are searching and how long they wait. Works with a client key.
`StartMatch`	Starts a match with no matchmaking. Host only.
`EndMatch`	Ends the match. The lobby goes back to waiting. Host only.

Other players get the error NOT_HOST. A lobby in the queue is only matched while at least one of its players has been seen within the last 45 seconds. A player with an open event stream counts as seen. OnQueueCancelled gives a reason. It can be timeout, queue_disabled, billing_locked, plan_changed, no_build_for_version or server_failed. The reason is empty when the host cancels.

When a match is found

OnMatchFound fires. It has the match ID and the queue ID. The server is not ready yet.
Simpl starts the server.
OnServerReady fires with the host and the port. The plugin only fires it when the server has a port named game.
Connect to that address. Call TravelToServer(Host, Port), or TravelToLobbyServer() to use the lobby’s server.

TravelToServer returns true when travel started. That does not mean the player connected. To learn how addresses work, see Connect players.

The whole flow in C++

This sample initializes the plugin, creates a lobby, listens for the server, enters the queue, and shuts down. HandleServerReady must be declared with UFUNCTION() in your header.

#include "SimplClientSubsystem.h"
#include "SimplClientCore.h"
#include "SimplValue.h"

void UMyGameInstance::StartOnline(const FString& PlayerId)
{
	USimplClientSubsystem* Simpl = GetSubsystem<USimplClientSubsystem>();
	if (!Simpl || !Simpl->InitializeSimpl(PlayerId))
	{
		return;
	}

	Simpl->OnServerReady.AddDynamic(this, &UMyGameInstance::HandleServerReady);

	TMap<FString, FSimplStateValue> State;
	State.Add(TEXT("name"), FSimplStateValue::FromString(TEXT("Sam")));

	Simpl->CreateLobby(TEXT("duel"), TEXT("iad"), TEXT("My lobby"), 0, false, State,
		[Simpl](const FSimplReply& Reply)
		{
			if (Reply.Result.bOk)
			{
				Simpl->EnterQueue();
			}
			else
			{
				UE_LOG(LogTemp, Warning, TEXT("Create failed: %s"), *Reply.Result.ErrorCode);
			}
		});
}

void UMyGameInstance::HandleServerReady(const FString& Host, int32 Port, const FString& MatchId, const TArray<FSimplLobbyNetworkPort>& NetworkPorts)
{
	GetSubsystem<USimplClientSubsystem>()->TravelToServer(Host, Port);
}

void UMyGameInstance::Shutdown()
{
	if (USimplClientSubsystem* Simpl = GetSubsystem<USimplClientSubsystem>())
	{
		Simpl->ShutdownSimpl();
	}
	Super::Shutdown();
}

ShutdownSimpl leaves the lobbies you are in. OnShutdownComplete tells you when it is done. It is available in C++ only.

Getting Started

Build Your Server

Run Your Server

Players

Unreal SDK

Platform

Queues and matches

Enter and cancel the queue

When a match is found

The whole flow in C++

​Enter and cancel the queue

​When a match is found

​The whole flow in C++

Enter and cancel the queue

When a match is found

The whole flow in C++