RPC и Stream в SyncHub Cloud

1) Настало время перейти к синхронизации данных и отправки сообщений, а так же вызова функций на экземплярах игрока в других клиентах. Для начала давайте узнаем, что такое Stream в SyncHub Cloud и как им пользоваться. Если говорить простым языком, то Stream - это поток в котором Вы можете синхронизировать данные на своём игровом объекте между клиентами. Примеры, когда Вам пригодится Stream:

1) Синхронизировать одежду которая на персонаже

2) Синхронизировать цвета одежды

3) Синхронизировать здоровье/ману и т.д.

2) Если Вы ещё не до конца поняли, то ничего страшного, применим на практике. Откройте наш проект из прошлого урока, далее откройте префаб Player и давайте создадим ему что вроде оружия дочерним элементом

3) Теперь откройте скрипт PlayerController.cs и добавьте следующий код:

using SyncHubCloud;
using System;
using Unity.VisualScripting;
using UnityEngine;

public class PlayerController : MonoBehaviour
{
    // переменная нашего скрипта SyncHub_ConnectionView который уже висит на префабе Player
    public SyncHub_ConnectionView syncHub_ConnectionView;

    //Скорость перемещения игрока
    public float SpeedMove = 5f;

    // переменные здоровья и объекта оружия
    public int HP;
    public GameObject GunGM;

    private void OnEnable()
    {
        // добавляем событие для слушателя stream потока
        syncHub_ConnectionView.OnGetStream.AddListener(OnGetStream);
    }

    // отписываемся от всех событий при выходе из game сцены
    private void OnDisable()
    {
        syncHub_ConnectionView.OnGetStream.RemoveListener(OnGetStream);
    }

    // функция которая работает с потоком данных, в ней можно проводить синхронизацию
    private void OnGetStream(SyncHub_ConnectionView сonnectionView, string package_name, bool isWriting, params object[] coming_values)
    {
        //Если происходит запись данных
        if (isWriting)
        {
            // передаём наши значения, тут Вы можете передавать любое количество переменных
            //передаём название пакета и 2 значения, включено ли оружее и наше здоровье
            сonnectionView.SendNext("players_data", GunGM.activeSelf, HP);
        }
        else  //иначе если происходит чтение полученных данных
        {
            // смотрим если пришедший пакет не совпадает, не выполняем дальше код
            if (package_name != "players_data") return;
            // соблюдайте порядок чтения данных, в каком порядке отправили, в таком и прочли
            //Включаем или выключаем наше оружие в зависимости от полученного значения
            GunGM.SetActive(coming_values[0].ToBool());
            //получаем количество нашего здоровья 
            HP = coming_values[1].ToInt32();

        }
    }


    void Update()
    {
        // проверка если это наш префаб игрока
        if (syncHub_ConnectionView.IsMine())
        {
      // включение или выключение видимости оружия по нажатию на клавишу "E"
            if(Input.GetKeyDown(KeyCode.E))
            {
                if(GunGM.activeSelf)
                {
                    GunGM.SetActive(false);
                }
                else
                {
                    GunGM.SetActive(true);
                }
            }

            // перемещение вперёд - назад
            transform.position += Vector3.forward * SpeedMove * Input.GetAxis("Vertical") * Time.deltaTime;

            // перемещение влево - вправо
            transform.position += Vector3.right * SpeedMove * Input.GetAxis("Horizontal") * Time.deltaTime;

        }
    }
}

4) После редактирования скрипта добавьте наше оружие в переменную GunGM в инспекторе

5) Снова соберите сборку для windows как в прошлом уроке и запустите 2 клиента. На одном создайте комнату, а на другом подключитесь к ней

Теперь если Вы на одном из клиентов выключите оружие у персонажа по нажатию на клавишу “E”, то и на другом клиенте оно тоже отключится и обратно появится, если включите.

Вот как раз для подобных случаев и не только, нам и понадобится использовать Stream в SyncHub Cloud.

6) Теперь давайте перейдём к RPC в SyncHub Cloud. В нашем случае RPC - Удаленные вызовы процедур — это именно то, что следует из названия, а именно вызовы методов для удаленных клиентов, находящихся в комнате.

Отправка RPC делится на 3 типа, All, Others и ToMe.

• All - Отправляет RPC всем игрокам в комнате, включая себя.

• Others - Отправляет RPC всем, кроме себя

• ToMe - Отправляет RPC себе и всем своим экземплярам у других игроков

7) Предлагаем разобрать RPC на практике. Откройте скрипт PlayerController.cs и допишите там следующий код:

using SyncHubCloud;
using System;
using Unity.VisualScripting;
using UnityEngine;

public class PlayerController : MonoBehaviour
{
    // переменная нашего скрипта SyncHub_ConnectionView который уже висит на префабе Player
    public SyncHub_ConnectionView syncHub_ConnectionView;

    //Скорость перемещения игрока
    public float SpeedMove = 5f;

    // переменные здоровья и объекта оружия
    public int HP;
    public GameObject GunGM;

    public GameObject CubePrefab;

    private void OnEnable()
    {
        // добавляем событие для слушателя stream потока
        syncHub_ConnectionView.OnGetStream.AddListener(OnGetStream);
    }

    // отписываемся от всех событий при выходе из game сцены
    private void OnDisable()
    {
        syncHub_ConnectionView.OnGetStream.RemoveListener(OnGetStream);
    }

    // функция которая работает с потоком данных, в ней можно проводить синхронизацию
    private void OnGetStream(SyncHub_ConnectionView сonnectionView, bool isWriting, params object[] coming_values)
    {
        //Если проиходит запись данных
        if (isWriting)
        {
            // передаём наши значения, тут Вы можете передавать любое количество переменных
            // пока передаём 2 значения, включено ли оружее и наше здоровье
            сonnectionView.SendNext(GunGM.activeSelf, HP);
        }
        else  //иначе если проиходит чтение полученных данных
        {
            for (int i = 0; i < coming_values.Length; i++)
            {
                Debug.Log(coming_values[i].ToString());
            }
            // соблюдайте порядок чтения данных, в каком порядке отправили, в таком и прочли
            //Включаем или выключаем наше оружие в зависимости от полученного значения
            GunGM.SetActive(coming_values[0].ToBool());
            //получаем количество нашего здоровья 
            HP = coming_values[1].ToInt32();

        }
    }


    void Update()
    {
        // проверка если это наш префаб игрока
        if (syncHub_ConnectionView.IsMine())
        {
            // нажатию на клавишу "R"
            if (Input.GetKeyDown(KeyCode.R))
            {
                // С помощью нашего компонента syncHub_ConnectionView мы отправляем вызов функции SpawnObjectCube()
                syncHub_ConnectionView.SyncHub_RPC("SpawnObjectCube", TargetRPC.All);
            }

            // включение или выключение видимости оружия по нажатию на клавишу "E"
            if (Input.GetKeyDown(KeyCode.E))
            {
                if(GunGM.activeSelf)
                {
                    GunGM.SetActive(false);
                }
                else
                {
                    GunGM.SetActive(true);
                }
            }

            // перемещение вперёд - назад
            transform.position += Vector3.forward * SpeedMove * Input.GetAxis("Vertical") * Time.deltaTime;

            // перемещение влево - вправо
            transform.position += Vector3.right * SpeedMove * Input.GetAxis("Horizontal") * Time.deltaTime;

        }
    }

    // все RPC методы которые будут вызываться удалённо должны быть помечены как [SyncHubRPC]
    [SyncHubRPC]
    public void SpawnObjectCube ()
    {
        // спавним куб чуть дальше от нашего префаба
        Vector3 myPos = transform.position;
        myPos = myPos + new Vector3(0, 0, 2f);
        Instantiate(CubePrefab, myPos, CubePrefab.transform.rotation);
    }
}

8) Теперь создайте любой объект, куб или цилиндр, сделайте его префабом, а потом занесите в переменную CubePrefab

9) Соберите сборку и запустите 2 клиента, после нажмите на одном из клиентов клавишу “R” и вы увидите как у всех игроков заспавнится префаб куба, так произошло потому что мы отправили RPC метод всем игрокам включая себя

10) А теперь измените эту строку кода

syncHub_ConnectionView.SyncHub_RPC("SpawnObjectCube", TargetRPC.All); - вместо TargetRPC.All напишите TargetRPC.Others и снова повторите шаг 9. После нажатия на клавишу R, Вы увидите что кубик заспавнился только у другого клиента, а всё потому что мы отправили вызов RPC метода всем кроме себя

11) Вы так же можете передавать неограниченное количество параметров в RPC метод, вот пример: syncHub_ConnectionView.SyncHub_RPC("SpawnObjectCube", TargetRPC.Others, 1, true, 45f);

[SyncHubRPC]
public void SpawnObjectCube (int numberCube, bool isCube, float size)
{
}

12) На этом всё, вы теперь знаете как работает RPC и Stream в SyncHub Cloud.