Inheritance #
- AudioServer
- CameraServer
- ClassDB
- DisplayServer
- EditorFileSystemDirectory
- EditorInterface
- EditorPaths
- EditorSelection
- EditorUndoRedoManager
- EditorVCSInterface
- Engine
- EngineDebugger
- FramebufferCacheRD
- GDExtensionManager
- Geometry2D
- Geometry3D
- IP
- Input
- InputMap
- JNISingleton
- JSONRPC
- JavaClassWrapper
- JavaScriptBridge
- MainLoop (1)
- Marshalls
- MovieWriter
- NativeMenu
- NavigationMeshGenerator
- NavigationServer2D
- NavigationServer3D
- Node (21)
- OS
- OpenXRExtensionWrapperExtension
- OpenXRInteractionProfileMetadata
- Performance
- PhysicsDirectBodyState2D (1)
- PhysicsDirectBodyState3D (1)
- PhysicsDirectSpaceState2D (1)
- PhysicsDirectSpaceState3D (1)
- PhysicsServer2D (1)
- PhysicsServer2DManager
- PhysicsServer3D (1)
- PhysicsServer3DManager
- PhysicsServer3DRendering
ServerHandler
- ProjectSettings
- RefCounted (121)
- RenderData (2)
- RenderSceneData (2)
- RenderingDevice
- RenderingServer
- ResourceLoader
- ResourceSaver
- ResourceUID
- ScriptLanguage (1)
- ShaderIncludeDB
- TextServerManager
- ThemeDB
- TileData
- Time
- TranslationServer
- TreeItem
- UndoRedo
- UniformSetCacheRD
- WorkerThreadPool
- XRServer
- XRVRS
- AESContext
- AStar2D
- AStar3D
- AStarGrid2D
- AudioEffectInstance (1)
- AudioSample
- AudioSamplePlayback
- AudioStreamPlayback (5)
- CameraFeed
- CharFXTransform
- ConfigFile
- Crypto
- DTLSServer
- DirAccess
- ENetConnection
- EditorContextMenuPlugin
- EditorDebuggerPlugin
- EditorDebuggerSession
- EditorExportPlatform (6)
- EditorExportPlugin
- EditorExportPreset
- EditorFeatureProfile
- EditorFileSystemImportFormatSupportQuery
- EditorInspectorPlugin
- EditorResourceConversionPlugin
- EditorResourcePreviewGenerator
- EditorResourceTooltipPlugin
- EditorSceneFormatImporter (4)
- EditorScenePostImport
- EditorScenePostImportPlugin
- EditorScript
- EditorTranslationParserPlugin
- EncodedObjectAsID
- EngineProfiler
- Expression
- FileAccess
- GLTFObjectModelProperty
- HMACContext
- HTTPClient
- HashingContext
- ImageFormatLoader (1)
- JavaClass
- JavaObject
- JavaScriptObject
- KinematicCollision2D
- KinematicCollision3D
- Lightmapper (1)
- MeshConvexDecompositionSettings
- MeshDataTool
- MultiplayerAPI (2)
- Mutex
- NavigationPathQueryParameters2D
- NavigationPathQueryParameters3D
- NavigationPathQueryResult2D
- NavigationPathQueryResult3D
- Node3DGizmo (1)
- OggPacketSequencePlayback
- OpenXRAPIExtension
- PCKPacker
- PackedDataContainerRef
- PacketPeer (8)
- PhysicsPointQueryParameters2D
- PhysicsPointQueryParameters3D
- PhysicsRayQueryParameters2D
- PhysicsRayQueryParameters3D
- PhysicsShapeQueryParameters2D
- PhysicsShapeQueryParameters3D
- PhysicsTestMotionParameters2D
- PhysicsTestMotionParameters3D
- PhysicsTestMotionResult2D
- PhysicsTestMotionResult3D
- RDAttachmentFormat
- RDFramebufferPass
- RDPipelineColorBlendState
- RDPipelineColorBlendStateAttachment
- RDPipelineDepthStencilState
- RDPipelineMultisampleState
- RDPipelineRasterizationState
- RDPipelineSpecializationConstant
- RDSamplerState
- RDShaderSource
- RDTextureFormat
- RDTextureView
- RDUniform
- RDVertexAttribute
- RandomNumberGenerator
- RegEx
- RegExMatch
- RenderSceneBuffers (2)
- RenderSceneBuffersConfiguration
- Resource (103)
- ResourceFormatLoader
- ResourceFormatSaver
- ResourceImporter (16)
- SceneState
- SceneTreeTimer
- Semaphore
- SkinReference
- StreamPeer (5)
- SurfaceTool
- TCPServer
- TLSOptions
- TextLine
- TextParagraph
- TextServer (1)
- Thread
- TranslationDomain
- TriangleMesh
- Tween
- Tweener (5)
- UDPServer
- UPNP
- UPNPDevice
- WeakRef
- WebRTCPeerConnection (1)
- XMLParser
- XRInterface (4)
- XRPose
- XRTracker (2)
- ZIPPacker
- ZIPReader
- ENetPacketPeer
- MultiplayerPeer (5)
- PacketPeerDTLS
- PacketPeerExtension
- PacketPeerStream
- PacketPeerUDP
- WebRTCDataChannel (1)
- WebSocketPeer
- ENetMultiplayerPeer
- MultiplayerPeerExtension
- OfflineMultiplayerPeer
- WebRTCMultiplayerPeer
- WebSocketMultiplayerPeer
Table of contents
-
var handshake_headers: PackedStringArray = PackedStringArray() -
var handshake_timeout: float = 3.0 -
var inbound_buffer_size: int = 65535 -
var max_queued_packets: int = 4096 -
var outbound_buffer_size: int = 65535 -
var supported_protocols: PackedStringArray = PackedStringArray() -
func create_client(tls_client_options: TLSOptions = null) -> intError -
func create_server(tls_server_options: TLSOptions = null) -> intError -
const func get_peer(peer_id: int) -> WebSocketPeer -
const func get_peer_address(id: int) -> String -
const func get_peer_port(id: int) -> int
WebSocketMultiplayerPeer #
is_refcounted, is_instantiable, core, not_builtin_classes
Base class for WebSocket server and client.
Base class for WebSocket server and client, allowing them to be used as multiplayer peer for the MultiplayerAPI.
Note: When exporting to Android, make sure to enable the INTERNET permission in the Android export preset before exporting the project or using one-click deploy. Otherwise, network communication of any kind will be blocked by Android.
Members #
var handshake_headers: PackedStringArray = PackedStringArray()#
The extra headers to use during handshake. See WebSocketPeer.handshake_headers for more details.
var handshake_timeout: float = 3.0#
The maximum time each peer can stay in a connecting state before being dropped.
var inbound_buffer_size: int = 65535#
The inbound buffer size for connected peers. See WebSocketPeer.inbound_buffer_size for more details.
var max_queued_packets: int = 4096#
The maximum number of queued packets for connected peers. See WebSocketPeer.max_queued_packets for more details.
var outbound_buffer_size: int = 65535#
The outbound buffer size for connected peers. See WebSocketPeer.outbound_buffer_size for more details.
var supported_protocols: PackedStringArray = PackedStringArray()#
The supported WebSocket sub-protocols. See WebSocketPeer.supported_protocols for more details.
Methods #
func create_client(tls_client_options: TLSOptions = null) -> intError#
Starts a new multiplayer client connecting to the given url. TLS certificates will be verified against the hostname when connecting using the wss:// protocol. You can pass the optional tls_client_options parameter to customize the trusted certification authorities, or disable the common name verification. See TLSOptions.client and TLSOptions.client_unsafe.
Note: It is recommended to specify the scheme part of the URL, i.e. the url should start with either ws:// or wss://.
func create_server(tls_server_options: TLSOptions = null) -> intError#
Starts a new multiplayer server listening on the given port. You can optionally specify a bind_address, and provide valid tls_server_options to use TLS. See TLSOptions.server.
const func get_peer(peer_id: int) -> WebSocketPeer#
Returns the WebSocketPeer associated to the given peer_id.
const func get_peer_address(id: int) -> String#
Returns the IP address of the given peer.
const func get_peer_port(id: int) -> int#
Returns the remote port of the given peer.