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

Script language

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

GUILayout.RepeatButton

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 RepeatButton(image: Texture, params options: GUILayoutOption[]): bool;
public static bool RepeatButton(Texture image, params GUILayoutOption[] options);
public static function RepeatButton(text: string, params options: GUILayoutOption[]): bool;
public static bool RepeatButton(string text, params GUILayoutOption[] options);
public static function RepeatButton(content: GUIContent, params options: GUILayoutOption[]): bool;
public static bool RepeatButton(GUIContent content, params GUILayoutOption[] options);
public static function RepeatButton(image: Texture, style: GUIStyle, params options: GUILayoutOption[]): bool;
public static bool RepeatButton(Texture image, GUIStyle style, params GUILayoutOption[] options);
public static function RepeatButton(text: string, style: GUIStyle, params options: GUILayoutOption[]): bool;
public static bool RepeatButton(string text, GUIStyle style, params GUILayoutOption[] options);
public static function RepeatButton(content: GUIContent, style: GUIStyle, params options: GUILayoutOption[]): bool;
public static bool RepeatButton(GUIContent content, GUIStyle style, params GUILayoutOption[] options);

Parameters

text Text to display on the button.
image Texture to display on the button.
content Text, image and tooltip for this button.
style The style to use. If left out, the button style from the current GUISkin is used.
options An optional list of layout options that specify extra layouting properties. Any values passed in here will override settings defined by the style.
See Also: GUILayout.Width, GUILayout.Height, GUILayout.MinWidth, GUILayout.MaxWidth, GUILayout.MinHeight, GUILayout.MaxHeight, GUILayout.ExpandWidth, GUILayout.ExpandHeight.

Returns

bool true when the holds down the mouse.

Description

Make a repeating button. The button returns true as long as the user holds down the mouse.


Repeat Buttons in the Game View.

    // Draws a button with an image and a button with text
    var tex : Texture;
    function OnGUI() {
        if(!tex) {
            Debug.LogError("No texture found, please assign a texture on the inspector");
        }

if(GUILayout.RepeatButton (tex)) { Debug.Log("Clicked the image"); } if(GUILayout.RepeatButton ("I am a regular Automatic Layout Button")) { Debug.Log("Clicked Button"); } }
using UnityEngine;
using System.Collections;

public class ExampleClass : MonoBehaviour { public Texture tex; void OnGUI() { if (!tex) Debug.LogError("No texture found, please assign a texture on the inspector"); if (GUILayout.RepeatButton(tex)) Debug.Log("Clicked the image"); if (GUILayout.RepeatButton("I am a regular Automatic Layout Button")) Debug.Log("Clicked Button"); } }