Documentation

Unity Engine

User Manual

Script Reference

Unity Engine

ContextMenu

Adds the function to the context menu of the component.
Read time 2 minutesLast updated 4 days ago

Definition

  • Type: Constructor
  • Namespace: UnityEngine
  • Assembly: UnityEngine.CoreModule

ContextMenu(string)

Adds the function to the context menu of the component.
public ContextMenu(string itemName)

Parameters

itemName

string
The name of the context menu item.

Remarks

In the inspector of the attached script. When the user selects the context menu, the function will be executed.
This is most useful for automatically setting up Scene data from the script. The function has to be non-static.

Examples

using UnityEngine;public class ContextTesting : MonoBehaviour{    /// Add a context menu named "Do Something" in the inspector    /// of the attached script.    [ContextMenu("Do Something")]    void DoSomething()    {        Debug.Log("Perform operation");    }}

ContextMenu(string, bool)

Adds the function to the context menu of the component.
public ContextMenu(string itemName, bool isValidateFunction)

Parameters

itemName

string
The name of the context menu item.

isValidateFunction

bool
Whether this is a validate function (defaults to false).

Remarks

In the inspector of the attached script. When the user selects the context menu, the function will be executed.
This is most useful for automatically setting up Scene data from the script. The function has to be non-static.

Examples

using UnityEngine;public class ContextTesting : MonoBehaviour{    /// Add a context menu named "Do Something" in the inspector    /// of the attached script.    [ContextMenu("Do Something")]    void DoSomething()    {        Debug.Log("Perform operation");    }}

ContextMenu(string, bool, int)

Adds the function to the context menu of the component.
public ContextMenu(string itemName, bool isValidateFunction, int priority)

Parameters

itemName

string
The name of the context menu item.

isValidateFunction

bool
Whether this is a validate function (defaults to false).

priority

int
Priority used to override the ordering of the menu items (defaults to 1000000). The lower the number the earlier in the menu it will appear.

Remarks

In the inspector of the attached script. When the user selects the context menu, the function will be executed.
This is most useful for automatically setting up Scene data from the script. The function has to be non-static.

Examples

using UnityEngine;public class ContextTesting : MonoBehaviour{    /// Add a context menu named "Do Something" in the inspector    /// of the attached script.    [ContextMenu("Do Something")]    void DoSomething()    {        Debug.Log("Perform operation");    }}