Open 3D Engine AWSGameLift 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
AWSGameLift::IAWSGameLiftMatchmakingEventRequests Class Referenceabstract

#include <AWSGameLiftMatchmakingRequestBus.h>

Public Member Functions

 AZ_RTTI (IAWSGameLiftMatchmakingEventRequests, "{C2DA440E-74E0-411E-813D-5880B50B0C9E}")
 
virtual void StartPolling (const AZStd::string &ticketId, const AZStd::string &playerId)=0
 
virtual void StopPolling ()=0
 

Detailed Description

IAWSGameLiftMatchmakingEventRequests GameLift Gem matchmaking event interfaces which is used to track matchmaking ticket event Developer should define the way to poll matchmaking ticket event and behavior based on the ticket status Use AWSGameLiftClientLocalTicketTracker as an example, it uses continuous polling to query matchmaking ticket: StartPolling - local ticket tracker starts monitor process for matchmaking ticket, and joins player to the match once ticket is complete StopPolling - local ticket tracker cancels ongoing matchmaking ticket and stops monitoring process

Member Function Documentation

◆ StartPolling()

virtual void AWSGameLift::IAWSGameLiftMatchmakingEventRequests::StartPolling ( const AZStd::string &  ticketId,
const AZStd::string &  playerId 
)
pure virtual

StartPolling Request to start process for polling matchmaking ticket based on given ticket id and player Id

Parameters
ticketIdThe requested matchmaking ticket id
playerIdThe requested matchmaking player id

◆ StopPolling()

virtual void AWSGameLift::IAWSGameLiftMatchmakingEventRequests::StopPolling ( )
pure virtual

StopPolling Request to stop process for polling matchmaking ticket

The documentation for this class was generated from the following file: