Legacy Documentation: Version 2017.1 (Go to current version)
LanguageEnglish
  • C#
  • JS

Script language

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

Handles.Button

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

Submission failed

For some reason your suggested change could not be submitted. Please <a>try again</a> 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 Button(position: Vector3, direction: Quaternion, size: float, pickSize: float, capFunction: Handles.CapFunction): bool;
public static bool Button(Vector3 position, Quaternion direction, float size, float pickSize, Handles.CapFunction capFunction);

Parameters

position The position to draw the button in the space of Handles.matrix.
direction The rotation of the button in the space of Handles.matrix.
size The visual size of the handle. Use HandleUtility.GetHandleSize if you want a constant screen-space size.
pickSize The size of the button for the purpose of detecting a click. Use HandleUtility.GetHandleSize if you want a constant screen-space size.
capFunction The draw style of the button.

Returns

bool True when the user clicks the button.

Description

Make a 3D Button.

This button works like one drawn with GUI.Button, but it has a 3D position and is drawn by a handle function.


Button Handle as a rectangle in the Scene View.

Add the following script to your Assets folder as ButtonExample.cs and add the ButtonExample component to an object in a scene.

#pragma strict
public class ButtonExample extends MonoBehaviour {
}
using UnityEngine;

public class ButtonExample : MonoBehaviour {}

Add the following script to Assets/Editor as ButtonExampleEditor.cs and select the object with the ButtonExample component.

#pragma strict
@CustomEditor(ButtonExample)
@CanEditMultipleObjects
class ButtonExampleEditor extends Editor {
	protected virtual function OnSceneGUI() {
		var buttonExample: ButtonExample = ButtonExampletarget;
		var position: Vector3 = buttonExample.transform.position + Vector3.up * 2f;
		var size: float = 2f;
		var pickSize: float = size * 2f;
		if (Handles.Button(position, Quaternion.identity, size, pickSize, Handles.RectangleHandleCap))
			Debug.Log("The button was pressed!");
	}
}
using UnityEditor;
using UnityEngine;

[CustomEditor(typeof(ButtonExample)), CanEditMultipleObjects] class ButtonExampleEditor : Editor { protected virtual void OnSceneGUI() { ButtonExample buttonExample = (ButtonExample)target;

Vector3 position = buttonExample.transform.position + Vector3.up * 2f; float size = 2f; float pickSize = size * 2f;

if (Handles.Button(position, Quaternion.identity, size, pickSize, Handles.RectangleHandleCap)) Debug.Log("The button was pressed!"); } }

Did you find this page useful? Please give it a rating: