Amazon Web Services 文档中描述的 Amazon Web Services 服务或功能可能因区域而异。要查看适用于中国区域的差异，请参阅 中国的 Amazon Web Services 服务入门 (PDF)。

本文属于机器翻译版本。若本译文内容与英语原文存在差异，则一律以英文原文为准。

Unreal Engine 的 Amazon GameLift 服务器软件开发工具包 参考：动作

此 服务器 API 参考可帮助您准备 Unreal Engine 游戏项目用于 。有关集成过程的详细信息，请参阅 将 Amazon GameLift 添加到您的游戏服务器。

此 API 在 GameLiftServerSDK.h 和 GameLiftServerSDKModels.h 中定义。

设置 Unreal Engine 插件并查看代码示例将 Amazon GameLift 集成到虚幻引擎项目中。

AcceptPlayerSession()

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

语法

FGameLiftGenericOutcome AcceptPlayerSession(const FString& playerSessionId)

参数

返回值

返回由成功或失败组成的通用结果，并显示错误消息。

ActivateGameSession()

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

语法

FGameLiftGenericOutcome ActivateGameSession()

参数

此操作没有参数。

返回值

返回由成功或失败组成的通用结果，并显示错误消息。

DescribePlayerSessions()

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

语法

FGameLiftDescribePlayerSessionsOutcome DescribePlayerSessions(const FGameLiftDescribePlayerSessionsRequest &describePlayerSessionsRequest)

参数

返回值

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

GetGameSessionId()

检索当前由服务器进程托管的游戏会话的 ID (如果服务器进程处于活动状态)。

语法

FGameLiftStringOutcome GetGameSessionId()

参数

此操作没有参数。

返回值

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

GetSdkVersion()

返回当前内置到服务器进程中的开发工具包的版本号。

语法

FGameLiftStringOutcome GetSdkVersion();

参数

此操作没有参数。

返回值

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

示例

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

InitSDK()

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

语法

FGameLiftGenericOutcome InitSDK()

参数

此操作没有参数。

返回值

返回由成功或失败组成的通用结果，并显示错误消息。

ProcessEnding()

通知 服务，该服务器进程正在关闭。应在所有其他清除任务 (包括关闭所有活动游戏会话) 之后调用此方法。此方法应退出，退出代码为 0；非零退出代码将导致生成一条事件消息，提示进程未完全退出。

语法

FGameLiftGenericOutcome ProcessEnding()

参数

此操作没有参数。

返回值

返回由成功或失败组成的通用结果，并显示错误消息。

ProcessReady()

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

语法

FGameLiftGenericOutcome ProcessReady(FProcessParameters &processParameters)

参数

返回值

返回由成功或失败组成的通用结果，并显示错误消息。

示例

请参阅使用 Unreal Engine 插件中的示例代码。

RemovePlayerSession()

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

语法

FGameLiftGenericOutcome RemovePlayerSession(const FString& playerSessionId)

参数

返回值

返回由成功或失败组成的通用结果，并显示错误消息。

StartMatchBackfill()

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

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

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

语法

FGameLiftStringOutcome StartMatchBackfill (FStartMatchBackfillRequest &startBackfillRequest);

参数

返回值

如果成功，将返回对战回填票证作为 FGameLiftStringOutcome 对象。如果不成功，将返回错误消息。使用 Amazon 软件开发工具包操作 AmazonDescribeMatchmaking() 可跟踪票证状态。

StopMatchBackfill()

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

语法

FGameLiftGenericOutcome StopMatchBackfill (FStopMatchBackfillRequest &stopBackfillRequest);

参数

返回值

返回由成功或失败组成的通用结果，并显示错误消息。

TerminateGameSession()

4.0.1 相反，服务器进程应在游戏会话结束ProcessEnding()后调用。

通知 Amazon GameLift 服务服务器进程已结束当前游戏会话。当服务器进程保持活动状态并准备托管新游戏会话时，将调用此操作。只有在游戏会话终止程序完成后才应调用它，因为它会向 Amazon GameLift 发出信号，表明服务器进程可以立即用于托管新的游戏会话。

如果服务器进程将在游戏会话停止后关闭，则不会调用此操作。取而代之的是，调用ProcessEnding()表示游戏会话和服务器进程都将结束。

语法

FGameLiftGenericOutcome TerminateGameSession()

参数

此操作没有参数。

返回值

返回由成功或失败组成的通用结果，并显示错误消息。

UpdatePlayerSessionCreationPolicy()

更新当前游戏会话接受新玩家会话的能力。可将游戏会话设置为接受或拒绝所有新的玩家会话。(另请参阅 UpdateGameSession() 服务 API 参考 中的 操作)。

语法

FGameLiftGenericOutcome UpdatePlayerSessionCreationPolicy(EPlayerSessionCreationPolicy policy)

参数

返回值

返回由成功或失败组成的通用结果，并显示错误消息。