Version: 2017.2 (switch to 2017.3b)
LanguageEnglish
  • C#
  • JS

Script language

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

Handles.Label

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 method Label(position: Vector3, text: string): void;
public static void Label(Vector3 position, string text);
public static method Label(position: Vector3, image: Texture): void;
public static void Label(Vector3 position, Texture image);
public static method Label(position: Vector3, content: GUIContent): void;
public static void Label(Vector3 position, GUIContent content);
public static method Label(position: Vector3, text: string, style: GUIStyle): void;
public static void Label(Vector3 position, string text, GUIStyle style);
public static method Label(position: Vector3, content: GUIContent, style: GUIStyle): void;
public static void Label(Vector3 position, GUIContent content, GUIStyle style);

Parameters

position Position in 3D space as seen from the current handle camera.
text Text to display on the label.
image Texture to display on the label.
content Text, image and tooltip for this label.
style The style to use. If left out, the label style from the current GUISkin is used.

Note: Use HandleUtility.GetHandleSize where you might want to have constant screen-sized handles.

Description

Make a text label positioned in 3D space.

Labels have no user interaction, do not catch mouse clicks and are always rendered in normal style.


Label 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

@CustomEditor (DummyLabelScript) class LabelHandle extends Editor { function OnSceneGUI () { Handles.color = Color.blue; Handles.Label(target.transform.position + Vector3.up*2, target.transform.position.ToString() + "\nShieldArea: " + target.shieldArea.ToString()); Handles.BeginGUI(Rect(Screen.width - 100, Screen.height - 80, 90,50));

Handles.DrawWireArc(target.transform.position, target.transform.up, -target.transform.right, 180, target.shieldArea); target.shieldArea = Handles.ScaleValueHandle(target.shieldArea, target.transform.position + target.transform.forward*target.shieldArea, target.transform.rotation, 1, Handles.ConeCap, 1); } }

And the script attached to this Handle:

    // DummyLavelScript.js

var shieldArea : float = 5;

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