Unity3D

通過以下鏈接下載ProudChat Unity SDK。

項目設定

新增Unity PackageFile

通過git下載的ProudChatUnity Package Unity編輯上端Assets - Import Package - custom Package添加Package 。

Package File全部導入。

插件配置

請參考插件設置

ProudChatComponent

用戶可以通過ProudChatComponent輕鬆使用聊天所需的各種功能。

- ProudChat_Init

進行ChatClient Initialize的部分。 用戶在使用前必須調用Init函數與服務器連接。

函數名
參數
註釋

ProudChat_Init

Proud Console提供的用戶的UUID用戶生成的項目的UUID用戶固有的UniqueID

用戶將 ChatClient 作爲與服務器連接的函數來編寫此部分 。 參數接收三個字符串, 但它們內部調用 ChatClientInitComplete, ChatClientJoinFailed 函數, 可確認登錄成功還是失敗 。

- 函數

函數名
參數
註釋

AddChannel

您想要訪問的頻道的固有Key

用於連接特定頻道時 。

Leave_Channel

想播出的頻道的固有Key

想退出連接的頻道時使用。

Send_Msg

特定對方固有的識別值,

要發送給特定對象的信息

用於向特定對象發送消息。

Send_ChannelMsg

特定渠道的獨特識別值, 要發送給特定頻道的消息

用於向特定頻道發送消息。

- 事件變數

事件函數名
註釋

m_ClientInitComplete_Event

ChatClient完成Init後發生的活動,用戶可以註冊使用。 實例包括,當調用ChatClientInitComplete()函數時,會發生事件,輸出一個名爲'ProudChat Connection Success'的Unity日誌,並添加一個名爲"ALL"的通道。

m_ClientInitFailed_Event

ChatClient中成爲Init Failed後發生的事件,用戶可以註冊使用。 實例包括,如果調用ChatClientJoinFailed()函數,則會發生事件,失敗時返回錯誤,並顯示"ProudChat Connection Failed"日誌。

m_SendMsg_Response_Event

用戶間Send Message到達時,會進行活動處理。 用戶可以註冊並使用Event,註冊時接收產生信息的Unique ID對方發送的信息作爲參數。

m_ChannelMsg_Response_Event

Channel Message 到達時發生的事件 。 用戶可以註冊並使用Event,註冊時接收消息通道的Unique ID產生消息的Unique ID對方發送的消息作爲參數。

m_Notice_Response_Event

Notice到達時,會進行活動處理。 用戶可以註冊Event使用。 示例中通過Notice_Response()在Proud Console發送公告時打印公告內容。

- 事件函數

函數名
註釋

ChatClientInitComplete

完成Server Connection後,成功到Login後被呼叫的函數。

ChatClientJoinFailed

Server Login 失敗時調用的一個函數。 使用此函數的時間是連接服務器成功但無法登錄賬戶時發生的事件 。 這部分失敗時不會重試,因此需要確認設置。

SendMsg_Response

是其他用戶給我發信息的話,就會變成Delegate的函數。

ChannelMsg_Response

另一個用戶向頻道發送消息後成爲Delegate的函數。

Notice_Response

ProudConsle發送公告事項時成爲Delegate的函數,從服務器接收Message後打印公告事項內容。

構建

- Android

- iOS

Last updated