サブゲームモードを使用して Quick Play を設定する
注釈:本資料はAI技術を用いて翻訳されています。
概要
サブゲームモードを使用すると、1 つのマッチプールで複数のゲームプレイモードを提供できます。プレイヤーがプレイ可能なモードを選択し、ゲームはその選択を含むマッチチケットを 1 つ送信します。モード専用のボタンからも、同じプールに単一の許容モードを送信できます。これにより、そのモードのプレイヤーは、選択に互換性のある Quick Play プレイヤーとキューを共有できます。
このガイドでは、Elimination、Team Deathmatch、Skirmish を例に、共通ルールセット、許容モードを指定するチケット属性、作成されたセッションからゲームプレイモードを選択する方法を説明します。
このガイドのプレイヤー数、フレキシングの閾値、レイテンシ上限は設定例です。ゲームに合わせて調整し、デプロイ前に、想定するプレイヤー数とホスティングモデルで設定のチェックを完了してください。
前提条件
- マッチメイキング入門、マッチルールセットを設定する、マッチプールを設定するについて理解していること。
- AGS Admin Portal へのアクセス権と、Matchmaking v2 を使用する名前空間があること。
- セッションテンプレートと、ルールセットでサポートする最大規模のマッチ(この例では 50 人)を収容できるホスティング実装があること。
- プレイヤー認証、Lobby 接続、マッチメイキングとセッションのフローが実装されたゲームクライアントがあること。マッチメイキングを Unity ゲームクライアントに統合する、またはマッチメイキングをゲームクライアントに統合するを参照してください。
- Unity の場合は、プロジェクトに AccelByte Unity SDK がインストールされ、設定されていること。
- Unreal の場合は、Sessions V2 が有効な AccelByte OSS V2 と、ゲームコードで使用できる
OnlineSubsystemAccelByteモジュールがあること。
サブゲームモードを定義する
alliance フィールドは、チーム数とチームごとのプレイヤー数を指定します。
| フィールド | 意味 |
|---|---|
min_number | 最小チーム数 |
max_number | 最大チーム数 |
player_min_number | チームごとの最小プレイヤー数 |
player_max_number | チームごとの最大プレイヤー数 |
このサンプルでは、以下の要件を使用します。
| モード識別子 | 初期のチーム構成 | 初期の合計プレイヤー数 | 10 秒後の構成 |
|---|---|---|---|
elimination | 10 チーム、各チーム 2~5 人 | 20~50 人 | 1~10 チーム、各チーム 1~5 人 |
teamdeathmatch | 2 チーム、各チーム 5 人 | 10 人 | 1~2 チーム、各チーム 1~5 人 |
skirmish | 2 チーム、各チーム 2 人 | 4 人 | 変更なし。フレキシングルールなし |
この例の Elimination はチームベースのモードです。初期設定では、少なくとも 20 人が必要です。
このサンプルの Elimination と Team Deathmatch のフレキシングルールは、10 秒後に 1 チーム 1 人のみのマッチを許容します。Team Deathmatch で常に 2 つの対戦チームが必要な場合は、緩和後の min_number を 2 に設定してください。緩和後の最小プレイヤー数は、ゲームでプレイ可能な最小チームサイズに合わせて選択してください。
共通のセッション収容人数を設定する
マッチメイキングは、マッチに使用するサブゲームモードの alliance に従ってチームを編成します。プールから作成する新しいセッションの最大プレイヤー数は、最上位の alliance の max_number * player_max_number で求めます。この値が 0 より大きい場合、セッションテンプレートの最大プレイヤー数を上書きします。最上位の最大値は、最大規模のマッチを収容できるように設定してください。
{
"min_number": 1,
"max_number": 10,
"player_min_number": 1,
"player_max_number": 5
}
この例では、4 人の Skirmish マッチも含め、プール内で成立するすべての新規マッチのセッション収容人数が 10 * 5 = 50 人になります。ゲームロジックとプレイヤー数の表示には、ゲームプレイモードのチーム要件を使用してください。
ルールセットと共有プールを設定する
各モードの alliance_flexing_rule は、そのサブゲームモード内に配置してください。マッチメイキングは、そのルールを該当モードの alliance に適用します。最上位の alliance_flexing_rule は、最上位の alliance にのみ適用されます。
以下の JSON は、ルールセットの設定データです。Admin Portal では Configuration (JSON) フィールドに使用します。管理 API または CLI の操作では、操作の data フィールドに指定し、ラッパーフィールドは別途指定します。マッチルールセットを設定するに従ってください。
{
"alliance": {
"min_number": 1,
"max_number": 10,
"player_min_number": 1,
"player_max_number": 5
},
"auto_backfill": false,
"region_latency_max_ms": 200,
"rebalance_enable": false,
"sub_game_modes": {
"elimination": {
"name": "elimination",
"alliance": {
"min_number": 10,
"max_number": 10,
"player_min_number": 2,
"player_max_number": 5
},
"alliance_flexing_rule": [
{
"duration": 10,
"min_number": 1,
"max_number": 10,
"player_min_number": 1,
"player_max_number": 5
}
]
},
"teamdeathmatch": {
"name": "teamdeathmatch",
"alliance": {
"min_number": 2,
"max_number": 2,
"player_min_number": 5,
"player_max_number": 5
},
"alliance_flexing_rule": [
{
"duration": 10,
"min_number": 1,
"max_number": 2,
"player_min_number": 1,
"player_max_number": 5
}
]
},
"skirmish": {
"name": "skirmish",
"alliance": {
"min_number": 2,
"max_number": 2,
"player_min_number": 2,
"player_max_number": 2
}
}
}
}
この例では、自動バックフィルとリバランスを無効にし、共通のレイテンシ上限を 200 ミリ秒に設定しています。スキルやロールの要件は追加していません。
- 上記の設定でルールセットを作成します。名前の例は
quickplay-rulesetです。 - そのルールセットと共通のセッションテンプレートを参照するプールを 1 つ作成します。名前の例は
quickplay-poolです。マッチプールを設定するに従ってください。 - ホスティング実装が 50 人のセッションをサポートすることを確認します。
- リソースを再取得して設定を確認し、以下の実行時チェックを完了します。このガイドのリソース名は例です。作成や更新の前に既存のリソースを確認してください。
1 つのチケットで許容モードを送信する
ルールセットのキーは複数形の sub_game_modes です。チケット属性は単数形の attributes.sub_game_mode で、値は許容するモード識別子の配列です。
{
"matchPool": "quickplay-pool",
"attributes": {
"sub_game_mode": ["elimination", "teamdeathmatch", "skirmish"]
}
}
ルールセットに設定した識別子と完全に一致させてください。このリストは、許容できる結果を指定します。配列の順序はモードの優先順位を指定するものではありません。
| プレイヤーの選択 | sub_game_mode の値 |
|---|---|
| Quick Play、すべてのモード | ["elimination", "teamdeathmatch", "skirmish"] |
| Elimination のみ | ["elimination"] |
| Team Deathmatch のみ | ["teamdeathmatch"] |
| Skirmish のみ | ["skirmish"] |
| Team Deathmatch または Skirmish | ["teamdeathmatch", "skirmish"] |
すべての選択で同じプールを使用します。Team Deathmatch のみを選んだプレイヤーは、Team Deathmatch も許容する Quick Play プレイヤーとマッチできます。選択に共通するモードがないプレイヤー同士は、マッチしてはいけません。
パーティが 2 人を超える場合は、Skirmish を除外してください。チームごとの最大人数が 2 人のためです。他の許容モードについても、パーティサイズとパーティ配置要件を満たすか確認してください。パーティリーダーが、パーティセッション ID を指定してチケットを 1 つ送信します。
ゲームエンジンから送信する
- Unity
- Unreal (OSS)
CreateMatchmakingTicket を使用して、許容するモードの配列を送信します。リージョンマッチングを使用する場合は、測定したリージョンレイテンシを指定してください。
using System;
using System.Collections.Generic;
using AccelByte.Api;
using AccelByte.Core;
using AccelByte.Models;
using UnityEngine;
public static class QuickPlayTickets
{
public static void Create(
string poolName,
string[] acceptedModes,
Dictionary<string, int> measuredLatencies,
Action<string> onCreated,
string partySessionId = null)
{
if (string.IsNullOrWhiteSpace(poolName))
throw new ArgumentException("A match pool is required.", nameof(poolName));
if (acceptedModes == null || acceptedModes.Length == 0)
throw new ArgumentException("Select at least one mode.", nameof(acceptedModes));
var options = new MatchmakingV2CreateTicketRequestOptionalParams
{
attributes = new Dictionary<string, object>
{
["sub_game_mode"] = acceptedModes
},
latencies = measuredLatencies,
sessionId = partySessionId
};
var matchmaking = AccelByteSDK.GetClientRegistry()
.GetApi().GetMatchmakingV2();
matchmaking.CreateMatchmakingTicket(poolName, options, result =>
{
if (result.IsError)
{
Debug.LogError($"Matchmaking failed: {result.Error.Message}");
return;
}
onCreated?.Invoke(result.Value.matchTicketId);
});
}
}
キュー開始ボタンのハンドラーで、選択されたモードの配列を渡し、返されたチケット ID を保存します。以下の例では、クライアントが measuredLatencies と activeTicketId を管理しているものとします。
QuickPlayTickets.Create(
"quickplay-pool",
new[] { "elimination", "teamdeathmatch", "skirmish" },
measuredLatencies,
id => activeTicketId = id);
Team Deathmatch 専用のボタンでは、代わりに new[] { "teamdeathmatch" } を渡してください。チケット作成中の重複送信を防ぎ、作成に失敗した場合は UI の状態を復元してください。有効なチケットがある状態でプレイヤーが選択を変更した場合は、DeleteMatchmakingTicket を呼び出し、キャンセルの成功を待ってから代わりのチケットを作成してください。有効期限切れや、キャンセルとマッチ成立イベントの競合は、既存のマッチメイキングフローで処理します。
AccelByte の検索設定ヘルパーを使用して、sub_game_mode に TArray<FString> を保存します。OSS は、その設定をチケット属性の JSON 配列に変換します。カンマ区切りの文字列や JSON 文字列では、必要な配列を指定できません。
以下のヘルパーには、既存の OSS V2 セッションインターフェース、認証済みローカルプレイヤー ID、開始リクエストの完了デリゲートを渡します。bUseP2P はセッションテンプレートに合わせ、P2P の場合は true、AMS 専用サーバーの場合は false に設定してください。
#include "OnlineSessionInterfaceV2AccelByte.h"
#include "OnlineSessionSettingsAccelByte.h"
#include "OnlineSubsystemAccelByteSessionSettings.h"
bool StartQuickPlayMatchmaking(
const FOnlineSessionV2AccelBytePtr& SessionInterface,
const FUniqueNetIdRef& LocalPlayerId,
const TArray<FString>& AcceptedModes,
bool bUseP2P,
const FOnStartMatchmakingComplete& OnStarted,
TSharedPtr<FOnlineSessionSearchAccelByte>& OutSearchHandle)
{
if (!SessionInterface.IsValid() || AcceptedModes.Num() == 0)
{
return false;
}
TSharedRef<FOnlineSessionSearchAccelByte> SearchHandle =
MakeShared<FOnlineSessionSearchAccelByte>();
SearchHandle->SetIsP2PMatchmaking(bUseP2P);
SearchHandle->QuerySettings.Set(
SETTING_SESSION_MATCHPOOL,
FString(TEXT("quickplay-pool")),
EOnlineComparisonOp::Equals);
FOnlineSearchSettingsAccelByte::Set(
SearchHandle->QuerySettings,
FName(TEXT("sub_game_mode")),
AcceptedModes,
EOnlineComparisonOp::Equals);
if (!SessionInterface->StartMatchmaking(
USER_ID_TO_MATCHMAKING_USER_ARRAY(LocalPlayerId),
NAME_GameSession,
FOnlineSessionSettings(),
SearchHandle,
OnStarted))
{
return false;
}
OutSearchHandle = SearchHandle;
return true;
}
キューのハンドラーからヘルパーを呼び出します。以下では、LocalPlayerId は有効な FUniqueNetIdPtr、OnStartMatchmakingCompleteDelegate はバインド済みの FOnStartMatchmakingComplete です。ActiveSearchHandle は、検索中に保持する TSharedPtr<FOnlineSessionSearchAccelByte> 型のクラスメンバーです。
const TArray<FString> AcceptedModes = {
TEXT("elimination"), TEXT("teamdeathmatch"), TEXT("skirmish")
};
const bool bRequestStarted = StartQuickPlayMatchmaking(
SessionInterface,
LocalPlayerId.ToSharedRef(),
AcceptedModes,
bUseP2P,
OnStartMatchmakingCompleteDelegate,
ActiveSearchHandle);
Team Deathmatch 専用ボタンでは、TEXT("teamdeathmatch") のみを含む TArray<FString> を同じヘルパーに渡してください。bRequestStarted が false の場合は、直ちにキュー UI を復元してください。戻り値の true と開始リクエストの完了デリゲートは、マッチメイキングの開始に関するものです。最終的なマッチ結果は、マッチメイキングをゲームクライアントに統合するの説明に従い、FOnMatchmakingCompleteDelegate で処理してください。
処理中の重複送信を防いでください。パーティでは、リーダーのみがマッチメイキングを開始します。OSS は現在のパーティセッション ID を追加します。有効な選択を置き換える前に、CancelMatchmaking を呼び出し、FOnCancelMatchmakingCompleteDelegate コールバックで成功を確認してください。キャンセル中にマッチが成立する場合も考慮してください。
マッチしたゲームセッションに参加した後、セッション設定から sub_game_mode を取得します。
TArray<FString> SessionModes;
const FOnlineSessionSettings* Settings =
SessionInterface->GetSessionSettings(NAME_GameSession);
const bool bHasModes = Settings != nullptr
&& FOnlineSessionSettingsAccelByte::Get(
*Settings, FName(TEXT("sub_game_mode")), SessionModes);
bHasModes が false の場合、または配列が空の場合は、セッションフローでモードデータの欠落を処理してください。それ以外の場合は、次のセクションの優先順位に従ってゲームプレイモードを選択してください。OSS のセッション属性については、ゲームセッションの属性を統合するを参照してください。
セッションに参加してゲームプレイモードを選択する
マッチ成立後は、通常のセッション招待と参加フローに従ってください。マッチしたセッションの属性から sub_game_mode 配列を取得します。この配列には、マッチしたすべてのチケットが許容し、編成されたチームがフレキシング適用後も含めて有効なチーム要件を満たすモードが入ります。たとえば、3 つのモードすべてを許容する 2 人がフレキシング後にマッチすると、配列には "elimination" と "teamdeathmatch" が含まれます。配列の順序は一定ではありません。
ゲームクライアントとサーバーで共通の固定された優先順位を使用します。その優先順位で、セッションの配列に含まれる最初のモードを選択してください。たとえば、Elimination、Team Deathmatch、Skirmish の順に優先する場合、この 2 人のマッチでは Elimination を使用します。
通知、セッション参加、ホストへの接続方式については、マッチメイキングを Unity ゲームクライアントに統合する、またはマッチメイキングをゲームクライアントに統合するを参照してください。共通のセッション収容人数が大きい場合でも、ゲームプレイとプレイヤー数 UI には各モードのチーム要件を使用してください。
設定を検証する
対象のデプロイ環境で、以下のチェックを実行してください。実際のチケットとセッションのデータを確認します。チケット作成の成功やルールセットの再取得だけでは、マッチメイキングの動作を検証できません。
| チェック | 期待する結果 |
|---|---|
| モード専用ボタンと Quick Play ボタン | 同じプールと、意図した空でない許容モード配列がリクエストで使用される |
| フレキシング前の単一モードのチケット | チームはそのモードの初期要件を満たす。人数が足りない場合はキューに残る |
| 10 秒経過後の Elimination 専用と Team Deathmatch 専用のチケット | 各モードに固有の緩和後のチーム要件が適用される。マッチャーの評価遅延を考慮する |
| 10 秒経過後の Skirmish 専用のチケット | Skirmish では引き続き 2 チーム、各チーム 2 人が必要である |
| 共通する許容モードがない場合 | 記録した観測時間中はマッチしない |
| すべてのモードを許容する 2 人がフレキシング後にマッチした場合 | セッションに Elimination と Team Deathmatch が順不同で含まれ、最大プレイヤー数は 50 人になる |
| すべてのチケットが 3 モードを許容し、フレキシング後に各 2 人の 2 チームが成立した場合 | セッションの配列に 3 モードすべてが含まれる。配列の順序にかかわらず、クライアントとサーバーが同じゲームプレイモードを選択する |
| パーティサイズ | 提供されるモードと実際のチーム割り当てが、すべてのパーティを収容できる |
| セッションの収容人数 | 4 人の Skirmish マッチと最大規模の Elimination マッチのどちらでも、セッションの最大プレイヤー数は 50 人である。ホスティングは 50 人全員を収容できる |
| セッションメンバー | チケットが、想定したプレイヤーとチームを含む同じセッションに対応する |
| チケットのライフサイクル | キャンセル、再作成、有効期限切れ、マッチ成立との競合後も、クライアント状態に矛盾がない |
| ホスティングとクリーンアップ | プレイヤーが設定した接続フローを完了し、テストのチケットとセッションが削除される |
50 人の Elimination マッチを含め、各モードを想定するプレイヤー数とフレキシングの閾値でテストしてください。チーム構成やセッションのモードが想定と異なる場合は、デプロイ前にチケットとセッションのデータを確認してください。
10 秒の閾値によって小さすぎるマッチが成立していないか、200 ミリ秒のレイテンシ上限がプレイヤーに適しているか確認してください。この例では自動バックフィルを無効にしているため、その設定によって緩和後のマッチにプレイヤーが自動補充されることはありません。