methodName | Name of method to call. |
value | Optional parameter value for the method. |
options | Should an error be raised if the method does not exist on the target object? |
Calls the method named methodName
on every MonoBehaviour in this game object and on every ancestor of the behaviour.
The receiving method can choose to ignore the argument by having zero arguments.
If the options
parameter is set to SendMessageOptions.RequireReceiver an error is printed when the message is not picked up by any component.
Note that messages will not be sent to inactive objects (ie, those that have been deactivated in the editor or with the GameObject.SetActive function).
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); } }
Did you find this page useful? Please give it a rating:
Thanks for rating this page!
What kind of problem would you like to report?
Thanks for letting us know! This page has been marked for review based on your feedback.
If you have time, you can provide more information to help us fix the problem faster.
Provide more information
You've told us this page needs code samples. If you'd like to help us further, you could provide a code sample, or tell us about what kind of code sample you'd like to see:
You've told us there are code samples on this page which don't work. If you know how to fix it, or have something better we could use instead, please let us know:
You've told us there is information missing from this page. Please tell us more about what's missing:
You've told us there is incorrect information on this page. If you know what we should change to make it correct, please tell us:
You've told us this page has unclear or confusing information. Please tell us more about what you found unclear or confusing, or let us know how we could make it clearer:
You've told us there is a spelling or grammar error on this page. Please tell us what's wrong:
You've told us this page has a problem. Please tell us more about what's wrong:
Thank you for helping to make the Unity documentation better!
Your feedback has been submitted as a ticket for our documentation team to review.
We are not able to reply to every ticket submitted.