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

Script language

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

GUI.Button

Other Versions
Leave feedback
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 Button(position: Rect, text: string): bool;
public static bool Button(Rect position, string text);
public static method Button(position: Rect, image: Texture): bool;
public static bool Button(Rect position, Texture image);
public static method Button(position: Rect, content: GUIContent): bool;
public static bool Button(Rect position, GUIContent content);
public static method Button(position: Rect, text: string, style: GUIStyle): bool;
public static bool Button(Rect position, string text, GUIStyle style);
public static method Button(position: Rect, image: Texture, style: GUIStyle): bool;
public static bool Button(Rect position, Texture image, GUIStyle style);
public static method Button(position: Rect, content: GUIContent, style: GUIStyle): bool;
public static bool Button(Rect position, GUIContent content, GUIStyle style);

Parameters

positionRectangle on the screen to use for the button.
textText to display on the button.
image Texture to display on the button.
contentText, image and tooltip for this button.
styleThe style to use. If left out, the button style from the current GUISkin is used.

Returns

bool true when the users clicks the button.

Description

Make a single press button. The user clicks them and something happens immediately.

no example available in JavaScript
// Draws 2 buttons, one with an image, and other with a text
// And print a message when they got clicked.

using UnityEngine;
using System.Collections;

public class ExampleClass : MonoBehaviour
{
    public Texture btnTexture;

    void OnGUI()
    {
        if (!btnTexture)
        {
            Debug.LogError("Please assign a texture on the inspector");
            return;
        }

        if (GUI.Button(new Rect(10, 10, 50, 50), btnTexture))
            Debug.Log("Clicked the button with an image");

        if (GUI.Button(new Rect(10, 70, 50, 30), "Click"))
            Debug.Log("Clicked the button with text");
    }
}

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

Is something described here not working as you expect it to? It might be a Known Issue. Please check with the Issue Tracker at issuetracker.unity3d.com.

Copyright © 2018 Unity Technologies. Publication: 2018.1-002N. Built: 2018-12-04.
TutorialsCommunity AnswersKnowledge BaseForumsAsset StoreLegalPrivacy PolicyCookiesDo Not Sell or Share My Personal Information