适用于 C# 的 Amazon GameLift 服务器 SDK 4.x：操作

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

适用于 C# 的 Amazon GameLift 服务器 SDK 4.x：数据类型

AcceptPlayerSession()

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

语法

GenericOutcome AcceptPlayerSession(String playerSessionId)

参数

返回值

返回由成功或失败组成的通用结果，并显示错误消息。

示例

此示例演示了处理连接请求的函数，包括验证和拒绝无效的玩家会话 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()

通知 服务，服务器进程已激活游戏会话，现在已准备好接收玩家连接。此操作应作为 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)

参数

返回值

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

示例

此示例演示了将所有玩家会话主动连接到指定游戏会话的请求。通过省略 NextToken 和将 Limit 值设置为 10， 将返回与请求匹配的前 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 (如果服务器进程处于活动状态)。

对于尚未通过游戏会话激活的空闲进程，该调用返回 Success = True 和 GameSessionId =""（空字符串）。

语法

AwsStringOutcome GetGameSessionId()

参数

此操作没有参数。

返回值

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

示例

var getGameSessionIdOutcome = GameLiftServerAPI.GetGameSessionId();

GetInstanceCertificate()

检索与队列及其实例关联的 PEM 编码 TLS 证书的文件位置。 AWS Certificate Manager当您在证书配置设置为 GENERATED 的情况下创建新队列时，将生成此证书。使用此证书可与游戏客户端建立安全连接并加密客户端/服务器通信。

语法

GetInstanceCertificateOutcome GetInstanceCertificate();

参数

此操作没有参数。

返回值

如果成功，则返回一个 GetInstanceCertificateOutcome 对象，该对象包含实例集的 TLS 证书文件的位置（该证书文件存储在实例上）。从证书链中提取的根证书文件也存储在实例上。如果不成功，将返回错误消息。

有关证书和证书链数据的更多信息，请参阅 AWS Certificate Manager API 参考中的获取证书响应元素。

示例

var getInstanceCertificateOutcome = GameLiftServerAPI.GetInstanceCertificate();

GetSdkVersion()

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

语法

AwsStringOutcome GetSdkVersion()

参数

此操作没有参数。

返回值

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

示例

var getSdkVersionOutcome = GameLiftServerAPI.GetSdkVersion(); 

GetTerminationTime()

如果终止时间可用，则返回安排服务器进程关闭的时间。收到来自 服务的 回调后，服务器进程将执行此操作。Amazon GameLift 可能出于以下原因onProcessTerminate()调用：(1) 运行状况不佳（服务器进程已报告端口运行状况或未对 Amazon GameLift 做出响应），(2) 在缩小规模事件期间终止实例时，或 (3) 由于现货实例中断而终止实例时。

如果该进程已收到 onProcessTerminate() 回调，则返回的值是估计的终止时间 (纪元秒)。如果进程未收到onProcessTerminate()回调，则会返回一条错误消息。了解有关关闭服务器进程的更多信息。

语法

AwsDateTimeOutcome GetTerminationTime()

参数

此操作没有参数。

返回值

如果成功，则以AwsDateTimeOutcome对象形式返回终止时间。该值是终止时间，以自 0001 00:00:00 起经过的报价表示。例如，日期时间值 2020-09-13 12:26:40-000Z 等于 637355968000000000 滴答作响。如果没有可用的终止时间，将返回一条错误消息。

示例

var getTerminationTimeOutcome = GameLiftServerAPI.GetTerminationTime(); 

InitSDK()

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

语法

InitSDKOutcome InitSDK()

参数

此操作没有参数。

返回值

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

示例

var initSDKOutcome = GameLiftServerAPI.InitSDK(); 

ProcessEnding()

通知 服务，该服务器进程正在关闭。应在所有其他清除任务 (包括关闭所有活动游戏会话) 之后调用此方法。此方法应退出，退出代码为 0；非零退出代码将导致生成一条事件消息，提示进程未完全退出。

当该方法以代码为 0 退出后，您可以使用成功的退出代码终止该进程。您也可以退出，并返回错误代码。如果您退出时出现错误代码，则队列事件将指示进程异常终止（SERVER_PROCESS_TERMINATED_UNHEALTHY）。

语法

GenericOutcome ProcessEnding()

参数

此操作没有参数。

返回值

返回由成功或失败组成的通用结果，并显示错误消息。

示例

var processEndingOutcome = GameLiftServerAPI.ProcessEnding();
if (processReadyOutcome.Success)
   Environment.Exit(0);
// otherwise, exit with error code
Environment.Exit(errorCode);
    

ProcessReady()

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

语法

GenericOutcome ProcessReady(ProcessParameters processParameters)

参数

返回值

返回由成功或失败组成的通用结果，并显示错误消息。

示例

此示例说明 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();
}

bool OnHealthCheck()
{
    bool isHealthy;
    // complete health evaluation within 60 seconds and set health
    return isHealthy;
}

RemovePlayerSession()

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

语法

GenericOutcome RemovePlayerSession(String playerSessionId)

参数

返回值

返回由成功或失败组成的通用结果，并显示错误消息。

示例

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

StartMatchBackfill()

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

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

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

语法

StartMatchBackfillOutcome StartMatchBackfill (StartMatchBackfillRequest startBackfillRequest);

参数

返回值

返回带有匹配回填票证 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 SDK 操作 StopMatchmaking()。在中了解有关 FlexMatch 回填功能的更多信息。

语法

GenericOutcome StopMatchBackfill (StopMatchBackfillRequest stopBackfillRequest);

参数

返回值

返回由成功或失败组成的通用结果，并显示错误消息。

示例

// 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()

4.0.1 相反，服务器进程应在游戏会话结束ProcessEnding()后调用。

通知 Amazon GameLift 服务服务器进程已结束当前游戏会话。当服务器进程保持活动状态并准备托管新游戏会话时，将调用此操作。只有在游戏会话终止程序完成后才应调用它，因为它会向 Amazon GameLift 发出信号，表明服务器进程可以立即用于托管新的游戏会话。

如果服务器进程将在游戏会话停止后关闭，则不会调用此操作。取而代之的是，调用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)

参数

返回值

返回由成功或失败组成的通用结果，并显示错误消息。

示例

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

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