Legacy Documentation: Version 2018.1 (Go to current version)
LanguageEnglish
  • C#
  • JS

Script language

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

Component.SendMessage

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

Cancel

public method SendMessage(methodName: string): void;
public void SendMessage(string methodName);
public method SendMessage(methodName: string, value: object): void;
public void SendMessage(string methodName, object value);
public method SendMessage(methodName: string, value: object, options: SendMessageOptions): void;
public void SendMessage(string methodName, object value, SendMessageOptions options);
public method SendMessage(methodName: string, options: SendMessageOptions): void;
public void SendMessage(string methodName, SendMessageOptions options);

Parameters

methodNameName of the method to call.
valueOptional parameter for the method.
optionsShould an error be raised if the target object doesn't implement the method for the message?

Description

Calls the method named methodName on every MonoBehaviour in this game object.

The receiving method can choose to ignore the argument by having zero arguments. If options 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
    SendMessage ("ApplyDamage", 5.0);

// Every script attached to the game object // that has a ApplyDamage function will be called. function ApplyDamage (damage : float) { print (damage); }
no example available in C#

Did you find this page useful? Please give it a rating: