本文属于机器翻译版本。若本译文内容与英语原文存在差异,则一律以英文原文为准。
亚马逊GameLift服务器虚幻引擎SDK参考资料:数据类型
这份 Amazon S GameLift erver SDK 参考资料可以帮助你准备虚幻引擎游戏项目,以便在亚马逊上使用GameLift。有关集成过程的详细信息,请参阅 将亚马逊GameLift添加到您的游戏服务器。
此 API 在 GameLiftServerSDK.h
和 GameLiftServerSDKModels.h
中定义。
设置 Unreal Engine 插件并查看代码示例整合亚马逊GameLift进入虚幻引擎项目。
-
数据类型
F DescribePlayerSessionsRequest
此数据类型用于指定检索哪些玩家会话。您可以按如下方式使用它:
-
提供 a PlayerSessionId 以请求特定的玩家会话。
-
GameSessionId提供请求指定游戏会话中的所有玩家会话。
-
提供 a PlayerId 以请求指定玩家的所有玩家会话。
对于大型玩家会话集合,请使用分页参数以在有序数据块中检索结果。
目录
- GameSessionId
-
游戏会话的唯一标识符。使用此参数可请求指定游戏会话的所有玩家会话。游戏会话 ID 的格式如下所示:
arn:aws:gamelift:<region>::gamesession/fleet-<fleet ID>/<ID string>
。<ID string> 的值为自定义 ID 字符串(如果在创建游戏会话时指定了一个)或者是生成的字符串。类型:字符串
必需:否
- 限制
-
要返回的最大结果数量。将此参数与一起使用NextToken以一组连续页面的形式获取结果。如果指定玩家会话 ID,将忽略此参数。
类型:整数
必需:否
- NextToken
-
令牌指示结果的下一个连续页面的开头。使用之前的调用返回此操作的令牌。要指定结果集的开始,请不要指定值。如果指定玩家会话 ID,将忽略此参数。
类型:字符串
必需:否
- PlayerId
-
玩家的唯一标识符。玩家 ID 由开发人员定义。请参阅生成玩家 ID。
类型:字符串
必需:否
- PlayerSessionId
-
玩家会话的唯一标识符。
类型:字符串
必需:否
- PlayerSessionStatusFilter
-
用于筛选结果的玩家会话状态。可能的玩家会话状态包括以下内容:
-
RESERVED - 已收到玩家会话请求,但玩家尚未连接到服务器进程和/或进行验证。
-
ACTIVE - 服务器进程已验证玩家,当前已连接。
-
COMPLETED - 玩家连接已断开。
-
TIMEDOUT - 收到了玩家会话请求,但玩家未连接和/或在超时限制 (60 秒) 内验证。
类型:字符串
必需:否
-
F ProcessParameters
此数据类型包含在ProcessReady()调用中发送到 Amazon GameLift 服务的一组参数。
目录
- port
-
服务器进程侦听新玩家连接的端口号。该值必须在部署此游戏服务器生成包的任意队组上所配置的端口范围内。此端口号包含在游戏会话和玩家会话对象中,游戏会话在连接到服务器进程时使用。
类型:整数
必需:是
- logParameters
-
包含游戏会话日志文件目录路径列表的对象。
类型:TArray<FString>
必需:否
- onStartGame会话
-
亚马逊GameLift服务为激活新游戏会话而调用的回调函数的名称。亚马逊GameLift调用此函数是为了响应客户端的请求CreateGameSession。回调函数接受一个GameSession对象(在亚马逊GameLift服务 API 参考中定义)。
类型:F OnStartGameSession
必需:是
- onProcessTerminate
-
Amazon GameLift 服务为强制关闭服务器进程而调用的回调函数的名称。调用此函数后,Amazon 会GameLift等待五分钟让服务器进程关闭,然后通过ProcessEnding()呼叫进行响应,然后才关闭服务器进程。
类型:F SimpleDelegate
必需:否
- onHealthCheck
-
Amazon GameLift 服务为从服务器进程请求健康状态报告而调用的回调函数的名称。亚马逊每 60 秒GameLift调用一次此函数。调用此函数后,Am GameLift azon 等待 60 秒钟等待响应,如果没有收到任何响应。将服务器进程记录为不正常。
类型:F OnHealthCheck
必需:否
- onUpdateGame会话
-
Amazon GameLift 服务为将更新的游戏会话对象传递给服务器进程而调用的回调函数的名称。当处理匹配回填请求以提供更新的匹配器数据时,亚马逊会GameLift调用此函数。它传递GameSession对象、状态更新 (
updateReason
) 和匹配回填票证 ID。类型:F OnUpdateGameSession
必需:否
F StartMatchBackfillRequest
此数据类型用于发送对战回填请求。该信息通过StartMatchBackfill()电话传达给亚马逊GameLift服务。
目录
- GameSessionArn
-
游戏会话的唯一标识符。此 API 操作 GetGameSessionId() 返回采用 ARN 格式的标识符。
类型:FString
必需:是
- MatchmakingConfigurationArn
-
采用 ARN 格式的唯一标识符,适用于用于此请求的对战构建器。要查找用于创建原始游戏会话的对战构建器,请查看对战构建器数据属性中的游戏会话对象。在 “使用媒人数据” 中了解有关媒人数据的更多信息.
类型:FString
必需:是
- 玩家
-
一组表示当前正在游戏会话中的所有玩家的数据。对战构建器使用此信息搜索与当前玩家非常匹配的新玩家。有关玩家对象格式的描述,请参阅亚马逊 GameLift API 参考指南。要查找玩家属性、ID 和团队任务,请查看对战构建器数据属性中的游戏会话对象。如果对战构建器使用了延迟,则收集当前区域中更新的延迟并将其包含在每个玩家的数据中。
类型:TArray<FPlayer>
必需:是
- TicketId
-
对战或匹配回填请求票证的唯一标识符。如果此处未提供任何值,亚马逊GameLift将以 UUID 的形式生成。使用此标识符可跟踪匹配回填票证状态或取消请求 (如需要)。
类型:FString
必需:否
F StopMatchBackfillRequest
此数据类型用于取消对战回填请求。该信息通过StopMatchBackfill()电话传达给亚马逊GameLift服务。
目录
- GameSessionArn
-
与被取消的请求关联的唯一游戏会话标识符。
类型:FString
必需:是
- MatchmakingConfigurationArn
-
此请求发送到的对战构建器的唯一标识符。
类型:FString
必需:是
- TicketId
-
要取消的回填请求票证的唯一标识符。
类型:FString
必需:是