Browse Source

Merge pull request #84226 from Agaanii/patch-1

Fix documentation in MultiplayerAPIExtension
Rémi Verschelde 1 year ago
parent
commit
8ce31989ff
1 changed files with 7 additions and 4 deletions
  1. 7 4
      doc/classes/MultiplayerAPIExtension.xml

+ 7 - 4
doc/classes/MultiplayerAPIExtension.xml

@@ -15,7 +15,7 @@
 		var base_multiplayer = SceneMultiplayer.new()
 
 		func _init():
-		    # Just passthourgh base signals (copied to var to avoid cyclic reference)
+		    # Just passthrough base signals (copied to var to avoid cyclic reference)
 		    var cts = connected_to_server
 		    var cf = connection_failed
 		    var pc = peer_connected
@@ -25,13 +25,16 @@
 		    base_multiplayer.peer_connected.connect(func(id): pc.emit(id))
 		    base_multiplayer.peer_disconnected.connect(func(id): pd.emit(id))
 
+		func _poll():
+		    return base_multiplayer.poll()
+
 		# Log RPC being made and forward it to the default multiplayer.
-		func _rpc(peer: int, object: Object, method: StringName, args: Array) -> int: # Error
+		func _rpc(peer: int, object: Object, method: StringName, args: Array) -> Error:
 		    print("Got RPC for %d: %s::%s(%s)" % [peer, object, method, args])
 		    return base_multiplayer.rpc(peer, object, method, args)
 
 		# Log configuration add. E.g. root path (nullptr, NodePath), replication (Node, Spawner|Synchronizer), custom.
-		func _object_configuration_add(object, config: Variant) -> int: # Error
+		func _object_configuration_add(object, config: Variant) -> Error:
 		    if config is MultiplayerSynchronizer:
 		        print("Adding synchronization configuration for %s. Synchronizer: %s" % [object, config])
 		    elif config is MultiplayerSpawner:
@@ -39,7 +42,7 @@
 		    return base_multiplayer.object_configuration_add(object, config)
 
 		# Log configuration remove. E.g. root path (nullptr, NodePath), replication (Node, Spawner|Synchronizer), custom.
-		func _object_configuration_remove(object, config: Variant) -> int: # Error
+		func _object_configuration_remove(object, config: Variant) -> Error:
 		    if config is MultiplayerSynchronizer:
 		        print("Removing synchronization configuration for %s. Synchronizer: %s" % [object, config])
 		    elif config is MultiplayerSpawner: