适用于 C# 和 Unity 的亚马逊 GameLift 服务器SDK参考：数据类型

此 Amazon GameLift C# Server SDK 参考资料可以帮助您为多人游戏做好准备，以便在亚马逊上使用 GameLift。有关集成过程的详细信息，请参阅将 Amazon GameLift 添加到您的游戏服务器；有关使用适用于 Unity 的 C# 服务器SDK插件的信息，请参阅将 Amazon GameLift 集成到 Unity 项目中。

LogParameters

使用此数据类型来识别在游戏会话期间生成的哪些文件您希望游戏服务器在游戏会话结束 GameLift 后将其上传到 Amazon。游戏服务器通过通ProcessReady()话与 LogParameters to Amazon GameLift 通信。

属性

描述

LogPaths

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

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

类型：List<String>

必需：否

ProcessParameters

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

属性	描述
LogParameters	包含游戏会话日志文件目录路径列表的对象。类型：`Aws::GameLift::Server::LogParameters` 必需：是
OnHealthCheck	Amazon 为向服务器进程请求运行状况报告而调 GameLift 用的回调函数的名称。亚马逊每 60 秒 GameLift 调用一次此函数。调用此函数后，Amazon 会等待 60 秒 GameLift 等待响应，如果未收到任何响应，Amazon 会将服务器进程 GameLift 记录为运行状况不佳。类型：`void OnHealthCheckDelegate()` 必需：是
OnProcessTerminate	Amazon 为强制关闭服务器进程而调 GameLift 用的回调函数的名称。调用此函数后，Amazon 会 GameLift 等待五分钟，等待服务器进程关闭并通过ProcessEnding()调用进行响应，然后再关闭服务器进程。类型：`void OnProcessTerminateDelegate()` 必需：是
OnStartGameSession	Amazon 为激活新游戏会 GameLift 话而调用的回调函数的名称。Amazon GameLift 调用此函数是为了响应客户请求CreateGameSession。回调函数接受一个GameSession对象。类型：`void OnStartGameSessionDelegate(GameSession)` 必需：是
OnUpdateGameSession	Amazon 为将更新的游戏会话对象传递给服务器进程而调 GameLift 用的回调函数的名称。当已处理匹配回填请求以提供更新的匹配器数据时，Amazon会 GameLift 调用此函数。它传递一个GameSession对象、一个状态更新 (`updateReason`) 和匹配回填票证 ID。类型：void OnUpdateGameSessionDelegate (UpdateGameSession) 必需：否
端口	服务器进程用于侦听新玩家连接的端口号。该值必须在部署此游戏服务器构建的任意实例集上所配置的端口范围内。此端口号包含在游戏会话和玩家会话对象中，游戏会话在连接到服务器进程时使用。类型：`Integer` 必需：是

UpdateGameSession

更新了游戏会话对象的信息，包括更新游戏会话的原因。如果更新与匹配回填操作相关，则此数据类型包括回填票证 ID。

属性描述

GameSession

属性	描述
GameSession	一个 GameSession 对象。该`GameSession`对象包含描述游戏会话的属性。类型：`GameSession GameSession()` 必需：是
UpdateReason	更新游戏会话的原因。类型：`UpdateReason UpdateReason()` 必需：是
BackfillTicketId	尝试更新游戏会话的回填票证的 ID。类型：`String` 必需：是

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

类型：GameSession GameSession()

必需：是

UpdateReason

更新游戏会话的原因。

类型：UpdateReason UpdateReason()

必需：是

BackfillTicketId

尝试更新游戏会话的回填票证的 ID。

类型：String

必需：是

GameSession

游戏会话的详细信息。

属性	描述
GameSessionId	会话的唯一标识符。游戏会话ARN采用以下格式:`arn:aws:gamelift:<region>::gamesession/<fleet ID>/<custom ID string or idempotency token>`. 类型：`String` 必需：否
名称	游戏会话的描述性标签。类型：`String` 必需：否
FleetId	运行游戏会话的集的唯一标识符。类型：`String` 必需：否
MaximumPlayerSessionCount	机群中已连接到游戏会话的玩家数量。类型：`Integer` 必需：否
端口	游戏会话的端口号。要连接到 Amazon GameLift 游戏服务器，应用程序需要 IP 地址和端口号。类型：`Integer` 必需：否
IpAddress	游戏会话的 IP 地址。要连接到 Amazon GameLift 游戏服务器，应用程序需要 IP 地址和端口号。类型：`String` 必需：否
GameSessionData	一组自定义游戏会话属性，采用单个字符串值格式。类型：`String` 必需：否
MatchmakerData	有关用于创建游戏会话的配对过程的信息，JSON语法格式为字符串。除了使用的对战配置外，它还包含分配到对战的所有玩家的数据，包括玩家属性和队伍分配。类型：`String` 必需：否
GameProperties	游戏会话的一组自定义属性，采用键值对格式。这些属性将通过启动新游戏会话的请求传递到游戏服务器进程。类型：`Dictionary<string, string>` 必需：否
DnsName	分配给正在运行游戏会话的实例的DNS标识符。CRL 采用以下格式： TLS-已启用的舰队：。`<unique identifier>.<region identifier>.amazongamelift.com` 未TLS启用的舰队:. `ec2-<unique identifier>.compute.amazonaws.com` 连接到在TLS已启用队列上运行的游戏会话时，必须使用DNS名称，而不是 IP 地址。类型：`String` 必需：否

ServerParameters

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

属性	描述
WebSocketUrl	当您`RegisterCompute`加入 Amazon 时`GameLiftServerSdkEndpoint`返回的 GameLift Anywhere。类型：`String` 必需：是
ProcessId	注册到托管游戏的服务器进程的唯一标识符。类型：`String` 必需：是
HostId	托管游戏的服务器进程的主机的唯一标识符。 hostId 是在您注册计算机时 ComputeName 使用的。欲了解更多信息，请参阅 RegisterCompute 类型：`String` 必需：是
FleetId	计算注册到的队列的实例集 ID。有关更多信息，请参阅RegisterCompute。类型：`String` 必需：是
AuthToken	由亚马逊生成的身份验证令牌 GameLift ，用于向亚马逊 GameLift验证您的服务器。有关更多信息，请参阅GetComputeAuthToken。类型：`String` 必需：是

StartMatchBackfillRequest

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

属性	描述
GameSessionArn	游戏会话的唯一标识符。该API操作以ARN格式`GetGameSessionId`返回标识符。类型：`String` 必需：是
MatchmakingConfigurationArn	匹配器用于此请求的ARN唯一标识符，形式为。原始游戏会话ARN的匹配器位于匹配器数据属性的游戏会话对象中。在使用对战构建器数据中了解有关对战构建器数据的更多信息。类型：`String` 必需：是
玩家	一组表示当前正在游戏会话中的所有玩家的数据。对战构建器使用此信息搜索与当前玩家非常匹配的新玩家。类型：`List<Player>` 必需：是
TicketId	对战或匹配回填请求票证的唯一标识符。如果您不提供值，Amazon GameLift 会生成一个值。使用此标识符可跟踪匹配回填票证状态或取消请求 (如需要)。类型：`String` 必需：否

玩家

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

属性	描述
LatencyInMS	一组以毫秒为单位的值，表示玩家在连接到某个位置时所经历的延迟量。如果使用此属性，则仅匹配列出的位置的玩家。如果对战构建器具有评估玩家延迟的规则，玩家必须报告延迟才能进行匹配。类型：`Dictionary<string, int>` 必需：否
PlayerAttributes	键/值对的集合，其中包含用于对战的玩家信息。玩家属性键必须与配对规则集中 PlayerAttributes 使用的属性密钥相匹配。有关玩家属性的更多信息，请参阅AttributeValue。类型：`Dictionary<string, AttributeValue` 必需：否
PlayerId	玩家的唯一标识符。类型：`String` 必需：否
团队	玩家在对战中被分配到的团队的名称。在对战规则集中定义团队名称。类型：`String` 必需：否

DescribePlayerSessionsRequest

此数据类型用于指定检索哪些玩家会话。它可以通过多种方式使用：(1) 提供 a PlayerSessionId 以请求特定的玩家会话；(2) 提供 a GameSessionId 以请求指定游戏会话中的所有玩家会话；或 (3) 提供 a PlayerId 以请求指定玩家的所有玩家会话。对于大型玩家会话集合，请使用分页参数以连续页面格式检索结果。

属性	描述
GameSessionId	游戏会话的唯一标识符。使用此参数可请求指定游戏会话的所有玩家会话。游戏会话 ID 的格式如下所示：`arn:aws:gamelift:<region>::gamesession/fleet-<fleet ID>/<ID string>`。<ID string> 的值为自定义 ID 字符串（如果在创建游戏会话时指定了一个）或者是生成的字符串。类型：`String` 必需：否
PlayerSessionId	玩家会话的唯一标识符。类型：`String` 必需：否
PlayerId	玩家的唯一标识符。请参阅生成玩家 ID。类型：`String` 必需：否
PlayerSessionStatusFilter	用于筛选结果的玩家会话状态。可能的玩家会话状态包括以下内容： RESERVED— 已收到玩家会话请求，但玩家尚未连接到服务器进程和/或经过验证。 ACTIVE— 该玩家已通过服务器进程验证，并且当前已连接。 COMPLETED— 玩家连接已断开。 TIMEDOUT— 已收到玩家会话请求，但该玩家未连接和/或未在超时限制（60 秒）内通过验证。类型：`String` 必需：否
NextToken	令牌指示结果的下一个连续页面的开头。要指定结果集的开始，请不要指定值。如果指定玩家会话 ID，将忽略此参数。类型：`String` 必需：否
限制	要返回的最大结果数量。如果指定玩家会话 ID，将忽略此参数。类型：`int` 必需：否

StopMatchBackfillRequest

用于取消对战回填请求的信息。游戏服务器通过StopMatchBackfill()呼叫将此信息传送给 Amazon GameLift 服务。

属性描述

GameSessionArn

属性	描述
GameSessionArn	与被取消的请求关联的唯一游戏会话标识符。类型：`string` 必需：是
MatchmakingConfigurationArn	此请求发送到的对战构建器的唯一标识符。类型：`string` 必需：是
TicketId	要取消的回填请求票证的唯一标识符。类型：`string` 必需：是

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

类型：string

必需：是

MatchmakingConfigurationArn

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

类型：string

必需：是

TicketId

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

类型：string

必需：是

GetFleetRoleCredentialsRequest

这种数据类型使游戏服务器只能有限地访问您的其他 AWS 资源。有关更多信息，请参阅为亚马逊设置 IAM 服务角色 GameLift。

属性描述

RoleArn

属性	描述
RoleArn	服务角色的 Amazon 资源名称 (ARN)，用于扩展对您的 AWS 资源的有限访问权限。类型：`string` 必需：是
RoleSessionName	描述角色证书使用情况的会话名称。类型：`string` 必需：否

服务角色的 Amazon 资源名称 (ARN)，用于扩展对您的 AWS 资源的有限访问权限。

类型：string

必需：是

RoleSessionName

描述角色证书使用情况的会话名称。

类型：string

必需：否

AttributeValue

在玩家属性密钥-值对中使用。此对象允许您使用任何有效的数据类型来指定属性值：字符串、数字、字符串数组或数据映射。每个AttributeValue对象只能使用一个可用属性。

属性	描述
attrType	指定属性值的类型。类型：一个枚举值。必需：否
S	表示字符串属性值。类型：`string` 必需：是
否	表示属性值。类型：`double` 必需：是
sl	表示字符串属性值的数组。类型：`string[]` 必需：是
SDM	表示字符串键和双精度值的字典。类型：`Dictionary<string, double>` 必需：是

AwsStringOutcome

此数据类型由操作生成，并生成具有以下属性的对象：

属性描述

结果

属性	描述
结果	操作的结果。类型：`string` 必需：否
成功	操作是否成功。类型：`bool` 必需：是
错误	操作失败时发生的错误。类型：GameLiftError 必需：否

操作的结果。

类型：string

必需：否

成功

操作是否成功。

类型：bool

必需：是

错误

操作失败时发生的错误。

类型：GameLiftError

必需：否

GenericOutcome

此数据类型由操作生成，并生成具有以下属性的对象：

属性描述

成功

属性	描述
成功	操作是否成功。类型：`bool` 必需：是
错误	操作失败时发生的错误。类型：GameLiftError 必需：否

操作是否成功。

类型：bool

必需：是

错误

操作失败时发生的错误。

类型：GameLiftError

必需：否

DescribePlayerSessionsOutcome

此数据类型由操作生成，并生成具有以下属性的对象：

属性描述

结果

属性	描述
结果	操作的结果。类型：DescribePlayerSessionsResult 必需：否
成功	操作是否成功。类型：`bool` 必需：是
错误	操作失败时发生的错误。类型：GameLiftError 必需：否

操作的结果。

类型：DescribePlayerSessionsResult

必需：否

成功

操作是否成功。

类型：bool

必需：是

错误

操作失败时发生的错误。

类型：GameLiftError

必需：否

DescribePlayerSessionsResult

属性	描述
NextToken	令牌指示结果的下一个连续页面的开头。要指定结果集的开始，请不要指定值。如果指定玩家会话 ID，将忽略此参数。类型：`string` 必需：是
PlayerSessions	一组对象，其中包含与请求相匹配的每个玩家会话的属性。类型：`IList<PlayerSession>` 必填
成功	操作是否成功。类型：`bool` 必需：是
错误	操作失败时发生的错误。类型：GameLiftError 必需：否

PlayerSession

属性	描述
CreationTime	类型：`long` 必需：是
FleetId	类型：`string` 必需：是
GameSessionId	类型：`string` 必需：是
IpAddress	类型：`string` 必需：是
PlayerData	类型：`string` 必需：是
PlayerId	类型：`string` 必需：是
PlayerSessionId	类型：`string` 必需：是
端口	类型：`int` 必需：是
Status	类型：`PlayerSessionStatus`枚举。必需：是
TerminationTime	类型：`long` 必需：是
DnsName	类型：`string` 必需：是

StartMatchBackfillOutcome

此数据类型由操作生成，并生成具有以下属性的对象：

属性描述

结果

属性	描述
结果	操作的结果。类型：StartMatchBackfillResult 必需：否
成功	操作是否成功。类型：`bool` 必需：是
错误	操作失败时发生的错误。类型：GameLiftError 必需：否

操作的结果。

类型：StartMatchBackfillResult

必需：否

成功

操作是否成功。

类型：bool

必需：是

错误

操作失败时发生的错误。

类型：GameLiftError

必需：否

StartMatchBackfillResult

属性描述

TicketId

属性	描述
TicketId	类型：`string` 必需：是

类型：string

必需：是

GetComputeCertificateOutcome

此数据类型由操作生成，并生成具有以下属性的对象：

属性描述

结果

属性	描述
结果	操作的结果。类型：GetComputeCertificateResult 必需：否
成功	操作是否成功。类型：`bool` 必需：是
错误	操作失败时发生的错误。类型：GameLiftError 必需：否

操作的结果。

类型：GetComputeCertificateResult

必需：否

成功

操作是否成功。

类型：bool

必需：是

错误

操作失败时发生的错误。

类型：GameLiftError

必需：否

GetComputeCertificateResult

计算机上TLS证书的路径和计算机的主机名。

属性描述

CertificatePath

属性	描述
CertificatePath	类型：`string` 必需：是
ComputeName	类型：`string` 必需：是

类型：string

必需：是

ComputeName

类型：string

必需：是

GetFleetRoleCredentialsOutcome

此数据类型由操作生成，并生成具有以下属性的对象：

属性描述

结果

属性	描述
结果	操作的结果。类型：GetFleetRoleCredentialsResult 必需：否
成功	操作是否成功。类型：`bool` 必需：是
错误	操作失败时发生的错误。类型：GameLiftError 必需：否

操作的结果。

类型：GetFleetRoleCredentialsResult

必需：否

成功

操作是否成功。

类型：bool

必需：是

错误

操作失败时发生的错误。

类型：GameLiftError

必需：否

GetFleetRoleCredentialsResult

属性	描述
AccessKeyId	用于对您的 AWS 资源进行身份验证和提供访问权限的访问密钥 ID。类型：`string` 必需：否
AssumedRoleId	服务角色所属的用户 ID。类型：`string` 必需：否
AssumedRoleUserArn	服务角色所属用户的 Amazon 资源名称 (ARN)。类型：`string` 必需：否
过期	您的会话凭证到期之前的时间。类型：`DateTime` 必需：否
SecretAccessKey	指定 S3 验证的访问密钥 ID。类型：`string` 必需：否
SessionToken	用于识别与您的 AWS 资源交互的当前活动会话的令牌。类型：`string` 必需：否
成功	操作是否成功。类型：`bool` 必需：是
错误	操作失败时发生的错误。类型：GameLiftError 必需：否

AwsDateTimeOutcome

此数据类型由操作生成，并生成具有以下属性的对象：

属性描述

结果

属性	描述
结果	操作的结果。类型：`DateTime` 必需：否
成功	操作是否成功。类型：`bool` 必需：是
错误	操作失败时发生的错误。类型：GameLiftError 必需：否

操作的结果。

类型：DateTime

必需：否

成功

操作是否成功。

类型：bool

必需：是

错误

操作失败时发生的错误。

类型：GameLiftError

必需：否

GameLiftError

属性描述

ErrorType

属性	描述
ErrorType	错误的类型。类型：`GameLiftErrorType`枚举。必需：否
ErrorName	错误类型的名称。类型：`string` 必需：否
ErrorMessage	错误消息。类型：`string` 必需：否

错误的类型。

类型：GameLiftErrorType枚举。

必需：否

ErrorName

错误类型的名称。

类型：string

必需：否

ErrorMessage

错误消息。

类型：string

必需：否

枚举

为 Amazon GameLift 服务器 SDK (C#) 定义的枚举定义如下：

AttrType

NONE
STRING
DOUBLE
STRING_LIST
STRING_DOUBLE_MAP

GameLiftErrorType

表示错误类型的字符串值。有效值包括：

SERVICE_ CALL _ FAILED — 对 AWS 服务的呼叫失败。
LOCAL_ CONNECTION _ FAILED — 与 Amazon 的本地连接 GameLift 失败。
NETWORK_ NOT _ INITIALIZED — 网络尚未初始化。
GAMESESSION_ID_ NOT _ SET — 游戏会话 ID 尚未设置。
BAD_REQUEST_EXCEPTION
INTERNAL_SERVICE_EXCEPTION
ALREADY_ INITIALIZED — Amazon GameLift 服务器或客户端已使用初始化 () 进行初始化。
FLEET_ MISMATCH — 目标舰队与 gameSession 或的舰队不匹配playerSession。
GAMELIFT_ CLIENT NOT _ INITIALIZED — Amazon GameLift 客户端尚未初始化。
GAMELIFT_ SERVER NOT _ INITIALIZED — Amazon GameLift 服务器尚未初始化。
GAME_ SESSION ENDED _ FAILED — Amazon GameLift 服务器SDK无法联系服务以报告游戏会话已结束。
GAME_ SESSION NOT _ READY — Amazon GameLift 服务器游戏会话未激活。
GAME_ SESSION READY _ FAILED — Amazon GameLift 服务器SDK无法联系服务以报告游戏会话已准备就绪。
INITIALIZATION_ MISMATCH — 在 Server:: Initialize () 之后调用了客户端方法，反之亦然。
NOT_ INITIALIZED — 尚未使用初始化 () 初始化 Amazon GameLift 服务器或客户端。
NO TARGET _ ALIASID _ _ SET — aliasId 尚未设定目标。
NO TARGET _ FLEET _ _ SET — 尚未设置目标舰队。
PROCESS_ ENDING _ FAILED — Amazon GameLift 服务器SDK无法联系服务以报告该过程即将结束。
PROCESS_ NOT _ ACTIVE — 服务器进程尚未处于活动状态，未绑定到 GameSession，并且无法接受或处理 PlayerSessions。
PROCESS_ NOT _ READY — 服务器进程尚未准备好激活。
PROCESS_ READY _ FAILED — Amazon GameLift 服务器SDK无法联系服务以报告流程已准备就绪。
SDK_ VERSION DETECTION _ FAILED — SDK 版本检测失败。
STX_ CALL _ FAILED — 对XStx服务器后端组件的调用失败。
STX_ INITIALIZATION _ FAILED — XStx 服务器后端组件初始化失败。
UNEXPECTED_ PLAYER _ SESSION — 服务器遇到了未注册的玩家会话。
WEBSOCKET_CONNECT_FAILURE
WEBSOCKET_CONNECT_FAILURE_FORBIDDEN
WEBSOCKET_CONNECT_FAILURE_INVALID_URL
WEBSOCKET_CONNECT_FAILURE_TIMEOUT
WEBSOCKET_ RETRIABLE _ SEND MESSAGE _ FAILURE — 向 GameLift 服务 WebSocket发送消息失败可重试。
WEBSOCKETSEND_ MESSAGE _ FAILURE — 未能向 GameLift 服务发送消息 WebSocket。
MATCH_ BACKFILL REQUEST _ VALIDATION-请求验证失败。
PLAYER_ SESSION REQUEST _ VALIDATION-请求验证失败。

PlayerSessionCreationPolicy

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

ACCEPT_ ALL — 接受所有新玩家会话。
DENY_ ALL — 拒绝所有新玩家会话。
NOT_ SET — 游戏会话未设置为接受或拒绝新玩家会话。

PlayerSessionStatus

ACTIVE
COMPLETED
NOT_SET
RESERVED
TIMEDOUT

Javascript 在您的浏览器中被禁用或不可用。

要使用 Amazon Web Services 文档，必须启用 Javascript。请参阅浏览器的帮助页面以了解相关说明。

文档惯例

操作

适用于 C# 的服务器软件开发工具包参考 4.x