Legacy Documentation: Version 5.5
LanguageEnglish
  • C#
  • JS

Script language

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

ContextMenu Constructor

public ContextMenu(string itemName);
public ContextMenu(string itemName, bool isValidateFunction);
public ContextMenu(string itemName, bool isValidateFunction, int priority);

Parameters

itemName The name of the context menu item.
isValidateFunction Whether this is a validate function (defaults to false).
priority 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.

Description

Adds the function to the context menu of the component.

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.

	@ContextMenu ("Do Something")
	function DoSomething () {
		Debug.Log ("Perform operation");
	}
	// C# example:
	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");
		}
	}