# obj_uiZ_scrollbar

An object version of the uiz_drawscrollbar_horizontal/vertical script.

## Settings

* **scrollbarsprite[spr_uiZ_scrollbar]:** which sprite to use. The sprite should follow a few rules, listen further down in this page.
* **scrollbarcolor[c_white]:** which color blend the sprite should get.(may not apply to all parts)
* **scrollbacktexturemode[uiz_texturemode_fill]: How sprites should be stretched/tiled. You can choose the constants:** uiz_texturemode_fill, uiz_texturemode_fill_edgeless, uiz_texturemode_tile, uiz_texturemode_tilefit.
* **scrolllines[100]: How many steps the scrollbar has. If you're drawing out a list, then this would be:**  "(your list size)-(how many list items fit in view without scrolling)"
* **scrollspeed[1]:** how many scrolllines the middle mouse scroll wheel and/or the buttons should scroll every time you interact with them.

## Readable variables

* **scroll:** how far the bar has scrolled down. (a value between 0 and the amount of scrolllines). You don't have to use "uiz_drawscrollbar_getValue".

## Functions

* **uiz_scrollbar_settings(instanceid,sprite[spr_uiZ_scrollbar],color[c_white],backtexturemode[uiz_texturemode_fill],scrollspeed[1]):**
  * **instanceid:** the instance id of the instance you want to modify
  * **sprite:** which sprite to use. The sprite should follow a few rules, listen further down in this page.
  * **color:** which color blend the sprite should get.(may not apply to all parts)
  * **backtexturemode: How sprites should be stretched/tiled. You can choose the constants:** uiz_texturemode_fill, uiz_texturemode_fill_edgeless, uiz_texturemode_tile, uiz_texturemode_tilefit.
  * **scrollspeed:** how many scrolllines the middle mouse scroll wheel and/or the buttons should scroll every time you interact with them.
* **uiz_scrollbar_setlines(instanceid,lines[100]):**
  * **instanceid:** the instance id of the instance you want to modify
  * **lines: How many steps the scrollbar has. If you're drawing out a list, then this would be:**  "(your list size)-(how many list items fit in view without scrolling)"
* **scroll = uiz_scrollbar_getscroll(instanceid):**
  * **instanceid:** the instance id of the instance you want to modify
  * **scroll:** how far the bar has scrolled down. (a value between 0 and the amount of scrolllines). You don't have to use "uiz_drawscrollbar_getValue".

## Sprite requirements

A valid scrollbar sprite holds the following images:<br>

0. A button down sprite that also acts as a right button on horizontal scrollbars.
1. The same as 0, but then when the mouse hovers over it.
2. The same as 0, but then when the mouse clicks it.
3. A button up sprite that also acts as a left button on horizontal scrollbars.
4. The same as 3, but then when the mouse hovers over it.
5. The same as 3, but then when the mouse clicks it.
6. The top/left part of a scrollbar.
7. The same as 6, but then when the mouse hovers over it.
8. The same as 6, but then when the mouse clicks it.
9. The bottom/right part of a scrollbar.
10. The same as 9, but then when the mouse hovers over it.
11. The same as 9, but then when the mouse clicks it.
12. The middle part of a vertical scrollbar.
13. The same as 12, but then when the mouse hovers over it.
14. The same as 12, but then when the mouse clicks it.
15. A sprite to put on the middle of the scrollbar.
16. A background sprite for behind the scrollbar.
17. The middle part of a horizontal scrollbar.
18. The same as 17, but then when the mouse hovers over it.
19. The same as 17, but then when the mouse clicks it.

Note: you can use spr_uiZ_scrollbar as a reference.

## Visuals

<img src="objects/scrollbar.png">