Documentation

Unity Engine


User Manual

Script Reference

Unity Engine


Button

Make a single press button. The user clicks them and something happens immediately.
Read time 5 minutesLast updated 6 days ago

Definition

  • Type: Method
  • Namespace: UnityEngine
  • Assembly: UnityEngine.IMGUIModule

Button(Rect, string)

Make a single press button. The user clicks them and something happens immediately.
public static bool Button(Rect position, string text)

Parameters

position

Rectangle on the screen to use for the button.

text

Text to display on the button.

Returns

Type

Description

booltrue when the users clicks the button.

Examples

// 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"); }}

Button(Rect, Texture)

Make a single press button. The user clicks them and something happens immediately.
public static bool Button(Rect position, Texture image)

Parameters

position

Rectangle on the screen to use for the button.

image

Texture to display on the button.

Returns

Type

Description

booltrue when the users clicks the button.

Examples

// 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"); }}

Button(Rect, GUIContent)

Make a single press button. The user clicks them and something happens immediately.
public static bool Button(Rect position, GUIContent content)

Parameters

position

Rectangle on the screen to use for the button.

content

Text, image and tooltip for this button.

Returns

Type

Description

booltrue when the users clicks the button.

Examples

// 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"); }}

Button(Rect, string, GUIStyle)

Make a single press button. The user clicks them and something happens immediately.
public static bool Button(Rect position, string text, GUIStyle style)

Parameters

position

Rectangle on the screen to use for the button.

text

Text to display on the button.

The style to use. If left out, the
button
style from the current GUISkin is used.

Returns

Type

Description

booltrue when the users clicks the button.

Examples

// 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"); }}

Button(Rect, Texture, GUIStyle)

Make a single press button. The user clicks them and something happens immediately.
public static bool Button(Rect position, Texture image, GUIStyle style)

Parameters

position

Rectangle on the screen to use for the button.

image

Texture to display on the button.

The style to use. If left out, the
button
style from the current GUISkin is used.

Returns

Type

Description

booltrue when the users clicks the button.

Examples

// 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"); }}

Button(Rect, GUIContent, GUIStyle)

Make a single press button. The user clicks them and something happens immediately.
public static bool Button(Rect position, GUIContent content, GUIStyle style)

Parameters

position

Rectangle on the screen to use for the button.

content

Text, image and tooltip for this button.

The style to use. If left out, the
button
style from the current GUISkin is used.

Returns

Type

Description

booltrue when the users clicks the button.

Examples

// 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"); }}