Script language:

  • JS
  • C#
  • Boo
Script language

Select your preferred scripting language. All code snippets will be displayed in this language.

Component.SendMessageUpwards

SendMessageUpwards(methodName: string, options: SendMessageOptions): void;
void SendMessageUpwards(string methodName, SendMessageOptions options);
def SendMessageUpwards(methodName as string, options as SendMessageOptions) as void
SendMessageUpwards(methodName: string, value: object = null, options: SendMessageOptions = SendMessageOptions.RequireReceiver): void;
void SendMessageUpwards(string methodName, object value = null, SendMessageOptions options = SendMessageOptions.RequireReceiver);
def SendMessageUpwards(methodName as string, value as object = null, options as SendMessageOptions = SendMessageOptions.RequireReceiver) as void

Parameters

methodNameName of method to call.
valueOptional parameter value for the method.
optionsShould an error be raised if the method does not exist on the target object?

Description

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).

	// Calls the function ApplyDamage with a value of 5
	SendMessageUpwards ("ApplyDamage", 5.0);
	
	// Every script attached to the game object 
	// that has a ApplyDamage function will be called.
	function ApplyDamage (damage : float) {
		print (damage);
	}
using UnityEngine;
using System.Collections;

public class ExampleClass : MonoBehaviour {
    void ApplyDamage(float damage) {
        print(damage);
    }
    void Example() {
        SendMessageUpwards("ApplyDamage", 5.0F);
    }
}
import UnityEngine
import System.Collections

public class ExampleClass(MonoBehaviour):

	def ApplyDamage(damage as float) as void:
		print(damage)

	def Example() as void:
		SendMessageUpwards('ApplyDamage', 5.0F)