Legacy Documentation: Version 4.6(go to latest)
Language: English
  • C#
  • JS
  • Boo

Script language

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

GUI.HorizontalScrollbar

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

Sumbission failed

For some reason your suggested change could not be submitted. Please try again 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 HorizontalScrollbar(position: Rect, value: float, size: float, leftValue: float, rightValue: float): float;
public static float HorizontalScrollbar(Rect position, float value, float size, float leftValue, float rightValue);
public static def HorizontalScrollbar(position as Rect, value as float, size as float, leftValue as float, rightValue as float) as float
public static function HorizontalScrollbar(position: Rect, value: float, size: float, leftValue: float, rightValue: float, style: GUIStyle): float;
public static float HorizontalScrollbar(Rect position, float value, float size, float leftValue, float rightValue, GUIStyle style);
public static def HorizontalScrollbar(position as Rect, value as float, size as float, leftValue as float, rightValue as float, style as GUIStyle) as float

Parameters

position Rectangle on the screen to use for the scrollbar.
value The position between min and max.
size How much can we see?
leftValue The value at the left end of the scrollbar.
rightValue The value at the right end of the scrollbar.
style The style to use for the scrollbar background. If left out, the horizontalScrollbar style from the current GUISkin is used.

Returns

float The modified value. This can be changed by the user by dragging the scrollbar, or clicking the arrows at the end.

Description

Make a horizontal scrollbar. Scrollbars are what you use to scroll through a document. Most likely, you want to use scrollViews instead.

	var hSbarValue : float;
	
	function OnGUI () {
		hSbarValue = GUI.HorizontalScrollbar (Rect (25, 25, 100, 30), hSbarValue, 1.0, 0.0, 10.0);
	}
using UnityEngine;
using System.Collections;

public class ExampleClass : MonoBehaviour {
    public float hSbarValue;
    void OnGUI() {
        hSbarValue = GUI.HorizontalScrollbar(new Rect(25, 25, 100, 30), hSbarValue, 1.0F, 0.0F, 10.0F);
    }
}
import UnityEngine
import System.Collections

public class ExampleClass(MonoBehaviour):

	public hSbarValue as float

	def OnGUI() as void:
		hSbarValue = GUI.HorizontalScrollbar(Rect(25, 25, 100, 30), hSbarValue, 1.0F, 0.0F, 10.0F)

Finding extra elements:

The styles of the buttons at the end of the scrollbar are searched for in the current skin by adding "leftbutton" and "rightbutton" to the style name. The name of the scrollbar thumb (the thing you drag) is found by appending "thumb" to the style name.

	var scrollPos : float = 0.5;
	// This will use the following style names to determine the size / placement of the buttons
	// MyScrollbarleftbutton    - Name of style used for the left button.
	// MyScrollbarrightbutton - Name of style used for the right button.
	// MyScrollbarthumb         - Name of style used for the draggable thumb.
	function OnGUI() {
		scrollPos = GUI.HorizontalScrollbar(Rect(0,0,100,20), scrollPos, 1, 0, 100, "Scroll");
	}