framescrollbar
A object version of the uiz_drawscrollbar_horizontal/vertical script which has been specially made for scrolling frames. Frame object already have scrollbars built in. However, if that is not flexible enough for you and you want to put the scrollbar in another position, you can use this object.
This is a very plug and play object, you can just put it in a good position, and then just refer it to a frame.
- scrollbarsprite[spr_uiZ_scrollbar]: which sprite to use. The sprite should follow a few rules, listed 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 streched/tiled. You can choose the constants: uiz_texturemode_fill, uiz_texturemode_fill_edgeless, uiz_texturemode_tile, uiz_texturemode_tilefit.
- scrollspeed[70]: how many scrolllines the middle mouse scrollwheel and/or the buttons should scroll every time you interact with them.
- horizontal[false]: whether to make the frame scroll horizontally (true) or vertically (false).
- scrollbarAnimation[uiz_smoothstep]: what animation should be used to animate the scrollbar (and the frame movement). Animations take place when using the scrollwheel or when clicking on an empty space in the scrollbar.
- scrollbarAnimationTime[0.3]: How long an animation on the scrollbar should take in seconds.
- scroll: how far scrolled down the bar has. (a value between 0 and the amount of available pixels to scroll in the frame). You don't have to use "uiz_drawscrollbar_getValue".
-
uiz_framescrollbar_settings(instanceid,scrollbarsprite,scrollbarcolor,scrollbacktexturemode,scrollspeed): set the look and feel of the scrollbar.
- instanceid: the instance id of the instance you want to modify
- scrollbarsprite[spr_uiZ_scrollbar]: which sprite to use. The sprite should follow a few rules, listed 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 streched/tiled. You can choose the constants: uiz_texturemode_fill, uiz_texturemode_fill_edgeless, uiz_texturemode_tile, uiz_texturemode_tilefit.
- scrollspeed[70]: how many scrolllines the middle mouse scrollwheel and/or the buttons should scroll every time you interact with them.
-
uiz_framescrollbar_setframe(instanceid,frame id): Set what frame this scrollbar should control.
- instanceid: the instance id of the instance you want to modify
- frame id[noone]: The id of the frame to be controlled by this scrollbar.
-
uiz_framescrollbar_setAnimation(instanceid,scrollbarAnimation,scrollbarAnimationTime)
- instanceid: the instance id of the instance you want to modify
- scrollbarAnimation[uiz_smoothstep]: what animation should be used to animate the scrollbar (and the frame movement). Animations take place when using the scrollwheel or when clicking on an empty space in the scrollbar.
- scrollbarAnimationTime[0.3]: How long an animation on the scrollbar should take in seconds.
A valid scrollbar sprite holds the following images:
- A button down sprite that also acts as a right button on horizontal scrollbars.
- The same as 0, but then when the mouse hovers over it.
- The same as 0, but then when the mouse clicks it.
- A button up sprite that also acts as a left button on horizontal scrollbars.
- The same as 3, but then when the mouse hovers over it.
- The same as 3, but then when the mouse clicks it.
- The top/left part of a scrollbar.
- The same as 6, but then when the mouse hovers over it.
- The same as 6, but then when the mouse clicks it.
- The bottom/right part of a scrollbar.
- The same as 9, but then when the mouse hovers over it.
- The same as 9, but then when the mouse clicks it.
- The middle part of a vertical scrollbar.
- The same as 12, but then when the mouse hovers over it.
- The same as 12, but then when the mouse clicks it.
- A sprite to put on the middle of the scrollbar.
- A background sprite for behind the scrollbar.
- The middle part of a horizontal scrollbar.
- The same as 17, but then when the mouse hovers over it.
- The same as 17, but then when the mouse clicks it.
Note: you can use spr_uiZ_scrollbar as a reference.
