Skip to content

Commit

Permalink
Fix documentation in MultiplayerAPIExtension
Browse files Browse the repository at this point in the history
Fix documentation in MultiplayerAPIExtension.xml

In implementing a MultiplayerAPIExtension, I found that the example from documentation did not function even in the Multiplayer tutorial example.

Eventually, I found that the issue was that base_multiplayer will not poll unless told to by the LogMultiplayer implementation.

I also corrected a spelling issue and a few out-of-date return types.
  • Loading branch information
Agaanii committed Nov 1, 2023
1 parent 93cdacb commit c10921b
Showing 1 changed file with 7 additions and 4 deletions.
11 changes: 7 additions & 4 deletions doc/classes/MultiplayerAPIExtension.xml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -25,21 +25,24 @@
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:
print("Adding node %s to the spawn list. Spawner: %s" % [object, config])
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:
Expand Down

0 comments on commit c10921b

Please sign in to comment.