やはり俺のターンがまわってこないのはまちがっている。#6|Nakamaのステータスで、チームの誰がオンラインかを出す

4つの窓を2行2列に並べたところ(2回目の再生)。メインのエディタの Game ビューに「赤チーム ●スライム ●フェアリー」、Player 2 の Game にも同じ一覧、Player 3 と Player 4 の Game に「青チーム ●メデューサ ●キョンシー」。仮想プレイヤーの窓は左に Game、右に Console。4つの一覧を赤枠で囲んだもの
今回のゴール:チームの一覧に、オンラインの印が付く

前回は、4人を赤チームと青チームに分けて、メンバーの一覧をConsoleに出しました。でも、一覧をもらったあとに入った人は見えませんでしたし、その人が今ゲームを開いているのかも分かりません。今回は、Nakamaのステータスを使って、チームのメンバーが今オンラインかどうかを、画面の一覧に印で出します。

目次

今回やること

チームの一覧に、オンラインの印を付ける。左にスライムの画面(赤チーム、●スライム(自分)、○フェアリー(オフライン))。右の Nakama の箱から、①フォローする(今オンラインの人が返ってくる、FollowUsersAsync)、②来た・帰った(フォローした人のステータスの通知、Joins・Leaves)、③チームに入った(チャンネルの知らせ(コード3)→ 一覧を読み直す)の3つの矢印。下に「つないだ人は、ほかの人から「オンライン」に見える(#3 の appearOnline: true)」
Nakama からの3つの知らせで、一覧を新しくする
  • チームのメンバーをフォローして、今オンラインの人をもらう
  • フォローした人が来たり帰ったりしたら、通知(Joins・Leaves)で印を付け直す
  • あとからチームに入った人は、チームのチャンネルに届く知らせで分かるようにする
  • 一覧を画面に出す(TeamView)

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

ステータスってどんなもの?

オンラインに見えるのは、つないでいる人

ステータスの流れ(スライムがフェアリーをフォローする)。左にスライム、真ん中に Nakama、右にフェアリーの縦の線。フェアリーから Nakama へ「ソケットをつなぐ(appearOnline)」、スライムから Nakama へ「FollowUsersAsync(フェアリー)」、Nakama からスライムへ「今オンライン:フェアリー → ●」、フェアリーから Nakama へ「ゲームを閉じる(ソケットが切れる)」、Nakama からスライムへ「Leaves:フェアリー → ○」
フォローすると、来た・帰ったが届く

Nakamaのステータスは、「この人は今つながっている」をほかの人に知らせる仕組みです。

  • ステータスを出す:ソケットをつないだだけでは、ほかの人からはオンラインに見えない。#3でConnectAsync(session, appearOnline: true)にしてあるので、つないだ時点でオンラインに見える
  • フォローする:FollowUsersAsyncで、知りたい人をフォローする。そのとき、フォローした人のうち今オンラインの人が返ってくる
  • 通知を受ける:フォローした人がつないだり切れたりすると、ReceivedStatusPresenceが呼ばれる。来た人はJoins、帰った人はLeavesに入っている

フォローは、今のソケットがつながっている間だけです。ゲームを開き直したら、もう一度フォローします。サーバーに「誰をフォローしているか」は残りません。

公式のドキュメントはStatus(Heroic Labs)です。チームのメンバーをまとめてフォローする仕組みは無いので、メンバーのユーザーIDを並べてフォローします。

あとから入った人は、チャンネルの知らせで分かる

フォローできるのは、知っている人だけです。前回のように、一覧をもらったあとにチームに入った人は、フォローのしようがありません。

そこで使うのが、グループのチャンネルです。Nakamaのグループには、メンバーだけが入れるチャット用のチャンネルが付いています。open のグループに誰かが入ると、Nakamaがそのチャンネルに「入りました」の知らせを送ってくれます。知らせは、メッセージのCodeで見分けます。

Code知らせ
0ふつうのチャットのメッセージ(ユーザーが送ったもの)
3グループに入った
4グループに入れてもらった(管理する人が足した)
5グループを抜けた
6グループから外された

チャットは使いませんが、チャンネルに入っておけば、コード3の知らせが届きます。届いたら、メンバーの一覧をもらい直して、新しい人もフォローします。コードの一覧はRealtime Chat(Heroic Labs)にあります。

スライム

チャットの部屋なのに、話さないで入っておくだけなの?

フェアリー

そうよ。チームに誰かが入ったら、サーバーが部屋に張り紙をしてくれるの。それを見に行くだけね

画面に一覧を出そう

日本語のフォント

TeamView のゲームオブジェクトの Inspector。Rect Transform と Canvas Renderer はたたんであり、TextMeshPro - Text (UI) の Font Asset に「NotoSansJP SDF (TMP_Font Asset)」、Font Size に 48。Font Asset と Font Size を赤枠で囲んだもの
Font Asset は NotoSansJP SDF、Font Size は 48

一覧はTextMeshProで出します。名前が日本語なので、日本語のフォントアセットを作ります。

  1. Noto Sans JP(Google Fonts)をダウンロードして、Assets/FontsにNotoSansJP.ttfを入れる(ライセンスのOFL.txtも一緒に)
  2. 初めてTextMeshProを使うときは、Window>TextMeshPro>Import TMP Essential Resourcesで、TMPの基本の素材を入れる
  3. NotoSansJP.ttfを右クリック>Create>TextMeshPro>Font Asset>SDFで、「NotoSansJP SDF」を作る
  4. Edit>Project Settings>TextMesh Pro>SettingsのDefault Font Assetに、NotoSansJP SDFを入れる

フォントアセットの作り方は、9-3 TextMeshProで美しいテキストを表示しようで詳しく紹介しています。

CanvasとText

Hierarchy。SampleScene の下に Main Camera・Global Light 2D・Nakama・Canvas(子に TeamView)・EventSystem。Canvas と TeamView を赤枠で囲んだもの
Canvas の下に TeamView
  1. Hierarchyの「+」>UI (Canvas)>Text – TextMeshProで、テキストを作る(CanvasとEventSystemも一緒に出来る)
  2. テキストの名前をTeamViewにする
Canvas の Inspector。Canvas Scaler の UI Scale Mode が Scale With Screen Size、Reference Resolution が X 1920・Y 1080、Screen Match Mode が Match Width Or Height、Match が 0.5。この3つを赤枠で囲んだもの
Canvas Scaler は Full HD を基準に

CanvasのCanvas Scalerは、Game ビューと同じFull HDを基準にします。

  • UI Scale Mode:Scale With Screen Size
  • Reference Resolution:X 1920・Y 1080
  • Match:0.5

TeamViewは、画面の左上に置きます。

  • Rect Transform:アンカーを左上(top・left)、Pivot X 0・Y 1、Pos X 60・Pos Y -60、Width 600・Height 400
  • TextMeshPro:Font Size 48、Alignment は左上

TeamViewを作る

Assets/ScriptsにTeamView.csを作ります。チームの名前と、メンバーを1行ずつ出すだけのスクリプトです。

using System.Collections.Generic;
using System.Text;
using Nakama;
using TMPro;
using UnityEngine;

// チームのメンバーの一覧を、オンラインかどうかの印を付けて画面に出す
public class TeamView : MonoBehaviour
{
    [SerializeField] private TMP_Text membersText;

    public void Show(string teamName, IEnumerable<IApiUser> members, ICollection<string> onlineUserIds)
    {
        StringBuilder builder = new StringBuilder();
        builder.AppendLine(teamName);
        foreach (IApiUser member in members)
        {
            if (onlineUserIds.Contains(member.Id))
            {
                // オンライン:緑の●
                builder.AppendLine($"<color=#4CD964>●</color> {member.DisplayName}");
            }
            else
            {
                // オフライン:名前ごと灰色
                builder.AppendLine($"<color=#808080>○ {member.DisplayName}</color>");
            }
        }
        membersText.text = builder.ToString();
    }
}
  • members:チームのメンバー(Nakamaのユーザー)
  • onlineUserIds:今オンラインの人のユーザーID。ここに入っている人が緑の●、入っていない人は灰色の○になる
  • <color=…>は、TextMeshProのリッチテキストのタグです。1つのテキストの中で、一部だけ色を変えられます
TeamView の Inspector。Rect Transform・Canvas Renderer・TextMeshPro - Text (UI) はたたんであり、Team View (Script) の Members Text に「TeamView (Text Mesh Pro UGUI)」。Members Text を赤枠で囲んだもの
Members Text に、同じゲームオブジェクトのテキストを入れる

TeamViewのゲームオブジェクトにTeamViewを付けて、Members Textに同じゲームオブジェクトのTextMeshProを入れます。

TeamManagerを直そう

TeamManager.csを直します。チームを探す・作る・入るところ(FindMyTeamAsync・JoinOrCreateAsync・FindTeamAsync)は前回のままなので、...で省いています。前回のShowMembersAsyncは、LoadMembersAsyncとShowMembersに分けました。

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

// チーム(Nakama の Group)に入って、メンバーとオンラインかどうかを画面に出す
public class TeamManager : MonoBehaviour
{
    // グループのチャンネルに Nakama が送ってくる「誰かがグループに入った」の知らせ
    private const int GroupJoinCode = 3;

    // 1チームに入れる人数
    [SerializeField] private int maxMemberCount = 10;
    [SerializeField] private TeamView teamView;

    private IClient client;
    private ISession session;
    private ISocket socket;
    private IApiGroup team;
    private IApiUser[] members = new IApiUser[0];
    // 今オンラインのメンバーのユーザーID
    private readonly HashSet<string> onlineUserIds = new HashSet<string>();

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

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

        socket.ReceivedStatusPresence += OnStatusPresence;
        socket.ReceivedChannelMessage += OnChannelMessage;
        // 先にチームのチャンネルに入っておく(このあとチームに入った人は、知らせで分かる)
        await socket.JoinChatAsync(team.Id, ChannelType.Group);
        await LoadMembersAsync();
    }

    ...

    // メンバーの一覧をもらって、自分のほかのメンバーをフォローする
    private async Task LoadMembersAsync()
    {
        IApiGroupUserList groupUserList = await client.ListGroupUsersAsync(session, team.Id, null, maxMemberCount, null);
        members = groupUserList.GroupUsers.Select(groupUser => groupUser.User).ToArray();
        string[] otherUserIds = members.Select(member => member.Id).Where(userId => userId != session.UserId).ToArray();

        // フォローすると、その中で今オンラインの人が返ってくる
        IStatus status = await socket.FollowUsersAsync(otherUserIds);
        onlineUserIds.Clear();
        onlineUserIds.Add(session.UserId);
        foreach (IUserPresence presence in status.Presences)
        {
            onlineUserIds.Add(presence.UserId);
        }
        ShowMembers();
    }

    // フォローしている人が、オンラインになった・オフラインになった
    private void OnStatusPresence(IStatusPresenceEvent presenceEvent)
    {
        foreach (IUserPresence presence in presenceEvent.Leaves)
        {
            onlineUserIds.Remove(presence.UserId);
        }
        foreach (IUserPresence presence in presenceEvent.Joins)
        {
            onlineUserIds.Add(presence.UserId);
        }
        ShowMembers();
    }

    // チームのチャンネルに知らせが来た
    private async void OnChannelMessage(IApiChannelMessage message)
    {
        if (message.GroupId != team.Id || message.Code != GroupJoinCode)
        {
            return;
        }
        Debug.Log("チームに新しいメンバーが入りました");
        try
        {
            await LoadMembersAsync();
        }
        catch (ApiResponseException e)
        {
            Debug.LogError($"メンバーの一覧をもらえませんでした:{e.Message}");
        }
    }

    private void ShowMembers()
    {
        teamView.Show(team.Name, members, onlineUserIds);
        string[] onlineNames = members.Where(member => onlineUserIds.Contains(member.Id)).Select(member => member.DisplayName).ToArray();
        Debug.Log($"「{team.Name}」のオンライン({onlineNames.Length}/{members.Length}人):{string.Join("、", onlineNames)}");
    }
}

EnterAsyncに、ソケット(ISocket)を渡してもらうようにしました。ステータスもチャンネルも、ソケットでやり取りするからです。

チャンネルに入ってから、一覧をもらう

先にチャンネルに入ってから、一覧をもらう。上の段「逆の順番だと…」:一覧をもらう(フェアリーはまだいない)→ フェアリーが入る(チャンネルにいないので、知らせが届かない)→ チャンネルに入る(フェアリーは一覧にも知らせにも出ない)。下の段「このシリーズの順番」:チャンネルに入る(ここから先の知らせは届く)→ 一覧をもらう(ここまでに入った人は、全員出る)→ フェアリーが入る(知らせ(コード3)→ 一覧を読み直す)
順番を逆にすると、そのあいだに入った人を見のがす
await socket.JoinChatAsync(team.Id, ChannelType.Group);
await LoadMembersAsync();

JoinChatAsyncのChannelType.Groupで、チームのグループのチャンネルに入ります。グループのチャンネルに入れるのは、そのグループのメンバーだけです。

ここは、チャンネルに入るのが先、一覧をもらうのはあとにしています。逆にすると、一覧をもらってからチャンネルに入るまでのあいだにチームに入った人が、一覧にも知らせにも出てきません。

フォローして、今オンラインの人をもらう

IStatus status = await socket.FollowUsersAsync(otherUserIds);

LoadMembersAsyncでは、前回と同じようにListGroupUsersAsyncでメンバーをもらってから、自分のほかのメンバーをフォローします。

  • FollowUsersAsyncの答えのPresencesに、フォローした人のうち今オンラインの人が入っている
  • 自分は、フォローしなくてもオンラインなので、先にonlineUserIdsに入れておく
  • 前回と同じく、ListGroupUsersAsyncの人数(limit)は必ず書く(書かないと1人しか返ってこない)

来た・帰ったで、印を付け直す

OnStatusPresenceは、フォローしている人がつないだり切れたりしたときに呼ばれます。

  • Leavesの人はonlineUserIdsから外し、Joinsの人は足す
  • Leavesを先、Joinsをあとにする。ステータスを変えたときは、古いステータスのLeavesと新しいステータスのJoinsが1回の通知でまとめて届くので、逆にするとオンラインのままの人が消えてしまう

#3でソケットをuseMainThread: trueで作ったので、この通知はUnityのメインスレッドで呼ばれます。そのまま画面のテキストを書き換えて大丈夫です。

チームに入った知らせで、一覧を読み直す

OnChannelMessageは、チャンネルにメッセージが届いたときに呼ばれます。自分のチームのチャンネルで、Codeが3(グループに入った)のときだけ、LoadMembersAsyncで一覧をもらい直して、新しい人もフォローします。

async void の中の try/catch

OnChannelMessageは、ソケットのイベントから呼ばれるのでasync voidにしています。async voidのメソッドで例外が出ると、呼んだ側では受け取れません。

そのため、LoadMembersAsyncの失敗(サーバーが止まったときなど)は、このメソッドの中のtry/catchで受け取ってログに出しています。

NakamaConnectionとInspectorをつなごう

NakamaConnection.csは、EnterTeamAsyncの1行だけ直します。ソケットもTeamManagerに渡します。

await teamManager.EnterAsync(client, session, socket, teamName);

Startでは、前回と同じくConnectSocketAsyncのあとにEnterTeamAsyncを呼んでいるので、ソケットはもうつながっています。

Nakama のゲームオブジェクトの Inspector。Nakama Connection (Script) の Team Manager に「Nakama (Team Manager)」、Team Manager (Script) の Max Member Count は 10、Team View に「TeamView (Team View)」。Team View の欄を赤枠で囲んだもの
Team Manager の Team View に、TeamView を入れる

HierarchyでNakamaを選び、Team ManagerのTeam Viewに、TeamViewのゲームオブジェクトを入れます。シーンを保存しておきます。

前回と同じく、シーンを直したあとの最初の再生で仮想プレイヤーだけエラーになるときは、Multiplayer Play Modeの窓でPlayer 2〜4のチェックを外して入れ直します。

4人で確かめよう

初めての再生

4つの窓を2行2列に並べたところ(初めての再生)。Player 2 の Game に「赤チーム ●スライム ●フェアリー」、Player 3 と Player 4 の Game に「青チーム ●メデューサ ●キョンシー」。Player 4 の Console に「「青チーム」のオンライン(1/1人):メデューサ」「チームに新しいメンバーが入りました」「「青チーム」のオンライン(2/2人):メデューサ、キョンシー」。一覧と3行のログを赤枠で囲んだもの
先にチームを作った人の一覧にも、あとから入った人が出た

前回の「先に入った人には、あとの人が見えない」を確かめるために、Nakamaのデータを空にしてから(docker compose down -v→docker compose up -d)、メインのエディタで再生しました。

メインのエディタ(スライム)。Game ビューに「赤チーム ●スライム ●フェアリー」。Console に「「赤チーム」を作りました」「「赤チーム」のオンライン(1/1人):スライム」「チームに新しいメンバーが入りました」「「赤チーム」のオンライン(2/2人):スライム、フェアリー」。一覧と最後の3行のログを赤枠で囲んだもの
スライムの一覧に、あとから入ったフェアリーが足された

チームを作ったスライム(メインのエディタ)のログは、次のようになりました。

「赤チーム」を作りました
「赤チーム」のオンライン(1/1人):スライム
チームに新しいメンバーが入りました
「赤チーム」のオンライン(2/2人):スライム、フェアリー

作った直後は1人だけでしたが、フェアリーが入ったところでコード3の知らせが届いて、一覧が2人になりました。今回は青チームはメデューサが先に作り、メデューサのログも同じ流れになりました(どちらが先にチームを作るかは、再生するたびに変わります)。

あとから入ったフェアリーとキョンシーは、入った時点で2人の一覧をもらい、相手をフォローして、相手がオンラインなのも分かっています。

画像では、見やすいように仮想プレイヤーの窓のGameとConsoleを左右に並べています。並べ方は、動きには関係ありません。

Consoleで知らせを見る

Nakama の Console の Chat Messages。種類に Group Chat、赤チームのグループID を入れて Search。Code 3、Sender ID c7daaae1-…、Username UiqraCAtEH、Content {} の1行。1行を赤枠で囲んだもの
グループのチャンネルに、コード3の知らせが残っている

NakamaのConsole(http://localhost:7351)のChat Messagesで、左の欄をGroup Chatにして、赤チームのグループIDで探しました(グループIDは、Groupsで赤チームを開くと分かります)。

Codeが3の知らせが1つあり、UsernameはUiqraCAtEHでした。Player 2のConsoleの「ログインしました:UiqraCAtEH(…)」と同じなので、フェアリーが入ったときの知らせです。

2回目の再生

止めて、もう一度再生しました。今度は4人とも前回のチームのままで、全員の一覧に、チームの2人とも緑の●が付きました(記事のいちばん上の画像)。

先に動いた人は、相手がまだつないでいないので「オンライン(1/2人)」になり、相手がつないだところでJoinsが届いて「オンライン(2/2人)」に変わりました。

「青チーム」に入っています
「青チーム」のオンライン(1/2人):キョンシー
「青チーム」のオンライン(2/2人):メデューサ、キョンシー

1人がゲームを閉じると

キョンシー(Player 3)の画面を左右に並べたもの。左「メデューサがいるとき」:Game に「青チーム ●メデューサ ●キョンシー」。右「Player 4 のチェックを外したあと」:Game に「青チーム ○メデューサ(灰色) ●キョンシー」、Console の最後に「「青チーム」のオンライン(1/2人):キョンシー」。一覧と最後のログを赤枠で囲んだもの
メデューサが帰ると、灰色の○になる

再生したまま、Multiplayer Play Modeの窓でPlayer 4(メデューサ)のチェックを外しました。メデューサのエディタが閉じてソケットが切れ、キョンシーにはLeavesが届きました。

  • キョンシーの一覧で、メデューサが灰色の○になった
  • Consoleに「「青チーム」のオンライン(1/2人):キョンシー」

チェックを外して少しすると、一覧が変わりました。メデューサはチームから抜けたわけではないので、一覧には残ったままです。

スライム

メンバーだけど今はいない、が分かるようになったね!

今回の通信チェック

  • 4人の画面の左上に、チームの一覧が出た(オンラインは緑の●)
  • 初めての再生で、先にチームを作った人の一覧にも、あとから入った人が足された(コード3の知らせ)
  • NakamaのConsoleのChat Messagesに、グループのチャンネルのコード3の知らせがあった
  • 2回目の再生で、あとからつないだ人がJoinsでオンラインになった
  • Player 4を外すと、Leavesでメデューサが灰色になった
プロジェクトの環境
  • 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)
  • フォント:Noto Sans JP(TextMeshProのフォントアセット)
フェアリー

誰がいるか分かったから、次はいよいよ対戦の部屋ね。部屋はサーバーのコードで作るわよ

次回は

次回は、Nakamaのサーバーのコード(TypeScript)で対戦の部屋(権威マッチ)を作ります。4人が同じ部屋に入って、入った人の名前が全員の画面に出るところまでやりたいと思います。

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

コメント

コメント一覧 (1件)

コメントする

目次