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::IAWSGameLiftRequests Class Referenceabstract

#include <AWSGameLiftRequestBus.h>

Public Member Functions

 AZ_RTTI (IAWSGameLiftRequests, "{494167AD-1185-4AF3-8BF9-C8C37FC9C199}")
 
virtual bool ConfigureGameLiftClient (const AZStd::string &region)=0
 
virtual AZStd::string CreatePlayerId (bool includeBrackets, bool includeDashes)=0
 

Detailed Description

IAWSGameLiftRequests GameLift Gem interfaces to configure GameLift client and other help functions, like creating random GameLift player id

Member Function Documentation

◆ ConfigureGameLiftClient()

virtual bool AWSGameLift::IAWSGameLiftRequests::ConfigureGameLiftClient ( const AZStd::string &  region)
pure virtual

ConfigureGameLiftClient Configure GameLift client to interact with Amazon GameLift service

Parameters
regionSpecifies the AWS region to use
Returns
True if client configuration succeeds, false otherwise

◆ CreatePlayerId()

virtual AZStd::string AWSGameLift::IAWSGameLiftRequests::CreatePlayerId ( bool  includeBrackets,
bool  includeDashes 
)
pure virtual

CreatePlayerId Create a new, random ID number for every player in every new game session.

Parameters
includeBracketsWhether includes brackets in player id
includeDashesWhether includes dashes in player id
Returns
The player id to use in game session
The documentation for this class was generated from the following file: