MenuItem Constructor

Parameters

Description

Creates a menu item and invokes the static function following it, when the menu item is selected.

MenuItem is an attribute that precedes a script function. This makes the function appear in the Unity menu system. The menu location is specified by the itemName argument.

isValidateFunction is used to make a MenuItem function as one that will be executed before a script function with the same itemName argument. The second argument is boolean. If this argument is set to true it will mark the associated function as one that is called before the execution of the second script function. This second script function with the same itemName will be executed next.

priority determines how the following script function is ordered in the menu system. The integer value is compared against values on other script functions. If the integer value is greater than other values then the MenuItem script function will be placed at the bottom of the list. The value of priority can also be used to manage the list of script functions into groups. The example later in this page describes more about this feature.

The following script example adds two functions into a Example menu system.

#pragma strict
// Add Example1 into a new menu list
@MenuItem("Example/Example1", false, 100)
public static function Example1() {
	print("Example/Example1");
}
// Add Example1 into a new menu list
@MenuItem("Example/Example2", false, 100)
public static function Example2() {
	print("Example/Example2");
}

using UnityEngine;
using System.Collections;

public class ExampleClass : MonoBehaviour {
 
    // Add Example1 into a new menu list
    [MenuItem("Example/Example1", false, 100)]
    public static void Example1() {
        print("Example/Example1");
    }
 
    // Add Example1 into a new menu list
    [MenuItem("Example/Example2", false, 100)]
    public static void Example2() {
        print("Example/Example2");
    }
}

This simple following example shows how the Example menu can have two entries divided by a separator line. This happens when the priority argument is separated by more than 10. (However, see the following description.)

#pragma strict
// Add Example1 has priority of 110
@MenuItem("Example/Example1", false, 100)
public static function Example1() {
	print("Example/Example1");
}
// This will cause a divider to be created.
@MenuItem("Example/Example2", false, 111)
public static function Example2() {
	print("Example/Example2");
}

using UnityEngine;
using System.Collections;

public class ExampleClass : MonoBehaviour {
 
    // Add Example1 has priority of 110
    [MenuItem("Example/Example1", false, 100)]
    public static void Example1() {
        print("Example/Example1");
    }
 
    // Example2 has a priority of 111 which is 11 more than Example1.
    // This will cause a divider to be created.
    [MenuItem("Example/Example2", false, 111)]
    public static void Example2() {
        print("Example/Example2");
    }
}

Note: The understanding of ten or greater is considered to create a divider in the menu. However, as per the example above, the difference between script function need to have the priority separated by 11 or more. This is why the example before has a value of 100 and one of 111. Changing 111 to 110 does not have a divider.