Amazon GameLift
开发人员指南 (版本 )
AWS 文档中描述的 AWS 服务或功能可能因区域而异。要查看适用于中国区域的差异,请参阅中国的 AWS 服务入门

Amazon GameLift Server API (C++) 参考:操作

此 Amazon GameLift C++ 服务器 API 参考可帮助您准备使用 Amazon GameLift 的多人游戏。有关集成过程的详细信息,请参阅 添加 Amazon GameLift 到您的游戏服务器

此 API 在 GameLiftServerAPI.hLogParameters.hProcessParameters.h 中定义。

AcceptPlayerSession()

通知 Amazon GameLift 服务,具有所指定玩家会话 ID 的玩家已连接到服务器进程并且需要验证。Amazon GameLift 将确认玩家会话 ID 有效 — 即该玩家 ID 在游戏会话中有保留的玩家位置。通过验证后,Amazon GameLift 将玩家位置的状态从 RESERVED 更改为 ACTIVE。

语法

GenericOutcome AcceptPlayerSession(const std::string& playerSessionId);

参数

playerSessionId

Amazon GameLift 服务为响应对 AWS SDK Amazon GameLift API 操作 CreatePlayerSession 的调用而发出的唯一 ID。游戏客户端将在连接到服务器进程时引用此 ID。

类型:std::string

必需:是

返回值

返回成功或失败 (包含错误消息) 的一般结果。

示例

此示例演示了处理连接请求的函数,包括验证和拒绝无效的玩家会话 ID。

void ReceiveConnectingPlayerSessionID (Connection& connection, const std::string& playerSessionId){ Aws::GameLift::GenericOutcome connectOutcome = Aws::GameLift::Server::AcceptPlayerSession(playerSessionId); if(connectOutcome.IsSuccess()) { connectionToSessionMap.emplace(connection, playerSessionId); connection.Accept(); } else { connection.Reject(connectOutcome.GetError().GetMessage(); } }

ActivateGameSession()

通知 Amazon GameLift 服务,服务器进程已启动游戏会话,现在已准备好接收玩家连接。此操作应作为 onStartGameSession() 回调函数的一部分,在所有游戏会话初始化已完成之后调用。

语法

GenericOutcome ActivateGameSession();

参数

此操作没有参数。

返回值

返回成功或失败 (包含错误消息) 的一般结果。

示例

此示例显示作为 onStartGameSession() 回调函数的一部分调用 ActivateGameSession()

void onStartGameSession(Aws::GameLift::Model::GameSession myGameSession) { // game-specific tasks when starting a new game session, such as loading map GenericOutcome outcome = Aws::GameLift::Server::ActivateGameSession(); }

DescribePlayerSessions()

检索玩家会话数据,包括设置、会话元数据和玩家数据。使用此操作获取单个玩家会话的信息、游戏会话中所有玩家会话的信息或者与单个玩家 ID 相关联的所有玩家会话的信息。

语法

DescribePlayerSessionsOutcome DescribePlayerSessions ( const Aws::GameLift::Server::Model::DescribePlayerSessionsRequest &describePlayerSessionsRequest);

参数

describePlayerSessionsRequest

DescribePlayerSessionsRequest 对象描述要检索的玩家会话。

必需:是

返回值

如果成功,将返回一个 DescribePlayerSessionsOutcome 对象,包含一组与请求参数相匹配的玩家会话对象。玩家会话对象与 AWS SDK Amazon GameLift API PlayerSession 数据类型具有相同的结构。

示例

此示例演示了将所有玩家会话主动连接到指定游戏会话的请求。通过忽略 NextToken 和将 Limit 值设置为 10,Amazon GameLift 将返回符合请求条件的前 10 条玩家会话记录。

// Set request parameters Aws::GameLift::Server::Model::DescribePlayerSessionsRequest request; request.SetPlayerSessionStatusFilter(Aws::GameLift::Server::Model::PlayerSessionStatusMapper::GetNameForPlayerSessionStatus(Aws::GameLift::Server::Model::PlayerSessionStatus::Active)); request.SetLimit(10); request.SetGameSessionId("the game session ID"); // can use GetGameSessionId() // Call DescribePlayerSessions Aws::GameLift::DescribePlayerSessionsOutcome playerSessionsOutcome = Aws::GameLift::Server::DescribePlayerSessions(request);

GetGameSessionId()

检索当前由服务器进程托管的游戏会话的唯一标识符 (如果服务器进程处于活动状态)。该标识符以 ARN 格式返回:arn:aws-cn:gamelift:<region>::gamesession/fleet-<fleet ID>/<ID string>

语法

AwsStringOutcome GetGameSessionId();

参数

此操作没有参数。

返回值

如果成功,以 AwsStringOutcome 对象返回游戏会话 ID。如果不成功,将返回错误消息。

示例

Aws::GameLift::AwsStringOutcome sessionIdOutcome = Aws::GameLift::Server::GetGameSessionId();

GetSdkVersion()

返回正在使用中的软件开发工具包的当前版本号。

语法

AwsStringOutcome GetSdkVersion();

参数

此操作没有参数。

返回值

如果成功,返回以 AwsStringOutcome 对象返回当前软件开发工具包的版本。返回的字符串仅包含版本号 (例如:"3.1.5")。如果不成功,将返回错误消息。

示例

Aws::GameLift::AwsStringOutcome SdkVersionOutcome = Aws::GameLift::Server::GetSdkVersion();

GetTerminationTime()

如果终止时间可用,则返回安排服务器进程关闭的时间。收到来自 Amazon GameLift 服务的 onProcessTerminate() 回调后,服务器进程将执行此操作。服务器进程可能出于多种原因而关闭:(1) 进程运行状况不佳,(2) 实例在缩减事件期间被终止,或 (3) 实例由于 Spot 实例中断而终止。

如果该进程已收到 onProcessTerminate() 回调,则返回的值是估计的终止时间 (纪元秒)。如果没有可用的终止时间,则返回的值为 -1,这表示服务器进程可能随时被终止。如果该进程未收到 onProcessTerminate() 回调,则返回的值始终为 -1。了解有关关闭服务器进程的更多信息。

语法

AwsLongOutcome GetTerminationTime();

参数

此操作没有参数。

返回值

如果成功,返回以 AwsLongOutcome 对象返回当前软件开发工具包的版本。该值是终止时间 (纪元秒) 或值 -1。如果不成功,将返回错误消息。

示例

Aws::GameLift::AwsLongOutcome TermTimeOutcome = Aws::GameLift::Server::GetTerminationTime();

InitSDK()

初始化 Amazon GameLift 开发工具包。应在启动之后、进行任何其他 Amazon GameLift 相关的初始化之前调用此方法。

语法

InitSDKOutcome InitSDK();

参数

此操作没有参数。

返回值

如果成功,返回 InitSdkOutcome 对象,指示服务器进程已准备好调用 ProcessReady()

示例

Aws::GameLift::Server::InitSDKOutcome initOutcome = Aws::GameLift::Server::InitSDK();

ProcessEnding()

通知 Amazon GameLift 服务,该服务器进程正在关闭。此方法应退出,退出代码为 0;非零退出代码将导致生成一条事件消息,提示进程未完全退出。

语法

GenericOutcome ProcessEnding();

参数

此操作没有参数。

返回值

返回成功或失败 (包含错误消息) 的一般结果。

示例

Aws::GameLift::GenericOutcome outcome = Aws::GameLift::Server::ProcessEnding();

ProcessReady()

通知 Amazon GameLift 服务,服务器进程已准备好托管游戏会话。在成功调用 InitSDK() 并完成了服务器进程托管游戏会话所需的全部设置任务后,应调用此方法。

此调用为同步操作。要进行异步调用,请使用 ProcessReadyAsync()。有关更多信息,请参阅 准备服务器进程

语法

GenericOutcome ProcessReady( const Aws::GameLift::Server::ProcessParameters &processParameters);

参数

processParameters

ProcessParameters 对象,用于传输有关服务器进程的以下信息:

  • 回调方法的名称,在游戏服务器代码中实现,Amazon GameLift 服务调用它来与服务器进程通信。

  • 服务器进程正在侦听的端口号。

  • 您希望 Amazon GameLift 捕获和存储的任何游戏会话特定文件的路径。

必需:是

返回值

返回成功或失败 (包含错误消息) 的一般结果。

示例

此示例演示了 ProcessReady() 调用和回调函数的实现。

// Set parameters and call ProcessReady std::string serverLog("serverOut.log"); // Example of a log file written by the game server std::vector<std::string> logPaths; logPaths.push_back(serverLog); int listenPort = 9339; Aws::GameLift::Server::ProcessParameters processReadyParameter = Aws::GameLift::Server::ProcessParameters( std::bind(&Server::onStartGameSession, this, std::placeholders::_1), std::bind(&Server::onProcessTerminate, this), std::bind(&Server::OnHealthCheck, this), std::bind(&Server::OnUpdateGameSession, this), listenPort, Aws::GameLift::Server::LogParameters(logPaths)); Aws::GameLift::GenericOutcome outcome = Aws::GameLift::Server::ProcessReady(processReadyParameter); // Implement callback functions void Server::onStartGameSession(Aws::GameLift::Model::GameSession myGameSession) { // game-specific tasks when starting a new game session, such as loading map GenericOutcome outcome = Aws::GameLift::Server::ActivateGameSession (maxPlayers); } void Server::onProcessTerminate() { // game-specific tasks required to gracefully shut down a game session, // such as notifying players, preserving game state data, and other cleanup GenericOutcome outcome = Aws::GameLift::Server::ProcessEnding(); } bool Server::onHealthCheck() { bool health; // complete health evaluation within 60 seconds and set health return health; }

ProcessReadyAsync()

通知 Amazon GameLift 服务,服务器进程已准备好托管游戏会话。在服务器进程准备好托管游戏会话后,应调用此方法。该方法的参数用于指定 Amazon GameLift 在特定环境下应调用的回调函数的名称。游戏服务器代码必须执行这些函数。

此调用为异步操作。要进行同步调用,请使用 ProcessReady()。有关更多信息,请参阅 准备服务器进程

语法

GenericOutcomeCallable ProcessReadyAsync( const Aws::GameLift::Server::ProcessParameters &processParameters);

参数

processParameters

ProcessParameters 对象,用于传输有关服务器进程的以下信息:

  • 回调方法的名称,在游戏服务器代码中实现,Amazon GameLift 服务调用它来与服务器进程通信。

  • 服务器进程正在侦听的端口号。

  • 您希望 Amazon GameLift 捕获和存储的任何游戏会话特定文件的路径。

必需:是

返回值

返回成功或失败 (包含错误消息) 的一般结果。

示例

// Set parameters and call ProcessReady std::string serverLog("serverOut.log"); // This is an example of a log file written by the game server std::vector<std::string> logPaths; logPaths.push_back(serverLog); int listenPort = 9339; Aws::GameLift::Server::ProcessParameters processReadyParameter = Aws::GameLift::Server::ProcessParameters( std::bind(&Server::onStartGameSession, this, std::placeholders::_1), std::bind(&Server::onProcessTerminate, this), std::bind(&Server::OnHealthCheck, this), std::bind(&Server::OnUpdateGameSession, this), listenPort, Aws::GameLift::Server::LogParameters(logPaths)); Aws::GameLift::GenericOutcomeCallable outcome = Aws::GameLift::Server::ProcessReadyAsync(processReadyParameter); // Implement callback functions void onStartGameSession(Aws::GameLift::Model::GameSession myGameSession) { // game-specific tasks when starting a new game session, such as loading map GenericOutcome outcome = Aws::GameLift::Server::ActivateGameSession (maxPlayers); } void onProcessTerminate() { // game-specific tasks required to gracefully shut down a game session, // such as notifying players, preserving game state data, and other cleanup GenericOutcome outcome = Aws::GameLift::Server::ProcessEnding(); } bool onHealthCheck() { // perform health evaluation and complete within 60 seconds return health; }

RemovePlayerSession()

通知 Amazon GameLift 服务,具有所指定玩家会话 ID 的玩家已从服务器进程断开连接。作为响应,Amazon GameLift 将玩家位置更改为可用,这使得该玩家位置可以分配给新玩家。

语法

GenericOutcome RemovePlayerSession( const std::string& playerSessionId);

参数

playerSessionId

Amazon GameLift 服务为响应对 AWS SDK Amazon GameLift API 操作 CreatePlayerSession 的调用而发出的唯一 ID。游戏客户端将在连接到服务器进程时引用此 ID。

类型:std::string

必需:是

返回值

返回成功或失败 (包含错误消息) 的一般结果。

示例

Aws::GameLift::GenericOutcome disconnectOutcome = Aws::GameLift::Server::RemovePlayerSession(playerSessionId);

StartMatchBackfill()

发送请求以为使用 FlexMatch 创建的游戏会话中的开放位置查找新玩家。另请参阅 AWS 软件开发工具包操作 StartMatchBackfill()。通过此操作,托管游戏会话的游戏服务器进程可以发出匹配回填请求。在利用 FlexMatch 回填现有游戏中了解有关 FlexMatch 回填功能的更多信息。

此操作为异步操作。如果成功匹配了新玩家,则 Amazon GameLift 服务会使用回调函数 OnUpdateGameSession() 提供更新的对战构建器数据。

服务器进程每次只能具有一个活动的匹配回填请求。要发送新请求,请先调用 StopMatchBackfill() 以取消原始请求。

语法

StartMatchBackfillOutcome StartMatchBackfill ( const Aws::GameLift::Server::Model::StartMatchBackfillRequest &startBackfillRequest);

参数

StartMatchBackfillRequest

一个 StartMatchBackfillRequest 对象,用于传递以下信息:

  • 要分配给回填请求的票证 ID。此信息是可选的;如果未提供任何 ID,则 Amazon GameLift 将自动生成一个 ID。

  • 要将请求发送到的对战构建器。需要完整的配置 ARN。可从游戏会话的对战构建器数据中获得此值。

  • 正在进行回填的游戏会话的 ID。

  • 游戏会话的当前玩家的可用对战数据。

必需:是

返回值

返回带有对战回填票证的 StartMatchBackfillOutcome 对象或包含错误消息的失败。使用 AWS 软件开发工具包操作 DescribeMatchmaking() 可跟踪票证状态。

示例

// Build a backfill request std::vector<Player> players; Aws::GameLift::Server::Model::StartMatchBackfillRequest startBackfillRequest; startBackfillRequest.SetTicketId("a ticket ID"); //optional, autogenerated if not provided startBackfillRequest.SetMatchmakingConfigurationArn("the matchmaker configuration ARN"); //from the game session matchmaker data startBackfillRequest.SetGameSessionArn("the game session ARN"); // can use GetGameSessionId() startBackfillRequest.SetPlayers(players); //from the game session matchmaker data // Send backfill request Aws::GameLift::StartMatchBackfillOutcome backfillOutcome = Aws::GameLift::Server::StartMatchBackfill(startBackfillRequest); // Implement callback function for backfill void Server::OnUpdateGameSession(Aws::GameLift::Server::Model::GameSession gameSession, Aws::GameLift::Server::Model::UpdateReason updateReason, std::string backfillTicketId) { // handle status messages // perform game-specific tasks to prep for newly matched players }

StopMatchBackfill()

取消使用 StartMatchBackfill() 创建的活动对战回填请求。另请参阅 AWS 软件开发工具包操作 StopMatchmaking()。在利用 FlexMatch 回填现有游戏中了解有关 FlexMatch 回填功能的更多信息。

语法

GenericOutcome StopMatchBackfill ( const Aws::GameLift::Server::Model::StopMatchBackfillRequest &stopBackfillRequest);

参数

StopMatchBackfillRequest

一个 StopMatchBackfillRequest 对象,用于识别要取消的对战票证:

  • 分配给被取消的回填请求的票证 ID

  • 回填请求所发送到的对战构建器

  • 与回填请求关联的游戏会话

必需:是

返回值

返回成功或失败 (包含错误消息) 的一般结果。

示例

// Set backfill stop request parameters Aws::GameLift::Server::Model::StopMatchBackfillRequest stopBackfillRequest; stopBackfillRequest.SetTicketId("the ticket ID"); stopBackfillRequest.SetGameSessionArn("the game session ARN"); // can use GetGameSessionId() stopBackfillRequest.SetMatchmakingConfigurationArn("the matchmaker configuration ARN"); // from the game session matchmaker data Aws::GameLift::GenericOutcome stopBackfillOutcome = Aws::GameLift::Server::StopMatchBackfillRequest(stopBackfillRequest);

TerminateGameSession()

通知 Amazon GameLift 服务,服务器进程已关闭游戏会话。由于每个服务器进程一次仅托管一个游戏会话,因此您无需指定哪个会话。此操作应在游戏会话关闭进程结束时调用。调用此操作后,服务器进程可以调用 ProcessReady() 以发送其承载新游戏会话的可用性信号。它也可以调用 ProcessEnding() 以关闭服务器进程并终止实例。

语法

GenericOutcome TerminateGameSession();

参数

此操作没有参数。

返回值

返回成功或失败 (包含错误消息) 的一般结果。

示例

此示例说明了游戏会话结束时的服务器进程。

// game-specific tasks required to gracefully shut down a game session, // such as notifying players, preserving game state data, and other cleanup Aws::GameLift::GenericOutcome outcome = Aws::GameLift::Server::TerminateGameSession(); Aws::GameLift::GenericOutcome outcome = Aws::GameLift::Server::ProcessReady(onStartGameSession, onProcessTerminate);

UpdatePlayerSessionCreationPolicy()

更新当前游戏会话接受新玩家会话的能力。可将游戏会话设置为接受或拒绝所有新的玩家会话。另请参阅 AWS 软件开发工具包操作 UpdateGameSession()

语法

GenericOutcome UpdatePlayerSessionCreationPolicy( Aws::GameLift::Model::PlayerSessionCreationPolicy newPlayerSessionPolicy);

参数

newPlayerSessionPolicy

用于指示游戏会话是否接受新玩家的字符串值。

类型: Aws::GameLift::Model::PlayerSessionCreationPolicy 枚举。有效值包括:

  • ACCEPT_ALL – 接受所有新玩家会话。

  • DENY_ALL – 拒绝所有新玩家会话。

必需:是

返回值

返回成功或失败 (包含错误消息) 的一般结果。

示例

此示例将当前游戏会话的接入策略设为接受所有玩家。

Aws::GameLift::GenericOutcome outcome = Aws::GameLift::Server::UpdatePlayerSessionCreationPolicy(Aws::GameLift::Model::PlayerSessionCreationPolicy::ACCEPT_ALL);