やはり俺のターンがまわってこないのはまちがっている。#10|Nakamaで状態をそろえる:途中から入った人には全体、ふだんは差分

4人の Game ビューを2行2列に並べたコマ送りの GIF(約20秒)。左上がスライム(赤チーム・メインのエディタ)、右上がフェアリー(赤チーム・オート)、左下がキョンシー(青チーム・オート)、右下がメデューサ(青チーム・あとから入る)。初めは右下が「メデューサはまだいない(Player 4 を止めている)」の板で、3人の画面の盤で赤と青のコマが進む。途中でメデューサが入ると、右下にも同じ盤・同じ「○ターン目:○チームの番(代表:○○)」が出て、そのあとは4人の画面がそろって進む
今回のゴール:あとから入った人も、同じ盤面になる

前回は、番が来たチームの代表だけが操作できるようになりました。ここまでは、何か変わるたびに、サーバーが状態の全体(部屋にいる人・チーム・コマの位置・番・代表)を毎回全員に送っていました。今回は、それを「入った人には全体、ふだんは変わったところ(差分)だけ」に分けます。試合の途中から入った人にも、同じ盤面が出るかを確かめます。

目次

今回やること

入った人には全体、変わったら全員に差分。上の Nakama(部屋の状態:players・teams・turnNumber…、version:変わるたびに +1、今は version 16)から、左のスライム・フェアリー・キョンシーへ緑の矢印「opcode 2:差分を全員に(サイコロを振った・代表が変わった…、約285バイト)」、右のあとから入ったメデューサへオレンジの矢印「opcode 1:状態の全体を、入った人だけに(盤・チーム・番・代表のすべて、約886バイト)」。真ん中に「入るまでの差分は、全体の中に入っている」
全体は入った人だけ、差分は全員に
  • サーバーの状態に、変わるたびに1つ増えるversionを持たせる
  • 状態の全体(opcode 1)は、部屋に入った人にだけ送る
  • サイコロ・代表・人の出入りは、変わったところだけを差分(opcode 2)で全員に送る
  • Unityは、届いた全体を持っておき、差分を当てて画面を書きかえる

盤もゲームの中身も、前回と同じです。変わるのは、サーバーとUnityのあいだで「何を送るか」だけです。見た目は変わりませんが、あとで盤やお金・アイテムが増えたときに効いてきます。

状態の全体と差分

毎回ぜんぶ送ると、何が困るの?

状態の全体と、差分の中身。左の「状態の全体(opcode 1)」は version 16、players 4人(ID・名前・チーム)、teams 2チーム(ID・名前・マス)、turnNumber・turnTeamIndex 13・0、representativeUserId スライムのID、lastRoll 前の番のサイコロ。「メデューサに届いた大きさ:886バイト」。右の「差分「rolled」(opcode 2)」は version・kind 17・rolled、turnNumber・turnTeamIndex 14・1(番の情報は毎回)、representativeUserId キョンシーのID、teamId・position 動いたチームと、そのマス、lastRoll 今振ったサイコロ。「全員に届いた大きさ:285バイト」
全体は886バイト、差分は285バイト

サイコロを1回振っても、変わるのは「1つのチームのマス・前の番のサイコロ・次の番と代表」だけです。それなのに、部屋にいる全員の名前やID、全チームの情報まで毎回送っていました。

今回の4人・2チームの部屋で比べると、全体は886バイト、サイコロを振ったときの差分は285バイトでした。今はまだ小さいですが、このあと盤のマスの種類・お金・アイテム・人数が増えると、全体はどんどん大きくなり、それを毎回全員に送ることになります。差分なら、何が増えても「変わったところ」だけです。

スライム

全部送るほうが、作るのはラクなんだけどなあ・・・

フェアリー

最初はそれでいいのよ。でも途中から入った人のぶんと、ふだんのぶんは分けておくと、あとで助かるわ

差分の形を決める

差分は4種類。joined:人が入った(matchJoin)、player と新しく加わったチーム、Unity では players に足す(チームも足す)。left:人が抜けた(matchLeave)、userId、players から外す。rolled:サイコロを振った(rollDice)、teamId・position・lastRoll、そのチームのマスと前の番を書きかえる。representative:代表をゆずった(passRepresentative)、番の情報だけ、代表を書きかえる。下に「どの差分にも:version・turnNumber・turnTeamIndex・representativeUserId」
差分の種類は kind で分ける

Server/src/main.tsを直します。まず、メッセージの種類に差分(2)を足します。

// メッセージの種類
enum OpCode {
    // サーバー → 入った人:状態の全体
    Snapshot = 1,
    // サーバー → 全員:差分(変わったところだけ)
    Diff = 2,
    // 代表 → サーバー:サイコロを振る(何ターン目のつもりか)
    RollDice = 10,
    // 代表 → サーバー:代表をゆずる(何ターン目のつもりか)
    PassRepresentative = 12,
}

差分の形です。kindで種類を分け、種類ごとに使う欄を変えます。

// 差分の種類
type DiffKind = "joined" | "left" | "rolled" | "representative";

// 差分(opcode 2)。番の情報(turnNumber・turnTeamIndex・representativeUserId)は小さいので毎回入れる
interface StateDiff {
    // 何番目の変化か(状態の全体の version の続き)
    version: number;
    kind: DiffKind;
    turnNumber: number;
    turnTeamIndex: number;
    representativeUserId: string;
    // joined:入った人と、新しく加わったチーム(加わっていなければ null)
    player?: Player;
    team?: Team | null;
    // left:抜けた人
    userId?: string;
    // rolled:動いたチームと、そのマス・振ったサイコロ
    teamId?: string;
    position?: number;
    lastRoll?: DiceRoll | null;
}

// sendDiff に渡す、変わったところ(version と番の情報は sendDiff が入れる)
type DiffChange = Pick<StateDiff, "kind" | "player" | "team" | "userId" | "teamId" | "position" | "lastRoll">;
  • type DiffKind = "joined" | ...:TypeScriptでは、決まった文字列だけを入れられる型を作れる。ほかの文字列を入れると、ビルドでエラーになる
  • player?: Playerの?:無くてもよい欄。JSON.stringifyは、値が入っていない欄を書き出さない
  • 番の情報(何ターン目・どのチーム・代表)は、どの差分にも入れる。小さいので、毎回入れたほうがUnity側が簡単になる
  • Pick<StateDiff, …>:StateDiffから、書いた欄だけを持つ型を作る

RoomStateには、versionを足しておきます(matchInitでは0)。

interface RoomState {
    room: string;
    // 状態が変わるたびに1つ増える番号(差分の順番を確かめるため)
    version: number;
    // (ここから下は前回のまま)
    players: Player[];

version で順番を確かめる

version で、当てるか捨てるかを決める。左の「状態の全体:version 16(メデューサが持っている状態)」から、右に並んだ差分へ。差分 version 16(joined)→ 16 以下 → もう入っているので捨てる(赤)。差分 version 17(rolled)→ 16 の次 → 当てて、version 17 に(緑)。差分 version 18(rolled)→ 17 の次 → 当てて、version 18 に(緑)。差分 version 20 が来たら → 19 が抜けている → 警告を出す(オレンジ)
持っている version の次だけを当てる

差分は「前の状態に当てる」ものなので、順番が大事です。そこで、状態が変わるたびにversionを1つ増やし、全体にも差分にも入れて送ります。

// 状態の全体を、渡した人にだけ送る(入ったばかりの人)
function sendSnapshot(logger: nkruntime.Logger, dispatcher: nkruntime.MatchDispatcher, state: RoomState, presences: nkruntime.Presence[]) {
    const snapshot = {
        version: state.version,
        players: state.players,
        teams: state.teams,
        turnTeamIndex: state.turnTeamIndex,
        turnNumber: state.turnNumber,
        representativeUserId: state.representativeUserId,
        lastRoll: state.lastRoll,
    };
    const json = JSON.stringify(snapshot);
    dispatcher.broadcastMessage(OpCode.Snapshot, json, presences);
    logger.info("状態の全体を%d人に送りました(version %d、%d文字)", presences.length, state.version, json.length);
}

// 変わったところだけを、全員に送る。version を1つ進め、ラベルの人数も直す
function sendDiff(logger: nkruntime.Logger, dispatcher: nkruntime.MatchDispatcher, state: RoomState, change: DiffChange) {
    state.version++;
    const diff: StateDiff = {
        version: state.version,
        kind: change.kind,
        turnNumber: state.turnNumber,
        turnTeamIndex: state.turnTeamIndex,
        representativeUserId: state.representativeUserId,
        player: change.player,
        team: change.team,
        userId: change.userId,
        teamId: change.teamId,
        position: change.position,
        lastRoll: change.lastRoll,
    };
    const json = JSON.stringify(diff);
    dispatcher.broadcastMessage(OpCode.Diff, json);
    dispatcher.matchLabelUpdate(makeLabel(state));
    logger.info("差分「%s」を全員に送りました(version %d、%d文字)", change.kind, state.version, json.length);
}
  • sendSnapshot:broadcastMessageの3つ目に送る人(presences)を渡すと、その人にだけ届く。渡さなければ全員に届く
  • sendDiff:versionを1つ進めてから、番の情報と変わったところを全員に送る

Unity側は、持っている状態のversionの次の番号の差分だけを当てます。持っているversion以下の差分は、もう状態に入っているので捨てます。番号が飛んだら、どこかの差分が抜けたということなので、警告を出します。

途中から入った人に全体を送る

ほかの人には差分、入った人には全体

matchJoinを直します。

// 入った人を覚えて、ほかの人には差分、入った人には状態の全体を送る
function matchJoin(ctx: nkruntime.Context, logger: nkruntime.Logger, nk: nkruntime.Nakama, dispatcher: nkruntime.MatchDispatcher, tick: number, state: RoomState, presences: nkruntime.Presence[]): { state: RoomState } | null {
    // 表示名は presence に無いので、ユーザーの情報をもらう
    const users = nk.usersGetId(presences.map(presence => presence.userId));
    for (const user of users) {
        // チームはサーバーが調べる(クライアントの言うことを信じない)
        const group = findTeamOfUser(nk, user.userId);
        let teamId = "";
        let addedTeam: Team | null = null;
        if (group != null) {
            teamId = group.id;
            addedTeam = addTeam(logger, state, group);
        }
        // 同じ人が入り直したときは、前の分を外してから足す
        state.players = state.players.filter(player => player.userId != user.userId);
        const player: Player = { userId: user.userId, name: user.displayName || user.username, teamId: teamId };
        state.players.push(player);
        logger.info("部屋「%s」に%sが入りました", state.room, player.name);
        // まだ代表がいなければ(最初の人・番のチームに誰もいなかったとき)、選ぶ
        if (state.representativeUserId == "") {
            pickRepresentative(logger, state);
        }
        sendDiff(logger, dispatcher, state, { kind: "joined", player: player, team: addedTeam });
    }
    // 入った人には、今の状態の全体を送る(ここまでの差分は、この中に入っている)
    sendSnapshot(logger, dispatcher, state, presences);
    return { state: state };
}
  1. 入った人をplayersに足し、まだ代表がいなければ選ぶ
  2. もう部屋にいる人には、差分「joined」を送る(新しいチームなら、そのチームも入れる)
  3. 最後に、入った人にだけ状態の全体を送る

差分「joined」は全員に送るので、入った本人にも届きます。でも、そのあとに届く全体のversionのほうが新しいので、本人は差分を捨てます(上の図の「version 16(joined)」)。

addTeamは、新しく加えたチームを返すように変えました(もうあればnull)。

// まだ無いチームなら、番の順の最後に足して、そのチームを返す。もうあれば null
function addTeam(logger: nkruntime.Logger, state: RoomState, group: nkruntime.Group): Team | null {
    const found = state.teams.filter(team => team.id == group.id);
    if (found.length > 0) {
        return null;
    }
    const team: Team = { id: group.id, name: group.name, position: 0 };
    state.teams.push(team);
    logger.info("部屋「%s」に%sが加わりました(%d番目)", state.room, group.name, state.teams.length);
    return team;
}

抜けた・振った・ゆずったも差分に

前回までsendSnapshot(dispatcher, state)を呼んでいたところを、すべてsendDiffに変えます。

// matchLeave:抜けた人を外して(代表なら選び直して)から
sendDiff(logger, dispatcher, state, { kind: "left", userId: presence.userId });

// rollDice:コマを進めて、次のチームと代表にしてから
sendDiff(logger, dispatcher, state, { kind: "rolled", teamId: turnTeam.id, position: turnTeam.position, lastRoll: state.lastRoll });

// passRepresentative:代表を変えてから
sendDiff(logger, dispatcher, state, { kind: "representative" });

代表をゆずったときの差分「representative」には、番の情報(新しい代表)しか入っていません。番の情報をどの差分にも入れておいたので、これだけで済みます。

書き終えたら、前回と同じくServerフォルダでdocker compose up -d --buildします。

差分で画面を動かそう

メッセージの種類とJSONの形

OpCode.csに、サーバーと同じ2を足します。

    // サーバー → 入った人:状態の全体
    Snapshot = 1,
    // サーバー → 全員:差分(変わったところだけ)
    Diff = 2,

RoomMessages.csのRoomSnapshotにversionを足し、差分のStateDiffを作ります。

// サーバーから届く、状態の全体(opcode 1)。届いたあとは、差分を当てて持ち続ける
[Serializable]
public class RoomSnapshot
{
    // 何番目の変化までが入っているか
    public int version;
    public RoomPlayer[] players;
    // (ここから下は前回のまま)
// サーバーから届く、差分(opcode 2)。kind ごとに、使う欄が違う
[Serializable]
public class StateDiff
{
    // 何番目の変化か(持っている状態の version の次なら当てる)
    public int version;
    // joined・left・rolled・representative
    public string kind;
    // 番の情報は、どの差分にも入っている
    public int turnNumber;
    public int turnTeamIndex;
    public string representativeUserId;
    // joined:入った人と、新しく加わったチーム(加わっていなければ id が空)
    public RoomPlayer player;
    public TeamState team;
    // left:抜けた人
    public string userId;
    // rolled:動いたチームと、そのマス・振ったサイコロ
    public string teamId;
    public int position;
    public DiceRoll lastRoll;
}

サーバーが書き出さなかった欄は、JsonUtilityでは空の値になります。teamはnullで送っても空のTeamStateが作られるので、新しいチームかどうかはteam.idが空かどうかで見分けます(#8のlastRollと同じです)。

状態を持って、差分を当てる

RoomManager.csを直します。前回までは、届いた状態の全体をそのまま画面に出していました。今回は、届いた全体をroomに持っておき、差分が届いたらroomに当ててから画面に出します。

    // 持っている状態(状態の全体が届いたら入れ、差分を当てて新しくする)
    private RoomSnapshot room;

(前回のturnNumberは消して、room.turnNumberを使います。)

    // サーバーからメッセージが届いた
    private void OnMatchState(IMatchState matchState)
    {
        if (matchState.MatchId != matchId)
        {
            return;
        }
        string json = Encoding.UTF8.GetString(matchState.State);
        if (matchState.OpCode == (long)OpCode.Snapshot)
        {
            // 入ったときに、状態の全体が届く
            room = JsonUtility.FromJson<RoomSnapshot>(json);
            Debug.Log($"状態の全体が届きました(version {room.version}、{matchState.State.Length}バイト)");
            ShowRoom();
        }
        else if (matchState.OpCode == (long)OpCode.Diff)
        {
            StateDiff diff = JsonUtility.FromJson<StateDiff>(json);
            // 状態の全体がまだ届いていないか、もう状態に入っている差分なら捨てる
            if (room == null || diff.version <= room.version)
            {
                return;
            }
            if (diff.version != room.version + 1)
            {
                Debug.LogWarning($"差分が抜けています(持っているのは version {room.version}、届いたのは version {diff.version})");
            }
            ApplyDiff(diff);
            Debug.Log($"差分「{diff.kind}」を当てました(version {diff.version}、{matchState.State.Length}バイト)");
            ShowRoom();
        }
    }

    // 持っている状態に、差分を当てる
    private void ApplyDiff(StateDiff diff)
    {
        room.version = diff.version;
        // 番の情報は、どの差分にも入っている
        room.turnNumber = diff.turnNumber;
        room.turnTeamIndex = diff.turnTeamIndex;
        room.representativeUserId = diff.representativeUserId;
        switch (diff.kind)
        {
            case "joined":
                // 入り直した人は、前の分を外してから足す
                room.players = room.players.Where(player => player.userId != diff.player.userId).Append(diff.player).ToArray();
                if (diff.team != null && !string.IsNullOrEmpty(diff.team.id))
                {
                    room.teams = room.teams.Append(diff.team).ToArray();
                }
                break;
            case "left":
                room.players = room.players.Where(player => player.userId != diff.userId).ToArray();
                break;
            case "rolled":
                TeamState movedTeam = room.teams.First(team => team.id == diff.teamId);
                movedTeam.position = diff.position;
                room.lastRoll = diff.lastRoll;
                break;
            case "representative":
                // 変わったのは代表だけ(番の情報で済んでいる)
                break;
        }
    }
  • OnMatchState:opcode 1ならroomに入れる。opcode 2なら、持っているversionの次かを見てから当てる
  • ApplyDiff:番の情報を書きかえ、kindごとにplayers・teams・lastRollを直す
  • Where・Append・ToArray(System.Linq):配列から外す・配列に足す。JsonUtilityで読むために、playersとteamsは配列のままにしている

画面に出すところはShowRoomにまとめました。中身は前回のOnMatchStateの後半と同じで、snapshotの代わりにroomを使います。

    // 持っている状態を、画面に出す
    private void ShowRoom()
    {
        roomView.Show(roomName, room.players);
        if (room.teams.Length == 0)
        {
            return;
        }
        boardView.Show(room.teams);
        // (代表かどうかを調べて TurnView に出すところ・オートは前回のまま、snapshot を room にする)
    }

サイコロを振る・ゆずるで送る「何ターン目のつもりか」も、room.turnNumberを使います。

roomを持っていても、それを書きかえていいのはサーバーから届いたものだけです。ボタンを押したときに、Unityで先にコマを動かしたり番を進めたりはしません。サーバーが確かめて送ってきた差分だけを当てるので、全員の画面がずれません。

4人で確かめよう

3人で始める

メデューサが入る前の Game ビュー。スライム・フェアリー・キョンシーの3人の画面に、同じ盤と「10ターン目:青チームの番(代表:キョンシー)」。右下は「メデューサはまだいない(Player 4 を止めている)」の板。3人の盤を赤枠で囲んだもの
メデューサ抜きの3人で、何ターンか進める

Nakamaのデータを空にしてから、Multiplayer Play ModeのPlayer 4(メデューサ)のチェックを外して、3人で再生しました。スライムが振り、フェアリー・キョンシーは代表になると自動で振って、15回ほど差分が送られました。

あとからメデューサが入る

メデューサが入ったあとの4人の Game ビュー。4人とも同じ盤(赤と青のコマが同じマス)と「16ターン目:青チームの番(代表:キョンシー)」。盤と番の文字を赤枠で囲んだもの
あとから入ったメデューサにも、同じ盤と番が出た

再生したまま、Multiplayer Play ModeでPlayer 4のチェックを入れました。Player 4が起動して部屋に入ると、メデューサの画面にも、ほかの3人と同じ盤・同じ番・同じ代表が出ました。そのあとのサイコロも、4人の画面でそろって進みました。

サーバーのログです(メデューサが入ったところ)。

赤チームの代表はスライム(2人から)
差分「rolled」を全員に送りました(version 15、279文字)
部屋「room1」にメデューサが入りました
差分「joined」を全員に送りました(version 16、260文字)
状態の全体を1人に送りました(version 16、822文字)
赤チームのスライムが5を出して、4マス目へ
青チームの代表はキョンシー(2人から)
差分「rolled」を全員に送りました(version 17、277文字)
  • メデューサが入ると、ほかの3人には差分「joined」(version 16)、メデューサにだけ状態の全体(version 16)が送られた
  • そのあとのサイコロは、差分「rolled」(version 17)として4人に送られた

届いた大きさ

Player 4(メデューサ)の Console。「部屋「room1」に入りました」のあとに「状態の全体が届きました(version 16、886バイト)」、「13ターン目:赤チームの番、代表はスライム…」、「差分「rolled」を当てました(version 17、285バイト)」。全体と差分の2行を赤枠で囲んだもの
メデューサには、最初に全体、そのあとは差分

メデューサのConsoleでは、最初に状態の全体(version 16、886バイト)が届き、次に差分(version 17、285バイト)を当てていました。全体の中に「joined」の分まで入っているので、version 16の差分は捨てられ、ログにも出ていません。

サーバーのログはJSON.stringifyした文字の数(822文字)、UnityのログはUTF-8のバイト数(886バイト)なので、数字が少し違います。名前などの日本語は、1文字が3バイトになるためです。

メインのエディタは差分だけ

メインのエディタ(スライム)。Game ビューに「18ターン目:青チームの番(代表:メデューサ)」、Console に「差分「rolled」を当てました(version 20、288バイト)」「差分「rolled」を当てました(version 21、286バイト)」。2行のログと番の文字を赤枠で囲んだもの
最初からいた人には、差分だけが届く

最初からいたスライムには、入ったときの全体のあとは、ずっと差分だけが届いていました。18ターン目には、あとから入ったメデューサが青チームの代表に選ばれています。メデューサにはオートを付けていないので、ここで誰かが振るのを待つことになりました。

スライム

途中から入っても、ちゃんと同じ盤になってる!

今回の通信チェック

  • 状態の全体は、入った人にだけ届いた
  • サイコロ・代表・人の出入りは、差分として全員に届いた(全体886バイトに対して、差分は約285バイト)
  • 差分は version の順に当てられ、全体より古い差分は捨てられた
  • あとから入ったメデューサにも、3人と同じ盤・番・代表が出た
プロジェクトの環境
  • 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)、TypeScript 5.9.3

次回は

次回は、切れても止まらないようにします。今は、代表が抜けたらすぐ選び直すだけで、チームに誰もいなくなると試合が止まってしまいます。回線が切れたのか自分で抜けたのかを分けて、戻ってくるのを少し待ったり、誰もいなければ時間切れで進めたりしたいと思います。つなぎ直した人には、今回作った「状態の全体」を送ります。

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

コメント

コメントする

目次