Legacy Documentation: Version 5.2
LanguageEnglish
  • C#
  • JS

Script language

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

Handles.EndGUI

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 EndGUI(): void;
public static void EndGUI();

Description

End a 2D GUI block and get back to the 3D handle GUI.

See Also: Handles.BeginGUI.


GUI in the Scene View.

	// Create a 180 degrees wire arc with a ScaleValueHandle attached to the disc
	// that lets you modify the "shieldArea" var in the WireArcExample.js, also
	// lets you visualize some info of the transform and finally lets you 
	// reset the shield area value to 5 by clicking on a button
	
		// cast & store references
		Shield shield = (target as Shield);
		Transform transform = shield.transform;
		
		// 3D UI: arc and scale handle
	    	Handles.color = Color.blue;
		Handles.DrawWireArc(transform.position, transform.up, -transform.right, 180, shield.shieldArea);
		shield.shieldArea = Handles.ScaleValueHandle( shield.shieldArea, transform.position + transform.forward*shield.shieldArea, transform.rotation, 1, Handles.ConeCap, 1);
		
		// start of 2D UI section
		Handles.BeginGUI();
		
		// information label
		Handles.Label(transform.position + Vector3.right*2, "Shield Area: " +shield.shieldArea);
		
		// reset button:
		GUILayout.BeginArea(new Rect(Screen.width - 100, Screen.height - 80, 90,50));
		if(GUILayout.Button("Reset Area")) { shield.shieldArea = 5; }
		GUILayout.EndArea();
		
		// end of 2D UI section
	 		Handles.EndGUI();
	 		
	    }
	}

And the script attached to the Game Object which should have these custom handles:

	// DummyButtonScript.js
	
	var shieldArea : float = 5;