Unreal Engine 4

아래의 링크를 통해 ProudChat Unreal Engine 4 SDK를 다운로드 합니다.

📂 Unreal Engine 4 ProudChat SDK

프로젝트 설정

- Plugins 설치

프로젝트 루트 폴더에서 Plugins 폴더를 새로 만듭니다.

다운로드한 SDK 파일을 생성한 Plugins 폴더로 복사합니다.

언리얼 에디터에서 편집 - 플러그인 을 눌러 플러그인 브라우저 탭에서 복사한 ProudChat 플러그인의 활성화 여부를 확인합니다.

Plugins 폴더로 복사한 후 언리얼 에디터에서 ProudChat 플러그인이 보이지 않을 경우 에디터를 종료 했다가 다시 실행 하시면 확인 가능합니다.

- 블루프린트 클래스 설정

Plugin이 정상적으로 설치되면 언리얼 에디터의 ProudChat C++ 클래스 브라우저에서 ProudChatActor 클래스를 기반으로 블루프린트 클래스를 생성 합니다.

생성한 블루프린트 클래스의 이벤트 그래프에서 Proud Chat의 Init함수를 생성해 BeginPlay 이벤트와 연결하고 Proud Console 에서 받아온 계정 UUID와 프로젝트 UUID, 유저 UniqueID를 입력 합니다.

컴파일 버튼을 눌러 이벤트를 컴파일 후 생성한 블루프린트 클래스를 레벨에 올리고 플레이를 눌러 서버와연결이 되는지 확인 합니다.

연결에 성공하면 레벨 좌상단에 ProudChat Connection Success 문구가 출력됩니다.

ProudChatActor

- ProudChatActor::Init

ProudChat을 Initialize 하는 부분입니다. 유저는 사용 전에 반드시 Init함수를 호출하여 서버와 연결을 해주셔야 합니다.

함수명	매개변수	설명
Init	Proud Console 에서 제공되는 유저의 UUID, 유저가 생성한 프로젝트의 UUID, 유저 고유의 UniqueID	ProudChat을 연결하기 위한 함수로 유저는 이 부분을 작성합니다. 매개변수로는 3개의 문자열을 받고 있지만, 내부적으로 std::bind를 통해 ChatClientInitComplete, ChatClientInitFailed 이벤트를 호출하고 있어 로그인에 성공, 실패 여부를 확인할 수 있습니다.

함수명

매개변수

설명

Init

Proud Console 에서 제공되는 유저의 UUID, 유저가 생성한 프로젝트의 UUID, 유저 고유의 UniqueID

ProudChat을 연결하기 위한 함수로 유저는 이 부분을 작성합니다. 매개변수로는 3개의 문자열을 받고 있지만, 내부적으로 std::bind를 통해 ChatClientInitComplete, ChatClientInitFailed 이벤트를 호출하고 있어 로그인에 성공, 실패 여부를 확인할 수 있습니다.

- 함수

함수명	매개변수	설명
AddChannel	접속하고 싶은 채널의 고유 Key	접속하고 싶은 채널의 키를 입력합니다.
LeaveChannel	접속 해제하고 싶은 채널의 고유 Key	접속을 해제하고 싶은 채널의 키를 입력합니다.
SendChannelMsg	특정 채널의 고유한 식별 값, 특정 채널에게 보낼 메시지	특정 채널에게 메시지를 보낼 때 사용합니다.
SendMsg	특정 상대방 고유한 식별 값, 특정 상대방에게 보낼 메시지	특정 상대에게 메시지를 보낼 때 사용합니다.

함수명

매개변수

설명

AddChannel

접속하고 싶은 채널의 고유 Key

접속하고 싶은 채널의 키를 입력합니다.

LeaveChannel

접속 해제하고 싶은 채널의 고유 Key

접속을 해제하고 싶은 채널의 키를 입력합니다.

SendChannelMsg

특정 채널의 고유한 식별 값, 특정 채널에게 보낼 메시지

특정 채널에게 메시지를 보낼 때 사용합니다.

SendMsg

특정 상대방 고유한 식별 값, 특정 상대방에게 보낼 메시지

특정 상대에게 메시지를 보낼 때 사용합니다.

- 이벤트 변수

이벤트 변수명	설명
InitComplete_Delegate	Init Complete가 완료되었을 때 호출되는 이벤트
InitFailed_Delegate	Init Failed가 되었을 때 호출되는 이벤트
ChannelMsg_Response_Delegate	Channel Message가 도착했을 때 호출되는 이벤트
SendMsg_Response_Delegate	Send Message가 도착했을 때 호출되는 이벤트
Notice_Response_Delegate	Notice가 도착했을 때 호출되는 이벤트

이벤트 변수명

설명

InitComplete_Delegate

Init Complete가 완료되었을 때 호출되는 이벤트

InitFailed_Delegate

Init Failed가 되었을 때 호출되는 이벤트

ChannelMsg_Response_Delegate

Channel Message가 도착했을 때 호출되는 이벤트

SendMsg_Response_Delegate

Send Message가 도착했을 때 호출되는 이벤트

Notice_Response_Delegate

Notice가 도착했을 때 호출되는 이벤트

- 이벤트 함수

이벤트 함수명	설명
ChatClientInitComplete	Server Connection 완료 후 Login까지 성공하면 호출되는 함수입니다.
ChatClientInitFailed	Server Login 실패 시 호출되는 함수입니다. 이 함수를 타게 되는 시점은 서버와의 연결은 성공하였으나 계정 로그인을 못할 때 발생하는 이벤트입니다. 실패 시 재시도를 하지 않으므로 설정 확인이 필요합니다.
ChannelMsg_Response	다른 유저가 채널에 메시지 전송 시 Delegate되는 이벤트 함수 사용자는 Event를 등록하여 사용 가능 하며, 등록 시 메시지가 온 채널의 Unique ID, 메시지를 발생 시킨 대상의 Unique ID, 상대방이 보낸 메시지를 매개변수로 받습니다.
SendMsg_Response	다른 유저가 나에게 메시지 전송 시 Delegate되는 이벤트 함수 사용자는 Event를 등록하여 사용 가능 하며, 등록 시 메시지를 발생 시킨 대상의 Unique ID, 상대방이 보낸 메시지를 매개변수로 받습니다.
Notice_Response	Proud Console 에서 공지사항 발송 시 Delegate되는 이벤트 함수 매개변수로 받은 메시지를 통해 공지사항 내용을 출력합니다.

이벤트 함수명

설명

ChatClientInitComplete

Server Connection 완료 후 Login까지 성공하면 호출되는 함수입니다.

ChatClientInitFailed

Server Login 실패 시 호출되는 함수입니다. 이 함수를 타게 되는 시점은 서버와의 연결은 성공하였으나 계정 로그인을 못할 때 발생하는 이벤트입니다. 실패 시 재시도를 하지 않으므로 설정 확인이 필요합니다.

ChannelMsg_Response

다른 유저가 채널에 메시지 전송 시 Delegate되는 이벤트 함수 사용자는 Event를 등록하여 사용 가능 하며, 등록 시 메시지가 온 채널의 Unique ID, 메시지를 발생 시킨 대상의 Unique ID, 상대방이 보낸 메시지를 매개변수로 받습니다.

SendMsg_Response

다른 유저가 나에게 메시지 전송 시 Delegate되는 이벤트 함수 사용자는 Event를 등록하여 사용 가능 하며, 등록 시 메시지를 발생 시킨 대상의 Unique ID, 상대방이 보낸 메시지를 매개변수로 받습니다.

Notice_Response

Proud Console 에서 공지사항 발송 시 Delegate되는 이벤트 함수 매개변수로 받은 메시지를 통해 공지사항 내용을 출력합니다.