Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -103,6 +103,7 @@ func transmit_input(tick: int) -> void:
var input_tick: int = tick + NetworkRollback.input_delay
var input_data := _input_encoder.encode(input_tick, _get_owned_input_props())
var state_owning_peer := root.get_multiplayer_authority()
NetworkRollback.register_input_submission(root, tick)

if enable_input_broadcast:
for peer in _visibility_filter.get_rpc_target_peers():
Expand Down Expand Up @@ -209,6 +210,7 @@ func _submit_input(tick: int, data: Array) -> void:
var earliest_received_input = _input_encoder.apply(tick, snapshots, sender)
if earliest_received_input >= 0:
_earliest_input_tick = mini(_earliest_input_tick, earliest_received_input)
NetworkRollback.register_input_submission(root, tick)

# `serialized_state` is a serialized _PropertySnapshot
@rpc("any_peer", "unreliable_ordered", "call_remote")
Expand Down
22 changes: 22 additions & 0 deletions addons/netfox/rollback/network-rollback.gd
Original file line number Diff line number Diff line change
Expand Up @@ -168,6 +168,7 @@ var _rollback_stage: String = ""
var _is_rollback: bool = false
var _simulated_nodes: _Set = _Set.new()
var _mutated_nodes: Dictionary = {}
var _input_submissions: Dictionary = {}

const _STAGE_BEFORE := "B"
const _STAGE_PREPARE := "P"
Expand Down Expand Up @@ -266,6 +267,27 @@ func is_just_mutated(target: Object, p_tick: int = tick) -> bool:
else:
return false

## Register that a node has submitted its input for a specific tick
func register_input_submission(root_node: Node, tick: int) -> void:
if not _input_submissions.has(root_node):
_input_submissions[root_node] = tick
else:
_input_submissions[root_node] = maxi(_input_submissions[root_node], tick)

## Get the latest input tick submitted by a specific root node
func get_latest_input_tick(root_node: Node) -> int:
if _input_submissions.has(root_node):
return _input_submissions[root_node]
return -1

## Get all root nodes that have submitted input
func get_input_submissions() -> Dictionary:
return _input_submissions

## Check if a node has submitted input for a specific tick (or later)
func has_input_for_tick(root_node: Node, tick: int) -> bool:
return _input_submissions.has(root_node) and _input_submissions[root_node] >= tick

func _ready():
_NetfoxLogger.register_tag(_get_rollback_tag)
NetworkTime.after_tick_loop.connect(_rollback)
Expand Down
14 changes: 14 additions & 0 deletions docs/netfox/guides/network-rollback.md
Original file line number Diff line number Diff line change
Expand Up @@ -129,6 +129,20 @@ To actually run a rollback tick on them, call

These methods are called by [RollbackSynchronizer] under the hood.

## Input Submission Status

In certain scenarios you may wish to delay commiting to something hard to reverse
like death, vfx or audio untill its known for sure the outcome won't change. One
way of doing this is to check which nodes have submited input and are past a
point of rollback.

You can query the status of Nodes with `NetworkRollback.get_latest_input_tick(root_node)`
or `NetworkRollback.has_input_for_tick(root_node, tick)`. `root_node` being what
the relevant [RollbackSynchronizer] has configured.

All tracked nodes can be retreived from `NetworkRollback.get_input_submissions()`
which will return the entire <root_node, latest_tick> dictionary.

## Settings

![Network rollback settings](../assets/network-rollback-settings.png)
Expand Down
Loading