
在線示例
快速開始
安裝環境
- Unity 2018.3 或更高。
- 無其他SDK依賴。
安裝方法
-
通過 OpenUPM 安裝
插件已托管至 OpenUPM ,您可以使用 openupm-cli 進行安裝。
openupm add com.psygame.unitywebsocket
-
通過 Git 安裝
在您的項目根路徑的
Packages
文件夾中找到manifest.json
文件,參考如下方式進行修改:{ "dependencies": { "com.psygame.unitywebsocket": "https://github.com/psygame/UnityWebSocket.git", ... }, }
可通過修改鏈接后綴
#{version}
來安裝對應版本。- 示例:
"com.psygame.unitywebsocket": "https://github.com/psygame/UnityWebSocket.git#2.3.0",
- 示例:
-
通過 Unity Package 安裝
在 Releases 頁面中,下載對應版本的
UnityWebSocket.unitypackage
安裝包,然后導入到您的項目中。
使用方法
- 代碼示例
// 命名空間
using UnityWebSocket;
// 創建實例
WebSocket scoket = new WebSocket();
// 注冊回調
scoket.OnOpen += OnOpen;
scoket.OnClose += OnClose;
scoket.OnMessage += OnMessage;
socket.OnError += OnError;
// 連接
string address = "ws://echo.websocket.org";
socket.ConnectAsync(address);
// 發送數據(兩種發送方式)
socket.SendAsync(str); // 發送類型 String 類型數據
socket.SendAsync(bytes); // 發送 byte[] 類型數據
// 關閉連接
socket.CloseAsync();
- 詳細使用方法可參考項目中的 UnityWebSocketTest.cs 示例代碼。
注意(Warning)
-
插件中多個命名空間中存在 WebSocket 類,適用不同環境,請根據自身需求選擇。
命名空間 平台 方式 說明 UnityWebSocket 全平台 同步(無阻塞) [推薦] 無需考慮異步回調使用 Unity 組件的問題。 UnityWebSocket.Uniform 全平台 異步 需要考慮異步回調使用 Unity 組件的問題。 UnityWebSocket.WebGL WebGL平台 異步 僅支持WebGL平台下的通信。 UnityWebSocket.NoWebGL 非WebGL平台 異步 僅支持非WebGL平台下的通信。
QQ 交流群
- 1126457634 >>> 入群通道 <<<