DgsCreateScrollBar: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
No edit summary
 
(3 intermediate revisions by the same user not shown)
Line 5: Line 5:
==Syntax==  
==Syntax==  
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
element dgsCreateScrollBar( float x, float y,float width, float height, bool horizontal, bool relative [,element parent = nil, element arrowImage = nil, element bgImage= nil, element cursorImage= nil, int colorArrowDef = 0xFFF0F0F0, int bgColorDef = 0xFFF0F0F0,int cursorColorDef = 0xFFC0C0C0,int colorArrowHov = 0xFFDADADA , int cursorColorHov = 0xFFA6A6A6, int colorArrowCli = 0xFFB4B4B4, int colorCursorCli = 0xFF606060] )
element dgsCreateScrollBar( float x, float y, float width, float height, bool isHorizontal, bool relative [, element parent = nil, element arrowImage = nil, element troughImage = nil, element cursorImage = nil, int normalArrowColor = 0xAARRGGBB , int hoveringArrowColor = 0xAARRGGBB, int clickedArrowColor = 0xAARRGGBB, int troughColor = 0xAARRGGBB, int normalCursorColor = 0xAARRGGBB, int hoveringCursorColor = 0xAARRGGBB, int clickedCursorColor = 0xAARRGGBB ] )
</syntaxhighlight>
</syntaxhighlight>


Line 13: Line 13:
*'''width:''' A float of the width of the DGS scroll bar. This is affected by the ''relative'' argument.
*'''width:''' A float of the width of the DGS scroll bar. This is affected by the ''relative'' argument.
*'''height:''' A float of the height of the DGS scroll bar. This is affected by the ''relative'' argument. Note: height must be enough to fit the drop down menu, else the drop down won't appear.
*'''height:''' A float of the height of the DGS scroll bar. This is affected by the ''relative'' argument. Note: height must be enough to fit the drop down menu, else the drop down won't appear.
*'''horizontal:''' whether this scroll bar is horizontal (''true'') or vertical (''false'').
*'''isHorizontal:''' whether this scroll bar is horizontal (''true'') or vertical (''false'').
*'''relative:''' This is whether sizes and positioning are relative.  If this is ''true'', then all x,y,width,height floats must be between 0 and 1, representing sizes relative to the parent.
*'''relative:''' This is whether sizes and positioning are relative.  If this is ''true'', then all x,y,width,height floats must be between 0 and 1, representing sizes relative to the parent.


Line 19: Line 19:
*'''parent:''' This is the parent that the DGS scroll bar is attached to.  If the ''relative'' argument is true, sizes and positioning will be made relative to this parent. If the ''relative'' argument is false, positioning will be the number of offset pixels from the parent's origin. If no parent is passed, the parent will become the screen - causing positioning and sizing according to screen positioning.
*'''parent:''' This is the parent that the DGS scroll bar is attached to.  If the ''relative'' argument is true, sizes and positioning will be made relative to this parent. If the ''relative'' argument is false, positioning will be the number of offset pixels from the parent's origin. If no parent is passed, the parent will become the screen - causing positioning and sizing according to screen positioning.
*'''arrowImage:''' A texture element of the background of the arrow of the scroll bar.
*'''arrowImage:''' A texture element of the background of the arrow of the scroll bar.
*'''bgImage:''' A texture element of the background of the track of the scroll bar.
*'''troughImage:''' A texture element of the background of the trough of the scroll bar.
*'''cursorImage:''' A texture element of the background of the cursor(face) of the scroll bar.
*'''cursorImage:''' A texture element of the background of the cursor of the scroll bar.
*'''colorArrowDef:''' An int of the color of the background of the arrow of the scroll bar ( not hovering on or clicked ).
*'''normalArrowColor:''' An int of the color of the background of the arrow of the scroll bar ( not hovering on or clicked ).
*'''bgColorDef:''' An int of the color of the background of the track of the scroll bar.
*'''hoveringArrowColor:''' An int of the color of the background of the arrow of the scroll bar ( hovering on ).
*'''cursorColorDef:''' An int of the color of the background of the cursor(face) of the scroll bar ( not hovering on or clicked ).
*'''clickedArrowColor:''' An int of the color of the background of the arrow of the scroll bar ( clicked ).
*'''colorArrowHov:''' An int of the color of the background of the arrow of the scroll bar ( hovering on ).
*'''troughColor:''' An int of the color of the background of the trough of the scroll bar.
*'''cursorColorHov :''' An int of the color of the background of the cursor(face) of the scroll bar ( hovering on ).
*'''normalCursorColor:''' An int of the color of the background of the cursor of the scroll bar ( not hovering on or clicked ).
*'''colorArrowCli:''' An int of the color of the background of the arrow of the scroll bar ( clicked ).
*'''hoveringCursorColor:''' An int of the color of the background of the cursor of the scroll bar ( hovering on ).
*'''colorCursorCli :''' An int of the color of the background of the cursor(face) of the scroll bar ( clicked ).
*'''clickedCursorColor:''' An int of the color of the background of the cursor of the scroll bar ( clicked ).


==Example==
==Example==
Line 36: Line 36:
local scrollBar = DGS:dgsCreateScrollBar(0.29, 0.30, 0.44, 0.04, true, true)
local scrollBar = DGS:dgsCreateScrollBar(0.29, 0.30, 0.44, 0.04, true, true)
showCursor(true)  
showCursor(true)  
addEventHandler("onDgsElementScroll", scrollBar, function(scb,new,old)
outputChatBox("The new scroll position is "..new.." ( was:"..old.." )")
end,false)
end)
end)
</syntaxhighlight>
</syntaxhighlight>

Latest revision as of 06:17, 29 January 2022

This function allows creation of a DGS Scroll Bar.

Syntax

element dgsCreateScrollBar( float x, float y, float width, float height, bool isHorizontal, bool relative [, element parent = nil, element arrowImage = nil, element troughImage = nil, element cursorImage = nil, int normalArrowColor = 0xAARRGGBB , int hoveringArrowColor = 0xAARRGGBB, int clickedArrowColor = 0xAARRGGBB, int troughColor = 0xAARRGGBB, int normalCursorColor = 0xAARRGGBB, int hoveringCursorColor = 0xAARRGGBB, int clickedCursorColor = 0xAARRGGBB ] )

Required Arguments

  • x: A float of the 2D x position of the DGS scroll bar on a player's screen. This is affected by the relative argument.
  • y: A float of the 2D y position of the DGS scroll bar on a player's screen. This is affected by the relative argument.
  • width: A float of the width of the DGS scroll bar. This is affected by the relative argument.
  • height: A float of the height of the DGS scroll bar. This is affected by the relative argument. Note: height must be enough to fit the drop down menu, else the drop down won't appear.
  • isHorizontal: whether this scroll bar is horizontal (true) or vertical (false).
  • relative: This is whether sizes and positioning are relative. If this is true, then all x,y,width,height floats must be between 0 and 1, representing sizes relative to the parent.

Optional Arguments

  • parent: This is the parent that the DGS scroll bar is attached to. If the relative argument is true, sizes and positioning will be made relative to this parent. If the relative argument is false, positioning will be the number of offset pixels from the parent's origin. If no parent is passed, the parent will become the screen - causing positioning and sizing according to screen positioning.
  • arrowImage: A texture element of the background of the arrow of the scroll bar.
  • troughImage: A texture element of the background of the trough of the scroll bar.
  • cursorImage: A texture element of the background of the cursor of the scroll bar.
  • normalArrowColor: An int of the color of the background of the arrow of the scroll bar ( not hovering on or clicked ).
  • hoveringArrowColor: An int of the color of the background of the arrow of the scroll bar ( hovering on ).
  • clickedArrowColor: An int of the color of the background of the arrow of the scroll bar ( clicked ).
  • troughColor: An int of the color of the background of the trough of the scroll bar.
  • normalCursorColor: An int of the color of the background of the cursor of the scroll bar ( not hovering on or clicked ).
  • hoveringCursorColor: An int of the color of the background of the cursor of the scroll bar ( hovering on ).
  • clickedCursorColor: An int of the color of the background of the cursor of the scroll bar ( clicked ).

Example

This example creates a scroll bar on the screen. 

DGS = exports.dgs 
addEventHandler("onClientResourceStart", resourceRoot, function()
	local scrollBar = DGS:dgsCreateScrollBar(0.29, 0.30, 0.44, 0.04, true, true)
	showCursor(true) 
	addEventHandler("onDgsElementScroll", scrollBar, function(scb,new,old)
		outputChatBox("The new scroll position is "..new.." ( was:"..old.." )")
	end,false)
end)

See Also

Custom Cursor Functions

Multi Language Supports

Animation

3D Element

3D Interface

3D Line

3D Image

3D Text

Browser

Button

Check Box

Combo Box

Custom Renderer

Edit

Detect Area

Drag'N Drop

Grid List

Image

Memo

Menu

Label

Layout

Line

Progress Bar

Radio Button

Scale Pane

Scroll Bar

Scroll Pane

Selector

Style

Switch Button

Tab Panel

Window

Basic Shape Plugins

Circle

Quadrilateral

Rounded Rectangle

Other Plugins

Blur Box

Canvas

Chart

Color Picker

Effect 3D

Gradient

Mask

Media Browser

Nine Slice

Object Preview Supports

Paste Handler

QRCode

Remote Image

Screen Source

SVG

Tooltips

Retrieved from "https://wiki.multitheftauto.com/wiki/DgsCreateScrollBar?oldid=73860"