feat(SyncDictionary): Add individual Actions for operations

[MrGadget1024]

• Set and Remove Actions pass OLD item
• Deprecates Callback Action

With the new Set and Remove Actions, users will be able to do work with the previous values, while accessing the new values by the dictionary key.

Below is an example that would be applicable for a card game or inventory:

using UnityEngine;
using Mirror;
using System;

public class SyncDictTest : NetworkBehaviour
{
    public struct ItemData
    {
        public byte prefabIndex;
        public Vector3 position;
        public Quaternion rotation;

        // this is not networked or serialized, it's only used on the client
        // to hold reference to the instantiated object for a dictionary item.
        [NonSerialized]
        public GameObject clientObject;

        public void CreateClientObject(GameObject prefab, Vector3 pos, Quaternion rot)
        {
            clientObject = Instantiate(prefab, pos, rot);
        }
    }

    public GameObject[] prefabs;

    public readonly SyncDictionary<ushort, ItemData> dict = new SyncDictionary<ushort, ItemData>();

    ushort nextIndex = 0;

    void Awake()
    {
        dict.OnAdd = OnAdd;
        dict.OnSet = OnSet;
        dict.OnRemove = OnRemove;
        dict.OnClear = OnClear;
    }

    public override void OnStartClient()
    {
        // Handlers not setup when spawned...call OnAdd for each.
        foreach (ushort key in dict.Keys)
            dict.OnAdd?.Invoke(key);
    }

    void OnAdd(ushort key)
    {
        dict[key].CreateClientObject(prefabs[dict[key].prefabIndex], dict[key].position, dict[key].rotation);
    }

    void OnSet(ushort key, ItemData oldItem)
    {
        if (dict[key].prefabIndex != oldItem.prefabIndex)
        {
            if (oldItem.clientObject != null)
                Destroy(oldItem.clientObject);

            dict[key].CreateClientObject(prefabs[dict[key].prefabIndex], dict[key].position, dict[key].rotation);
        }
        else
        {
            oldItem.clientObject.transform.position = dict[key].position;
            oldItem.clientObject.transform.rotation = dict[key].rotation;
        }
    }

    void OnRemove(ushort key, ItemData oldItem)
    {
        if (oldItem.clientObject != null)
            Destroy(oldItem.clientObject);
    }

    void OnClear()
    {
        foreach (ItemData itemData in dict.Values)
            if (itemData.clientObject != null)
                Destroy(itemData.clientObject);
    }

    [Command]
    public void CmdAddItem(byte prefabIndex, Vector3 position, Quaternion rotation)
    {
        dict[nextIndex] = new ItemData
        {
            prefabIndex = prefabIndex,
            position = position,
            rotation = rotation
        };

        nextIndex++;
    }

    [Command]
    public void CmdSetItem(ushort key, byte prefabIndex, Vector3 position, Quaternion rotation)
    {
        if (dict.TryGetValue(key, out ItemData item))
        {
            item.prefabIndex = prefabIndex;
            item.position = position;
            item.rotation = rotation;
            dict[key] = item;
        }
    }

    [Command]
    public void CmdReplaceItem(ushort key, byte prefabIndex)
    {
        if (dict.TryGetValue(key, out ItemData item))
        {
            item.prefabIndex = prefabIndex;
            dict[key] = item;
        }
    }

    [Command]
    public void CmdMoveItem(ushort key, Vector3 position)
    {
        if (dict.TryGetValue(key, out ItemData item))
        {
            item.position = position;
            dict[key] = item;
        }
    }

    [Command]
    public void CmdRotateItem(ushort key, Quaternion rotation)
    {
        if (dict.TryGetValue(key, out ItemData item))
        {
            item.rotation = rotation;
            dict[key] = item;
        }
    }

    [Command]
    public void CmdRemoveItem(ushort key)
    {
        dict.Remove(key);
    }

    [Command]
    public void CmdClearItems()
    {
        dict.Clear();
    }
}