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.
AWSGameLift::IAWSGameLiftServerRequests Class Referenceabstract

#include <AWSGameLiftServerRequestBus.h>

Public Member Functions

 AZ_RTTI (IAWSGameLiftServerRequests, "{D76CD98D-4C37-4C25-82C4-4E8772706D70}")
 
virtual bool NotifyGameLiftProcessReady ()=0
 
virtual bool StartMatchBackfill (const AZStd::string &ticketId, const AZStd::vector< AWSGameLiftPlayer > &players)=0
 
virtual bool StopMatchBackfill (const AZStd::string &ticketId)=0
 

Detailed Description

IAWSGameLiftServerRequests Server interfaces to expose Amazon GameLift Server SDK

Member Function Documentation

◆ NotifyGameLiftProcessReady()

virtual bool AWSGameLift::IAWSGameLiftServerRequests::NotifyGameLiftProcessReady ( )
pure virtual

Notify GameLift that the server process is ready to host a game session.

Returns
True if the ProcessReady notification is sent to GameLift successfully, false otherwise

◆ StartMatchBackfill()

virtual bool AWSGameLift::IAWSGameLiftServerRequests::StartMatchBackfill ( const AZStd::string &  ticketId,
const AZStd::vector< AWSGameLiftPlayer > &  players 
)
pure virtual

Sends a request to find new players for open slots in a game session created with FlexMatch.

Parameters
ticketIdUnique identifier for match backfill request ticket
playersA set of data representing all players who are currently in the game session, if not provided, system will use lazy loaded game session data which is not guaranteed to be accurate (no latency data either)
Returns
True if StartMatchBackfill succeeds, false otherwise

◆ StopMatchBackfill()

virtual bool AWSGameLift::IAWSGameLiftServerRequests::StopMatchBackfill ( const AZStd::string &  ticketId)
pure virtual

Cancels an active match backfill request that was created with StartMatchBackfill

Parameters
ticketIdUnique identifier of the backfill request ticket to be canceled
Returns
True if StopMatchBackfill succeeds, false otherwise

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