# SUIScrollbar

## Index

### Functions Index

| Function Name                                                 |
| ------------------------------------------------------------- |
| void [**OnValueChanged** ](#onvaluechanged)(Closure callback) |

### Properties Index

| Property Name                                                |
| ------------------------------------------------------------ |
| float [**Size** ](#size)`get` `set`                          |
| float [**Value** ](#value)`get` `set`                        |
| int [**NumberOfSteps** ](#numberofsteps)`get` `set`          |
| SColor [**NormalColor** ](#normalcolor)`get` `set`           |
| SColor [**HighlightedColor** ](#highlightedcolor)`get` `set` |
| SColor [**PressedColor** ](#pressedcolor)`get` `set`         |
| SColor [**DisabledColor** ](#disabledcolor)`get` `set`       |
| float [**ColorMultiplier** ](#colormultiplier)`get` `set`    |
| SGameObject [**GameObject** ](#gameobject)`get`              |

### OnValueChanged

void **OnValueChanged** (Closure callback)

*Handling for when the scrollbar value is changed.*

| Parameter | Type | Description |
| --------- | ---- | ----------- |
|           |      |             |

{% tabs %}
{% tab title="Lua" %}

```lua
function OCV()
--
end
Space.Host.ExecutingObject.UIScrollbar.OnValueChanged(OCV)
```

{% endtab %}
{% endtabs %}

## Properties

### Size

float **Size** `get` `set`

*The size of the scrollbar handle where 1 means it fills the entire scrollbar.*

{% tabs %}
{% tab title="Lua" %}

```lua
Space.Host.ExecutingObject.UIScrollbar.Size = 0.1
```

{% endtab %}
{% endtabs %}

### Value

float **Value** `get` `set`

*The current value of the scrollbar, between 0 and 1.*

{% tabs %}
{% tab title="Lua" %}

```lua
Space.Host.ExecutingObject.UIScrollbar.Value = 0.5
```

{% endtab %}
{% endtabs %}

### NumberOfSteps

int **NumberOfSteps** `get` `set`

*Property Description*

{% tabs %}
{% tab title="Lua" %}

```lua
Space.Host.ExecutingObject.UIScrollbar.NumberOfSteps = 2
```

{% endtab %}
{% endtabs %}

### NormalColor

[SColor](https://docs.breakroom.tech/scripting/client-scripting-api-reference/types/scolor) **NormalColor** `get` `set`

*Property Description*

{% tabs %}
{% tab title="Lua" %}

```lua
Space.Host.ExecutingObject.UIScrollbar.NormalColor = Color.Red
```

{% endtab %}
{% endtabs %}

### HighlightedColor

[SColor](https://docs.breakroom.tech/scripting/client-scripting-api-reference/types/scolor) **HighlightedColor** `get` `set`

*Property Description*

{% tabs %}
{% tab title="Lua" %}

```lua
Space.Host.ExecutingObject.UIScrollbar.HighlightedColor = Color.Red
```

{% endtab %}
{% endtabs %}

### PressedColor

[SColor](https://docs.breakroom.tech/scripting/client-scripting-api-reference/types/scolor) **PressedColor** `get` `set`

*Property Description*

{% tabs %}
{% tab title="Lua" %}

```lua
Space.Host.ExecutingObject.UIScrollbar.PressedColor = Color.Red
```

{% endtab %}
{% endtabs %}

### DisabledColor

[SColor](https://docs.breakroom.tech/scripting/client-scripting-api-reference/types/scolor) **DisabledColor** `get` `set`

*Property Description*

{% tabs %}
{% tab title="Lua" %}

```lua
Space.Host.ExecutingObject.UIScrollbar.DisabledColor = Color.Red
```

{% endtab %}
{% endtabs %}

### ColorMultiplier

float **ColorMultiplier** `get` `set`

*Property Description*

{% tabs %}
{% tab title="Lua" %}

```lua
Space.Host.ExecutingObject.UIScrollbar.ColorMultiplier = Color.Red
```

{% endtab %}
{% endtabs %}

### GameObject

[SGameObject](https://docs.breakroom.tech/scripting/client-scripting-api-reference/types/sgameobject) **GameObject** `get`

*Property Description*

{% tabs %}
{% tab title="Lua" %}

```lua
theGameObject = Space.Host.ExecutingObject.UIScrollbar.GameObject
```

{% endtab %}
{% endtabs %}