WebSocket
sUNC Reference

WebSocket

Create and use client WebSocket connections.

Related to sUNC documentation

This reference is based exclusively on the official sUNC documentation.

Overview

  • The WebSocket class is a client and cannot create servers.
  • sUNC explicitly requires secure `wss://` support.

Constructor

Connects to a ws:// or wss:// endpoint.

Luau
function WebSocket.connect(url: string): WebSocket

Events

NameTypeDescription
OnMessage(message: string) -> ()

Fires when a message is received.

OnClose() -> ()

Fires when the connection closes.

Methods

NameTypeDescription
Send(message)()

Sends a message.

Close()()

Closes the connection.