Unity Script Reference – GameObject.BroadcastMessage

GameObject.BroadcastMessage

function BroadcastMessage (methodName : String, parameter : object = null, options : SendMessageOptions = SendMessageOptions.RequireReceiver) : void

Description

Calls the method named methodName on every MonoBehaviour in this game object or any of its children.

The receiving method can choose to ignore parameter by having zero parameters. If options is set to SendMessageOptions.RequireReceiver an error is printed when the message is not picked up by any component.

JavaScript

/// Calls the function ApplyDamage with a value of 5
gameObject.BroadcastMessage ("ApplyDamage", 5.0);

// Every script attached to the game object and all its children
// that has a ApplyDamage function will be called.
function ApplyDamage (damage : float) {
    print (damage);
}

using UnityEngine;
using System.Collections;

public class example : MonoBehaviour {
    void ApplyDamage(float damage) {
        print(damage);
    }
    void Example() {
        gameObject.BroadcastMessage("ApplyDamage", 5.0F);
    }
}

import UnityEngine
import System.Collections

class example(MonoBehaviour):

    def ApplyDamage(damage as single):
        print(damage)

    def Example():
        gameObject.BroadcastMessage('ApplyDamage', 5.0F)