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

Amazon GameLift Server API (C#) 参考:操作

此 Amazon GameLift C# 服务器 API 参考可帮助您准备使用 Amazon GameLift 的多人游戏。有关集成过程的详细信息,请参阅 添加 Amazon GameLift 到您的游戏服务器

此 API 在 GameLiftServerAPI.csLogParameters.csProcessParameters.cs 中定义。

AcceptPlayerSession()

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

语法

GenericOutcome AcceptPlayerSession(String playerSessionId)

参数

playerSessionId

当创建了一个新的玩家会话时 GameLift 发出的唯一 ID。玩家会话 ID 在 PlayerSession 对象中指定,作为对 AWS 开发工具包 Amazon GameLift API 操作 StartGameSessionPlacementCreateGameSessionDescribeGameSessionPlacementDescribePlayerSessions 的客户端调用的响应返回。

类型:字符串

必需:否

返回值

返回成功或失败 (包含错误消息) 的一般结果。

示例

此示例演示了处理连接请求的函数,包括验证和拒绝无效的玩家会话 ID。

void ReceiveConnectingPlayerSessionID (Connection connection, String playerSessionId){ var acceptPlayerSessionOutcome = GameLiftServerAPI.AcceptPlayerSession(playerSessionId); if(acceptPlayerSessionOutcome.Success) { connectionToSessionMap.emplace(connection, playerSessionId); connection.Accept(); } else { connection.Reject(acceptPlayerSessionOutcome.Error.ErrorMessage); } }

ActivateGameSession()

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

语法

GenericOutcome ActivateGameSession()

参数

此操作没有参数。

返回值

返回成功或失败 (包含错误消息) 的一般结果。

示例

此示例显示了 ActivateGameSession() 作为 onStartGameSession() 委派函数的一部分调用。

void OnStartGameSession(GameSession gameSession) { // game-specific tasks when starting a new game session, such as loading map // When ready to receive players var activateGameSessionOutcome = GameLiftServerAPI.ActivateGameSession(); }

DescribePlayerSessions()

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

语法

DescribePlayerSessionsOutcome DescribePlayerSessions(DescribePlayerSessionsRequest describePlayerSessionsRequest)

参数

describePlayerSessionsRequest

DescribePlayerSessionsRequest 对象描述要检索的玩家会话。

必需:是

返回值

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

示例

此示例演示了将所有玩家会话主动连接到指定游戏会话的请求。通过省略 NextToken 和将 Limit 值设置为 10,Amazon GameLift 将返回与请求匹配的前 10 个玩家会话记录。

// Set request parameters var describePlayerSessionsRequest = new Aws.GameLift.Server.Model.DescribePlayerSessionsRequest() { GameSessionId = GameLiftServerAPI.GetGameSessionId().Result, //gets the ID for the current game session Limit = 10, PlayerSessionStatusFilter = PlayerSessionStatusMapper.GetNameForPlayerSessionStatus(PlayerSessionStatus.ACTIVE) }; // Call DescribePlayerSessions Aws::GameLift::DescribePlayerSessionsOutcome playerSessionsOutcome = Aws::GameLift::Server::Model::DescribePlayerSessions(describePlayerSessionRequest);

GetGameSessionId()

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

语法

AwsStringOutcome GetGameSessionId()

参数

此操作没有参数。

返回值

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

示例

var getGameSessionIdOutcome = GameLiftServerAPI.GetGameSessionId();

GetSdkVersion()

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

语法

AwsStringOutcome GetSdkVersion()

参数

此操作没有参数。

返回值

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

示例

var getSdkVersionOutcome = GameLiftServerAPI.GetSdkVersion();

GetTerminationTime()

如果终止时间可用,则返回安排服务器进程关闭的时间。收到来自 Amazon GameLift 服务的 onProcessTerminate() 回调后,服务器进程将执行此操作。服务器进程可能出于多种原因而关闭:(1) 进程运行状况不佳,(2) 实例在缩减事件期间被终止,或 (3) 实例由于 Spot 实例中断而终止。

如果该进程已收到 onProcessTerminate() 回调,则返回的值是估计的终止时间 (纪元秒)。如果没有可用的终止时间,则返回的值为 -1,这表示服务器进程可能随时被终止。如果该进程未收到 onProcessTerminate() 回调,则返回的值始终为 -1。了解有关关闭服务器进程的更多信息。

语法

AwsLongOutcome GetTerminationTime()

参数

此操作没有参数。

返回值

如果成功,返回以 AwsLongOutcome 对象返回当前软件开发工具包的版本。该值是终止时间 (纪元秒) 或值 -1。如果不成功,将返回错误消息。

示例

var getTerminationTimeOutcome = GameLiftServerAPI.GetTerminationTime();

InitSDK()

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

语法

InitSDKOutcome InitSDK()

参数

此操作没有参数。

返回值

如果成功,返回 InitSdkOutcome 对象,指示服务器进程已准备好调用 ProcessReady()

示例

var initSDKOutcome = GameLiftServerAPI.InitSDK();

ProcessEnding()

通知 Amazon GameLift 服务,该服务器进程正在关闭。此方法应退出,退出代码为 0;非零退出代码将导致生成一条事件消息,提示进程未完全退出。

语法

GenericOutcome ProcessEnding()

参数

此操作没有参数。

返回值

返回成功或失败 (包含错误消息) 的一般结果。

示例

var processEndingOutcome = GameLiftServerAPI.ProcessEnding();

ProcessReady()

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

语法

GenericOutcome ProcessReady(ProcessParameters processParameters)

参数

processParameters

ProcessParameters 对象,用于传输有关服务器进程的以下信息:

  • 回调方法的名称,在游戏服务器代码中实现,Amazon GameLift 服务调用它来与服务器进程通信。

  • 服务器进程正在侦听的端口号。

  • 您希望 Amazon GameLift 捕获和存储的任何游戏会话特定文件的路径。

必需:是

返回值

返回成功或失败 (包含错误消息) 的一般结果。

示例

此示例说明 ProcessReady() 调用和委派函数实施。

// Set parameters and call ProcessReady var processParams = new ProcessParameters( this.OnGameSession, this.OnProcessTerminate, this.OnHealthCheck, this.OnGameSessionUpdate, port, new LogParameters(new List<string>() // Examples of log and error files written by the game server { "C:\\game\\logs", "C:\\game\\error" }) ); var processReadyOutcome = GameLiftServerAPI.ProcessReady(processParams); // Implement callback functions void OnGameSession(GameSession gameSession) { // game-specific tasks when starting a new game session, such as loading map // When ready to receive players var activateGameSessionOutcome = GameLiftServerAPI.ActivateGameSession(); } void OnProcessTerminate() { // game-specific tasks required to gracefully shut down a game session, // such as notifying players, preserving game state data, and other cleanup var ProcessEndingOutcome = GameLiftServerAPI.ProcessEnding(); GameLiftServerAPI.Destroy(); } bool OnHealthCheck() { bool isHealthy; // complete health evaluation within 60 seconds and set health return isHealthy; }

RemovePlayerSession()

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

语法

GenericOutcome RemovePlayerSession(String playerSessionId)

参数

playerSessionId

当创建了一个新的玩家会话时 GameLift 发出的唯一 ID。玩家会话 ID 在 PlayerSession 对象中指定,作为对 AWS 开发工具包 Amazon GameLift API 操作 StartGameSessionPlacementCreateGameSessionDescribeGameSessionPlacementDescribePlayerSessions 的客户端调用的响应返回。

类型:字符串

必需:否

返回值

返回成功或失败 (包含错误消息) 的一般结果。

示例

Aws::GameLift::GenericOutcome disconnectOutcome = Aws::GameLift::Server::RemovePlayerSession(playerSessionId);

StartMatchBackfill()

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

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

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

语法

StartMatchBackfillOutcome StartMatchBackfill (StartMatchBackfillRequest startBackfillRequest);

参数

StartMatchBackfillRequest

一个 StartMatchBackfillRequest 对象,用于传递以下信息:

  • 要分配给回填请求的票证 ID。此信息是可选的;如果未提供任何 ID,则 Amazon GameLift 将自动生成一个 ID。

  • 要将请求发送到的对战构建器。需要完整的配置 ARN。可从游戏会话的对战构建器数据中获得此值。

  • 正在进行回填的游戏会话的 ID。

  • 游戏会话的当前玩家的可用对战数据。

必需:是

返回值

返回带有匹配回填票证 ID 的 StartMatchBackfillOutcome 对象或包含错误消息的失败。

示例

// Build a backfill request var startBackfillRequest = new AWS.GameLift.Server.Model.StartMatchBackfillRequest() { TicketId = "a ticket ID", //optional MatchmakingConfigurationArn = "the matchmaker configuration ARN", GameSessionId = GameLiftServerAPI.GetGameSessionId().Result, // gets ID for current game session //get player data for all currently connected players MatchmakerData matchmakerData = MatchmakerData.FromJson(gameSession.MatchmakerData); // gets matchmaker data for current players // get matchmakerData.Players // remove data for players who are no longer connected Players = ListOfPlayersRemainingInTheGame }; // Send backfill request var startBackfillOutcome = GameLiftServerAPI.StartMatchBackfill(startBackfillRequest); // Implement callback function for backfill void OnUpdateGameSession(GameSession myGameSession) { // game-specific tasks to prepare for the newly matched players and update matchmaker data as needed }

StopMatchBackfill()

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

语法

GenericOutcome StopMatchBackfill (StopMatchBackfillRequest stopBackfillRequest);

参数

StopMatchBackfillRequest

一个 StopMatchBackfillRequest 对象,用于识别要取消的对战票证:

  • 分配给被取消的回填请求的票证 ID

  • 回填请求所发送到的对战构建器

  • 与回填请求关联的游戏会话

必需:是

返回值

返回成功或失败 (包含错误消息) 的一般结果。

示例

// Set backfill stop request parameters var stopBackfillRequest = new AWS.GameLift.Server.Model.StopMatchBackfillRequest() { TicketId = "a ticket ID", //optional, if not provided one is autogenerated MatchmakingConfigurationArn = "the matchmaker configuration ARN", //from the game session matchmaker data GameSessionId = GameLiftServerAPI.GetGameSessionId().Result //gets the ID for the current game session }; var stopBackfillOutcome = GameLiftServerAPI.StopMatchBackfillRequest(stopBackfillRequest);

TerminateGameSession()

通知 Amazon GameLift 服务,服务器进程已关闭游戏会话。(目前,每个服务器进程一次仅托管一个游戏会话,因此您无需指定哪个会话。) 此操作应在游戏会话关闭进程结束时调用。调用此操作后,服务器进程可以调用 ProcessReady() 以发送其承载新游戏会话的可用性信号。它也可以调用 ProcessEnding() 以关闭服务器进程并终止实例。

语法

GenericOutcome TerminateGameSession()

参数

此操作没有参数。

返回值

返回成功或失败 (包含错误消息) 的一般结果。

示例

此示例说明了游戏会话结束时的服务器进程。

// game-specific tasks required to gracefully shut down a game session, // such as notifying players, preserving game state data, and other cleanup var terminateGameSessionOutcome = GameLiftServerAPI.TerminateGameSession(); var processReadyOutcome = GameLiftServerAPI.ProcessReady(processParams);

UpdatePlayerSessionCreationPolicy()

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

语法

GenericOutcome UpdatePlayerSessionCreationPolicy(PlayerSessionCreationPolicy playerSessionPolicy)

参数

newPlayerSessionPolicy

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

类型: PlayerSessionCreationPolicy 枚举。有效值包括:

  • ACCEPT_ALL – 接受所有新玩家会话。

  • DENY_ALL – 拒绝所有新玩家会话。

必需:是

返回值

返回成功或失败 (包含错误消息) 的一般结果。

示例

此示例将当前游戏会话的接入策略设为接受所有玩家。

var updatePlayerSessionCreationPolicyOutcomex = GameLiftServerAPI.UpdatePlayerSessionCreationPolicy(PlayerSessionCreationPolicy.ACCEPT_ALL);