Duck Game: Гайд по неткоду для мододелов

Понимание того, как работает неткод сделает ваши оружия/предметы совместимыми с мультиплеером без необходимости проводить кучу тестов, и если у вас нет друзей или двух компьютеров, это может сэкономить часы ненужной отладки и безвыходных ситуаций.
P.s данный гайд является переводом. Оригинал: https://steamcommunity.com/sharedfiles/filedetails/?id=1394086869

public StateBinding _frameBinding = new StateBinding("spriteFrame", -1, false, false);
public byte spriteFrame {
      get {
        if (this._chargeAnim == null)
          return (byte) 0;
        return (byte) this._chargeAnim._frame;
      }

      set {
        if (this._chargeAnim == null)
          return;
        this._chargeAnim._frame = (int) value;
      }
    }

public StateBinding _netBounceSoundBinding = (StateBinding) new NetSoundBinding("_bounceSound "); //Statebinding для _bounceSound
public StateBinding _netYellSoundBinding = (StateBinding) new NetSoundBinding("_netYellSound "); //StateBinding для _netYellSound

public NetSoundEffect _bounceSound = new NetSoundEffect(); //Пустой SoundEffect, который будет привязан к функции.

public NetSoundEffect _netYellSound = new NetSoundEffect(new string[3]
    {
      "quackYell01",
      "quackYell02",
      "quackYell03"
    }); //Создание нового NetSoundEffect, который, будучи единожды воспроизведён, запустит три новых звука, и его синхронизация, чтобы остальные игроки услышали новый звук.
public override void Initialize()
{
    _bounceSound.function = new NetSoundEffect.Function(Bounce);
}

void Bounce()
{
    SFX.Play(GetPath("myBounceSound.wav"));
    shake = 5f;
}

public StateBinding _laserStateBinding = (StateBinding) new StateFlagBinding(new string[3]
{
"_charging",
"_fired",
"doBlast"
});
public bool doBlast;
public bool _fired;
public bool _charging;

Пример взят из HugeLaser. На самом деле, поля _charging и_fired в нём не используются, и он зависит от кадра спрайта и индекса анимации, которые, в свою очередь, синхронизированы. И это лучший способ вызова, так как иначе была бы задержка между всеми клиентами. Более того, в Writing Proper Code это работает со StateBindigs (parts).

Типы StateBindigs, которые вам не нужно знать, так как они используются только для оптимизации:

DataBinding(string field) – Работает более эффективно с BitBuffers, и только с ними.
CompressedVec2Binding – Уменьшает размер Vec2. Все конструкторы поступают с максимальными значениями.
CompressedFloatBinding – Уменьшает размер float. Все конструкторы поступают с максимальными значениями.
InterpolatedVec2Binding[/b] – Расширение CompressedFloatBinding с наивысшим приоритетом.

[h]Как писать правильный код, который работает с StateBindinds.[/h]
This is especially important if you’re dealing with stuff like timers or values that change rapidly. Basically what you have to do is write your stuff as if they could randomly skip a bunch of numbers and still work in the end.

Это особенно важно, если вы имеете дело с таймерами или значениями, которые быстро меняются. По сути вам нужно написать код так, как-будто он может случайно пропускать несколько чисел и всё ещё работать

Вот пример: У вас есть float таймер, который уменьшает своё значение каждый фрейм, и как только он достигает нуля, что-то происходит.
Вот, как делать не стоит:

timer–;
if(timer == 0) doStuff();

Это отлично работает в локальной игре; но в онлайне каждый фрейм может отправляться только ограниченное количество данных, и с большой вероятностью значение таймера будет уменьшаться каждые три или больше фрейма. В таком случае, таймер будет уменьшаться как-то так(полагая, что он начинается с 10):
10 -> 10 -> 10 -> 7 -> 7 -> 5 -> 5 -> 5 -> 2 -> 2 -> 2 -> -1 -> -1 -> -3……
Как вы видите, 0 был пропущен и doStuff() никогда не запустился.

Вот, как это исправить:

timer–;
if(timer <= 0) doStuff();

Легко, не так ли? И это действительно заработает!
Иммено из-за этого происходил баг с бесконечной загрузкой интернет-карты. Ландон (разработчик) использовал ==, и когда необходимое число пропускалось из-за кривых карт, оно уходило дальше в бесконечность. К счастью, это было пофикшено в бете.

Хотя, это всего лишь половина пазла, так как не менее важно выбрать правильные значения для синхронизации. Кроме полей _charging и_fired, HugeLaser – это отличный пример того, как должны выглядеть таймеры.

Если кратко, то вот, что там происходит: 2 StateBinding для анимаций, использующие индекс анимации и кадр спрайта. Это может быть использовано для синхронизации анимаций.

StateFlagBinding очень полезен, когда вы имеете дело с несколькими логическими значениями, например, если что-то открыто, закрыто или заблокировано.

Это просто более быстрый способ выполнения множественных логических привязок состояний, который на самом деле довольно сильно устарел.

Параметры должны быть bool для использования, и затем их значения будут сжаты в один ushort. Использование ushort означает, что у вас не может быть более 16 логических полей.

public StateBinding _laserStateBinding = (StateBinding) new StateFlagBinding(new string[3]
{
"_charging",
"_fired",
"doBlast"
});
public bool doBlast;
public bool _fired;
public bool _charging;

Пример взят из HugeLaser. На самом деле, поля _charging и_fired в нём не используются, и он зависит от кадра спрайта и индекса анимации, которые, в свою очередь, синхронизированы. И это лучший способ вызова, так как иначе была бы задержка между всеми клиентами. Более того, в Writing Proper Code это работает со StateBindigs (parts).

Типы StateBindigs, которые вам не нужно знать, так как они используются только для оптимизации:

DataBinding(string field) – Работает более эффективно с BitBuffers, и только с ними.
CompressedVec2Binding – Уменьшает размер Vec2. Все конструкторы поступают с максимальными значениями.
CompressedFloatBinding – Уменьшает размер float. Все конструкторы поступают с максимальными значениями.
InterpolatedVec2Binding[/b] – Расширение CompressedFloatBinding с наивысшим приоритетом.

[h]Как писать правильный код, который работает с StateBindinds.[/h]
This is especially important if you’re dealing with stuff like timers or values that change rapidly. Basically what you have to do is write your stuff as if they could randomly skip a bunch of numbers and still work in the end.

Это особенно важно, если вы имеете дело с таймерами или значениями, которые быстро меняются. По сути вам нужно написать код так, как-будто он может случайно пропускать несколько чисел и всё ещё работать

Вот пример: У вас есть float таймер, который уменьшает своё значение каждый фрейм, и как только он достигает нуля, что-то происходит.
Вот, как делать не стоит:

timer–;
if(timer == 0) doStuff();

Это отлично работает в локальной игре; но в онлайне каждый фрейм может отправляться только ограниченное количество данных, и с большой вероятностью значение таймера будет уменьшаться каждые три или больше фрейма. В таком случае, таймер будет уменьшаться как-то так(полагая, что он начинается с 10):
10 -> 10 -> 10 -> 7 -> 7 -> 5 -> 5 -> 5 -> 2 -> 2 -> 2 -> -1 -> -1 -> -3……
Как вы видите, 0 был пропущен и doStuff() никогда не запустился.

Вот, как это исправить:

timer–;
if(timer <= 0) doStuff();

if(isServerForObject)
  Level.Add(new Crate(500,500));

Да, вам нужно дополнительное условие, и вот зачем:

Так как у каждого клиента запущен свой код оружия, заспавнится 2 коробки; одна локально, и вторая от владельца объекта.
isServerForObject проверяет, владеет ли текущий компьютер объектом, чтобы объект заспавнился только один раз.

На самом деле, вы можете проверять, явлвется ли утка локальной, используя isServerForObject.

На самом деле, есть ещё одна вещь, о которой вам стоит знать, и это Fondleing. По сути, оно позволяет вам взять конотроль над вещью и установить соединение.

public void Fondle(Thing t)
    {
      if (t == null || !Network.isActive || (!this.isServerForObject || !t.CanBeControlled()) || (this.connection != DuckNetwork.localConnection || t.connection == this.connection))
        return;
      t.connection = this.connection;
      ++t.authority;
}

public static void UpdateNetmessageTypes()
public static void UpdateNetmessageTypes() {
IEnumerable subclasses = Editor.GetSubclasses(typeof(NetMessage));
    Network.typeToMessageID.Clear();
    ushort key = 1;
    foreach (System.Type type in subclasses)
    {
        if (type.GetCustomAttributes(typeof(FixedNetworkID), false).Length != 0) {
            FixedNetworkID customAttribute = (FixedNetworkID)type.GetCustomAttributes(typeof(FixedNetworkID), false)[0];
            if (customAttribute != null)
                Network.typeToMessageID.Add(type, customAttribute.FixedID);
        }
    }
    foreach (System.Type type in subclasses) {
        if (!Network.typeToMessageID.ContainsValue(type)) {
            while (Network.typeToMessageID.ContainsKey(key))
                ++key;
            Network.typeToMessageID.Add(type, key);
            ++key;
        }
    }
}

public override void OnPostInitialize() {
    UpdateNetmessageTypes();
}

public override void OnPostInitialize() {
    UpdateNetmessageTypes();
}

Вуаля, теперь вы можете использовать NetMessage в вашем моде.

По сути, все NetMessage, которые вы будете использовать, это события (events).
Вы так же можете использовать обычные NetMessage(NMDuckNetwork), но только если вы отправляете другим данные, такие как кастомные шапки.

Ваш гипотетический NetMessage работает как-то так:
OnSerilize override заполняет битбаффер serializedData данными из каждого поля в вашем классе (в отличие от StateBidning, свойства не работают), затем они пересылается по интервебам(interwebs), где после получения они проходят через OnDeserilize override, где он помещает все значения из битбаффера в правильные поля.

Для всех Netmessage’ей вам понадобится один пустой конструктор, потому что, когда вы получите сообщение, создастся новый объект этого типа, используя пустой конструктор. Если у вас его нет, вас крашнет (не анимеплеер).

Вот, как выглядит простой NetMessage:

class NMTimeLimit : NMDuckNetworkEvent
    {
        public string message;
        public NMTimeLimit()
        {

        }

        public NMTimeLimit(string msg)
        {
            message = msg;
        }

        public override void Activate()
        {          
            base.Activate();
            HUD.AddInputChangeDisplay(message);
        }

    }

Вот список всех типов данных, которые будет автоматически сериализованы и десериализованы(очень важно, чтобы поля были public! иначе они не будут сериализованы):

• string
• float
• double
• byte
• sbyte
• bool
• short
• ushort
• int
• uint
• long
• ulong
• char
• Vec2
• Всё, что наследует или является Thing

При применении этого к уткам: используйте byte для netIndex.

duck.profile.networkIndex

а затем найдите утку, используя

DuckNetwork.profiles[(int) index].duck;

Таким образом, все ваши сообщения, связанные с уткой, будут отправляться намного быстрее, и шансы на рассинхронизацию значительно уменьшатся.

А что, если вы хотите какой-то массив? Поскольку он не поддерживается автоматически, нам придется изменить OnSerilize и OnDeserilize overrirides.

int[] myArray = new int[] { 25,30,29};
protected override void OnSerialize()
{
      base.OnSerialize(); //это то, что автоматически сериализирует поля, так что не убирайте это.

      serializedData.Write(myArray.Length);
      foreach (var num in myArray)
             serializedData.Write(num); //то же самое, что и в примере с BitBuffer'ом

public override void OnDeserialize(BitBuffer msg)
{
      base.OnDeserialize(msg); //автоматически десериализирует поля, не убирайте это.
      //так как при сериализации base.OnSerilize выполнялся первым, base.OnDeserilize тоже должен выполняться первым.

      myArray = new int[msg.ReadInt()];
      for (int i = 0; i < myArray.Length; i++)
          myArray[] = msg.ReadInt();
}
//по сути, вам нужно выяснить, как превратить что-либо в BitBuffer