Legacy Documentation: Version 5.0
Language: English
  • C#
  • JS

Script language

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

EditorGUI.Foldout

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

Sumbission failed

For some reason your suggested change could not be submitted. Please try again in a few minutes. And thank you for taking the time to help us improve the quality of Unity Documentation.

Close

Cancel

Switch to Manual
public static function Foldout(position: Rect, foldout: bool, content: string, style: GUIStyle = EditorStyles.foldout): bool;
public static bool Foldout(Rect position, bool foldout, string content, GUIStyle style = EditorStyles.foldout);
public static function Foldout(position: Rect, foldout: bool, content: string, toggleOnLabelClick: bool, style: GUIStyle = EditorStyles.foldout): bool;
public static bool Foldout(Rect position, bool foldout, string content, bool toggleOnLabelClick, GUIStyle style = EditorStyles.foldout);
public static function Foldout(position: Rect, foldout: bool, content: GUIContent, style: GUIStyle = EditorStyles.foldout): bool;
public static bool Foldout(Rect position, bool foldout, GUIContent content, GUIStyle style = EditorStyles.foldout);
public static function Foldout(position: Rect, foldout: bool, content: GUIContent, toggleOnLabelClick: bool, style: GUIStyle = EditorStyles.foldout): bool;
public static bool Foldout(Rect position, bool foldout, GUIContent content, bool toggleOnLabelClick, GUIStyle style = EditorStyles.foldout);

Parameters

positionRectangle on the screen to use for the arrow and label.
foldoutThe shown foldout state.
contentThe label to show.
styleOptional GUIStyle.
toggleOnLabelClickShould the label be a clickable part of the control?

Returns

bool The foldout state selected by the user. If true, you should render sub-objects.

Description

Make a label with a foldout arrow to the left of it.

This is useful for creating tree or folder like structures where child objects are only shown if the parent is folded out.


Foldout in an Editor Window.

#pragma strict
// Create a foldable menu that hides/shows the selected transform position.
// if no Transform is selected, the Foldout item will be folded until a transform is selected.
public class EditorGUIFoldout extends EditorWindow {
	public var showPosition = true;
	public var status = "Select a GameObject";
	@MenuItem("Examples/Foldout Usage")
	static function Init() {
		var window = GetWindow(EditorGUIFoldout);
		window.position = new Rect(0, 0, 150, 60);
		window.Show();
	}
	function OnGUI() {
		showPosition = EditorGUI.Foldout(new Rect(3, 3, position.width - 6, 15), showPosition, status);
		if (showPosition)if (Selection.activeTransform) {
			Selection.activeTransform.position = EditorGUI.Vector3Field(new Rect(3, 25, position.width - 6, 40), "Position", Selection.activeTransform.position);
			status = Selection.activeTransform.name;
		}
		if (!Selection.activeTransform) {
			status = "Select a GameObject";
			showPosition = false;
		}
	}
	function OnInspectorUpdate() {
		Repaint();
	}
}
using UnityEditor;
using UnityEngine;
using System.Collections;

// Create a foldable menu that hides/shows the selected transform position. // if no Transform is selected, the Foldout item will be folded until a transform is selected. public class EditorGUIFoldout : EditorWindow { public bool showPosition = true; public string status = "Select a GameObject"; [MenuItem("Examples/Foldout Usage")] static void Init() { UnityEditor.EditorWindow window = GetWindow(typeof(EditorGUIFoldout)); window.position = new Rect(0, 0, 150, 60); window.Show(); } void OnGUI() { showPosition = EditorGUI.Foldout(new Rect(3, 3, position.width - 6, 15), showPosition, status); if (showPosition) if (Selection.activeTransform) { Selection.activeTransform.position = EditorGUI.Vector3Field(new Rect(3, 25, position.width - 6, 40), "Position", Selection.activeTransform.position); status = Selection.activeTransform.name; } if (!Selection.activeTransform) { status = "Select a GameObject"; showPosition = false; } } void OnInspectorUpdate() { Repaint(); } }