适用于 Go 的 Amazon GameLift 服务器 SDK：数据类型 - Amazon GameLift
LogParametersProcessParametersUpdateGameSessionGameSession服务器参数StartMatchBackfillRequest玩家DescribePlayerSessionsRequestStopMatchBackfillRequest获取实例集角色凭证申请

适用于 Go 的 Amazon GameLift 服务器 SDK：数据类型

使用 Amazon GameLift Go 服务器 SDK 5.x 参考将要托管的多人游戏与 Amazon GameLift 集成。有关集成过程的指南，请参阅将 Amazon GameLift 添加到您的游戏服务器。

GameLiftServerAPI.go定义了 Go 服务器软件开发工具包 操作。

适用于 Go 的 Amazon GameLift 服务器 SDK：操作

LogParameters

一个对象，用于标识游戏会话期间生成的文件，您希望 Amazon GameLift 在游戏会话结束后上传和存储这些文件。游戏服务器在调用中作为对象的一部分提供LogParameters给 Amazon GameLift。ProcessParameters ProcessReady()

属性

 描述
LogPaths

您希望 用于存储供以后访问的游戏服务器日志文件的目录路径列表。服务器进程在每个游戏会话期间生成这些文件。文件路径和名称在游戏服务器中定义并存储在根游戏构建目录中。

日志路径必须是绝对的。例如，如果您的游戏构建在类似于 MyGame\sessionLogs\ 的路径中存储游戏会话日志，则日志路径将为 (在 Windows 实例上) 或 (在 Linux 实例上)。

类型：[]string

必需：否

ProcessParameters

描述服务器进程与 Amazon GameLift 之间通信的对象。服务器进程通过调用将此信息提供给 Amazon GameLift。ProcessReady()

属性

 描述
LogParameters 一个对象，其中包含游戏会话期间生成的文件的目录路径。 Amazon GameLift 会复制并存储文件以备将来访问。

类型：LogParameters

必需：否
OnHealthCheck 服务调用以从服务器进程请求运行状态报告的回调函数的名称。 Amazon GameLift 每 60 秒调用一次此函数，并等待 60 秒等待响应。TRUE如果运行状况良好，则服务器进程会返回，FALSE如果不健康，则返回。如果没有返回任何响应，Amazon GameLift 会将服务器进程记录为运行状况不佳。

类型：OnHealthCheck func() bool

必需：否
OnProcessTerminate Amazon GameLift 为强制关闭服务器进程而调用的回调函数。调用此函数之后， 等待五分钟以便服务器进程关闭，然后使用 调用响应，再关闭服务器进程。

类型：OnProcessTerminate func()

必需：是
OnStartGameSession Amazon GameLift 调用的回调函数，用于将更新的游戏会话对象传递给服务器进程。当处理匹配回填请求以提供更新的对战构建器数据时，Amazon GameLift 会调用此函数。它将传递一个 GameSession 对象、一个状态更新（updateReason）以及对战回填票证 ID。

类型：OnStartGameSession func (model.GameSession )

必需：是
OnUpdateGameSession Amazon GameLift 调用的回调函数，用于将更新的游戏会话信息传递给服务器进程。Amazon GameLift 在处理匹配回填请求后调用此函数，以提供更新的对战构建器数据。

类型：OnUpdateGameSession func (model.UpdateGameSession)

必需：否
Port 服务器进程用于侦听新玩家连接的端口号。该值必须在部署此游戏服务器构建的任意实例集上所配置的端口范围内。此端口号包含在游戏会话和玩家会话对象中，游戏会话在连接到服务器进程时会使用该端口号。

类型：int

必需：是

UpdateGameSession

游戏会话对象的更新，包括更新游戏会话的原因，以及相关的回填票证 ID（如果使用回填填填填充游戏会话中的玩家会话）。

属性 描述
GameSession 一个 GameSession 对象。该GameSession对象包含描述游戏会话的属性。

类型：GameSession GameSession()

必需：是
更新原因 更新游戏会话的原因。

类型：UpdateReason UpdateReason()

必需：是
backfilltTicketID 尝试更新游戏会话的回填票证的 ID。

类型：String

必需：否

GameSession

游戏会话的详细信息。

属性 描述
GameSessionId

会话的唯一标识符。arn:aws:gamelift:<region>::gamesession/<fleet ID>/<custom ID string or idempotency token> 事件具有以下 Amazon 资源名称 (ARN) 格式。

类型：String

必需：否
名称

游戏会话的描述性标签。

类型：String

必需：否
FleetId

运行游戏会话的集的唯一标识符。

类型：String

必需：否
最大玩家会话数

机群中已连接到游戏会话的玩家数量。

类型：Integer

必需：否
端口

游戏会话的端口号。要连接到 Amazon GameLift 游戏服务器，应用程序需要 IP 地址和端口号。

类型：Integer

必需：否
IpAddress

游戏会话的 IP 地址。要连接到 Amazon GameLift 游戏服务器，应用程序需要 IP 地址和端口号。

类型：String

必需：否
GameSessionData

一组自定义游戏会话属性，采用单个字符串值格式。

类型：String

必需：否
MatchmakerData

有关用于创建游戏会话的对战过程的信息，采用 JSON 语法，格式为字符串。除了使用的对战配置外，它还包含分配到对战的所有玩家的数据，包括玩家属性和队伍分配。

类型：String

必需：否
GameProperties

游戏会话的一组自定义属性，采用键值对格式。这些属性将通过启动新游戏会话的请求传递到游戏服务器进程。

类型：map[string] string

必需：否
DnsName

分配给正在运行游戏会话的实例的 DNS 标识符。CRL 采用以下格式：

  • 支持 TLS 的实例集:. <unique identifier>.<region identifier>.amazongamelift.com

  • 未启用 TLS 的实例集:. ec2-<unique identifier>.compute.amazonaws.com

连接到在支持 TLS 的队列上运行的游戏会话时，必须使用 DNS 名称，而不是 IP 地址。

类型：String

必需：否

服务器参数

用于维护 Amazon GameLift Anywhere 服务器与 Amazon GameLift 服务之间连接的信息。使用启动新的服务器进程时会使用此信息InitSDK()。对于托管在 Amazon GameLift 托管 EC2 实例上的服务器，请使用空对象。

属性 描述
WebSocketURL

当您对 Amazon GameLift Anywhere 计算资源执行 RegisterCompute 操作时，Amazon GameLift 返回的 GameLiftServerSdkEndpoint。

类型：string

必需：是
ProcessID

注册到托管游戏的服务器进程的唯一标识符。

类型：string

必需：是
HostID

托管新服务器进程的计算资源的唯一标识符。

HostID是在您注册计算机时ComputeName使用的。有关更多信息，请参阅注册计算。

类型：string

必需：是
FleetID 计算注册到的实例集的唯一标识符。有关更多信息，请参阅注册计算。

类型：string

必需：是
AuthToken 由 Amazon GameLift 生成的身份验证令牌，用于向 Amazon GameLift 验证您的服务器。有关更多信息，请参阅 getComputeAut hToken。

类型：string

必需：是

StartMatchBackfillRequest

用于创建对战回填请求的信息。游戏服务器通过 StartMatchBackfill() 调用将这些信息传达给 Amazon GameLift。

属性 描述
GameSessionArn

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

类型：String

必需：是
MatchmakingConfigurationArn

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

类型：String

必需：是
玩家

一组表示当前正在游戏会话中的所有玩家的数据。对战构建器使用此信息搜索与当前玩家非常匹配的新玩家。

类型：[]model.Player

必需：是
TicketId

对战或匹配回填请求票证的唯一标识符。如果不提供值，Amazon GameLift 会生成值。使用此标识符可跟踪匹配回填票证状态或取消请求 (如需要)。

类型：String

必需：否

玩家

表示对战中的玩家的对象。当对战请求开始时，玩家会有玩家 ID、属性，可能还有延迟数据。对战结束后， Amazon GameLift 会添加团队信息。

属性 描述
Latencyinms

一组以毫秒为单位的值，表示玩家在连接到某个位置时所经历的延迟量。

如果使用此属性，则仅匹配列出的位置的玩家。如果对战构建器具有评估玩家延迟的规则，玩家必须报告延迟才能进行匹配。

类型：map[string] int

必需：否
玩家属性

键/值对的集合，其中包含用于对战的玩家信息。玩家属性键必须与对战规则集中使用的玩家属性相匹配。

有关玩家属性的更多信息，请参阅 Atri buteValue。

类型：map[string] AttributeValue

必需：否
PlayerId

玩家的唯一标识符。

类型：String

必需：否
团队

玩家在对战中被分配到的团队的名称。您可以在对战规则集中定义团队名称。

类型：String

必需：否

DescribePlayerSessionsRequest

一个对象，用于指定要检索哪些玩家会话。服务器进程通过DescribePlayerSessions()调用 Amazon GameLift 来提供这些信息。

属性 描述
GameSessionID

游戏会话的唯一标识符。使用此参数可请求指定游戏会话的所有玩家会话。

游戏会话 ID 的格式为arn:aws:gamelift:<region>::gamesession/fleet-<fleet ID>/<ID string>。GameSessionID是自定义 ID 字符串或生成的字符串。

类型：String

必需：否
PlayerSessionID

玩家会话的唯一标识符。使用此参数请求单个特定的玩家会话。

类型：String

必需：否
PlayerID

玩家的唯一标识符。使用此参数可请求指定游戏会话的所有玩家会话。请参阅生成玩家 ID。

类型：String

必需：否
PlayerSessionStatusFilter

用于筛选结果的玩家会话状态。可能的玩家会话状态包括以下内容：

  • RESERVED - 已收到玩家会话请求，但玩家尚未连接到服务器进程和/或进行验证。

  • ACTIVE - 服务器进程已验证玩家，当前已连接。

  • COMPLETED - 玩家连接已断开。

  • TIMEDOUT - 收到了玩家会话请求，但玩家未连接和/或在超时限制 (60 秒) 内验证。

类型：String

必需：否
NextToken

令牌指示结果的下一个连续页面的开头。要指定结果集的开始，请不要指定值。如果指定玩家会话 ID，将忽略此参数。

类型：String

必需：否
Limit

要返回的最大结果数量。如果指定玩家会话 ID，将忽略此参数。

类型：int

必需：否

StopMatchBackfillRequest

用于取消对战回填请求的信息。游戏服务器通过电话将这些信息传达给 Amazon GameLift 服务。StopMatchBackfill()

属性 描述
GameSessionArn

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

类型：string

必需：否
MatchmakingConfigurationArn

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

类型：string

必需：否
TicketId

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

类型：string

必需：否

获取实例集角色凭证申请

将对AWS资源的有限访问权限扩展到游戏服务器的角色证书。有关更多信息，请参阅为 Amazon GameLift 设置 IAM 服务角色。

属性 描述
RoleArn 将有限访问权限扩展到您的AWS资源的服务角色的 ARN。

类型：string

必需：是
roleSessionName 描述角色证书使用情况的会话名称。

类型：string

必需：是