Fishnet 4.5.X and 4.6.x versions causing `Object was initialized twice without being reset` error

[bahaokten]

General
Unity version: 2022.3.26
Fish-Networking version: tested versions: 4.5.7, 4.6.4, 4.6.5
Discord link: https://discord.com/channels/424284635074134018/1352538645684424796/1352538645684424796

Description
For some nested object structures, object initialization throws Object was initialized twice without being reset. error

Replication
Steps to reproduce the behavior:

1. Make a nested object in the structure of ROOT NOB -> SOME NOB or NON NOB -> PARENT NOB -> LEAF NOB
2. Start as Host
3. Switch to a scene with the problematic object structure to initialize as Host

Steps to reproduce with provided unity proj Download Link

1. Add EntryScene and NestedNobsScene to the build
2. Start EntryScene
3. Observe the error for Leaf nob initialization

Expected behavior
All objects initialize as expected

Screenshots
If applicable, add screenshots to help explain your problem.

[FirstGearGames]

Updated to waiting on a test package using our bug report format please
https://fish-networking.gitbook.io/docs/manual/guides/creating-bug-reports#guidelines

[bahaokten]

Test project in unity pkg format: LINK

[FirstGearGames]

It appears to be an issue with initialization order sorting on nested objects. It's trying to sort 'Parent' after 'Leaf', when it shouldn't be able to since parent is higher up on the hierarchy.

[FirstGearGames]

Fixed in 4.6.6.

Open NetworkObject.cs and find this

public sbyte GetInitializeOrder() => _initializeOrder;

Replace with this

public int GetInitializeOrder() => Order;

public int Order => _initializeOrder;

Replace with this

        public int Order
        {
            get
            {
                /* Returns a value to add onto initialization order
                 * based on how nested the object is. This is a fairly
                 * cheap and quick way to ensure nested objects
                 * always initialize after ones in the hierarchy. */
                /* Assuming a modifier base of 100.
                 * A            0
                 *   B          100
                 *     C        200
                 *       D      300
                 *   E          100
                 *     F        200
                 */
                int GetOrderModifier()
                {
                    //Ensure at least 1 multiplier so initialization order isnt multiplied by 0.
                    int multiplier = 1;

                    //Add one multiplier per every nested.
                    NetworkBehaviour parentNb = CurrentParentNetworkBehaviour;
                    while (parentNb != null)
                    {
                        multiplier += 1;
                        parentNb = parentNb.NetworkObject.CurrentParentNetworkBehaviour;
                    }

                    int modifierBase = (sbyte.MaxValue + 1);

                    return (multiplier * modifierBase);
                }
                
                return (_initializeOrder + GetOrderModifier());
            }
        }

You will also need to replace these methods..
Writer.cs

        internal void WriteSpawnedNetworkObject(NetworkObject nob)
        {
            WriteNetworkObjectId(nob.ObjectId);
            WriteUInt16(nob.SpawnableCollectionId);
            WriteInt32(nob.GetInitializeOrder());
        }

Reader.cs

       internal int ReadNetworkObjectForSpawn(out int initializeOrder, out ushort collectionid)
        {
            int objectId = ReadNetworkObjectId();
            collectionid = ReadUInt16();
            initializeOrder = ReadInt32();

            return objectId;
        }

This prevents higher nested initialization orders from initializing before their parent.

You will get a few 'cannot convert sbyte to int' errors after these changes; change all those sbytes to int.

[FirstGearGames]

Resolved in 4.6.6