Legacy Documentation: Version 4.5.0

Script language:

  • JS
  • C#
  • Boo
Script language

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

GUILayout.RepeatButton

static function RepeatButton(image: Texture, params options: GUILayoutOption[]): bool;
static bool RepeatButton(Texture image, params GUILayoutOption[] options);
static def RepeatButton(image as Texture, *options as GUILayoutOption[]) as bool
static function RepeatButton(text: string, params options: GUILayoutOption[]): bool;
static bool RepeatButton(string text, params GUILayoutOption[] options);
static def RepeatButton(text as string, *options as GUILayoutOption[]) as bool
static function RepeatButton(content: GUIContent, params options: GUILayoutOption[]): bool;
static bool RepeatButton(GUIContent content, params GUILayoutOption[] options);
static def RepeatButton(content as GUIContent, *options as GUILayoutOption[]) as bool
static function RepeatButton(image: Texture, style: GUIStyle, params options: GUILayoutOption[]): bool;
static bool RepeatButton(Texture image, GUIStyle style, params GUILayoutOption[] options);
static def RepeatButton(image as Texture, style as GUIStyle, *options as GUILayoutOption[]) as bool
static function RepeatButton(text: string, style: GUIStyle, params options: GUILayoutOption[]): bool;
static bool RepeatButton(string text, GUIStyle style, params GUILayoutOption[] options);
static def RepeatButton(text as string, style as GUIStyle, *options as GUILayoutOption[]) as bool
static function RepeatButton(content: GUIContent, style: GUIStyle, params options: GUILayoutOption[]): bool;
static bool RepeatButton(GUIContent content, GUIStyle style, params GUILayoutOption[] options);
static def RepeatButton(content as GUIContent, style as GUIStyle, *options as GUILayoutOption[]) as bool

Parameters

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.
optionsAn 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");
        
    }
}
import UnityEngine
import System.Collections

public class ExampleClass(MonoBehaviour):

	public tex as Texture

	def OnGUI() as void:
		if not 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')