Open 3D Engine Multiplayer Gem API Reference 23.10.0
O3DE is an open-source, fully-featured, high-fidelity, modular 3D engine for building games and simulations, available to every industry.
Public Member Functions | List of all members
Multiplayer::IMatchmakingRequests Class Referenceabstract

#include <IMatchmakingRequests.h>

Public Member Functions

 AZ_RTTI (IMatchmakingRequests, "{BC0B74DA-A448-4F40-9B50-9D73142829D5}")
 
virtual void AcceptMatch (const AcceptMatchRequest &acceptMatchRequest)=0
 
virtual AZStd::string StartMatchmaking (const StartMatchmakingRequest &startMatchmakingRequest)=0
 
virtual void StopMatchmaking (const StopMatchmakingRequest &stopMatchmakingRequest)=0
 

Detailed Description

IMatchmakingRequests Pure virtual session interface class to abstract the details of session handling from application code.

Member Function Documentation

◆ AcceptMatch()

virtual void Multiplayer::IMatchmakingRequests::AcceptMatch ( const AcceptMatchRequest &  acceptMatchRequest)
pure virtual

Registers a player's acceptance or rejection of a proposed matchmaking.

Parameters
acceptMatchRequestThe request of AcceptMatch operation

◆ StartMatchmaking()

virtual AZStd::string Multiplayer::IMatchmakingRequests::StartMatchmaking ( const StartMatchmakingRequest &  startMatchmakingRequest)
pure virtual

Create a game match for a group of players.

Parameters
startMatchmakingRequestThe request of StartMatchmaking operation
Returns
A unique identifier for a matchmaking ticket

◆ StopMatchmaking()

virtual void Multiplayer::IMatchmakingRequests::StopMatchmaking ( const StopMatchmakingRequest &  stopMatchmakingRequest)
pure virtual

Cancels a matchmaking ticket that is currently being processed.

Parameters
stopMatchmakingRequestThe request of StopMatchmaking operation
The documentation for this class was generated from the following file: