Struct MultiplayerAPI
High-level multiplayer API.
struct MultiplayerAPI
;
This class implements most of the logic behind the high-level multiplayer API.
By default, SceneTree has a reference to this class that is used to provide multiplayer capabilities (i.e. RPC/RSET) across the whole scene.
It is possible to override the MultiplayerAPI instance used by specific Nodes by setting the Node property, effectively allowing to run both client and server in the same scene.
Properties
| Name | Type | Description |
|---|---|---|
allowObjectDecoding[get, set]
|
bool | If true (or if the networkPeer has PacketPeer set to true), the MultiplayerAPI will allow encoding and decoding of object during RPCs/RSETs.
Warning: Deserialized objects can contain code which gets executed. Do not use this option if the serialized object comes from untrusted sources to avoid potential security threats such as remote code execution.
|
networkPeer[get, set]
|
NetworkedMultiplayerPeer | The peer object to handle the RPC system (effectively enabling networking when set). Depending on the peer itself, the MultiplayerAPI will become a network server (check with isNetworkServer) and will set root node's network mode to master, or it will become a regular peer with root node set to puppet. All child nodes are set to inherit the network mode by default. Handling of networking-related events (connection, disconnection, new clients) is done by connecting to MultiplayerAPI's signals.
|
refuseNewNetworkConnections[get, set]
|
bool | If true, the MultiplayerAPI's networkPeer refuses new incoming connections.
|
Methods
| Name | Description |
|---|---|
_addPeer
|
|
_connectedToServer
|
|
_connectionFailed
|
|
_delPeer
|
|
_serverDisconnected
|
|
clear
|
Clears the current MultiplayerAPI network state (you shouldn't call this unless you know what you are doing). |
getNetworkConnectedPeers
|
Returns the peer IDs of all connected peers of this MultiplayerAPI's networkPeer.
|
getNetworkPeer
|
|
getNetworkUniqueId
|
Returns the unique peer ID of this MultiplayerAPI's networkPeer.
|
getRpcSenderId
|
Returns the sender's peer ID for the RPC currently being executed. Note: If not inside an RPC this method will return 0. |
hasNetworkPeer
|
Returns true if there is a networkPeer set.
|
isNetworkServer
|
Returns true if this MultiplayerAPI's networkPeer is in server mode (listening for connections).
|
isObjectDecodingAllowed
|
|
isRefusingNewNetworkConnections
|
|
poll
|
Method used for polling the MultiplayerAPI. You only need to worry about this if you are using Node override or you set SceneTree to false. By default, SceneTree will poll its MultiplayerAPI for you.
Note: This method results in RPCs and RSETs being called, so they will be executed in the same context of this function (e.g. _process, physics, Thread).
|
sendBytes
|
Sends the given raw bytes to a specific peer identified by id (see NetworkedMultiplayerPeer). Default ID is 0, i.e. broadcast to all peers.
|
setAllowObjectDecoding
|
|
setNetworkPeer
|
|
setRefuseNewNetworkConnections
|
|
setRootNode
|
Sets the base root node to use for RPCs. Instead of an absolute path, a relative path will be used to find the node upon which the RPC should be executed. This effectively allows to have different branches of the scene tree to be managed by different MultiplayerAPI, allowing for example to run both client and server in the same scene. |
Enums
| Name | Description |
|---|---|
Constants
|
|
RPCMode
|