FDescribePlayerSessionsRequest FProcessParameters FStartMatchBackfillRequest FStopMatchBackfillRequest

Unreal Engine SDK的 Amazon GameLift 伺服器：資料類型

使用 Amazon GameLift Server SDK for Unreal 參考，整合您的多人遊戲以與 Amazon 託管 GameLift。如需整合程序的指引，請參閱將 Amazon GameLift 新增至您的遊戲伺服器。

注意

此參考適用於舊版的 Amazon GameLift 伺服器 SDK。如需最新版本，請參閱。

這是API在 GameLiftServerSDK.h和中定義的GameLiftServerSDKModels.h。

若要設定 Unreal Engine 外掛程式，並查看程式碼範例將 Amazon GameLift 整合至 Unreal Engine 專案。

Unreal Engine SDK的 Amazon GameLift 伺服器：動作

FDescribePlayerSessionsRequest

此資料類型用於指定要擷取的玩家工作階段，您可利用下列方式使用：

提供 PlayerSessionId 來請求特定的玩家工作階段。
提供 GameSessionId 來請求指定遊戲工作階段中的所有玩家工作階段。
提供 PlayerId 來請求指定播放器的所有播放器工作階段。

對於大量的玩家工作階段，可使用分頁參數於循序區塊擷取結果。

獨一無二的遊戲工作階段識別項。請使用此參數要求特定遊戲工作階段的所有玩家工作階段。遊戲工作階段 ID 格式如下：arn:aws:gamelift:<region>::gamesession/fleet-<fleet ID>/<ID string>。<ID string> 的值可能是自訂 ID 字串 (若在建立遊戲工作階段時有指定 ID)，或是產生的字串。

類型：字串

必要：否

限制

回傳結果的數量上限。使用此參數搭配 NextToken 取得結果作為一組連續頁面。若指定玩家工作階段 ID，此參數將遭到忽略。

類型：整數

必要：否

NextToken

字符顯示下一個結果循序頁面的開始處。使用前一個呼叫此動作傳回的字符。指定結果集的開始處時，請勿指定值。若指定玩家工作階段 ID，此參數將遭到忽略。

類型：字串

必要：否

PlayerId

玩家的唯一識別項。播放器由開發人員IDs定義。請參閱產生玩家 ID。

類型：字串

必要：否

PlayerSessionId

玩家工作階段的唯一識別項。

類型：字串

必要：否

PlayerSessionStatusFilter

用於篩選結果的玩家工作階段狀態。可能的玩家工作階段狀態包括下列項目：

RESERVED – 已收到播放器工作階段請求，但播放器尚未連線至伺服器程序和/或已驗證。
ACTIVE – 播放器已由伺服器程序驗證，且目前已連線。
COMPLETED – 播放器連線已中斷。
TIMEDOUT – 已收到玩家工作階段請求，但玩家未連線和/或未在逾時限制（60 秒）內驗證。

類型：字串

必要：否

FProcessParameters

此資料類型包含傳送至ProcessReady()通話中 Amazon GameLift 服務的一組參數。

伺服器處理的連接埠號碼將為新玩家連線進行接聽。值必須屬於為部署此遊戲伺服器組建之機群所設定的連接埠範圍。此連接埠號碼包含在遊戲工作階段和遊戲工作階段物件中，遊戲工作階段會使用該物件來連接到伺服器程序。

類型：整數

必要：是

logParameters

含對遊戲工作階段日誌檔之目錄路徑清單的物件。

類型：TArray＜FString＞

必要：否

onStartGame工作階段

Amazon GameLift 服務叫用以啟用新遊戲工作階段的回呼函數名稱。Amazon GameLift 呼叫此函數以回應用戶端請求 CreateGameSession。回呼函數會取得GameSession物件（定義於 Amazon GameLift Service API參考 ）。

類型： FOnStartGameSession

必要：是

onProcessTerminate

Amazon GameLift 服務調用以強制伺服器程序關閉的回呼函數名稱。呼叫此功能後，Amazon 會 GameLift 等待五分鐘讓伺服器程序關閉，並在關閉伺服器程序之前回應ProcessEnding()呼叫。

類型： FSimpleDelegate

必要：否

onHealthCheck

Amazon GameLift 服務叫用以從伺服器程序請求運作狀態報告的回呼函數名稱。Amazon 每 60 秒 GameLift 呼叫一次此函數。呼叫此函數後，Amazon 會 GameLift 等待 60 秒等待回應，如果沒有收到回應，會將伺服器程序記錄為運作狀態不佳。

類型： FOnHealthCheck

必要：否

onUpdateGame工作階段

Amazon GameLift 服務叫用以將更新後的遊戲工作階段物件傳遞至伺服器程序的回呼函數名稱。Amazon 會在處理相符回填請求時 GameLift 呼叫此函數，以提供更新的相符者資料。它傳遞GameSession物件、狀態更新（updateReason）和相符的回填票證 ID。

類型： FOnUpdateGameSession

必要：否

FStartMatchBackfillRequest

此項資料類型用於傳送配對回填要求。資訊會在StartMatchBackfill()通話中傳達給 Amazon GameLift 服務。

表示目前遊戲工作階段之中所有玩家的一組資料。配對建構器使用此項資訊搜尋適合配對現有玩家的新玩家。如需播放器物件格式的說明，請參閱 Amazon GameLift API 參考指南。若要尋找玩家屬性IDs、和團隊指派，請查看相符者資料屬性中的遊戲工作階段物件。若配對建構器使用延遲，您可收集現有區域更新後的延遲，並將其納入各個玩家資料之中。

類型：TArray＜FPlayer＞

必要：是

TicketId

配對或配對回填要求票證的唯一識別項。如果此處未提供任何值，Amazon GameLift 將以的形式產生一個值UUID。您可使用此識別項依據需求追蹤配對回填票證狀態或取消要求。

類型： FString

必要：否

FStopMatchBackfillRequest

此項資料類型用於取消配對回填要求。資訊會在StopMatchBackfill()通話中傳達給 Amazon GameLift 服務。