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::AWSGameLiftClientManager Class Reference

#include <AWSGameLiftClientManager.h>

Inherits AWSGameLiftRequestBus::Handler, AWSGameLiftMatchmakingAsyncRequestBus::Handler, AWSGameLiftMatchmakingRequestBus::Handler, AWSGameLiftSessionAsyncRequestBus::Handler, and AWSGameLiftSessionRequestBus::Handler.

Public Member Functions

virtual void ActivateManager ()
 
virtual void DeactivateManager ()
 
bool ConfigureGameLiftClient (const AZStd::string &region) override
 
AZStd::string CreatePlayerId (bool includeBrackets, bool includeDashes) override
 
void AcceptMatchAsync (const Multiplayer::AcceptMatchRequest &acceptMatchRequest) override
 
void StartMatchmakingAsync (const Multiplayer::StartMatchmakingRequest &startMatchmakingRequest) override
 
void StopMatchmakingAsync (const Multiplayer::StopMatchmakingRequest &stopMatchmakingRequest) override
 
void CreateSessionAsync (const Multiplayer::CreateSessionRequest &createSessionRequest) override
 
void JoinSessionAsync (const Multiplayer::JoinSessionRequest &joinSessionRequest) override
 
void SearchSessionsAsync (const Multiplayer::SearchSessionsRequest &searchSessionsRequest) const override
 
void LeaveSessionAsync () override
 
void AcceptMatch (const Multiplayer::AcceptMatchRequest &acceptMatchRequest) override
 
AZStd::string StartMatchmaking (const Multiplayer::StartMatchmakingRequest &startMatchmakingRequest) override
 
void StopMatchmaking (const Multiplayer::StopMatchmakingRequest &stopMatchmakingRequest) override
 
AZStd::string CreateSession (const Multiplayer::CreateSessionRequest &createSessionRequest) override
 
bool JoinSession (const Multiplayer::JoinSessionRequest &joinSessionRequest) override
 
Multiplayer::SearchSessionsResponse SearchSessions (const Multiplayer::SearchSessionsRequest &searchSessionsRequest) const override
 
void LeaveSession () override
 

Static Public Attributes

static constexpr const char AWSGameLiftClientManagerName [] = "AWSGameLiftClientManager"
 
static constexpr const char AWSGameLiftClientRegionMissingErrorMessage []
 
static constexpr const char AWSGameLiftClientCredentialMissingErrorMessage []
 
static constexpr const char AWSGameLiftCreateSessionRequestInvalidErrorMessage []
 

Detailed Description

AWSGameLiftClientManager GameLift client manager to support game and player session related client requests

Member Data Documentation

◆ AWSGameLiftClientCredentialMissingErrorMessage

constexpr const char AWSGameLift::AWSGameLiftClientManager::AWSGameLiftClientCredentialMissingErrorMessage[]
staticconstexpr
Initial value:
=
"Missing AWS credential for GameLift client."

◆ AWSGameLiftClientRegionMissingErrorMessage

constexpr const char AWSGameLift::AWSGameLiftClientManager::AWSGameLiftClientRegionMissingErrorMessage[]
staticconstexpr
Initial value:
=
"Missing AWS region for GameLift client."

◆ AWSGameLiftCreateSessionRequestInvalidErrorMessage

constexpr const char AWSGameLift::AWSGameLiftClientManager::AWSGameLiftCreateSessionRequestInvalidErrorMessage[]
staticconstexpr
Initial value:
=
"Invalid GameLift CreateSession or CreateSessionOnQueue request."

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