SimpleNetworkUdonBehaviour

SimpleNetworkMonster SimpleNetworkUdonBehaviourは、VRChatのNetworkingがしんどい方のためのNetworkingラッパーなスーパークラスです。 SendCustomNetworkEventメソッドで、引数を扱えない問題を解消する目的で作成されました。

テストワールド

TestWorldScreenShot 下記のリンクからSimpleNetworkUdonBehaviourの挙動を実際に確認することができます。 https://vrchat.com/home/world/wrld_11b7ced1-63a6-49cc-ac2f-8b2537bf435d

一人では確認できないので、Inviteを送って友達と一緒に見てみてね！

特徴

SendCustomNetworkEventでは不可能な、引数の送信を実現します。
SendCustomNetworkEventよりも低レイテンシーな高速同期ができます。
連続でイベントを叩いても自動的に1回の通信にまとめるから安定して動作します。
最後に実行したイベントやイベントログをサーバに保存し、Joinした人に同期できます。
イベント発行者を制限する機能を搭載し、予期せぬイベント発行を防ぎます。
わずらわしい権限問題もForceモードを使えば、自動的に所有権を取得しての送信が可能です。

説明

VRChatでUdonを使ってネットワークプログラミングするためには、プログラムの流れの中で複数台のコンピュータを意識しどのコンピュータがどういう状態にあるかを考えながらプログラミングすることが避けられませんでした。

Udonを使って、ネットワーク上の他のコンピュータの同じオブジェクトのメソッドを呼び出すにはSendCustomNetworkEventを使うのが一般的です。しかしSendCustomNetworkEventは、メソッドを呼び出せるものの、そのメソッドに値を送れないという最大の問題を抱えていました。

SimpleNetworkUdonBehaviourは、VRChatに用意された、UdonSyncedの仕組みを利用してカスタムイベントをコマンド化し OnValueChangedを利用して、コマンドが同期されたタイミングで受信用メソッドを呼び出すことで、引数付きのイベント発行を実現しました。

また、UdonSyncedは高速同期されるため、SendCustomNetworkEventよりも早い応答速度の通信を実現しています。この低レイテンシー同期は、オブジェクトのUdonBehaviourSyncModeをManualに設定することで有効になります。

speedtest

SimpleNetworkUdonBehaviourのSendEventを利用したネットワークイベントの仕組みは、for文で連続実行してもネットワークに負荷をかけません。 SimpleNetworkUdonBehaviourは複数のイベントを自動でひとつにまとめ、一度の通信で全イベントを届けるため、安定して動作します。

また、SendCustomNetworkEventを使うことで引きおこる変化は、基本的にLate-Joiner（後からJoinした人）に同期してくれませんが SimpleNetworkUdonBehaviourには、JoinSync（ジョインシンク）という機能が備わっており、Late-Joinerに指定のイベントを実行したり、連続した指定のイベントをログという形でサーバに保存し、すべてのログ化されたイベントをLate-Joinerに連続的に実行して復元する機能も備わっています。

SimpleNetworkUdonBehaviourには、安全なコードを単純に記述する仕組みも備わっています。ネットワークプログラミングではインスタンスマスターや、オブジェクトオーナーが代表してイベントの送信を担うことがあり if( Networking.IsOwner(gameObject) ) { ... }のようなコードが乱立しがちです。

SimpleNetworkUdonBehaviourには、Publisher（パブリッシャー）という概念が備わっており、初期化時にこのパブリッシャーを設定することで、イベント発行者を限定することができます。この仕組みを使うことで、誤って予期せぬ人から同じイベントが送信されるといったこと防ぐことができるため、どのネットワークイベントを誰が送信しているのかを意識してプログラミングする必要がありません。

また、IsPublisherメソッドを使って、パブリッシャーのみ実行する処理を書いたり SendEventのForceモードを使うことで、パブリッシャーでなくても強制的にイベントを送信することもできます。

使い方

SimpleNetworkUdonBehaviourクラスを継承し、SendEventメソッドを実行することで、インスタンス内にいる全ユーザ（自分も含む）の同一オブジェクトにイベント名と値を届けることができます。イベントの受信は、サブクラスでReceiveEventメソッドをオーバーライドすることで可能となり、第一引数にイベント名が、第二引数に値が届きます。

SimpleNetworkUdonBehaviourを初期化するため、StartメソッドでSimpleNetworkInit呼び出します。
引数付きイベントを全ユーザ（自分を含む）に送信するにはSendEventメソッドを実行します。第一引数にイベント名を、第二引数には値となるデータを設定します。 例：SendEvent("イベント名", "値");
引数付きイベントを受信するにはReceiveEventメソッドをオーバーライドします。第一引数にはイベント名が、第二引数には値が全ユーザ（自分を含む）に届きます。

using UdonSharp;
using UnityEngine;
using VRC.SDKBase;
using VRC.Udon;
using tutinoco;

public class Test : SimpleNetworkUdonBehaviour
{
    void Start()
    {
        SimpleNetworkInit();
        SendEvent("Talk", "こんにちは！");
    }

    public override void ReceiveEvent(string name, string value)
    {
        if( name == "Talk" ) {
            Debug.Log(value); // こんにちは！が全ユーザに届く
        }
    }
}

上記のコードでは、わかりやすさを優先してSendEventメソッドをStartに記述しています。

自らのイベントを自らで呼ぶ使い方もできますが、嬉しいのは、値の送信が可能になったことで、命令されたら動くアクションだけをまとめたクラスを作成できるようになることです。

以下は、命令待ちをするモンスタークラスです。

using UdonSharp;
using UnityEngine;
using VRC.SDKBase;
using VRC.Udon;
using tutinoco;

public class Monster : SimpleNetworkUdonBehaviour
{
    [SerializeField] private Rigidbody rigidbody;
    [SerializeField] private Text fukidashi;

    void Start()
    {
        SimpleNetworkInit();
    }

    public override void ReceiveEvent(string name, string value)
    {
        // 上にジャンプする
        if( name == "jump" ) {
            float power = GetFloat(value);
            rigidbody.AddForce(transform.up*power, ForceMode.Impulse);
        }

        // 前にダッシュする
        if( name == "dash" ) {
            float power = GetFloat(value);
            rigidbody.AddForce(transform.forward*power, ForceMode.Impulse);
        }

        // ふきだしに文字を表示
        if( name == "talk" ) {
            fukidashi.text = value;
        }
    }
}

このモンスタークラスを使って作られたモンスターをジャンプさせるには、適当な場所に以下のコードを記述します。

monster.SendEvent("jump", 5.0f);

もちろん値を送信できるため、ここではfloat型のジャンプ力の指定も行ってイベントを送信しています。

これらモンスターオブジェクトを配列で管理すれば、複数のモンスターを同時に制御することも可能です。

// 複数のモンスターをいろんな強さでジャンプさせる
//（もちろん、どのパソコンから見ても同じように見えるよ！）
foreach( monster in monsters ) {
    float power = Random.Range(3.0f, 6.0f);
    monster.SendEvent("jump", power);
}

対応しているデータ型

SimpleNetworkUdonBehaviourは、基本的に文字列データの送受信を行いますが、Vector3などの型にも対応しています。既に前述のコードでは、ReceiveEventメソッド内でGetFloatを用いてfloat型のデータを受け取っています。

対応している型は、現在bool int float Vector3です。

ReceiveEventで受信したデータはstringに変換されているため GetBool GetInt GetFloat GetVector3 等のメソッドを利用し、元の型に戻して受け取る必要があります。

現在非対応の型に対応してくださった方がいらっしゃいましたら、是非共有してくださると嬉しいです:)

パブリッシャー

SimpleNetworkInitメソッドを利用して初期化するとき、第一引数にパブリッシャーを設定して初期化することができます。

パブリッシャーとは、イベント発行が許されたユーザを限定する安全装置的な機能です。パブリッシャーを設定しないとPublisher.Allが自動的に選択され、誰でもイベントを送信できる状態となります。

Publisher.All 全ての人がパブリッシャーとなり、誰でもSendEventの利用が可能になります。
Publisher.Owner オブジェクト所有者のみSendEventの利用が可能になります。
Publisher.Master インスタンスマスターのみSendEventの利用が可能になります。

この仕組みを使うことで、誤って予期せぬ人から同じイベントが送信されるといったこと防ぐことができるためどのネットワークイベントを誰が送信しているのかを意識してプログラミングする必要がありません。

public class Sample : SimpleNetworkUdonBehaviour
{
    void Start()
    {
        // オブジェクトの所有者のみSendEventの実行を許す
        SimpleNetworkInit( Publisher.Owner );
    }

    void Update()
    {
        // パブリッシャーがOwnerに設定されているため
        // オブジェクト所有者しかSendEventを実行できない
        // そのためOwnerの座標だけが全員に送信される
        SendEvent("SetPosition", gameObject.transform.position);
    }

    public override void ReceiveEvent(string name, string value)
    {
        if( name == "SetPosition" ) {
            // オーナー以外は受け取った座標を反映
            if( !IsPublisher() ) gameObject.transform.position(GetVector3(value));
        }
    }
}

パブリッシャーの設定は安全装置的な機能ですが、IsPublisherメソッドを使ってパブリッシャーに明示的に処理を行わせたりすることもできます。上記のReceiveEvent内のコードでは、IsPublisherメソッドを利用し、イベントを送信してきたパブリッシャー以外のみ座標を同期するような制御をしています。

Forceモード

SendEventには、最後の引数にForceモードが存在しtrueに設定することで、パブリッシャー（イベント発行が許された者）でなくとも、一時的にイベントを送信することができます。このときSimpleNetworkUdonBehaviourは、自動的にオブジェクトの所有権を獲得し、その後でイベントを送信します。

// Forceモードでイベントを強制的に発行
SendEvent("イベント名", "値", true);

パブリッシャーをPublisher.Ownerにしていた場合、Forceモードを利用してイベントを強制的に発行すると、オブジェクト所有者がその人に移るため、パブリッシャーが切り替わって、その後のイベントはその人が担うことになります。

JoinSync

SimpleNetworkUdonBehaviourには、イベントをサーバに記録し、Late-Joiner（後からJoinした人）に実行させる機能が備わっています。この機能をうまく利用することで、複雑なプログラミング無しにLate-Joinerに状態を正しく同期させることができます。

JoinSyncはSendEventメソッドの第三引数に設定します。

// 1000円で売るイベントをサーバにログとして積み上げて送信
SendEvnet("sale", 1000, JoinSync.Logging);

設定できるJoinSyncの値は以下の通りです。

JoinSync.None サーバにイベントを保存せず、Late-Joinerにこのイベントは送信しません。
JoinSync.Latest 同名のイベントの中で、最後に実行されたイベントと値をサーバに保存し、Late-Joinerに送信します。
JoinSync.Logging 同名のイベントの中で、今まで実行されたイベントを全てサーバに保存し、Late-Joinerに連続的に送信します。

サーバに記録されたイベントやイベントログを削除するにはClearJoinSyncEventメソッドを利用します。

// 売ったイベントのログをサーバから削除する
ClearJoinSyncEvent("sale");

オブジェクトに蓄積された、あらゆる全てのイベントを削除するにはイベント名を指定せずに実行します。

// オブジェクトが持つ全てのJoinSyncの記録をサーバから削除
ClearJoinSyncEvent();

ExecEvent

Udonでは、イベントのローカル実行にSendCustomEventが用意されていますが、似たように自身のPCのみでReceiveEventを呼ぶ方法にExecEventメソッドが用意されています。

// イベントを送信せず自分のみイベントを実行する
ExecEvent("イベント名", "値");

ExecEventはローカル動作するため、JoinSyncを設定したり、Forceモードで実行したりすることはできません。

導入

VRChat Creator Companionなどで、適当なUdonSharpプロジェクトを作成または開きます。
Assetsフォルダにtutinocoフォルダを作成し、ダウンロードしたSimpleNetworkUdonBehaviourを配置するかgit clone https://github.com/tutinoco/SimpleNetworkUdonBehaviour.gitを実行します。
Projectウインドウで右クリック → Create → U# Scriptを選択すると、新しいスクリプトの保存先とファイル名を聞かれるのでAssets/Scripts/TestTest.csなどで作成します。
通信を行いたいオブジェクトを作成または選択してインスペクタからAdd Componentをクリック、先ほど作成したスクリプトファイル名TestTestを選択します。（高速同期を有効にするには、ここでUdonBehaviourSyncModeをManualに設定する）
3で作成したU# Scriptを開き、6行目あたりにusing tutinoco;を追加します。
親クラスがUdonSharpBehaviourになっているのでSimpleNetworkUdonBehaviourに変更します。

注意事項

SendCustomNetworkEventのようにメソッドを呼び出すことはできません。 Udonでは、MethodInfoが使用できないため、このような仕様になりましたが、SendCustomNetworkEventは受信用メソッドが増えすぎてしまうため、個人的にこっちのほうが好みです。
OnOwnershipTransferredとOnPreSerializationメソッドを利用しているため、サブクラスでも利用したいときは、親クラスSimpleNetworkUdonBehaviourにも渡してあげる必要があります。
複数コマンドの一括受信に対応するため･（半角中黒）を利用しています。そのため、文字列の送信に･を使うことはできません。
イベント名に:と__init__は利用できません。

SimpleNetworkUdonBehaviour

Install / Use

README

SimpleNetworkUdonBehaviour

テストワールド

特徴

説明

使い方

対応しているデータ型

パブリッシャー

Forceモード

JoinSync

ExecEvent

導入

注意事項