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 함수를 호출하고 있어 로그인 성공, 실패 여부를 확인할 수 있습니다. |
- Disconnect
| 함수명 | 매개변수 | 설명 |
|---|---|---|
Disconnect | - | 채팅 서버와의 연결을 종료합니다. |
- 함수
| 함수명 | 매개변수 | 설명 |
|---|---|---|
isConnected | - | 현재 Connection 상태를 체크합니다. |
Join_Channel | 접속하고 싶은 채널의 고유 Key | 특정 채널에 접속하고 싶을 때 사용합니다. |
Leave_Channel | 나가고 싶은 채널의 고유 Key | 접속한 채널에서 나가고 싶을 때 사용합니다. |
Send_Direct_Msg | 특정 상대방의 고유한 식별 값, 특정 상대방에게 보낼 메시지 | 특정 상대에게 메시지를 보낼 때 사용합니다. |
Send_Channel_Msg | 특정 채널의 고유한 식별 값, 특정 채널에게 보낼 메시지 | 특정 채널에게 메시지를 보낼 때 사용합니다. |
MsgTranslate | src = 현재 언어 국가 코드 target = 변환할 언어 국가 코드 msgKey = 변환할 메세지 고유 인식 값 msg = 변환할 메세지 | (Beta) 해당 메세지의 번역을 요청합니다. |
MsgTranslate_Auto | target = 변환할 언어 국가 코드 msgKey = 변환할 메세지 고유 인식 값 msg = 변환할 메세지 | (Beta) 해당 msg를 자동으로 언어 감지를 진행하여 번역을 요청합니다. |
MsgRecord_Channel | channelKey = 해당 채널의 키 day = 일수 최대 90 cnt = 갯수 최대 100 | (Beta) 해당 Channel의 과거 기록을 가져옵니다. 최대 90일, 100건까지 |
MsgRecord_Direct | target = 상대 유저의 UniqueKey day = 일수 최대 90 cnt = 갯수 최대 100 | (Beta) Direct 메세지의 과거 기록을 가져옵니다. 최대 90일, 100건까지 |
MsgRecord_Notice | day = 일수 최대 90 cnt = 갯수 최대 100 | (Beta) Notice의 과거 기록을 가져옵니다. 최대 90일, 100건까지 |
- 이벤트 변수
| 이벤트 함수명 | 설명 |
|---|---|
m_ClientInitComplete_Event | ChatClient가 Init 이 완료되면 발생합니다. |
m_ClientInitFailed_Event | ChatClient가 Init Failed 시 발생합니다. |
m_ChatDisconnect_Event | Chat 서버가 Discconnect 시 발생합니다. |
m_DirectMsg_Response_Event | DirectMsg 가 도착했을 때 발생하는 이벤트를 처리합니다. |
m_ChannelMsg_Response_Event | ChannelMsg 가도착했을 때 발생하는 이벤트를 처리합니다. |
m_Notice_Response_Event | Notice 도착 시 발생하는 이벤트를 처리합니다. |
m_Channel_Join_Success_Event | Channel Join 성공 시 발생하는 이벤트를 처리합니다. |
m_Channel_Join_Failed_Event | Channel Join 실패 시 발생하는 이벤트를 처리합니다. |
m_Channel_Leave_Success_Event | Channel Leave 성공 시 발생하는 이벤트를 처리합니다. |
m_Channel_Leave_Failed_Event | Channel Leave 실패 시 발생하는 이벤트를 처리합니다. |
m_Msg_Translate_Success_Event | (Beta) 메세지 Translate 성공 시 발생하는 이벤트를 처리합니다. |
m_Msg_Translate_Failed_Event | (Beta) 메세지 Translate 실패 시 발생하는 이벤트를 처리합니다. |
m_Msg_Record_Success_Event | (Beta) 과거 기록 불러오기 성공 시 발생하는 이벤트를 처리합니다. |
m_Msg_Record_Failed_Event | (Beta) 과거 기록 불러오기 실패 시 발생하는 이벤트를 처리합니다. |
빌드하기
- Android
Stripped 폴더의 플러그인 선택을 참고하시기 바랍니다.
- iOS
iOS 빌드하기를 참고하시기 바랍니다.
Last updated
