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

适用于 Unreal Engine 的 Amazon GameLift 服务器 API 参考:数据类型

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

此 API 在 GameLiftServerSDK.hGameLiftServerSDKModels.h 中定义。

设置 Unreal Engine 插件并查看代码示例将 Amazon GameLift 添加到 Unreal Engine 游戏服务器项目

FProcessParameters

此数据类型包含一组在 ProcessReady() 调用中发送到 Amazon GameLift 服务的参数。

内容

port (远程调试端口)

服务器进程侦听新玩家连接的端口号。该值必须在部署此游戏服务器生成包的任意队组上所配置的端口范围内。此端口号包含在游戏会话和玩家会话对象中,游戏会话在连接到服务器进程时使用。

类型:整数

必需:是

logParameters

包含游戏会话日志文件目录路径列表的对象。

类型:TArray<FString>

必需:否

onStartGameSession

Amazon GameLift 为了激活新的游戏会话而调用的回调函数的名称。Amazon GameLift 调用此函数以响应客户端请求 CreateGameSession。回调函数采用 GameSession 对象(在 Amazon GameLift 服务 API 参考 中定义)。

类型:FOnStartGameSession

必需:是

onProcessTerminate

Amazon GameLift 服务调用用于强制关闭服务器进程的回调函数的名称。调用此函数之后,Amazon GameLift 等待五分钟以便服务器进程关闭,然后使用 ProcessEnding() 调用响应,再关闭服务器进程。

类型:FSimpleDelegate

必需:否

onHealthCheck

Amazon GameLift 服务为了向服务器进程请求运行状况报告而调用的回调函数的名称。Amazon GameLift 每隔 60 秒调用此函数一次。调用此函数后,Amazon GameLift 将等待 60 秒接收响应,如果未收到响应,则会将服务器进程记录为不正常。

类型:FOnHealthCheck

必需:否

FStartMatchBackfillRequest

此数据类型用于发送对战回填请求。此信息在 StartMatchBackfill() 调用中传递给 Amazon GameLift 服务。

内容

GameSessionArn

游戏会话的唯一标识符。此 API 操作 GetGameSessionId() 返回采用 ARN 格式的标识符。

类型:FString

必需:是

MatchmakingConfigurationArn

采用 ARN 格式的唯一标识符,适用于用于此请求的对战构建器。要查找用于创建原始游戏会话的对战构建器,请查看对战构建器数据属性中的游戏会话对象。在使用对战构建器数据中了解有关对战构建器数据的更多信息。

类型:FString

必需:是

玩家

一组表示当前正在游戏会话中的所有玩家的数据。对战构建器使用此信息搜索与当前玩家非常匹配的新玩家。有关玩家对象格式的描述,请参阅 Amazon GameLift API 参考指南。要查找玩家属性、ID 和团队任务,请查看对战构建器数据属性中的游戏会话对象。如果对战构建器使用了延迟,则收集当前区域中更新的延迟并将其包含在每个玩家的数据中。

类型:TArray<FPlayer>

必需:是

TicketId

对战或匹配回填请求票证的唯一标识符。如果此处未提供任何值,则 Amazon GameLift 将生成一个采用 UUID 形式的值。使用此标识符可跟踪匹配回填票证状态或取消请求 (如需要)。

类型:FString

必需:否

FStopMatchBackfillRequest

此数据类型用于取消对战回填请求。此信息在 StopMatchBackfill() 调用中传递给 Amazon GameLift 服务。

内容

GameSessionArn

与被取消的请求关联的唯一游戏会话标识符。

类型:FString

必需:是

MatchmakingConfigurationArn

此请求发送到的对战构建器的唯一标识符。

类型:FString

必需:是

TicketId

要取消的回填请求票证的唯一标识符。

类型:FString

必需:是