fix: RewindableAction to handle later ticks (#534)

When modifying a rewindable action from outside of its parent, it may
set a tick in one loop, but not in the next one. For example, the player
hits a spike, and the spike sets the RewindableAction for tick 15. On
the next loop, the player doesn't hit the spike on tick 15, but is also
not simulated for tick 15 since it doesn't have input.

This results in TicksetSerializer's assert failing, because there's an
active tick past the last set one.

Instead, RewindableAction now serializes the last set tick, even if it
was not set in the current loop. TicksetSerializer will not serialize
ticks outside of the specified range.

Fixes #532

Author: elementbound

addons/netfox.extras/plugin.cfg

@@ -3,5 +3,5 @@
 name="netfox.extras"
 description="Game-specific utilities for Netfox"
 author="Tamas Galffy and contributors"
-version="1.35.2"
+version="1.35.3"
 script="netfox-extras.gd"

addons/netfox.internals/plugin.cfg

@@ -3,5 +3,5 @@
 name="netfox.internals"
 description="Shared internals for netfox addons"
 author="Tamas Galffy and contributors"
-version="1.35.2"
+version="1.35.3"
 script="plugin.gd"

addons/netfox.noray/plugin.cfg

@@ -3,5 +3,5 @@
 name="netfox.noray"
 description="Bulletproof your connectivity with noray integration for netfox"
 author="Tamas Galffy and contributors"
-version="1.35.2"
+version="1.35.3"
 script="netfox-noray.gd"

addons/netfox/plugin.cfg

@@ -3,5 +3,5 @@
 name="netfox"
 description="Shared internals for netfox addons"
 author="Tamas Galffy and contributors"
-version="1.35.2"
+version="1.35.3"
 script="netfox.gd"

addons/netfox/rewindable-action.gd

@@ -203,7 +203,12 @@ func _after_loop() -> void:
 
 	# Submit
 	if is_multiplayer_authority() and _last_set_tick >= 0:
-		var active_tick_bytes = _TicksetSerializer.serialize(NetworkRollback.history_start, _last_set_tick, _active_ticks)
+		var serialize_from := NetworkRollback.history_start
+		var serialize_to := _last_set_tick
+		if not _active_ticks.is_empty():
+			serialize_to = maxi(_active_ticks.max(), serialize_to)
+
+		var active_tick_bytes = _TicksetSerializer.serialize(serialize_from, serialize_to, _active_ticks)
 		_submit_state.rpc(active_tick_bytes)
 
 @rpc("authority", "unreliable_ordered", "call_remote")

addons/netfox/serializers/tickset-serializer.gd

@@ -12,7 +12,10 @@ static func serialize(earliest_tick: int, latest_tick: int, active_ticks: _Set)
 	buffer.put_u8(tickset_duration)
 
 	for tick in active_ticks:
-		assert(tick <= latest_tick, "Trying to serialize ticks beyond latest !")
+		# Don't serialize before range
+		if tick < earliest_tick: continue
+		# Don't serialize past range
+		if tick > latest_tick: break
 		buffer.put_u8(tick - earliest_tick)
 
 	return buffer.data_array

test/netfox/serializers/tickset-serializer.test.gd

@@ -33,6 +33,21 @@ func test_should_serialize_ticks():
 	expect_equal(deserialized[1], latest_tick)
 	expect_equal(deserialized[2], active_ticks)
 
+func test_should_serialize_only_range():
+	# Given
+	var earliest_tick = 16
+	var latest_tick = 20
+	var active_ticks = _Set.of([15, 16, 20, 24])
+
+	# When
+	var bytes = _TicksetSerializer.serialize(earliest_tick, latest_tick, active_ticks)
+	var deserialized = _TicksetSerializer.deserialize(bytes)
+
+	# Then
+	expect_equal(deserialized[0], earliest_tick)
+	expect_equal(deserialized[1], latest_tick)
+	expect_equal(deserialized[2], _Set.of([16, 20]))
+
 func test_should_fail_on_earliest_after_latest():
 	# Given
 	var earliest_tick = 42

test/network-mocks.gd

@@ -36,3 +36,7 @@ static func in_network_tick(callback: Callable) -> void:
 ## Runs a single network tick
 static func run_network_tick() -> void:
 	in_network_tick(NOOP)
+
+## Runs a single-tick network tick loop
+static func run_network_tick_loop() -> void:
+	in_network_tick_loop(NOOP)