Amazon Web Services 文档中描述的 Amazon Web Services 服务或功能可能因区域而异。要查看适用于中国区域的差异，请参阅 中国的 Amazon Web Services 服务入门 (PDF)。

本文属于机器翻译版本。若本译文内容与英语原文存在差异，则一律以英文原文为准。

亚马逊GameLift服务器 SDK (C#) 参考：操作

您可以使用此 Amazon GameLift C# 服务器 SDK 参考资料来帮助您准备多人游戏以便在亚马逊上使用GameLift。有关集成过程的详细信息，请参阅将亚马逊GameLift添加到您的游戏服务器。

AcceptPlayerSession()

通知亚马逊GameLift服务，具有指定玩家会话 ID 的玩家已连接到服务器进程并需要验证。亚马逊会GameLift验证玩家会话 ID 是否有效，也就是说，玩家 ID 已在游戏会话中预留了玩家时段。验证后，亚马逊GameLift会将玩家位置的状态从 “预留” 更改为 “活跃”。

语法

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

通知 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)

参数

返回值

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

示例

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

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

语法

AwsStringOutcome GetGameSessionId()

参数

此操作没有参数。

返回值

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

示例

var getGameSessionIdOutcome = GameLiftServerAPI.GetGameSessionId();

GetSdkVersion()

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

语法

AwsStringOutcome GetSdkVersion()

参数

此操作没有参数。

返回值

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

示例

var getSdkVersionOutcome = GameLiftServerAPI.GetSdkVersion(); 

GetTerminationTime()

如果终止时间可用，则返回安排服务器进程关闭的时间。服务器进程在收到来自 Amazon GameLift 服务的onProcessTerminate()回调后执行此操作。亚马逊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()

初始化亚马逊 GameLift SDK。应在启动时调用此方法，然后再进行任何其他GameLift与亚马逊相关的初始化。

语法

InitSDKOutcome InitSDK()

参数

此操作没有参数。

返回值

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

示例

var initSDKOutcome = GameLiftServerAPI.InitSDK(); 

ProcessEnding()

通知 Amazon GameLift 服务服务器进程正在关闭。应在所有其他清除任务 (包括关闭所有活动游戏会话) 之后调用此方法。此方法应退出，退出代码为 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()

通知 Amazon GameLift 服务服务器进程已准备好托管游戏会话。在成功调用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()

通知亚马逊GameLift服务具有指定玩家会话 ID 的玩家已断开与服务器进程的连接。作为回应，亚马逊将玩家位置GameLift更改为空闲状态，这样就可以将其分配给新玩家。

语法

GenericOutcome RemovePlayerSession(String playerSessionId)

参数

返回值

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

示例

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

StartMatchBackfill()

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

此操作为异步操作。如果成功匹配了新玩家，亚马逊GameLift服务会使用回调函数提供更新的匹配器数据OnUpdateGameSession()。

服务器进程每次只能具有一个活动的匹配回填请求。要发送新请求，请先调用 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() 创建的活动对战回填请求。另请参阅 S Amazon DK 操作 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()后调用。

通知亚马逊GameLift服务服务器进程已结束当前游戏会话。当服务器进程将保持活动状态并准备好托管新的游戏会话时，将调用此操作。只有在游戏会话终止过程完成后才能调用它，因为它会向亚马逊发出信号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()

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

语法

GenericOutcome UpdatePlayerSessionCreationPolicy(PlayerSessionCreationPolicy playerSessionPolicy)

参数

返回值

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

示例

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

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