やはり俺のターンがまわってこないのはまちがっている。#5|NakamaのGroupでチームを作る:作る・入る・メンバーの一覧

4つの窓を2行2列に並べたところ(2回目の再生)。Player 2 の Console に「「赤チーム」に入っています」「「赤チーム」のメンバー(2人):スライム、フェアリー」、Player 3 に「「青チーム」に入っています」「「青チーム」のメンバー(2人):キョンシー、メデューサ」、Player 4 も同じ。メインのエディタの下のステータスバーに「「赤チーム」のメンバー(2人):スライム、フェアリー」。それぞれを赤枠で囲んだもの
今回のゴール:4人が赤チームと青チームに分かれて、メンバーの一覧が出る

前回は、Multiplayer Play Modeで4人を動かして、それぞれ別の人としてログインするところまでやりました。今回は、その4人をNakamaのGroupでチームに分けます。スライムとフェアリーの赤チーム、キョンシーとメデューサの青チームを作って、チームのメンバーの一覧を出すところまでやります。

目次

今回やること

チーム = Nakama の Group。赤チームの箱にスライム(作った人)とフェアリー(あとから入った)、青チームの箱にキョンシー(作った人)とメデューサ(あとから入った)。どちらも Group(open・最大10人)。右の Nakama の箱に「グループの名前は重ならない」。下に「メンバーは何人でも。途中で入っても抜けてもいい(入っている人は、サーバーが覚えている)」
チームは、Nakama の Group で作る
  • チームはNakamaのGroupで作る
  • テスト用に、Multiplayer Play Modeのタグで「どのチームに入るか」を決める
  • チームを作る・入る・メンバーの一覧を出すTeamManagerを作る
  • 4人で再生して、2チーム×2人になるのを確かめる

Nakamaはdocker compose up -dで起動しておきます。Unityのプロジェクトは、前回のClientをそのまま使います(仮想プレイヤーの3人もActiveのまま)。

チームはGroupで作ろう

Groupってどんなもの?

NakamaのGroupは、ユーザーを集めておく入れ物です。ギルドやクラン、チームに使うためのもので、サーバーが「誰がどのグループに入っているか」を覚えておいてくれます。

  • 名前:グループの名前は、ほかのグループと同じ名前には出来ない
  • open:trueなら誰でもすぐに入れる。falseだと、入りたい人は「入りたい」というお願い(参加申請)になって、管理する人が認めるまで入れない
  • 最大の人数:何も書かなければ100人。今回は10人にする

このシリーズのチームは、メンバーが何人でもよく、途中で入ったり抜けたりします。ログインしていない人もメンバーのまま残るので、Groupはチームにぴったりです。

作った人とメンバー

グループの中の人には、役割(State)があります。

State役割できること
0Superadminグループを作った人。グループを消したり、管理する人を決めたり出来る
1Admin管理する人。メンバーを入れたり外したり出来る
2Memberふつうのメンバー
3Join request入りたいとお願いしている人(openがfalseのとき)

今回はopenのグループなので、最初に作った人がSuperadmin、あとから入った人がMemberになります。

公式のドキュメントはGroups(Heroic Labs)です。

テスト用に、チームのタグを足そう

本当のゲームでは、プレイヤーがチームを選ぶ画面を作ります。今はチームの仕組みを確かめたいので、前回の名前と同じように、Multiplayer Play Modeのタグでチームを決めます。

タグを作る

Project Settings の Multiplayer > Playmode。Player Tags の一覧に、スライム・フェアリー・キョンシー・メデューサ・赤チーム・青チームの6つ。赤チームと青チームの2行を赤枠で囲んだもの
Player Tags に、赤チームと青チームを足す
  1. Edit > Project Settings > Multiplayer > Playmodeを開く
  2. Player Tagsの「+」で、赤チームと青チームの2つを足す

前回の4人の名前と合わせて、タグは6つになります。

プレイヤーに2つ目のタグを付ける

Multiplayer Play Mode の窓。Main Editor にスライムと赤チーム、Player 2 にフェアリーと赤チーム、Player 3 にキョンシーと青チーム、Player 4 にメデューサと青チームのタグ。4つのチームのタグを赤枠で囲んだもの
名前のタグの横に、チームのタグを付ける

Multiplayer Play Modeの窓で、それぞれのAdd Tags to Playerから、チームのタグを足します。タグは1人にいくつでも付けられます。

  • Main Editor:スライム・赤チーム
  • Player 2:フェアリー・赤チーム
  • Player 3:キョンシー・青チーム
  • Player 4:メデューサ・青チーム

仮想プレイヤーの窓のタイトルも、[フェアリー|赤チーム]のようになります。

TeamManagerを作ろう

Assets/ScriptsにTeamManager.csを作ります。チームに入って、メンバーの一覧をConsoleに出すスクリプトです。

using System.Linq;
using System.Threading.Tasks;
using Nakama;
using UnityEngine;

// チーム(Nakama の Group)に入って、メンバーの一覧を出す
public class TeamManager : MonoBehaviour
{
    // 1チームに入れる人数
    [SerializeField] private int maxMemberCount = 10;

    private IClient client;
    private ISession session;
    private IApiGroup team;

    public async Task EnterAsync(IClient nakamaClient, ISession nakamaSession, string teamName)
    {
        client = nakamaClient;
        session = nakamaSession;

        // 前に入ったチームがあれば、そのチームのまま
        team = await FindMyTeamAsync();
        if (team != null)
        {
            Debug.Log($"「{team.Name}」に入っています");
        }
        else
        {
            team = await JoinOrCreateAsync(teamName);
        }
        await ShowMembersAsync();
    }

    // 自分が入っているチームを探す
    private async Task<IApiGroup> FindMyTeamAsync()
    {
        IApiUserGroupList userGroupList = await client.ListUserGroupsAsync(session, null, 10, null);
        IUserGroupListUserGroup userGroup = userGroupList.UserGroups.FirstOrDefault();
        if (userGroup == null)
        {
            return null;
        }
        return userGroup.Group;
    }

    // チームを作る。もうあれば、そのチームに入る
    private async Task<IApiGroup> JoinOrCreateAsync(string teamName)
    {
        try
        {
            IApiGroup createdTeam = await client.CreateGroupAsync(session, teamName, open: true, maxCount: maxMemberCount);
            Debug.Log($"「{teamName}」を作りました");
            return createdTeam;
        }
        catch (ApiResponseException e) when (e.StatusCode == 409)
        {
            // 409:その名前のチームは、もうある
            IApiGroup foundTeam = await FindTeamAsync(teamName);
            await client.JoinGroupAsync(session, foundTeam.Id);
            Debug.Log($"「{teamName}」に入りました");
            return foundTeam;
        }
    }

    // 名前でチームを探す(名前がぴったり同じチームだけが返ってくる)
    private async Task<IApiGroup> FindTeamAsync(string teamName)
    {
        IApiGroupList groupList = await client.ListGroupsAsync(session, teamName, 1);
        return groupList.Groups.First();
    }

    // チームのメンバーを Console に出す
    private async Task ShowMembersAsync()
    {
        IApiGroupUserList groupUserList = await client.ListGroupUsersAsync(session, team.Id, null, maxMemberCount, null);
        string[] names = groupUserList.GroupUsers.Select(groupUser => groupUser.User.DisplayName).ToArray();
        Debug.Log($"「{team.Name}」のメンバー({names.Length}人):{string.Join("、", names)}");
    }
}

入口はEnterAsyncです。ログインしたあとに、NakamaConnectionから呼んでもらいます。

前に入ったチームを探す

IApiUserGroupList userGroupList = await client.ListUserGroupsAsync(session, null, 10, null);

ListUserGroupsAsyncは、自分が入っているグループの一覧を返します。2回目からは、ここで前回入ったチームが見つかるので、作ったり入ったりはしません。

このシリーズでは、1人が入るチームは1つだけにします。なので、一覧の最初の1つを自分のチームにしています。

作ってみて、もうあれば入る

チームを作ってみて、もうあれば入る。CreateGroupAsync(「赤チーム」を作る)から、作れたときは「作った人になる(Superadmin・スライム)」へ、409 のときは「名前が使われている(Group name is in use.)」から「探して入る(ListGroupsAsync → JoinGroupAsync)」へ。下に「探してから作る」だと2人が同時に作ろうとしたとき片方が失敗する、という説明
先に作ってみて、409 なら探して入る

チームに入るときは、先に作ってみて、名前が使われていたら入るようにしています。

  • CreateGroupAsync:グループを作る。作った人は、そのまま1人目のメンバー(Superadmin)になる
  • 同じ名前のグループがあると、Nakamaは409(Group name is in use.)を返す。SDKではApiResponseExceptionになる
  • 409のときだけ、ListGroupsAsyncで名前から探して、JoinGroupAsyncで入る

catch (… e) when (e.StatusCode == 409)は、条件に合う例外だけを受け取る書き方です。サーバーが止まっているなど、ほかのエラーは受け取らずに、NakamaConnectionのcatchまで伝わります。

「探してから作る」にしない理由

「探して、無ければ作る」の順にすると、スライムとフェアリーが同時に再生したとき、2人とも「無い」と思って作ろうとします。片方は名前が重なって失敗するので、結局そのエラーの処理が要ります。

先に作ってみれば、名前が重ならないことはNakamaが守ってくれるので、同時でも順番でも同じ書き方で済みます。

ListGroupsAsyncの名前の検索は、名前がぴったり同じものだけが返ってきました。赤だけで探しても、赤チームは見つかりません(名前の頭が同じものをまとめて探すときは、赤%のように後ろに%を付けます)。

メンバーの一覧を出す

IApiGroupUserList groupUserList = await client.ListGroupUsersAsync(session, team.Id, null, maxMemberCount, null);

ListGroupUsersAsyncで、グループのメンバーの一覧をもらいます。1人ずつのUser.DisplayNameに、前回付けた表示名(スライムなど)が入っています。

ListGroupUsersAsync(session, team.Id)のように人数(limit)を書かないと、SDKの決まりの値が1なので、1人しか返ってきません。ListGroupsAsyncやListUserGroupsAsyncも同じです。何人まで欲しいかを、必ず書いておきます。

NakamaConnectionからチームに入ろう

タグで、名前とチームを分ける

NakamaConnection.csを直します。変わったところだけ載せます。

using System;
using System.Linq;
using System.Threading.Tasks;
using Nakama;
using Unity.Multiplayer.PlayMode;
using UnityEngine;

// Nakama にログインして、ソケットをつなぐ
public class NakamaConnection : MonoBehaviour
{
    ...
    private const string RefreshTokenKey = "nakama.refreshToken";
    // テスト用のチームの名前(Multiplayer Play Mode のタグで、どちらに入るかを決める)
    private static readonly string[] TeamNames = { "赤チーム", "青チーム" };

    [SerializeField] private TeamManager teamManager;

    ...

    private async void Start()
    {
        ...
        try
        {
            session = await LoginAsync();
            Debug.Log($"ログインしました:{session.Username}({session.UserId})");
            await SetDisplayNameAsync();
            await ConnectSocketAsync();
            await EnterTeamAsync();
        }
        ...
    }

    ...

    // Multiplayer Play Mode のタグを、表示する名前にする(テスト用)
    private async Task SetDisplayNameAsync()
    {
        // チームのタグではないものを、名前にする
        string displayName = CurrentPlayer.Tags.FirstOrDefault(tag => !TeamNames.Contains(tag));
        if (displayName == null)
        {
            return;
        }
        await client.UpdateAccountAsync(session, username: null, displayName: displayName);
        Debug.Log($"名前を「{displayName}」にしました");
    }

    // Multiplayer Play Mode のチームのタグのチームに入る(テスト用)
    private async Task EnterTeamAsync()
    {
        string teamName = CurrentPlayer.Tags.FirstOrDefault(tag => TeamNames.Contains(tag));
        if (teamName == null)
        {
            return;
        }
        await teamManager.EnterAsync(client, session, teamName);
    }
    ...
}
  • TeamNames:チームのタグの名前。タグがこの中にあればチーム、無ければ名前として使う
  • SetDisplayNameAsync:前回はTags[0]を名前にしていました。タグが2つになったので、チームではないタグを名前にするように直しました
  • EnterTeamAsync:チームのタグを探して、TeamManagerのEnterAsyncを呼ぶ。チームのタグが無ければ、どのチームにも入らない

FirstOrDefaultは、条件に合う最初の1つを返し、無ければnullを返します(using System.Linq;が要ります)。

Inspectorでつなぐ

Nakama のゲームオブジェクトの Inspector。Nakama Connection (Script) の Team Manager に「Nakama (Team Manager)」、その下に Team Manager (Script) が付いていて Max Member Count は 10。Team Manager の欄と、Team Manager のコンポーネントを赤枠で囲んだもの
Nakama に TeamManager を付けて、Team Manager に入れる
  1. HierarchyでNakamaのゲームオブジェクトを選ぶ
  2. Add ComponentでTeamManagerを付ける
  3. Nakama ConnectionのTeam Managerに、Nakama(Team Manager)を入れる(Team Managerのコンポーネントをドラッグ&ドロップ)

Max Member Countは10のままでOKです。シーンを保存しておきます。

仮想プレイヤーは、メインのエディタのシーンとスクリプトをそのまま使います。自分の環境では、TeamManagerを付けたあとの最初の再生で、仮想プレイヤーの3人だけ「Nakama につなげませんでした:Object reference not set to an instance of an object」になりました。直したシーンがまだ読み込まれていなかったようなので、Multiplayer Play Modeの窓でPlayer 2〜4のチェックを外して入れ直しました。

4人でチームに入ろう

初めての再生

4つの窓を2行2列に並べたところ(初めての再生)。Player 2 の Console に「「赤チーム」に入りました」「「赤チーム」のメンバー(2人):スライム、フェアリー」、Player 3 に「「青チーム」を作りました」「「青チーム」のメンバー(1人):キョンシー」、Player 4 に「「青チーム」に入りました」「「青チーム」のメンバー(2人):キョンシー、メデューサ」。メインのエディタの下のステータスバーに「「赤チーム」のメンバー(1人):スライム」。それぞれを赤枠で囲んだもの
作った人と、あとから入った人

Nakamaのデータを空にしてから(docker compose down -v→docker compose up -d)、メインのエディタで再生しました。チームのところのログは、次のようになりました。

スライム(メインのエディタ)
「赤チーム」を作りました
「赤チーム」のメンバー(1人):スライム

フェアリー(Player 2)
「赤チーム」に入りました
「赤チーム」のメンバー(2人):スライム、フェアリー

キョンシー(Player 3)
「青チーム」を作りました
「青チーム」のメンバー(1人):キョンシー

メデューサ(Player 4)
「青チーム」に入りました
「青チーム」のメンバー(2人):キョンシー、メデューサ

先に動いたスライムとキョンシーがチームを作り、あとのフェアリーとメデューサは409を受けて、そのチームに入りました。

スライム

やった、チームが出来た!でも、ぼくの一覧には、ぼくしかいないよ?

フェアリー

一覧をもらったのが、わたしが入る前だったからよ。一覧は、もらったときのメンバーしか入っていないの

先に入った人には、あとの人が見えない

一覧は、そのときのメンバーだけ。時間の線の上に、スライム(赤チームを作る・一覧:スライム(1人))と、あとのフェアリー(赤チームに入る・一覧:スライム、フェアリー(2人))。スライムの下に「スライムの一覧は1人のまま(あとから入ったフェアリーは見えない)」、右に「あとから入った人を知るには、通知を受け取る(次回)」
一覧は、もらったときのメンバーだけ

ListGroupUsersAsyncは、呼んだときのメンバーを返すだけです。あとから誰かが入っても、先に一覧をもらった人には知らされません。

  • もう一度ListGroupUsersAsyncを呼べば、今のメンバーがもらえる
  • 「誰かが入った」「誰かがオンラインになった」をすぐに知るには、Nakamaからの通知を受け取る

通知は、次回のステータス(オンラインかどうか)と一緒にやります。

Consoleで確かめる

Nakama の Console の Groups。青チーム(9164407c-…)と赤チーム(d813337a-…)の2行。2行を赤枠で囲んだもの
Groups に、赤チームと青チーム

再生したまま、NakamaのConsole(http://localhost:7351)のGroupsを開くと、赤チームと青チームの2つが出来ていました。

Nakama の Console で赤チームを開いて Members のタブを選んだところ。IPDtyTJKYE が Superadmin、FrBFvNWXko が Member の2行(2 items)。2行を赤枠で囲んだもの
赤チームのメンバーは2人

赤チームを選んで、Membersのタブを開きます。

  • IPDtyTJKYE(スライム):Superadmin(作った人)
  • FrBFvNWXko(フェアリー):Member

Consoleでは、表示名ではなくユーザー名が出ます。どちらがどの人かは、UnityのConsoleの「ログインしました:…」で分かります。2チーム×2人になりました。

2回目の再生

メインのエディタの Console(2回目の再生)。「ログインしました:IPDtyTJKYE(cee8c95a-…)」「名前を「スライム」にしました」「ソケットがつながりました」「「赤チーム」に入っています」「「赤チーム」のメンバー(2人):スライム、フェアリー」。最後の2行を赤枠で囲んだもの
2回目は、入っているチームのまま

止めて、もう一度再生しました。今度は4人とも、

「赤チーム」に入っています
「赤チーム」のメンバー(2人):スライム、フェアリー

のように、ListUserGroupsAsyncで前回のチームが見つかって、作ったり入ったりせずに済みました。Nakamaのデータを消さない限り、チームはサーバーに残っています。

4つの窓を2行2列に並べたところ(2回目の再生)。Player 2 の Console に「「赤チーム」に入っています」「「赤チーム」のメンバー(2人):スライム、フェアリー」、Player 3 に「「青チーム」に入っています」「「青チーム」のメンバー(2人):キョンシー、メデューサ」、Player 4 も同じ。メインのエディタの下のステータスバーに「「赤チーム」のメンバー(2人):スライム、フェアリー」。それぞれを赤枠で囲んだもの
4人とも、前回のチームのまま

チームのタグを付け替えても、2回目からは前に入ったチームのままです。チームを変えたいときは、LeaveGroupAsyncでグループから抜けるか、Nakamaのデータを空にしてから再生します。

今回の通信チェック

  • Player Tagsに赤チーム・青チームを足して、4人に2つ目のタグを付けた
  • 先に動いた人がチームを作り(Superadmin)、あとの人は409を受けて同じチームに入った
  • それぞれのConsoleに、チームのメンバーの一覧が出た(先に入った人は1人のまま)
  • NakamaのConsoleのGroupsに、赤チームと青チーム(2人ずつ)が出来た
  • 2回目の再生では、4人とも前回のチームのままだった
プロジェクトの環境
  • Unityのバージョン:6.3 LTS(6000.3.22f1)
  • テンプレート:Universal 2D(Windows向け、Game ビューは Full HD)
  • Multiplayer Play Mode:2.0.2
  • Nakama Unity SDK:v3.23.0
  • サーバー:Nakama v3.42.0(WSL2のDocker Engine)
フェアリー

チームは出来たけど、誰が今いるのかはまだ分からないわね。番が来たときに代表を決めるには、それが要るのよ

次回は

次回は、Nakamaのステータスを使って、チームのメンバーが今オンラインかどうかを調べます。メンバーをフォローして、誰かが来たり帰ったりしたら、すぐに分かるようにしたいと思います。

よかったらシェアしてね!
  • URLをコピーしました!
  • URLをコピーしました!

コメント

コメント一覧 (1件)

コメントする

目次