이번에는 원하는 GameObject에 붙어있는 한개 이상의 Script에 구현되어있는 메소드를 호출하는 방법에 대해 이야기 해보겠습니다. 이 방법을 사용하면 해당 GameObject에 실행하고자 하는 메소드를 가진 스크립트가 컴포넌트로 존재하는지 아닌지를 크게 신경쓰지 않고도 호출하는 것이 가능합니다.
public void SendMessage(string methodName, object value = null,
SendMessageOptions options = SendMessageOptions.RequireReceiver);
SendMessage 함수는 현재 스크립트가 실행중인 GameObject에 붙어있는 모든 MonoBehaviour 스크립트의 원하는 함수를 호출해 줍니다.
void Start () {
gameObject.SendMessage("ApplyDamage", 5.0f);
}
void ApplyDamage(float damage) {
Debug.Log ("Damage: " + damage);
}
위의 코드가 실행되면 ApplyDamage() 함수에 파라미터 5.0f 가 넘어가며 실행되게 됩니다.
하나의 GameObject에 두개의 스크립트를 붙여보았습니다. 그리고 ExampleClass1에서는 SendMessage를 사용하여 ExampleClass2에 있는 메소드를 호출해 보겠습니다.
public class ExampleClass1 : MonoBehaviour {
void Start () {
gameObject.SendMessage("ApplyDamage", 5.0f);
}
}
public class ExampleClass2 : MonoBehaviour {
void Start () {
}
void ApplyDamage(float damage) {
Debug.Log ("ExampleClass2 Damage: " + damage);
}
}
위의 실행결과는 정상적으로 다음과 같이 출력이 됩니다.
ExampleClass2 Damage: 5
여기서 알 수 있는 것은 SendMessage는 GameObject에 추가되어있는 모든 Script 컴포넌트들에 전달이 되게 됩니다. 그중에 같은 이름을 가지고 있는 메소드가 있다면 그것이 실행되게 됩니다. 해당 이름의 메소드가 호출하는 스크립트 내부에 선언되어 있다면 그것이 최우선 순위로 실행이 되고 이후에는 컴포넌트에 등록되어있는 순서대로 메시지가 전달됩니다.
public class ExampleClass1 : MonoBehaviour {
void Start () {
gameObject.SendMessage("ApplyDamage", 5.0f);
}
void ApplyDamage(float damage) {
Debug.Log ("ExampleClass1 Damage: " + damage);
}
}
public class ExampleClass2 : MonoBehaviour {
void Start () {
}
void ApplyDamage(float damage) {
Debug.Log ("ExampleClass2 Damage: " + damage);
}
}
//=>
ExampleClass1 Damage: 5
ExampleClass2 Damage: 5
SendMessage를 호출할때는 파라미터를 가지고 있더라도 수신하는 메소드는 파라미터를 받지 않음으로써 넘어올 파라미터를 무시할 수 있습니다. 다음의 코드는 문제 없이 ApplyDamage() 메소드가 호출됩니다.
void Start () {
gameObject.SendMessage("ApplyDamage", 5.0f);
}
void ApplyDamage() {
Debug.Log ("Damage: Parameter Ignored");
}
SendMessage는 .Net 리플렉션을 통하여 구현됩니다. 때문에 처음 찾게 되는 같은 이름을 가진 메소드를 실행하게 되며 만약 메소드 오버로딩이 되어있는 상태라면 정상적으로 동작하지 않게 됩니다.
void Start () {
gameObject.SendMessage("ApplyDamage", 5.0f);
}
void ApplyDamage() {
Debug.Log ("Damage: Ignored");
}
void ApplyDamage(float damage) {
Debug.Log ("Damage: " + damage);
}
위의 코드는 Damage: Ignored 를 출력하게 됩니다. 추가로 SetActive(false)와 같은 방법으로 비활성화 되어있는 GameObject는 메시지를 수신하지 않습니다.
public void SendMessageUpwards(string methodName, object value = null,
SendMessageOptions options = SendMessageOptions.RequireReceiver);
이번에는 SendMessageUpwards 메소드에 대해 알아보겠습니다. 기본적으로 SendMessage 와 동일하게 동작하지만 자신(GameObject)를 포함하여 부모 GameObject까지 메시지를 전달합니다.
위의 스크린샷과 같이 두개의 GameObject를 부모 자식 형태로 배치를 해보았습니다. 스크립트는 다음과 같이 부여하였습니다.
public class RyanParent : MonoBehaviour {
void Start () {
}
void ApplyDamage(float damage) {
Debug.Log ("RyanParent Damage: " + damage);
}
}
public class RyanChild : MonoBehaviour {
void Start () {
gameObject.SendMessageUpwards ("ApplyDamage", 5.0f);
}
void ApplyDamage(float damage) {
Debug.Log ("RyanChild Damage: " + damage);
}
}
이 코드의 실행 결과는 RyanChild로 시작하여 부모인 RyanParent까지 전달이 됩니다.
RyanChild Damage: 5 RyanParent Damage: 5
기타 비활성화 되어있는 GameObject는 이벤트를 받을 수 없다거나 오버로딩에 정상적으로 대응하지 못하는 특성은 SendMessage와 동일합니다.
public void BroadcastMessage(string methodName, object parameter = null,
SendMessageOptions options = SendMessageOptions.RequireReceiver);
이번에는 위에서 설명한 SendMessageUpwards와 반대로 동작하는 메소드입니다. BroadcastMessage를 통해 메소드를 호출하게 되면 자기 자신의 GameObject를 포함하여 그의 모든 자식 객체들에게 메시지가 전달됩니다.
이번에는 부모 GameObject에서 BroadcastMessage를 실행해 보겠습니다.
public class RyanParent : MonoBehaviour {
void Start () {
gameObject.BroadcastMessage ("ApplyDamage", 5.0f);
}
void ApplyDamage(float damage) {
Debug.Log ("RyanParent Damage: " + damage);
}
}
public class RyanChild : MonoBehaviour {
void Start () {
}
void ApplyDamage(float damage) {
Debug.Log ("RyanChild Damage: " + damage);
}
}
예상했던데로 부모의ApplyDamage가 호출되고 그 다음에 자식의 ApplyDamage가 호출됩니다.
RyanParent Damage: 5 RyanChild Damage: 5
BroadcastMessage 역시 마찬가지로 비활성화되어있는 GameObject는 메시지를 받을 수 없다거나 오버로딩에 정상적으로 대응 할 수 없다는 특징은 같습니다.
SendMessageOptions 은 무엇인가?
위에서 설명한 모든 메소드들의 3번째 인자로 SendMessageOptions 가 있습니다. enum 타입이며 다음과 같은 두가지 타입을 선택할 수 있습니다.
- RequireReceiver : SendMessage에 대응할 수 있는 수신자가 반드시 있어야 합니다.
- DontRequireReceiver : SendMessage에 대응할 수 있는 수신자가 없어도 괜찮습니다.
3번째 파라미터를 지정하지 않아도 기본 값은 RequireReceiver이며 이는 한번 메시지 호출이 발생하면 누군가는 그것을 받아서 처리를 해주어야 한다는것을 의미합니다. 만약에 대응되는 메소드가 존재하지 않는다면 오류가 발생하게 됩니다.
하지만 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