algodoogle
23ec41c1d6
Adds test/multiPlayerTest.tscn plus a driver that runs the kitchen flow across two game instances: grab/drop, dirt station, sink washing, hob cooking, counter combining and plating. Runs headless (run_mp_test.ps1), in two visible windows (run_mp_test_windowed.ps1), or by hand with keyboard controls (play_mp_test.ps1). 108 checks, exits non-zero on failure. After every step both peers snapshot every item's position and rendered state and the server diffs them. Targeted assertions only look at the thing a step touched, which misses desyncs elsewhere - that audit is what caught the last bug below. Bugs found and fixed: - net_pickable: apply_held_state() only wrote `enabled` in its non-authority branch, so once a client grabbed an item every other peer set enabled=false and regaining authority never restored it. The server could then never pick that item up again, and a station would "snap" it (emitting has_picked_up, so a plate still got marked dirty) while pick_up() bailed out on the disabled item - leaving the zone holding an item with no grab driver. - network_manager: station gating only happened in the spawn path, so stations baked into a scene file kept running their snap zones on clients and grabbed items straight out of the local hand. Added gate_existing_stations(). - network_manager: despawn_item() only freed the server's copy. Items baked into a scene aren't tracked by the MultiplayerSpawner, so consuming one left a ghost on every client, which then blocked the station it sat in and got grabbed instead of its replacement. - network_manager: the snap-into-station decision read the server's own copy of the item position, but the reliable release RPC routinely overtakes the synchronizer's unordered position updates - so it acted on a stale position and teleported items back into the station they had just been carried away from. The releasing peer now sends its final transform and the server adopts it first. - container: contained_ids.append()/erase() mutate the array in place, which never fires the setter that rebuilds the plate's visuals. The peer that put food on a plate was the only peer that never redrew it; remote peers looked right because the synchronizer assigns there. Also null-guards XRServer.get_tracker() in the vendored xr-tools hand grab point, which threw on every successful grab without an XR runtime, and adds multiplayer_world.populate_from_layout so debug scenes can bake their own content instead of spawning the whole kitchen. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
180 lines
8.2 KiB
GDScript
180 lines
8.2 KiB
GDScript
extends MultiplayerSynchronizer
|
|
|
|
## Networked sync component for a pickable item. Added as a child literally
|
|
## named "NetPickable" (network_manager.gd's authority RPCs already expect
|
|
## this) of every net-synced pickable, replicating its transform and held
|
|
## state. Only the current multiplayer authority (the server while loose, or
|
|
## whichever peer is holding it) actually simulates physics for the item;
|
|
## every other peer freezes their local copy and just follows the synced
|
|
## transform.
|
|
|
|
## 0 = loose/server-simulated; otherwise the peer id currently holding it.
|
|
## Replicated at spawn and on change so a late joiner sees the current holder.
|
|
var net_held_by: int = 0: set = _set_net_held_by
|
|
|
|
var _pickable: XRToolsPickable
|
|
|
|
# This item's own baked freeze_mode (e.g. plate.tscn bakes KINEMATIC, not the
|
|
# RigidBody3D default of STATIC) — captured once so it can be restored when
|
|
# this peer regains ownership, instead of getting stuck on whatever
|
|
# apply_held_state() last forced it to while non-authority.
|
|
var _original_freeze_mode: int
|
|
|
|
# Same idea for the pickable's authored `enabled` flag, which the non-authority
|
|
# branch of apply_held_state() clears while someone else is holding the item.
|
|
var _original_enabled: bool
|
|
|
|
|
|
func _ready() -> void:
|
|
_pickable = get_parent() as XRToolsPickable
|
|
if not _pickable:
|
|
push_error("NetPickable must be a child of an XRToolsPickable")
|
|
return
|
|
_original_freeze_mode = _pickable.freeze_mode
|
|
_original_enabled = _pickable.enabled
|
|
_pickable.picked_up.connect(_on_picked_up)
|
|
_pickable.dropped.connect(_on_dropped)
|
|
# Deferred: the pickable root captures its own original_collision_mask/
|
|
# original_collision_layer via @onready, which runs AFTER this child's
|
|
# _ready() but BEFORE the root's _ready() body. Calling apply_held_state
|
|
# synchronously here would freeze/mask the item before that capture runs,
|
|
# permanently corrupting the "restore on drop" values.
|
|
apply_held_state.call_deferred()
|
|
|
|
|
|
func _set_net_held_by(value: int) -> void:
|
|
var old := net_held_by
|
|
net_held_by = value
|
|
if old != value and NetworkManager.is_online():
|
|
print("%s net_held_by: %d -> %d (local state: %s, authority=%d)" % [
|
|
_pickable.name, old, value, _holder_desc(), get_multiplayer_authority()
|
|
])
|
|
apply_held_state()
|
|
|
|
|
|
## Puts the item in the right physics state for whether this peer currently
|
|
## owns it. Called locally after net_held_by changes, and directly by
|
|
## NetworkManager._set_item_authority right after an authority handoff.
|
|
func apply_held_state() -> void:
|
|
if not _pickable:
|
|
return
|
|
if not NetworkManager.is_online() or is_multiplayer_authority():
|
|
# We own this item's simulation (offline, loose+server, or currently
|
|
# holding it). If it's not actively in our own hand right now, make
|
|
# sure it isn't still left frozen/collision-less from a previous
|
|
# non-authority period (e.g. right after regaining authority when a
|
|
# client released it) — while actually held, XRToolsPickable's own
|
|
# pick_up()/let_go() already manage these fields, so leave those be.
|
|
if not _pickable.is_picked_up():
|
|
var changed := _pickable.freeze_mode != _original_freeze_mode \
|
|
or _pickable.collision_mask != _pickable.original_collision_mask
|
|
if changed and NetworkManager.is_online():
|
|
print(
|
|
"%s: reclaiming ownership, restoring freeze_mode %d->%d collision_mask %d->%d" % [
|
|
_pickable.name, _pickable.freeze_mode, _original_freeze_mode,
|
|
_pickable.collision_mask, _pickable.original_collision_mask
|
|
]
|
|
)
|
|
_pickable.freeze_mode = _original_freeze_mode
|
|
_pickable.collision_mask = _pickable.original_collision_mask
|
|
# Unlike freeze/collision (which XRToolsPickable manages itself while
|
|
# held), `enabled` is only ever written by the non-authority branch
|
|
# below, so it must be restored here or it stays false forever: once a
|
|
# client grabbed this item, every other peer set enabled=false, and
|
|
# regaining authority left it that way. On the server that silently
|
|
# broke everything downstream — hands couldn't pick the item up again,
|
|
# and a station snap zone would "snap" it (emitting has_picked_up, so
|
|
# e.g. a plate still got marked dirty) while pick_up() bailed out on
|
|
# the disabled item, leaving the zone holding an item with no grab
|
|
# driver that then fell out of the station.
|
|
if _pickable.enabled != _original_enabled:
|
|
if NetworkManager.is_online():
|
|
print("%s: reclaiming ownership, restoring enabled %s->%s" % [
|
|
_pickable.name, _pickable.enabled, _original_enabled
|
|
])
|
|
_pickable.enabled = _original_enabled
|
|
return
|
|
# A net_held_by/position sync update can race ahead of the
|
|
# authority-handoff RPC that's about to confirm a grab we just made
|
|
# optimistically (they travel on different channels with no ordering
|
|
# guarantee). Don't let a stale sync value yank an item out of our own
|
|
# hand mid-grab — only an explicit force_release_item rejection, or
|
|
# actually losing authority for real, should end a grab we initiated.
|
|
if _pickable.is_picked_up() and _pickable.get_picked_up_by() is XRToolsFunctionPickup:
|
|
if NetworkManager.is_online():
|
|
print(
|
|
"%s: ignoring non-authority sync (net_held_by=%d) — still actively held by our own hand (grab-race guard)" % [
|
|
_pickable.name, net_held_by
|
|
]
|
|
)
|
|
return
|
|
# Someone else owns it: stop simulating locally, just follow the sync.
|
|
if _pickable.is_picked_up():
|
|
if NetworkManager.is_online():
|
|
print(
|
|
"%s: was held by %s on this peer, but authority now says peer %d owns it — force-dropping" % [
|
|
_pickable.name, _holder_desc(), net_held_by
|
|
]
|
|
)
|
|
_pickable.drop()
|
|
if NetworkManager.is_online():
|
|
print("%s: freezing (non-authority, owner=peer %d)" % [_pickable.name, net_held_by])
|
|
_pickable.freeze = true
|
|
_pickable.freeze_mode = RigidBody3D.FREEZE_MODE_KINEMATIC
|
|
_pickable.collision_mask = 0
|
|
_pickable.enabled = (net_held_by == 0)
|
|
|
|
|
|
## Local hand grab (not a station snap zone, which is server-only): request
|
|
## authority immediately so the throw/drop can be reconciled, but let the grab
|
|
## happen instantly here rather than waiting on the round trip.
|
|
func _on_picked_up(_p) -> void:
|
|
var by := _pickable.get_picked_up_by()
|
|
if not (by is XRToolsFunctionPickup):
|
|
# e.g. a station snap zone grabbed it (server-side auto-snap, or the
|
|
# addon's own "grab out of a snap zone" shortcut mid-cascade) — not a
|
|
# player-initiated hand grab, so no authority request from here.
|
|
if NetworkManager.is_online():
|
|
print("%s picked up by %s (not a hand) — no authority request" % [_pickable.name, _holder_desc()])
|
|
return
|
|
if NetworkManager.is_online():
|
|
print("%s grabbed by hand (authority was peer %d), requesting authority" % [_pickable.name, net_held_by])
|
|
NetworkManager.request_item_authority_from(_pickable.get_path())
|
|
|
|
|
|
func _on_dropped(_p) -> void:
|
|
# Only forward if we're actually still the authority — a drop caused by
|
|
# apply_held_state() losing authority (see above) must not re-report.
|
|
if not is_multiplayer_authority():
|
|
if NetworkManager.is_online():
|
|
print("%s dropped locally, but we aren't its authority (peer %d is) — not reporting" % [_pickable.name, net_held_by])
|
|
return
|
|
if NetworkManager.is_online():
|
|
print("%s dropped, reporting release to server (lin=%s ang=%s)" % [
|
|
_pickable.name, _pickable.linear_velocity, _pickable.angular_velocity
|
|
])
|
|
# Send our own final transform too: we were the authority until now, and the
|
|
# server's copy may not have received our last position sync yet.
|
|
NetworkManager.release_item_authority_from(
|
|
_pickable.get_path(), _pickable.linear_velocity, _pickable.angular_velocity,
|
|
_pickable.global_transform
|
|
)
|
|
|
|
|
|
## Human-readable description of what's currently holding this item on THIS
|
|
## peer, for diagnosing desyncs between a hand's own "what am I holding"
|
|
## bookkeeping and the item's actual grab state (see the snap-zone-grab race
|
|
## in NetworkManager._try_snap_into_station for a real example).
|
|
func _holder_desc() -> String:
|
|
if not _pickable or not _pickable.is_picked_up():
|
|
return "loose"
|
|
var by := _pickable.get_picked_up_by()
|
|
if not by:
|
|
return "held(no grabber?)"
|
|
if by is XRToolsFunctionPickup:
|
|
return "hand(%s)" % by.get_path()
|
|
if by is XRToolsSnapZone:
|
|
var station := by.get_parent()
|
|
return "zone(%s)" % (station.name if station else str(by.get_path()))
|
|
return "other(%s: %s)" % [by.get_class(), by.get_path()]
|