Amazon GameLift 服務器開發套件（虛幻）參考：數據類型 - Amazon GameLift
F ProcessParametersUpdateGameSessionGameSessionF ServerParametersF StartMatchBackfillRequestFPLAYERF GameLiftDescribePlayerSessionsRequestF StopMatchBackfillRequestF AttributeValueF GameLiftGetFleetRoleCredentialsRequestF GameLiftLongOutcomeF GameLiftStringOutcomeF GameLiftDescribePlayerSessionsOutcomeF GameLiftDescribePlayerSessionsResultF GenericOutcomeF GameLiftPlayerSessionF GameLiftGetComputeCertificateOutcomeF GameLiftGetComputeCertificateResultF GameLiftGetFleetRoleCredentialsOutcomeF GetFleetRoleCredentialsResultF GameLiftError列舉

本文為英文版的機器翻譯版本，如內容有任何歧義或不一致之處，概以英文版為準。

Amazon GameLift 服務器開發套件（虛幻）參考：數據類型

您可以使用這個 Amazon GameLift 虛幻伺服器開發套件參考來協助您準備好與 Amazon GameLift 搭配使用的多人遊戲。如需有關整合程序的詳細資訊，請參閱添加 Amazon GameLift 到您的遊戲服務器和如需使用 Unreal SDK 伺服器外掛程式的資訊，請參閱 GameLift 將 Amazon 集成到虛幻引擎項目中。

注意

本主題說明您在為虛幻引擎建置時可以使用的 Amazon GameLift C++ API。具體而言，本文件適用於您使用-DBUILD_FOR_UNREAL=1選項編譯的程式碼。

F ProcessParameters

此數據類型包含一組發送到 Amazon GameLift 的參數ProcessReady()。

屬性

 Description
LogParameters 具有遊戲階段作業期間所產生之檔案目錄路徑的物件。Amazon GameLift 複製和存儲文件以供 future 訪問。

Type (類型)：TArray<FString>

必要：否
OnHealthCheck Amazon 呼 GameLift 叫以從伺服器處理序要求健康狀態報告的回呼函數。Amazon 每 60 秒 GameLift 調用一次此函數，並等待 60 秒進行響應。如果狀況不良，TRUE則伺服器處理序FALSE會傳回狀況良好。如果未傳回任何回應，Amazon 會將伺服器處理序 GameLift 記錄為狀況不良。

這個屬性是一個委託函數，定義為DECLARE_DELEGATE_RetVal(bool, FOnHealthCheck);

Type (類型)：FOnHealthCheck

必要：否
OnProcessTerminate Amazon GameLift 調用以強制服務器進程關閉的回調函數。呼叫此函數之後，Amazon 會 GameLift 等待 5 分鐘讓伺服器處理序關閉並回應呼ProcessEnding()叫，然後再關閉伺服器處理序。

Type (類型)：FSimpleDelegate

必要：是
OnStartGameSession Amazon GameLift 調用以激活新遊戲會話的回調函數。Amazon GameLift 調用此函數以響應客戶請求CreateGameSession。回呼函數會傳遞GameSession物件，如 Amazon GameLift API 參考中所定義。

這個屬性是一個委託函數，定義為 DECLARE_DELEGATE_OneParam(FOnStartGameSession, Aws::GameLift::Server::Model::GameSession);

Type (類型)：FOnStartGameSession

必要：是
OnUpdateGameSession Amazon GameLift 調用將更新的遊戲會話對象傳遞給服務器進程的回調函數。Amazon 會在處理比賽回填請求以提供更新的分房系統資料時 GameLift 呼叫此函數。它傳遞一個GameSession對象，一個狀態更新（updateReason）和匹配回填票證 ID。

這個屬性是一個委託函數，定義為 DECLARE_DELEGATE_OneParam(FOnUpdateGameSession, Aws::GameLift::Server::Model::UpdateGameSession);

Type (類型)：FOnUpdateGameSession

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

Type (類型)：int

必要：是

UpdateGameSession

此資料類型會更新為遊戲工作階段物件，其中包括更新遊戲工作階段的原因，以及如果使用回填填補充遊戲工作階段中的玩家工作階段，則相關的回填票證 ID。

屬性 Description
GameSession 由 Amazon GameLift API 定義的GameSession對象。GameSession物件包含描述遊戲工作階段的屬性。

Type (類型)：Aws::GameLift::Server::GameSession

必要：否
UpdateReason 遊戲工作階段正在更新的原因。

Type (類型)：enum class UpdateReason

  • 比對資料更新

  • 回填失敗 (_C)

  • 回填 _ 定時 _ 輸出

  • 回填 (_ 已取消)

必要：否

BackfillTicketId 嘗試更新遊戲工作階段的回填票證 ID。

Type (類型)：char[]

必要：否

GameSession

此資料類型提供遊戲工作階段的詳細資訊。

屬性 Description
GameSessionId

遊戲工作階段的唯一識別碼。遊戲工作階段 ARN 的格式如下：arn:aws:gamelift:<region>::gamesession/<fleet ID>/<custom ID string or idempotency token>。

Type (類型)：char[]

必要：否
名稱

遊戲工作階段的描述性標籤。

Type (類型)：char[]

必要：否
FleetId

執行遊戲工作階段之叢集的唯一識別碼。

Type (類型)：char[]

必要：否
MaximumPlayerSessionCount

與遊戲工作階段的玩家連線數目上限。

Type (類型)：int

必要：否
連線埠

遊戲工作階段的連接埠號碼。若要連線到 Amazon GameLift 遊戲伺服器，應用程式需要 IP 位址和連接埠號碼。

Type (類型)：int

必要：否
IpAddress

遊戲工作階段的 IP 位址。若要連線到 Amazon GameLift 遊戲伺服器，應用程式需要 IP 位址和連接埠號碼。

Type (類型)：char[]

必要：否
GameSessionData

一組自訂遊戲工作階段屬性，格式為單一字串值。

Type (類型)：char[]

必要：否
MatchmakerData

有關用於建立遊戲工作階段的配對程序的資訊，以 JSON 語法格式化為字串。除了使用的配對配置外，它還包含了所有指定給比賽的玩家的數據，包括球員屬性和團隊分配。

Type (類型)：char[]

必要：否
GameProperties

遊戲工作階段的一組自訂屬性，格式化為 key: value 配對。這些屬性會與啟動新遊戲工作階段的要求一起傳遞。

Type (類型)：GameProperty[]

必要：否
DnsName

指派給執行遊戲工作階段之執行個體的 DNS 識別碼。值的格式如下：

  • 具備 TLS 功能的叢集：。<unique identifier>.<region identifier>.amazongamelift.com

  • 未啟用 TLS 的叢集：ec2-<unique identifier>.compute.amazonaws.com

連線至已啟用 TLS 的叢集上執行的遊戲工作階段時，您必須使用 DNS 名稱，而非 IP 位址。

Type (類型)：char[]

必要：否

F ServerParameters

用於維護 Amazon 服務 GameLift Anywhere器和 Amazon 服 GameLift 務之間連接的信息。當使用啟動新的伺服器處理序時，會使用此資訊InitSDK()。對於託管在 Amazon GameLift 受管 EC2 執行個體上的伺服器，請使用空物件。

屬性 Description
webSocketUrl

GameLiftServerSdkEndpointAmazon GameLift 返回當你一RegisterCompute個 Amazon GameLift Anywhere 計算資源。

Type (類型)：char[]

必要：是

流程

註冊到託管您遊戲的伺服器處理序的唯一識別碼。

Type (類型)：char[]

必要：是
hostId HostID這是您註冊運算時ComputeName使用的。若要取得更多資訊，請參閱RegisterCompute。

Type (類型)：char[]

必要：是
飛行 計算所註冊之叢集的唯一識別碼。若要取得更多資訊，請參閱RegisterCompute。

Type (類型)：char[]

必要：是
驗證令牌 Amazon 生成的身份驗證令牌 GameLift ，用於向 Amazon 驗證您的服務器。 GameLift若要取得更多資訊，請參閱GetComputeAuthToken。

Type (類型)：char[]

必要：是

F StartMatchBackfillRequest

用於建立配對回填請求的資訊。遊戲服務器通過電話將此信息傳達StartMatchBackfill()給 Amazon GameLift 。

屬性 Description
GameSessionArn

唯一的遊戲工作階段識別碼。該 API 操作GetGameSessionId返回 ARN 格式的標識符。

Type (類型)：char[]

必要：是
MatchmakingConfigurationArn

一個唯一的識別碼，以 ARN 的形式，供分房系統用於此要求。原始遊戲工作階段的分房系統 ARN 位於分房系統資料屬性中的遊戲工作階段物件中。請參閱使用分房系統資料，進一步了解分房系統資料。

Type (類型)：char[]

必要：是
Players

一組數據，代表在遊戲會話中的所有玩家。配對建構器使用此項資訊搜尋適合配對現有玩家的新玩家。

Type (類型)：TArray<FPlayer>

必要：是
TicketId

配對或配對回填請求票證的唯一識別碼。如果你不提供一個值，Amazon GameLift 生成一個。您可使用此識別項依據需求追蹤配對回填票證狀態或取消要求。

Type (類型)：char[]

必要：否

FPLAYER

此資料類型代表配對中的玩家。開始配對要求時，玩家會擁有玩家 ID、屬性以及可能的延遲資料。Amazon 在比賽進行後 GameLift 添加球隊信息。

屬性 Description
LatencyIn女士

以毫秒為單位表示的一組值，表示玩家連線至某個位置時所經歷的延遲量。

如果使用此屬性，則播放器僅匹配列出的位置。若配對構建器有評估玩家延遲的規則，玩家則必須回報延遲度，方可配對。

Type (類型)：TMap>FString, int32<

必要：否
PlayerAttributes

包含可用於配對的玩家資訊的 key: 值組合集合。玩家屬性鍵必須與配對規則集中 PlayerAttributes 使用的鍵相符。

如需播放程式屬性的詳細資訊，請參閱AttributeValue。

Type (類型)：TMap>FString, FAttributeValue<

必要：否
PlayerId

玩家的唯一識別碼。

Type (類型)：std::string

必要：否
團隊

球員在比賽中被分配到的球隊名稱。您可以在配對規則集中定義小組名稱。

Type (類型)：FString

必要：否

F GameLiftDescribePlayerSessionsRequest

指定要擷取哪些玩家工作階段的物件。服務器進程通過DescribePlayerSessions()致電 Amazon 提供此信息 GameLift。

屬性 Description
GameSessionId

唯一的遊戲工作階段識別碼。請使用此參數要求特定遊戲工作階段的所有玩家工作階段。

遊戲工作階段 ID 格式為FString. GameSessionID是自訂 ID 字串或

Type (類型)：std::string

必要：否
PlayerSessionId

玩家工作階段的唯一識別碼。使用此參數可要求單一特定玩家工作階段。

Type (類型)：FString

必要：否
PlayerId

玩家的唯一識別碼。使用此參數可要求特定玩家的所有玩家工作階段。請參閱 產生玩家 ID。

Type (類型)：FString

必要：否
PlayerSessionStatusFilter

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

  • 保留 — 已收到播放器工作階段要求，但播放程式尚未連線至伺服器處理序或已驗證。

  • 作用中 — 播放程式已由伺服器處理序驗證並已連線。

  • 已完成 — 玩家連線中斷。

  • TIMEDOUT — 收到玩家工作階段要求，但玩家沒有連線或未在逾時限制 (60 秒) 內驗證。

Type (類型)：FString

必要：否
NextToken

表示下一頁結果開始的令牌。若要指定結果集的開頭，請勿提供值。如果您提供玩家工作階段 ID，則會忽略此參數。

Type (類型)：FString

必要：否
限制

回傳結果的數量上限。如果您提供玩家工作階段 ID，則會忽略此參數。

Type (類型)：int

必要：否

F StopMatchBackfillRequest

用於取消配對回填要求的資訊。遊戲服務器在通話中將此信息傳達StopMatchBackfill()給 Amazon GameLift 服務。

屬性 Description
GameSessionArn

要求取消的唯一遊戲工作階段識別碼。

Type (類型)：FString

必要：是
MatchmakingConfigurationArn

傳送此要求的分房系統的唯一識別碼。

Type (類型)：FString

必要：是
TicketId

要取消之回填要求票證的唯一識別碼。

Type (類型)：FString

必要：是

F AttributeValue

在FPLAYER屬性鍵值對中使用這些值。此物件可讓您使用任何有效的資料類型來指定屬性值：字串、數字、字串陣列或資料對應。每個AttributeValue物件只能使用其中一個可用性質。

屬性 Description
屬性類型

指定屬性值的類型。

類型：FAttributeType枚舉值。

必要：否
S

表示一個字符串屬性值。

Type (類型)：FString

必要：否
N

表示數值屬性值。

Type (類型)：double

必要：否
SL

表示一個字符串屬性值的數組。

Type (類型)：TArray<FString>

必要：否
代決人

代表字串索引鍵和 double 值的字典。

Type (類型)：TMap<FString, double>

必要：否

F GameLiftGetFleetRoleCredentialsRequest

此資料類型提供角色認證，可將有限的AWS資源存取權限延伸至遊戲伺服器。若要取得更多資訊，請參閱為 Amazon 設置 IAM 服務角色 GameLift。

屬性 Description
RoleArn 服務角色的 Amazon 資源名稱 (ARN)，可延伸對AWS資源的有限存取權限。

Type (類型)：FString

必要：否
RoleSessionName 說明使用角色認證之工作階段的名稱。

Type (類型)：FString

必要：否

F GameLiftLongOutcome

此資料類型是由動作產生的，並產生具有下列屬性的物件：

屬性 Description
結果

動作的結果。

Type (類型)：long

必要：否
ResultWithOwnership

動作的結果，轉換為右值，以便調用代碼可以獲得對象的所有權。

Type (類型)：long&&

必要：否
Success (成功)

動作是否成功。

Type (類型)：bool

必要：是
錯誤

處理行動失敗時發生的錯誤。

Type (類型)：F GameLiftError

必要：否

F GameLiftStringOutcome

此資料類型是由動作產生的，並產生具有下列屬性的物件：

屬性 Description
結果

動作的結果。

Type (類型)：FString

必要：否
ResultWithOwnership

動作的結果，轉換為右值，以便調用代碼可以獲得對象的所有權。

Type (類型)：FString&&

必要：否
Success (成功)

動作是否成功。

Type (類型)：bool

必要：是
錯誤

處理行動失敗時發生的錯誤。

Type (類型)：F GameLiftError

必要：否

F GameLiftDescribePlayerSessionsOutcome

此資料類型是由動作產生的，並產生具有下列屬性的物件：

屬性 Description
結果

動作的結果。

Type (類型)：F GameLiftDescribePlayerSessionsResult

必要：否

ResultWithOwnership

動作的結果，轉換為右值，以便調用代碼可以獲得對象的所有權。

Type (類型)：FGameLiftDescribePlayerSessionsResult&&

必要：否
Success (成功)

動作是否成功。

Type (類型)：bool

必要：是
錯誤

處理行動失敗時發生的錯誤。

Type (類型)：F GameLiftError

必要：否

F GameLiftDescribePlayerSessionsResult

屬性 Description
PlayerSessions

Type (類型)：TArray<FGameLiftPlayerSession>

必要：是

NextToken

表示下一頁結果開始的令牌。若要指定結果集的開頭，請勿提供值。如果您提供玩家工作階段 ID，則會忽略此參數。

Type (類型)：FString

必要：否
Success (成功)

動作是否成功。

Type (類型)：bool

必要：是
錯誤

處理行動失敗時發生的錯誤。

Type (類型)：F GameLiftError

必要：否

F GenericOutcome

此資料類型是由動作產生的，並產生具有下列屬性的物件：

屬性 Description
Success (成功)

動作是否成功。

Type (類型)：bool

必要：是
錯誤

處理行動失敗時發生的錯誤。

Type (類型)：F GameLiftError

必要：否

F GameLiftPlayerSession

屬性 Description
CreationTime

Type (類型)：long

必要：是
FleetId

Type (類型)：FString

必要：是
GameSessionId

Type (類型)：FString

必要：是
IpAddress

Type (類型)：FString

必要：是
PlayerData

Type (類型)：FString

必要：是
PlayerId

Type (類型)：FString

必要：是
PlayerSessionId

Type (類型)：FString

必要：是
連線埠

Type (類型)：int

必要：是
Status

類型：PlayerSessionStatus枚舉。

必要：是
TerminationTime

Type (類型)：long

必要：是
DnsName

Type (類型)：FString

必要：是

F GameLiftGetComputeCertificateOutcome

此資料類型是由動作產生的，並產生具有下列屬性的物件：

屬性 Description
結果

動作的結果。

Type (類型)：F GameLiftGetComputeCertificateResult

必要：否

ResultWithOwnership

動作的結果，轉換為右值，以便調用代碼可以獲得對象的所有權。

Type (類型)：FGameLiftGetComputeCertificateResult&&

必要：否
Success (成功)

動作是否成功。

Type (類型)：bool

必要：是
錯誤

處理行動失敗時發生的錯誤。

Type (類型)：F GameLiftError

必要：否

F GameLiftGetComputeCertificateResult

計算上 TLS 憑證的路徑以及計算機的主機名稱。

屬性 Description
CertificatePath

Type (類型)：FString

必要：是
ComputeName

Type (類型)：FString

必要：是

F GameLiftGetFleetRoleCredentialsOutcome

此資料類型是由動作產生的，並產生具有下列屬性的物件：

屬性 Description
結果

動作的結果。

Type (類型)：F GetFleetRoleCredentialsResult

必要：否

ResultWithOwnership

動作的結果，轉換為右值，以便調用代碼可以獲得對象的所有權。

Type (類型)：FGameLiftGetFleetRoleCredentialsResult&&

必要：否
Success (成功)

動作是否成功。

Type (類型)：bool

必要：是
錯誤

處理行動失敗時發生的錯誤。

Type (類型)：F GameLiftError

必要：否

F GetFleetRoleCredentialsResult

屬性 Description
AccessKeyId

用於驗證並提供AWS資源存取權的存取金鑰 ID。

Type (類型)：FString

必要：否
AssumedRoleId

服務角色所屬的使用者識別碼。

Type (類型)：FString

必要：否
AssumedRoleUserArn

服務角色所屬之使用者的 Amazon 資源名稱 (ARN)。

Type (類型)：FString

必要：否
過期

您的工作階段認證到期之前的時間長度。

Type (類型)：FDateTime

必要：否
SecretAccessKey

用於驗證的秘密存取金鑰 ID。

Type (類型)：FString

必要：否
SessionToken

標識當前活動會話與您的AWS資源進行交互的令牌。

Type (類型)：FString

必要：否
Success (成功)

動作是否成功。

Type (類型)：bool

必要：是
錯誤

處理行動失敗時發生的錯誤。

Type (類型)：GameLiftError

必要：否

F GameLiftError

屬性 Description
ErrorType

錯誤類型。

類型：GameLiftErrorType枚舉。

必要：否

ErrorName

錯誤的名稱。

Type (類型)：std::string

必要：否

ErrorMessage

錯誤訊息。

Type (類型)：std::string

必要：否

列舉

針對 Amazon GameLift 伺服器開發套件 (虛幻) 定義的枚舉定義如下：

F AttributeType

  • NONE

  • 字符串

  • 雙

  • 字符串列表

  • 弦雙地圖

GameLiftErrorType

指示錯誤類型的字符串值。有效值包含：

  • 服務呼叫失敗 — 對服務的呼叫失敗。AWS

  • 本地連接失敗 — 與 Amazon 的本地連接失敗。 GameLift

  • 網路不初始化 — 網路尚未初始化。

  • 遊戲設定 — 尚未設定遊戲工作階段識別碼。

  • 不要求 _ 例外

  • 內部 _ 服務 _ 異常

  • 已初始化 — Amazon GameLift 伺服器或用戶端已經使用初始化 () 進行初始化。

  • FLEET_MISMATCH — 目標叢集與遊戲經營或玩家工作階段的機隊不相符。

  • 已初始化 — Amazon 用戶端尚未初始化。 GameLift

  • 已初始化 — Amazon 伺服器尚未初始化。 GameLift

  • 遊戲工作階段失敗 — Amazon GameLift 伺服器開發套件無法聯絡服務以報告遊戲工作階段已結束。

  • 未啟動 Amazon 伺服器遊戲工作階段。 GameLift

  • 遊戲工作階段已準備就緒 — Amazon GameLift 伺服器開發套件無法聯絡服務以報告遊戲工作階段已準備就緒。

  • 初始化不匹配-在服務器:: 初始化（）之後調用客戶端方法，反之亦然。

  • 初始化 — Amazon GameLift 伺服器或用戶端尚未使用初始化 () 初始化。

  • 無目標別名-尚未設定目標別名。

  • 目標叢集 — 尚未設定目標叢集。

  • 處理結束-Amazon GameLift 伺服器開發套件無法聯絡服務以報告程序已結束。

  • PROCES_NOT_ACT_ACTIVE — 伺服器處理作業尚未啟動、未繫結至 GameSession，且無法接受或處理。 PlayerSessions

  • 處理程序 NOT_READY — 伺服器處理作業尚未準備好啟動。

  • 處理程序 READY_FAIN — Amazon GameLift 伺服器開發套件無法聯絡服務以報告程序已準備就緒。

  • SDK_ 版本偵測失敗 — SDK 版本偵測失敗。

  • STX_CALL_ 失敗 — 對 XSTX 伺服器後端元件的呼叫失敗。

  • STX_ 初始化失敗 — XSTX 伺服器後端元件無法初始化。

  • 意外的玩家工作階段 — 伺服器遇到未註冊的玩家工作階段。

  • WEB 插槽 _ 連接 _ 失敗

  • WEB 插座 _ 連接 _ 失敗 _ 禁止

  • 網站插槽 _ 連接 _ 失敗 _ 無效 _URL

  • 網路插槽 _ 連線 _ 失敗 _ 逾時

  • 網站重新擷取 _ 傳送訊息 _ 失敗 — 將訊息傳送至服務的可擷取失敗。 GameLift WebSocket

  • 網站傳送訊息失敗 — 無法將訊息傳送至服務。 GameLift WebSocket

  • 匹配 _ 後填 _ 請求驗證 — 驗證請求失敗。

  • 播放器會話請求驗證 — 請求的驗證失敗。

E PlayerSessionCreationPolicy

字串值代表遊戲工作階段是否可接受新玩家。有效值包含：

  • ACCEPT_ALL – 接受所有新玩家工作階段。

  • DENY_ALL – 拒絕所有新玩家工作階段。

  • NOT_SET — 遊戲工作階段未設定為接受或拒絕新玩家工作階段。

E PlayerSessionStatus

  • ACTIVE

  • COMPLETED (已完成)

  • 沒有設定

  • 已保留

  • 定時