Version: 2018.2 (switch to 2018.1 or 2017.4)
LanguageEnglish
  • C#

GUILayout.VerticalScrollbar

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 float VerticalScrollbar(float value, float size, float topValue, float bottomValue, params GUILayoutOption[] options);
public static float VerticalScrollbar(float value, float size, float topValue, float bottomValue, GUIStyle style, params GUILayoutOption[] options);

Parameters

valueThe position between min and max.
sizeHow much can we see?
topValueThe value at the top end of the scrollbar.
bottomValueThe value at the bottom end of the scrollbar.
styleThe style to use for the scrollbar background. If left out, the horizontalScrollbar 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.

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 vertical scrollbar.

A scrollbar control returns a float value that represents the position of the draggable "thumb" withtin the bar. You can use the value to adjust another GUI element to reflect the scroll position. However, most scrollable views can be handled more easily using a scroll view control.


Vertical Scrollbar in the Game View.

using UnityEngine;
using System.Collections;

public class ExampleClass : MonoBehaviour { public float vSbarValue; void OnGUI() { vSbarValue = GUILayout.VerticalScrollbar(vSbarValue, 1.0F, 10.0F, 0.0F); } }

The styles of the scroll buttons at the end of the bar can be located in the current skin by adding "upbutton" and "downbutton" to the style name. The name of the scrollbar thumb (the thing you drag) is found by appending "thumb" to the style name.

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