🤓 NetCode update

Thinking through how to keep game state in sync with network state, I had to choose a pattern to stay organized.

The problem:

• No consistent state change interface
• State changes were not clear if it triggers a network update, or comes from a network update
• Signals were emitted from any object or Globals without reason
• “Update/Updated” Signals cause co-recursive signal emission

Take the Inventory as an example, player can add, remove, or update an inventory, and the items in the inventory need to be synchronized to all other connected players.

Before - not following a pattern

┌───────────────┐      ┌───────────────────────────┐
│ Inventory.gd  │      │ Network.gd                │
│               │      │                           │
│ add()         ├──────┤►send_add()                │
│ remove()      │┼┼┼┼┼┼┤►send_remove()             │
│ update() ─────┼──────┤►send_update() ─────┐      │
│  ▲            │      │                    ▼      │
└──┬────────────┘   ┌──┼─signal(inventory_updated) │
   │                │  │                           │
   └────────────────┘  └───────────────────────────┘

The problem is clear when updating an inventory, and listening for an inventory update

After - layered architecture

I’ve added a “Net Sync” module as a broker layer between the actual “Network” comms layer.

Each layer should only interact with immediately adjacent layers.

If the player is online (in a real game)

If the player is offline (local dev/debug and game design)

The “Net Sync” layer skips talking to network socket and echoes the same data from the send() signals

The public interface for Inventory is “safe” to use and the code can trust that recv() signals will be emitted in both online and offline modes