Category Archives: C#

Unity C# – SendMessage, SendMessageUpwards, BroadcastMessage 알아보기

unity_logo

이번에는 원하는 GameObject에 붙어있는 한개 이상의 Script에 구현되어있는 메소드를 호출하는 방법에 대해 이야기 해보겠습니다. 이 방법을 사용하면 해당 GameObject에 실행하고자 하는 메소드를 가진 스크립트가 컴포넌트로 존재하는지 아닌지를 크게 신경쓰지 않고도 호출하는 것이 가능합니다.

public void SendMessage(string methodName, object value = null,
SendMessageOptions options = SendMessageOptions.RequireReceiver);

SendMessage 함수는 현재 스크립트가 실행중인 GameObject에 붙어있는 모든 MonoBehaviour 스크립트의 원하는 함수를 호출해 줍니다.

위의 코드가 실행되면 ApplyDamage() 함수에 파라미터 5.0f 가 넘어가며 실행되게 됩니다.

unity_sendmessage_01

하나의 GameObject에 두개의 스크립트를 붙여보았습니다. 그리고 ExampleClass1에서는 SendMessage를 사용하여 ExampleClass2에 있는 메소드를 호출해 보겠습니다.

위의 실행결과는 정상적으로 다음과 같이 출력이 됩니다.

여기서 알 수 있는 것은 SendMessage는 GameObject에 추가되어있는 모든 Script 컴포넌트들에 전달이 되게 됩니다. 그중에 같은 이름을 가지고 있는 메소드가 있다면 그것이 실행되게 됩니다. 해당 이름의 메소드가 호출하는 스크립트 내부에 선언되어 있다면 그것이 최우선 순위로 실행이 되고 이후에는 컴포넌트에 등록되어있는 순서대로 메시지가 전달됩니다.

SendMessage를 호출할때는 파라미터를 가지고 있더라도 수신하는 메소드는 파라미터를 받지 않음으로써 넘어올 파라미터를 무시할 수 있습니다. 다음의 코드는 문제 없이 ApplyDamage() 메소드가 호출됩니다.

SendMessage는 .Net 리플렉션을 통하여 구현됩니다. 때문에 처음 찾게 되는 같은 이름을 가진 메소드를 실행하게 되며 만약 메소드 오버로딩이 되어있는 상태라면 정상적으로 동작하지 않게 됩니다.

위의 코드는 Damage: Ignored 를 출력하게 됩니다. 추가로 SetActive(false)와 같은 방법으로 비활성화 되어있는 GameObject는 메시지를 수신하지 않습니다.

public void SendMessageUpwards(string methodName, object value = null,
SendMessageOptions options = SendMessageOptions.RequireReceiver);

이번에는 SendMessageUpwards 메소드에 대해 알아보겠습니다. 기본적으로 SendMessage 와 동일하게 동작하지만 자신(GameObject)를 포함하여 부모 GameObject까지 메시지를 전달합니다.unity_sendmessage_upwards_01

위의 스크린샷과 같이 두개의 GameObject를 부모 자식 형태로 배치를 해보았습니다. 스크립트는 다음과 같이 부여하였습니다.

이 코드의 실행 결과는 RyanChild로 시작하여 부모인 RyanParent까지 전달이 됩니다.

기타 비활성화 되어있는 GameObject는 이벤트를 받을 수 없다거나 오버로딩에 정상적으로 대응하지 못하는 특성은 SendMessage와 동일합니다.

public void BroadcastMessage(string methodName, object parameter = null,
SendMessageOptions options = SendMessageOptions.RequireReceiver);

이번에는 위에서 설명한 SendMessageUpwards와 반대로 동작하는 메소드입니다. BroadcastMessage를 통해 메소드를 호출하게 되면 자기 자신의 GameObject를 포함하여 그의 모든 자식 객체들에게 메시지가 전달됩니다.

이번에는 부모 GameObject에서 BroadcastMessage를 실행해 보겠습니다.

예상했던데로 부모의ApplyDamage가 호출되고 그 다음에 자식의 ApplyDamage가 호출됩니다.

BroadcastMessage 역시 마찬가지로 비활성화되어있는 GameObject는 메시지를 받을 수 없다거나 오버로딩에 정상적으로 대응 할 수 없다는 특징은 같습니다.

SendMessageOptions 은 무엇인가?

위에서 설명한 모든 메소드들의 3번째 인자로 SendMessageOptions 가 있습니다. enum 타입이며 다음과 같은 두가지 타입을 선택할 수 있습니다.

  • RequireReceiver : SendMessage에 대응할 수 있는 수신자가 반드시 있어야 합니다.
  • DontRequireReceiver : SendMessage에 대응할 수 있는 수신자가 없어도 괜찮습니다.

3번째 파라미터를 지정하지 않아도 기본 값은 RequireReceiver이며 이는 한번 메시지 호출이 발생하면 누군가는 그것을 받아서 처리를 해주어야 한다는것을 의미합니다. 만약에 대응되는 메소드가 존재하지 않는다면 오류가 발생하게 됩니다.unity_message_require_receiver

하지만 DontRequireReceiver 는 아무도 처리하지 않아도 문제가 되지 않습니다. Optional한 처리를 하는 경우 쓸만한 옵션일 것 같습니다.

참고 :
https://docs.unity3d.com/ScriptReference/GameObject.SendMessage.html
https://docs.unity3d.com/ScriptReference/GameObject.SendMessageUpwards.html
https://docs.unity3d.com/ScriptReference/GameObject.BroadcastMessage.html

Unity C# – Delegate 알아보기

unity_logo

이번에는 delegate 에 대해서 알아보겠습니다. C#에서는 이 delegate 를 사용하여 함수에 대한 참조를 나타내는 방법입니다. delegate를 인스턴스화 하면 호환되는 파라미터 타입/개수와 반환 타입이 같은 모든 메소드를 참조할 수 있게 됩니다. 한번 참조된 delegate 를 통해 참조된 함수를 대리로 호출하는 것이 가능해집니다. C++의 함수 포인터와 동일한 형태로 사용가능하지만 안전하게 캡슐화 하여 사용할 수 있다는 장점이 있습니다.

위의 코드는 string 타입 파라미터를 하나 가지고 있고 반환 타입이 없는(void) delegate Del 을 선언하는 코드입니다. 이 delegate는 인스턴스화 하고 나면 참조하고 있는 실제 메소드를 대리로 호출하는것이 가능해지며 마치 기존의 메소드를 직접 호출하는것처럼 호출할 수 있습니다.

위의 코드를 보면 Del delegate를 인스턴스화 하며 DelegateMethod를 참조하도록 하고 있는 것을 볼 수 있습니다. new 키워드를 사용하지 않고 좀 더 간단하게 선언하는 방법도 있습니다.

이러한 delegate를 사용하여 특정 작업이 수행된 뒤에 호출되는 콜백(Callback) 으로 사용할 수 있습니다.

위의 코드는 특정 작업이 호출된 뒤에 결과를 출력하는데 사용할 DelegateMethod 메소드를 delegate를 통해서 RunHeavyJob에 넘겨 콜백으로 사용하는것을 볼 수 있는 예제입니다.

여기까지는 수많은 언어에서 볼 수 있는 일반적인 형태의 콜백, 리스너, 함수 포인터와 같은 기능이지 않을까 생각합니다. 하지만 추가로 멋진 기능이라고 생각되는 멀티캐스트(Multicast) 호출 기능을 사용할 수 있습니다.

위의 코드는 한번 인스턴스화 한 delegate 인 handler 변수에 계속해서 새로운 delegate를 추가하는 과정입니다. 그리고 handler를 호출하게 되면 지금까지 등록된 delegate 모두를 대리호출 하게 됩니다. 이때에는 등록된 순서대로 차례차례 호출이 되게 됩니다. 즉 결과는 다음과 같이 출력됩니다.

물론 다음과 같은 방법으로 등록된 delegate를 제거하는것도 가능합니다.

위의 코드를 수행하면 이미 등록되어있던 DelegateMethod1, DelegateMethod2, DelegateMethod3 중에 DelegateMethod2가 제거되게 됩니다.

이미 등록된 delegate의 수를 확인하려면 다음과 같이 하면 됩니다.

참고 :
https://msdn.microsoft.com/ko-kr/library/ms173171.aspx
https://msdn.microsoft.com/ko-kr/library/ms173172.aspx