Version: 5.4 beta (switch to 5.3)
LanguageEnglish
  • C#
  • JS

Script language

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

Handles.BeginGUI

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

public static function BeginGUI(): void;
public static void BeginGUI();
public static function BeginGUI(position: Rect): void;
public static void BeginGUI(Rect position);

Parameters

position The position and size of the 2D GUI area.

Description

Begin a 2D GUI block inside the 3D handle GUI.

Begin a 2D GUI block on top of the current handle camera.

See Also: Handles.EndGUI.


GUI in the Scene View.

To use this example, place this script in the Assets/Editor folder:


        
using UnityEngine;
using UnityEditor;

[CustomEditor( typeof( DummyButton ) )] public class DummyButtonHandleEditor : Editor { public float arrowSize = 1;

void OnSceneGUI( ) { DummyButton t = target as DummyButton;

Handles.color = Color.blue; Handles.Label( t.transform.position + Vector3.up * 2, t.transform.position.ToString( ) + "\nShieldArea: " + t.shieldArea.ToString( ) );

Handles.BeginGUI( ); GUILayout.BeginArea( new Rect( Screen.width - 100, Screen.height - 80, 90, 50 ) );

if( GUILayout.Button( "Reset Area" ) ) t.shieldArea = 5;

GUILayout.EndArea( ); Handles.EndGUI( );

Handles.DrawWireArc( t.transform.position, t.transform.up, -t.transform.right, 180, t.shieldArea );

t.shieldArea = Handles.ScaleValueHandle( t.shieldArea, t.transform.position + t.transform.forward * t.shieldArea, t.transform.rotation, 1, Handles.ConeCap, 1 ); } }

...and attach this script to the object which you'd like to attach the handles:


        
using UnityEngine;

[ExecuteInEditMode] public class DummyButton : MonoBehaviour { public float shieldArea = 5; }