Suggest a change
Success!
Thank you for helping us improve the quality of Unity Documentation. Although we cannot accept all submissions, we do read each suggested change from our users and will make updates where applicable.
Close
Submission failed
For some reason your suggested change could not be submitted. Please <a>try again</a> in a few minutes. And thank you for taking the time to help us improve the quality of Unity Documentation.
Close
Switch to Manual
Declaration
public void
BroadcastMessage(string
methodName,
Object
parameter = null,
SendMessageOptions options = SendMessageOptions.RequireReceiver);
Parameters
| Parameter |
Description |
| methodName |
The name of the MonoBehaviour method to call. |
| parameter |
An optional parameter value to pass to the called method. |
| options |
Whether an error should be raised if the method doesn't exist on the target object. |
Description
Calls the specified method on every MonoBehaviour attached to the GameObject or any of its children.
A parameter specified for a method that doesn't accept parameters is ignored.
If options is set to SendMessageOptions.RequireReceiver an error is printed when the message is not picked up by any component.
using UnityEngine;
public class Example : MonoBehaviour
{
void Start()
{
/// Calls the function ApplyDamage with a value of 5
/// // Every script attached to the GameObject and all its children
// that has a ApplyDamage function will be called.
gameObject.BroadcastMessage("ApplyDamage", 5.0);
}
}
public class Example2 : MonoBehaviour
{
public void ApplyDamage(float damage)
{
print(damage);
}
}