Unity3D
아래의 링크를 통해 ProudChat Unity SDK를 다운로드 합니다.
프로젝트 설정
Unity PackageFile 추가
git을 통해 다운로드 받은 ProudChatUnityPackage 유니티 에디터 상단 Assets - Import Package - custom Package를 통해 Package를 추가합니다.
플러그인 설정
플러그인 설정을 참고하시기 바랍니다.
ProudChatComponent
사용자는 ProudChatComponent를 통해 채팅에 필요한 각 기능들을 간편하게 사용할 수 있습니다.
반드시 한 개의 Component만 등록하여 사용하시기 바랍니다.
- ProudChat_Init
ChatClient를 Initialize 하는 부분입니다. 유저는 사용 전에 반드시 Init함수를 호출하여 서버와 연결을 해주셔야 합니다.
| 함수명 | 매개변수 | 설명 |
|---|---|---|
ProudChat_Init | Proud Console 에서 제공되는 유저의 UUID, 유저가 생성한 프로젝트의 UUID, 유저 고유의 UniqueID | ChatClient를 서버와 연결하기 위한 함수로 유저는 이 부분을 작성합니다. 매개변수로는 3개의 문자열을 받고 있지만, 내부적으로 ChatClientInitComplete, ChatClientJoinFailed 함수를 호출하고 있어 로그인에 성공 했는지 실패 했는지 확인할 수 있습니다. |
- 함수
| 함수명 | 매개변수 | 설명 |
|---|---|---|
AddChannel | 접속하고 싶은 채널의 고유 Key | 특정 채널에 접속하고 싶을 때 사용합니다. |
Leave_Channel | 나가고 싶은 채널의 고유 Key | 접속한 채널에서 나가고 싶을 때 사용합니다. |
Send_Msg | 특정 상대방의 고유한 식별 값, 특정 상대방에게 보낼 메시지 | 특정 상대에게 메시지를 보낼 때 사용합니다. |
Send_ChannelMsg | 특정 채널의 고유한 식별 값, 특정 채널에게 보낼 메시지 | 특정 채널에게 메시지를 보낼 때 사용합니다. |
- 이벤트 변수
| 이벤트 함수명 | 설명 |
|---|---|
m_ClientInitComplete_Event | ChatClient가 Init이 완료되면 발생하는 이벤트로, 사용자가 등록하여 사용할 수 있습니다. 예제는 ChatClientInitComplete() 함수가 호출되면 이벤트가 발생하며, 'ProudChat Connection Success' 라는 유니티 로그가 출력 되며 "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
Stripped 폴더의 플러그인 선택을 참고하시기 바랍니다.
- iOS
iOS 빌드하기를 참고하시기 바랍니다.
Last updated
