Multi Theft Auto: Wiki - User contributions [en]

DgsMediaLoadMedia

2025-08-24T05:53:27Z

Thisdp: /* Required Arguments */

__NOTOC__
{{Client function}}
This function is for loading Video/Audio/Image to a Media Browser ([[dgsCreateMediaBrowser]]) element.

Available Media Format:

Video: webm

Audio: ogg

Image: png/gif/jpg ...

==Syntax==
<syntaxhighlight lang="lua">
element dgsMediaLoadMedia ( element media, string path, string theType )
</syntaxhighlight>

===Required Arguments===
*'''media:''' The element media that you want to load the media into it.
*'''path:''' Path to the media file that you want to load.
*'''theType:''' Type of the media file you want to load, available values are:
**'''audio:''' Audio path.
**'''video:''' Video path.
**'''image:''' Image path.
**'''imagedata:''' Image raw data.

===Returns===
Returns true if media loaded, false otherwise.

==Example==
This example loads a local gif image
<syntaxhighlight lang="lua">
loadstring(exports.dgs:dgsImportFunction())() --Import DGS functions
browser = dgsCreateMediaBrowser(256,256) --Create Multi Media Browser
dgsMediaLoadMedia(browser,"test.gif","IMAGE") --Load the gif file into multi media browser
image = dgsCreateImage(200,200,200,200,browser,false) --Apply the browser to a dgs-dximage
</syntaxhighlight>

==See Also==
{{DGSFUNCTIONS}}

DgsCreateGIF

2025-08-23T10:28:00Z

Thisdp:

__NOTOC__
{{Client function}}

This function creates a GIF interface plugin.

==Syntax==
<syntaxhighlight lang="lua">
element dgsCreateGIF( string pathOrRaw )
</syntaxhighlight>

===Required Arguments===
*'''pathOrRaw: ''' A string representing the path to your GIF file, or the raw GIF data

===Returns===
Returns a dgs-dxgif element (DGS Plugin Type)[ dgs-dxgif (Element Type) ] if succeed, ''false'' otherwise

==Example==
<syntaxhighlight lang="lua">
DGS = exports.dgs --get exported functions from dgs

local gif = DGS:dgsCreateGIF("test.gif")
DGS:dgsGIFPlay(gif,1) --Play GIF with Speed 1x
image = DGS:dgsCreateImage(500,500,200,200,gif,false)

</syntaxhighlight>

==See Also==
{{DGS_Plugin/Gif}}

DgsCreateGIF

2025-08-23T10:27:29Z

Thisdp: Created page with "__NOTOC__ {{Client function}} This function creates a GIF interface plugin. ==Syntax== <syntaxhighlight lang="lua"> element dgsCreateGIF( string pathOrRaw ) </syntaxhighlight> ===Required Arguments=== *'''pathOrRaw: ''' A string representing the path to your GIF file, or the raw GIF data ===Returns=== Returns a dgs-dxgif element (DGS Plugin Type)[ dgs-dxgif (Element Type) ] if succeed, ''false'' otherwise ==Example== <syntaxhighlight lang="lua"> DGS = exports.dg..."

Template:DGS Plugin/Gif

2025-08-23T10:23:08Z

Thisdp: Created page with "*dgsCreateGIF *dgsGIFGetSize *dgsGIFGetImageCount *dgsGIFGetImages *dgsGIFPlay *dgsGIFStop *dgsGIFSetSpeed *dgsGIFGetSpeed *dgsGIFGetPlaying *dgsGIFSetLooped *dgsGIFGetLooped *dgsGIFSetFrameID *dgsGIFGetFrameID"

*[[dgsCreateGIF]]
*[[dgsGIFGetSize]]
*[[dgsGIFGetImageCount]]
*[[dgsGIFGetImages]]
*[[dgsGIFPlay]]
*[[dgsGIFStop]]
*[[dgsGIFSetSpeed]]
*[[dgsGIFGetSpeed]]
*[[dgsGIFGetPlaying]]
*[[dgsGIFSetLooped]]
*[[dgsGIFGetLooped]]
*[[dgsGIFSetFrameID]]
*[[dgsGIFGetFrameID]]

Template:DGSFUNCTIONS

2025-08-23T10:21:17Z

Thisdp: /* Other Plugins */

__NOTOC__
{{DGS General Functions}}

==Custom Cursor Functions==
{{DGS Custom Cursor Functions}}

==[[DGS_Multilingual|Multi Language Supports]]==
{{DGS Multi Language Supports Functions}}

==Animation==
{{DGS Animation Functions}}

==3D Element==
{{DGS 3D Element Functions}}

==3D Interface==
{{DGS 3D Interface Functions}}

==3D Line==
{{DGS 3D Line Functions}}

==3D Image==
{{DGS 3D Image Functions}}

==3D Text==
{{DGS 3D Text Functions}}

==Browser==
{{DGS Browser Functions}}

==Button==
{{DGS Button Functions}}

==Check Box==
{{DGS Check Box Functions}}

==Combo Box==
{{DGS Combo Box Functions}}

==Custom Renderer==
{{Template:DGS Custom Renderer Functions}}

==Edit==
{{DGS Edit Functions}}

==Detect Area==
{{DGS Detect Area Functions}}

==Drag'N Drop==
{{DGS Drag'N Drop Functions}}

==Grid List==
{{DGS GridList Functions}}

==Image==
{{DGS Image Functions}}

==Memo==
{{DGS Memo Functions}}

==Menu==
{{DGS Menu Functions}}

==Label==
{{DGS Label Functions}}

==Layout==
{{DGS Layout Functions}}

==Line==
{{DGS Line Functions}}

==Progress Bar==
{{DGS Progress Bar Functions}}

==Radio Button==
{{DGS Radio Button Functions}}

==Scale Pane==
{{DGS Scale Pane Functions}}

==Scroll Bar==
{{DGS Scroll Bar Functions}}

==Scroll Pane==
{{DGS Scroll Pane Functions}}

==Selector==
{{DGS Selector Functions}}

==Style==
{{DGS Style Functions}}

==Switch Button==
{{DGS Switch Button Functions}}

==Tab Panel==
{{DGS Tab Panel Functions}}

==Window==
{{DGS Window Functions}}

==Basic Shape Plugins==

===Circle===
{{DGS Plugin/Circle}}

===Quadrilateral===
{{DGS Plugin/Quadrilateral Functions}}

===Rounded Rectangle===
{{DGS Plugin/Rounded Rectangle Functions}}

==Other Plugins==

===Blur Box===
{{DGS Plugin/Blur Box}}

===Canvas===
{{DGS Plugin/Canvas}}

===Chart===
{{DGS Plugin/Chart}}

===Color Picker===
{{DGS Plugin/Color Picker}}

===Effect 3D===
{{DGS Plugin/Effect 3D}}

===GIF===
{{DGS Plugin/Gif}}

===Gradient===
{{DGS Plugin/Gradient}}

===Mask===
{{DGS Plugin/Mask}}

===Media Browser===
{{DGS Plugin/Media Browser}}

===Nine Slice===
{{DGS Plugin/Nine Slice}}

===Object Preview Supports===
{{DGS Plugin/Object Preview Functions}}

===Paste Handler===
{{DGS Plugin/Paste Handler Functions}}

===QRCode===
{{DGS Plugin/QRCode Functions}}

===Remote Image===
{{DGS Plugin/Remote Image Functions}}

===Screen Source===
{{DGS Plugin/Screen Source Functions}}

===SVG===
{{DGS Plugin/SVG}}

===Tooltips===
{{DGS Plugin/Tooltips}}

Dgs-dxprogressbar

2025-08-21T05:10:47Z

Thisdp: /* progress */

[[Dgs|DGS]] Properties is always used to change the gui style and make it more fantastic.

This page shows the properties of dgs-dxlabel that you could use.

==Main Functions==
*[[dgsSetProperty]]
*[[dgsGetProperty]]

==Properties==
===bgColor===
This property determines the background color of the progress bar.
<syntaxhighlight lang="lua">dgsSetProperty(progressbar,"bgColor",bgColor)</syntaxhighlight>
*'''bgColor''' : An integer of the color that can be converted by [[tocolor]].

===bgImage===
This property determines the background image of the progress bar.
<syntaxhighlight lang="lua">dgsSetProperty(progressbar,"bgImage",bgImage)</syntaxhighlight>
*'''bgImage''' : A material element that serves as the background image of the progress bar (texture/shader/screen source/renderTarget).

===indicatorColor===
This property determines the indicator color of the progress bar.
<syntaxhighlight lang="lua">dgsSetProperty(progressbar,"indicatorColor",indicatorColor)</syntaxhighlight>
*'''indicatorColor''' : An integer of the color that can be converted by [[tocolor]].

===indicatorImage===
This property determines the indicator image of the progress bar.
<syntaxhighlight lang="lua">dgsSetProperty(progressbar,"indicatorImage",indicatorImage)</syntaxhighlight>
*'''indicatorImage''' : A material element that serves as the indicator image of the progress bar (texture/shader/screen source/renderTarget).

===indicatorMode===
This property determines the indicator mode of the progress bar. See [[dgsProgressBarSetMode]]/[[dgsProgressBarGetMode]].
<syntaxhighlight lang="lua">dgsSetProperty(progressbar,"indicatorMode",indicatorMode)</syntaxhighlight>
*'''indicatorMode''' : A bool indicates if indicator image uses clip mode or stretch mode. (false for stretch, true for clip)

===padding===
This property determines the padding of the progress bar.
<syntaxhighlight lang="lua">dgsSetProperty(progressbar,"padding",{paddingX,paddingY})</syntaxhighlight>
*'''paddingX''' : An integer of 2D x padding value.
*'''paddingY''' : An integer of 2D y padding value.

===progress===
This property stores the progress value of progress bar.
<syntaxhighlight lang="lua">dgsSetProperty(progressbar,"progress",progress)</syntaxhighlight>
*'''progress''' : A float of progress value.

===progressReverse===
This property determines if the progress value is reversed.
<syntaxhighlight lang="lua">dgsSetProperty(progressbar,"progressReverse",progressReverse)</syntaxhighlight>
*'''progressReverse''' : A bool indicates if the progress value is from 0 to 100 or 100 to 0.

===style===
This property stores the style name of progress bar, to change the style use [[dgsProgressBarSetStyle]].
<syntaxhighlight lang="lua">dgsSetProperty(progressbar,"style",style)</syntaxhighlight>
*'''style''' : A string of the style name.

==Style Properties==
===>Style:normal-horizontal<===
None
===>Style:normal-vertical<===
None
===>Style:ring-round<===

====antiAliased====
This style property determines the anti aliasing of the ring.
<syntaxhighlight lang="lua">dgsSetProperty(progressbar,"antiAliased",antiAliased)</syntaxhighlight>
*'''antiAliased:''' A float of the anti aliasing of the ring.

====bgProgress====
This style property determines the progress of the background of the ring.
<syntaxhighlight lang="lua">dgsSetProperty(progressbar,"bgProgress",bgProgress)</syntaxhighlight>
*'''bgProgress:''' A float of the progress of the background of the ring.

====bgRadius====
This style property determines the radius of the background of the ring.
<syntaxhighlight lang="lua">dgsSetProperty(progressbar,"bgRadius",bgRadius)</syntaxhighlight>
*'''bgRadius:''' A float of the radius of the background of the ring.

====bgRotation====
This style property determines the rotation of the background of the ring.
<syntaxhighlight lang="lua">dgsSetProperty(progressbar,"bgRotation",bgRotation)</syntaxhighlight>
*'''bgRotation:''' A float of the rotation of the background of the ring.

====bgThickness====
This style property determines the thickness of the background of the ring.
<syntaxhighlight lang="lua">dgsSetProperty(progressbar,"bgThickness",bgThickness)</syntaxhighlight>
*'''bgThickness:''' A float of the thickness of the background of the ring.

====elements====
This style property stores the custom elements of the progress bar.
<syntaxhighlight lang="lua">dgsSetProperty(progressbar,"elements",elements)</syntaxhighlight>
*'''elements:''' A table of elements. Built-in elements are as follows:
**'''elements.circleShader:''' A shader of ring-round style.

====isClockwise====
This style property determines whether the progress direction is clockwise or anti-clockwise .
<syntaxhighlight lang="lua">dgsSetProperty(progressbar,"isClockwise",isClockwise)</syntaxhighlight>
*'''isClockwise:''' A bool of whether the progress direction is clockwise or anti-clockwise.

====radius====
This style property determines the radius of the ring.
<syntaxhighlight lang="lua">dgsSetProperty(progressbar,"radius",radius)</syntaxhighlight>
*'''radius:''' A float of the radius of the ring.

====rotation====
This style property determines the rotation of the ring.
<syntaxhighlight lang="lua">dgsSetProperty(progressbar,"rotation",rotation)</syntaxhighlight>
*'''rotation:''' A float of the rotation of the ring.

====thickness====
This style property determines the thickness of the ring.
<syntaxhighlight lang="lua">dgsSetProperty(progressbar,"thickness",thickness)</syntaxhighlight>
*'''radius:''' A float of the thickness of the ring.

===>Style:ring-plain<===
====antiAliased====
This style property determines the anti aliasing of the ring.
<syntaxhighlight lang="lua">dgsSetProperty(progressbar,"antiAliased",antiAliased)</syntaxhighlight>
*'''antiAliased:''' A float of the anti aliasing of the ring.

====bgProgress====
This style property determines the progress of the background of the ring.
<syntaxhighlight lang="lua">dgsSetProperty(progressbar,"bgProgress",bgProgress)</syntaxhighlight>
*'''bgProgress:''' A float of the progress of the background of the ring.

====bgRadius====
This style property determines the radius of the background of the ring.
<syntaxhighlight lang="lua">dgsSetProperty(progressbar,"bgRadius",bgRadius)</syntaxhighlight>
*'''bgRadius:''' A float of the radius of the background of the ring.

====bgRotation====
This style property determines the rotation of the background of the ring.
<syntaxhighlight lang="lua">dgsSetProperty(progressbar,"bgRotation",bgRotation)</syntaxhighlight>
*'''bgRotation:''' A float of the rotation of the background of the ring.

====bgThickness====
This style property determines the thickness of the background of the ring.
<syntaxhighlight lang="lua">dgsSetProperty(progressbar,"bgThickness",bgThickness)</syntaxhighlight>
*'''bgThickness:''' A float of the thickness of the background of the ring.

====elements====
This style property stores the custom elements of the progress bar.
<syntaxhighlight lang="lua">dgsSetProperty(progressbar,"elements",elements)</syntaxhighlight>
*'''elements:''' A table of elements. Built-in elements are as follows:
**'''elements.circleShader:''' A shader of ring-round style.

====isClockwise====
This style property determines whether the progress direction is clockwise or anti-clockwise.
<syntaxhighlight lang="lua">dgsSetProperty(progressbar,"isClockwise",isClockwise)</syntaxhighlight>
*'''isClockwise:''' A bool of whether the progress direction is clockwise or anti-clockwise.

====radius====
This style property determines the radius of the ring.
<syntaxhighlight lang="lua">dgsSetProperty(progressbar,"radius",radius)</syntaxhighlight>
*'''radius:''' A float of the radius of the ring.

====rotation====
This style property determines the rotation of the ring.
<syntaxhighlight lang="lua">dgsSetProperty(progressbar,"rotation",rotation)</syntaxhighlight>
*'''rotation:''' A float of the rotation of the ring.

====thickness====
This style property determines the thickness of the ring.
<syntaxhighlight lang="lua">dgsSetProperty(progressbar,"thickness",thickness)</syntaxhighlight>
*'''thickness:''' A float of the thickness of the ring.

==See Also==
{{DGSPROPERTIES}}

DgsSVGNodeSetAttribute

2025-08-21T03:29:12Z

Thisdp: /* Example */

{{Client function}}
__NOTOC__
This function change single node attribute in svg document .
==Syntax==
<syntaxhighlight lang="lua">
bool dgsSVGNodeSetAttribute( xmlnode xmlNode, string attributeName, string value)
</syntaxhighlight>
===Required Arguments===
*'''xmlNode:''' The [[xmlnode]] you want to change their attribute value.
*'''attributeName:''' The attribute name that you want change its value .
*'''value:''' The new value for the attribute.
===Returns===
* Returns [[xmlnode]] if created successfully, ''false'' otherwise.

==Example==
<section name="Client" class="client" show="true">
<syntaxhighlight lang="lua">
loadstring(exports.dgs:dgsImportFunction())() -- load dgs functions using loadstring.

local svg = dgsCreateSVG(500,500) -- Create the SVG .
local svgDoc = dgsSVGGetDocument(svg) -- Get the SVG Document so you can modify it .
local rect = dgsSVGCreateNode(svgDoc,"rect",50,50) -- Create SVG node with rect shape.
dgsSVGNodeSetAttributes(rect,{ -- Change the rect shape attributes value .
["stroke"] = {255,255,0},
["stroke-width"] = "5px",
["fill"] = "rgb(255,0,0)",
})
local theImage = dgsCreateImage(200,200,500,500,svg,false) -- Render the SVG by dgsCreateImage

dgsSVGNodeSetAttribute(rect,'fill', 'rgb(255,0,255)') -- Change node 'fill' attribute value to 'rgb(255,0,255)'
</syntaxhighlight></section>

==See Also==
{{DGSFUNCTIONS}}

Dgs-dxprogressbar

2025-08-21T03:08:06Z

Thisdp: /* indicatorImage */

[[Dgs|DGS]] Properties is always used to change the gui style and make it more fantastic.

This page shows the properties of dgs-dxlabel that you could use.

==Main Functions==
*[[dgsSetProperty]]
*[[dgsGetProperty]]

==Properties==
===bgColor===
This property determines the background color of the progress bar.
<syntaxhighlight lang="lua">dgsSetProperty(progressbar,"bgColor",bgColor)</syntaxhighlight>
*'''bgColor''' : An integer of the color that can be converted by [[tocolor]].

===bgImage===
This property determines the background image of the progress bar.
<syntaxhighlight lang="lua">dgsSetProperty(progressbar,"bgImage",bgImage)</syntaxhighlight>
*'''bgImage''' : A material element that serves as the background image of the progress bar (texture/shader/screen source/renderTarget).

===indicatorColor===
This property determines the indicator color of the progress bar.
<syntaxhighlight lang="lua">dgsSetProperty(progressbar,"indicatorColor",indicatorColor)</syntaxhighlight>
*'''indicatorColor''' : An integer of the color that can be converted by [[tocolor]].

===indicatorImage===
This property determines the indicator image of the progress bar.
<syntaxhighlight lang="lua">dgsSetProperty(progressbar,"indicatorImage",indicatorImage)</syntaxhighlight>
*'''indicatorImage''' : A material element that serves as the indicator image of the progress bar (texture/shader/screen source/renderTarget).

===indicatorMode===
This property determines the indicator mode of the progress bar. See [[dgsProgressBarSetMode]]/[[dgsProgressBarGetMode]].
<syntaxhighlight lang="lua">dgsSetProperty(progressbar,"indicatorMode",indicatorMode)</syntaxhighlight>
*'''indicatorMode''' : A bool indicates if indicator image uses clip mode or stretch mode. (false for stretch, true for clip)

===padding===
This property determines the padding of the progress bar.
<syntaxhighlight lang="lua">dgsSetProperty(progressbar,"padding",{paddingX,paddingY})</syntaxhighlight>
*'''paddingX''' : An integer of 2D x padding value.
*'''paddingY''' : An integer of 2D y padding value.

===progress===
This property stores the progress value of progress bar.
<syntaxhighlight lang="lua">dgsSetProperty(progressbar,"progress",progress)</syntaxhighlight>
*'''progress''' : A float of progress value.

===style===
This property stores the style name of progress bar, to change the style use [[dgsProgressBarSetStyle]].
<syntaxhighlight lang="lua">dgsSetProperty(progressbar,"style",style)</syntaxhighlight>
*'''style''' : A string of the style name.

==Style Properties==
===>Style:normal-horizontal<===
None
===>Style:normal-vertical<===
None
===>Style:ring-round<===

====antiAliased====
This style property determines the anti aliasing of the ring.
<syntaxhighlight lang="lua">dgsSetProperty(progressbar,"antiAliased",antiAliased)</syntaxhighlight>
*'''antiAliased:''' A float of the anti aliasing of the ring.

====bgProgress====
This style property determines the progress of the background of the ring.
<syntaxhighlight lang="lua">dgsSetProperty(progressbar,"bgProgress",bgProgress)</syntaxhighlight>
*'''bgProgress:''' A float of the progress of the background of the ring.

====bgRadius====
This style property determines the radius of the background of the ring.
<syntaxhighlight lang="lua">dgsSetProperty(progressbar,"bgRadius",bgRadius)</syntaxhighlight>
*'''bgRadius:''' A float of the radius of the background of the ring.

====bgRotation====
This style property determines the rotation of the background of the ring.
<syntaxhighlight lang="lua">dgsSetProperty(progressbar,"bgRotation",bgRotation)</syntaxhighlight>
*'''bgRotation:''' A float of the rotation of the background of the ring.

====bgThickness====
This style property determines the thickness of the background of the ring.
<syntaxhighlight lang="lua">dgsSetProperty(progressbar,"bgThickness",bgThickness)</syntaxhighlight>
*'''bgThickness:''' A float of the thickness of the background of the ring.

====elements====
This style property stores the custom elements of the progress bar.
<syntaxhighlight lang="lua">dgsSetProperty(progressbar,"elements",elements)</syntaxhighlight>
*'''elements:''' A table of elements. Built-in elements are as follows:
**'''elements.circleShader:''' A shader of ring-round style.

====isClockwise====
This style property determines whether the progress direction is clockwise or anti-clockwise .
<syntaxhighlight lang="lua">dgsSetProperty(progressbar,"isClockwise",isClockwise)</syntaxhighlight>
*'''isClockwise:''' A bool of whether the progress direction is clockwise or anti-clockwise.

====radius====
This style property determines the radius of the ring.
<syntaxhighlight lang="lua">dgsSetProperty(progressbar,"radius",radius)</syntaxhighlight>
*'''radius:''' A float of the radius of the ring.

====rotation====
This style property determines the rotation of the ring.
<syntaxhighlight lang="lua">dgsSetProperty(progressbar,"rotation",rotation)</syntaxhighlight>
*'''rotation:''' A float of the rotation of the ring.

====thickness====
This style property determines the thickness of the ring.
<syntaxhighlight lang="lua">dgsSetProperty(progressbar,"thickness",thickness)</syntaxhighlight>
*'''radius:''' A float of the thickness of the ring.

===>Style:ring-plain<===
====antiAliased====
This style property determines the anti aliasing of the ring.
<syntaxhighlight lang="lua">dgsSetProperty(progressbar,"antiAliased",antiAliased)</syntaxhighlight>
*'''antiAliased:''' A float of the anti aliasing of the ring.

====bgProgress====
This style property determines the progress of the background of the ring.
<syntaxhighlight lang="lua">dgsSetProperty(progressbar,"bgProgress",bgProgress)</syntaxhighlight>
*'''bgProgress:''' A float of the progress of the background of the ring.

====bgRadius====
This style property determines the radius of the background of the ring.
<syntaxhighlight lang="lua">dgsSetProperty(progressbar,"bgRadius",bgRadius)</syntaxhighlight>
*'''bgRadius:''' A float of the radius of the background of the ring.

====bgRotation====
This style property determines the rotation of the background of the ring.
<syntaxhighlight lang="lua">dgsSetProperty(progressbar,"bgRotation",bgRotation)</syntaxhighlight>
*'''bgRotation:''' A float of the rotation of the background of the ring.

====bgThickness====
This style property determines the thickness of the background of the ring.
<syntaxhighlight lang="lua">dgsSetProperty(progressbar,"bgThickness",bgThickness)</syntaxhighlight>
*'''bgThickness:''' A float of the thickness of the background of the ring.

====elements====
This style property stores the custom elements of the progress bar.
<syntaxhighlight lang="lua">dgsSetProperty(progressbar,"elements",elements)</syntaxhighlight>
*'''elements:''' A table of elements. Built-in elements are as follows:
**'''elements.circleShader:''' A shader of ring-round style.

====isClockwise====
This style property determines whether the progress direction is clockwise or anti-clockwise.
<syntaxhighlight lang="lua">dgsSetProperty(progressbar,"isClockwise",isClockwise)</syntaxhighlight>
*'''isClockwise:''' A bool of whether the progress direction is clockwise or anti-clockwise.

====radius====
This style property determines the radius of the ring.
<syntaxhighlight lang="lua">dgsSetProperty(progressbar,"radius",radius)</syntaxhighlight>
*'''radius:''' A float of the radius of the ring.

====rotation====
This style property determines the rotation of the ring.
<syntaxhighlight lang="lua">dgsSetProperty(progressbar,"rotation",rotation)</syntaxhighlight>
*'''rotation:''' A float of the rotation of the ring.

====thickness====
This style property determines the thickness of the ring.
<syntaxhighlight lang="lua">dgsSetProperty(progressbar,"thickness",thickness)</syntaxhighlight>
*'''thickness:''' A float of the thickness of the ring.

==See Also==
{{DGSPROPERTIES}}

DgsProgressBarSetMode

2025-08-21T03:06:16Z

Thisdp: /* Required Arguments */

{{Client function}}

This function sets bar image showing mode.

==Syntax==
<syntaxhighlight lang="lua">
bool dgsProgressBarSetMode ( element progressBar, bool mode )
</syntaxhighlight>
[[Image:dgspgMode.gif|frame|The Effect Of Mode.]]

===Required Arguments===
*'''progressBar:''' the Progress Bar that you want to operate.
*'''mode:''' the mode to choose, stretch or clip ( see effect in the the right side image ).

===Returns===
Returns ''true'' if succeed, ''false'' otherwise.

<syntaxhighlight lang="lua">
DGS = exports.dgs
local tex = dxCreateTexture("exampleImage.png")
pb1 = DGS:dgsCreateProgressBar(100,300,400,50,false)
DGS:dgsSetProperties(pb1,{barimg=tex,barcolor=tocolor(255,255,255,255)})
pb2 = DGS:dgsCreateProgressBar(100,370,400,50,false)
DGS:dgsSetProperties(pb2,{barimg=tex,barcolor=tocolor(255,255,255,255)})
DGS:dgsProgressBarSetMode(pb2,true)
addEventHandler("onClientRender",root,function()
local tick = getTickCount()/20%360/180*math.pi
local pos = (math.cos(tick)*100+100)/2
DGS:dgsProgressBarSetProgress(pb1,pos)
DGS:dgsProgressBarSetProgress(pb2,pos)
end)
</syntaxhighlight>

==See Also==
{{DGSFUNCTIONS}}

Dgs-dxgridlist

2025-07-25T16:39:30Z

Thisdp: /* mode */

[[Dgs|DGS]] Properties is always used to change the gui style and make it more fantastic.

This page shows the properties of dgs-dxgridlist that you could use.

==Main Functions==
*[[dgsSetProperty]]
*[[dgsGetProperty]]

==Properties==
===autoSort===
This property determines whether auto sort is enabled. ''See [[dgsGridListSetAutoSortEnabled]]/[[dgsGridListGetAutoSortEnabled]]''
<syntaxhighlight lang="lua">dgsSetProperty(gridlist,"autoSort",autoSort)</syntaxhighlight>
*'''autoSort:''' A bool of auto sort state.

===backgroundOffset===
This property determines the offset between the left border and row background.
<syntaxhighlight lang="lua">dgsSetProperty(gridlist,"backgroundOffset",backgroundOffset)</syntaxhighlight>
*'''backgroundOffset:''' An integer of the offset between the left border and row background.

===bgColor===
This property determines the background color of the grid list.
<syntaxhighlight lang="lua">dgsSetProperty(gridlist,"bgColor",bgColor)</syntaxhighlight>
*'''bgColor:''' An integer of the color that can be converted by [[tocolor]].

===bgImage===
This property determines the background image of the grid list. To adjust the color of the image, use property '''bgColor'''
<syntaxhighlight lang="lua">dgsSetProperty(gridlist,"bgImage",bgImage)</syntaxhighlight>
*'''bgImage:''' A material element that serves as the background image of the grid list (texture/shader/screen source/renderTarget).

===clip===
Whether the clip property is enabled or not. ''Learn More [[dxDrawText]]''
<syntaxhighlight lang="lua">dgsSetProperty(gridlist,"clip",clip)</syntaxhighlight>
*'''clip:''' If set to true, the parts of the text that don't fit within the bounding box will be cut off.

===columnColor===
This property determines the background color of the column of the grid list.
<syntaxhighlight lang="lua">dgsSetProperty(gridlist,"columnColor",columnColor)</syntaxhighlight>
*'''columnColor:''' An integer of the color that can be converted by [[tocolor]].

===columnData===
This property stores column data.
<syntaxhighlight lang="lua">dgsSetProperty(gridlist,"columnData",columnData)</syntaxhighlight>
*'''columnData:''' A table stores all column data.
'''Data Structure'''
<syntaxhighlight lang="lua">
{
{ text, Width, AllWidthFront, Alignment, color, colorcoded, sizeX, sizeY, font },
{ text, Width, AllWidthFront, Alignment, color, colorcoded, sizeX, sizeY, font },
{ text, Width, AllWidthFront, Alignment, color, colorcoded, sizeX, sizeY, font },
...
}
</syntaxhighlight>

===columnHeight===
This property determines the column height of the grid list.
<syntaxhighlight lang="lua">dgsSetProperty(gridlist,"columnHeight",columnHeight)</syntaxhighlight>
*'''columnHeight:''' An integer of column height of the grid list.

===columnImage===
This property determines the background image of the column of the grid list.
<syntaxhighlight lang="lua">dgsSetProperty(gridlist,"columnImage",columnImage)</syntaxhighlight>
*'''columnImage:''' A material element that serves as the background image of the column of the grid list (texture/shader/screen source/renderTarget).

===columnMoveOffset===
This property stores the move offset of column that is used to render.
<syntaxhighlight lang="lua">dgsSetProperty(gridlist,"columnMoveOffset",columnMoveOffset)</syntaxhighlight>
*'''columnMoveOffset:''' A float stores the move offset of column that is used to render.

===columnOffset===
This property determines the global offset between the left border and column text.
<syntaxhighlight lang="lua">dgsSetProperty(gridlist,"columnOffset",columnOffset)</syntaxhighlight>
*'''columnOffset:''' An integer of offset of the column.

===columnRelative===
This property determines whether the column length is relative or not. ''See [[dgsGridListSetColumnRelative]]/[[dgsGridListGetColumnRelative]]''
<syntaxhighlight lang="lua">dgsSetProperty(gridlist,"columnRelative",columnRelative)</syntaxhighlight>
*'''columnRelative:''' A bool of the relative state of the column length.

===columnShadow===
The shadow text of the column.
<syntaxhighlight lang="lua">dgsSetProperty(gridlist,"columnShadow",{offsetX,offsetY,color})</syntaxhighlight>
*'''offsetX:''' A float of the 2D X offset of the shadow text of the column.
*'''offsetY:''' A float of the 2D Y offset of the shadow text of the column.
*'''color:''' An integer of the color of the shadow text of the column.

===columnTextColor===
This property determines the color of the column text of the grid list.
<syntaxhighlight lang="lua">dgsSetProperty(gridlist,"columnTextColor",columnTextColor)</syntaxhighlight>
*'''columnTextColor:''' An integer of the color that can be converted by [[tocolor]].

===columnTextPosOffset===
This property adjusts the offset of the text of the column, which can solve text misplacing caused by font.
<syntaxhighlight lang="lua">dgsSetProperty(gridlist,"columnTextPosOffset",{offsetX,offsetY})</syntaxhighlight>
*'''offsetX:''' A float of the 2D X offset of the text of the column.
*'''offsetY:''' A float of the 2D Y offset of the text of the column.

===columnTextSize===
This property determines the scale of the column text of the grid list.
<syntaxhighlight lang="lua">dgsSetProperty(gridlist,"columnTextSize",{scaleX,scaleY})</syntaxhighlight>
*'''scaleX:''' A float of the 2D X scale of the text of the column.
*'''scaleY:''' A float of the 2D Y scale of the text of the column.

===columnWordBreak===
This property determines whether word break property for column is enabled or not. ''Learn More [[dxDrawText]]''
<syntaxhighlight lang="lua">dgsSetProperty(gridlist,"columnWordBreak",columnWordBreak)</syntaxhighlight>
*'''columnWordBreak:''' A bool indicates whether the word break is enabled.

===colorCoded===
Whether the color code is enabled or not. ''Learn More [[dxDrawText]]''
<syntaxhighlight lang="lua">dgsSetProperty(gridlist,"colorCoded",colorCoded)</syntaxhighlight>
*'''colorCoded:''' Set to true to enable embedded #FFFFFF color codes.

===defaultColumnOffset===
This property determines offset of normal row column (is different from but works with columnOffset). ''See [[dgsGridListSetRowAsSection]]''
<syntaxhighlight lang="lua">dgsSetProperty(gridlist,"defaultColumnOffset",defaultColumnOffset)</syntaxhighlight>
*'''defaultColumnOffset:''' An integer of the offset of normal row column.

===defaultSortFunctions===
This property determines the default sort function of grid list when clicking column.
<syntaxhighlight lang="lua">dgsSetProperty(gridlist,"defaultSortFunctions",{lowerSortFunction,upperSortFunction})</syntaxhighlight>
*'''lowerSortFunction:''' A string of the lower sort function name.
*'''upperSortFunction:''' A string of the upper sort function name.
Here are three groups can be use:
*'''greaterLower'''/'''greaterUpper''': Sorting directly with string.
*'''numGreaterLowerNumFirst'''/'''numGreaterUpperNumFirst''': Sorting support number order with number first.
*'''numGreaterLowerStrFirst'''/'''numGreaterUpperStrFirst''': Sorting support number order with string first.
*'''longerLower'''/'''longerUpper''': Sorting according to the utf8 length of the string.

===defaultSortIcons===
This property determines the icons of the default sort function.
<syntaxhighlight lang="lua">dgsSetProperty(gridlist,"defaultSortIcons",{iconA,iconB})</syntaxhighlight>
*'''iconA:''' A string of the lower sort icon ('''▲''' By default).
*'''iconB:''' A string of the upper sort icon ('''▼''' By default).

===font===
This is equivalent to [[dgsSetFont]]/[[dgsGetFont]]. ''Learn More [[dxDrawText]]''
<syntaxhighlight lang="lua">dgsSetProperty(gridlist,"font",font)</syntaxhighlight>
*'''font:''' A [[Element/DX_font|dx font element]] of the default text font of the gridlist.

===leading===
This property determines the space between rows.
<syntaxhighlight lang="lua">dgsSetProperty(gridlist,"leading",leading)</syntaxhighlight>
*'''leading:''' How many pixels between rows

===multiSelection===
This property determines whether multi selection is enabled or not. ''See [[dgsGridListSetMultiSelectionEnabled]]/[[dgsGridListGetMultiSelectionEnabled]]''
<syntaxhighlight lang="lua">dgsSetProperty(gridlist,"multiSelection",multiSelection)</syntaxhighlight>
*'''multiSelection:''' A bool of the state of the multi selection.

===moveHardness===
This property determines how hard will the grid list moves when scrolling.
<syntaxhighlight lang="lua">dgsSetProperty(gridlist,"moveHardness",{scrollHardness,dragHardness})</syntaxhighlight>
*'''scrollHardness:''' A float determins how hard will the grid list moves when scrolling with wheel ( should be larger than 0, lower than 1 ).
*'''dragHardness:''' A float determins how hard will the grid list moves when dragging with mouse ( should be larger than 0, lower than 1 ).

===preSelect===
This property stores the item id the cursor is hovering on.
<syntaxhighlight lang="lua">dgsSetProperty(gridlist,"preSelect",{rowIndex,columnIndex})</syntaxhighlight>
*'''rowIndex:''' Row Index
*'''columnIndex:''' Column Index

===rowColor===
This property determines the default 3 states' colors of row. ''See [[dgsGridListSetRowBackGroundColor]]/[[dgsGridListGetRowBackGroundColor]]''. Note that this property does not affect rows that were created before the property was changed.
<syntaxhighlight lang="lua">dgsSetProperty(gridlist,"rowColor",{colorDefault,colorHoving,colorSelected})</syntaxhighlight>
*'''colorDefault:''' An integer of the color of the row (Default State).
*'''colorHoving:''' An integer of the color of the row (Hoving State).
*'''colorSelected:''' An integer of the color of the row (Selected State).

===rowData===
This property stores row data.
<syntaxhighlight lang="lua">dgsSetProperty(gridlist,"rowData",rowData)</syntaxhighlight>
*'''rowData:''' A table stores all row data.
'''Data Structure'''
<syntaxhighlight lang="lua">
{

[1] = {
[-4] = columnOffset, --column offset
[-3] = {normal,hovering,selected}, --background image
[-2] = true/false, --selectable
[-1] = true/false, --clickable
[0] = {normal,hovering,selected}, --background color
[1] = {text,color,colorcoded,scalex,scaley,font,{image,color,imagex,imagey,imagew,imageh},unselectable,unclickable}, --Column 1
[2] = {text,color,colorcoded,scalex,scaley,font,{image,color,imagex,imagey,imagew,imageh},unselectable,unclickable}, --Column 2
...
}, --Row 1
[2] = {
[-4] = columnOffset, --column offset
[-3] = {normal,hovering,selected}, --background image
[-2] = true/false, --selectable
[-1] = true/false, --clickable
[0] = {normal,hovering,selected}, --background color
[1] = {text,color,colorcoded,scalex,scaley,font,{image,color,imagex,imagey,imagew,imageh},unselectable,unclickable}, --Column 1
[2] = {text,color,colorcoded,scalex,scaley,font,{image,color,imagex,imagey,imagew,imageh},unselectable,unclickable}, --Column 2
...
}, --Row 2
}
</syntaxhighlight>

===rowHeight===
This property determines the row height of the grid list.
<syntaxhighlight lang="lua">dgsSetProperty(gridlist,"rowHeight",rowHeight)</syntaxhighlight>
*'''rowHeight:''' An integer of row height of the grid list.

===rowImage===
This property determines the default 3 states' background image of row. ''See [[dgsGridListGetRowBackGroundImage]]/[[dgsGridListSetRowBackGroundImage]]''. Note that this property does not affect rows that were created before the property was changed.
<syntaxhighlight lang="lua">dgsSetProperty(gridlist,"rowImage",{normalImage,hoveringImage,selectedImage})</syntaxhighlight>
*'''normalImage:''' A texture of the image of the row (Normal State).
*'''hoveringImage:''' A texture of the image of the row (Hoving State).
*'''selectedImage:''' A texture of the image of the row (Selected State).

===rowImageStyle===
This property determines the style of row background image.
<syntaxhighlight lang="lua">dgsSetProperty(gridlist,"rowImageStyle",style)</syntaxhighlight>
*'''style:''' An integer of the style of row background image. Available values are as follows:
**'''1:''' Every item uses a complete background image.
**'''2:''' Every row uses a complete background image.
**'''3:''' Only the visible area of every row uses a complete background image.

===rowMoveOffset===
This property stores the move offset of row that is used to render.
<syntaxhighlight lang="lua">dgsSetProperty(gridlist,"rowMoveOffset",rowMoveOffset)</syntaxhighlight>
*'''rowMoveOffset:''' A float stores the move offset of row that is used to render.

===rowSelect===
This property stores the selected rows.
<syntaxhighlight lang="lua">dgsSetProperty(gridlist,"rowSelect",data)</syntaxhighlight>
*'''data:''' the data.
'''Data Structure'''
<syntaxhighlight lang="lua">
{
[Column1] = {
Row1,
Row2,
...
},
[Column2] = {
Row1,
Row2,
...
},
...
}
</syntaxhighlight>

===rowShadow===
The shadow text of the row.
<syntaxhighlight lang="lua">dgsSetProperty(gridlist,"rowShadow",{offsetX,offsetY,color})</syntaxhighlight>
*'''offsetX:''' A float of the 2D X offset of the shadow text of the row.
*'''offsetY:''' A float of the 2D Y offset of the shadow text of the row.
*'''color:''' An integer of the color of the shadow text of the row.

===rowShowUnclippedOnly===
This property will force the grid list only show those unclipped row
<syntaxhighlight lang="lua">dgsSetProperty(gridlist,"rowShowUnclippedOnly",rowShowUnclippedOnly)</syntaxhighlight>
*'''rowShowUnclippedOnly:''' A bool indicates if the only the unclipped rows will be shown in grid list.

===rowTextColor===
This property determines the default color of the row text of the grid list.
<syntaxhighlight lang="lua">dgsSetProperty(gridlist,"rowTextColor",rowTextColor)</syntaxhighlight>
*'''rowTextColor:''' An integer of the color of the row text that can be converted by [[tocolor]]. Note that this property does not affect rows that were created before the property was changed.

<syntaxhighlight lang="lua">dgsSetProperty(gridlist,"rowTextColor",{normalColor,hoveringColor,selectedColor})</syntaxhighlight>
*'''normalColor:''' A integer of the color of the row text that can be converted by [[tocolor]](Normal State).
*'''hoveringColor:''' A integer of the color of the row text that can be converted by [[tocolor]](Hoving State).
*'''selectedColor:''' A integer of the color of the row text that can be converted by [[tocolor]](Selected State).

===rowTextPosOffset===
This property adjusts the offset of the text of the row, which can solve text misplacing caused by font.
<syntaxhighlight lang="lua">dgsSetProperty(gridlist,"rowTextPosOffset",{offsetX,offsetY})</syntaxhighlight>
*'''offsetX:''' A float of the 2D X offset of the text of the row.
*'''offsetY:''' A float of the 2D Y offset of the text of the row.

===rowTextSize===
This property determines the default scale of the row text of the grid list. Note that this property does not affect rows that were created before the property was changed.
<syntaxhighlight lang="lua">dgsSetProperty(gridlist,"rowTextSize",{scaleX,scaleY})</syntaxhighlight>
*'''scaleX:''' A float of the 2D X scale of the text of the row.
*'''scaleY:''' A float of the 2D Y scale of the text of the row.

===rowWordBreak===
This property determines whether word break property for row is enabled or not. ''Learn More [[dxDrawText]]''
<syntaxhighlight lang="lua">dgsSetProperty(gridlist,"rowWordBreak",rowWordBreak)</syntaxhighlight>
*'''rowWordBreak:''' A bool indicates whether the word break is enabled.

===scrollBarAlignment===
This property sets the alignment of the scroll bars in the grid list.
<syntaxhighlight lang="lua">dgsSetProperty(gridlist, "scrollBarAlignment",{vertical})</syntaxhighlight> 
*'''vertical:''' Specifies the alignment of the vertical scroll bar, which can be set to:
**'''left:''' Aligns the vertical scroll bar to the left of the grid list.
**'''right:''' Aligns the vertical scroll bar to the right of the grid list.


===scrollBarState===
This property forces the visibility of scroll bar. ''See [[dgsGridListSetScrollBarState]]/[[dgsGridListGetScrollBarState]]''
<syntaxhighlight lang="lua">dgsSetProperty(gridlist,"scrollBarState",{vertical,horizontal})</syntaxhighlight>
*'''vertical:''' A bool of the state of the vertical scroll bar.
*'''horizontal:''' A bool of the state of the horizontal scroll bar.
**'''true:''' Force to be visible
**'''false:''' Force to be invisible
**'''nil:''' Auto

===scrollBarThick===
This property determines the thickness of scroll bar.
<syntaxhighlight lang="lua">dgsSetProperty(gridlist,"scrollBarThick",scrollBarThick)</syntaxhighlight>
*'''scrollBarThick:''' An integer of the thickness of scroll bar.

===sectionColumnOffset===
This property determines offset of section row column (is different from but works with columnOffset). ''See [[dgsGridListSetRowAsSection]]''
<syntaxhighlight lang="lua">dgsSetProperty(gridlist,"sectionColumnOffset",sectionColumnOffset)</syntaxhighlight>
*'''sectionColumnOffset:''' An integer of the offset of section row column.

===sectionFont===
This property determines the font of the text of which row is in section mode. ''Learn More [[dxDrawText]]''
<syntaxhighlight lang="lua">dgsSetProperty(gridlist,"sectionFont",sectionFont)</syntaxhighlight>
*'''sectionFont:''' A [[Element/DX_font|dx font element]] of the text of which row is in section mode.

===selectionMode===
This property stores current selection mode of grid list. ''See [[dgsGridListSetSelectionMode]]/[[dgsGridListGetSelectionMode]]''
<syntaxhighlight lang="lua">dgsSetProperty(gridlist,"selectionMode",selectionMode)</syntaxhighlight>
*'''selectionMode:''' The mode of the selection. Can be the following values:
**'''1:''' row selection
**'''2:''' column selection
**'''3:''' cell selection

===selectedColumn===
This property stores the index of which column the cursor is hovering. ''See [[dgsGridListGetEnterColumn]]''
<syntaxhighlight lang="lua">dgsSetProperty(gridlist,"selectedColumn",selectedColumn)</syntaxhighlight>
*'''columnHeight:''' Column Index.

===sortColumn===
This property determines target sort column. ''See [[dgsGridListSetSortColumn]]''
<syntaxhighlight lang="lua">dgsSetProperty(gridlist,"sortColumn",sortColumn)</syntaxhighlight>
*'''sortColumn:''' An integer of the specific column to be sorted by.

===sortEnabled===
This property determines whether sort is enabled. ''See [[dgsGridListSetSortEnabled]]/[[dgsGridListGetSortEnabled]]''
<syntaxhighlight lang="lua">dgsSetProperty(gridlist,"sortEnabled",sortEnabled)</syntaxhighlight>
*'''sortEnabled:''' A bool of sort state.

==See Also==
{{DGSPROPERTIES}}

DgsMenuGetItemColor

2025-07-11T04:37:27Z

Thisdp: /* Syntax */

{{Client function}}
__NOTOC__
This function gets the color of a specific menu item. You can retrieve the colors either as separate RGBA components or as color values.

==Syntax 1==
<syntaxhighlight lang="lua">
int r, int g, int b, int a, int hr, int hg, int hb, int ha dgsMenuGetItemColor ( element menu, int uniqueID )
</syntaxhighlight>

===Required Arguments===
*'''menu:''' The DGS menu element containing the item
*'''uniqueID:''' The unique ID of the menu item (returned by [[dgsMenuAddItem]])

===Optional Arguments===
*'''notSplitColor:''' If set to ''true'', returns the color values as they are stored (two color values). If ''false'' or not specified, returns 8 separate RGBA components

===Returns===
When '''notSplitColor''' is ''false'' or not specified:
Returns 8 integers representing the RGBA components: normal red, normal green, normal blue, normal alpha, hover red, hover green, hover blue, hover alpha. Returns ''false'' if the operation failed.

==Syntax2 ==
<syntaxhighlight lang="lua">
int normalColor, int hoverColor dgsMenuGetItemColor ( element menu, int uniqueID, bool notSplitColor )
</syntaxhighlight>

===Required Arguments===
*'''menu:''' The DGS menu element containing the item
*'''uniqueID:''' The unique ID of the menu item (returned by [[dgsMenuAddItem]])

===Optional Arguments===
*'''notSplitColor:''' If set to ''true'', returns the color values as they are stored (two color values). If ''false'' or not specified, returns 8 separate RGBA components

===Returns===
When '''notSplitColor''' is ''true'':
Returns two color values: normalColor, hoverColor. Returns ''false'' if the operation failed.

==Examples==

===Example 1: Getting RGBA Components===
<syntaxhighlight lang="lua">
loadstring(exports.dgs:dgsImportFunction())()-- load functions

-- Create a menu with items
local menu = dgsCreateMenu(200, 200, 200, 150, false)
local item1 = dgsMenuAddItem(menu, "Red Item", "red")
local item2 = dgsMenuAddItem(menu, "Custom Item", "custom")

-- Set colors for the items
dgsMenuSetItemColor(menu, item1, 255, 0, 0, 200) -- Red with alpha
local normalColor = tocolor(100, 150, 200)
local hoverColor = tocolor(200, 255, 100)
dgsMenuSetItemColor(menu, item2, {normalColor, hoverColor})

-- Get the colors as RGBA components
local r, g, b, a, hr, hg, hb, ha = dgsMenuGetItemColor(menu, item1)
if r then
outputChatBox("Item 1 - Normal: R=" .. r .. " G=" .. g .. " B=" .. b .. " A=" .. a)
outputChatBox("Item 1 - Hover: R=" .. hr .. " G=" .. hg .. " B=" .. hb .. " A=" .. ha)
end

local r2, g2, b2, a2, hr2, hg2, hb2, ha2 = dgsMenuGetItemColor(menu, item2)
if r2 then
outputChatBox("Item 2 - Normal: R=" .. r2 .. " G=" .. g2 .. " B=" .. b2 .. " A=" .. a2)
outputChatBox("Item 2 - Hover: R=" .. hr2 .. " G=" .. hg2 .. " B=" .. hb2 .. " A=" .. ha2)
end

-- Show the menu
dgsMenuShow(menu)
</syntaxhighlight>

===Example 2: Getting Color Values===
<syntaxhighlight lang="lua">
loadstring(exports.dgs:dgsImportFunction())()-- load functions

-- Create a menu with items
local menu = dgsCreateMenu(200, 200, 200, 150, false)
local item1 = dgsMenuAddItem(menu, "Blue Item", "blue")
local item2 = dgsMenuAddItem(menu, "Yellow Item", "yellow")

-- Set colors for the items
dgsMenuSetItemColor(menu, item1, tocolor(0, 0, 255)) -- Blue for both states
local normalYellow = tocolor(255, 255, 0)
local hoverYellow = tocolor(255, 255, 150)
dgsMenuSetItemColor(menu, item2, {normalYellow, hoverYellow})

-- Get the colors as color values
local normalColor1, hoverColor1 = dgsMenuGetItemColor(menu, item1, true)
if normalColor1 then
outputChatBox("Item 1 - Normal Color: " .. normalColor1)
outputChatBox("Item 1 - Hover Color: " .. hoverColor1)
end

local normalColor2, hoverColor2 = dgsMenuGetItemColor(menu, item2, true)
if normalColor2 then
outputChatBox("Item 2 - Normal Color: " .. normalColor2)
outputChatBox("Item 2 - Hover Color: " .. hoverColor2)
end

-- Show the menu
dgsMenuShow(menu)
</syntaxhighlight>

===Example 3: Color Inspection and Modification===
<syntaxhighlight lang="lua">
loadstring(exports.dgs:dgsImportFunction())()-- load functions

-- Create a menu with items
local menu = dgsCreateMenu(200, 200, 200, 150, false)
local item1 = dgsMenuAddItem(menu, "Inspectable Item", "inspect")

-- Set initial color
dgsMenuSetItemColor(menu, item1, 128, 128, 128, 255) -- Gray

-- Function to inspect and modify colors
function inspectAndModifyColor(menu, uniqueID)
-- Get current colors as RGBA components
local r, g, b, a, hr, hg, hb, ha = dgsMenuGetItemColor(menu, uniqueID)

if r then
outputChatBox("Current colors:")
outputChatBox("Normal - R:" .. r .. " G:" .. g .. " B:" .. b .. " A:" .. a)
outputChatBox("Hover - R:" .. hr .. " G:" .. hg .. " B:" .. hb .. " A:" .. ha)

-- Modify the colors (make them brighter)
local newR = math.min(255, r + 50)
local newG = math.min(255, g + 50)
local newB = math.min(255, b + 50)

-- Set the new colors
dgsMenuSetItemColor(menu, uniqueID, newR, newG, newB, a)
outputChatBox("Colors have been brightened!")
else
outputChatBox("Failed to get item colors")
end
end

-- Show the menu
dgsMenuShow(menu)

-- Inspect and modify colors after 3 seconds
setTimer(inspectAndModifyColor, 3000, 1, menu, item1)
</syntaxhighlight>

==See Also==
*[[dgsMenuSetItemColor]]
*[[dgsMenuAddItem]]
*[[dgsMenuGetItemText]]
*[[dgsMenuGetItemTextSize]]
*[[dgsCreateMenu]]

==Author==
[[User:Mohab|Mohab]].

Dgs3DInterfaceProcessLineOfSight

2024-10-05T16:24:25Z

Thisdp: /* Examples */

{{Client function}}
__NOTOC__
This function casts a ray through two points to the dgs 3d interface, and tells you information about the point that was hit, if any.
==Syntax==
Return values labelled for ease of reference.
<syntaxhighlight lang="lua">
bool -- hit
float float float -- hitX, hitY, hitZ
float float -- hitInterfaceX, hitInterfaceY
dgs3DInterfaceProcessLineOfSight ( dgs-3dinterface interface,
float startX, float startY, float startZ,
float endX, float endY, float endZ )
</syntaxhighlight>

===Required Arguments===
*'''startX:''' The start ''x'' position
*'''startY:''' The start ''y'' position
*'''startZ:''' The start ''z'' position
*'''endX:''' The end ''x'' position
*'''endY:''' The end ''y'' position
*'''endZ:''' The end ''z'' position

===Returns===
*'''hit:''' ''true'' if there is a collision with dgs 3d interface, ''false'' otherwise
*'''hitX, hitY, hitZ:''' collision position
*'''hitInterfaceX, hitInterfaceY:''' the position on 3d interface

==Examples==
<syntaxhighlight lang="lua">
DGS = exports.dgs

dgs3dPanel = DGS:dgsCreate3DInterface(0,0,3,2,2,400,400,tocolor(255,255,255,255),0,1,0)
DGS:dgsCreateImage(0,0,1,1,_,true,dgs3dPanel) -- Background

local hit, hitX, hitY, hitZ, hitInterfaceX, hitInterfaceY = DGS:dgs3DInterfaceProcessLineOfSight ( 10, 10, 3, 0, 0, 3 )
outputChatBox ( "Hit " .. tostring(hit) .. ", " .. tostring(hitInterfaceX) .. ", " .. tostring(hitInterfaceY) )
</syntaxhighlight>

==See Also==
{{DGSFUNCTIONS}}

Dgs3DInterfaceProcessLineOfSight

2024-10-05T16:23:59Z

Thisdp: Created page with "{{Client function}} __NOTOC__ This function casts a ray through two points to the dgs 3d interface, and tells you information about the point that was hit, if any. ==Syntax== Return values labelled for ease of reference. <syntaxhighlight lang="lua"> bool -- hit float float float -- hitX, hitY, hitZ float float -- hitInterfaceX, hitInterfaceY dgs3DInterfaceProcessLineOfSight ( dgs-3dinterface interface,..."

{{Client function}}
__NOTOC__
This function casts a ray through two points to the dgs 3d interface, and tells you information about the point that was hit, if any.
==Syntax==
Return values labelled for ease of reference.
<syntaxhighlight lang="lua">
bool -- hit
float float float -- hitX, hitY, hitZ
float float -- hitInterfaceX, hitInterfaceY
dgs3DInterfaceProcessLineOfSight ( dgs-3dinterface interface,
float startX, float startY, float startZ,
float endX, float endY, float endZ )
</syntaxhighlight>

===Required Arguments===
*'''startX:''' The start ''x'' position
*'''startY:''' The start ''y'' position
*'''startZ:''' The start ''z'' position
*'''endX:''' The end ''x'' position
*'''endY:''' The end ''y'' position
*'''endZ:''' The end ''z'' position

===Returns===
*'''hit:''' ''true'' if there is a collision with dgs 3d interface, ''false'' otherwise
*'''hitX, hitY, hitZ:''' collision position
*'''hitInterfaceX, hitInterfaceY:''' the position on 3d interface

==Examples==
<syntaxhighlight lang="lua">
DGS = exports.dgs

dgs3dPanel = DGS:dgsCreate3DInterface(0,0,3,2,2,400,400,tocolor(255,255,255,255),0,1,0)
DGS:dgsCreateImage(0,0,1,1,_,true,dgs3dPanel) -- Background

local hit, hitX, hitY, hitZ, hitInterfaceX, hitInterfaceY = dgs3DInterfaceProcessLineOfSight ( 10, 10, 3, 0, 0, 3 )
outputChatBox ( "Hit " .. tostring(hit) .. ", " .. tostring(hitInterfaceX) .. ", " .. tostring(hitInterfaceY) )
</syntaxhighlight>

==See Also==
{{DGSFUNCTIONS}}

Dgs-dxscrollbar

2024-09-02T01:20:46Z

Thisdp: /* cursorLength */

[[Dgs|DGS]] Properties is always used to change the gui style and make it more fantastic.

This page shows the properties of dgs-dxscrollbar that you could use.

==Main Functions==
*[[dgsSetProperty]]
*[[dgsGetProperty]]

==Properties==
===arrowWidth===
This property adjusts the width of arrow ( take vertical scroll bar as a standard ).
<syntaxhighlight lang="lua">dgsSetProperty(scrollbar,"arrowWidth",{arrowWidth,relative})</syntaxhighlight>
*'''arrowWidth:''' A number of the width of arrow, which is affected by '''relative'''.
*'''relative:''' A bool of whether the width is relative or not. If this is true, then length must be between 0 and 1.

===arrowColor===
The arrow color of scroll bar, includes normal, hovering, click.
<syntaxhighlight lang="lua">dgsSetProperty(scrollbar,"arrowColor",{arrowColorNormal,arrowColorHover,arrowColorClick})</syntaxhighlight>
*'''arrowColorNormal:''' An integer of the arrow color, which can be converted by [[tocolor]].
*'''arrowColorHover:''' An integer of the arrow color when the mouse's cursor is hovering on it, which can be converted by [[tocolor]].
*'''arrowColorClick:''' An integer of the arrow color when the arrow gets clicked, which can be converted by [[tocolor]].

===arrowImage===
The arrow image of scroll bar.
<syntaxhighlight lang="lua">dgsSetProperty(scrollbar,"arrowImage",arrowImage)</syntaxhighlight>
*'''arrowImage:''' A material element of the arrow image of scroll bar.

===cursorColor===
The cursor color of scroll bar, includes normal, hovering, click.
<syntaxhighlight lang="lua">dgsSetProperty(scrollbar,"cursorColor",{cursorColorNormal,cursorColorHover,cursorColorClick})</syntaxhighlight>
*'''cursorColorNormal:''' An integer of the cursor color, which can be converted by [[tocolor]].
*'''cursorColorHover:''' An integer of the cursor color when the mouse's cursor is hovering on it, which can be converted by [[tocolor]].
*'''cursorColorClick:''' An integer of the cursor color when the cursor gets clicked, which can be converted by [[tocolor]].

===cursorImage===
The cursor image of scroll bar.
<syntaxhighlight lang="lua">dgsSetProperty(scrollbar,"cursorImage",cursorImage)</syntaxhighlight>
*'''cursorImage:''' A material element of the cursor image of scroll bar.

===cursorWidth===
This property adjusts the width of cursor ( take vertical scroll bar as a standard ).
<syntaxhighlight lang="lua">dgsSetProperty(scrollbar,"cursorWidth",{cursorWidth,relative})</syntaxhighlight>
*'''cursorWidth:''' A number of the width of cursor, which is affected by '''relative'''.
*'''relative:''' A bool of whether the width is relative or not. If this is true, then length must be between 0 and 1.

===grades===
This property stores the grades of scroll bar. ''See [[dgsScrollBarSetGrades]]/[[dgsScrollBarGetGrades]]''
<syntaxhighlight lang="lua">dgsSetProperty(scrollbar,"grades",grades)</syntaxhighlight>
*'''grades:''' A number of the grades of scroll bar.

===currentGrade===
This property stores the current grade of scroll bar if ''grades'' enabled.
<syntaxhighlight lang="lua">dgsSetProperty(scrollbar,"currentGrade",currentGrade)</syntaxhighlight>
*'''currentGrade:''' A number of the current grade, ranges from 0 to ''grades''.

===image===
The image of scroll bar, includes arrow, cursor and trough.
<syntaxhighlight lang="lua">dgsSetProperty(scrollbar,"image",{arrowImage,cursorImage,troughImage})</syntaxhighlight>
*'''arrowImage:''' A texture of the image of arrow.
*'''cursorImage:''' A texture of the image of cursor.
*'''troughImage:''' A texture of the image of trough.

===imageRotation===
This property solves the problem of the rotation of the images.
<syntaxhighlight lang="lua">dgsSetProperty(scrollbar,"imageRotation",{Horizontal,Vertical})</syntaxhighlight>
*'''Horizontal:''' A table includes arrowImageRotation,cursorImageRotation,troughImageRotation of horizontal scroll bar, by default:
<syntaxhighlight lang="lua" >{0,270,270}</syntaxhighlight>
*'''Vertical:''' A table includes arrowImageRotation,cursorImageRotation,troughImageRotation of vertical scroll bar, by default:
<syntaxhighlight lang="lua" >{270,0,0}</syntaxhighlight>

===cursorLength===
This property determines whether the length of the cursor of scroll bar.
<syntaxhighlight lang="lua">dgsSetProperty(scrollbar,"cursorLength",{cursorLength,relative})</syntaxhighlight>
*'''cursorLength:''' A number of the length of scroll bar, which is affected by '''relative'''.
*'''relative:''' A bool of whether the length is relative or not. If this is true, then length must be between 0 and 1.

===locked===
This is equivalent to [[dgsScrollBarSetLocked]]/[[dgsScrollBarGetLocked]].
<syntaxhighlight lang="lua">dgsSetProperty(scrollbar,"locked",locked)</syntaxhighlight>
*'''locked:''' A bool of whether the scroll bar get locked or not.

===map===
This property will map the value from 0~100 to mapMin~mapMax (Both get and set scroll position).
<syntaxhighlight lang="lua">dgsSetProperty(scrollbar,"map",{mapMin,mapMax})</syntaxhighlight>
*'''mapMin:''' A number of the min value.
*'''mapMax:''' A number of the max value.

===multiplier===
This property determines whether how much a scroll bar will scroll when you click the arrow or use mouse wheel.

This property is difficult to understand. Before use this property, do an experiment first.
<syntaxhighlight lang="lua">dgsSetProperty(scrollbar,"multiplier",{multiplier,relative})</syntaxhighlight>
*'''multiplier:''' A number of the multiplier of scroll bar, which is affected by '''relative'''.
*'''relative:''' A bool of whether the multiplier is relative or not. If this is true, then multiplier must be between 0 and 1.

===scrollPosition===
This is equivalent to [[dgsScrollBarSetScrollPosition]]/[[dgsScrollBarGetScrollPosition]].
<syntaxhighlight lang="lua">dgsSetProperty(scrollbar,"scrollPosition",scrollPosition)</syntaxhighlight>
*'''scrollPosition:''' An integer of the scroll poisition of the scroll bar. Ranges from 0 to 100.

===scrollArrow===
This property indicates whether enable the scroll arrow or not. It is useful when making scroll bar act as slide or something else.
<syntaxhighlight lang="lua">dgsSetProperty(scrollbar,"scrollArrow",scrollArrow)</syntaxhighlight>
*'''scrollArrow:''' A bool of whether enable the scroll arrow or not.

===troughClickAction===
This property determines what will the scroll bar do when you click the trough.
<syntaxhighlight lang="lua">dgsSetProperty(scrollbar,"troughClickAction",troughClickAction)</syntaxhighlight>
*'''troughClickAction:''' A string. Available values are as follows:
**'''none:''' No actions.
**'''step:''' Step up or down.
**'''jump:''' Make cursor of scroll bar jump to the current place you click.

===troughColor===
The trough color of scroll bar.
<syntaxhighlight lang="lua">dgsSetProperty(scrollbar,"troughColor",{troughColorPart1,troughColorPart2})</syntaxhighlight>
*'''troughColorPart1:''' An integer of the trough color on the left/top side of the cursor, which can be converted by [[tocolor]].
*'''troughColorPart2:''' An integer of the trough color on the right/bottom side of the cursor, which can be converted by [[tocolor]].

===troughImageSectionMode===
This property will toggle section mode or stretch mode.
<syntaxhighlight lang="lua">dgsSetProperty(scrollbar,"troughImageSectionMode",troughImageSectionMode)</syntaxhighlight>
*'''troughImageSectionMode:''' A bool indicates whether to enable section mode of the image or keep stretch mode of the trough image.

===troughWidth===
This property adjusts the width of trough ( take vertical scroll bar as a standard ).
<syntaxhighlight lang="lua">dgsSetProperty(scrollbar,"troughWidth",{troughWidth,relative})</syntaxhighlight>
*'''troughWidth:''' A number of the width of arrow, which is affected by '''relative'''.
*'''relative:''' A bool of whether the width is relative or not. If this is true, then length must be between 0 and 1.

===troughImage===
The trough image of scroll bar.
<syntaxhighlight lang="lua">dgsSetProperty(scrollbar,"troughImage",troughImage)</syntaxhighlight>
*'''troughImage:''' A material element of the trough image of scroll bar.

===wheelReversed===
This property determines whether the increasing/decreasing direction is reversed when using mouse wheel.
<syntaxhighlight lang="lua">dgsSetProperty(scrollbar,"wheelReversed",wheelReversed)</syntaxhighlight>
*'''wheelReversed:''' A bool indicates whether the increasing/decreasing direction is reversed when using mouse wheel.

===isHorizontal===
This property determines whether the scroll bar is horizontal or vertical.
<syntaxhighlight lang="lua">dgsSetProperty(scrollbar,"isHorizontal",isHorizontal)</syntaxhighlight>
*'''isHorizontal:''' Available values are as follows:
**'''false:''' vertical
**'''true:''' horizontal

==See Also==
{{DGSPROPERTIES}}

Dgs-dxscrollbar

2024-09-02T01:20:28Z

Thisdp: /* length */

[[Dgs|DGS]] Properties is always used to change the gui style and make it more fantastic.

This page shows the properties of dgs-dxscrollbar that you could use.

==Main Functions==
*[[dgsSetProperty]]
*[[dgsGetProperty]]

==Properties==
===arrowWidth===
This property adjusts the width of arrow ( take vertical scroll bar as a standard ).
<syntaxhighlight lang="lua">dgsSetProperty(scrollbar,"arrowWidth",{arrowWidth,relative})</syntaxhighlight>
*'''arrowWidth:''' A number of the width of arrow, which is affected by '''relative'''.
*'''relative:''' A bool of whether the width is relative or not. If this is true, then length must be between 0 and 1.

===arrowColor===
The arrow color of scroll bar, includes normal, hovering, click.
<syntaxhighlight lang="lua">dgsSetProperty(scrollbar,"arrowColor",{arrowColorNormal,arrowColorHover,arrowColorClick})</syntaxhighlight>
*'''arrowColorNormal:''' An integer of the arrow color, which can be converted by [[tocolor]].
*'''arrowColorHover:''' An integer of the arrow color when the mouse's cursor is hovering on it, which can be converted by [[tocolor]].
*'''arrowColorClick:''' An integer of the arrow color when the arrow gets clicked, which can be converted by [[tocolor]].

===arrowImage===
The arrow image of scroll bar.
<syntaxhighlight lang="lua">dgsSetProperty(scrollbar,"arrowImage",arrowImage)</syntaxhighlight>
*'''arrowImage:''' A material element of the arrow image of scroll bar.

===cursorColor===
The cursor color of scroll bar, includes normal, hovering, click.
<syntaxhighlight lang="lua">dgsSetProperty(scrollbar,"cursorColor",{cursorColorNormal,cursorColorHover,cursorColorClick})</syntaxhighlight>
*'''cursorColorNormal:''' An integer of the cursor color, which can be converted by [[tocolor]].
*'''cursorColorHover:''' An integer of the cursor color when the mouse's cursor is hovering on it, which can be converted by [[tocolor]].
*'''cursorColorClick:''' An integer of the cursor color when the cursor gets clicked, which can be converted by [[tocolor]].

===cursorImage===
The cursor image of scroll bar.
<syntaxhighlight lang="lua">dgsSetProperty(scrollbar,"cursorImage",cursorImage)</syntaxhighlight>
*'''cursorImage:''' A material element of the cursor image of scroll bar.

===cursorWidth===
This property adjusts the width of cursor ( take vertical scroll bar as a standard ).
<syntaxhighlight lang="lua">dgsSetProperty(scrollbar,"cursorWidth",{cursorWidth,relative})</syntaxhighlight>
*'''cursorWidth:''' A number of the width of cursor, which is affected by '''relative'''.
*'''relative:''' A bool of whether the width is relative or not. If this is true, then length must be between 0 and 1.

===grades===
This property stores the grades of scroll bar. ''See [[dgsScrollBarSetGrades]]/[[dgsScrollBarGetGrades]]''
<syntaxhighlight lang="lua">dgsSetProperty(scrollbar,"grades",grades)</syntaxhighlight>
*'''grades:''' A number of the grades of scroll bar.

===currentGrade===
This property stores the current grade of scroll bar if ''grades'' enabled.
<syntaxhighlight lang="lua">dgsSetProperty(scrollbar,"currentGrade",currentGrade)</syntaxhighlight>
*'''currentGrade:''' A number of the current grade, ranges from 0 to ''grades''.

===image===
The image of scroll bar, includes arrow, cursor and trough.
<syntaxhighlight lang="lua">dgsSetProperty(scrollbar,"image",{arrowImage,cursorImage,troughImage})</syntaxhighlight>
*'''arrowImage:''' A texture of the image of arrow.
*'''cursorImage:''' A texture of the image of cursor.
*'''troughImage:''' A texture of the image of trough.

===imageRotation===
This property solves the problem of the rotation of the images.
<syntaxhighlight lang="lua">dgsSetProperty(scrollbar,"imageRotation",{Horizontal,Vertical})</syntaxhighlight>
*'''Horizontal:''' A table includes arrowImageRotation,cursorImageRotation,troughImageRotation of horizontal scroll bar, by default:
<syntaxhighlight lang="lua" >{0,270,270}</syntaxhighlight>
*'''Vertical:''' A table includes arrowImageRotation,cursorImageRotation,troughImageRotation of vertical scroll bar, by default:
<syntaxhighlight lang="lua" >{270,0,0}</syntaxhighlight>

===cursorLength===
This property determines whether the length of the cursor of scroll bar.
<syntaxhighlight lang="lua">dgsSetProperty(scrollbar,"cursorLength",{length,relative})</syntaxhighlight>
*'''cursorLength:''' A number of the length of scroll bar, which is affected by '''relative'''.
*'''relative:''' A bool of whether the length is relative or not. If this is true, then length must be between 0 and 1.

===locked===
This is equivalent to [[dgsScrollBarSetLocked]]/[[dgsScrollBarGetLocked]].
<syntaxhighlight lang="lua">dgsSetProperty(scrollbar,"locked",locked)</syntaxhighlight>
*'''locked:''' A bool of whether the scroll bar get locked or not.

===map===
This property will map the value from 0~100 to mapMin~mapMax (Both get and set scroll position).
<syntaxhighlight lang="lua">dgsSetProperty(scrollbar,"map",{mapMin,mapMax})</syntaxhighlight>
*'''mapMin:''' A number of the min value.
*'''mapMax:''' A number of the max value.

===multiplier===
This property determines whether how much a scroll bar will scroll when you click the arrow or use mouse wheel.

This property is difficult to understand. Before use this property, do an experiment first.
<syntaxhighlight lang="lua">dgsSetProperty(scrollbar,"multiplier",{multiplier,relative})</syntaxhighlight>
*'''multiplier:''' A number of the multiplier of scroll bar, which is affected by '''relative'''.
*'''relative:''' A bool of whether the multiplier is relative or not. If this is true, then multiplier must be between 0 and 1.

===scrollPosition===
This is equivalent to [[dgsScrollBarSetScrollPosition]]/[[dgsScrollBarGetScrollPosition]].
<syntaxhighlight lang="lua">dgsSetProperty(scrollbar,"scrollPosition",scrollPosition)</syntaxhighlight>
*'''scrollPosition:''' An integer of the scroll poisition of the scroll bar. Ranges from 0 to 100.

===scrollArrow===
This property indicates whether enable the scroll arrow or not. It is useful when making scroll bar act as slide or something else.
<syntaxhighlight lang="lua">dgsSetProperty(scrollbar,"scrollArrow",scrollArrow)</syntaxhighlight>
*'''scrollArrow:''' A bool of whether enable the scroll arrow or not.

===troughClickAction===
This property determines what will the scroll bar do when you click the trough.
<syntaxhighlight lang="lua">dgsSetProperty(scrollbar,"troughClickAction",troughClickAction)</syntaxhighlight>
*'''troughClickAction:''' A string. Available values are as follows:
**'''none:''' No actions.
**'''step:''' Step up or down.
**'''jump:''' Make cursor of scroll bar jump to the current place you click.

===troughColor===
The trough color of scroll bar.
<syntaxhighlight lang="lua">dgsSetProperty(scrollbar,"troughColor",{troughColorPart1,troughColorPart2})</syntaxhighlight>
*'''troughColorPart1:''' An integer of the trough color on the left/top side of the cursor, which can be converted by [[tocolor]].
*'''troughColorPart2:''' An integer of the trough color on the right/bottom side of the cursor, which can be converted by [[tocolor]].

===troughImageSectionMode===
This property will toggle section mode or stretch mode.
<syntaxhighlight lang="lua">dgsSetProperty(scrollbar,"troughImageSectionMode",troughImageSectionMode)</syntaxhighlight>
*'''troughImageSectionMode:''' A bool indicates whether to enable section mode of the image or keep stretch mode of the trough image.

===troughWidth===
This property adjusts the width of trough ( take vertical scroll bar as a standard ).
<syntaxhighlight lang="lua">dgsSetProperty(scrollbar,"troughWidth",{troughWidth,relative})</syntaxhighlight>
*'''troughWidth:''' A number of the width of arrow, which is affected by '''relative'''.
*'''relative:''' A bool of whether the width is relative or not. If this is true, then length must be between 0 and 1.

===troughImage===
The trough image of scroll bar.
<syntaxhighlight lang="lua">dgsSetProperty(scrollbar,"troughImage",troughImage)</syntaxhighlight>
*'''troughImage:''' A material element of the trough image of scroll bar.

===wheelReversed===
This property determines whether the increasing/decreasing direction is reversed when using mouse wheel.
<syntaxhighlight lang="lua">dgsSetProperty(scrollbar,"wheelReversed",wheelReversed)</syntaxhighlight>
*'''wheelReversed:''' A bool indicates whether the increasing/decreasing direction is reversed when using mouse wheel.

===isHorizontal===
This property determines whether the scroll bar is horizontal or vertical.
<syntaxhighlight lang="lua">dgsSetProperty(scrollbar,"isHorizontal",isHorizontal)</syntaxhighlight>
*'''isHorizontal:''' Available values are as follows:
**'''false:''' vertical
**'''true:''' horizontal

==See Also==
{{DGSPROPERTIES}}

DgsGridListSetSelectedItems

2024-06-30T07:54:38Z

Thisdp: /* Required Arguments */

{{Client function}}
__NOTOC__
This function selects multipile items in the specific dgs grid list.

==Syntax==
<syntaxhighlight lang="lua">
bool dgsGridListSetSelectedItems ( element gridList , table items )
</syntaxhighlight>

===Required Arguments===
*'''gridList:''' The dgs grid list which you want to select items in.
*'''items:''' The item table in this format ( the same as cegui's ) :
<syntaxhighlight lang="lua">
table = {
[1] = {
["column"] = columnID, -- has the first selected item's column ID
["row"] = rowID -- has the first selected item's row ID
},
[2] = {
["column"] = columnID, -- has the second selected item's column ID
["row"] = rowID -- has the second selected item's row ID
},
...
}
</syntaxhighlight>

===Returns===
Returns ''true'' if successful, ''false'' otherwise.

==Example==
<syntaxhighlight lang="lua">
DGS = exports.dgs
-- This example creates a grid list of all players and select an item at row 1 column 1.
playerWindow = DGS:dgsCreateWindow(526, 230, 291, 284, "", false)
gridlistPlayers = DGS:dgsCreateGridList(9, 23, 272, 201, false, playerWindow)
DGS:dgsGridListAddColumn(gridlistPlayers, "Players", 0.9)
DGS:dgsGridListSetSelectionMode(gridlistPlayers, 1) -- So can select many players
for _, players in ipairs(getElementsByType("player")) do
local row = DGS:dgsGridListAddRow(gridlistPlayers)
DGS:dgsGridListSetItemText(gridlistPlayers, row, 1, getPlayerName(players))
end
DGS:dgsGridListSetSelectedItems(gridlistPlayers,{
{
row = 1,
column = 1
},
})
</syntaxhighlight>

==See Also==
{{DGSFUNCTIONS}}

OnDgsMousePreClick

2024-06-02T05:21:54Z

Thisdp: /* Example */

{{Client event}}
__NOTOC__
This event happens when any dgs-element clicked
{{Note|The '''player''' who clicked the dgs-element is always the [[localPlayer]].}}
{{Note|If you want to ask why everything is triggered... See the forth parameter of [[addEventHandler]]}}
{{Note|This event is cancelable, which will affect the click effect and related events}}

==Parameters==
<syntaxhighlight lang="lua">
string button, string state, int absoluteX, int absoluteY, bool isCoolingDown
</syntaxhighlight>
*'''button:''' the name of the button which will be clicked , it can be ''left'', ''right'', ''middle''
*'''state:''' the state of the mouse button, will be ''down'' if the mouse button was pushed, or ''up'' if it was released. '''Please note currently both ''up'' and ''down'' state are supported.
*'''absoluteX:''' the X position of the mouse cursor, in pixels, measured from the left side of the screen.
*'''absoluteY:''' the Y position of the mouse cursor, in pixels, measured from the top of the screen.
*'''isCoolingDown:''' A bool indicates whether this dgs element is cooling down. See [[DGS_General_Basic_Properties#clickCoolDown|Property:clickCoolDown]]
==Source==
The [[event system#Event source|source]] of this event is the DGS element that was clicked.

==Example==
<syntaxhighlight lang="lua">
DGS = exports.dgs

btnOutput = DGS:dgsCreateButton( 0.7, 0.1, 0.2, 0.1, "Output!", true )
addEventHandler ( "onDgsMousePreClick", btnOutput, onPreClick )
addEventHandler ( "onDgsMouseClick", btnOutput, onClick )

state = false
function onPreClick ( button, state, x, y, isCoolingDown )
state = not state
if state then
outputChatBox("Pre Click Cancelled")
cancelEvent()
else
outputChatBox("Pre Click")
end
end

function onClick ( button, state ) --Event is canceled, no longer triggers
outputChatBox("Click")
end
</syntaxhighlight>

==See Also==
===DGS events===
{{DGSEVENTS}}
===Client event functions===
{{Client_event_functions}}

DGS General Basic Properties

2024-06-02T05:19:47Z

Thisdp: /* clickCoolDown */

[[Dgs|DGS]] Properties is always used to change the gui style and make it more fantastic.

This page shows the general properties of all dgs elements that you could use.

==Main Functions==
*[[dgsSetProperty]]
*[[dgsGetProperty]]

==Properties==
===alpha===
Require a number ranges from 0 to 1. This is equivalent to [[dgsSetAlpha]]/[[dgsGetAlpha]].
<syntaxhighlight lang="lua">dgsSetProperty(dgsElement,"alpha",alpha = 1)</syntaxhighlight>
*'''alpha:''' The visibility/transparency of the DGS element. Ranges from 0 (fully transparent) to 1 (fully opaque). Default value is 0.80.

===clickCoolDown===
This property is used to limit the click frequency to a specific dgs element.
<syntaxhighlight lang="lua">dgsSetProperty(dgsElement,"clickCoolDown",clickCoolDown = false)</syntaxhighlight>
*'''clickCoolDown:''' A number indicates how long you want to limit the click (ms). Set to ''false'' to disable this.

===changeOrder===
Require a bool indicates whether the layer will be changed when being brought to front ( or clicked ).
<syntaxhighlight lang="lua">dgsSetProperty(dgsElement,"changeOrder",changeOrder = true)</syntaxhighlight>
*'''changeOrder:''' A bool indicates whether the layer will be changed when being brought to front ( or clicked ).

===debugTrace===
This property stores the "debug tracing data" includes in which lua '''file''' and '''line''' the specific dgs element created (Only available using '''loadstring(exports.dgs:dgsImportFunction())()'''.
<syntaxhighlight lang="lua">dgsSetProperty(dgsElement,"debugTrace",debugTrace)</syntaxhighlight>
*'''debugTrace:''' A table stores creation data. Structure is as follows:
<syntaxhighlight lang="lua">
{
file=filePath,
line=lineNum,
fncName=functionName,
}
</syntaxhighlight>

===enabled===
Requires a bool value. This is equivalent to [[dgsSetEnabled]]/[[dgsGetEnabled]].
<syntaxhighlight lang="lua">dgsSetProperty(dgsElement,"enabled",enabled)</syntaxhighlight>
*'''enabled:''' The state.

===enableFullEnterLeaveCheck===
Requires a bool value. This determines if target dgs element will have full check of mouse enter/leave. And you should use [[onDgsElementEnter]]/[[onDgsElementLeave]] instead of [[onDgsMouseEnter]]/[[onDgsMouseLeave]].
<syntaxhighlight lang="lua">dgsSetProperty(dgsElement,"enableFullEnterLeaveCheck",enableFullEnterLeaveCheck)</syntaxhighlight>
*'''enableFullEnterLeaveCheck:''' The state.

===functionRunBefore===
Requires a bool value. Set whether the function runs before rendering or after rendering (see property '''functions''').
<syntaxhighlight lang="lua">dgsSetProperty(dgsElement,"functionRunBefore",functionRunBefore)</syntaxhighlight>
*'''functionRunBefore:''' Set to true, and the function will run before rendering. Set to false, and the function will run after rendering.

===functions===
Requires a string at the 3rd argument. This property runs a function while rendering.

'''Predefine Variable'''
*'''self:''' The DGS Element itself.

See example in [[dgsSetProperty]]
<syntaxhighlight lang="lua">dgsSetProperty(dgsElement,"functions",fncString,arg1,arg2,...)</syntaxhighlight>
*'''fncString:''' The string of function to be loaded.
*'''arg1:''' argument 1
*'''arg2:''' argument 2
*'''...:''' other arguments

===childOutsideHit===
Requires a bool value. Set whether children elements are clickable when they are outside of their parent element.
<syntaxhighlight lang="lua">dgsSetProperty(dgsElement,"childOutsideHit",childOutsideHit = false)</syntaxhighlight>
*'''childOutsideHit:''' If set to true, the dgsElement's child elements are clickable even though they are not inside the bounding box of dgsElement.

===ignoreParentTitle===
Requires a bool value. Set whether to ignore the title of dgs-dxwindow.
<syntaxhighlight lang="lua">dgsSetProperty(dgsElement,"ignoreParentTitle",ignoreParentTitle = false)</syntaxhighlight>
*'''ignoreParentTitle:''' Set to true to ignore the title of dgs-dxwindow if its parent is a dgs-dxwindow . Set to false to disable it, which means the y position of dgsElement in dgs-dxwindow will start to be calculated under the title.

===mouseButtons===
This property defines the specific mouse buttons that can be used to click on the element.
Syntax:
<syntaxhighlight lang="lua">dgsSetProperty(dgsElement, "mouseButtons", {bool left, bool right, bool middle})</syntaxhighlight>
*'''left''': Set this true to enable clicking with the left mouse button. Set it to false to disable clicking with the left mouse button.
*'''right''': Set this to true to enable clicking with the right mouse button. Set it to false to disable clicking with the right mouse button.
*'''middle''': Set this value to true to enable clicking with the middle mouse button. Set it to false to disable clicking with the middle mouse button.

===outline===
The border line of the bounding box of dgs element.
<syntaxhighlight lang="lua">dgsSetProperty(dgsElement,"outline",{side,width,color,left,right,top,bottom})</syntaxhighlight>
*'''side''' : A string indicates which side the outline will attach to. The available values are as follows:
**'''in'''
**'''center'''
**'''out'''
*'''width''': The width of the outline.
*'''color''': The color of the outline, which can be transformed by [[tocolor]].
*'''left''': Set '''true''' to show outline in the left, and '''false''' to hide it. (Default is '''true''' if not set)
*'''right''': Set '''true''' to show the outline in the right, and '''false''' to hide it. (Default is '''true''' if not set)
*'''top''': Set '''true''' to show the outline at the top, and '''false''' to hide it. (Default is '''true''' if not set)
*'''bottom''': Set '''true''' to show the outline at the bottom, and '''false''' to hide it. (Default is '''true''' if not set)

===renderEventCall===
Requires a bool value. Set whether [[onDgsElementRender]] is triggered when rendering. (Don't always enable this, or it will cause severely performance decrease)
<syntaxhighlight lang="lua">dgsSetProperty(dgsElement,"renderEventCall",renderEventCall = false)</syntaxhighlight>
*'''renderEventCall:''' Set to true to enable, and false to disable.

===postGUI===
Requires a bool value. Set whether the dgs element is post gui when render settings "postGUI" is ''nil''(automatic).
<syntaxhighlight lang="lua">dgsSetProperty(dgsElement,"postGUI",postGUI)</syntaxhighlight>
*'''postGUI:''' Set to true to enable post gui, or it wil under gui.

===visible===
This property change the visibility of a dgs element. This is equivalent to [[dgsSetVisible]]/[[dgsGetVisible]].
<syntaxhighlight lang="lua">dgsSetProperty(dgsElement,"visible",visible)</syntaxhighlight>
*'''visible:''' A bool indicates whether the dgs element is visible or not.

==See Also==
{{DGSPROPERTIES}}

OnDgsMousePreClick

2024-05-12T07:12:25Z

Thisdp: /* Example */

{{Client event}}
__NOTOC__
This event happens when any dgs-element clicked
{{Note|The '''player''' who clicked the dgs-element is always the [[localPlayer]].}}
{{Note|If you want to ask why everything is triggered... See the forth parameter of [[addEventHandler]]}}
{{Note|This event is cancelable, which will affect the click effect and related events}}

==Parameters==
<syntaxhighlight lang="lua">
string button, string state, int absoluteX, int absoluteY, bool isCoolingDown
</syntaxhighlight>
*'''button:''' the name of the button which will be clicked , it can be ''left'', ''right'', ''middle''
*'''state:''' the state of the mouse button, will be ''down'' if the mouse button was pushed, or ''up'' if it was released. '''Please note currently both ''up'' and ''down'' state are supported.
*'''absoluteX:''' the X position of the mouse cursor, in pixels, measured from the left side of the screen.
*'''absoluteY:''' the Y position of the mouse cursor, in pixels, measured from the top of the screen.
*'''isCoolingDown:''' A bool indicates whether this dgs element is cooling down. See [[DGS_General_Basic_Properties#clickCoolDown|Property:clickCoolDown]]
==Source==
The [[event system#Event source|source]] of this event is the DGS element that was clicked.

==Example==
<syntaxhighlight lang="lua">
DGS = exports.dgs

btnOutput = DGS:dgsCreateButton( 0.7, 0.1, 0.2, 0.1, "Output!", true )
DGS:dgsSetProperty( btnOutput , "clickCoolDown", 1000 ) --Cool Down 1s
addEventHandler ( "onDgsMousePreClick", btnOutput, onPreClick )
addEventHandler ( "onDgsMouseClick", btnOutput, onClick )

function onPreClick ( button, state, x, y, isCoolingDown )
if isCoolingDown then
outputChatBox("Cooling Down, Cancelled")
cancelEvent()
else
outputChatBox("Pre Click")
end
end

function onClick ( button, state ) --Event is canceled, no longer triggers
outputChatBox("Click")
end
</syntaxhighlight>

==See Also==
===DGS events===
{{DGSEVENTS}}
===Client event functions===
{{Client_event_functions}}

DGS General Basic Properties

2024-05-12T07:08:26Z

Thisdp: /* clickCoolDown */

[[Dgs|DGS]] Properties is always used to change the gui style and make it more fantastic.

This page shows the general properties of all dgs elements that you could use.

==Main Functions==
*[[dgsSetProperty]]
*[[dgsGetProperty]]

==Properties==
===alpha===
Require a number ranges from 0 to 1. This is equivalent to [[dgsSetAlpha]]/[[dgsGetAlpha]].
<syntaxhighlight lang="lua">dgsSetProperty(dgsElement,"alpha",alpha = 1)</syntaxhighlight>
*'''alpha:''' The visibility/transparency of the DGS element. Ranges from 0 (fully transparent) to 1 (fully opaque). Default value is 0.80.

===clickCoolDown===
This property is used to limit the click frequency to a specific dgs element. This should work with [[onDgsMousePreClick]]/[[onDgsMouseClick]].
<syntaxhighlight lang="lua">dgsSetProperty(dgsElement,"clickCoolDown",clickCoolDown = false)</syntaxhighlight>
*'''clickCoolDown:''' A number indicates how long you want to limit the click (ms). Set to ''false'' to disable this.

===changeOrder===
Require a bool indicates whether the layer will be changed when being brought to front ( or clicked ).
<syntaxhighlight lang="lua">dgsSetProperty(dgsElement,"changeOrder",changeOrder = true)</syntaxhighlight>
*'''changeOrder:''' A bool indicates whether the layer will be changed when being brought to front ( or clicked ).

===debugTrace===
This property stores the "debug tracing data" includes in which lua '''file''' and '''line''' the specific dgs element created (Only available using '''loadstring(exports.dgs:dgsImportFunction())()'''.
<syntaxhighlight lang="lua">dgsSetProperty(dgsElement,"debugTrace",debugTrace)</syntaxhighlight>
*'''debugTrace:''' A table stores creation data. Structure is as follows:
<syntaxhighlight lang="lua">
{
file=filePath,
line=lineNum,
fncName=functionName,
}
</syntaxhighlight>

===enabled===
Requires a bool value. This is equivalent to [[dgsSetEnabled]]/[[dgsGetEnabled]].
<syntaxhighlight lang="lua">dgsSetProperty(dgsElement,"enabled",enabled)</syntaxhighlight>
*'''enabled:''' The state.

===enableFullEnterLeaveCheck===
Requires a bool value. This determines if target dgs element will have full check of mouse enter/leave. And you should use [[onDgsElementEnter]]/[[onDgsElementLeave]] instead of [[onDgsMouseEnter]]/[[onDgsMouseLeave]].
<syntaxhighlight lang="lua">dgsSetProperty(dgsElement,"enableFullEnterLeaveCheck",enableFullEnterLeaveCheck)</syntaxhighlight>
*'''enableFullEnterLeaveCheck:''' The state.

===functionRunBefore===
Requires a bool value. Set whether the function runs before rendering or after rendering (see property '''functions''').
<syntaxhighlight lang="lua">dgsSetProperty(dgsElement,"functionRunBefore",functionRunBefore)</syntaxhighlight>
*'''functionRunBefore:''' Set to true, and the function will run before rendering. Set to false, and the function will run after rendering.

===functions===
Requires a string at the 3rd argument. This property runs a function while rendering.

'''Predefine Variable'''
*'''self:''' The DGS Element itself.

See example in [[dgsSetProperty]]
<syntaxhighlight lang="lua">dgsSetProperty(dgsElement,"functions",fncString,arg1,arg2,...)</syntaxhighlight>
*'''fncString:''' The string of function to be loaded.
*'''arg1:''' argument 1
*'''arg2:''' argument 2
*'''...:''' other arguments

===childOutsideHit===
Requires a bool value. Set whether children elements are clickable when they are outside of their parent element.
<syntaxhighlight lang="lua">dgsSetProperty(dgsElement,"childOutsideHit",childOutsideHit = false)</syntaxhighlight>
*'''childOutsideHit:''' If set to true, the dgsElement's child elements are clickable even though they are not inside the bounding box of dgsElement.

===ignoreParentTitle===
Requires a bool value. Set whether to ignore the title of dgs-dxwindow.
<syntaxhighlight lang="lua">dgsSetProperty(dgsElement,"ignoreParentTitle",ignoreParentTitle = false)</syntaxhighlight>
*'''ignoreParentTitle:''' Set to true to ignore the title of dgs-dxwindow if its parent is a dgs-dxwindow . Set to false to disable it, which means the y position of dgsElement in dgs-dxwindow will start to be calculated under the title.

===mouseButtons===
This property defines the specific mouse buttons that can be used to click on the element.
Syntax:
<syntaxhighlight lang="lua">dgsSetProperty(dgsElement, "mouseButtons", {bool left, bool right, bool middle})</syntaxhighlight>
*'''left''': Set this true to enable clicking with the left mouse button. Set it to false to disable clicking with the left mouse button.
*'''right''': Set this to true to enable clicking with the right mouse button. Set it to false to disable clicking with the right mouse button.
*'''middle''': Set this value to true to enable clicking with the middle mouse button. Set it to false to disable clicking with the middle mouse button.

===outline===
The border line of the bounding box of dgs element.
<syntaxhighlight lang="lua">dgsSetProperty(dgsElement,"outline",{side,width,color,left,right,top,bottom})</syntaxhighlight>
*'''side''' : A string indicates which side the outline will attach to. The available values are as follows:
**'''in'''
**'''center'''
**'''out'''
*'''width''': The width of the outline.
*'''color''': The color of the outline, which can be transformed by [[tocolor]].
*'''left''': Set '''true''' to show outline in the left, and '''false''' to hide it. (Default is '''true''' if not set)
*'''right''': Set '''true''' to show the outline in the right, and '''false''' to hide it. (Default is '''true''' if not set)
*'''top''': Set '''true''' to show the outline at the top, and '''false''' to hide it. (Default is '''true''' if not set)
*'''bottom''': Set '''true''' to show the outline at the bottom, and '''false''' to hide it. (Default is '''true''' if not set)

===renderEventCall===
Requires a bool value. Set whether [[onDgsElementRender]] is triggered when rendering. (Don't always enable this, or it will cause severely performance decrease)
<syntaxhighlight lang="lua">dgsSetProperty(dgsElement,"renderEventCall",renderEventCall = false)</syntaxhighlight>
*'''renderEventCall:''' Set to true to enable, and false to disable.

===postGUI===
Requires a bool value. Set whether the dgs element is post gui when render settings "postGUI" is ''nil''(automatic).
<syntaxhighlight lang="lua">dgsSetProperty(dgsElement,"postGUI",postGUI)</syntaxhighlight>
*'''postGUI:''' Set to true to enable post gui, or it wil under gui.

===visible===
This property change the visibility of a dgs element. This is equivalent to [[dgsSetVisible]]/[[dgsGetVisible]].
<syntaxhighlight lang="lua">dgsSetProperty(dgsElement,"visible",visible)</syntaxhighlight>
*'''visible:''' A bool indicates whether the dgs element is visible or not.

==See Also==
{{DGSPROPERTIES}}

DGS General Basic Properties

2024-05-12T07:08:03Z

Thisdp: /* clickCoolDown */

[[Dgs|DGS]] Properties is always used to change the gui style and make it more fantastic.

This page shows the general properties of all dgs elements that you could use.

==Main Functions==
*[[dgsSetProperty]]
*[[dgsGetProperty]]

==Properties==
===alpha===
Require a number ranges from 0 to 1. This is equivalent to [[dgsSetAlpha]]/[[dgsGetAlpha]].
<syntaxhighlight lang="lua">dgsSetProperty(dgsElement,"alpha",alpha = 1)</syntaxhighlight>
*'''alpha:''' The visibility/transparency of the DGS element. Ranges from 0 (fully transparent) to 1 (fully opaque). Default value is 0.80.

===clickCoolDown===
This property is used to limit the click frequency to a specific dgs element. This should work with [[onDgsMousePreClick]].
<syntaxhighlight lang="lua">dgsSetProperty(dgsElement,"clickCoolDown",clickCoolDown = false)</syntaxhighlight>
*'''clickCoolDown:''' A number indicates how long you want to limit the click (ms). Set to ''false'' to disable this.

===changeOrder===
Require a bool indicates whether the layer will be changed when being brought to front ( or clicked ).
<syntaxhighlight lang="lua">dgsSetProperty(dgsElement,"changeOrder",changeOrder = true)</syntaxhighlight>
*'''changeOrder:''' A bool indicates whether the layer will be changed when being brought to front ( or clicked ).

===debugTrace===
This property stores the "debug tracing data" includes in which lua '''file''' and '''line''' the specific dgs element created (Only available using '''loadstring(exports.dgs:dgsImportFunction())()'''.
<syntaxhighlight lang="lua">dgsSetProperty(dgsElement,"debugTrace",debugTrace)</syntaxhighlight>
*'''debugTrace:''' A table stores creation data. Structure is as follows:
<syntaxhighlight lang="lua">
{
file=filePath,
line=lineNum,
fncName=functionName,
}
</syntaxhighlight>

===enabled===
Requires a bool value. This is equivalent to [[dgsSetEnabled]]/[[dgsGetEnabled]].
<syntaxhighlight lang="lua">dgsSetProperty(dgsElement,"enabled",enabled)</syntaxhighlight>
*'''enabled:''' The state.

===enableFullEnterLeaveCheck===
Requires a bool value. This determines if target dgs element will have full check of mouse enter/leave. And you should use [[onDgsElementEnter]]/[[onDgsElementLeave]] instead of [[onDgsMouseEnter]]/[[onDgsMouseLeave]].
<syntaxhighlight lang="lua">dgsSetProperty(dgsElement,"enableFullEnterLeaveCheck",enableFullEnterLeaveCheck)</syntaxhighlight>
*'''enableFullEnterLeaveCheck:''' The state.

===functionRunBefore===
Requires a bool value. Set whether the function runs before rendering or after rendering (see property '''functions''').
<syntaxhighlight lang="lua">dgsSetProperty(dgsElement,"functionRunBefore",functionRunBefore)</syntaxhighlight>
*'''functionRunBefore:''' Set to true, and the function will run before rendering. Set to false, and the function will run after rendering.

===functions===
Requires a string at the 3rd argument. This property runs a function while rendering.

'''Predefine Variable'''
*'''self:''' The DGS Element itself.

See example in [[dgsSetProperty]]
<syntaxhighlight lang="lua">dgsSetProperty(dgsElement,"functions",fncString,arg1,arg2,...)</syntaxhighlight>
*'''fncString:''' The string of function to be loaded.
*'''arg1:''' argument 1
*'''arg2:''' argument 2
*'''...:''' other arguments

===childOutsideHit===
Requires a bool value. Set whether children elements are clickable when they are outside of their parent element.
<syntaxhighlight lang="lua">dgsSetProperty(dgsElement,"childOutsideHit",childOutsideHit = false)</syntaxhighlight>
*'''childOutsideHit:''' If set to true, the dgsElement's child elements are clickable even though they are not inside the bounding box of dgsElement.

===ignoreParentTitle===
Requires a bool value. Set whether to ignore the title of dgs-dxwindow.
<syntaxhighlight lang="lua">dgsSetProperty(dgsElement,"ignoreParentTitle",ignoreParentTitle = false)</syntaxhighlight>
*'''ignoreParentTitle:''' Set to true to ignore the title of dgs-dxwindow if its parent is a dgs-dxwindow . Set to false to disable it, which means the y position of dgsElement in dgs-dxwindow will start to be calculated under the title.

===mouseButtons===
This property defines the specific mouse buttons that can be used to click on the element.
Syntax:
<syntaxhighlight lang="lua">dgsSetProperty(dgsElement, "mouseButtons", {bool left, bool right, bool middle})</syntaxhighlight>
*'''left''': Set this true to enable clicking with the left mouse button. Set it to false to disable clicking with the left mouse button.
*'''right''': Set this to true to enable clicking with the right mouse button. Set it to false to disable clicking with the right mouse button.
*'''middle''': Set this value to true to enable clicking with the middle mouse button. Set it to false to disable clicking with the middle mouse button.

===outline===
The border line of the bounding box of dgs element.
<syntaxhighlight lang="lua">dgsSetProperty(dgsElement,"outline",{side,width,color,left,right,top,bottom})</syntaxhighlight>
*'''side''' : A string indicates which side the outline will attach to. The available values are as follows:
**'''in'''
**'''center'''
**'''out'''
*'''width''': The width of the outline.
*'''color''': The color of the outline, which can be transformed by [[tocolor]].
*'''left''': Set '''true''' to show outline in the left, and '''false''' to hide it. (Default is '''true''' if not set)
*'''right''': Set '''true''' to show the outline in the right, and '''false''' to hide it. (Default is '''true''' if not set)
*'''top''': Set '''true''' to show the outline at the top, and '''false''' to hide it. (Default is '''true''' if not set)
*'''bottom''': Set '''true''' to show the outline at the bottom, and '''false''' to hide it. (Default is '''true''' if not set)

===renderEventCall===
Requires a bool value. Set whether [[onDgsElementRender]] is triggered when rendering. (Don't always enable this, or it will cause severely performance decrease)
<syntaxhighlight lang="lua">dgsSetProperty(dgsElement,"renderEventCall",renderEventCall = false)</syntaxhighlight>
*'''renderEventCall:''' Set to true to enable, and false to disable.

===postGUI===
Requires a bool value. Set whether the dgs element is post gui when render settings "postGUI" is ''nil''(automatic).
<syntaxhighlight lang="lua">dgsSetProperty(dgsElement,"postGUI",postGUI)</syntaxhighlight>
*'''postGUI:''' Set to true to enable post gui, or it wil under gui.

===visible===
This property change the visibility of a dgs element. This is equivalent to [[dgsSetVisible]]/[[dgsGetVisible]].
<syntaxhighlight lang="lua">dgsSetProperty(dgsElement,"visible",visible)</syntaxhighlight>
*'''visible:''' A bool indicates whether the dgs element is visible or not.

==See Also==
{{DGSPROPERTIES}}

DgsCreateQuad

2024-05-05T07:51:51Z

Thisdp:

File:DGS Quadrilateral 1.png

2024-05-05T07:51:06Z

Thisdp:

DgsCreateQuad

2024-05-05T07:50:19Z

Thisdp:

__NOTOC__
{{Client function}}
>>>Warning: This feature requires pixel shader model 2_a<<<

This function creates a quadrilateral shader that can be used for dgs elements.

==Syntax==
<syntaxhighlight lang="lua">
element dgsCreateQuad( table corners [, int color = 0xFFFFFFFF, texture background = nil, bool colorOverwritten = true ] )
</syntaxhighlight>

[[Image:DGS_Quadrilateral_1.png|300px|thumb|Example Rounded Rectangle]]
===Required Arguments===
*'''corners :''' A table of the corners of the quadrilateral. The structure is as follows:
<syntaxhighlight lang="lua">
{
{ float LeftTopX, float LeftTopY, bool relative },
{ float RightTopX, float RightTopY, bool relative },
{ float RightBottomX, float RightBottomY, bool relative },
{ float LeftBottomX, float LeftBottomY, bool relative },
}
</syntaxhighlight>

===Optional Arguments===
{{OptionalArg}}
*'''color''': An int of the color of the quadrilateral.
*'''background''': A texture element of the background of the quadrilateral.
*'''colorOverwritten''': A bool indicates whether the final color will be overwritten by '''color ''' or the product of render color and '''color''' (resultColor = render color * '''color''') when rendering.

===Returns===
Returns a dgs-dxquad element (dgs Type)/ shader (element Type) if succeed, ''false'' otherwise

==Example==
<syntaxhighlight lang="lua">
DGS = exports.dgs --get exported functions from dgs

local rndRect = DGS:dgsCreateRoundRect(50,false,tocolor(0,0,0,150)) --Create Rounded Rectangle with 50 pixels radius
local image1 = DGS:dgsCreateImage(200,200,400,100,rndRect,false) --Apply it to the dgs image
</syntaxhighlight>

==Syntax==
<syntaxhighlight lang="lua">
element dgsCreateRoundRect( table multiArguments [, int color = 0xFFFFFFFF, texture background = nil, bool colorOverwritten = true, bool/int border = false, float borderHorizontalThickness, float borderVerticalThickness ] )
</syntaxhighlight>

===Required Arguments===
*'''multiArguments :''' A table contains at least 1 group of the radius of the corner. The structure is as follows:
<syntaxhighlight lang="lua">
{
{ float LeftTopRadius, bool relative },
{ float RightTopRadius, bool relative },
{ float RightBottomRadius, bool relative },
{ float LeftBottomRadius, bool relative },
}
</syntaxhighlight>

===Optional Arguments===
{{OptionalArg}}
*'''color :''' An int of the color of the rounded rectangle.
*'''background:''' A texture element of the background of the rounded rectangle.
*'''colorOverwritten :''' A bool indicates whether the final color will be overwritten by '''color ''' or the product of render color and '''color''' when rendering.

===Returns===
Returns a dgs-dxquad element (dgs Type)/ shader (element Type) if succeed, ''false'' otherwise

==Example==
<syntaxhighlight lang="lua">
DGS = exports.dgs --get exported functions from dgs

local quad = dgsCreateQuad({
{20,10,false},
{80,10,false},
{90,90,false},
{10,90,false},
},tocolor(255,255,255,100))
dgsQuadSetColorOverwritten(quad,false)

local btn = dgsCreateButton(500,400,400,50,"Button",false)
dgsSetProperty(btn,"image",quad)

</syntaxhighlight>
==See Also==
{{DGSFUNCTIONS}}

DgsCreateQuad

2024-05-05T07:45:09Z

Thisdp: Created page with "__NOTOC__ {{Client function}} >>>Warning: This feature requires pixel shader model 2_a<<< This function creates a quadrilateral shader that can be used for dgs elements. ==Syntax== <syntaxhighlight lang="lua"> element dgsCreateQuad( table corners [, int color = 0xFFFFFFFF, texture background = nil, bool colorOverwritten = true ] ) </syntaxhighlight> Image:DGS_Rounded_Rectangle.png|300px|thumb..."

__NOTOC__
{{Client function}}
>>>Warning: This feature requires pixel shader model 2_a<<<

This function creates a quadrilateral shader that can be used for dgs elements.

==Syntax==
<syntaxhighlight lang="lua">
element dgsCreateQuad( table corners [, int color = 0xFFFFFFFF, texture background = nil, bool colorOverwritten = true ] )
</syntaxhighlight>

[[Image:DGS_Rounded_Rectangle.png|300px|thumb|Example Rounded Rectangle]]
===Required Arguments===
*'''corners :''' A table of the corners of the quadrilateral. The structure is as follows:
<syntaxhighlight lang="lua">
{
{ float LeftTopX, float LeftTopY, bool relative },
{ float RightTopX, float RightTopY, bool relative },
{ float RightBottomX, float RightBottomY, bool relative },
{ float LeftBottomX, float LeftBottomY, bool relative },
}
</syntaxhighlight>

===Optional Arguments===
{{OptionalArg}}
*'''color''': An int of the color of the quadrilateral.
*'''background''': A texture element of the background of the quadrilateral.
*'''colorOverwritten''': A bool indicates whether the final color will be overwritten by '''color ''' or the product of render color and '''color''' (resultColor = render color * '''color''') when rendering.

===Returns===
Returns a dgs-dxroundrectangle element (dgs Type)/ shader (element Type) if succeed, ''false'' otherwise

==Example==
<syntaxhighlight lang="lua">
DGS = exports.dgs --get exported functions from dgs

local rndRect = DGS:dgsCreateRoundRect(50,false,tocolor(0,0,0,150)) --Create Rounded Rectangle with 50 pixels radius
local image1 = DGS:dgsCreateImage(200,200,400,100,rndRect,false) --Apply it to the dgs image
</syntaxhighlight>

==Syntax==
<syntaxhighlight lang="lua">
element dgsCreateRoundRect( table multiArguments [, int color = 0xFFFFFFFF, texture background = nil, bool colorOverwritten = true, bool/int border = false, float borderHorizontalThickness, float borderVerticalThickness ] )
</syntaxhighlight>

===Required Arguments===
*'''multiArguments :''' A table contains at least 1 group of the radius of the corner. The structure is as follows:
<syntaxhighlight lang="lua">
{
{ float LeftTopRadius, bool relative },
{ float RightTopRadius, bool relative },
{ float RightBottomRadius, bool relative },
{ float LeftBottomRadius, bool relative },
}
</syntaxhighlight>

===Optional Arguments===
{{OptionalArg}}
*'''color :''' An int of the color of the rounded rectangle.
*'''background:''' A texture element of the background of the rounded rectangle.
*'''colorOverwritten :''' A bool indicates whether the final color will be overwritten by '''color ''' or the product of render color and '''color''' when rendering.

===Returns===
Returns a dgs-dxquad element (dgs Type)/ shader (element Type) if succeed, ''false'' otherwise

==Example==
<syntaxhighlight lang="lua">
DGS = exports.dgs --get exported functions from dgs

local quad = dgsCreateQuad({
{20,10,false},
{80,10,false},
{90,90,false},
{10,90,false},
},tocolor(255,255,255,100))
dgsQuadSetColorOverwritten(quad,false)

local btn = dgsCreateButton(500,400,400,50,"Button",false)
dgsSetProperty(btn,"image",quad)

</syntaxhighlight>
==See Also==
{{DGSFUNCTIONS}}

Template:DGSFUNCTIONS

2024-03-24T11:31:41Z

Thisdp: /* Basic Shape Plugin */

__NOTOC__
{{DGS General Functions}}

==Custom Cursor Functions==
{{DGS Custom Cursor Functions}}

==[[DGS_Multilingual|Multi Language Supports]]==
{{DGS Multi Language Supports Functions}}

==Animation==
{{DGS Animation Functions}}

==3D Element==
{{DGS 3D Element Functions}}

==3D Interface==
{{DGS 3D Interface Functions}}

==3D Line==
{{DGS 3D Line Functions}}

==3D Image==
{{DGS 3D Image Functions}}

==3D Text==
{{DGS 3D Text Functions}}

==Browser==
{{DGS Browser Functions}}

==Button==
{{DGS Button Functions}}

==Check Box==
{{DGS Check Box Functions}}

==Combo Box==
{{DGS Combo Box Functions}}

==Custom Renderer==
{{Template:DGS Custom Renderer Functions}}

==Edit==
{{DGS Edit Functions}}

==Detect Area==
{{DGS Detect Area Functions}}

==Drag'N Drop==
{{DGS Drag'N Drop Functions}}

==Grid List==
{{DGS GridList Functions}}

==Image==
{{DGS Image Functions}}

==Memo==
{{DGS Memo Functions}}

==Menu==
{{DGS Menu Functions}}

==Label==
{{DGS Label Functions}}

==Layout==
{{DGS Layout Functions}}

==Line==
{{DGS Line Functions}}

==Progress Bar==
{{DGS Progress Bar Functions}}

==Radio Button==
{{DGS Radio Button Functions}}

==Scale Pane==
{{DGS Scale Pane Functions}}

==Scroll Bar==
{{DGS Scroll Bar Functions}}

==Scroll Pane==
{{DGS Scroll Pane Functions}}

==Selector==
{{DGS Selector Functions}}

==Style==
{{DGS Style Functions}}

==Switch Button==
{{DGS Switch Button Functions}}

==Tab Panel==
{{DGS Tab Panel Functions}}

==Window==
{{DGS Window Functions}}

==Basic Shape Plugins==

===Circle===
{{DGS Plugin/Circle}}

===Quadrilateral===
{{DGS Plugin/Quadrilateral Functions}}

===Rounded Rectangle===
{{DGS Plugin/Rounded Rectangle Functions}}

==Other Plugins==

===Blur Box===
{{DGS Plugin/Blur Box}}

===Canvas===
{{DGS Plugin/Canvas}}

===Chart===
{{DGS Plugin/Chart}}

===Color Picker===
{{DGS Plugin/Color Picker}}

===Effect 3D===
{{DGS Plugin/Effect 3D}}

===Gradient===
{{DGS Plugin/Gradient}}

===Mask===
{{DGS Plugin/Mask}}

===Media Browser===
{{DGS Plugin/Media Browser}}

===Nine Slice===
{{DGS Plugin/Nine Slice}}

===Object Preview Supports===
{{DGS Plugin/Object Preview Functions}}

===Paste Handler===
{{DGS Plugin/Paste Handler Functions}}

===QRCode===
{{DGS Plugin/QRCode Functions}}

===Remote Image===
{{DGS Plugin/Remote Image Functions}}

===Screen Source===
{{DGS Plugin/Screen Source Functions}}

===SVG===
{{DGS Plugin/SVG}}

===Tooltips===
{{DGS Plugin/Tooltips}}

Template:DGSFUNCTIONS

2024-03-24T11:31:35Z

Thisdp: /* Plugin */

__NOTOC__
{{DGS General Functions}}

==Custom Cursor Functions==
{{DGS Custom Cursor Functions}}

==[[DGS_Multilingual|Multi Language Supports]]==
{{DGS Multi Language Supports Functions}}

==Animation==
{{DGS Animation Functions}}

==3D Element==
{{DGS 3D Element Functions}}

==3D Interface==
{{DGS 3D Interface Functions}}

==3D Line==
{{DGS 3D Line Functions}}

==3D Image==
{{DGS 3D Image Functions}}

==3D Text==
{{DGS 3D Text Functions}}

==Browser==
{{DGS Browser Functions}}

==Button==
{{DGS Button Functions}}

==Check Box==
{{DGS Check Box Functions}}

==Combo Box==
{{DGS Combo Box Functions}}

==Custom Renderer==
{{Template:DGS Custom Renderer Functions}}

==Edit==
{{DGS Edit Functions}}

==Detect Area==
{{DGS Detect Area Functions}}

==Drag'N Drop==
{{DGS Drag'N Drop Functions}}

==Grid List==
{{DGS GridList Functions}}

==Image==
{{DGS Image Functions}}

==Memo==
{{DGS Memo Functions}}

==Menu==
{{DGS Menu Functions}}

==Label==
{{DGS Label Functions}}

==Layout==
{{DGS Layout Functions}}

==Line==
{{DGS Line Functions}}

==Progress Bar==
{{DGS Progress Bar Functions}}

==Radio Button==
{{DGS Radio Button Functions}}

==Scale Pane==
{{DGS Scale Pane Functions}}

==Scroll Bar==
{{DGS Scroll Bar Functions}}

==Scroll Pane==
{{DGS Scroll Pane Functions}}

==Selector==
{{DGS Selector Functions}}

==Style==
{{DGS Style Functions}}

==Switch Button==
{{DGS Switch Button Functions}}

==Tab Panel==
{{DGS Tab Panel Functions}}

==Window==
{{DGS Window Functions}}

==Basic Shape Plugin==

===Circle===
{{DGS Plugin/Circle}}

===Quadrilateral===
{{DGS Plugin/Quadrilateral Functions}}

===Rounded Rectangle===
{{DGS Plugin/Rounded Rectangle Functions}}

==Other Plugins==

===Blur Box===
{{DGS Plugin/Blur Box}}

===Canvas===
{{DGS Plugin/Canvas}}

===Chart===
{{DGS Plugin/Chart}}

===Color Picker===
{{DGS Plugin/Color Picker}}

===Effect 3D===
{{DGS Plugin/Effect 3D}}

===Gradient===
{{DGS Plugin/Gradient}}

===Mask===
{{DGS Plugin/Mask}}

===Media Browser===
{{DGS Plugin/Media Browser}}

===Nine Slice===
{{DGS Plugin/Nine Slice}}

===Object Preview Supports===
{{DGS Plugin/Object Preview Functions}}

===Paste Handler===
{{DGS Plugin/Paste Handler Functions}}

===QRCode===
{{DGS Plugin/QRCode Functions}}

===Remote Image===
{{DGS Plugin/Remote Image Functions}}

===Screen Source===
{{DGS Plugin/Screen Source Functions}}

===SVG===
{{DGS Plugin/SVG}}

===Tooltips===
{{DGS Plugin/Tooltips}}

Template:DGSFUNCTIONS

2024-03-24T11:31:26Z

Thisdp: /* Basic Shapes */

__NOTOC__
{{DGS General Functions}}

==Custom Cursor Functions==
{{DGS Custom Cursor Functions}}

==[[DGS_Multilingual|Multi Language Supports]]==
{{DGS Multi Language Supports Functions}}

==Animation==
{{DGS Animation Functions}}

==3D Element==
{{DGS 3D Element Functions}}

==3D Interface==
{{DGS 3D Interface Functions}}

==3D Line==
{{DGS 3D Line Functions}}

==3D Image==
{{DGS 3D Image Functions}}

==3D Text==
{{DGS 3D Text Functions}}

==Browser==
{{DGS Browser Functions}}

==Button==
{{DGS Button Functions}}

==Check Box==
{{DGS Check Box Functions}}

==Combo Box==
{{DGS Combo Box Functions}}

==Custom Renderer==
{{Template:DGS Custom Renderer Functions}}

==Edit==
{{DGS Edit Functions}}

==Detect Area==
{{DGS Detect Area Functions}}

==Drag'N Drop==
{{DGS Drag'N Drop Functions}}

==Grid List==
{{DGS GridList Functions}}

==Image==
{{DGS Image Functions}}

==Memo==
{{DGS Memo Functions}}

==Menu==
{{DGS Menu Functions}}

==Label==
{{DGS Label Functions}}

==Layout==
{{DGS Layout Functions}}

==Line==
{{DGS Line Functions}}

==Progress Bar==
{{DGS Progress Bar Functions}}

==Radio Button==
{{DGS Radio Button Functions}}

==Scale Pane==
{{DGS Scale Pane Functions}}

==Scroll Bar==
{{DGS Scroll Bar Functions}}

==Scroll Pane==
{{DGS Scroll Pane Functions}}

==Selector==
{{DGS Selector Functions}}

==Style==
{{DGS Style Functions}}

==Switch Button==
{{DGS Switch Button Functions}}

==Tab Panel==
{{DGS Tab Panel Functions}}

==Window==
{{DGS Window Functions}}

==Basic Shape Plugin==

===Circle===
{{DGS Plugin/Circle}}

===Quadrilateral===
{{DGS Plugin/Quadrilateral Functions}}

===Rounded Rectangle===
{{DGS Plugin/Rounded Rectangle Functions}}

==Plugin==

===Blur Box===
{{DGS Plugin/Blur Box}}

===Canvas===
{{DGS Plugin/Canvas}}

===Chart===
{{DGS Plugin/Chart}}

===Color Picker===
{{DGS Plugin/Color Picker}}

===Effect 3D===
{{DGS Plugin/Effect 3D}}

===Gradient===
{{DGS Plugin/Gradient}}

===Mask===
{{DGS Plugin/Mask}}

===Media Browser===
{{DGS Plugin/Media Browser}}

===Nine Slice===
{{DGS Plugin/Nine Slice}}

===Object Preview Supports===
{{DGS Plugin/Object Preview Functions}}

===Paste Handler===
{{DGS Plugin/Paste Handler Functions}}

===QRCode===
{{DGS Plugin/QRCode Functions}}

===Remote Image===
{{DGS Plugin/Remote Image Functions}}

===Screen Source===
{{DGS Plugin/Screen Source Functions}}

===SVG===
{{DGS Plugin/SVG}}

===Tooltips===
{{DGS Plugin/Tooltips}}

Template:DGSFUNCTIONS

2024-03-24T11:31:14Z

Thisdp: /* Plugin */

__NOTOC__
{{DGS General Functions}}

==Custom Cursor Functions==
{{DGS Custom Cursor Functions}}

==[[DGS_Multilingual|Multi Language Supports]]==
{{DGS Multi Language Supports Functions}}

==Animation==
{{DGS Animation Functions}}

==3D Element==
{{DGS 3D Element Functions}}

==3D Interface==
{{DGS 3D Interface Functions}}

==3D Line==
{{DGS 3D Line Functions}}

==3D Image==
{{DGS 3D Image Functions}}

==3D Text==
{{DGS 3D Text Functions}}

==Browser==
{{DGS Browser Functions}}

==Button==
{{DGS Button Functions}}

==Check Box==
{{DGS Check Box Functions}}

==Combo Box==
{{DGS Combo Box Functions}}

==Custom Renderer==
{{Template:DGS Custom Renderer Functions}}

==Edit==
{{DGS Edit Functions}}

==Detect Area==
{{DGS Detect Area Functions}}

==Drag'N Drop==
{{DGS Drag'N Drop Functions}}

==Grid List==
{{DGS GridList Functions}}

==Image==
{{DGS Image Functions}}

==Memo==
{{DGS Memo Functions}}

==Menu==
{{DGS Menu Functions}}

==Label==
{{DGS Label Functions}}

==Layout==
{{DGS Layout Functions}}

==Line==
{{DGS Line Functions}}

==Progress Bar==
{{DGS Progress Bar Functions}}

==Radio Button==
{{DGS Radio Button Functions}}

==Scale Pane==
{{DGS Scale Pane Functions}}

==Scroll Bar==
{{DGS Scroll Bar Functions}}

==Scroll Pane==
{{DGS Scroll Pane Functions}}

==Selector==
{{DGS Selector Functions}}

==Style==
{{DGS Style Functions}}

==Switch Button==
{{DGS Switch Button Functions}}

==Tab Panel==
{{DGS Tab Panel Functions}}

==Window==
{{DGS Window Functions}}

==Basic Shapes==

===Circle===
{{DGS Plugin/Circle}}

===Quadrilateral===
{{DGS Plugin/Quadrilateral Functions}}

===Rounded Rectangle===
{{DGS Plugin/Rounded Rectangle Functions}}

==Plugin==

===Blur Box===
{{DGS Plugin/Blur Box}}

===Canvas===
{{DGS Plugin/Canvas}}

===Chart===
{{DGS Plugin/Chart}}

===Color Picker===
{{DGS Plugin/Color Picker}}

===Effect 3D===
{{DGS Plugin/Effect 3D}}

===Gradient===
{{DGS Plugin/Gradient}}

===Mask===
{{DGS Plugin/Mask}}

===Media Browser===
{{DGS Plugin/Media Browser}}

===Nine Slice===
{{DGS Plugin/Nine Slice}}

===Object Preview Supports===
{{DGS Plugin/Object Preview Functions}}

===Paste Handler===
{{DGS Plugin/Paste Handler Functions}}

===QRCode===
{{DGS Plugin/QRCode Functions}}

===Remote Image===
{{DGS Plugin/Remote Image Functions}}

===Screen Source===
{{DGS Plugin/Screen Source Functions}}

===SVG===
{{DGS Plugin/SVG}}

===Tooltips===
{{DGS Plugin/Tooltips}}

Template:DGS Plugin/Quadrilateral Functions

2024-03-24T11:29:38Z

Thisdp: Created page with "*dgsCreateQuad *dgsQuadSetVertices *dgsQuadGetVertices *dgsQuadSetTexture *dgsQuadGetTexture *dgsQuadSetColor *dgsQuadGetColor *dgsQuadSetColorOverwritten *dgsQuadGetColorOverwritten *dgsQuadSetRotation *dgsQuadSetRotation *dgsQuadSetTextureRotation *dgsQuadGetTextureRotation"

*[[dgsCreateQuad]]
*[[dgsQuadSetVertices]]
*[[dgsQuadGetVertices]]
*[[dgsQuadSetTexture]]
*[[dgsQuadGetTexture]]
*[[dgsQuadSetColor]]
*[[dgsQuadGetColor]]
*[[dgsQuadSetColorOverwritten]]
*[[dgsQuadGetColorOverwritten]]
*[[dgsQuadSetRotation]]
*[[dgsQuadSetRotation]]
*[[dgsQuadSetTextureRotation]]
*[[dgsQuadGetTextureRotation]]

Template:DGSFUNCTIONS

2024-03-24T11:28:44Z

Thisdp: /* Quadrilateral */

__NOTOC__
{{DGS General Functions}}

==Custom Cursor Functions==
{{DGS Custom Cursor Functions}}

==[[DGS_Multilingual|Multi Language Supports]]==
{{DGS Multi Language Supports Functions}}

==Animation==
{{DGS Animation Functions}}

==3D Element==
{{DGS 3D Element Functions}}

==3D Interface==
{{DGS 3D Interface Functions}}

==3D Line==
{{DGS 3D Line Functions}}

==3D Image==
{{DGS 3D Image Functions}}

==3D Text==
{{DGS 3D Text Functions}}

==Browser==
{{DGS Browser Functions}}

==Button==
{{DGS Button Functions}}

==Check Box==
{{DGS Check Box Functions}}

==Combo Box==
{{DGS Combo Box Functions}}

==Custom Renderer==
{{Template:DGS Custom Renderer Functions}}

==Edit==
{{DGS Edit Functions}}

==Detect Area==
{{DGS Detect Area Functions}}

==Drag'N Drop==
{{DGS Drag'N Drop Functions}}

==Grid List==
{{DGS GridList Functions}}

==Image==
{{DGS Image Functions}}

==Memo==
{{DGS Memo Functions}}

==Menu==
{{DGS Menu Functions}}

==Label==
{{DGS Label Functions}}

==Layout==
{{DGS Layout Functions}}

==Line==
{{DGS Line Functions}}

==Progress Bar==
{{DGS Progress Bar Functions}}

==Radio Button==
{{DGS Radio Button Functions}}

==Scale Pane==
{{DGS Scale Pane Functions}}

==Scroll Bar==
{{DGS Scroll Bar Functions}}

==Scroll Pane==
{{DGS Scroll Pane Functions}}

==Selector==
{{DGS Selector Functions}}

==Style==
{{DGS Style Functions}}

==Switch Button==
{{DGS Switch Button Functions}}

==Tab Panel==
{{DGS Tab Panel Functions}}

==Window==
{{DGS Window Functions}}

==Plugin==

===Blur Box===
{{DGS Plugin/Blur Box}}

===Canvas===
{{DGS Plugin/Canvas}}

===Chart===
{{DGS Plugin/Chart}}

===Circle===
{{DGS Plugin/Circle}}

===Color Picker===
{{DGS Plugin/Color Picker}}

===Effect 3D===
{{DGS Plugin/Effect 3D}}

===Gradient===
{{DGS Plugin/Gradient}}

===Mask===
{{DGS Plugin/Mask}}

===Media Browser===
{{DGS Plugin/Media Browser}}

===Nine Slice===
{{DGS Plugin/Nine Slice}}

===Object Preview Supports===
{{DGS Plugin/Object Preview Functions}}

===Paste Handler===
{{DGS Plugin/Paste Handler Functions}}

===QRCode===
{{DGS Plugin/QRCode Functions}}

===Remote Image===
{{DGS Plugin/Remote Image Functions}}

===Rounded Rectangle===
{{DGS Plugin/Rounded Rectangle Functions}}

===Quadrilateral===
{{DGS Plugin/Quadrilateral Functions}}

===Screen Source===
{{DGS Plugin/Screen Source Functions}}

===SVG===
{{DGS Plugin/SVG}}

===Tooltips===
{{DGS Plugin/Tooltips}}

Template:DGSFUNCTIONS

2024-03-24T11:28:39Z

Thisdp: /* Rounded Rectangle */

__NOTOC__
{{DGS General Functions}}

==Custom Cursor Functions==
{{DGS Custom Cursor Functions}}

==[[DGS_Multilingual|Multi Language Supports]]==
{{DGS Multi Language Supports Functions}}

==Animation==
{{DGS Animation Functions}}

==3D Element==
{{DGS 3D Element Functions}}

==3D Interface==
{{DGS 3D Interface Functions}}

==3D Line==
{{DGS 3D Line Functions}}

==3D Image==
{{DGS 3D Image Functions}}

==3D Text==
{{DGS 3D Text Functions}}

==Browser==
{{DGS Browser Functions}}

==Button==
{{DGS Button Functions}}

==Check Box==
{{DGS Check Box Functions}}

==Combo Box==
{{DGS Combo Box Functions}}

==Custom Renderer==
{{Template:DGS Custom Renderer Functions}}

==Edit==
{{DGS Edit Functions}}

==Detect Area==
{{DGS Detect Area Functions}}

==Drag'N Drop==
{{DGS Drag'N Drop Functions}}

==Grid List==
{{DGS GridList Functions}}

==Image==
{{DGS Image Functions}}

==Memo==
{{DGS Memo Functions}}

==Menu==
{{DGS Menu Functions}}

==Label==
{{DGS Label Functions}}

==Layout==
{{DGS Layout Functions}}

==Line==
{{DGS Line Functions}}

==Progress Bar==
{{DGS Progress Bar Functions}}

==Radio Button==
{{DGS Radio Button Functions}}

==Scale Pane==
{{DGS Scale Pane Functions}}

==Scroll Bar==
{{DGS Scroll Bar Functions}}

==Scroll Pane==
{{DGS Scroll Pane Functions}}

==Selector==
{{DGS Selector Functions}}

==Style==
{{DGS Style Functions}}

==Switch Button==
{{DGS Switch Button Functions}}

==Tab Panel==
{{DGS Tab Panel Functions}}

==Window==
{{DGS Window Functions}}

==Plugin==

===Blur Box===
{{DGS Plugin/Blur Box}}

===Canvas===
{{DGS Plugin/Canvas}}

===Chart===
{{DGS Plugin/Chart}}

===Circle===
{{DGS Plugin/Circle}}

===Color Picker===
{{DGS Plugin/Color Picker}}

===Effect 3D===
{{DGS Plugin/Effect 3D}}

===Gradient===
{{DGS Plugin/Gradient}}

===Mask===
{{DGS Plugin/Mask}}

===Media Browser===
{{DGS Plugin/Media Browser}}

===Nine Slice===
{{DGS Plugin/Nine Slice}}

===Object Preview Supports===
{{DGS Plugin/Object Preview Functions}}

===Paste Handler===
{{DGS Plugin/Paste Handler Functions}}

===QRCode===
{{DGS Plugin/QRCode Functions}}

===Remote Image===
{{DGS Plugin/Remote Image Functions}}

===Rounded Rectangle===
{{DGS Plugin/Rounded Rectangle Functions}}

===Quadrilateral ===
{{DGS Plugin/Quadrilateral Functions}}

===Screen Source===
{{DGS Plugin/Screen Source Functions}}

===SVG===
{{DGS Plugin/SVG}}

===Tooltips===
{{DGS Plugin/Tooltips}}

Template:DGSFUNCTIONS

2024-03-24T11:28:31Z

Thisdp: /* Rounded Rectangle */

__NOTOC__
{{DGS General Functions}}

==Custom Cursor Functions==
{{DGS Custom Cursor Functions}}

==[[DGS_Multilingual|Multi Language Supports]]==
{{DGS Multi Language Supports Functions}}

==Animation==
{{DGS Animation Functions}}

==3D Element==
{{DGS 3D Element Functions}}

==3D Interface==
{{DGS 3D Interface Functions}}

==3D Line==
{{DGS 3D Line Functions}}

==3D Image==
{{DGS 3D Image Functions}}

==3D Text==
{{DGS 3D Text Functions}}

==Browser==
{{DGS Browser Functions}}

==Button==
{{DGS Button Functions}}

==Check Box==
{{DGS Check Box Functions}}

==Combo Box==
{{DGS Combo Box Functions}}

==Custom Renderer==
{{Template:DGS Custom Renderer Functions}}

==Edit==
{{DGS Edit Functions}}

==Detect Area==
{{DGS Detect Area Functions}}

==Drag'N Drop==
{{DGS Drag'N Drop Functions}}

==Grid List==
{{DGS GridList Functions}}

==Image==
{{DGS Image Functions}}

==Memo==
{{DGS Memo Functions}}

==Menu==
{{DGS Menu Functions}}

==Label==
{{DGS Label Functions}}

==Layout==
{{DGS Layout Functions}}

==Line==
{{DGS Line Functions}}

==Progress Bar==
{{DGS Progress Bar Functions}}

==Radio Button==
{{DGS Radio Button Functions}}

==Scale Pane==
{{DGS Scale Pane Functions}}

==Scroll Bar==
{{DGS Scroll Bar Functions}}

==Scroll Pane==
{{DGS Scroll Pane Functions}}

==Selector==
{{DGS Selector Functions}}

==Style==
{{DGS Style Functions}}

==Switch Button==
{{DGS Switch Button Functions}}

==Tab Panel==
{{DGS Tab Panel Functions}}

==Window==
{{DGS Window Functions}}

==Plugin==

===Blur Box===
{{DGS Plugin/Blur Box}}

===Canvas===
{{DGS Plugin/Canvas}}

===Chart===
{{DGS Plugin/Chart}}

===Circle===
{{DGS Plugin/Circle}}

===Color Picker===
{{DGS Plugin/Color Picker}}

===Effect 3D===
{{DGS Plugin/Effect 3D}}

===Gradient===
{{DGS Plugin/Gradient}}

===Mask===
{{DGS Plugin/Mask}}

===Media Browser===
{{DGS Plugin/Media Browser}}

===Nine Slice===
{{DGS Plugin/Nine Slice}}

===Object Preview Supports===
{{DGS Plugin/Object Preview Functions}}

===Paste Handler===
{{DGS Plugin/Paste Handler Functions}}

===QRCode===
{{DGS Plugin/QRCode Functions}}

===Remote Image===
{{DGS Plugin/Remote Image Functions}}

===Rounded Rectangle===
{{DGS Plugin/Rounded Rectangle Functions}}

===Rounded Rectangle===
{{DGS Plugin/Quadrilateral Functions}}

===Screen Source===
{{DGS Plugin/Screen Source Functions}}

===SVG===
{{DGS Plugin/SVG}}

===Tooltips===
{{DGS Plugin/Tooltips}}

DGS OOP Class

2024-03-20T02:25:03Z

Thisdp: /* Functions */

<div style="background:#FBFDFF;border-radius:5px;padding:5px;">
DGS provides not only POP ( Procedure Oriented Programming ) but also [[OOP]] ( Object Oriented Programming ). This page introduces [[OOP]] of dgs.

==Structure==
When using DGS [[OOP]], DGS objects to be operated are no longer elements, instead, they will be tables ( table is the only type whose call methods can be defined in lua ) .
Here is the structure of DGS OOP Object:
<syntaxhighlight lang="lua">
DGSObject = {
DGSElement = DGSElement -- The actual dgs element
function1,
function2,
...
}
</syntaxhighlight>
*'''The built-in functions are non-modifiable'''
*'''Any variable of the table are get/set via [[dgsSetProperty]]/[[dgsGetProperty]] ( Exclude DGSElement )'''
*'''After importing DGS OOP Class, there is a table called : ''DGSClass'' '''

==Get Started==
Instead of using
<syntaxhighlight lang="lua">
label = exports.dgs:dgsCreateLabel(0, 0, 0.5, 0.1, "text", true)
</syntaxhighlight>
<syntaxhighlight lang="lua">
DGS = exports.dgs
label = DGS:dgsCreateLabel(0,0,0.5,0.1,"text",true)
</syntaxhighlight>
<syntaxhighlight lang="lua">
loadstring(exports.dgs:dgsImportFunction())()-- load functions
label = dgsCreateLabel(0,0,0.5,0.1,"text",true) --create a label
</syntaxhighlight>

We provides Object Oriented Programming
<syntaxhighlight lang="lua">
loadstring(exports.dgs:dgsImportOOPClass())()-- load OOP class
window = dgsWindow(0,0,0.5,0.1,"test",true) --create a window with oop
label = window:dgsLabel(0,0,1,1,"label",true) --create a label inside the window
label.text = "DGS OOP Test" --set text
</syntaxhighlight>

<div style="background:#C0D0FF;border-radius:5px;padding:5px;">
'''Notice:''' When you are going to create a child element, there is no need to pass '''parent''' as an argument into the function, because the parent dgs element is the function caller.
<div style="background:#EE6666;border-radius:5px;padding:10px;">
<div style="color:#FFFFFF;font-size:18px;line-height:35px;text-shadow:black 0.1em 0.1em 0.2em">This is the '''Wrong''' Usage:</div>
<syntaxhighlight lang="lua">
loadstring(exports.dgs:dgsImportOOPClass())()-- load OOP class
window = dgsWindow(0,0,0.5,0.1,"test",true) --create a window with oop
label = dgsLabel(0,0,1,1,"label",true,window) --create a label inside the window ( Wrong )
label.text = "DGS OOP Test" --set text
</syntaxhighlight>
</div>
<div style="background:#33AA33;border-radius:5px;padding:10px;">
<div style="color:#FFFFFF;font-size:18px;line-height:35px;text-shadow:black 0.1em 0.1em 0.2em">This is the '''Correct''' Usage:</div>
<syntaxhighlight lang="lua">
loadstring(exports.dgs:dgsImportOOPClass())()-- load OOP class
window = dgsWindow(0,0,0.5,0.1,"test",true) --create a window with oop
label = window:dgsLabel(0,0,1,1,"label",true) --create a label inside the window ( Correct )
label.text = "DGS OOP Test" --set text
</syntaxhighlight>
</div>
</div>

==Special==
For Position and Size, we have a more convenient method to do.
<div style="background:#33AA33;border-radius:5px;padding:10px;">
<syntaxhighlight lang="lua">
loadstring(exports.dgs:dgsImportOOPClass())()-- load OOP class
window = dgsWindow(0,0,0.5,0.1,"test",true) --create a window with oop
window.position.x = 0.2 -- For relative position
window.position.relative = false -- Change to absolute position
window.position.x = 10 -- For absolute position
window.size.relative = false
window.size.w = 400
</syntaxhighlight>
</div>

==Functions==

<div style="background:#E8F2FF;border-radius:20px;padding:20px; width:800px;">
<div style="background:#66A7FF;border-radius:10px;padding:5px; width:800px;">
===Creation Functions===
</div>
{| class="wikitable" style="width: 800px; text-align: center; table-layout: fixed;"
|-
!OOP Functions
!POP Functions
|-
|dgs3DInterface
|[[dgsCreate3DInterface]]
|-
|dgs3DText
|[[dgsCreate3DText]]
|-
|dgsBrowser
|[[dgsCreateBrowser]]
|-
|dgsButton
|[[dgsCreateButton]]
|-
|dgsCheckBox
|[[dgsCreateCheckBox]]
|-
|dgsComboBox
|[[dgsCreateComboBox]]
|-
|dgsDetectArea
|[[dgsCreateDetectArea]]
|-
|dgsEdit
|[[dgsCreateEdit]]
|-
|dgsGridList
|[[dgsCreateGridList]]
|-
|dgsImage
|[[dgsCreateImage]]
|-
|dgsLabel
|[[dgsCreateLabel]]
|-
|dgsMemo
|[[dgsCreateMemo]]
|-
|dgsProgressBar
|[[dgsCreateProgressBar]]
|-
|dgsRadioButton
|[[dgsCreateRadioButton]]
|-
|dgsScrollBar
|[[dgsCreateScrollBar]]
|-
|dgsScrollPane
|[[dgsCreateScrollPane]]
|-
|dgsSwitchButton
|[[dgsCreateSwitchButton]]
|-
|dgsTabPanel
|[[dgsCreateTabPanel]]
|-
|dgsWindow
|[[dgsCreateWindow]]
|-
|}

<div style="background:#66A7FF;border-radius:10px;padding:5px; width:800px;">

===Non Object Functions===
</div>
{| class="wikitable" style="width: 800px; text-align: center; table-layout: fixed;"
|-
!OOP Functions
!POP Functions
|-
|isStyleAvailable
|[[dgsIsStyleAvailable]]
|-
|getLoadedStyleList
|[[dgsGetLoadedStyleList]]
|-
|setCurrentStyle
|[[dgsSetCurrentStyle]]
|-
|getCurrentStyle
|[[dgsGetCurrentStyle]]
|-
|getScreenSize
|[[guiGetScreenSize]]
|-
|setInputEnabled
|[[guiSetInputEnabled]]
|-
|getInputEnabled
|[[guiGetInputEnabled]]
|-
|setRenderSetting
|[[dgsSetRenderSetting]]
|-
|getRenderSetting
|[[dgsGetRenderSetting]]
|-
|getLayerElements
|[[dgsGetLayerElements]]
|-
|addEasingFunction
|[[dgsAddEasingFunction]]
|-
|easingFunctionExists
|[[dgsEasingFunctionExists]]
|-
|removeEasingFunction
|[[dgsRemoveEasingFunction]]
|-
|getSystemFont
|[[dgsGetSystemFont]]
|-
|setSystemFont
|[[dgsSetSystemFont]]
|-
|translationTableExists
|[[dgsTranslationTableExists]]
|-
|setTranslationTable
|[[dgsSetTranslationTable]]
|-
|setAttachTranslation
|[[dgsSetAttachTranslation]]
|-
|}

<div style="background:#66A7FF;border-radius:10px;padding:5px; width:800px;">
===General Functions===
</div>
{| class="wikitable" style="width: 800px; text-align: center; table-layout: fixed;"
|-
!OOP Functions
!POP Functions
|-
|getPosition
|[[dgsGetPosition]]
|-
|setPosition
|[[dgsSetPosition]]
|-
|getParent
|[[dgsGetParent]]
|-
|setParent
|[[dgsSetParent]]
|-
|getChild
|[[dgsGetChild]]
|-
|getChildren
|[[dgsGetChildren]]
|-
|getSize
|[[dgsGetSize]]
|-
|setSize
|[[dgsSetSize]]
|-
|getType
|[[dgsGetType]]
|-
|setLayer
|[[dgsSetLayer]]
|-
|getLayer
|[[dgsSetLayer]]
|-
|setCurrentLayerIndex
|[[dgsSetCurrentLayerIndex]]
|-
|getCurrentLayerIndex
|[[dgsGetCurrentLayerIndex]]
|-
|getProperty
|[[dgsGetProperty]]
|-
|setProperty
|[[dgsSetProperty]]
|-
|getProperties
|[[dgsGetProperties]]
|-
|setProperties
|[[dgsSetProperties]]
|-
|getVisible
|[[dgsGetVisible]]
|-
|setVisible
|[[dgsGetVisible]]
|-
|getEnabled
|[[dgsGetEnabled]]
|-
|setEnabled
|[[dgsSetEnabled]]
|-
|getSide
|[[dgsGetSide]]
|-
|setSide
|[[dgsSetSide]]
|-
|getAlpha
|[[dgsGetAlpha]]
|-
|setAlpha
|[[dgsSetAlpha]]
|-
|getFont
|[[dgsGetFont]]
|-
|setFont
|[[dgsSetFont]]
|-
|getText
|[[dgsGetText]]
|-
|setText
|[[dgsSetText]]
|-
|bringToFront
|[[dgsBringToFront]]
|-
|moveToBack
|[[dgsMoveToBack]]
|-
|focus
|[[dgsFocus]]
|-
|blur
|[[dgsBlur]]
|-
|simulateClick
|[[dgsSimulateClick]]
|-
|animTo
|[[dgsAnimTo]]
|-
|isAniming
|[[dgsIsAniming]]
|-
|stopAniming
|[[dgsStopAniming]]
|-
|moveTo
|[[dgsMoveTo]]
|-
|isMoving
|[[dgsIsMoving]]
|-
|stopMoving
|[[dgsStopMoving]]
|-
|sizeTo
|[[dgsSizeTo]]
|-
|isSizing
|[[dgsIsSizing]]
|-
|stopSizing
|[[dgsStopSizing]]
|-
|alphaTo
|[[dgsAlphaTo]]
|-
|isAlphaing
|[[dgsIsAlphaing]]
|-
|stopAlphaing
|[[dgsStopAlphaing]]
|-
|getPostGUI
|[[dgsGetPostGUI]]
|-
|setPostGUI
|[[dgsSetPostGUI]]
|-
|destroy
|[[destroyElement]]
|-
|isElement
|[[isElement]]
|-
|getElement
|self.dgsElement
|-
|addMoveHandler
|[[dgsAddMoveHandler]]
|-
|removeMoveHandler
|[[dgsRemoveMoveHandler]]
|-
|isMoveHandled
|[[dgsIsMoveHandled]]
|-
|addSizeHandler
|[[dgsAddSizeHandler]]
|-
|removeSizeHandler
|[[dgsRemoveSizeHandler]]
|-
|isSizeHandled
|[[dgsIsSizeHandled]]
|-
|attachToTranslation
|[[dgsAttachToTranslation]]
|-
|detachFromTranslation
|[[dgsDetachFromTranslation]]
|-
|getTranslationName
|[[dgsGetTranslationName]]
|-
|on
|[[addEventHandler]](Handled By DGS)
|-
|removeOn
|[[removeEventHandler]](Handled By DGS)
|-
|}

<div style="background:#66A7FF;border-radius:10px;padding:5px; width:800px;">
===Window===
</div>
{| class="wikitable" style="width: 800px; text-align: center; table-layout: fixed;"
|-
!OOP Functions
!POP Functions
|-
|setSizable
|[[dgsWindowSetSizable]]
|-
|setMovable
|[[dgsWindowSetMovable]]
|-
|close
|[[dgsCloseWindow]]
|-
|setCloseButtonEnabled
|[[dgsWindowSetCloseButtonEnabled]]
|-
|getCloseButtonEnabled
|[[dgsWindowGetCloseButtonEnabled]]
|-
|getCloseButton
|[[dgsWindowGetCloseButton]]
|-
|}

<div style="background:#66A7FF;border-radius:10px;padding:5px; width:800px;">
===3D Interface===
</div>
{| class="wikitable" style="width: 800px; text-align: center; table-layout: fixed;"
|-
!OOP Functions
!POP Functions
|-
|getBlendMode
|[[dgs3DInterfaceGetBlendMode]]
|-
|setBlendMode
|[[dgs3DInterfaceSetBlendMode]]
|-
|getPosition
|[[dgs3DInterfaceGetPosition]]
|-
|setPosition
|[[dgs3DInterfaceSetPosition]]
|-
|getSize
|[[dgs3DInterfaceGetSize]]
|-
|setSize
|[[dgs3DInterfaceSetSize]]
|-
|getResolution
|[[dgs3DInterfaceGetResolution]]
|-
|setFaceTo
|[[dgs3DInterfaceSetFaceTo]]
|-
|getFaceTo
|[[dgs3DInterfaceGetFaceTo]]
|-
|setResolution
|[[dgs3DInterfaceSetResolution]]
|-
|attachToElement
|[[dgs3DInterfaceAttachToElement]]
|-
|isAttached
|[[dgs3DInterfaceIsAttached]]
|-
|detachFromElement
|[[dgs3DInterfaceDetachFromElement]]
|-
|setAttachedOffsets
|[[dgs3DInterfaceSetAttachedOffsets]]
|-
|getAttachedOffsets
|[[dgs3DInterfaceGetAttachedOffsets]]
|-
|setRotation
|[[dgs3DInterfaceSetRotation]]
|-
|getRotation
|[[dgs3DInterfaceGetRotation]]
|-
|}

<div style="background:#66A7FF;border-radius:10px;padding:5px; width:800px;">

===3D Text===
</div>
{| class="wikitable" style="width: 800px; text-align: center; table-layout: fixed;"
|-
!OOP Functions
!POP Functions
|-
|getDimension
|[[dgs3DTextGetDimension]]
|-
|setDimension
|[[dgs3DTextSetDimension]]
|-
|getInterior
|[[dgs3DTextGetInterior]]
|-
|setInterior
|[[dgs3DTextSetInterior]]
|-
|attachToElement
|[[dgs3DTextAttachToElement]]
|-
|detachFromElement
|[[dgs3DTextDetachFromElement]]
|-
|isAttached
|[[dgs3DTextIsAttached]]
|-
|setAttachedOffsets
|[[dgs3DTextSetAttachedOffsets]]
|-
|getAttachedOffsets
|[[dgs3DTextGetAttachedOffsets]]
|-
|getPosition
|[[dgs3DTextGetPosition]]
|-
|setPosition
|[[dgs3DTextSetPosition]]
|-
|}

<div style="background:#66A7FF;border-radius:10px;padding:5px; width:800px;">

===Check Box===
</div>
{| class="wikitable" style="width: 800px; text-align: center; table-layout: fixed;"
|-
!OOP Functions
!POP Functions
|-
|getSelected
|[[dgsCheckBoxGetSelected]]
|-
|setSelected
|[[dgsCheckBoxSetSelected]]
|-
|}

<div style="background:#66A7FF;border-radius:10px;padding:5px; width:800px;">
===Combo Box===
</div>
{| class="wikitable" style="width: 800px; text-align: center; table-layout: fixed;"
|-
!OOP Functions
!POP Functions
|-
|addItem
|[[dgsComboBoxAddItem]]
|-
|removeItem
|[[dgsComboBoxRemoveItem]]
|-
|setItemText
|[[dgsComboBoxSetItemText]]
|-
|getItemText
|[[dgsComboBoxGetItemText]]
|-
|getItemCount
|[[dgsComboBoxGetItemCount]]
|-
|getText
|[[dgsComboBoxGetText]]
|-
|clear
|[[dgsComboBoxClear]]
|-
|setSelectedItem
|[[dgsComboBoxSetSelectedItem]]
|-
|getSelectedItem
|[[dgsComboBoxGetSelectedItem]]
|-
|setItemColor
|[[dgsComboBoxSetItemColor]]
|-
|getItemColor
|[[dgsComboBoxGetItemColor]]
|-
|getState
|[[dgsComboBoxGetState]]
|-
|setState
|[[dgsComboBoxSetState]]
|-
|getBoxHeight
|[[dgsComboBoxGetBoxHeight]]
|-
|setBoxHeight
|[[dgsComboBoxSetBoxHeight]]
|-
|getScrollBar
|[[dgsComboBoxGetScrollBar]]
|-
|setScrollPosition
|[[dgsComboBoxSetScrollPosition]]
|-
|getScrollPosition
|[[dgsComboBoxGetScrollPosition]]
|-
|setCaptionText
|[[dgsComboBoxSetCaptionText]]
|-
|getCaptionText
|[[dgsComboBoxGetCaptionText]]
|-
|setEditEnabled
|[[dgsComboBoxSetEditEnabled]]
|-
|getEditEnabled
|[[dgsComboBoxGetEditEnabled]]
|-
|}

<div style="background:#66A7FF;border-radius:10px;padding:5px; width:800px;">
===Custom Renderer===
</div>
{| class="wikitable" style="width: 800px; text-align: center; table-layout: fixed;"
|-
!OOP Functions
!POP Functions
|-
|setFunction
|[[dgsCustomRendererSetFunction]]
|-
|}

<div style="background:#66A7FF;border-radius:10px;padding:5px; width:800px;">
===Detect Area===
</div>
{| class="wikitable" style="width: 800px; text-align: center; table-layout: fixed;"
|-
!OOP Functions
!POP Functions
|-
|setFunction
|[[dgsDetectAreaSetFunction]]
|-
|}

<div style="background:#66A7FF;border-radius:10px;padding:5px; width:800px;">
===Edit===
</div>
{| class="wikitable" style="width: 800px; text-align: center; table-layout: fixed;"
|-
!OOP Functions
!POP Functions
|-
|moveCaret
|[[dgsEditMoveCaret]]
|-
|getCaretPosition
|[[dgsEditGetCaretPosition]]
|-
|setCaretPosition
|[[dgsEditSetCaretPosition]]
|-
|setCaretStyle
|[[dgsEditSetCaretStyle]]
|-
|getCaretStyle
|[[dgsEditGetCaretStyle]]
|-
|setWhiteList
|[[dgsEditSetWhiteList]]
|-
|getMaxLength
|[[dgsEditGetMaxLength]]
|-
|setMaxLength
|[[dgsEditSetMaxLength]]
|-
|setReadOnly
|[[dgsEditSetReadOnly]]
|-
|getReadOnly
|[[dgsEditGetReadOnly]]
|-
|setMasked
|[[dgsEditSetMasked]]
|-
|getMasked
|[[dgsEditGetMasked]]
|-
|setUnderlined
|[[dgsEditSetUnderlined]]
|-
|getUnderlined
|[[dgsEditGetUnderlined]]
|-
|setHorizontalAlign
|[[dgsEditSetHorizontalAlign]]
|-
|getHorizontalAlign
|[[dgsEditGetHorizontalAlign]]
|-
|setVerticalAlign
|[[dgsEditSetVerticalAlign]]
|-
|getVerticalAlign
|[[dgsEditGetVerticalAlign]]
|-
|setAlignment
|[[dgsEditSetAlignment]]
|-
|getAlignment
|[[dgsEditGetAlignment]]
|-
|insertText
|[[dgsEditInsertText]]
|-
|deleteText
|[[dgsEditDeleteText]]
|-
|getPartOfText
|[[dgsEditGetPartOfText]]
|-
|clearText
|[[dgsEditClearText]]
|-
|replaceText
|[[dgsEditReplaceText]]
|-
|setTypingSound
|[[dgsEditSetTypingSound]]
|-
|getTypingSound
|[[dgsEditGetTypingSound]]
|-
|setPlaceHolder
|[[dgsEditSetPlaceHolder]]
|-
|getPlaceHolder
|[[dgsEditGetPlaceHolder]]
|-
|}

<div style="background:#66A7FF;border-radius:10px;padding:5px; width:800px;">
===Grid List===
</div>
{| class="wikitable" style="width: 800px; text-align: center; table-layout: fixed;"
|-
!OOP Functions
!POP Functions
|-
|getScrollBar
|[[dgsGridListGetScrollBar]]
|-
|setScrollPosition
|[[dgsGridListSetScrollPosition]]
|-
|getScrollPosition
|[[dgsGridListGetScrollPosition]]
|-
|resetScrollBarPosition
|[[dgsGridListResetScrollBarPosition]]
|-
|setColumnRelative
|[[dgsGridListSetColumnRelative]]
|-
|getColumnRelative
|[[dgsGridListGetColumnRelative]]
|-
|addColumn
|[[dgsGridListAddColumn]]
|-
|getColumnCount
|[[dgsGridListGetColumnCount]]
|-
|removeColumn
|[[dgsGridListRemoveColumn]]
|-
|getColumnAllWidth
|[[dgsGridListGetColumnAllWidth]]
|-
|getColumnWidth
|[[dgsGridListGetColumnWidth]]
|-
|setColumnWidth
|[[dgsGridListSetColumnWidth]]
|-
|getColumnTitle
|[[dgsGridListGetColumnTitle]]
|-
|setColumnTitle
|[[dgsGridListSetColumnTitle]]
|-
|getColumnFont
|[[dgsGridListGetColumnFont]]
|-
|setColumnFont
|[[dgsGridListSetColumnFont]]
|-
|addRow
|[[dgsGridListAddRow]]
|-
|removeRow
|[[dgsGridListRemoveRow]]
|-
|clearRow
|[[dgsGridListClearRow]]
|-
|clearColumn
|[[dgsGridListClearColumn]]
|-
|clear
|[[dgsGridListClear]]
|-
|getRowCount
|[[dgsGridListGetRowCount]]
|-
|setItemText
|[[dgsGridListSetItemText]]
|-
|getItemText
|[[dgsGridListGetItemText]]
|-
|getSelectedItem
|[[dgsGridListGetSelectedItem]]
|-
|setSelectedItem
|[[dgsGridListSetSelectedItem]]
|-
|setItemColor
|[[dgsGridListSetItemColor]]
|-
|getItemColor
|[[dgsGridListGetItemColor]]
|-
|setItemData
|[[dgsGridListSetItemData]]
|-
|getItemData
|[[dgsGridListGetItemData]]
|-
|setItemImage
|[[dgsGridListSetItemImage]]
|-
|getItemImage
|[[dgsGridListGetItemImage]]
|-
|removeItemImage
|[[dgsGridListRemoveItemImage]]
|-
|getRowBackGroundImage
|[[dgsGridListGetRowBackGroundImage]]
|-
|setRowBackGroundImage
|[[dgsGridListSetRowBackGroundImage]]
|-
|setRowBackGroundColor
|[[dgsGridListSetRowBackGroundColor]]
|-
|getRowBackGroundColor
|[[dgsGridListGetRowBackGroundColor]]
|-
|setRowAsSection
|[[dgsGridListSetRowAsSection]]
|-
|selectItem
|[[dgsGridListSelectItem]]
|-
|itemIsSelected
|[[dgsGridListItemIsSelected]]
|-
|setMultiSelectionEnabled
|[[dgsGridListSetMultiSelectionEnabled]]
|-
|getMultiSelectionEnabled
|[[dgsGridListGetMultiSelectionEnabled]]
|-
|setSelectionMode
|[[dgsGridListSetSelectionMode]]
|-
|getSelectionMode
|[[dgsGridListGetSelectionMode]]
|-
|getSelectedItems
|[[dgsGridListGetSelectedItems]]
|-
|setSelectedItems
|[[dgsGridListSetSelectedItems]]
|-
|getSelectedCount
|[[dgsGridListGetSelectedCount]]
|-
|setSortFunction
|[[dgsGridListSetSortFunction]]
|-
|setAutoSortEnabled
|[[dgsGridListSetAutoSortEnabled]]
|-
|getAutoSortEnabled
|[[dgsGridListGetAutoSortEnabled]]
|-
|setSortEnabled
|[[dgsGridListSetSortEnabled]]
|-
|getSortEnabled
|[[dgsGridListGetSortEnabled]]
|-
|setSortColumn
|[[dgsGridListSetSortColumn]]
|-
|getSortColumn
|[[dgsGridListGetSortColumn]]
|-
|getEnterColumn
|[[dgsGridListGetEnterColumn]]
|-
|sort
|[[dgsGridListSort]]
|-
|setNavigationEnabled
|[[dgsGridListSetNavigationEnabled]]
|-
|getNavigationEnabled
|[[dgsGridListGetNavigationEnabled]]
|-
|}

<div style="background:#66A7FF;border-radius:10px;padding:5px; width:800px;">
===Image===
</div>
{| class="wikitable" style="width: 800px; text-align: center; table-layout: fixed;"
|-
!OOP Functions
!POP Functions
|-
|setImage
|[[dgsImageSetImage]]
|-
|getImage
|[[dgsImageGetImage]]
|-
|setUVSize
|[[dgsImageSetUVSize]]
|-
|getUVSize
|[[dgsImageGetUVSize]]
|-
|setUVPosition
|[[dgsImageSetUVPosition]]
|-
|getUVPosition
|[[dgsImageGetUVPosition]]
|-
|}

<div style="background:#66A7FF;border-radius:10px;padding:5px; width:800px;">
===Label===
</div>
{| class="wikitable" style="width: 800px; text-align: center; table-layout: fixed;"
|-
!OOP Functions
!POP Functions
|-
|setColor
|[[dgsLabelSetColor]]
|-
|getColor
|[[dgsLabelGetColor]]
|-
|setHorizontalAlign
|[[dgsLabelSetHorizontalAlign]]
|-
|getHorizontalAlign
|[[dgsLabelGetHorizontalAlign]]
|-
|setVerticalAlign
|[[dgsLabelSetVerticalAlign]]
|-
|getVerticalAlign
|[[dgsLabelGetVerticalAlign]]
|-
|getTextExtent
|[[dgsLabelGetTextExtent]]
|-
|getFontHeight
|[[dgsLabelGetFontHeight]]
|-
|}

<div style="background:#66A7FF;border-radius:10px;padding:5px; width:800px;">
===Memo===
</div>
{| class="wikitable" style="width: 800px; text-align: center; table-layout: fixed;"
|-
!OOP Functions
!POP Functions
|-
|moveCaret
|[[dgsMemoMoveCaret]]
|-
|seekPosition
|[[dgsMemoSeekPosition]]
|-
|getScrollBar
|[[dgsMemoGetScrollBar]]
|-
|setScrollPosition
|[[dgsMemoSetScrollPosition]]
|-
|getScrollPosition
|[[dgsMemoGetScrollPosition]]
|-
|setCaretPosition
|[[dgsMemoSetCaretPosition]]
|-
|getCaretPosition
|[[dgsMemoGetCaretPosition]]
|-
|setCaretStyle
|[[dgsMemoSetCaretStyle]]
|-
|getCaretStyle
|[[dgsMemoGetCaretStyle]]
|-
|setReadOnly
|[[dgsMemoSetReadOnly]]
|-
|getReadOnly
|[[dgsMemoGetReadOnly]]
|-
|getPartOfText
|[[dgsMemoGetPartOfText]]
|-
|deleteText
|[[dgsMemoDeleteText]]
|-
|insertText
|[[dgsMemoInsertText]]
|-
|clearText
|[[dgsMemoClearText]]
|-
|clearText
|[[dgsMemoClearText]]
|-
|setScrollBarState
|[[dgsMemoSetScrollBarState]]
|-
|getScrollBarState
|[[dgsMemoGetScrollBarState]]
|-
|setTypingSound
|[[dgsMemoSetTypingSound]]
|-
|getLineCount
|[[dgsMemoGetLineCount]]
|-
|setWordWrapState
|[[dgsMemoSetWordWrapState]]
|-
|getWordWrapState
|[[dgsMemoGetWordWrapState]]
|-
|}

<div style="background:#66A7FF;border-radius:10px;padding:5px; width:800px;">
===Progress Bar===
</div>
{| class="wikitable" style="width: 800px; text-align: center; table-layout: fixed;"
|-
!OOP Functions
!POP Functions
|-
|getProgress
|[[dgsProgressBarGetProgress]]
|-
|setProgress
|[[dgsProgressBarSetProgress]]
|-
|getMode
|[[dgsProgressBarGetMode]]
|-
|setMode
|[[dgsProgressBarSetMode]]
|-
|getVerticalSide
|[[dgsProgressBarGetVerticalSide]]
|-
|setVerticalSide
|[[dgsProgressBarSetVerticalSide]]
|-
|getHorizontalSide
|[[dgsProgressBarGetHorizontalSide]]
|-
|setHorizontalSide
|[[dgsProgressBarSetHorizontalSide]]
|-
|}

<div style="background:#66A7FF;border-radius:10px;padding:5px; width:800px;">
===Radio Button===
</div>
{| class="wikitable" style="width: 800px; text-align: center; table-layout: fixed;"
|-
!OOP Functions
!POP Functions
|-
|getSelected
|[[dgsRadioButtonGetSelected]]
|-
|setSelected
|[[dgsRadioButtonSetSelected]]
|-
|}

<div style="background:#66A7FF;border-radius:10px;padding:5px; width:800px;">
===Scroll Bar===
</div>
{| class="wikitable" style="width: 800px; text-align: center; table-layout: fixed;"
|-
!OOP Functions
!POP Functions
|-
|setScrollPosition
|[[dgsScrollBarSetScrollPosition]]
|-
|getScrollPosition
|[[dgsScrollBarGetScrollPosition]]
|-
|setScrollSize
|[[dgsScrollBarSetScrollSize]]
|-
|getScrollSize
|[[dgsScrollBarGetScrollSize]]
|-
|setLocked
|[[dgsScrollBarSetLocked]]
|-
|getLocked
|[[dgsScrollBarGetLocked]]
|-
|}

<div style="background:#66A7FF;border-radius:10px;padding:5px; width:800px;">
===Switch Button===
</div>
{| class="wikitable" style="width: 800px; text-align: center; table-layout: fixed;"
|-
!OOP Functions
!POP Functions
|-
|getState
|[[dgsSwitchButtonGetState]]
|-
|setState
|[[dgsSwitchButtonSetState]]
|-
|setText
|[[dgsSwitchButtonSetText]]
|-
|getText
|[[dgsSwitchButtonGetText]]
|-
|}

<div style="background:#66A7FF;border-radius:10px;padding:5px; width:800px;">
===Scroll Pane===
</div>
{| class="wikitable" style="width: 800px; text-align: center; table-layout: fixed;"
|-
!OOP Functions
!POP Functions
|-
|getScrollBar
|[[dgsScrollPaneGetScrollBar]]
|-
|setScrollPosition
|[[dgsScrollPaneSetScrollPosition]]
|-
|getScrollPosition
|[[dgsScrollPaneGetScrollPosition]]
|-
|setScrollBarState
|[[dgsScrollPaneSetScrollBarState]]
|-
|getScrollBarState
|[[dgsScrollPaneGetScrollBarState]]
|-
|}

<div style="background:#66A7FF;border-radius:10px;padding:5px; width:800px;">
===Tab Panel===
</div>
{| class="wikitable" style="width: 800px; text-align: center; table-layout: fixed;"
|-
!OOP Functions
!POP Functions
|-
|getSelectedTab
|[[dgsGetSelectedTab]]
|-
|setSelectedTab
|[[dgsSetSelectedTab]]
|-
|getTabFromID
|[[dgsTabPanelGetTabFromID]]
|-
|moveTab
|[[dgsTabPanelMoveTab]]
|-
|getTabID
|[[dgsTabPanelGetTabID]]
|-
|dgsTab
|[[dgsCreateTab]]
|-
|}

<div style="background:#66A7FF;border-radius:10px;padding:5px; width:800px;">
===Tab===
</div>
{| class="wikitable" style="width: 800px; text-align: center; table-layout: fixed;"
|-
!OOP Functions
!POP Functions
|-
|deleteTab
|[[dgsDeleteTab]]
|-
|}

</div>

==Events==
<div style="background:#E8F2FF;border-radius:20px;padding:20px; width:800px;">
{| class="wikitable" style="width: 800px; text-align: center; table-layout: fixed;"
|-
!OOP Events
!POP Events
|-
|dgsMouseLeave
|[[onDgsMouseLeave]]
|-
|dgsMouseEnter
|[[onDgsMouseEnter]]
|-
|dgsMouseClick
|[[onDgsMouseClick]]
|-
|dgsMouseWheel
|[[onDgsMouseWheel]]
|-
|dgsMouseDoubleClick
|[[onDgsMouseDoubleClick]]
|-
|dgsWindowClose
|[[onDgsWindowClose]]
|-
|dgsPositionChange
|[[onDgsPositionChange]]
|-
|dgsSizeChange
|[[onDgsSizeChange]]
|-
|dgsTextChange
|[[onDgsTextChange]]
|-
|dgsScrollBarScrollPositionChange
|[[onDgsScrollBarScrollPositionChange]]
|-
|dgsScrollPaneScroll
|[[onDgsScrollPaneScroll]]
|-
|dgsDestroy
|[[onDgsDestroy]]
|-
|dgsSwitchButtonStateChange
|[[onDgsSwitchButtonStateChange]]
|-
|dgsGridListSelect
|[[onDgsGridListSelect]]
|-
|dgsGridListItemDoubleClick
|[[onDgsGridListItemDoubleClick]]
|-
|dgsProgressBarChange
|[[onDgsProgressBarChange]]
|-
|dgsCreate
|[[onDgsCreate]]
|-
|dgsPreRender
|[[onDgsPreRender]]
|-
|dgsRender
|[[onDgsRender]]
|-
|dgsElementRender
|[[onDgsElementRender]]
|-
|dgsFocus
|[[onDgsFocus]]
|-
|dgsBlur
|[[onDgsBlur]]
|-
|dgsCursorMove
|[[onDgsCursorMove]]
|-
|dgsTabSelect
|[[onDgsTabSelect]]
|-
|dgsTabPanelTabSelect
|[[onDgsTabPanelTabSelect]]
|-
|dgsRadioButtonChange
|[[onDgsRadioButtonChange]]
|-
|dgsCheckBoxChange
|[[onDgsCheckBoxChange]]
|-
|dgsComboBoxSelect
|[[onDgsComboBoxSelect]]
|-
|dgsComboBoxStateChange
|[[onDgsComboBoxStateChange]]
|-
|dgsEditPreSwitch
|[[onDgsEditPreSwitch]]
|-
|dgsEditSwitched
|[[onDgsEditSwitched]]
|-
|dgsEditAccepted
|[[onDgsEditAccepted]]
|-
|dgsComboBoxAccepted
|[[onDgsComboBoxAccepted]]
|-
|dgsStopMoving
|[[onDgsStopMoving]]
|-
|dgsStopSizing
|[[onDgsStopSizing]]
|-
|dgsStopAlphaing
|[[onDgsStopAlphaing]]
|-
|dgsStopAniming
|[[onDgsStopAniming]]
|-
|dgsCursorDrag
|[[onDgsCursorDrag]]
|-
|}
</div>
</div>

Dgs-dxscrollpane

2024-03-18T02:58:08Z

Thisdp: /* bgImage */

[[Dgs|DGS]] Properties is always used to change the gui style and make it more fantastic.

This page shows the properties of dgs-dxscrollpane that you could use.

==Main Functions==
*[[dgsSetProperty]]
*[[dgsGetProperty]]

==Properties==
===basePointOffset ===
This property changes the offset of the base point where x=0, y=0. And by default, base point offset is 0, 0.
<syntaxhighlight lang="lua">dgsSetProperty(scrollpane,"basePointOffset",{offsetX ,offsetY,relative})</syntaxhighlight>
*'''offsetX :''' A float of the 2D X offset relative to the position of the text of radio button, depends on relative.
*'''offsetY:''' A float of the 2D Y offset relative to the position of the text of radio button, depends on relative.
*'''relative:''' A bool of whether the offset is relative to the size of scroll pane or absolute pixels.

===bgColor===
This property determines the background color of the scroll pane.
<syntaxhighlight lang="lua">dgsSetProperty(scrollpane,"bgColor",bgColor)</syntaxhighlight>
*'''bgColor:''' An integer of the color that can be converted by [[tocolor]].

===bgImage===
This property determines the background image of the scroll pane. '''Specify '[[Dgs-dxscrollpane#bgColor|bgColor]]' before using bgImage'''
<syntaxhighlight lang="lua">dgsSetProperty(scrollpane,"bgImage",bgImage)</syntaxhighlight>
*'''bgImage:''' A material element that serves as the background image of the scroll pane (texture/shader/screen source/renderTarget).

===minViewSize===
This property determines the minimal view size of scroll pane. By default, view size is determined by the content in the scroll pane.
<syntaxhighlight lang="lua">dgsSetProperty(scrollpane,"minViewSize",{w,h,relative})</syntaxhighlight>
*'''w:''' A float if the minimal view size in width.
*'''h:''' A float if the minimal view size in height.
*'''relative:''' A bool of whether the minimal view size is relative to the size of scroll pane or absolute pixels.

===moveHardness===
This property determines how hard will the scroll pane moves when scrolling.
<syntaxhighlight lang="lua">dgsSetProperty(scrollpane,"moveHardness",{scrollHardness,dragHardness})</syntaxhighlight>
*'''scrollHardness:''' A float determins how hard will the scroll pane moves when scrolling with wheel ( should be larger than 0, lower than 1 ).
*'''dragHardness:''' A float determins how hard will the scroll pane moves when dragging with mouse ( should be larger than 0, lower than 1 ).

===padding===
This property determines the content padding from 4 sides of element (left/top/right/bottom)
<syntaxhighlight lang="lua">dgsSetProperty(scrollpane, "padding", {horizontal, vertical, relative})</syntaxhighlight>
*'''horizontal:''' A float of the horizontal padding in pixels.
*'''vertical:''' A float of the vertical padding in pixels.

===scrollBarThick===
This property determines the thickness of scroll bar.
<syntaxhighlight lang="lua">dgsSetProperty(scrollpane,"scrollBarThick",scrollBarThick)</syntaxhighlight>
*'''scrollBarThick:''' An integer of the thickness of scroll bar.

===scrollBarState===
This property forces the visibility of scroll bar. ''See [[dgsScrollPaneSetScrollBarState]]/[[dgsScrollPaneGetScrollBarState]]''
<syntaxhighlight lang="lua">dgsSetProperty(scrollpane,"scrollBarState",{vertical,horizontal})</syntaxhighlight>
*'''vertical:''' A bool of the state of the vertical scroll bar.
*'''horizontal:''' A bool of the state of the horizontal scroll bar.
**'''true:''' Force to be visible
**'''false:''' Force to be invisible
**'''nil:''' Auto

===scrollBarLength===
This property forces the length of the cursor of scroll bar to be static instead of being adjusted automatically.
<syntaxhighlight lang="lua">dgsSetProperty(scrollpane,"scrollBarLength",{{VerticalLen,VerticalRelative},{HorizontalLen,HorizontalRelative}})</syntaxhighlight>
*'''VerticalLen:''' A float of the cursor length of the vertical scroll bar.
*'''VerticalRelative:''' A bool indicates whether the length is relative to the size of scroll bar or not.
*'''HorizontalLen:''' A float of the cursor length of the horizontal scroll bar.
*'''HorizontalRelative:''' A bool indicates whether the length is relative to the size of scroll bar or not.

==See Also==
{{DGSPROPERTIES}}

Dgs-dxscrollpane

2024-03-18T02:57:50Z

Thisdp: /* bgImage */

[[Dgs|DGS]] Properties is always used to change the gui style and make it more fantastic.

This page shows the properties of dgs-dxscrollpane that you could use.

==Main Functions==
*[[dgsSetProperty]]
*[[dgsGetProperty]]

==Properties==
===basePointOffset ===
This property changes the offset of the base point where x=0, y=0. And by default, base point offset is 0, 0.
<syntaxhighlight lang="lua">dgsSetProperty(scrollpane,"basePointOffset",{offsetX ,offsetY,relative})</syntaxhighlight>
*'''offsetX :''' A float of the 2D X offset relative to the position of the text of radio button, depends on relative.
*'''offsetY:''' A float of the 2D Y offset relative to the position of the text of radio button, depends on relative.
*'''relative:''' A bool of whether the offset is relative to the size of scroll pane or absolute pixels.

===bgColor===
This property determines the background color of the scroll pane.
<syntaxhighlight lang="lua">dgsSetProperty(scrollpane,"bgColor",bgColor)</syntaxhighlight>
*'''bgColor:''' An integer of the color that can be converted by [[tocolor]].

===bgImage===
This property determines the background image of the scroll pane. '''Specify [[Dgs-dxscrollpane#bgColor|bgColor]] before using bgImage'''
<syntaxhighlight lang="lua">dgsSetProperty(scrollpane,"bgImage",bgImage)</syntaxhighlight>
*'''bgImage:''' A material element that serves as the background image of the scroll pane (texture/shader/screen source/renderTarget).

===minViewSize===
This property determines the minimal view size of scroll pane. By default, view size is determined by the content in the scroll pane.
<syntaxhighlight lang="lua">dgsSetProperty(scrollpane,"minViewSize",{w,h,relative})</syntaxhighlight>
*'''w:''' A float if the minimal view size in width.
*'''h:''' A float if the minimal view size in height.
*'''relative:''' A bool of whether the minimal view size is relative to the size of scroll pane or absolute pixels.

===moveHardness===
This property determines how hard will the scroll pane moves when scrolling.
<syntaxhighlight lang="lua">dgsSetProperty(scrollpane,"moveHardness",{scrollHardness,dragHardness})</syntaxhighlight>
*'''scrollHardness:''' A float determins how hard will the scroll pane moves when scrolling with wheel ( should be larger than 0, lower than 1 ).
*'''dragHardness:''' A float determins how hard will the scroll pane moves when dragging with mouse ( should be larger than 0, lower than 1 ).

===padding===
This property determines the content padding from 4 sides of element (left/top/right/bottom)
<syntaxhighlight lang="lua">dgsSetProperty(scrollpane, "padding", {horizontal, vertical, relative})</syntaxhighlight>
*'''horizontal:''' A float of the horizontal padding in pixels.
*'''vertical:''' A float of the vertical padding in pixels.

===scrollBarThick===
This property determines the thickness of scroll bar.
<syntaxhighlight lang="lua">dgsSetProperty(scrollpane,"scrollBarThick",scrollBarThick)</syntaxhighlight>
*'''scrollBarThick:''' An integer of the thickness of scroll bar.

===scrollBarState===
This property forces the visibility of scroll bar. ''See [[dgsScrollPaneSetScrollBarState]]/[[dgsScrollPaneGetScrollBarState]]''
<syntaxhighlight lang="lua">dgsSetProperty(scrollpane,"scrollBarState",{vertical,horizontal})</syntaxhighlight>
*'''vertical:''' A bool of the state of the vertical scroll bar.
*'''horizontal:''' A bool of the state of the horizontal scroll bar.
**'''true:''' Force to be visible
**'''false:''' Force to be invisible
**'''nil:''' Auto

===scrollBarLength===
This property forces the length of the cursor of scroll bar to be static instead of being adjusted automatically.
<syntaxhighlight lang="lua">dgsSetProperty(scrollpane,"scrollBarLength",{{VerticalLen,VerticalRelative},{HorizontalLen,HorizontalRelative}})</syntaxhighlight>
*'''VerticalLen:''' A float of the cursor length of the vertical scroll bar.
*'''VerticalRelative:''' A bool indicates whether the length is relative to the size of scroll bar or not.
*'''HorizontalLen:''' A float of the cursor length of the horizontal scroll bar.
*'''HorizontalRelative:''' A bool indicates whether the length is relative to the size of scroll bar or not.

==See Also==
{{DGSPROPERTIES}}

Dgs-dxscrollpane

2024-03-18T02:57:37Z

Thisdp: /* bgImage */

[[Dgs|DGS]] Properties is always used to change the gui style and make it more fantastic.

This page shows the properties of dgs-dxscrollpane that you could use.

==Main Functions==
*[[dgsSetProperty]]
*[[dgsGetProperty]]

==Properties==
===basePointOffset ===
This property changes the offset of the base point where x=0, y=0. And by default, base point offset is 0, 0.
<syntaxhighlight lang="lua">dgsSetProperty(scrollpane,"basePointOffset",{offsetX ,offsetY,relative})</syntaxhighlight>
*'''offsetX :''' A float of the 2D X offset relative to the position of the text of radio button, depends on relative.
*'''offsetY:''' A float of the 2D Y offset relative to the position of the text of radio button, depends on relative.
*'''relative:''' A bool of whether the offset is relative to the size of scroll pane or absolute pixels.

===bgColor===
This property determines the background color of the scroll pane.
<syntaxhighlight lang="lua">dgsSetProperty(scrollpane,"bgColor",bgColor)</syntaxhighlight>
*'''bgColor:''' An integer of the color that can be converted by [[tocolor]].

===bgImage===
This property determines the background image of the scroll pane. ''Specify '''[[Dgs-dxscrollpane#bgColor|bgColor]]''' before using bgImage''
<syntaxhighlight lang="lua">dgsSetProperty(scrollpane,"bgImage",bgImage)</syntaxhighlight>
*'''bgImage:''' A material element that serves as the background image of the scroll pane (texture/shader/screen source/renderTarget).

===minViewSize===
This property determines the minimal view size of scroll pane. By default, view size is determined by the content in the scroll pane.
<syntaxhighlight lang="lua">dgsSetProperty(scrollpane,"minViewSize",{w,h,relative})</syntaxhighlight>
*'''w:''' A float if the minimal view size in width.
*'''h:''' A float if the minimal view size in height.
*'''relative:''' A bool of whether the minimal view size is relative to the size of scroll pane or absolute pixels.

===moveHardness===
This property determines how hard will the scroll pane moves when scrolling.
<syntaxhighlight lang="lua">dgsSetProperty(scrollpane,"moveHardness",{scrollHardness,dragHardness})</syntaxhighlight>
*'''scrollHardness:''' A float determins how hard will the scroll pane moves when scrolling with wheel ( should be larger than 0, lower than 1 ).
*'''dragHardness:''' A float determins how hard will the scroll pane moves when dragging with mouse ( should be larger than 0, lower than 1 ).

===padding===
This property determines the content padding from 4 sides of element (left/top/right/bottom)
<syntaxhighlight lang="lua">dgsSetProperty(scrollpane, "padding", {horizontal, vertical, relative})</syntaxhighlight>
*'''horizontal:''' A float of the horizontal padding in pixels.
*'''vertical:''' A float of the vertical padding in pixels.

===scrollBarThick===
This property determines the thickness of scroll bar.
<syntaxhighlight lang="lua">dgsSetProperty(scrollpane,"scrollBarThick",scrollBarThick)</syntaxhighlight>
*'''scrollBarThick:''' An integer of the thickness of scroll bar.

===scrollBarState===
This property forces the visibility of scroll bar. ''See [[dgsScrollPaneSetScrollBarState]]/[[dgsScrollPaneGetScrollBarState]]''
<syntaxhighlight lang="lua">dgsSetProperty(scrollpane,"scrollBarState",{vertical,horizontal})</syntaxhighlight>
*'''vertical:''' A bool of the state of the vertical scroll bar.
*'''horizontal:''' A bool of the state of the horizontal scroll bar.
**'''true:''' Force to be visible
**'''false:''' Force to be invisible
**'''nil:''' Auto

===scrollBarLength===
This property forces the length of the cursor of scroll bar to be static instead of being adjusted automatically.
<syntaxhighlight lang="lua">dgsSetProperty(scrollpane,"scrollBarLength",{{VerticalLen,VerticalRelative},{HorizontalLen,HorizontalRelative}})</syntaxhighlight>
*'''VerticalLen:''' A float of the cursor length of the vertical scroll bar.
*'''VerticalRelative:''' A bool indicates whether the length is relative to the size of scroll bar or not.
*'''HorizontalLen:''' A float of the cursor length of the horizontal scroll bar.
*'''HorizontalRelative:''' A bool indicates whether the length is relative to the size of scroll bar or not.

==See Also==
{{DGSPROPERTIES}}

Dgs-dxscrollpane

2024-03-18T02:57:23Z

Thisdp: /* bgImage */

[[Dgs|DGS]] Properties is always used to change the gui style and make it more fantastic.

This page shows the properties of dgs-dxscrollpane that you could use.

==Main Functions==
*[[dgsSetProperty]]
*[[dgsGetProperty]]

==Properties==
===basePointOffset ===
This property changes the offset of the base point where x=0, y=0. And by default, base point offset is 0, 0.
<syntaxhighlight lang="lua">dgsSetProperty(scrollpane,"basePointOffset",{offsetX ,offsetY,relative})</syntaxhighlight>
*'''offsetX :''' A float of the 2D X offset relative to the position of the text of radio button, depends on relative.
*'''offsetY:''' A float of the 2D Y offset relative to the position of the text of radio button, depends on relative.
*'''relative:''' A bool of whether the offset is relative to the size of scroll pane or absolute pixels.

===bgColor===
This property determines the background color of the scroll pane.
<syntaxhighlight lang="lua">dgsSetProperty(scrollpane,"bgColor",bgColor)</syntaxhighlight>
*'''bgColor:''' An integer of the color that can be converted by [[tocolor]].

===bgImage===
This property determines the background image of the scroll pane. ''Specify '''[[Dgs-dxscrollpane#bgColor|bgColor]''' before using bgImage''
<syntaxhighlight lang="lua">dgsSetProperty(scrollpane,"bgImage",bgImage)</syntaxhighlight>
*'''bgImage:''' A material element that serves as the background image of the scroll pane (texture/shader/screen source/renderTarget).

===minViewSize===
This property determines the minimal view size of scroll pane. By default, view size is determined by the content in the scroll pane.
<syntaxhighlight lang="lua">dgsSetProperty(scrollpane,"minViewSize",{w,h,relative})</syntaxhighlight>
*'''w:''' A float if the minimal view size in width.
*'''h:''' A float if the minimal view size in height.
*'''relative:''' A bool of whether the minimal view size is relative to the size of scroll pane or absolute pixels.

===moveHardness===
This property determines how hard will the scroll pane moves when scrolling.
<syntaxhighlight lang="lua">dgsSetProperty(scrollpane,"moveHardness",{scrollHardness,dragHardness})</syntaxhighlight>
*'''scrollHardness:''' A float determins how hard will the scroll pane moves when scrolling with wheel ( should be larger than 0, lower than 1 ).
*'''dragHardness:''' A float determins how hard will the scroll pane moves when dragging with mouse ( should be larger than 0, lower than 1 ).

===padding===
This property determines the content padding from 4 sides of element (left/top/right/bottom)
<syntaxhighlight lang="lua">dgsSetProperty(scrollpane, "padding", {horizontal, vertical, relative})</syntaxhighlight>
*'''horizontal:''' A float of the horizontal padding in pixels.
*'''vertical:''' A float of the vertical padding in pixels.

===scrollBarThick===
This property determines the thickness of scroll bar.
<syntaxhighlight lang="lua">dgsSetProperty(scrollpane,"scrollBarThick",scrollBarThick)</syntaxhighlight>
*'''scrollBarThick:''' An integer of the thickness of scroll bar.

===scrollBarState===
This property forces the visibility of scroll bar. ''See [[dgsScrollPaneSetScrollBarState]]/[[dgsScrollPaneGetScrollBarState]]''
<syntaxhighlight lang="lua">dgsSetProperty(scrollpane,"scrollBarState",{vertical,horizontal})</syntaxhighlight>
*'''vertical:''' A bool of the state of the vertical scroll bar.
*'''horizontal:''' A bool of the state of the horizontal scroll bar.
**'''true:''' Force to be visible
**'''false:''' Force to be invisible
**'''nil:''' Auto

===scrollBarLength===
This property forces the length of the cursor of scroll bar to be static instead of being adjusted automatically.
<syntaxhighlight lang="lua">dgsSetProperty(scrollpane,"scrollBarLength",{{VerticalLen,VerticalRelative},{HorizontalLen,HorizontalRelative}})</syntaxhighlight>
*'''VerticalLen:''' A float of the cursor length of the vertical scroll bar.
*'''VerticalRelative:''' A bool indicates whether the length is relative to the size of scroll bar or not.
*'''HorizontalLen:''' A float of the cursor length of the horizontal scroll bar.
*'''HorizontalRelative:''' A bool indicates whether the length is relative to the size of scroll bar or not.

==See Also==
{{DGSPROPERTIES}}

Dgs-dxscrollpane

2024-03-18T02:56:59Z

Thisdp:

[[Dgs|DGS]] Properties is always used to change the gui style and make it more fantastic.

This page shows the properties of dgs-dxscrollpane that you could use.

==Main Functions==
*[[dgsSetProperty]]
*[[dgsGetProperty]]

==Properties==
===basePointOffset ===
This property changes the offset of the base point where x=0, y=0. And by default, base point offset is 0, 0.
<syntaxhighlight lang="lua">dgsSetProperty(scrollpane,"basePointOffset",{offsetX ,offsetY,relative})</syntaxhighlight>
*'''offsetX :''' A float of the 2D X offset relative to the position of the text of radio button, depends on relative.
*'''offsetY:''' A float of the 2D Y offset relative to the position of the text of radio button, depends on relative.
*'''relative:''' A bool of whether the offset is relative to the size of scroll pane or absolute pixels.

===bgColor===
This property determines the background color of the scroll pane.
<syntaxhighlight lang="lua">dgsSetProperty(scrollpane,"bgColor",bgColor)</syntaxhighlight>
*'''bgColor:''' An integer of the color that can be converted by [[tocolor]].

===bgImage===
This property determines the background image of the scroll pane. ''Specify '''bgColor''' before using bgImage''
<syntaxhighlight lang="lua">dgsSetProperty(scrollpane,"bgImage",bgImage)</syntaxhighlight>
*'''bgImage:''' A material element that serves as the background image of the scroll pane (texture/shader/screen source/renderTarget).

===minViewSize===
This property determines the minimal view size of scroll pane. By default, view size is determined by the content in the scroll pane.
<syntaxhighlight lang="lua">dgsSetProperty(scrollpane,"minViewSize",{w,h,relative})</syntaxhighlight>
*'''w:''' A float if the minimal view size in width.
*'''h:''' A float if the minimal view size in height.
*'''relative:''' A bool of whether the minimal view size is relative to the size of scroll pane or absolute pixels.

===moveHardness===
This property determines how hard will the scroll pane moves when scrolling.
<syntaxhighlight lang="lua">dgsSetProperty(scrollpane,"moveHardness",{scrollHardness,dragHardness})</syntaxhighlight>
*'''scrollHardness:''' A float determins how hard will the scroll pane moves when scrolling with wheel ( should be larger than 0, lower than 1 ).
*'''dragHardness:''' A float determins how hard will the scroll pane moves when dragging with mouse ( should be larger than 0, lower than 1 ).

===padding===
This property determines the content padding from 4 sides of element (left/top/right/bottom)
<syntaxhighlight lang="lua">dgsSetProperty(scrollpane, "padding", {horizontal, vertical, relative})</syntaxhighlight>
*'''horizontal:''' A float of the horizontal padding in pixels.
*'''vertical:''' A float of the vertical padding in pixels.

===scrollBarThick===
This property determines the thickness of scroll bar.
<syntaxhighlight lang="lua">dgsSetProperty(scrollpane,"scrollBarThick",scrollBarThick)</syntaxhighlight>
*'''scrollBarThick:''' An integer of the thickness of scroll bar.

===scrollBarState===
This property forces the visibility of scroll bar. ''See [[dgsScrollPaneSetScrollBarState]]/[[dgsScrollPaneGetScrollBarState]]''
<syntaxhighlight lang="lua">dgsSetProperty(scrollpane,"scrollBarState",{vertical,horizontal})</syntaxhighlight>
*'''vertical:''' A bool of the state of the vertical scroll bar.
*'''horizontal:''' A bool of the state of the horizontal scroll bar.
**'''true:''' Force to be visible
**'''false:''' Force to be invisible
**'''nil:''' Auto

===scrollBarLength===
This property forces the length of the cursor of scroll bar to be static instead of being adjusted automatically.
<syntaxhighlight lang="lua">dgsSetProperty(scrollpane,"scrollBarLength",{{VerticalLen,VerticalRelative},{HorizontalLen,HorizontalRelative}})</syntaxhighlight>
*'''VerticalLen:''' A float of the cursor length of the vertical scroll bar.
*'''VerticalRelative:''' A bool indicates whether the length is relative to the size of scroll bar or not.
*'''HorizontalLen:''' A float of the cursor length of the horizontal scroll bar.
*'''HorizontalRelative:''' A bool indicates whether the length is relative to the size of scroll bar or not.

==See Also==
{{DGSPROPERTIES}}

Template:DGS Combo Box Functions

2024-03-11T05:26:29Z

Thisdp:

*[[dgsCreateComboBox]]
*[[dgsComboBoxAddItem]]
*[[dgsComboBoxRemoveItem]]
*[[dgsComboBoxSetItemText]]
*[[dgsComboBoxGetItemText]]
*[[dgsComboBoxSetItemData]]
*[[dgsComboBoxGetItemData]]
*[[dgsComboBoxGetItemCount]]
*[[dgsComboBoxClear]]
*[[dgsComboBoxSetSelectedItem]]
*[[dgsComboBoxGetSelectedItem]]
*[[dgsComboBoxSetItemColor]]
*[[dgsComboBoxGetItemColor]]
*[[dgsComboBoxSetItemImage]]
*[[dgsComboBoxGetItemImage]]
*[[dgsComboBoxRemoveItemImage]]
*[[dgsComboBoxSetItemBackGroundImage]]
*[[dgsComboBoxGetItemBackGroundImage]]
*[[dgsComboBoxSetItemBackGroundColor]]
*[[dgsComboBoxGetItemBackGroundColor]]
*[[dgsComboBoxSetItemFont]]
*[[dgsComboBoxGetItemFont]]
*[[dgsComboBoxGetState]]
*[[dgsComboBoxSetState]]
*[[dgsComboBoxGetBoxHeight]]
*[[dgsComboBoxSetBoxHeight]]
*[[dgsComboBoxSetViewCount]]
*[[dgsComboBoxGetViewCount]]
*[[dgsComboBoxGetScrollBar]]
*[[dgsComboBoxSetScrollBarState]]
*[[dgsComboBoxGetScrollBarState]]
*[[dgsComboBoxSetScrollPosition]]
*[[dgsComboBoxGetScrollPosition]]
*[[dgsComboBoxSetCaptionText]]
*[[dgsComboBoxGetCaptionText]]
*[[dgsComboBoxSetEditEnabled]]
*[[dgsComboBoxGetEditEnabled]]
*[[dgsComboBoxGetText]]
*[[dgsComboBoxSetSortFunction]]
*[[dgsComboBoxGetSortFunction]]
*[[dgsComboBoxSort]]

DgsEditAutoCompleteAddParameterFunction

2024-03-10T10:48:42Z

Thisdp:

__NOTOC__
{{Client function}}
This function adds the advanced usage of dgs edit auto complete, which can be used as dynamic auto complete.

==Syntax==
<syntaxhighlight lang="lua">
bool dgsEditAutoCompleteAddParameterFunction( string parameterType, string functionCode )
</syntaxhighlight>

===Required Arguments===
*'''parameterType:''' A string of the parameter type you want to attach.
*'''functionCode :''' A string of the function that you want to execute.

===Returns===
Returns true if successfully, false otherwise.

<syntaxhighlight lang="lua">
DGS = exports.dgs

edit = DGS:dgsCreateEdit(400,700,200,50,"",false)

DGS:dgsEditAddAutoComplete(edit,{"cmd","<player>"},true,true)

DGS:dgsEditAutoCompleteAddParameterFunction("<player>",[[
local input = ...
for i,player in ipairs(getElementsByType("player")) do
if input == getPlayerName(player):sub(1,#input) then
return getPlayerName(player)
end
end
]])
</syntaxhighlight>

==See Also==
{{DGSFUNCTIONS}}

DgsEditAutoCompleteAddParameterFunction

2024-03-10T10:48:18Z

Thisdp: Created page with "__NOTOC__ {{Client function}} This function adds the advanced usage of dgs edit auto complete, which can be used as dynamic auto complete. ==Syntax== <syntaxhighlight lang="lua"> element dgsEditAutoCompleteAddParameterFunction( string parameterType, string functionCode ) </syntaxhighlight> ===Required Arguments=== *'''parameterType:''' A string of the parameter type you want to attach. *'''functionCode :''' A string of the function that you want to execute. ===Ret..."

__NOTOC__
{{Client function}}
This function adds the advanced usage of dgs edit auto complete, which can be used as dynamic auto complete.

==Syntax==
<syntaxhighlight lang="lua">
element dgsEditAutoCompleteAddParameterFunction( string parameterType, string functionCode )
</syntaxhighlight>

===Required Arguments===
*'''parameterType:''' A string of the parameter type you want to attach.
*'''functionCode :''' A string of the function that you want to execute.

===Returns===
Returns true if successfully, false otherwise.

<syntaxhighlight lang="lua">
DGS = exports.dgs

edit = DGS:dgsCreateEdit(400,700,200,50,"",false)

DGS:dgsEditAddAutoComplete(edit,{"cmd","<player>"},true,true)

DGS:dgsEditAutoCompleteAddParameterFunction("<player>",[[
local input = ...
for i,player in ipairs(getElementsByType("player")) do
if input == getPlayerName(player):sub(1,#input) then
return getPlayerName(player)
end
end
]])
</syntaxhighlight>

==See Also==
{{DGSFUNCTIONS}}

DgsEditAddAutoComplete

2024-03-10T10:45:29Z

Thisdp:

__NOTOC__
{{Client function}}
This function adds an auto complete string to edit box.

==Syntax==
<syntaxhighlight lang="lua">
bool dgsEditAddAutoComplete( bool editBox, string/table str [, bool isSensitive = false, bool isAdvanced = false ] )
</syntaxhighlight>

===Required Arguments===
*'''edit:''' A dgs edit you wish to add auto complete.
*'''str:''' A string/table you want to set to auto complete.

===Optional Arguments===
*'''isSensitive:''' A bool indicates whether the auto complete text is capital sensitive or not.
*'''isAdvanced:''' A bool indicates whether the auto complete text is advanced for [[dgsEditAutoCompleteAddParameterFunction|parameter function]] usage.

===Returns===
Returns true if successfully, false otherwise.

<syntaxhighlight lang="lua">
DGS = exports.dgs
edit2 = DGS:dgsCreateEdit(0.3,0.6,0.2,0.05,"",true)
DGS:dgsEditAddAutoComplete(edit2,"You know what? I am an idiot!",false)
</syntaxhighlight>

==See Also==
{{DGSFUNCTIONS}}

DgsEditAddAutoComplete

2024-03-10T10:45:19Z

Thisdp:

__NOTOC__
{{Client function}}
This function adds an auto complete string to edit box.

==Syntax==
<syntaxhighlight lang="lua">
bool dgsEditAddAutoComplete( bool editBox, string/table str [, bool isSensitive = false, bool isAdvanced = false ] )
</syntaxhighlight>

===Required Arguments===
*'''edit:''' A dgs edit you wish to add auto complete.
*'''str:''' A string/table you want to set to auto complete.

===Optional Arguments===
*'''isSensitive:''' A bool indicates whether the auto complete text is capital sensitive or not.
*'''isAdvanced:''' A bool indicates whether the auto complete text is advanced for [[parameter function|dgsEditAutoCompleteAddParameterFunction]] usage.

===Returns===
Returns true if successfully, false otherwise.

<syntaxhighlight lang="lua">
DGS = exports.dgs
edit2 = DGS:dgsCreateEdit(0.3,0.6,0.2,0.05,"",true)
DGS:dgsEditAddAutoComplete(edit2,"You know what? I am an idiot!",false)
</syntaxhighlight>

==See Also==
{{DGSFUNCTIONS}}

DgsEditAddAutoComplete

2024-03-10T10:44:31Z

Thisdp:

__NOTOC__
{{Client function}}
This function adds an auto complete string to edit box.

==Syntax==
<syntaxhighlight lang="lua">
element dgsEditAddAutoComplete( bool editBox, string/table str [, bool isSensitive = false, bool isAdvanced = false ] )
</syntaxhighlight>

===Required Arguments===
*'''edit:''' A dgs edit you wish to add auto complete.
*'''str:''' A string/table you want to set to auto complete.

===Optional Arguments===
*'''isSensitive:''' A bool indicates whether the auto complete text is capital sensitive or not.
*'''isAdvanced:''' A bool indicates whether the auto complete text is advanced for [[parameter function]] usage.

===Returns===
Returns true if successfully, false otherwise.

<syntaxhighlight lang="lua">
DGS = exports.dgs
edit2 = DGS:dgsCreateEdit(0.3,0.6,0.2,0.05,"",true)
DGS:dgsEditAddAutoComplete(edit2,"You know what? I am an idiot!",false)
</syntaxhighlight>

==See Also==
{{DGSFUNCTIONS}}

Template:DGS Events/General

2024-02-13T04:24:55Z

Thisdp:

*[[onDgsBlur]]
*[[onDgsCreate]]
*[[onDgsCursorTypeChange]]
*[[onDgsCursorStateChange]]
*[[onDgsDestroy]]
*[[onDgsElementRender]]
*[[onDgsElementMove]]
*[[onDgsElementSize]]
*[[onDgsElementEnter]]
*[[onDgsElementLeave]]
*[[onDgsFocus]]
*[[onDgsKey]]
*[[onDgsPositionChange]]
*[[onDgsPreRender]]
*[[onDgsRender]]
*[[onDgsElementScroll]]
*[[onDgsSizeChange]]
*[[onDgsTextChange]]
*[[onDgsWindowClose]]
*[[onDgsPropertyChange]]

DgsScrollBarSetCursorLength

2024-02-12T03:48:11Z

Thisdp:

__NOTOC__
{{Client function}}
This function sets the length of scroll bar cursor.

==Syntax==
<syntaxhighlight lang="lua">
bool dgsScrollBarSetCursorLength( element scrollBar, float size [, bool relative])
</syntaxhighlight>

[[Image:DGS_ScrollBarDetail_A.png|thumb|DGS Scroll Detail]]
===Required Arguments===

*'''scrollBar:''' The scroll bar whose cursor have to be changed.
*'''size:''' A float of the length of the cursor.

===Optional Arguments===
*'''relative:''' This is whether sizes and positioning are relative. If this is true, then all width,height floats must be between 0 and 1, representing sizes relative to the scroll bar.

==Example==
<syntaxhighlight lang="lua">
DGS = exports.dgs
addEventHandler("onClientResourceStart", resourceRoot, function()
local scrollBar = DGS:dgsCreateScrollBar(0.29, 0.30, 0.44, 0.04, true, true)
DGS:dgsScrollBarSetCursorLength(scrollBar,0.1,true)
end)
</syntaxhighlight>

==See Also==
{{DGSFUNCTIONS}}

Template:DGS Scroll Bar Functions

2024-02-12T03:47:04Z

Thisdp:

*[[dgsCreateScrollBar]]
*[[dgsScrollBarSetScrollPosition]]
*[[dgsScrollBarGetScrollPosition]]
*[[dgsScrollBarSetGrades]]
*[[dgsScrollBarGetGrades]]
*[[dgsScrollBarSetLocked]]
*[[dgsScrollBarGetLocked]]
*[[dgsScrollBarSetCursorLength]]
*[[dgsScrollBarGetCursorLength]]
*[[dgsScrollBarSetCursorWidth]]
*[[dgsScrollBarGetCursorWidth]]
*[[dgsScrollBarSetTroughWidth]]
*[[dgsScrollBarGetTroughWidth]]
*[[dgsScrollBarSetArrowSize]]
*[[dgsScrollBarGetArrowSize]]
*[[dgsScrollBarSetTroughClickAction]]
*[[dgsScrollBarGetTroughClickAction]]

Dgs-dxscrollbar

2024-02-11T02:52:59Z

Thisdp: /* cursorWidth */

[[Dgs|DGS]] Properties is always used to change the gui style and make it more fantastic.

This page shows the properties of dgs-dxscrollbar that you could use.

==Main Functions==
*[[dgsSetProperty]]
*[[dgsGetProperty]]

==Properties==
===arrowWidth===
This property adjusts the width of arrow ( take vertical scroll bar as a standard ).
<syntaxhighlight lang="lua">dgsSetProperty(scrollbar,"arrowWidth",{arrowWidth,relative})</syntaxhighlight>
*'''arrowWidth:''' A number of the width of arrow, which is affected by '''relative'''.
*'''relative:''' A bool of whether the width is relative or not. If this is true, then length must be between 0 and 1.

===arrowColor===
The arrow color of scroll bar, includes normal, hovering, click.
<syntaxhighlight lang="lua">dgsSetProperty(scrollbar,"arrowColor",{arrowColorNormal,arrowColorHover,arrowColorClick})</syntaxhighlight>
*'''arrowColorNormal:''' An integer of the arrow color, which can be converted by [[tocolor]].
*'''arrowColorHover:''' An integer of the arrow color when the mouse's cursor is hovering on it, which can be converted by [[tocolor]].
*'''arrowColorClick:''' An integer of the arrow color when the arrow gets clicked, which can be converted by [[tocolor]].

===arrowImage===
The arrow image of scroll bar.
<syntaxhighlight lang="lua">dgsSetProperty(scrollbar,"arrowImage",arrowImage)</syntaxhighlight>
*'''arrowImage:''' A material element of the arrow image of scroll bar.

===cursorColor===
The cursor color of scroll bar, includes normal, hovering, click.
<syntaxhighlight lang="lua">dgsSetProperty(scrollbar,"cursorColor",{cursorColorNormal,cursorColorHover,cursorColorClick})</syntaxhighlight>
*'''cursorColorNormal:''' An integer of the cursor color, which can be converted by [[tocolor]].
*'''cursorColorHover:''' An integer of the cursor color when the mouse's cursor is hovering on it, which can be converted by [[tocolor]].
*'''cursorColorClick:''' An integer of the cursor color when the cursor gets clicked, which can be converted by [[tocolor]].

===cursorImage===
The cursor image of scroll bar.
<syntaxhighlight lang="lua">dgsSetProperty(scrollbar,"cursorImage",cursorImage)</syntaxhighlight>
*'''cursorImage:''' A material element of the cursor image of scroll bar.

===cursorWidth===
This property adjusts the width of cursor ( take vertical scroll bar as a standard ).
<syntaxhighlight lang="lua">dgsSetProperty(scrollbar,"cursorWidth",{cursorWidth,relative})</syntaxhighlight>
*'''cursorWidth:''' A number of the width of cursor, which is affected by '''relative'''.
*'''relative:''' A bool of whether the width is relative or not. If this is true, then length must be between 0 and 1.

===grades===
This property stores the grades of scroll bar. ''See [[dgsScrollBarSetGrades]]/[[dgsScrollBarGetGrades]]''
<syntaxhighlight lang="lua">dgsSetProperty(scrollbar,"grades",grades)</syntaxhighlight>
*'''grades:''' A number of the grades of scroll bar.

===currentGrade===
This property stores the current grade of scroll bar if ''grades'' enabled.
<syntaxhighlight lang="lua">dgsSetProperty(scrollbar,"currentGrade",currentGrade)</syntaxhighlight>
*'''currentGrade:''' A number of the current grade, ranges from 0 to ''grades''.

===image===
The image of scroll bar, includes arrow, cursor and trough.
<syntaxhighlight lang="lua">dgsSetProperty(scrollbar,"image",{arrowImage,cursorImage,troughImage})</syntaxhighlight>
*'''arrowImage:''' A texture of the image of arrow.
*'''cursorImage:''' A texture of the image of cursor.
*'''troughImage:''' A texture of the image of trough.

===imageRotation===
This property solves the problem of the rotation of the images.
<syntaxhighlight lang="lua">dgsSetProperty(scrollbar,"imageRotation",{Horizontal,Vertical})</syntaxhighlight>
*'''Horizontal:''' A table includes arrowImageRotation,cursorImageRotation,troughImageRotation of horizontal scroll bar, by default:
<syntaxhighlight lang="lua" >{0,270,270}</syntaxhighlight>
*'''Vertical:''' A table includes arrowImageRotation,cursorImageRotation,troughImageRotation of vertical scroll bar, by default:
<syntaxhighlight lang="lua" >{270,0,0}</syntaxhighlight>

===length===
This property determines whether the length of the cursor of scroll bar.
<syntaxhighlight lang="lua">dgsSetProperty(scrollbar,"length",{length,relative})</syntaxhighlight>
*'''length:''' A number of the length of scroll bar, which is affected by '''relative'''.
*'''relative:''' A bool of whether the length is relative or not. If this is true, then length must be between 0 and 1.

===locked===
This is equivalent to [[dgsScrollBarSetLocked]]/[[dgsScrollBarGetLocked]].
<syntaxhighlight lang="lua">dgsSetProperty(scrollbar,"locked",locked)</syntaxhighlight>
*'''locked:''' A bool of whether the scroll bar get locked or not.

===map===
This property will map the value from 0~100 to mapMin~mapMax (Both get and set scroll position).
<syntaxhighlight lang="lua">dgsSetProperty(scrollbar,"map",{mapMin,mapMax})</syntaxhighlight>
*'''mapMin:''' A number of the min value.
*'''mapMax:''' A number of the max value.

===multiplier===
This property determines whether how much a scroll bar will scroll when you click the arrow or use mouse wheel.

This property is difficult to understand. Before use this property, do an experiment first.
<syntaxhighlight lang="lua">dgsSetProperty(scrollbar,"multiplier",{multiplier,relative})</syntaxhighlight>
*'''multiplier:''' A number of the multiplier of scroll bar, which is affected by '''relative'''.
*'''relative:''' A bool of whether the multiplier is relative or not. If this is true, then multiplier must be between 0 and 1.

===scrollPosition===
This is equivalent to [[dgsScrollBarSetScrollPosition]]/[[dgsScrollBarGetScrollPosition]].
<syntaxhighlight lang="lua">dgsSetProperty(scrollbar,"scrollPosition",scrollPosition)</syntaxhighlight>
*'''scrollPosition:''' An integer of the scroll poisition of the scroll bar. Ranges from 0 to 100.

===scrollArrow===
This property indicates whether enable the scroll arrow or not. It is useful when making scroll bar act as slide or something else.
<syntaxhighlight lang="lua">dgsSetProperty(scrollbar,"scrollArrow",scrollArrow)</syntaxhighlight>
*'''scrollArrow:''' A bool of whether enable the scroll arrow or not.

===troughClickAction===
This property determines what will the scroll bar do when you click the trough.
<syntaxhighlight lang="lua">dgsSetProperty(scrollbar,"troughClickAction",troughClickAction)</syntaxhighlight>
*'''troughClickAction:''' A string. Available values are as follows:
**'''none:''' No actions.
**'''step:''' Step up or down.
**'''jump:''' Make cursor of scroll bar jump to the current place you click.

===troughColor===
The trough color of scroll bar.
<syntaxhighlight lang="lua">dgsSetProperty(scrollbar,"troughColor",{troughColorPart1,troughColorPart2})</syntaxhighlight>
*'''troughColorPart1:''' An integer of the trough color on the left/top side of the cursor, which can be converted by [[tocolor]].
*'''troughColorPart2:''' An integer of the trough color on the right/bottom side of the cursor, which can be converted by [[tocolor]].

===troughImageSectionMode===
This property will toggle section mode or stretch mode.
<syntaxhighlight lang="lua">dgsSetProperty(scrollbar,"troughImageSectionMode",troughImageSectionMode)</syntaxhighlight>
*'''troughImageSectionMode:''' A bool indicates whether to enable section mode of the image or keep stretch mode of the trough image.

===troughWidth===
This property adjusts the width of trough ( take vertical scroll bar as a standard ).
<syntaxhighlight lang="lua">dgsSetProperty(scrollbar,"troughWidth",{troughWidth,relative})</syntaxhighlight>
*'''troughWidth:''' A number of the width of arrow, which is affected by '''relative'''.
*'''relative:''' A bool of whether the width is relative or not. If this is true, then length must be between 0 and 1.

===troughImage===
The trough image of scroll bar.
<syntaxhighlight lang="lua">dgsSetProperty(scrollbar,"troughImage",troughImage)</syntaxhighlight>
*'''troughImage:''' A material element of the trough image of scroll bar.

===wheelReversed===
This property determines whether the increasing/decreasing direction is reversed when using mouse wheel.
<syntaxhighlight lang="lua">dgsSetProperty(scrollbar,"wheelReversed",wheelReversed)</syntaxhighlight>
*'''wheelReversed:''' A bool indicates whether the increasing/decreasing direction is reversed when using mouse wheel.

===isHorizontal===
This property determines whether the scroll bar is horizontal or vertical.
<syntaxhighlight lang="lua">dgsSetProperty(scrollbar,"isHorizontal",isHorizontal)</syntaxhighlight>
*'''isHorizontal:''' Available values are as follows:
**'''false:''' vertical
**'''true:''' horizontal

==See Also==
{{DGSPROPERTIES}}

DgsGradientSetColor

2023-11-15T02:43:28Z

Thisdp: Created page with "__NOTOC__ {{Client function}} This function sets the color of the dgs gradient plugin. ==Syntax== <syntaxhighlight lang="lua"> bool dgsGradientSetColor( element gradShader, int colorFrom, int colorTo ) </syntaxhighlight> ===Required Arguments=== *'''gradShader:''' The dgs gradient you want to set. *'''colorFrom''': Gradient color 1. ( Left side when '''rotation''' is 0 ) *'''colorTo ''': Gradient color 2. ( Right side when '''rotation''' is 0 ) ===Returns=== Return..."

__NOTOC__
{{Client function}}

This function sets the color of the dgs gradient plugin.

==Syntax==
<syntaxhighlight lang="lua">
bool dgsGradientSetColor( element gradShader, int colorFrom, int colorTo )
</syntaxhighlight>

===Required Arguments===
*'''gradShader:''' The dgs gradient you want to set.
*'''colorFrom''': Gradient color 1. ( Left side when '''rotation''' is 0 )
*'''colorTo ''': Gradient color 2. ( Right side when '''rotation''' is 0 )

===Returns===
Returns ''true'' if successful, false otherwise.

==Example==
<syntaxhighlight lang="lua">
DGS = exports.dgs

-- Create A Gradient Plugin
gradient = DGS:dgsCreateGradient(tocolor(240,10,10,255),tocolor(100,10,10,255),-90)

-- Create A Button
img = DGS:dgsCreateImage( 0.7, 0.1, 0.2, 0.1, gradient, true )

-- Change Color
DGS:dgsGradientSetColor(tocolor(10,10,10,255),tocolor(100,10,10,255))

</syntaxhighlight>

==See Also==
{{DGSFUNCTIONS}}