doc: BaseNetInput guide

addons/netfox.extras/base-net-input.gd

@@ -2,18 +2,6 @@ extends Node
 class_name BaseNetInput
 
 ## Base class for Input nodes used with rollback.
-##
-## During rollback, multiple logical ticks are simulated in the span of a single
-## actual tick. Since these are just logical ticks, no actual input arrives
-## during them from the input devices.
-##
-## The solution is to gather input before the tick loop, and use that input for
-## any new ticks simulated during the rollback.
-##
-## This class provides a layer of convenience, since the only thing to do here
-## is to implement the [code]_gather[/code] method. This method is responsible
-## for setting all the properties that you have specified in [RollbackSynchronizer]
-## as input.
 
 func _ready():
 	NetworkTime.before_tick_loop.connect(func():

addons/netfox.extras/plugin.cfg

@@ -3,5 +3,5 @@
 name="netfox.extras"
 description="Game-specific utilities for Netfox"
 author="Tamas Galffy"
-version="0.15.11"
+version="0.15.12"
 script="netfox-extras.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"
-version="0.15.11"
+version="0.15.12"
 script="netfox-noray.gd"

addons/netfox/plugin.cfg

@@ -3,5 +3,5 @@
 name="netfox"
 description="A higher-level networking addon with rollback support"
 author="Tamas Galffy"
-version="0.15.11"
+version="0.15.12"
 script="netfox.gd"

docs/netfox.extras/guides/base-net-input.md

@@ -0,0 +1,30 @@
+# BaseNetInput
+
+Base class for Input nodes used with rollback.
+
+During rollback, multiple logical ticks are simulated in the span of a single
+network tick. Since these are just logical ticks, no actual input arrives during
+them from the input devices.
+
+The solution is to gather input before the tick loop, and use that input for
+any new ticks simulated during the rollback.
+
+## Gathering input
+
+This class provides a virtual `_gather` method that you can override. Set the
+variables configured in [RollbackSynchronizer] in your own implementation:
+
+```gdscript
+extends BaseNetInput
+
+var movement: Vector3 = Vector3.ZERO
+
+func _gather():
+  movement = Vector3(
+    Input.get_axis("move_west", "move_east"),
+    0,
+    Input.get_axis("move_north", "move_south")
+  )
+```
+
+[RollbackSynchronizer]: ../../netfox/nodes/rollback-synchronizer.md

mkdocs.yml

@@ -20,4 +20,7 @@ nav:
     - Guides:
       - 'netfox.noray/guides/noray.md'
       - 'netfox.noray/guides/packet-handshake.md'
+  - netfox.extras:
+    - Guides:
+      - 'netfox.extras/guides/base-net-input.md'