Legacy Documentation: Version 4.5.0

Script language:

  • JS
  • C#
  • Boo
Script language

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

EditorGUI.Popup

static function Popup(position: Rect, selectedIndex: int, displayedOptions: string[], style: GUIStyle = EditorStyles.popup): int;
static int Popup(Rect position, int selectedIndex, string[] displayedOptions, GUIStyle style = EditorStyles.popup);
static def Popup(position as Rect, selectedIndex as int, displayedOptions as string[], style as GUIStyle = EditorStyles.popup) as int
static function Popup(position: Rect, selectedIndex: int, displayedOptions: GUIContent[], style: GUIStyle = EditorStyles.popup): int;
static int Popup(Rect position, int selectedIndex, GUIContent[] displayedOptions, GUIStyle style = EditorStyles.popup);
static def Popup(position as Rect, selectedIndex as int, displayedOptions as GUIContent[], style as GUIStyle = EditorStyles.popup) as int
static function Popup(position: Rect, label: string, selectedIndex: int, displayedOptions: string[], style: GUIStyle = EditorStyles.popup): int;
static int Popup(Rect position, string label, int selectedIndex, string[] displayedOptions, GUIStyle style = EditorStyles.popup);
static def Popup(position as Rect, label as string, selectedIndex as int, displayedOptions as string[], style as GUIStyle = EditorStyles.popup) as int
static function Popup(position: Rect, label: GUIContent, selectedIndex: int, displayedOptions: GUIContent[], style: GUIStyle = EditorStyles.popup): int;
static int Popup(Rect position, GUIContent label, int selectedIndex, GUIContent[] displayedOptions, GUIStyle style = EditorStyles.popup);
static def Popup(position as Rect, label as GUIContent, selectedIndex as int, displayedOptions as GUIContent[], style as GUIStyle = EditorStyles.popup) as int

Parameters

positionRectangle on the screen to use for the field.
labelOptional label in front of the field.
selectedIndexThe index of the option the field shows.
displayedOptionsAn array with the options shown in the popup.
styleOptional GUIStyle.

Returns

int The index of the option that has been selected by the user.

Description

Make a generic popup selection field.

Takes the currently selected index as a parameter and returns the index selected by the user.


Popup in and Editor Window.

	// Adds a component to the selected GameObjects
	
	class EditorGUIPopup extends EditorWindow {
		var options : String[] = ["Rigidbody", "Box Collider", "Sphere Collider"];
		var index : int = 0;
		
		@MenuItem("Examples/Editor GUI Popup usage")
		static function Init() {
			var window = GetWindow(EditorGUIPopup);
			window.position = Rect(0,0,180,80);
			window.Show();
		}
		function OnGUI() {
			index = EditorGUI.Popup(
				Rect(0,0,position.width, 20),
				"Component:",
				index, 
				options);
				
			if(GUI.Button(Rect(0,25,position.width, position.height - 26),"Add Component"))
				AddComponentToObjects();
		}
		function AddComponentToObjects() {
			if(!Selection.activeGameObject) {
				Debug.LogError("Please select at least one GameObject first");
				return;
			}
			for(var go : GameObject in Selection.gameObjects)
				go.AddComponent(options[index]);
		}
	}