SendMessageUpwards
Calls the method named methodName on every MonoBehaviour in this game object and on every ancestor of the behaviour.
Read time 2 minutesLast updated 6 days ago
Definition
- Type: Method
- Namespace: UnityEngine
- Assembly: UnityEngine.CoreModule
SendMessageUpwards(string, Object, SendMessageOptions)
Calls the method named on every MonoBehaviour in this game object and on every ancestor of the behaviour.
methodNamepublic void SendMessageUpwards(string methodName, object value, SendMessageOptions options)
Parameters
Name of method to call.
Optional parameter value for the method.
Should an error be raised if the method does not exist on the target object?
Remarks
The receiving method can choose to ignore the argument by having zero arguments. If the parameter is set to SendMessageOptions.RequireReceiver an error is printed when the message is not picked up by any component.
optionsNote that messages will not be sent to inactive objects (ie, those that have been deactivated in the editor or with the GameObject.SetActive function).
Examples
using UnityEngine;public class Example : MonoBehaviour{ void Start() { /// Calls the function ApplyDamage with a value of 5 SendMessageUpwards("ApplyDamage", 5.0); } // Every script attached to this game object and any ancestor // that has a ApplyDamage function will be called. void ApplyDamage(float damage) { print(damage); }}
SendMessageUpwards(string, SendMessageOptions)
Calls the method named on every MonoBehaviour in this game object and on every ancestor of the behaviour.
methodNamepublic void SendMessageUpwards(string methodName, SendMessageOptions options)
Parameters
Name of method to call.
Should an error be raised if the method does not exist on the target object?
Remarks
The receiving method can choose to ignore the argument by having zero arguments. If the parameter is set to SendMessageOptions.RequireReceiver an error is printed when the message is not picked up by any component.
optionsNote that messages will not be sent to inactive objects (ie, those that have been deactivated in the editor or with the GameObject.SetActive function).
Examples
using UnityEngine;public class Example : MonoBehaviour{ void Start() { /// Calls the function ApplyDamage with a value of 5 SendMessageUpwards("ApplyDamage", 5.0); } // Every script attached to this game object and any ancestor // that has a ApplyDamage function will be called. void ApplyDamage(float damage) { print(damage); }}