summaryrefslogtreecommitdiff
path: root/modules/websocket/doc_classes/WebSocketMultiplayerPeer.xml
blob: 8548d21323d615c44ef64ec003c18d667a01b28d (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
<?xml version="1.0" encoding="UTF-8" ?>
<class name="WebSocketMultiplayerPeer" inherits="NetworkedMultiplayerPeer" category="Core" version="3.2">
	<brief_description>
		Base class for WebSocket server and client.
	</brief_description>
	<description>
		Base class for WebSocket server and client, allowing them to be used as network peer for the [MultiplayerAPI].
	</description>
	<tutorials>
	</tutorials>
	<methods>
		<method name="get_peer" qualifiers="const">
			<return type="WebSocketPeer">
			</return>
			<argument index="0" name="peer_id" type="int">
			</argument>
			<description>
				Returns the [WebSocketPeer] associated to the given [code]peer_id[/code].
			</description>
		</method>
	</methods>
	<signals>
		<signal name="peer_packet">
			<argument index="0" name="peer_source" type="int">
			</argument>
			<description>
				Emitted when a packet is received from a peer. Note: this signal is only emitted when the client or server is configured to use Godot multiplayer API.
			</description>
		</signal>
	</signals>
	<constants>
	</constants>
</class>