Multi Theft Auto: Wiki - User contributions [en]

Resource:DGS

2025-05-01T09:42:30Z

XLive: Remove outdated examples

<pageclass class="resource" subcaption="Resource"></pageclass>
[[Image:DGS_Logo.png|400px|thumb|right|DGS Logo By [[User:Allerek|Allerek]]]]
This resource is designed to allow you to create directX GUI's as an alternative to the original MTA:SA GUI functions.

<span style="color:#DD2222;text-shadow:black 0em 0em 0.3em;">This wiki is always for the latest DGS version!</span>

<div style="padding:10px; border-radius:2px;font-size:14px;">
'''Full Name''': Thisdp's DirectX Graphical User Interface System (DxGUI Lib)

'''State''': <span style="color:#FFFFFF;text-shadow:black 0em 0em 0.3em;">OpenSource</span> & <span style="color:#55FF55;text-shadow:black 0em 0em 0.3em;">Work in progress</span>

'''Github Repo''': https://github.com/thisdp/dgs

'''Resource Download''': [https://github.com/thisdp/dgs/releases/latest/download/dgs.zip dgs.zip]

'''Server Discord''': https://discord.gg/QEs8q6W

'''Current Version''': 3.522

'''Update Log''': [https://github.com/thisdp/dgs/releases/tag/3.522 Changes and Updates Log]

'''Auto Completion & Syntax Highlight'''

Official:

'''Latest VSCode Snippets:''' [https://raw.githubusercontent.com/Armisael2k/mtasa-wiki-scrapper/master/functions.json VSCode Snippets (Last Update: Auto every month) By '''motar2k''']

Use the following command in server console to crawl and generate the latest auto completion (Only support NotePad++/Sublime/VSCode).
*'''g2d -crawl npp/sublime/vscode'''
Or you can use the following link to download completed files instead of crawling by yourself.
*[https://drive.google.com/file/d/1H_PiG2gmEz1AyXqZN4956IVgtZOjgMi6/view?usp=sharing NotePad++]
*[https://drive.google.com/file/d/1_07WBEWjriTTucrNGI7jT-4SknALKG6B/view?usp=sharing Sublime]
*[https://drive.google.com/file/d/1J4qoSjzmXZz7yxHUZ2fExBu3zvCwRESn/view?usp=sharing VSCode (Old)]

3rd Party Auto Completion:
*1. [http://www.mediafire.com/file/m6dm7815d5dihax/lua.zip NotePad++ By '''Ahmed Ly''']
*2. [https://marketplace.visualstudio.com/items?itemName=ERAGON.mtasa-dgs-lua Visual Studio Code By '''BW~ERAGON >''' ]
</div>

=Features=

[[Image:DGSNetStatus.png|300px|thumb|right|DGS Network Monitor]]

[[Image:DGSS.png|400px|thumb|right|]]

'''How does it work?'''
*DGS is based on [[element]] system, which just likes the cegui system. To make everything easy to use and understand, DGS has almost the same usage as CEGUI.
*DGS supports OOP syntax, if you don't like POP, then use OOP instead. But you should know that OOP is slower than POP.
*DGS elements are rendered in the event "onClientRender". When "onClientRender" is called, every DGS elements will be looped and calculated.
Examples can be found in the [https://github.com/thisdp/dgs/blob/master/test.lua test.lua] file inside DGS folder.

'''What's different from cegui?'''
*This resource is based on dx* functions, so its style will be more flexible than cegui, which means you can define the style by yourself.
*The latest '''Style System''' enables developer to define their own style such as changing color, loading images and even loading shaders with dgs elements on the server instead of using a lot of [[dgsSetProperty]]/[[dgsSetProperties]].

'''Update System'''
*It have an update system that can inform you of keeping your DGS latest.
*When a newer version has been released, it will detecte the version changing periodically and then notice you.
*Execute command "'''updatedgs'''" to check the least version and update your DGS.
*Also, you can check the version of DGS by inputting the command "dgsver"

'''You Should Know'''
*This project was started from 2014.
*Some of DGS elements use '''Render Target''', which means if you don't have enough video memory, '''Render Target won't be created''', and therefore those dgs elements won't be shown.

[[Image:Dx_7.PNG|400px|thumb|right|Example DGS Cmd]]

'''Debug'''
* You can enter the debug mode by executing the command "'''debugdgs'''".
* "'''debugdgs'''": Simple debug mode. For basic information.
* "'''debugdgs 2 '''": Render debug mode. To see dgs elements' scale with a rainbow border
* "'''debugdgs 3 '''": Tracing debug mode. To trace something for example where the dgs elements' were created, and the tracing mode of some functions will be enabled to show the detail.

'''Notice'''
*It is recommended to change the resource name to 'dgs'.
*This is a resource, if you want to use the functions exported by this resource, you should use an exported function prefix ('''exports.dgs:''') call in your code, such as
<syntaxhighlight lang="lua">
label = exports.dgs:dgsCreateLabel(0, 0, 0.5, 0.1, "text", true)
</syntaxhighlight>
*Here is a feasible way to shorten the name of an exported function:
<syntaxhighlight lang="lua">
DGS = exports.dgs --shorten the export function prefix
label = DGS:dgsCreateLabel(0,0,0.5,0.1,"text",true) --create a label
</syntaxhighlight>
*From the latest version, it no longer needs '''exports.dgs:''', instead we can do
<syntaxhighlight lang="lua">
loadstring(exports.dgs:dgsImportFunction())()-- load functions
label = dgsCreateLabel(0,0,0.5,0.1,"text",true) --create a label
</syntaxhighlight>
'''Object Oriented Programming'''
<syntaxhighlight lang="lua">
loadstring(exports.dgs:dgsImportOOPClass(true))()-- 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>

'''Special thanks to the following for their help (Respect the contributors)''':
* Axel, Senpai, ZoNe
* DiGiTal, #Dv^, maksam07
* Scorpyo, Kingleonide, Bullet(.el3tar)
* Allerek, Deihim007, OmarSwaitti(HankVoight)
* FlyingFork, Lettify, Ahmed Ly
* ᴛᴇᴍᴏɪꜱ, Shady

='''DGS Tips'''=
*[[DGS Events and GUI Events]]
*[[DGS Functions and GUI Functions]]
*[[DGS Grid List]]
*[[DGS OOP Class]]
*[[DGS Custom Plugin]]
*[[DGS Style System]]
*[[G2D|DGS GUI To DGS]]

='''DGS Element Properties'''=
{{DGSPROPERTIES}}

='''Client Functions'''=
{{DGSFUNCTIONS}}

=Client Events=
{{DGSEVENTS}}

=Last=
'''Everyone is welcome to make suggestions, test the script, help make adjustments/finish the wiki, etc.'''
[[Category:Resource]]

[[ar:Resource:Dgs]]
[[ZH-CN:Resource:Dgs]]
[[PL:Resource:Dgs]]
[[TR:Resource:Dgs]]

DgsImageSetImage

2024-12-02T18:00:53Z

XLive:

{{Client function}}
__NOTOC__
This function allows you to change the image in DGS image element to another one.

'''Note:'''
*If you pass '''path''' into this function, path will be converted into '''texture element''' handled by dgs.
*If you want to control the '''texture''' by yourself, please pass a '''texture element''' into this function.

==Syntax==
<syntaxhighlight lang="lua">
bool dgsImageSetImage ( element theElement, element/string texture )
</syntaxhighlight>

===Required Arguments===
*'''theElement:''' The image element to be changed.
*'''texture:''' A texture/shader/render target/screen source/image path that you want to set.

===Returns===
Returns ''true'' if the image in the image element was successfully changed, ''false'' otherwise.

==Example==
<syntaxhighlight lang="lua">
DGS = exports.dgs
local texture = dxCreateTexture("text.png") -- You need to add a texture yourself.
local myImage = DGS:dgsCreateImage ( 0.45, 0.48, 0.2, 0.5, _, true )
setTimer ( DGS:dgsImageSetImage, 10000, 1, myImage, texture )
</syntaxhighlight>

==See Also==
{{DGSFUNCTIONS}}

DgsComboBoxSetItemBackGroundColor

2023-11-14T13:54:23Z

XLive: typo

{{Client function}}

This function sets the background color of a specific item of the combo box.

==Syntax==
<syntaxhighlight lang="lua">
bool dgsComboBoxSetItemBackGroundColor( element comboBox, int itemIndex, int imageDefault, int imageHoving, int imageSelected )
</syntaxhighlight>

===Required Arguments===
*'''comboBox:''' the combo box that you want to operate.
*'''itemIndex:''' An integer of the item index.
*'''colorDefault:''' An integer of the color of the item (Default State).
*'''colorHoving:''' An integer of the color of the item (Hoving State).
*'''colorSelected:''' An integer of the color of the item (Selected State).

===Returns===
Returns '''true''' if set successfully, ''false'' if one of the arguments was invalid.

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

combobox = DGS:dgsCreateComboBox(200,50,600,50,false)
for i=1,30 do
DGS:dgsComboBoxAddItem(combobox,randomLetter(10)..tostring(i).." Test DGS")
DGS:dgsComboBoxSetItemBackGroundColor(combobox,i,tocolor(255,255,255,255),tocolor(0,0,255,255),tocolor(255,0,0,255))
end

</syntaxhighlight>

==See Also==
{{DGSFUNCTIONS}}

IsElementStreamedIn

2023-09-17T19:30:19Z

XLive: OOP

__NOTOC__
{{Client function}}
This function checks whether an [[element]] is currently streamed in (not virtualized) and are actual GTA objects in the world. You can force an element to be streamed in using [[setElementStreamable]].<br>
{{Deprecated feature|3|1.0|
DP2 can return true even if this element is not fully streamed in. This can happen during the period when the vehicle/object model is loading while the element is not actually fully created yet.
}}

==Syntax==
<syntaxhighlight lang="lua">
bool isElementStreamedIn ( element theElement )
</syntaxhighlight>
{{OOP||[[element]]:isStreamedIn|streamedIn}}

===Required Arguments===
* '''theElement''': The [[element]] to check whether is streamed in or not.

===Returns===
Returns ''true'' if the passed element is currently streamed in, ''false'' if it is virtualized.

==Example==
This command shows you how many objects you have streamed in.
<syntaxhighlight lang="lua">
function checkTheObjects ( cmd )
local amount = 0 -- When starting the command, we don't have any objects looped.
for k,v in ipairs ( getElementsByType ( "object" ) ) do -- Looping all the objects in the server
if isElementStreamedIn ( v ) then -- If the object is streamed in
amount = amount + 1 -- It's an object more streamed in
end
end
outputChatBox ( "You have currently " ..amount.. " objects streamed in." ) -- Send the player the amount of objects that are streamed in
end
addCommandHandler ( "checkobjects", checkTheObjects )
</syntaxhighlight>
Note: Objects can already stream from a very long distance, so even when you can't see some objects, they can still be returned.

==See Also==
{{Client element functions}}

Template:DGSEVENTS

2023-09-08T22:25:38Z

XLive: typo

==<span style="color:#eb3f00;text-shadow:0.05em 0.05em 0.2em #00000099;">General</span>==
{{DGS Events/General}}

==<span style="color:#eb3f00;text-shadow:0.05em 0.05em 0.2em #00000099;">Check Box</span>==
{{DGS Events/Check Box}}

==<span style="color:#eb3f00;text-shadow:0.05em 0.05em 0.2em #00000099;">Combo Box</span>==
{{DGS Events/Combo Box}}

==<span style="color:#eb3f00;text-shadow:0.05em 0.05em 0.2em #00000099;">Drag'N Drop</span>==
{{DGS Events/DragNDrop}}

==<span style="color:#eb3f00;text-shadow:0.05em 0.05em 0.2em #00000099;">Edit</span>==
{{DGS Events/Edit}}

==<span style="color:#eb3f00;text-shadow:0.05em 0.05em 0.2em #00000099;">Grid List</span>==
{{DGS Events/GridList}}

==<span style="color:#eb3f00;text-shadow:0.05em 0.05em 0.2em #00000099;">Menu</span>==
{{DGS Events/Menu}}

==<span style="color:#eb3f00;text-shadow:0.05em 0.05em 0.2em #00000099;">Selector</span>==
{{DGS Events/Selector}}

==<span style="color:#eb3f00;text-shadow:0.05em 0.05em 0.2em #00000099;">Mouse</span>==
{{DGS Events/Mouse}}

==<span style="color:#eb3f00;text-shadow:0.05em 0.05em 0.2em #00000099;">Radio Button</span>==
{{DGS Events/Radio Button}}

==<span style="color:#eb3f00;text-shadow:0.05em 0.05em 0.2em #00000099;">Switch Button</span>==
{{DGS Events/Switch Button}}

==<span style="color:#eb3f00;text-shadow:0.05em 0.05em 0.2em #00000099;">Tab</span>==
{{DGS Events/Tab}}

==<span style="color:#eb3f00;text-shadow:0.05em 0.05em 0.2em #00000099;">Animation</span>==
{{DGS Events/Animation}}

==<span style="color:#eb3f00;text-shadow:0.05em 0.05em 0.2em #00000099;">Plugin</span>==

===<span style="color:#eb3f00;text-shadow:0.05em 0.05em 0.2em #00000099;">Media</span>===
{{DGS Events/Plugin/Media Browser}}

===<span style="color:#eb3f00;text-shadow:0.05em 0.05em 0.2em #00000099;">Color Picker</span>===
{{DGS Events/Plugin/Color Picker}}

===<span style="color:#eb3f00;text-shadow:0.05em 0.05em 0.2em #00000099;">QRCode</span>===
{{DGS Events/Plugin/QRCode}}

===<span style="color:#eb3f00;text-shadow:0.05em 0.05em 0.2em #00000099;">Remote Image</span>===
{{DGS Events/Plugin/Remote Image}}

Resource:DGS

2023-07-16T19:38:15Z

XLive: download link

<pageclass class="resource" subcaption="Resource"></pageclass>
[[Image:DGS_Logo.png|400px|thumb|right|DGS Logo By [[User:Allerek|Allerek]]]]
This resource is designed to allow you to create directX GUI's as an alternative to the original MTA:SA GUI functions.

<span style="color:#DD2222;text-shadow:black 0em 0em 0.3em;">This wiki is always for the latest DGS version!</span>

<div style="padding:10px; border-radius:2px;font-size:14px;">
'''Full Name''': Thisdp's DirectX Graphical User Interface System (DxGUI Lib)

'''State''': <span style="color:#FFFFFF;text-shadow:black 0em 0em 0.3em;">OpenSource</span> & <span style="color:#55FF55;text-shadow:black 0em 0em 0.3em;">Work in progress</span>

'''Source code''': https://github.com/thisdp/dgs

'''Download''': [https://github.com/thisdp/dgs/releases/latest/download/dgs.zip GitHub]

'''Server Discord''': https://discord.gg/QEs8q6W

'''Current Version''': 3.521

'''Update Log''': [[DGS Updates Log|Changes and Updates Log]]

'''Auto Completion & Syntax Highlight'''

Official:

'''Latest VSCode Snippets:''' [https://raw.githubusercontent.com/Armisael2k/mtasa-wiki-scrapper/master/functions.json VSCode Snippets (Last Update: 06/02/2023) By '''motar2k''']

Use the following command in server console to crawl and generate the latest auto completion (Only support NotePad++/Sublime/VSCode).
*'''g2d -crawl npp/sublime/vscode'''
Or you can use the following link to download completed files instead of crawling by yourself.
*[https://drive.google.com/file/d/1H_PiG2gmEz1AyXqZN4956IVgtZOjgMi6/view?usp=sharing NotePad++]
*[https://drive.google.com/file/d/1_07WBEWjriTTucrNGI7jT-4SknALKG6B/view?usp=sharing Sublime]
*[https://drive.google.com/file/d/1J4qoSjzmXZz7yxHUZ2fExBu3zvCwRESn/view?usp=sharing VSCode (Old)]

3rd Party Auto Completion:
*1. [http://www.mediafire.com/file/m6dm7815d5dihax/lua.zip NotePad++ By '''Ahmed Ly''']
*2. [https://marketplace.visualstudio.com/items?itemName=ERAGON.mtasa-dgs-lua Visual Studio Code By '''BW~ERAGON >''' ]
</div>

=Features=

[[Image:DGSNetStatus.png|300px|thumb|right|DGS Network Monitor]]

[[Image:DGSS.png|400px|thumb|right|]]

'''How does it work?'''
*DGS is based on [[element]] system, which just likes the cegui system. To make DGS easier to use and understand, I choose to follow the usage of cegui's.
*DGS supports OOP syntax, if you don't like POP, then use OOP instead. But you should know that OOP is slower than POP.
*DGS elements are rendered in the event "onClientRender". When "onClientRender" is called, every DGS elements will be looped and calculated.

'''What's different from cegui?'''
*This resource is based on dx* functions, so its style will be more flexible than cegui, which means you can define the style by yourself.
*The latest '''Style System''' enables developer to define their own style such as changing color, loading images and even loading shaders with dgs elements on the server instead of using a lot of [[dgsSetProperty]]/[[dgsSetProperties]].

'''Update System'''
*It have an update system that can inform you of keeping your DGS latest.
*When a newer version has been released, it will detecte the version changing periodically and then notice you.
*Execute command "'''updatedgs'''" to check the least version and update your DGS.
*Also, you can check the version of DGS by inputting the command "dgsver"

'''You Should Know'''
*This project was started from 2014.
*Some of DGS elements use '''Render Target''', which means if you don't have enough video memory, '''Render Target won't be created''', and therefore those dgs elements won't be shown.

[[Image:Dx_7.PNG|400px|thumb|right|Example DGS Cmd]]

'''Examples scripts'''
*1.https://community.multitheftauto.com/index.php?p=resources&s=details&id=14757 By ([[User:Ahmed Ly|Ahmed Ly]] ,Mahmod Algeriany)
*2. Also File test.lua its have more Examples You can See it .
*3. This Video show you how to play a video by using Dgs https://www.youtube.com/watch?v=ZIq24zS5byI

'''Debug'''
* You can enter the debug mode by executing the command "'''debugdgs'''".
* "'''debugdgs'''": Simple debug mode. For basic information.
* "'''debugdgs 2 '''": Render debug mode. To see dgs elements' scale with a rainbow border
* "'''debugdgs 3 '''": Tracing debug mode. To trace something for example where the dgs elements' were created, and the tracing mode of some functions will be enabled to show the detail.

'''Notice'''
*It is recommended to change the resource name to 'dgs'.
*This is a resource, if you want to use the functions exported by this resource, you should use an exported function prefix ('''exports.dgs:''') call in your code, such as
<syntaxhighlight lang="lua">
label = exports.dgs:dgsCreateLabel(0, 0, 0.5, 0.1, "text", true)
</syntaxhighlight>
*Here is a feasible way to shorten the name of an exported function:
<syntaxhighlight lang="lua">
DGS = exports.dgs --shorten the export function prefix
label = DGS:dgsCreateLabel(0,0,0.5,0.1,"text",true) --create a label
</syntaxhighlight>
*From the latest version, it no longer needs '''exports.dgs:''', instead we can do
<syntaxhighlight lang="lua">
loadstring(exports.dgs:dgsImportFunction())()-- load functions
label = dgsCreateLabel(0,0,0.5,0.1,"text",true) --create a label
</syntaxhighlight>
'''Object Oriented Programming'''
<syntaxhighlight lang="lua">
loadstring(exports.dgs:dgsImportOOPClass(true))()-- 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>

'''Special thanks to the following for their help (Respect the contributors)''':
* Axel, Senpai, ZoNe
* DiGiTal, #Dv^, maksam07
* Scorpyo, Kingleonide, Bullet(.el3tar)
* Allerek, Deihim007, OmarSwaitti(HankVoight)
* FlyingFork, Lettify, Ahmed Ly
* ᴛᴇᴍᴏɪꜱ, Shady1

='''DGS Tips'''=
*[[DGS Events and GUI Events]]
*[[DGS Functions and GUI Functions]]
*[[DGS Grid List]]
*[[DGS OOP Class]]
*[[DGS Custom Plugin]]
*[[DGS Style System]]
*[[G2D|DGS GUI To DGS]]

='''DGS Element Properties'''=
{{DGSPROPERTIES}}

='''Client Functions'''=
{{DGSFUNCTIONS}}

=Client Events=
{{DGSEVENTS}}

=Last=
'''Everyone is welcome to make suggestions, test the script, help make adjustments/finish the wiki, etc.'''
[[Category:Resource]]

[[ar:Resource:Dgs]]
[[ZH-CN:Resource:Dgs]]
[[PL:Resource:Dgs]]
[[TR:Resource:Dgs]]

DgsCreateCanvas

2023-06-29T10:34:38Z

XLive: Remove unused color

__NOTOC__
{{Client function}}

This function creates a canvas that is used to draw multiple shaders.

==Syntax==
<syntaxhighlight lang="lua">
element dgsCreateCanvas( element renderSource, int width, int height )
</syntaxhighlight>

===Required Arguments===
*'''renderSource:''' The source to draw on the canvas, can be material such as texture, render target, shader etc.
*'''width:''' An integer indicates the width of canvas.
*'''height:''' An integer indicates the height of canvas.

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

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

local QRCode = DGS:dgsRequestQRCode("https://wiki.multitheftauto.com/wiki/Resource:Dgs") --Source Texture
local mask1 = DGS:dgsCreateMask(QRCode,"circle") --Apply Source Texture to Mask 1
local canvas = DGS:dgsCreateCanvas(mask1,200,200) --Draw Mask 1 in Canvas
local mask2 = DGS:dgsCreateMask(canvas ,"backgroundFilter") --Apply Canvas to Mask 2
local image = DGS:dgsCreateImage(300,300,200,200,mask2 ,false) --Draw Mask 2
</syntaxhighlight>

==See Also==
{{DGSFUNCTIONS}}

Dgs-dxgridlist

2023-06-11T14:12:14Z

XLive: Moved to mouseButtons property

[[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.

===mode===
This property determines the render mode of grid list.
<syntaxhighlight lang="lua">dgsSetProperty(gridlist,"mode",mode)</syntaxhighlight>
*'''mode:''' A bool of the state of render mode. Detail:
**'''true:''' No render target mode (Crappy and have a lot of bugs but doesn't take video memory)
**'''false:''' Render target mode (Great quality but takes video memory)

===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}}

Dgs-dxswitchbutton

2023-06-11T14:11:01Z

XLive: Moved to mouseButtons property

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

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

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

==Properties==
===clip===
Whether the clip property is enabled or not. ''Learn More [[dxDrawText]]''
<syntaxhighlight lang="lua">dgsSetProperty(switchButton,"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.

===cursorMoveSpeed===
This property determines the cursor moving speed when switch button changes state.
<syntaxhighlight lang="lua">dgsSetProperty(switchButton,"cursorMoveSpeed",cursorMoveSpeed)</syntaxhighlight>
*'''cursorMoveSpeed:''' A float of the cursor moving speed when switch button changes state.

===cursorWidth===
This property determines the cursor width of switch button.
<syntaxhighlight lang="lua">dgsSetProperty(switchButton,"cursorWidth",cursorWidth)</syntaxhighlight>
*'''cursorWidth:''' A float of the cursor width of switch button.

===cursorLength===
This property determines the cursor length of switch button.
<syntaxhighlight lang="lua">dgsSetProperty(switchButton,"cursorLength",cursorLength)</syntaxhighlight>
*'''cursorLength:''' A float of the cursor length of switch button.

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

===colorOn===
The color which can be translated by [[tocolor]] of the background color when the switch button turns on.
<syntaxhighlight lang="lua">dgsSetProperty(switchButton,"colorOn",{normalColor,hoverColor,clickColor})</syntaxhighlight>
*'''normalColor:''' A integer of background color of turned on switch button.
*'''hoverColor:''' A integer of background color of turned on switch button when the mouse is hovering on it.
*'''clickColor:''' A integer of background color of turned on switch button when the mouse is clicked on it.

===colorOff===
The color which can be translated by [[tocolor]] of the background color when the switch button turns off.
<syntaxhighlight lang="lua">dgsSetProperty(switchButton,"colorOff",{normalColor,hoverColor,clickColor})</syntaxhighlight>
*'''normalColor:''' A integer of background color of turned off switch button.
*'''hoverColor:''' A integer of background color of turned off switch button when the mouse is hovering on it.
*'''clickColor:''' A integer of background color of turned off switch button when the mouse is clicked on it.

===cursorColor===
The color which can be translated by [[tocolor]] of the cursor color.
<syntaxhighlight lang="lua">dgsSetProperty(switchButton,"cursorColor",{normalColor,hoverColor,clickColor})</syntaxhighlight>
*'''normalColor:''' A integer of cursor color of the switch button.
*'''hoverColor:''' A integer of cursor color of the switch button when the mouse is hovering on it.
*'''clickColor:''' A integer of cursor color of the switch button when the mouse is clicked on it.

===cursorImage===
The cursor image of switch button.
<syntaxhighlight lang="lua">dgsSetProperty(switchButton,"cursorImage",{normalColor,hoverColor,clickColor})</syntaxhighlight>
*'''normalImage:''' A material of cursor image of the switch button.
*'''hoverImage:''' A material of cursor image of the switch button when the mouse is hovering on it.
*'''clickImage:''' A material of cursor image of the switch button when the mouse is clicked on it.

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

===imageOn===
The background image of switch button when the state is on.
<syntaxhighlight lang="lua">dgsSetProperty(switchButton,"imageOn",{normalImage,hoverImage,clickImage})</syntaxhighlight>
*'''normalImage:''' A material of background image of turned on switch button.
*'''hoverImage:''' A material of background image of turned on switch button when the mouse is hovering on it.
*'''clickImage:''' A material of background image of turned on switch button when the mouse is clicked on it.

===imageOff===
The background image of switch button when the state is off.(
<syntaxhighlight lang="lua">dgsSetProperty(switchButton,"imageOff",{normalImage,hoverImage,clickImage})</syntaxhighlight>
*'''normalImage:''' A material of background image of turned off switch button.
*'''hoverImage:''' A material of background image of turned off switch button when the mouse is hovering on it.
*'''clickImage:''' A material of background image of turned off switch button when the mouse is clicked on it.

===shadow===
The shadow text of the switch button.
<syntaxhighlight lang="lua">dgsSetProperty(switchButton,"shadow",{offsetX,offsetY,color,outline})</syntaxhighlight>
*'''offsetX:''' A float of the 2D X offset of the shadow text of the switch button.
*'''offsetY:''' A float of the 2D Y offset of the shadow text of the switch button.
*'''color:''' An integer of the color of the shadow text of the switch button.
*'''outline:''' A bool of the outline state of the shadow text.

===state===
This property indicates the state of switch button.
<syntaxhighlight lang="lua">dgsSetProperty(switchButton,"state",state)</syntaxhighlight>
*'''state:''' A bool indicates the state of switch button.
**'''true:''' Turns on
**'''false:''' Turns off

===stateAnim===
This stores the progress of cursor animation, which is not recommend to modify.
<syntaxhighlight lang="lua">dgsSetProperty(switchButton,"stateAnim",stateAnim)</syntaxhighlight>
*'''stateAnim:''' A float of the cursor animation progress.

===style===
This property determines the state of switch button.
<syntaxhighlight lang="lua">dgsSetProperty(switchButton,"style",style)</syntaxhighlight>
*'''style:''' Mixed, available values are as follows:
**'''false:''' Default, a switch button with fading color when changing state.
**'''1:''' Split background color for turned on and off ( also split images ).
**'''2:''' Split background color for turned on and off ( not split images ).
**'''3:''' Do not split background color. Just switch gradually.
**'''4:''' No cursor. Just switch gradually.

===textOn===
This property stores the text to be shown when the switch button turns on.
<syntaxhighlight lang="lua">dgsSetProperty(switchButton,"textOn",textOn)</syntaxhighlight>
*'''textOn:''' A string of the text of the switch button.

===textOff===
This property stores the text to be shown when the switch button turns off.
<syntaxhighlight lang="lua">dgsSetProperty(switchButton,"textOff",textOff)</syntaxhighlight>
*'''textOff:''' A string of the text of the switch button.

===textColorOn===
The color which can be translated by [[tocolor]] of the text when the switch button turns on.
<syntaxhighlight lang="lua">dgsSetProperty(switchButton,"textColor_t",textColor_t)</syntaxhighlight>
*'''textColor_t:''' An integer of the color of the text when the switch button turns on.

===textColorOff===
The color which can be translated by [[tocolor]] of the text when the switch button turns off.(State=false)
<syntaxhighlight lang="lua">dgsSetProperty(switchButton,"textColor_f",textColor_f)</syntaxhighlight>
*'''textColor_f:''' An integer of the color of the text when the switch button turns off.

===textSize===
The scale of the text of the switch button. ''Learn More [[dxDrawText]]''
<syntaxhighlight lang="lua">dgsSetProperty(switchButton,"textSize",{scaleX,scaleY})</syntaxhighlight>
*'''scaleX:''' A float of the 2D X scale of the text of the switch button.
*'''scaleY:''' A float of the 2D Y scale of the text of the switch button.

===troughWidth===
This property determines trough length of switch button.
<syntaxhighlight lang="lua">dgsSetProperty(switchButton,"troughWidth",troughWidth)</syntaxhighlight>
*'''troughWidth:''' A float of the trough length of switch button.

===wordBreak===
Whether the word-break is enabled or not. ''Learn More [[dxDrawText]]''
<syntaxhighlight lang="lua">dgsSetProperty(switchButton,"wordBreak",wordBreak)</syntaxhighlight>
*'''wordBreak:''' If set to true, the text will wrap to a new line whenever it reaches the right side of the bounding box. If false, the text will always be completely on one line.

==See Also==
{{DGSPROPERTIES}}

PL/Dgs-dxbutton

2023-06-11T14:10:35Z

XLive: Moved to mouseButtons property

Właściwości [[Dgs|DGS]] są używane by zmieniać styl GUI i zrobić go lepszym!

Ta strona pokazuje właściwości dgs-dxbutton które możesz użyć.

==Główne funkcje==
*[[dgsSetProperty]]
*[[dgsGetProperty]]

==Właściwości==
===image===
Wymaga [texture/shader] który może być użyty jako tło przycisku.
<syntaxhighlight lang="lua">dgsSetProperty(button,"image",{defimg,hovimg,cliimg})</syntaxhighlight>
*'''defimg:''' Tekstura/shader tła przycisku (nie wybrany ani wciśnięty). (Możesz wpisać nil by wyłączyć ten obrazek).
*'''hovimg:''' Tekstura/shader tła przycisku który jest wybrany.(Możesz wpisać nil by wyłączyć ten obrazek).
*'''cliimg:''' Tekstura/shadert ła przycisku który wciśnięty. Możesz wpisać nil by wyłączyć ten obrazek).

===color===
Kolor tła przycisku który może być przetłumaczony przez [[tocolor]].
<syntaxhighlight lang="lua">dgsSetProperty(button,"color",{defcolor,hovcolor,clicolor})</syntaxhighlight>
*'''defcolor:''' Zmienna koloru tła przycisku (nie wybrany ani wciśnięty).
*'''hovcolor:''' Zmienna koloru tła przycisku wybranego.
*'''clicolor:''' Zmienna koloru tła przycisku wciśniętego.

===text===
To samo co [[dgsSetText]]/[[dgsGetText]].
<syntaxhighlight lang="lua">dgsSetProperty(button,"text",text)</syntaxhighlight>
*'''text''' : String napisu na przycisku.

===textcolor===
Kolor napisu, może być przetłumaczony przez [[tocolor]].
<syntaxhighlight lang="lua">dgsSetProperty(button,"textcolor",textcolor)</syntaxhighlight>
*'''textcolor''' : Zmienna koloru napisu na przycisku.

===textsize===
Wielkość tekstu na przycisku. ''Zobacz więcej w: [[dxDrawText]]''
<syntaxhighlight lang="lua">dgsSetProperty(button,"textsize",{scaleX,scaleY})</syntaxhighlight>
*'''scaleX''' : Płaszczyzna 2D X wielkości tekstu na przycisku..
*'''scaleY''' : Płaszczyzna 2D Y wielkości tekstu na przycisku..

===shadow===
Cień napisu na przycisku
<syntaxhighlight lang="lua">dgsSetProperty(button,"shadow",{offsetX,offsetY,color})</syntaxhighlight>
*'''offsetX''' : Płaszczyzna 2D X przesunięcia cienia napisu na przycisku.
*'''offsetY''' : Płaszczyzna 2D Y przesunięcia cienia napisu na przycisku.
*'''color''' : Zmienna koloru cienia.

===font===
To samo co [[dgsSetFont]]/[[dgsGetFont]]. ''Zobacz więcej w: [[dxDrawText]]''
<syntaxhighlight lang="lua">dgsSetProperty(button,"font",font)</syntaxhighlight>

*'''font''' : [[Element/DX_font|dx font element]] napisu na przycisku

===clickoffset===
Przesunięcie zaznacza o ile tekst przycisku ma się przesunąć kiedy jest klikany.
<syntaxhighlight lang="lua">dgsSetProperty(button,"clickoffset",{offsetX,offsetY})</syntaxhighlight>
*'''offsetX''' : Płaszczyzna 2D X przesunięcia relatywnego względem pozycji przycisku.
*'''offsetY''' : Płaszczyzna 2D Y przesunięcia relatywnego względem pozycji przycisku.

===wordbreak===
Oznacza czy word-break jest włączony czy nie. ''Więcej w: [[dxDrawText]]''
<syntaxhighlight lang="lua">dgsSetProperty(button,"wordbreak",wordbreak)</syntaxhighlight>

*'''wordbreak''' : Jeśli 'true', text zawija się do kolejnej lini kiedy dotyka prawej strony obramowania przycisku. Jeśli false, tekst będzie w jednej lini zawsze.

===colorcoded===
Oznacza czy Kolorowanie Kodem jest włączone czy nie. ''Więcej w: [[dxDrawText]]''
<syntaxhighlight lang="lua">dgsSetProperty(button,"colorcoded",colorcoded)</syntaxhighlight>
*'''colorcoded''' : Ustaw 'true' by włączyć kolory HTML(#000000)

===rightbottom===
Wyrównanie tekstu w przycisku
<syntaxhighlight lang="lua">dgsSetProperty(button,"rightbottom",{alignX,alignY})</syntaxhighlight>
*'''alignX''' : Horyzontalne wyrównanie tekstu w przycisku. Dostępne: "left", "center" lub "right".
*'''alignY''' : Wertykalne wyrównanie tekstu w przycisku. Dostępne: "top", "center" lub "bottom".

==Zobacz też==
{{DGSPROPERTIES_PL}}

Dgs-dxbutton

2023-06-11T14:10:11Z

XLive: Moved to mouseButtons property

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

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

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

==Properties==
===alignment===
Alignment of the text within the button.
<syntaxhighlight lang="lua">dgsSetProperty(button,"alignment",{alignX,alignY})</syntaxhighlight>
*'''alignX:''' Horizontal alignment of the text within the button. Can be "left", "center" or "right".
*'''alignY:''' Vertical alignment of the text within the button. Can be "top", "center" or "bottom".

===clickOffset===
The offset indicates that how much the text of the button will shift when it is clicked.
<syntaxhighlight lang="lua">dgsSetProperty(button,"clickOffset",{offsetX,offsetY})</syntaxhighlight>
*'''offsetX''' : A float of the 2D X offset relative to the position of the button.
*'''offsetY''' : A float of the 2D Y offset relative to the position of the button.

===color===
The color which can be translated by [[tocolor]] of the background of the button.
<syntaxhighlight lang="lua">dgsSetProperty(button,"color",{normalColor,hoveringColor,clickedColor})</syntaxhighlight>
*'''normalColor:''' An integer of the color of the background of the button ( neither selected nor clicked by mouse ).
*'''hoveringColor:''' An integer of the color of the background of the button which is selected.
*'''clickedColor:''' An integer of the color of the background of the button which is clicked.

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

===colorTransitionPeriod===
This property sets the transition period among colors (normal, hovering, clicked).
<syntaxhighlight lang="lua">dgsSetProperty(button,"colorTransitionPeriod",colorTransitionPeriod)</syntaxhighlight>
*'''colorTransitionPeriod''' : An integer indicates the transition time in miliseconds. ( Set to 0 to disable )

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

===iconAlignment===
Alignment of the icon within the button.
<syntaxhighlight lang="lua">dgsSetProperty(button,"iconAlignment",{alignX,alignY})</syntaxhighlight>
*'''alignX:''' Horizontal alignment of the icon within the button. Can be "left", "center" or "right".
*'''alignY:''' Vertical alignment of the icon within the button. Can be "top", "center" or "bottom".

===iconColor===
This property enables you to change the icon color (Work with '''iconImage''').
<syntaxhighlight lang="lua">dgsSetProperty(button,"iconColor",{normalColor,hoveringColor,clickedColor})</syntaxhighlight>
*'''normalColor:''' An integer of the color of the icon image of the button ( neither selected nor clicked by mouse ).
*'''hoveringColor:''' An integer of the color of the icon image of the button which is selected.
*'''clickedColor:''' An integer of the color of the icon image of the button which is clicked.

===iconImage===
Require [texture/shader] that can be used as the icon image of button.
<syntaxhighlight lang="lua">dgsSetProperty(button,"iconImage",{normalImage,hoveringImage,clickedImage})</syntaxhighlight>
*'''normalImage:''' A texture/shader element of the icon image of the button ( neither selected nor clicked by mouse ). ( You can pass a nil value to disable this option )
*'''hoveringImage:''' A texture/shader element of the icon image of the button which is selected. ( You can pass a nil value to disable this option )
*'''clickedImage:''' A texture/shader element of the icon image of the button which is clicked. ( You can pass a nil value to disable this option )

===iconOffset===
This property enables you to change the offset of the icon from the text (Work with '''iconImage''').
<syntaxhighlight lang="lua">dgsSetProperty(button,"iconOffset",{iconOffsetX,iconOffsetY,relative})</syntaxhighlight>
*'''iconOffsetX''' : An integer of the 2D X offset in pixels to the position of the icon.
*'''iconOffsetY''' : An integer of the 2D Y offset in pixels to the position of the icon.
*'''relative''' : A bool of whether the iconOffset is relative to the height of text or absolute pixels.

===iconRelative===
This property determines whether the icon is relative to the text or button.
<syntaxhighlight lang="lua">dgsSetProperty(button,"iconRelative",iconRelative)</syntaxhighlight>
*'''iconRelative:''' A bool determines whether the icon is relative to the text or button.

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

===iconSize===
This property enables you to change the icon size (Work with '''iconImage''').
<syntaxhighlight lang="lua">dgsSetProperty(button,"iconSize",{iconSizeX,iconSizeY,relative})</syntaxhighlight>
*'''iconSizeX''' : An integer of the 2D X scale to the position of the icon image.
*'''iconSizeY''' : An integer of the 2D Y scale to the position of the icon image.
*'''relative''' : A bool of whether the iconSize is relative to the height of text or absolute pixels.

===image===
Require [texture/shader] that can be used as the background of button.
<syntaxhighlight lang="lua">dgsSetProperty(button,"image",image)</syntaxhighlight>
*'''image:''' A texture/shader element of the background of the button
Or
<syntaxhighlight lang="lua">dgsSetProperty(button,"image",{normalImage,hoveringImage,ClickedImage})</syntaxhighlight>
*'''normalImage:''' A texture/shader element of the background of the button ( neither selected nor clicked by mouse ). ( You can pass a nil value to disable this image option )
*'''hoveringImage:''' A texture/shader element of the background of the button which is selected. ( You can pass a nil value to disable this image option )
*'''clickedImage:''' A texture/shader element of the background of the button which is clicked. ( You can pass a nil value to disable this image option )

===text===
This is equivalent to [[dgsSetText]]/[[dgsGetText]].
<syntaxhighlight lang="lua">dgsSetProperty(button,"text",text)</syntaxhighlight>
*'''text''' : A string of the text of the button.

===textColor===
The color which can be translated by [[tocolor]] of the text of the button.
<syntaxhighlight lang="lua">dgsSetProperty(button,"textColor",textColor)</syntaxhighlight>
*'''textColor''' : An integer of the color of the text of the button.

===textOffset===
The offset of the text on button.
<syntaxhighlight lang="lua">dgsSetProperty(button,"textOffset",{offsetX,offsetY,relative})</syntaxhighlight>
*'''offsetX''' : A float of the 2D X offset relative to the position of the button, depends on '''relative'''.
*'''offsetY''' : A float of the 2D Y offset relative to the position of the button, depends on '''relative'''.
*'''relative''' : A bool of whether the offset is relative or absolute.

===textSize===
The scale of the text of the button. ''Learn More [[dxDrawText]]''
<syntaxhighlight lang="lua">dgsSetProperty(button,"textSize",{scaleX,scaleY})</syntaxhighlight>
*'''scaleX''' : A float of the 2D X scale of the text of the button.
*'''scaleY''' : A float of the 2D Y scale of the text of the button.

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

===wordBreak===
Whether the word-break is enabled or not. ''Learn More [[dxDrawText]]''
<syntaxhighlight lang="lua">dgsSetProperty(button,"wordBreak",wordBreak)</syntaxhighlight>
*'''wordBreak''' : If set to true, the text will wrap to a new line whenever it reaches the right side of the bounding box. If false, the text will always be completely on one line.
==See Also==
{{DGSPROPERTIES}}

DGS General Basic Properties

2023-06-11T13:57:28Z

XLive: Add mouseButtons property

[[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}}

Dgs-dxedit

2023-05-18T17:14:50Z

XLive: Add placeHolderTextSize

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

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

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

==Properties==
===alignment===
Alignment of the text within the edit.

The functions as follows are basic on this property.

[[dgsEditSetHorizontalAlign]]/[[dgsEditGetHorizontalAlign]]

[[dgsEditSetVerticalAlign]]/[[dgsEditGetVerticalAlign]]
<syntaxhighlight lang="lua">dgsSetProperty(edit,"alignment",{alignX,alignY})</syntaxhighlight>
*'''alignX''' : Horizontal alignment of the text within the edit. Can be "left", "center" or "right".
*'''alignY''' : Vertical alignment of the text within the edit. Can be "top", "center" or "bottom".

===allowCopy===
This propertry determines whether the text can be copyed ( ctrl+c ) or cut ( ctrl+x )
<syntaxhighlight lang="lua">dgsSetProperty(edit,"allowCopy",allowCopy)</syntaxhighlight>
*'''allowCopy''' : A bool indicates whether the text can be copyed ( ctrl+c ) or cut ( ctrl+x )

===autoComplete===
This propertry allows auto complete for edit. ''See'' [[dgsEditAddAutoComplete]]\[[dgsEditRemoveAutoComplete]]\[[dgsEditSetAutoComplete]]\[[dgsEditGetAutoComplete]]
<syntaxhighlight lang="lua">dgsSetProperty(edit,"autoComplete",autoComplete)</syntaxhighlight>
*'''autoComplete''' : The auto complete table. Structure is as follows:
<syntaxhighlight lang="lua">
autoComplete = {
name1 = isSensitive,
name2 = isSensitive,
}
</syntaxhighlight>

===autoCompleteSkip===
This propertry allows skip auto complete detect.
<syntaxhighlight lang="lua">dgsSetProperty(edit,"autoCompleteSkip",autoCompleteSkip)</syntaxhighlight>
*'''autoCompleteSkip''' : A bool if whether disabling auto complete check

===autoCompleteShow===
This propertry stores current showing auto complete item.
<syntaxhighlight lang="lua">dgsSetProperty(edit,"autoCompleteShow",autoCompleteShow)</syntaxhighlight>
*'''autoCompleteShow''' : A table stores the showing data. Structure is as follows:
<syntaxhighlight lang="lua">
autoCompleteShow = {matchedAutoCompletion,showingAutoCompletion}
</syntaxhighlight>
'''matchedAutoCompletion''' may be different from '''showingAutoCompletion''' because of case sensitivity.

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

===bgColorBlur===
This property determines the background color of the edit when it is blurred.
<syntaxhighlight lang="lua">dgsSetProperty(edit,"bgColorBlur",bgColorBlur)</syntaxhighlight>
*'''bgColorBlur:''' An integer of the color that can be converted by [[tocolor]], leave to nil to use bgImage.

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

===bgImageBlur===
This property determines the background image of the edit when it is blurred.
<syntaxhighlight lang="lua">dgsSetProperty(edit,"bgImageBlur",bgImageBlur)</syntaxhighlight>
*'''bgImageBlur:''' A material element that serves as the background image of the edit(texture/shader/screen source/renderTarget), leave to nil to use bgImage.

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

===caretHeight===
This property determines what's the height of the caret.
<syntaxhighlight lang="lua">dgsSetProperty(edit,"caretHeight",caretHeight)</syntaxhighlight>
*'''caretHeight''' : A float indicates what's the height of the caret.

===caretOffset===
The offset of the caret of the edit.
<syntaxhighlight lang="lua">dgsSetProperty(edit,"caretOffset",offset)</syntaxhighlight>
*'''offset''' : A float of the offset of the caret of the edit.

===caretPos===
The position where the caret stays.
<syntaxhighlight lang="lua">dgsSetProperty(edit,"caretPos",index)</syntaxhighlight>
*'''index''' : An integer of the index of the text that the caret stays.

===clearSelection===
This property determines whether the text selection will be cleared when the edit blurs.
<syntaxhighlight lang="lua">dgsSetProperty(edit,"clearSelection",clearSelection)</syntaxhighlight>
*'''clearSelection''' : A bool indicates whether the text selection will be cleared when the edit blurs.

===caretStyle===
This is equivalent to [[dgsEditSetCaretStyle]]/[[dgsEditGetCaretStyle]].

This property allows us to change the style of caret of the edit. ( 0 is "|"; 1 is "_" )

Example(0):

This is Text|

Example(1):

This is Text_
<syntaxhighlight lang="lua">dgsSetProperty(edit,"caretStyle",caretStyle)</syntaxhighlight>
*'''caretStyle''' : An integer of the caret style of the edit.

===caretThick===
This property allows us to change the thickness of caret of the edit.
<syntaxhighlight lang="lua">dgsSetProperty(edit,"caretThick",caretThick)</syntaxhighlight>
*'''caretThick''' : An integer of the thickness of the caret of the edit.

===caretWidth===
This property allows us to change the caret width in caretStyle '''"1"'''.
<syntaxhighlight lang="lua">dgsSetProperty(edit,"caretWidth",{caretWidth,caretDefaultWidth,relative})</syntaxhighlight>
*'''caretWidth''' : A float of the width of the caret of the edit. If '''relative''' is ''true'', this will refer to font width of a character.
*'''caretDefaultWidth''' : A float of the width of the caret of the edit when there is no text to refer. If '''relative''' is '''true''', this will refer to '''textSize'''.
*'''relative''' : A bool indicates whether caret width is relative or absolute.

===edit===
This property stores a gui-edit which is used to input characters.
<syntaxhighlight lang="lua">dgsSetProperty(edit,"edit",gedit)</syntaxhighlight>
*'''gedit''' : A gui-edit.

===enableTabSwitch===
This property determines whether we can use the key "tab" to switch to another edit.
<syntaxhighlight lang="lua">dgsSetProperty(edit,"enableTabSwitch",enableTabSwitch)</syntaxhighlight>
*'''enableTabSwitch''' : A bool indicates whether we can use the key ''tab'' to switch to another edit.

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

===masked===
This is equivalent to [[dgsEditSetMasked]]/[[dgsEditGetMasked]]
<syntaxhighlight lang="lua">dgsSetProperty(edit,"masked",masked)</syntaxhighlight>
*'''masked''' : A boolean value indicating whether masking is to be enabled or disabled.

===maskText===
This property determines what the masked text will be, and the default is "*".
<syntaxhighlight lang="lua">dgsSetProperty(edit,"maskText",maskText)</syntaxhighlight>
*'''maskText''' : A string that the masked text will be.

===maxLength===
This is equivalent to [[dgsEditGetMaxLength]]/[[dgsEditSetMaxLength]]
<syntaxhighlight lang="lua">dgsSetProperty(edit,"maxLength",maxLength)</syntaxhighlight>
*'''maxLength''' : An integer indicating the maximum number of characters that can be typed into the edit box.

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

===placeHolder===
This is equivalent to [[dgsEditSetPlaceHolder]]//[[dgsEditGetPlaceHolder]]
<syntaxhighlight lang="lua">dgsSetProperty(edit,"placeHolder",placeHolder)</syntaxhighlight>
*'''placeHolder''' : A string of the place holder text of dgs edit ( This text will show when there is no text in a blurred dgs edit ).

===placeHolderColor===
This property determines the color of the place holder text. The color which can be translated by [[tocolor]].
<syntaxhighlight lang="lua">dgsSetProperty(edit,"placeHolderColor",placeHolderColor)</syntaxhighlight>
*'''placeHolderColor''' : An integer of the color of the place holder text of the edit.

===placeHolderColorcoded===
This property determines whether the place holder supports color code.
<syntaxhighlight lang="lua">dgsSetProperty(edit,"placeHolderColorcoded",placeHolderColorcoded)</syntaxhighlight>
*'''placeHolderColorcoded''' : A bool indicates whether the place holder supports color code.

===placeHolderFont===
This property changes the font of place holder.
<syntaxhighlight lang="lua">dgsSetProperty(edit,"placeHolderFont",placeHolderFont)</syntaxhighlight>
*'''placeHolderFont''' : A string/dx-font element of the font of the place holder.

===placeHolderIgnoreRenderTarget===
This property determines whether the place holder isn't restricted by render target.
<syntaxhighlight lang="lua">dgsSetProperty(edit,"placeHolderIgnoreRenderTarget",placeHolderIgnoreRenderTarget)</syntaxhighlight>
*'''placeHolderIgnoreRenderTarget''' : A bool indicates whether the place holder isn't restricted by render target.

===placeHolderOffset===
This property allows place holder has offsets relative to its original position.
<syntaxhighlight lang="lua">dgsSetProperty(edit,"placeHolderOffset",{ xOffset, yOffset })</syntaxhighlight>
*'''xOffset''' : An integer of 2D x offset.
*'''yOffset''' : An integer of 2D y offset.

===placeHolderVisibleWhenFocus===
This property allows place holder to be visible even when edit is focused.
<syntaxhighlight lang="lua">dgsSetProperty(edit,"placeHolderVisibleWhenFocus",placeHolderVisibleWhenFocus)</syntaxhighlight>
*'''placeHolderVisibleWhenFocus''' : A bool indicates whether the place holder when the edit is focused.

===placeHolderTextSize===
The scale of the place holder of the edit. ''Learn More [[dxDrawText]]''
<syntaxhighlight lang="lua">dgsSetProperty(edit,"textSize",{scaleX,scaleY})</syntaxhighlight>
*'''scaleX''' : A float of the 2D X scale of the place holder of the edit.
*'''scaleY''' : A float of the 2D Y scale of the place holder of the edit.

===readOnly===
This is equivalent to [[dgsEditSetReadOnly]]/[[dgsEditGetReadOnly]].
<syntaxhighlight lang="lua">dgsSetProperty(edit,"readOnly",readOnly)</syntaxhighlight>
*'''readOnly''' : A bool indicates whether the edit is only readable.

===readOnlyCaretShow===
Whether the caret of edit will show/hide under read-only mode.
<syntaxhighlight lang="lua">dgsSetProperty(edit,"readOnlyCaretShow",readOnlyCaretShow)</syntaxhighlight>
*'''readOnlyCaretShow''' : A bool indicates whether the caret is shown or hidden when the edit is read-only.

===renderTarget===
This property stores a render target of the edit.
<syntaxhighlight lang="lua">dgsSetProperty(edit,"renderTarget",renderTarget)</syntaxhighlight>
*'''renderTarget''' : A render target that is used to render the text.

===selectColorBlur===
The color which can be translated by [[tocolor]] of the rectangle of text selection of the edit when blurred.
<syntaxhighlight lang="lua">dgsSetProperty(edit,"selectColorBlur",selectColorBlur)</syntaxhighlight>
*'''selectColorBlur''' : An integer of the color of the rectangle of text selection of the edit when blurred.

===selectColor===
The color which can be translated by [[tocolor]] of the rectangle of text selection of the edit.
<syntaxhighlight lang="lua">dgsSetProperty(edit,"selectColor",selectColor)</syntaxhighlight>
*'''selectColor''' : An integer of the color of the rectangle of text selection of the edit.

===selectFrom===
The position from which the text is selected.
<syntaxhighlight lang="lua">dgsSetProperty(edit,"selectFrom",{index,line})</syntaxhighlight>
*'''index''' : An integer of the index of the text that selected from.

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

===showPos===
The min value of the x position of the text of the edit starts to show in the render target. ( I don't know how to explain it. XD )
<syntaxhighlight lang="lua">dgsSetProperty(edit,"showPos",posX)</syntaxhighlight>
*'''posX''' : An integer indicates how many pixels of the text are moved to left.

===text===
This is equivalent to [[dgsSetText]]/[[dgsGetText]].
<syntaxhighlight lang="lua">dgsSetProperty(edit,"text",text)</syntaxhighlight>
*'''text''' : A ''table'' of the text of the edit.( Because of multi lines, I use table instead of string )

===textColor===
The color which can be translated by [[tocolor]] of the text of the edit.
<syntaxhighlight lang="lua">dgsSetProperty(edit,"textColor",textColor)</syntaxhighlight>
*'''textColor''' : An integer of the color of the text of the edit.

===textSize===
The scale of the text of the edit. ''Learn More [[dxDrawText]]''
<syntaxhighlight lang="lua">dgsSetProperty(edit,"textSize",{scaleX,scaleY})</syntaxhighlight>
*'''scaleX''' : A float of the 2D X scale of the text of the edit.
*'''scaleY''' : A float of the 2D Y scale of the text of the edit.

===typingSound===
Typing sound, nil for disabled. This is equivalent to [[dgsEditSetTypingSound]]/[[dgsEditGetTypingSound]]
<syntaxhighlight lang="lua">dgsSetProperty(edit,"typingSound",typingSound)</syntaxhighlight>
*'''typingSound:''' A string of the path/url of typing sound.

===typingSoundVolume===
Typing sound, nil for disabled. This is equivalent to [[dgsEditSetTypingSoundVolume]]/[[dgsEditGetTypingSoundVolume]]
<syntaxhighlight lang="lua">dgsSetProperty(edit,"typingSoundVolume",typingSoundVolume)</syntaxhighlight>
*'''typingSoundVolume:''' A float of the volume of the typing sound. Range is from 0.0 to 1.0. This can go above 1.0 for amplification.

==See Also==
{{DGSPROPERTIES}}

Dgs-dxgridlist

2023-04-26T12:16:25Z

XLive: added a note to the default values

[[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.

===mode===
This property determines the render mode of grid list.
<syntaxhighlight lang="lua">dgsSetProperty(gridlist,"mode",mode)</syntaxhighlight>
*'''mode:''' A bool of the state of render mode. Detail:
**'''true:''' No render target mode (Crappy and have a lot of bugs but doesn't take video memory)
**'''false:''' Render target mode (Great quality but takes video memory)

===mouseSelectButton ===
This property allows which button on the mouse can select items of grid list.
<syntaxhighlight lang="lua">dgsSetProperty(gridlist,"mouseSelectButton",{canLeftButton,canMiddleButton,canRightButton})</syntaxhighlight>
*'''canLeftButton:''' A bool of whether left mouse button can select the grid list (default is true)
*'''canMiddleButton:''' A bool of whether middle mouse button can select the grid list (default is false)
*'''canRightButton:''' A bool of whether right mouse button can select the grid list (default is false)

===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}}

DgsGridListGetSelectedItem

2023-04-21T23:47:04Z

XLive: fix a typo in the example

{{Client function}}

This function returns the row and colum indexes of the selected item in a grid list.

==Syntax==
<syntaxhighlight lang="lua">
int, int dgsGridListGetSelectedItem ( element gridList )
</syntaxhighlight>

===Required Arguments===
*'''gridList:''' the grid list you want to know the selected row index of

===Returns===
Returns two integers of the row and column of the selected item if the specified grid list is valid and has a selected item, ''-1'' if nothing is selected, ''false'' otherwise.

==Example==
{{Client function}}
<syntaxhighlight lang="lua">
DGS = exports.dgs

local gridlist = DGS:dgsCreateGridList ( 0.80, 0.10, 0.15, 0.60, true )
local column = DGS:dgsGridListAddColumn ( gridlist, "test", 0.85 )
local row = DGS:dgsGridListAddRow ( gridlist )
DGS:dgsGridListSetItemText ( gridlist, row, column, "1" )

addEventHandler ( "onDgsMouseClick", root, function ( button, state )
if source == gridlist then
local selectedRow, selectedColumn = DGS:dgsGridListGetSelectedItem ( gridlist )
if selectedRow ~= -1 then
local output = DGS:dgsGridListGetItemText( gridlist, selectedRow, selectedColumn )
outputChatBox ( output, 255, 0, 0 )
end
end
end )
</syntaxhighlight>

==See Also==
{{DGSFUNCTIONS}}

DgsGridListGetScrollBar

2023-04-15T13:34:21Z

XLive:

{{Client function}}
This function retrieves the scroll bars of a DGS grid list.

==Syntax==
<syntaxhighlight lang="lua">
table dgsGridListGetScrollBar( element gridList )
</syntaxhighlight>

===Required Arguments===
*'''gridList:''' The DGS grid list element to retrieve the scroll bars from.

===Returns===
This function returns a table containing the vertical and horizontal scroll bars of the specified DGS grid list. ''false'' otherwise.

==Example==
<syntaxhighlight lang="lua">
loadstring(exports.dgs:dgsImportFunction())()

function clientsideResourceStart ()
-- Create the grid list element
local testList = dgsCreateGridList ( 0.45, 0.45, 0.15, 0.15, true )
-- Force scroll bars to be visible
dgsGridListSetScrollBarState ( testList, true, true )
-- Get the scorllbars of the grid list
local scrollBars = dgsGridListGetScrollBar ( testList )
-- Lock the vertical scroll bar
dgsScrollBarSetLocked( scrollBars[1], true )
-- Lock the horizontal scroll bar
dgsScrollBarSetLocked( scrollBars[2], true )
end
addEventHandler ( "onClientResourceStart", resourceRoot, clientsideResourceStart )
</syntaxhighlight>

==See Also==
{{DGSFUNCTIONS}}

DgsGridListGetScrollBar

2023-04-15T13:33:21Z

XLive: Rewrite the example

{{Client function}}
This function retrieves the scroll bars of a DGS grid list.

==Syntax==
<syntaxhighlight lang="lua">
table dgsGridListGetScrollBar( element gridList )
</syntaxhighlight>

===Required Arguments===
*'''gridList:''' The DGS grid list element to retrieve the scroll bars from.

===Returns===
This function returns a table containing the vertical and horizontal scroll bars of the specified DGS grid list. ''false'' otherwise.

==Example==
<syntaxhighlight lang="lua">
loadstring(exports.dgs:dgsImportFunction())()

function clientsideResourceStart ()
-- Create the grid list element
local testList = dgsCreateGridList ( 0.45, 0.45, 0.15, 0.15, true )
-- Force scroll bars to be visible
dgsGridListSetScrollBarState ( testList, true, true )
-- Lock the vertical scroll bar
dgsScrollBarSetLocked( dgsGridListGetScrollBar ( testList )[1], true )
-- Lock the horizontal scroll bar
dgsScrollBarSetLocked( dgsGridListGetScrollBar ( testList )[2], true )
end
addEventHandler ( "onClientResourceStart", resourceRoot, clientsideResourceStart )
</syntaxhighlight>

==See Also==
{{DGSFUNCTIONS}}

DgsSetAlpha

2023-03-12T15:14:06Z

XLive: fix type in the syntax

{{Client function}}
__NOTOC__
This changes the alpha level (the visibleness/transparency) of a DGS element

==Syntax==

<syntaxhighlight lang="lua">
bool dgsSetAlpha ( element theElement, float alpha )
</syntaxhighlight>
{{DGS/OOP|
Note = DGSElement:setAlpha|
Variable = alpha|
Counterpart = dgsGetAlpha
}}

===Required Arguments===
*'''guiElement:''' the DGS element whose visibility is to be changed
*'''alpha:''' The visibility/transparency of the DGS element. Ranges from 0 (fully transparent) to 1 (fully opaque). Default value is 1.

===Returns===
Returns ''true'' if the dgs element's alpha was successfully changed, ''false'' otherwise.

==Example==
This creates a DGS window and allows a player to change it's alpha (the visibleness/transparency) value with a command.
<syntaxhighlight lang="lua">
DGS = exports.dgs
myWindow = DGS:dgsCreateWindow ( 0.30, 0.10, 0.5, 0.60, "DGS window title", true )

--Add a command handler to change the alpha of the DGS window.
--Usage example: '/alpha 0.8', where 0.8 is stored as alphaAmount
function changeAlpha ( commandName, alphaAmount )
alphaAmount = tonumber(alphaAmount)
DGS:dgsSetAlpha ( myWindow, alphaAmount )
end
addCommandHandler ( "alpha", changeAlpha )
</syntaxhighlight>

=See Also=

==<span style="color:#eb3f00;text-shadow:0.05em 0.05em 0.2em #00000099;">General Functions</span>==
{{DGS General Functions}}

==<span style="color:#eb3f00;text-shadow:0.05em 0.05em 0.2em #00000099;">General Events</span>==
{{DGS Events/General}}

DgsGridListSetSelectedItem

2023-03-02T19:56:45Z

XLive: add scrollTo

{{Client function}}

This function selects an item from a grid list.

==Syntax==
<syntaxhighlight lang="lua">
int dgsGridListSetSelectedItem ( element gridList, int rowID, bool scrollTo )
</syntaxhighlight>

===Required Arguments===
*'''gridList:''' The grid list you want to set the selected row index to.
*'''rowID:''' The row index you want to set.
*'''scrollTo:''' Determines whether to scroll to the selected row or not.

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

==Example==
{{Client function}}
<syntaxhighlight lang="lua">
DGS = exports.dgs
showCursor(true)
local GridList = DGS:dgsCreateGridList ( 0.80, 0.10, 0.15, 0.60, true )
local column = DGS:dgsGridListAddColumn( GridList, "test", 0.85 )
for i=1,10 do
local row = DGS:dgsGridListAddRow ( GridList )
DGS:dgsGridListSetItemText ( GridList, row, column, tostring(i) )
end
DGS:dgsGridListSetSelectedItem( GridList, 1 )
</syntaxhighlight>

==See Also==
{{DGSFUNCTIONS}}

DgsMoveTo

2023-03-02T17:05:56Z

XLive:

__NOTOC__
{{Client function}}
This function allow us to add animation to dgs elements.

Change position of dgs elements with animation effect.
==Syntax==
<syntaxhighlight lang="lua">
number/table dgsMoveTo ( element/table dgsElement, float x, float y, bool relative, string easing = "Linear", float duration [, int delay = 0 ])
</syntaxhighlight>

===Required Arguments===
*'''dgsElement:''' The DGS element or a list of DGS elements to set animation to.
*'''x:''' Position over the X axis.
*'''y:''' Position over the Y axis.
*'''relative:''' Bool that indicates if the x/y positions are relative to the screen size.
*'''easing:''' The easing function to use for the interpolation (For More Detail :[[Easing]]), or your own easing function created by [[dgsAddEasingFunction]].
*'''duration:''' An integer of the time(ms) to finish the animation.

===Optional Arguments===
*'''delay:''' The delay time before the animation starts, can decrease the using of timer.
*'''settings:''' A table will be passed to your own easing function.

===Returns===
Returns an ''integer''/''table'' indicates the animation ID or a list of animation IDs if succeed, ''false'' otherwise.

==Example==
<syntaxhighlight lang="lua">
loadstring(exports.dgs:dgsImportFunction())()

parent = dgsCreateWindow(200,100,400,400,"DGS Parent Window",false) --Create a window

dgsMoveTo(parent,400,200,false,"OutQuad",2000) --Set Animation
</syntaxhighlight>

==See Also==
{{DGSFUNCTIONS}}

DgsSizeTo

2023-03-02T17:05:41Z

XLive:

__NOTOC__
{{Client function}}
This function allow us to add animation to dgs elements.

Change size of dgs elements with animation effect.
==Syntax==
<syntaxhighlight lang="lua">
number/table dgsSizeTo ( element/table dgsElement, float w, float h, bool relative, string easing = "Linear", float duration [, int delay = 0 ])
</syntaxhighlight>

===Required Arguments===
*'''dgsElement:''' The DGS element or a list of DGS elements to set animation to.
*'''w:''' Target Width.
*'''h:''' Target Height.
*'''relative:''' Bool that indicates if the w/h are relative to the screen size.
*'''easing:''' The easing function to use for the interpolation (For More Detail :[[Easing]]), or your own easing function created by [[dgsAddEasingFunction]].
*'''duration:''' An integer of the time(ms) to finish the animation.

===Optional Arguments===
*'''delay:''' The delay time before the animation start, can decrease the using of timer.

===Returns===
Returns an ''integer''/''table'' indicates the animation ID or a list of animation IDs if succeed, ''false'' otherwise.

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

parent = DGS:dgsCreateWindow(200,100,400,400,"DGS Parent Window",false) --Create a window

DGS:dgsSizeTo(parent,400,200,false,"OutQuad",2000) --Set Animation
</syntaxhighlight>

==See Also==
{{DGSFUNCTIONS}}

DgsAlphaTo

2023-03-02T17:05:26Z

XLive:

__NOTOC__
{{Client function}}
This function allow us to add animation to dgs elements.

Change alpha of dgs elements with animation effect.
==Syntax==
<syntaxhighlight lang="lua">
number/table dgsAlphaTo ( element/table dgsElement, float targetAlpha, string easing = "Linear", float duration [, int delay = 0 ] )
</syntaxhighlight>

===Required Arguments===
*'''dgsElement:''' The DGS element or a list of DGS elements to set animation to.
*'''targetAlpha:''' Target alpha of dgs element.
*'''easing:''' The easing function to use for the interpolation (For More Detail :[[Easing]]), or your own easing function created by [[dgsAddEasingFunction]].
*'''duration:''' An integer of the time(ms) to finish the animation.

===Optional Arguments===
*'''delay:''' The delay time before the animation start, can decrease the using of timer.

===Returns===
Returns an ''integer''/''table'' indicates the animation ID or a list of animation IDs if succeed, ''false'' otherwise.

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

parent = DGS:dgsCreateWindow(200,100,400,400,"DGS Parent Window",false) --Create a window
DGS:dgsSetAlpha(parent,0)
DGS:dgsAlphaTo(parent,1,"OutQuad",2000) --set alpha with animation effect.
</syntaxhighlight>

==See Also==
{{DGSFUNCTIONS}}

DgsSizeTo

2023-03-02T17:04:37Z

XLive: dgsElement can receive a table

__NOTOC__
{{Client function}}
This function allow us to add animation to dgs elements.

Change size of dgs elements with animation effect.
==Syntax==
<syntaxhighlight lang="lua">
number/table dgsSizeTo ( table/element dgsElement, float w, float h, bool relative, string easing = "Linear", float duration [, int delay = 0 ])
</syntaxhighlight>

===Required Arguments===
*'''dgsElement:''' The DGS element or a list of DGS elements to set animation to.
*'''w:''' Target Width.
*'''h:''' Target Height.
*'''relative:''' Bool that indicates if the w/h are relative to the screen size.
*'''easing:''' The easing function to use for the interpolation (For More Detail :[[Easing]]), or your own easing function created by [[dgsAddEasingFunction]].
*'''duration:''' An integer of the time(ms) to finish the animation.

===Optional Arguments===
*'''delay:''' The delay time before the animation start, can decrease the using of timer.

===Returns===
Returns an ''integer''/''table'' indicates the animation ID or a list of animation IDs if succeed, ''false'' otherwise.

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

parent = DGS:dgsCreateWindow(200,100,400,400,"DGS Parent Window",false) --Create a window

DGS:dgsSizeTo(parent,400,200,false,"OutQuad",2000) --Set Animation
</syntaxhighlight>

==See Also==
{{DGSFUNCTIONS}}

DgsMoveTo

2023-03-02T17:04:21Z

XLive: dgsElement can receive a table

__NOTOC__
{{Client function}}
This function allow us to add animation to dgs elements.

Change position of dgs elements with animation effect.
==Syntax==
<syntaxhighlight lang="lua">
number/table dgsMoveTo ( table/element dgsElement, float x, float y, bool relative, string easing = "Linear", float duration [, int delay = 0 ])
</syntaxhighlight>

===Required Arguments===
*'''dgsElement:''' The DGS element or a list of DGS elements to set animation to.
*'''x:''' Position over the X axis.
*'''y:''' Position over the Y axis.
*'''relative:''' Bool that indicates if the x/y positions are relative to the screen size.
*'''easing:''' The easing function to use for the interpolation (For More Detail :[[Easing]]), or your own easing function created by [[dgsAddEasingFunction]].
*'''duration:''' An integer of the time(ms) to finish the animation.

===Optional Arguments===
*'''delay:''' The delay time before the animation starts, can decrease the using of timer.
*'''settings:''' A table will be passed to your own easing function.

===Returns===
Returns an ''integer''/''table'' indicates the animation ID or a list of animation IDs if succeed, ''false'' otherwise.

==Example==
<syntaxhighlight lang="lua">
loadstring(exports.dgs:dgsImportFunction())()

parent = dgsCreateWindow(200,100,400,400,"DGS Parent Window",false) --Create a window

dgsMoveTo(parent,400,200,false,"OutQuad",2000) --Set Animation
</syntaxhighlight>

==See Also==
{{DGSFUNCTIONS}}

DgsAlphaTo

2023-03-02T17:03:22Z

XLive: dgsElement can receive a table

__NOTOC__
{{Client function}}
This function allow us to add animation to dgs elements.

Change alpha of dgs elements with animation effect.
==Syntax==
<syntaxhighlight lang="lua">
number/table dgsAlphaTo ( table/element dgsElement, float targetAlpha, string easing = "Linear", float duration [, int delay = 0 ] )
</syntaxhighlight>

===Required Arguments===
*'''dgsElement:''' The DGS element or a list of DGS elements to set animation to.
*'''targetAlpha:''' Target alpha of dgs element.
*'''easing:''' The easing function to use for the interpolation (For More Detail :[[Easing]]), or your own easing function created by [[dgsAddEasingFunction]].
*'''duration:''' An integer of the time(ms) to finish the animation.

===Optional Arguments===
*'''delay:''' The delay time before the animation start, can decrease the using of timer.

===Returns===
Returns an ''integer''/''table'' indicates the animation ID or a list of animation IDs if succeed, ''false'' otherwise.

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

parent = DGS:dgsCreateWindow(200,100,400,400,"DGS Parent Window",false) --Create a window
DGS:dgsSetAlpha(parent,0)
DGS:dgsAlphaTo(parent,1,"OutQuad",2000) --set alpha with animation effect.
</syntaxhighlight>

==See Also==
{{DGSFUNCTIONS}}

Dgs-dxgridlist

2023-02-28T11:50:16Z

XLive: Add scrollBarAlignment

[[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.

===mode===
This property determines the render mode of grid list.
<syntaxhighlight lang="lua">dgsSetProperty(gridlist,"mode",mode)</syntaxhighlight>
*'''mode:''' A bool of the state of render mode. Detail:
**'''true:''' No render target mode (Crappy and have a lot of bugs but doesn't take video memory)
**'''false:''' Render target mode (Great quality but takes video memory)

===mouseSelectButton ===
This property allows which button on the mouse can select items of grid list.
<syntaxhighlight lang="lua">dgsSetProperty(gridlist,"mouseSelectButton",{canLeftButton,canMiddleButton,canRightButton})</syntaxhighlight>
*'''canLeftButton:''' A bool of whether left mouse button can select the grid list (default is true)
*'''canMiddleButton:''' A bool of whether middle mouse button can select the grid list (default is false)
*'''canRightButton:''' A bool of whether right mouse button can select the grid list (default is false)

===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]]''
<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]]''
<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]].

<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.
<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}}

DgsSelectorClear

2023-02-18T20:16:15Z

XLive:

{{Client function}}
__NOTOC__
This function removes all the items from a dgs selector.

==Syntax==
<syntaxhighlight lang="lua">
bool dgsSelectorClear ( element selector )
</syntaxhighlight>

===Required Arguments===
*'''selector:''' The dgs selector element to be cleared

===Returns===
Returns ''true'' if the dgs selector element is valid and has been cleared successfully, ''false'' otherwise.

==Example==
This example creates a selector with all server vehicles on it, with a command to clear the selector.
<syntaxhighlight lang="lua">
DGS = exports.dgs

addEventHandler ( "onClientResourceStart", resourceRoot,
function ( )
selector = dgsCreateSelector(400,500,100,20,false)
for index, vehicle in ipairs ( getElementsByType ( "vehicle" ) ) do -- We loop through all vehicles.
DGS:dgsSelectorAddItem ( selector, getVehicleName ( vehicle ) ) -- We add the vehicle name to our selector.
end
end)

addCommandHandler ( "clear",
function ( )
DGS:dgsSelectorClear ( selector ) -- We clear our selector items.
end)
</syntaxhighlight>

==See Also==
{{DGSFUNCTIONS}}

Modules/MTA-MySQL

2023-02-08T10:08:47Z

XLive: the font size is intentional

<pageclass class="#AA7592" subcaption="MTA-MySQL Module"></pageclass>

<div style="font-size: 4em; line-height: 1em;">{{Warning|We don't provide any support for this module!}}</div>
<br>
<div style="font-size: 10em; line-height: 1em;">{{Warning|This module is too old, please use [[dbConnect]] instead.}}</div>
{{Module_Info|
name = MTA MySQL |
version = 0.5 |
author = [[User:ryden|Alberto Alonso (ryden)]] |
author2 = [[User:ryden|Alberto Alonso (ryden)]] |
module_website = [http://code.google.com/p/multitheftauto-modules Here] |
download_link = [https://nightly.mtasa.com/files/modules/32/mta_mysql.dll Windows 32 bit]<br/>[https://nightly.mtasa.com/files/modules/64/mta_mysql.dll Windows 64 bit]
[https://nightly.mtasa.com/files/modules/32/mta_mysql.so Linux 32 bit]<br/>[https://nightly.mtasa.com/files/modules/64/mta_mysql.so Linux 64 bit] |
license = [http://www.opensource.org/licenses/bsd-license.php BSD] |
written_in = C++ |
operating_system = Cross-platform |
compatible_with = DP2.x & 1.X |
}}
MTA MySQL is an alternative to the default [[Modules/MySQL|ml_mysql]] module provided by the MTA team.
It is available for Windows and GNU/Linux and provides the source code.

''Note: From version 0.4 it supports both DP2.3 and 1.0 servers.''

==Installation==
===Windows===
'''32 bit:''' Copy 32 bit mta_mysql.dll into the '''MTA San Andreas\server\mods\deathmatch\modules\''' directory.<br/>
''(You might also need to install [https://nightly.mtasa.com/files/vcredist_2013_x86.exe 32 bit VS2013 Runtime Redist])''

'''64 bit:''' Copy 64 bit mta_mysql.dll into the '''MTA San Andreas\server\x64\modules\''' directory.<br/>
''(You might also need to install [https://nightly.mtasa.com/files/vcredist_2013_x64.exe 64 bit VS2013 Runtime Redist])''

Then, add the following line in mtaserver.conf:
<syntaxhighlight lang="xml">
<module src="mta_mysql.dll" />
</syntaxhighlight>

===GNU/Linux===
'''32 bit:''' Copy 32 bit mta_mysql.so into the '''mods/deathmatch/modules/''' directory.<br/>

'''64 bit:''' Copy 64 bit mta_mysql.so into the '''x64/modules/''' directory.

Then, add the following line in mtaserver.conf:
<syntaxhighlight lang="xml">
<module src="mta_mysql.so" />
</syntaxhighlight>

To fix '''MODULE: Unable to find modules/mta_mysql.so (libmysqlclient.so.16: cannot open shared object file: No such file or directory)!''' copy ''libmysqlclient.so.16'' into '''/usr/lib''' ([https://nightly.mtasa.com/files/modules/32/libmysqlclient.so.16 32 bit], [https://nightly.mtasa.com/files/modules/64/libmysqlclient.so.16 64 bit])

'''If you experience an error on Unix systems:'''
Try to add port and socket parameters to your mysql_connect.

==Handler functions==
{{Modules/MTA-MySQL/Handler_functions}}

==Result managing functions==
{{Modules/MTA-MySQL/Result_functions}}

==Version 0.5 calling method==
From version 0.5 onwards you can call all this module functions, except mysql_connect and mysql_null, as if they are methods of an object.

For example, having a valid MySQL handler, you can do handler:query ( "SELECT * FROM table" ) instead of mysql_query ( handler, "SELECT * FROM table" ).

===Function aliases===
A function alias is a second name for a function, which makes calling any of the original name or the alias have the same result. The new aliases introduced in version 0.5 are:
* result:num_rows() is the same as result:numrows()
* result:num_fields() is the same as result:numfields()
* result:free_result() is the same as result:free()

[[Category:Modules]]

[[ru:Modules/MTA-MySQL]]

DgsSetVisible

2023-01-13T17:51:05Z

XLive: table syntax

{{Client function}}
__NOTOC__
This function changes the visibility state of a DGS element.

==Syntax==
<syntaxhighlight lang="lua">
bool dgsSetVisible ( element/table dgsElement, bool state )
</syntaxhighlight>
{{DGS/OOP|
Method = DGSElement:setVisible|
Variable = visible|
Counterpart = dgsGetVisible
}}

===Required Arguments===
*'''dgsElement:''' the DGS element whose visibility is to be changed
*'''state:''' the new visibility state

===Returns===
Returns ''true'' if the element's visibility could be changed, ''false'' otherwise.

==Example==
This example creates a dgs window and changes its visibility every 2 seconds, infinite times.

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

function changeVisibility ( )
-- we check if the dgs element is visible
DGS:dgsSetVisible (myWindow, not DGS:dgsGetVisible ( myWindow ) )
end

--Create a dgs window called 'myWindow'
myWindow = DGS:dgsCreateWindow ( 0.3, 0.3, 0.5, 0.60, "DGS window title", true )
--Set a timer to change the window's visibility every 2 seconds, infinite times
setTimer ( changeVisibility, 2000, 0 )</syntaxhighlight>

This example creates a dgs window with yes and no buttons and make it visible/invisible with the bindkey 'x'.
<section name="Client" class="client" show="true">
<syntaxhighlight lang="lua">
DGS = exports.dgs

newdgs = { button = {}, wind= {} }

addEventHandler("onClientResourceStart", resourceRoot,function()
newdgs.wind[1] = DGS:dgsDxCreateWindow(434, 304, 280, 123, "New Window", false)
DGS:dgsDxWindowSetSizable(newdgs.wind[1], false)
newdgs.button[1] = DGS:dgsDxCreateButton(35, 46, 87, 40, "yes", false, newdgs.wind[1])
newdgs.button[2] = DGS:dgsDxCreateButton(166, 49, 92, 37, "no", false, newdgs.wind[1])
end)

bindKey ( "x", "down", function ( )
local state = ( not DGS:dgsGetVisible( newdgs.wind[1] ) )
DGS:dgsSetVisible( newdgs.wind[1], state )
showCursor ( state )
end)
</syntaxhighlight></section>

=See Also=

==<span style="color:#eb3f00;text-shadow:0.05em 0.05em 0.2em #00000099;">General Functions</span>==
{{DGS General Functions}}

==<span style="color:#eb3f00;text-shadow:0.05em 0.05em 0.2em #00000099;">General Events</span>==
{{DGS Events/General}}

DgsGridListSetColumnTextColor

2022-11-27T10:50:54Z

XLive:

{{Client function}}
__NOTOC__
This function changes the color of a gridlist column title.

==Syntax==
<syntaxhighlight lang="lua">
bool dgsGridListSetItemColor ( element gridList, int columnIndex, int color )
</syntaxhighlight>

===Required Arguments===
*'''gridList:''' The dgs grid list element.
*'''columnIndex:''' Column index.
*'''color:''' The color of the text.

==Syntax==
<syntaxhighlight lang="lua">
bool dgsGridListSetItemColor ( element gridList, int columnIndex, int r, int g, int b [, int a = 255 ] )
</syntaxhighlight>

===Required Arguments===
*'''gridList:''' The dgs grid list element.
*'''columnIndex:''' Column index.
*'''r:''' The amount of red in the color (0-255).
*'''g:''' The amount of green in the color (0-255).
*'''b:''' The amount of blue in the color (0-255).

===Optional Arguments===
*'''a:''' The amount of alpha in the color (0-255).

===Returns===
Returns ''true'' if the title color was set successfully, ''false'' otherwise.

==Example==
'''example 1'''
<section name="Client" class="client" show="true">
<syntaxhighlight lang="lua">
loadstring(exports.dgs:dgsImportFunction())()
function createGridList()
local gridlist = dgsCreateGridList(0.3, 0.3, 0.4, 0.4, true)
dgsGridListAddColumn(gridlist, "Column 1", 0.25)
dgsGridListSetColumnTextColor(gridlist, 1, tocolor(255, 0, 0))

dgsGridListAddColumn(gridlist, "Column 2", 0.25)
dgsGridListSetColumnTextColor(gridlist, 2, tocolor(0, 255, 0))

dgsGridListAddColumn(gridlist, "Column 3", 0.25)
dgsGridListSetColumnTextColor(gridlist, 3, tocolor(0, 0, 255))

dgsGridListAddColumn(gridlist, "Column 4", 0.25)
dgsGridListSetColumnTextColor(gridlist, 4, tocolor(255, 255, 0))

for i = 1, 100 do
local row = dgsGridListAddRow(gridlist)
dgsGridListSetItemText(gridlist, row, 1, "Row " .. i)
dgsGridListSetItemText(gridlist, row, 2, "Row " .. i)
dgsGridListSetItemText(gridlist, row, 3, "Row " .. i)
dgsGridListSetItemText(gridlist, row, 4, "Row " .. i)
end
end
createGridList()
</syntaxhighlight>
</section>
'''example 2'''
<section name="Client" class="client" show="true">
<syntaxhighlight lang="lua">
loadstring(exports.dgs:dgsImportFunction())()
function createGridList()
-- create 3 columns and change their colors. then create 100 rows
local gridlist = dgsCreateGridList(0.3, 0.3, 0.4, 0.4, true)
dgsGridListAddColumn(gridlist, "Column 1", 0.25)
dgsGridListSetColumnTextColor(gridlist, 1, 255, 0, 0)

dgsGridListAddColumn(gridlist, "Column 2", 0.25)
dgsGridListSetColumnTextColor(gridlist, 2, 0, 255, 0)

dgsGridListAddColumn(gridlist, "Column 3", 0.25)
dgsGridListSetColumnTextColor(gridlist, 3, 0, 0, 255)

dgsGridListAddColumn(gridlist, "Column 4", 0.25)
dgsGridListSetColumnTextColor(gridlist, 4, 255, 255, 0, 180)

for i = 1, 100 do
local row = dgsGridListAddRow(gridlist)
dgsGridListSetItemText(gridlist, row, 1, "Row " .. i)
dgsGridListSetItemText(gridlist, row, 2, "Row " .. i)
dgsGridListSetItemText(gridlist, row, 3, "Row " .. i)
dgsGridListSetItemText(gridlist, row, 4, "Row " .. i)
end
end
createGridList()
</syntaxhighlight>
</section>

==See Also==
{{DGSFUNCTIONS}}

DgsGridListSetColumnTextColor

2022-11-27T10:50:14Z

XLive: Created page with "{{Client function}} __NOTOC__ This function changes the color of a gridlist column title. ==Syntax== <syntaxhighlight lang="lua"> bool dgsGridListSetItemColor ( element gridList, int columnIndex, int/table color ) </syntaxhighlight> ===Required Arguments=== *'''gridList:''' The dgs grid list element. *'''columnIndex:''' Column index. *'''color:''' The color of the text. ==Syntax== <syntaxhighlight lang="lua"> bool dgsGridListSetItemColor ( element gridList, int c..."

{{Client function}}
__NOTOC__
This function changes the color of a gridlist column title.

==Syntax==
<syntaxhighlight lang="lua">
bool dgsGridListSetItemColor ( element gridList, int columnIndex, int/table color )
</syntaxhighlight>

===Required Arguments===
*'''gridList:''' The dgs grid list element.
*'''columnIndex:''' Column index.
*'''color:''' The color of the text.

==Syntax==
<syntaxhighlight lang="lua">
bool dgsGridListSetItemColor ( element gridList, int columnIndex, int r, int g, int b [, int a = 255 ] )
</syntaxhighlight>

===Required Arguments===
*'''gridList:''' The dgs grid list element.
*'''columnIndex:''' Column index.
*'''r:''' The amount of red in the color (0-255).
*'''g:''' The amount of green in the color (0-255).
*'''b:''' The amount of blue in the color (0-255).

===Optional Arguments===
*'''a:''' The amount of alpha in the color (0-255).

===Returns===
Returns ''true'' if the title color was set successfully, ''false'' otherwise.

==Example==
'''example 1'''
<section name="Client" class="client" show="true">
<syntaxhighlight lang="lua">
loadstring(exports.dgs:dgsImportFunction())()
function createGridList()
local gridlist = dgsCreateGridList(0.3, 0.3, 0.4, 0.4, true)
dgsGridListAddColumn(gridlist, "Column 1", 0.25)
dgsGridListSetColumnTextColor(gridlist, 1, tocolor(255, 0, 0))

dgsGridListAddColumn(gridlist, "Column 2", 0.25)
dgsGridListSetColumnTextColor(gridlist, 2, tocolor(0, 255, 0))

dgsGridListAddColumn(gridlist, "Column 3", 0.25)
dgsGridListSetColumnTextColor(gridlist, 3, tocolor(0, 0, 255))

dgsGridListAddColumn(gridlist, "Column 4", 0.25)
dgsGridListSetColumnTextColor(gridlist, 4, tocolor(255, 255, 0))

for i = 1, 100 do
local row = dgsGridListAddRow(gridlist)
dgsGridListSetItemText(gridlist, row, 1, "Row " .. i)
dgsGridListSetItemText(gridlist, row, 2, "Row " .. i)
dgsGridListSetItemText(gridlist, row, 3, "Row " .. i)
dgsGridListSetItemText(gridlist, row, 4, "Row " .. i)
end
end
createGridList()
</syntaxhighlight>
</section>
'''example 2'''
<section name="Client" class="client" show="true">
<syntaxhighlight lang="lua">
loadstring(exports.dgs:dgsImportFunction())()
function createGridList()
-- create 3 columns and change their colors. then create 100 rows
local gridlist = dgsCreateGridList(0.3, 0.3, 0.4, 0.4, true)
dgsGridListAddColumn(gridlist, "Column 1", 0.25)
dgsGridListSetColumnTextColor(gridlist, 1, 255, 0, 0)

dgsGridListAddColumn(gridlist, "Column 2", 0.25)
dgsGridListSetColumnTextColor(gridlist, 2, 0, 255, 0)

dgsGridListAddColumn(gridlist, "Column 3", 0.25)
dgsGridListSetColumnTextColor(gridlist, 3, 0, 0, 255)

dgsGridListAddColumn(gridlist, "Column 4", 0.25)
dgsGridListSetColumnTextColor(gridlist, 4, 255, 255, 0, 180)

for i = 1, 100 do
local row = dgsGridListAddRow(gridlist)
dgsGridListSetItemText(gridlist, row, 1, "Row " .. i)
dgsGridListSetItemText(gridlist, row, 2, "Row " .. i)
dgsGridListSetItemText(gridlist, row, 3, "Row " .. i)
dgsGridListSetItemText(gridlist, row, 4, "Row " .. i)
end
end
createGridList()
</syntaxhighlight>
</section>

==See Also==
{{DGSFUNCTIONS}}

Template:DGS GridList Functions

2022-11-27T10:30:24Z

XLive: column text color

*[[dgsCreateGridList]]
*[[dgsGridListClear]]
*[[dgsGridListGetScrollBar]]
*[[dgsGridListSetScrollPosition]]
*[[dgsGridListGetScrollPosition]]
*[[dgsGridListScrollTo]]
*[[dgsGridListSetHorizontalScrollPosition]]
*[[dgsGridListGetHorizontalScrollPosition]]
*[[dgsGridListSetVerticalScrollPosition]]
*[[dgsGridListGetVerticalScrollPosition]]
*[[dgsGridListResetScrollBarPosition]]
*[[dgsGridListSetColumnRelative]]
*[[dgsGridListGetColumnRelative]]
*[[dgsGridListAddColumn]]
*[[dgsGridListRemoveColumn]]
*[[dgsGridListClearColumn]]
*[[dgsGridListGetColumnCount]]
*[[dgsGridListGetColumnAllWidth]]
*[[dgsGridListGetColumnHeight]]
*[[dgsGridListSetColumnHeight]]
*[[dgsGridListGetColumnWidth]]
*[[dgsGridListSetColumnWidth]]
*[[dgsGridListAutoSizeColumn]]
*[[dgsGridListGetColumnTextSize]]
*[[dgsGridListSetColumnTextSize]]
*[[dgsGridListGetColumnTitle]]
*[[dgsGridListSetColumnTitle]]
*[[dgsGridListGetColumnFont]]
*[[dgsGridListSetColumnFont]]
*[[dgsGridListGetColumnAlignment]]
*[[dgsGridListSetColumnAlignment]]
*[[dgsGridListSetColumnTextColor]]
*[[dgsGridListGetColumnTextColor]]
*[[dgsGridListSetSortColumn]]
*[[dgsGridListGetSortColumn]]
*[[dgsGridListGetEnterColumn]]
*[[dgsGridListAddRow]]
*[[dgsGridListAddRows]]
*[[dgsGridListRemoveRow]]
*[[dgsGridListClearRow]]
*[[dgsGridListGetRowCount]]
*[[dgsGridListGetRowBackGroundImage]]
*[[dgsGridListSetRowBackGroundImage]]
*[[dgsGridListSetRowBackGroundColor]]
*[[dgsGridListGetRowBackGroundColor]]
*[[dgsGridListSetRowAsSection]]
*[[dgsGridListGetRowSelectable]]
*[[dgsGridListSetRowSelectable]]
*[[dgsGridListGetRowHoverable]]
*[[dgsGridListSetRowHoverable]]
*[[dgsGridListGetItemAlignment]]
*[[dgsGridListSetItemAlignment]]
*[[dgsGridListSetItemTextSize]]
*[[dgsGridListGetItemTextSize]]
*[[dgsGridListSetItemColor]]
*[[dgsGridListGetItemColor]]
*[[dgsGridListSetItemTextOffset]]
*[[dgsGridListGetItemTextOffset]]
*[[dgsGridListSetItemText]]
*[[dgsGridListGetItemText]]
*[[dgsGridListSetItemFont]]
*[[dgsGridListGetItemFont]]
*[[dgsGridListSetItemData]]
*[[dgsGridListGetItemData]]
*[[dgsGridListSetItemImage]]
*[[dgsGridListGetItemImage]]
*[[dgsGridListRemoveItemImage]]
*[[dgsGridListSetItemBackGroundColorTemplate]]
*[[dgsGridListSetItemBackGroundImage]]
*[[dgsGridListGetItemBackGroundImage]]
*[[dgsGridListSetItemBackGroundColor]]
*[[dgsGridListGetItemBackGroundColor]]
*[[dgsGridListSelectItem]]
*[[dgsGridListItemIsSelected]]
*[[dgsGridListGetSelectedCount]]
*[[dgsGridListGetPreselectedItem]]
*[[dgsGridListGetSelectedItem]]
*[[dgsGridListSetSelectedItem]]
*[[dgsGridListGetSelectedItems]]
*[[dgsGridListSetSelectedItems]]
*[[dgsGridListGetItemSelectable]]
*[[dgsGridListSetItemSelectable]]
*[[dgsGridListGetItemHoverable]]
*[[dgsGridListSetItemHoverable]]
*[[dgsGridListSetSelectionMode]]
*[[dgsGridListGetSelectionMode]]
*[[dgsGridListSetNavigationEnabled]]
*[[dgsGridListGetNavigationEnabled]]
*[[dgsGridListSetMultiSelectionEnabled]]
*[[dgsGridListGetMultiSelectionEnabled]]
*[[dgsGridListSetAutoSortEnabled]]
*[[dgsGridListGetAutoSortEnabled]]
*[[dgsGridListSetSortFunction]]
*[[dgsGridListSetSortEnabled]]
*[[dgsGridListGetSortEnabled]]
*[[dgsGridListSort]]
*[[dgsAttachToGridList]]
*[[dgsDetachFromGridList]]

MTA Classes

2022-07-13T14:08:58Z

XLive: Undo revision 75263 by Borsuczek123 (talk)

In order to perform operations on MTA objects via scripting, pointers to internal classes are exported to scripts as Lua userdata. Each of these classes has a number of exported scripting functions associated with them.

Elements that have a physical representation in the game are also known as [[entity|Entities]].

The complete list of classes to be found in scripts follows:

* [[account|Account]]
* [[acl|ACL]]
* [[aclgroup|ACL group]]
* [[Ban]]
* [[element|Element]]
<ul>{{Elements}}</ul>
* [[resource|Resource]]
* [[textdisplay|Text display]]
* [[textitem|Text item]]
* [[timer|Timer]]
* [[xmlnode|XML node]]
* [[connection|Connection]]
[[Category:Scripting Concepts]]

[[hu:MTA Classes]]
[[es:Clases MTA]]
[[it:Classi di MTA]]
[[ru:Классы MTA]]

Element tree

2022-07-13T14:08:44Z

XLive: Undo revision 75264 by Borsuczek123 (talk)

[[File:Tre.png|frame|Element tree]]
MTA uses a so-called ''element tree'' to store all the elements that exist on the server and the client. This is directly related to the set of running [[resources]] and their map files' XML layout, although it can be changed at run-time by scripts.

If you are familiar with the concept of ''trees'' in computer-science, this should be easy to understand. If you are not, think of it as a family tree - except everyone only has a single parent. Every [[element]] has a ''parent'' element.

All elements that are created within scripts or from .map files are child elements of the resource they belong to. Thus, most elements (except for [[client]]s) exist only within resources and are also destroyed as soon as their resource is stopped.

==Tree elements==
* '''root''': This is at the very base of the tree - all elements are children (or descendants) of this element.
<syntaxhighlight lang="lua">
getRootElement()
</syntaxhighlight>
* '''resource''': These are direct children of the root element - with one for each ''running'' resource. This element is called the ''resource root''. Its ID holds the name of the resource.
<syntaxhighlight lang="lua">
getResourceRootElement()
</syntaxhighlight>
* '''map''': Each resource element contains at least one map element, representing either a ".map" file in the resource or the one containing the elements created by scripts (this is called the ''dynamic'' map). Their IDs contain the maps' filenames, or ''dynamic'' for the dynamic map.
** Map files can contain a number of other [[element]]s as well as an unlimited number of custom elements.

==Example==
This in an example of a serverside tree dumped to XML from a running server.
''Please note that it is shortened on some places for the sake of overview.''
<syntaxhighlight lang="xml">
<root>
<console/>
<player dontRespawn="false"/>
<player dontRespawn="false" lastSpawnarea=""/>
<resource id="resourcebrowser"/>
<resource id="ajax"/>
<resource id="resourcemanager"/>
<resource id="spawnmanager"/>
<resource id="mapmanager"/>
<resource id="runcode"/>
<resource id="fr">
<map id="dynamic">
<vehicle/>
</map>
</resource>
<resource id="elementbrowser"/>
<resource id="assault">
<map id="dynamic">
<team/>
<team/>
<blip/>
<marker/>
<colshape/>
<blip/>
<blip/>
</map>
</resource>
<resource id="as-farm">
<map id="dynamic"/>
<map id="as-farm.map">
<spawngroup req="" type="attacker">
<spawnarea posY="-8.3976354598999" posX="20.182683944702" skins="9" ... />
</spawngroup>
<spawngroup req="" type="attacker">
<spawnarea posY="32.166355133057" posX="-46.90763092041" skins="9" ... />
</spawngroup>
<spawngroup req="" type="attacker">
<spawnarea posY="35.214984893799" posX="-33.486911773682" skins="9" ... />
</spawngroup>
<spawngroup req="" type="attacker">
<spawnarea posY="35.214984893799" posX="-33.486911773682" skins="9" ... />
</spawngroup>
<objective id="first" type="checkpoint" description="Breach into the farm" ... />
<pickup type="weapon" ... />
</map>
</resource>
</root>
</syntaxhighlight>
===Explanation===
This tree consists of a number of resource root elements, the [[Element/Console|server console]] and two [[player]] elements, that are direct children of the '''root''' element. All these resources have a ''dynamic map'' as child element (it is just not shown for most of them). These contain the elements that are created dynamically by this resource using scripts, for example a [[vehicle]]. If the resource has a map file, it is also a child element, itself containing all the elements in the .map file.

Let's have a closer look at the '''assault''' resource: This contains just one ''dynamic'' map that has 2 teams, 3 blips, 1 marker, and 1 colshape as child elements. These are the elements that are created by the script, for example, the marker, the colshape and one of the blips are probably used for the objective.

The '''as-farm''' resource's function on the contrary is to be a map for the '''assault''' gamemode. The dynamic map is empty (it could contain elements if there was a script in it though), while there is a map called 'as-farm.map', that contains a number of elements. These are mostly custom elements (like spawngroup, spawnarea, objective) but also a few elements that MTA creates automatically after loading the map (like pickup). In the brackets after the element type, you can see the element data it contains. These are identical with the attributes the .map file contains within these elements, while you can also set and get element data for any other elements (e.g. players) with [[setElementData]] and [[getElementData]].

==Practical application==
Elements can have as many children as they like. This does not directly affect the map in any way, but it comes into its own when combined with the scripting system.

===Setting data for elements===
If you call a set... function on a node of the element tree, the function will affect every element within it (that it can work on).

So, the following code would set the size of every marker (the only type of element the setMarkerSize function can work on) that is below the root element to ''2.5''.
<syntaxhighlight lang="lua">
setMarkerSize ( root, 2.5 )
</syntaxhighlight>

The same can be done on any element, it is not restricted to the root element.

===Map manager===
The [[#Example|example above]] shows the way the [[map manager]] uses different resources. The 'assault' resource is the gamemode, that manages what happens on the server using scripts and thus by creating elements in the tree dynamically. When a map resource is started, the gamemode receives a [[resource|resource pointer]] referring to the started resource - in this case ''as-farm'' - from which you can retrieve and store the resource root element. Using this element in conjunction with functions like [[getElementsByType]], [[getElementData]] and various others, you can access any of the information that was loaded into the tree from the 'as-farm.map'-file through scripts in the gamemode resource.

Another thing that has to be considered related to the tree of elements is the fact that when you change the map, you don't have to remove any elements you created within the map resource, while you '''do''' have to remove elements that are created within the gamemode resource, '''if''' they are specific to the map (which will be probably the case for those items you create based on information read from the map resource's .map files).

==Element browser==
You can start the resource ''elementbrowser'' to see a live view of the element tree on your server. Just start the resource and browser to your server's web page and choose the ''Element browser'' option in the sidebar (firefox only currently).

[[Category:Scripting Concepts]]

[[hu:Element tree]]
[[es:Árbol de elementos]]
[[ru:Element tree]]
[[pl:Element tree]]
[[pt-br:Árvore de elementos]]

Element

2022-07-13T14:08:14Z

XLive: Undo revision 75266 by Borsuczek123 (talk)

An '''element''' is a generic class that can represent almost all in-game [[entity|entities]]. The built-in element types are:

{{Elements}}

Any other element type can be created as an abstract element, not referring to any game [[entity]]. For example, '''resource''' and '''map''' elements are created when resources and maps are loaded to group entities they create as their children.

Elements share common functions such as type and list retrieval, a destroy operation to remove both the element and the game entity it is linked to (except for some elements which can't be destroyed, for example client elements), [[element data]] storing and retrieval, and many more common operations.

All elements are stored internally in a [[Element tree|tree structure]], and as such every element except the '''root''' element has a parent element, that can be the '''root''' element, a '''resource''', '''map''' or another element. This is purely for declaring the scope of function calls.

==Related scripting functions==
===Client===
{{Client element functions}}
===Server===
{{Element functions}}
[[Category:Scripting Concepts]]

[[en:Element]]
[[ru:Element]]
[[es:Elemento]]
[[it:Elemento]]
[[hu:Element]]
[[pl:Element]]
[[pt-br:Elemento]]

How you can help

2022-07-13T14:07:43Z

XLive: Undo revision 75267 by Borsuczek123 (talk)

__NOTOC__
Multi Theft Auto has loads of areas in which you can help us. In turn, we'll be more than happy to help you get started with any ideas you have, help test them and - if they're good enough - release them to the whole community. This page outlines the key areas you could do something in, of course, there are many things we've not thought of, so think outside the box!

==Coding for MTA:SA==
* Become a patch contributor by sending [https://github.com/multitheftauto/mtasa-blue/pulls pull requests] to MTA, containing requested features or bugfixes. ([[Coding guidelines]])
* Translate MTA:SA to your native language - https://translate.multitheftauto.com/

==Scripting==
* Become a contributor to MTA's official resources by sending [https://github.com/multitheftauto/mtasa-resources/pulls pull requests] to our resources repository
* Create and [https://community.mtasa.com/ publish] a gamemode or useful script
**[[Scripting Introduction]]
**[https://www.lua.org/pil/index.html "Programming in Lua" Manual]
* Make a general purpose resource that provides useful functions to other resources.

==Mapping==
* Create and [https://community.mtasa.com/ publish] a map for an existing gamemode, with the map editor.
**[[Resource:Editor|Map Editor Manual]]

==Web development==
* Create your own system for statistics - using the [[PHP SDK]] as a basis. Join the [https://discord.gg/RygaCSD MTA discord] (or [https://discord.gg/GNN6PRtTnu development discord]) for help.

==Documentation==
Before you make changes check out: [[Help:Editing Guidelines|Editing Guidelines]] and [[Help:MTA Wiki Specific Templates|Specific Templates]]
* Finish documentation for [[:Category:Incomplete|Incomplete functions]] - ask in #mta.scripting if you're not sure of something.
* Add examples to [[:Category:Needs Example|functions & events missing examples]] - please '''test''' them, and again, ask if you need help.
* Review and verify [[:Category:Needs Checking|pages that need checking]] - make sure highlighted issues are solved before removing pages from the category.
* Expand the pages that explain [[:Category:Scripting_Concepts|MTA core concepts]].
* Write [https://forum.mtasa.com/forum/123-tutorials/ tutorials] to help new people.
* Translate the wiki pages so people from other countries can get started in MTA too.
* Create documentation for undocumented functions and events [[Undocumented Items]]
* Keep 'changes in' [current work-in-progress: https://wiki.multitheftauto.com/wiki/Changes_in_1.6] for future releases updated.

==Quality Assurance==
* [https://github.com/multitheftauto/mtasa-blue/issues Report issues] with the mod, make sure to do a search on the already reported issues first.
* Test and confirm existing reported issues.
* Use the newest build of MTA to detect and report new bugs, by going to 'Settings', 'Advanced', 'Update build type' and choosing 'Nightly' or get it regularly [https://nightly.mtasa.com/ from here].
* Any bugs which are related to a scripting function / event and present in the main release (rather than nightlies), document that bug by adding a [https://wiki.multitheftauto.com/wiki/Help:MTA_Wiki_Specific_Templates warning] to the wiki page to save other scripters a lot of time.

==Specific tasks==
* Create a fuzzer to check for crashes in our scripting functions.

==Grant==
You can donate to MTA:SA [https://mtasa.com/donate/manage.php here]

[[en:How you can help]]
[[ru:How you can help]]
[[pl:Jak możesz pomóc]]
[[uk:How you can help]]
[[es:Cómo puedes ayudar]]
[[hu:How you can help]]
[[tr:Nasıl yardımcı olabilirsiniz]]
[[pt-br:Como você pode ajudar]]

UK/Character Skins

2022-07-13T14:06:54Z

XLive: Undo revision 75268 by Borsuczek123 (talk)

Скіни, які гравець може використовувати.

*[[All Skins Page|Сторінка з усіма скінами]] - Не рекомендується, якщо у вас повільний інтернет.
*[[Special Skins Page|Сторінка з особливими скінами]] - Нові скіни, які стали доступні починаючи з MTA версії 1.1
*[[Gang Skins|Скіни членів банд]]
*[[Female Skins|Жіночі скіни]]
*[[Male Skins|Чоловічі скіни]]

'''Список скінів:'''
----
<syntaxhighlight lang="lua">
-- повний список
allSkins = getValidPedModels()
-- окремий список
maleSkins = {0, 1, 2, 7, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 32, 33, 34, 35, 36, 37, 43, 44, 45, 46, 47, 48, 49, 50, 51, 52, 57, 58, 59, 60, 61, 62, 66, 67, 68, 70, 71, 72, 73, 78, 79, 80, 81, 82, 83, 84, 94, 95, 96, 97, 98, 99, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109, 110, 111, 112, 113, 114, 115, 116, 117, 118, 120, 121, 122, 123, 124, 125, 126, 127, 128, 132, 133, 134, 135, 136, 137, 142, 143, 144, 146, 147, 153, 154, 155, 156, 158, 159, 160, 161, 162, 163, 164, 165, 166, 167, 168, 170, 171, 173, 174, 175, 176, 177, 179, 180, 181, 182, 183, 184, 185, 186, 187, 188, 189, 200, 202, 203, 204, 206, 209, 210, 212, 213, 217, 220, 221, 222, 223, 227, 228, 229, 230, 234, 235, 236, 239, 240, 241, 242, 247, 248, 249, 250, 252, 253, 254, 255, 258, 259, 260, 261, 262, 264, 265, 266, 267, 268, 269, 270, 271, 272, 274, 275, 276, 277, 278, 279, 280, 281, 282, 283, 284, 285, 286, 287, 288, 290, 291, 292, 293, 294, 295, 296, 297, 299, 300, 301, 302, 303, 305, 306, 307, 308, 309, 310, 311, 312}
femaleSkins = {9, 10, 11, 12, 13, 31, 38, 39, 40, 41, 53, 54, 55, 56, 63, 64, 69, 75, 76, 77, 85, 87, 88, 89, 90, 91, 92, 93, 129, 130, 131, 138, 139, 140, 141, 145, 148, 150, 151, 152, 157, 169, 172, 178, 190, 191, 192, 193, 194, 195, 196, 197, 198, 199, 201, 205, 207, 211, 214, 215, 216, 218, 219, 224, 225, 226, 231, 232, 233, 237, 238, 243, 244, 245, 246, 251, 256, 257, 263, 298, 304}
</syntaxhighlight>


'''Розбиті по секціях сторінки скінами:'''
----
*[[Skins Page 1|Сторінка 1]]: 7, 9-29
*[[Skins Page 2|Сторінка 2]]: 30-41, 43-52
*[[Skins Page 3|Сторінка 3]]: 53-64, 66-73, 75-76
*[[Skins Page 4|Сторінка 4]]: 77-85, 87-99
*[[Skins Page 5|Сторінка 5]]: 100-118, 120-122
*[[Skins Page 6|Сторінка 6]]: 123-144
*[[Skins Page 7|Сторінка 7]]: 145-148, 150-167
*[[Skins Page 8|Сторінка 8]]: 168-189
*[[Skins Page 9|Сторінка 9]]: 190-207, 209-212
*[[Skins Page 10|Сторінка 10]]: 213-234
*[[Skins Page 11|Сторінка 11]]: 235-238, 240-257
*[[Skins Page 12|Сторінка 12]]: 258-264, 274-288
*[[Skins Page 13|Сторінка 13]]: 290-312

==Примітки:==
*Останній діючий ID скіна: 312

*Ці пари ID відносяться до одного персонажу (1-й ID використовується в списках, 2-й відключений)
**118:119
**148:149

*Непрацюючі ID
**3 4 5 6 8 42 65 74 86 119 149 208 273 289

==Функції скінів==
{{Template:Skin_functions}}

==Див. також==
[[UK/Id|Списки ідентифікаторів]]

[[en:Character Skins]]
[[tr:Karakter Tipleri]]
[[it:Skin Personaggi]]
[[es:Skins de Personajes]]
[[de:Charakterskins]]
[[zh-cn:角色皮肤]]
[[ru:Character Skins]]

[[Category:Translated/ID Lists]]

DgsCreateBlurBox

2022-05-07T12:40:32Z

XLive:

__NOTOC__
{{Client function}}
<span style="color:#FF0000;text-shadow:black 0.1em 0.1em 0.6em;">>>>Warning: This feature requires pixel shader model 2_a<<<</span>

This function creates a blur box.

==Syntax==
<syntaxhighlight lang="lua">
element dgsCreateBlurBox( int resolutionX, int resolutionY [, texture sourceTexture = nil ] )
</syntaxhighlight>

[[Image:DGS_Blur_Box.png|300px|thumb|Example Blur Box]]

===Required Argument===
*'''resolutionX''': A number of the resolution of the blur box in width.
*'''resolutionY''': A number of the resolution of the blur box in height.

===Optional Argument===
*'''sourceTexture''': A texture that you want to blur. Set to ''nil'' to blur the screen.

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

==Example==
This example shows creating a blur box on image
<syntaxhighlight lang="lua">
DGS = exports.dgs --get exported functions from dgs
local x,y,width,height = 200,200,600,500

local blurbox = DGS:dgsCreateBlurBox(width, height) --Blur Box
local blurArea = DGS:dgsCreateImage(x,y,width,height,blurbox,false) --Blur Box Renderer
local window = DGS:dgsCreateWindow(x,y,width,height,"Test Window",false) --Window
DGS:dgsAttachToAutoDestroy(blurbox,window) --Destroy the blurbox with window
DGS:dgsAttachToAutoDestroy(blurArea,window) --Destroy the blurArea with window
DGS:dgsAttachElements(blurArea,window,0,0,1,1,true,true) --Attach Blur Box Renderer to Window
DGS:dgsSetLayer(blurArea,"bottom") --Make sure the blurArea is always under window
</syntaxhighlight>

This example adds a blurbox on the full screen
<syntaxhighlight lang="lua">
loadstring(exports.dgs:dgsImportFunction())()-- load functions

local sW, sH = guiGetScreenSize() -- get the screen size
local blurbox = dgsCreateBlurBox(sW, sH) -- Create a blur Box
local blurArea = dgsCreateImage(0,0,1,1,blurbox,true) -- --Blur Box Renderer
</syntaxhighlight>

This example shows that you can blur a dgs element
<syntaxhighlight lang="lua">
loadstring(exports.dgs:dgsImportFunction())()-- load functions

local sW, sH = guiGetScreenSize() -- get the screen size
local blurbox = dgsCreateBlurBox(sW/2, sH/2) -- Create a blur Box
dgsSetProperty(blurbox,"updateScreenSource",true)
dgsBlurBoxSetIntensity(blurbox,1)
dgsBlurBoxSetLevel(blurbox,15)
local blurArea = dgsCreateImage(0,0,0.5,0.5,blurbox,true) -- --Blur Box Renderer
window = dgsCreateWindow(400,200,800,200,"123",false)
dgsSetPostGUI(window,false)
dgsSetLayer(window,"bottom") --This window should be always under the blur box
</syntaxhighlight>

==See Also==
{{DGSFUNCTIONS}}

DgsCreateBlurBox

2022-05-07T12:39:30Z

XLive: improve example

__NOTOC__
{{Client function}}
<span style="color:#FF0000;text-shadow:black 0.1em 0.1em 0.6em;">>>>Warning: This feature requires pixel shader model 2_a<<<</span>

This function creates a blur box.

==Syntax==
<syntaxhighlight lang="lua">
element dgsCreateBlurBox( int resolutionX, int resolutionY [, texture sourceTexture = nil ] )
</syntaxhighlight>

[[Image:DGS_Blur_Box.png|300px|thumb|Example Blur Box]]

===Required Argument===
*'''resolutionX''': A number of the resolution of the blur box in width.
*'''resolutionY''': A number of the resolution of the blur box in height.

===Optional Argument===
*'''sourceTexture''': A texture that you want to blur. Set to ''nil'' to blur the screen.

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

==Example==
This example shows creating a blur box on image
<syntaxhighlight lang="lua">
DGS = exports.dgs --get exported functions from dgs
local x,y,width,height

local blurbox = DGS:dgsCreateBlurBox(width, height) --Blur Box
local blurArea = DGS:dgsCreateImage(x,y,width,height,blurbox,false) --Blur Box Renderer
local window = DGS:dgsCreateWindow(x,y,width,height,"Test Window",false) --Window
DGS:dgsAttachToAutoDestroy(blurbox,window) --Destroy the blurbox with window
DGS:dgsAttachToAutoDestroy(blurArea,window) --Destroy the blurArea with window
DGS:dgsAttachElements(blurArea,window,0,0,1,1,true,true) --Attach Blur Box Renderer to Window
DGS:dgsSetLayer(blurArea,"bottom") --Make sure the blurArea is always under window
</syntaxhighlight>

This example adds a blurbox on the full screen
<syntaxhighlight lang="lua">
loadstring(exports.dgs:dgsImportFunction())()-- load functions

local sW, sH = guiGetScreenSize() -- get the screen size
local blurbox = dgsCreateBlurBox(sW, sH) -- Create a blur Box
local blurArea = dgsCreateImage(0,0,1,1,blurbox,true) -- --Blur Box Renderer
</syntaxhighlight>

This example shows that you can blur a dgs element
<syntaxhighlight lang="lua">
loadstring(exports.dgs:dgsImportFunction())()-- load functions

local sW, sH = guiGetScreenSize() -- get the screen size
local blurbox = dgsCreateBlurBox(sW/2, sH/2) -- Create a blur Box
dgsSetProperty(blurbox,"updateScreenSource",true)
dgsBlurBoxSetIntensity(blurbox,1)
dgsBlurBoxSetLevel(blurbox,15)
local blurArea = dgsCreateImage(0,0,0.5,0.5,blurbox,true) -- --Blur Box Renderer
window = dgsCreateWindow(400,200,800,200,"123",false)
dgsSetPostGUI(window,false)
dgsSetLayer(window,"bottom") --This window should be always under the blur box
</syntaxhighlight>

==See Also==
{{DGSFUNCTIONS}}

User:XLive

2022-05-02T00:52:17Z

XLive:

<b>
*[https://github.com/xLive GitHub]
*[https://forum.mtasa.com/profile/52180-xlive/ Forum Profile]
*[https://community.multitheftauto.com/index.php?p=profile&id=416702 Community Profile]

<b>
[[Special:Contributions/XLive|My contributions in the wiki]]

<b>
[https://cdn.discordapp.com/emojis/755816981541683262.png?v=1 don't click!]

Dgs-dxbutton

2022-04-30T20:35:28Z

XLive: update image property

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

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

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

==Properties==
===alignment===
Alignment of the text within the button.
<syntaxhighlight lang="lua">dgsSetProperty(button,"alignment",{alignX,alignY})</syntaxhighlight>
*'''alignX:''' Horizontal alignment of the text within the button. Can be "left", "center" or "right".
*'''alignY:''' Vertical alignment of the text within the button. Can be "top", "center" or "bottom".

===clickOffset===
The offset indicates that how much the text of the button will shift when it is clicked.
<syntaxhighlight lang="lua">dgsSetProperty(button,"clickOffset",{offsetX,offsetY})</syntaxhighlight>
*'''offsetX''' : A float of the 2D X offset relative to the position of the button.
*'''offsetY''' : A float of the 2D Y offset relative to the position of the button.

===clickType===
This indicates that which button of the mouse can have effect on the button.
<syntaxhighlight lang="lua">dgsSetProperty(button,"clickType",clickType)</syntaxhighlight>
*'''clickType''' : If set to 1, only "Left Mouse Button" can do. If set to 2, only "Right Mouse Button" can do. Otherwise it will be both.

===color===
The color which can be translated by [[tocolor]] of the background of the button.
<syntaxhighlight lang="lua">dgsSetProperty(button,"color",{normalColor,hoveringColor,clickedColor})</syntaxhighlight>
*'''normalColor:''' An integer of the color of the background of the button ( neither selected nor clicked by mouse ).
*'''hoveringColor:''' An integer of the color of the background of the button which is selected.
*'''clickedColor:''' An integer of the color of the background of the button which is clicked.

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

===colorTransitionPeriod===
This property sets the transition period among colors (normal, hovering, clicked).
<syntaxhighlight lang="lua">dgsSetProperty(button,"colorTransitionPeriod",colorTransitionPeriod)</syntaxhighlight>
*'''colorTransitionPeriod''' : An integer indicates the transition time in miliseconds. ( Set to 0 to disable )

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

===iconAlignment===
Alignment of the icon within the button.
<syntaxhighlight lang="lua">dgsSetProperty(button,"iconAlignment",{alignX,alignY})</syntaxhighlight>
*'''alignX:''' Horizontal alignment of the icon within the button. Can be "left", "center" or "right".
*'''alignY:''' Vertical alignment of the icon within the button. Can be "top", "center" or "bottom".

===iconColor===
This property enables you to change the icon color (Work with '''iconImage''').
<syntaxhighlight lang="lua">dgsSetProperty(button,"iconColor",{normalColor,hoveringColor,clickedColor})</syntaxhighlight>
*'''normalColor:''' An integer of the color of the icon image of the button ( neither selected nor clicked by mouse ).
*'''hoveringColor:''' An integer of the color of the icon image of the button which is selected.
*'''clickedColor:''' An integer of the color of the icon image of the button which is clicked.

===iconImage===
Require [texture/shader] that can be used as the icon image of button.
<syntaxhighlight lang="lua">dgsSetProperty(button,"iconImage",{normalImage,hoveringImage,clickedImage})</syntaxhighlight>
*'''normalImage:''' A texture/shader element of the icon image of the button ( neither selected nor clicked by mouse ). ( You can pass a nil value to disable this option )
*'''hoveringImage:''' A texture/shader element of the icon image of the button which is selected. ( You can pass a nil value to disable this option )
*'''clickedImage:''' A texture/shader element of the icon image of the button which is clicked. ( You can pass a nil value to disable this option )

===iconOffset===
This property enables you to change the offset of the icon from the text (Work with '''iconImage''').
<syntaxhighlight lang="lua">dgsSetProperty(button,"iconOffset",{iconOffsetX,iconOffsetY,relative})</syntaxhighlight>
*'''iconOffsetX''' : An integer of the 2D X offset in pixels to the position of the icon.
*'''iconOffsetY''' : An integer of the 2D Y offset in pixels to the position of the icon.
*'''relative''' : A bool of whether the iconOffset is relative to the height of text or absolute pixels.

===iconRelative===
This property determines whether the icon is relative to the text or button.
<syntaxhighlight lang="lua">dgsSetProperty(button,"iconRelative",iconRelative)</syntaxhighlight>
*'''iconRelative:''' A bool determines whether the icon is relative to the text or button.

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

===iconSize===
This property enables you to change the icon size (Work with '''iconImage''').
<syntaxhighlight lang="lua">dgsSetProperty(button,"iconSize",{iconSizeX,iconSizeY,relative})</syntaxhighlight>
*'''iconSizeX''' : An integer of the 2D X scale to the position of the icon image.
*'''iconSizeY''' : An integer of the 2D Y scale to the position of the icon image.
*'''relative''' : A bool of whether the iconSize is relative to the height of text or absolute pixels.

===image===
Require [texture/shader] that can be used as the background of button.
<syntaxhighlight lang="lua">dgsSetProperty(button,"image",image)</syntaxhighlight>
*'''image:''' A texture/shader element of the background of the button
Or
<syntaxhighlight lang="lua">dgsSetProperty(button,"image",{normalImage,hoveringImage,ClickedImage})</syntaxhighlight>
*'''normalImage:''' A texture/shader element of the background of the button ( neither selected nor clicked by mouse ). ( You can pass a nil value to disable this image option )
*'''hoveringImage:''' A texture/shader element of the background of the button which is selected. ( You can pass a nil value to disable this image option )
*'''clickedImage:''' A texture/shader element of the background of the button which is clicked. ( You can pass a nil value to disable this image option )

===text===
This is equivalent to [[dgsSetText]]/[[dgsGetText]].
<syntaxhighlight lang="lua">dgsSetProperty(button,"text",text)</syntaxhighlight>
*'''text''' : A string of the text of the button.

===textColor===
The color which can be translated by [[tocolor]] of the text of the button.
<syntaxhighlight lang="lua">dgsSetProperty(button,"textColor",textColor)</syntaxhighlight>
*'''textColor''' : An integer of the color of the text of the button.

===textOffset===
The offset of the text on button.
<syntaxhighlight lang="lua">dgsSetProperty(button,"textOffset",{offsetX,offsetY,relative})</syntaxhighlight>
*'''offsetX''' : A float of the 2D X offset relative to the position of the button, depends on '''relative'''.
*'''offsetY''' : A float of the 2D Y offset relative to the position of the button, depends on '''relative'''.
*'''relative''' : A bool of whether the offset is relative or absolute.

===textSize===
The scale of the text of the button. ''Learn More [[dxDrawText]]''
<syntaxhighlight lang="lua">dgsSetProperty(button,"textSize",{scaleX,scaleY})</syntaxhighlight>
*'''scaleX''' : A float of the 2D X scale of the text of the button.
*'''scaleY''' : A float of the 2D Y scale of the text of the button.

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

===wordBreak===
Whether the word-break is enabled or not. ''Learn More [[dxDrawText]]''
<syntaxhighlight lang="lua">dgsSetProperty(button,"wordBreak",wordBreak)</syntaxhighlight>
*'''wordBreak''' : If set to true, the text will wrap to a new line whenever it reaches the right side of the bounding box. If false, the text will always be completely on one line.

==See Also==
{{DGSPROPERTIES}}

DgsLabelGetFontHeight

2022-03-16T16:38:05Z

XLive: Undo revision 74285 by XNawaf (talk)

{{Client function}}
__NOTOC__
This function returns the height of the font currently used in a DGS text label.

==Syntax==
<syntaxhighlight lang="lua">
float dgsLabelGetFontHeight ( element theLabel )
</syntaxhighlight>
===Required Arguments===
*'''theLabel:''' The text label to get the font height from.

===Returns===
Returns the absolute height of the font currently used in the text label if the function is successful, ''false'' otherwise.

==Example==
This example creates a window, a text label, gets the text extent and font height, and sets the text label size according to these values.
<syntaxhighlight lang="lua">
DGS = exports.dgs
-- create the window (the container for our label)
local myWindow = DGS:dgsCreateWindow ( 0, 0, 0.5, 0.4, "Information", true )

-- create the label
local myLabel = DGS:dgsCreateLabel ( 10, 10, 0, 0, "This is my text container", false, myWindow )

-- get the (absolute) text extent and font height, and use these to size the label
DGS:dgsSetSize ( myLabel, DGS:dgsLabelGetTextExtent ( myLabel ), DGS:dgsLabelGetFontHeight ( myLabel ), false )
</syntaxhighlight>

==See Also==
{{DGSFUNCTIONS}}

DgsLabelGetTextExtent

2022-03-16T16:37:23Z

XLive: Undo revision 74284 by XNawaf (talk)

{{Client function}}
__NOTOC__
This function returns the extent, or width, of the current text inside a DGS text label.

==Syntax==
<syntaxhighlight lang="lua">
float dgsLabelGetTextExtent ( element theLabel )
</syntaxhighlight>
===Required Arguments===
*'''theLabel:''' The text label to get the text extent from.

===Returns===
Returns the absolute width of the current text inside the text label if the function is successful, ''false'' otherwise.

==Example==
This example creates a window, a text label, gets the text extent and font height, and sets the text label size according to these values.
<syntaxhighlight lang="lua">
DGS = exports.dgs
-- create the window (the container for our label)
local myWindow = DGS:dgsCreateWindow ( 0, 0, 0.5, 0.4, "Information", true )

-- create the label
local myLabel = DGS:dgsCreateLabel ( 10, 10, 0, 0, "This is my text container", false, myWindow )

-- get the (absolute) text extent and font height, and use these to size the label
DGS:dgsSetSize ( myLabel, DGS:dgsLabelGetTextExtent ( myLabel ), DGS:dgsLabelGetFontHeight ( myLabel ), false )
</syntaxhighlight>

==See Also==
{{DGSFUNCTIONS}}

DgsLabelGetFontHeight

2022-03-16T16:13:02Z

XLive: Redirected page to DgsLabelGetTextSize

#REDIRECT [[dgsLabelGetTextSize]]

DgsLabelGetTextExtent

2022-03-16T16:12:27Z

XLive: Redirected page to DgsLabelGetTextSize

#REDIRECT [[dgsLabelGetTextSize]]

DgsLabelGetTextSize

2022-03-16T16:09:42Z

XLive: Undo revision 74282 by XNawaf (talk)

{{Client function}}
__NOTOC__
This function retrieves the theoretical width and height (in pixels) of a certain piece of text of dgs label.

==Syntax==
<syntaxhighlight lang="lua">
float float dgsLabelGetTextSize( element theLabel )
</syntaxhighlight>
===Required Arguments===
*'''theLabel:''' The label of whose text you wish to retrieve the width and height.

===Returns===
Returns two floats representing the width and height of the text in pixels.

==Example==
This example creates a text label, gets the text width and height, and creates a background for the label.
<syntaxhighlight lang="lua">
DGS = exports.dgs

local myLabel = DGS:dgsCreateLabel ( 200, 200, 100, 100, "OK. This is a dgs label of which you want to get the text width and height", false )
DGS:dgsSetProperty(myLabel,"wordBreak",true)
local width,height = DGS:dgsLabelGetTextSize( myLabel )
local background = DGS:dgsCreateImage(200, 200, width, height, _, false, _, tocolor(0,0,0,100))
</syntaxhighlight>

==See Also==
{{DGSFUNCTIONS}}

DgsLabelGetTextSize

2022-03-16T16:06:00Z

XLive:

{{Client function}}
__NOTOC__
This function retrieves the theoretical width and height (in pixels) of a certain piece of text of dgs label.

==Syntax==
<syntaxhighlight lang="lua">
float dgsLabelGetTextSize( element theLabel )
</syntaxhighlight>
===Required Arguments===
*'''theLabel:''' The label of whose text you wish to retrieve the width and height.

===Returns===
Returns two floats representing the width and height of the text in pixels.

==Example==
This example creates a text label, gets the text width and height, and creates a background for the label.
<syntaxhighlight lang="lua">
DGS = exports.dgs

local myLabel = DGS:dgsCreateLabel ( 200, 200, 100, 100, "OK. This is a dgs label of which you want to get the text width and height", false )
DGS:dgsSetProperty(myLabel,"wordBreak",true)
local width,height = DGS:dgsLabelGetTextSize( myLabel )
local background = DGS:dgsCreateImage(200, 200, width, height, _, false, _, tocolor(0,0,0,100))
</syntaxhighlight>

==See Also==
{{DGSFUNCTIONS}}

Dgs-dxcombobox

2022-01-09T15:34:07Z

XLive: update arrow

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

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

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

==Properties==
===arrow===
This property determines the arrow material of the combo box.
<syntaxhighlight lang="lua">dgsSetProperty(combobox,"arrow",arrow)</syntaxhighlight>
*'''arrow:''' A material element (texture/shader/screen).

===alignment===
Alignment of the caption text within the combo box.
<syntaxhighlight lang="lua">dgsSetProperty(combobox,"alignment",{alignX,alignY})</syntaxhighlight>
*'''alignX:''' Horizontal alignment of the caption text within the combo box. Can be "left", "center" or "right".
*'''alignY:''' Vertical alignment of the caption text within the combo box. Can be "top", "center" or "bottom".

===autoHideAfterSelected===
This property determines whether the drop down will be hide automatically after selected.
<syntaxhighlight lang="lua">dgsSetProperty(combobox,"autoHideAfterSelected",autoHideAfterSelected)</syntaxhighlight>
*'''autoHideAfterSelected:''' A bool indicates whether the drop down will be hide automatically after selected.

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

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

===buttonLen===
This property stores the width of the arrow button.
<syntaxhighlight lang="lua">dgsSetProperty(combobox,"buttonLen",{buttonLen,relative})</syntaxhighlight>
*'''buttonLen:''' A float of the width of arrow button, which is affected by '''relative'''.
*'''relative:''' If set to ''true'', '''buttonLen''' will range from 0 to 1 relative to combo box's height, otherwise the '''buttonLen''' will be absolute pixels.

===captionEdit===
This property stores the caption edit when the caption is editable with [[dgsComboBoxSetEditEnabled]].
<syntaxhighlight lang="lua">dgsSetProperty(combobox,"captionEdit",captionEdit)</syntaxhighlight>
*'''captionEdit:''' A dgs-dxedit element.

===caption===
This property stores the caption text of combo box.
<syntaxhighlight lang="lua">dgsSetProperty(combobox,"caption",caption)</syntaxhighlight>
*'''caption:''' A string of the caption text of the combo box.

===clip===
Whether the clip property is enabled (include caption text and item text). ''Learn More [[dxDrawText]]''
<syntaxhighlight lang="lua">dgsSetProperty(combobox,"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.

===color===
The color which can be translated by [[tocolor]] of the background of the combobox (behind arrow).
<syntaxhighlight lang="lua">dgsSetProperty(combobox,"color",{normalColor,hoveringColor,clickedColor})</syntaxhighlight>
*'''normalColor:''' An integer of the color of the combobox ( neither selected nor clicked by mouse ).
*'''hoveringColor:''' An integer of the color of the combobox which is selected.
*'''clickedColor:''' An integer of the color of the comboox which is clicked.

===colorcoded===
Whether the color code is enabled (include caption text and item text). ''Learn More [[dxDrawText]]''
<syntaxhighlight lang="lua">dgsSetProperty(combobox,"colorcoded",colorcoded)</syntaxhighlight>
*'''colorcoded:''' Set to true to enable embedded #FFFFFF color codes.

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

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

===shadow===
The shadow of the text of the combo box.
<syntaxhighlight lang="lua">dgsSetProperty(combobox,"shadow",{offsetX,offsetY,color,outline})</syntaxhighlight>
*'''offsetX:''' A float of the 2D X offset of the shadow text of the combo box.
*'''offsetY:''' A float of the 2D Y offset of the shadow text of the combo box.
*'''color:''' An integer of the color of the shadow text of the combo box.
*'''outline:''' A bool of the outline state of the shadow text.

===myBox===
Combo box is composed by dgs-dxcombobox and dgs-dxcombobox-Box. This property stores the dgs-combobox-Box of dgs-dxcombobox.
<syntaxhighlight lang="lua">dgsSetProperty(combobox,"myBox",myBox)</syntaxhighlight>
*'''myBox:''' A dgs-dxcombobox-box element.

===image===
The image of combo box ( under arrow ).
<syntaxhighlight lang="lua">dgsSetProperty(combobox,"image",{normalImage,hoveringImage,clickedImage})</syntaxhighlight>
*'''normalImage:''' A texture element of the background of the combobox ( no mouse enter and no mouse click ).
*'''hoveringImage:''' A texture element of the background of the combobox which is selected.
*'''clickedImage:''' A texture element of the background of the combobox which is clicked.

===itemAlignment===
Alignment of the item text within the combo box.
<syntaxhighlight lang="lua">dgsSetProperty(combobox,"itemAlignment",{alignX,alignY})</syntaxhighlight>
*'''alignX:''' Horizontal alignment of the item text within the combo box. Can be "left", "center" or "right".
*'''alignY:''' Vertical alignment of the item text within the combo box. Can be "top", "center" or "bottom".

===itemTextPadding===
This property determines the item text padding of combo box.
<syntaxhighlight lang="lua">dgsSetProperty(combobox,"itemTextPadding",{paddingX,alignY})</syntaxhighlight>
*'''paddingX''' : An integer of 2D x padding value.
*'''paddingY''' : An integer of 2D y padding value.

===itemColor===
This property determines the 3 states' back ground colors of item.
<syntaxhighlight lang="lua">dgsSetProperty(combobox,"itemColor",{colorNormal,colorHoving,colorSelected})</syntaxhighlight>
*'''colorNormal:''' An integer of the color of the item (Normal State).
*'''colorHoving:''' An integer of the color of the item (Hoving State).
*'''colorSelected:''' An integer of the color of the item (Selected State).

===itemData===
This property stores item data.
<syntaxhighlight lang="lua">dgsSetProperty(gridlist,"itemData",itemData)</syntaxhighlight>
*'''columnData:''' A table stores all item data.
'''Item Structure'''
<syntaxhighlight lang="lua">
{
textColor BackGround Image BackGround Color Text
{[-2]=color, [-1]={normal,hovering,selected}, [0]={normal,hovering,selected}, text },
{[-2]=color, [-1]={normal,hovering,selected}, [0]={normal,hovering,selected}, text },
{[-2]=color, [-1]={normal,hovering,selected}, [0]={normal,hovering,selected}, text },
{ ... },
}
]]
</syntaxhighlight>

===itemImage===
This property determines the 3 states' background image of item.
<syntaxhighlight lang="lua">dgsSetProperty(combobox,"itemImage",{imageDefault,cimageHoving,imageSelected})</syntaxhighlight>
*'''imageNormal:''' A texture of the image of the row (Normal State).
*'''cimageHoving:''' A texture of the image of the row (Hoving State).
*'''imageSelected:''' A texture of the image of the row (Selected State).

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

===itemTextColor===
This property determines the color of the item text of the combo box.
<syntaxhighlight lang="lua">dgsSetProperty(combobox,"itemTextColor",itemTextColor)</syntaxhighlight>
*'''itemTextColor:''' An integer of the color that can be converted by [[tocolor]].

===itemTextSize===
This property determines the scale of the item text of the combo box.
<syntaxhighlight lang="lua">dgsSetProperty(combobox,"itemTextSize",{scaleX,scaleY})</syntaxhighlight>
*'''scaleX:''' A float of the 2D X scale of the text of the item.
*'''scaleY:''' A float of the 2D Y scale of the text of the item.

===listState===
This property stores the state of combo box which determines whether the combo box is opened(1) or closed(-1).
See: [[dgsComboBoxGetState]]/[[dgsComboBoxSetState]]
<syntaxhighlight lang="lua">dgsSetProperty(combobox,"listState",listState)</syntaxhighlight>
*'''listState:''' An integer of the state of combo box.

===moveHardness===
This property determines how hard will the combo box moves when scrolling.
<syntaxhighlight lang="lua">dgsSetProperty(combobox,"moveHardness",moveHardness)</syntaxhighlight>
*'''moveHardness:''' A float determins how hard will the combo box moves when scrolling ( should be larger than 0, lower than 1 ).

===scrollbar===
This property stores the scroll bar of combo box.
<syntaxhighlight lang="lua">dgsSetProperty(combobox,"scrollbar",scrollbar)</syntaxhighlight>
*'''scrollbar:''' a dgs-dxscrollbar element.

===select===
This property stores the selected item of combo box.
<syntaxhighlight lang="lua">dgsSetProperty(combobox,"select",select)</syntaxhighlight>
*'''select:''' A integer of the index of selected item .

===textColor===
The color which can be translated by [[tocolor]] of the caption text of the combo box.
<syntaxhighlight lang="lua">dgsSetProperty(combobox,"textColor",textColor)</syntaxhighlight>
*'''textColor:''' An integer of the color of the text of the combo box.

===textPadding===
This property determines the caption text padding of combo box.
<syntaxhighlight lang="lua">dgsSetProperty(combobox,"textPadding",{paddingX,alignY})</syntaxhighlight>
*'''paddingX''' : An integer of 2D x padding value.
*'''paddingY''' : An integer of 2D y padding value.

===textSize===
The scale of the capiton text of the combo box. ''Learn More [[dxDrawText]]''
<syntaxhighlight lang="lua">dgsSetProperty(combobox,"textSize",{scaleX,scaleY})</syntaxhighlight>
*'''scaleX:''' A float of the 2D X scale of the text of the combo box.
*'''scaleY:''' A float of the 2D Y scale of the text of the combo box.

===textBox===
This property determines whether the '''caption''' of combo box is enabled or not.
<syntaxhighlight lang="lua">dgsSetProperty(combobox,"textBox",textBox)</syntaxhighlight>
*'''textBox:''' A bool indicates whether the '''caption''' of combo box is enabled or not.

===wordbreak===
Whether the word-break of capiton text is enabled or not. ''Learn More [[dxDrawText]]''
<syntaxhighlight lang="lua">dgsSetProperty(capiton ,"wordbreak",wordbreak)</syntaxhighlight>
*'''wordbreak:''' If set to true, the text will wrap to a new line whenever it reaches the right side of the bounding box. If false, the text will always be completely on one line.

==Property of dgs-dxcombobox-Box==
===myCombo===
Combo box is composed by dgs-dxcombobox and dgs-dxcombobox-Box. This property stores the dgs-comboboxof dgs-dxcombobox-Box.
<syntaxhighlight lang="lua">dgsSetProperty(myCombo,"myCombo",myCombo)</syntaxhighlight>
*'''myComboyBox:''' A dgs-dxcombobox element.

==See Also==
{{DGSPROPERTIES}}

DgsCreateGradient

2021-08-10T23:37:05Z

XLive: add missing space to syntax

__NOTOC__
{{Client function}}
This function is for creating a gradient shader.

==Syntax==
<syntaxhighlight lang="lua">
element dgsCreateGradient( int colorFrom, int colorTo [, float rotation = 0 ] )
</syntaxhighlight>

===Required Arguments===
*'''colorFrom''': Gradient color 1
*'''colorTo ''': Gradient color 2

===Optional Arguments===
*'''rotation ''': The rotation of the direction of the gradient.

===Returns===
Returns a dgs-dxgradient [Element Type:shader] if successful, ''false'' otherwise.

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

-- Create A Button
button = DGS:dgsCreateButton( 0.7, 0.1, 0.2, 0.1, "OK", true )

-- Create A Gradient Plugin
gradient = DGS:dgsCreateGradient(tocolor(240,10,10,255),tocolor(100,10,10,255),-90)

-- Tell gradient that don't overwrite the color from the button
DGS:dgsGradientSetColorOverwritten(gradient,false)

-- Apply the gradient to the button
DGS:dgsSetProperty(button,"image",{gradient, gradient, gradient})

-- Apply the color
DGS:dgsSetProperty(button,"color",{tocolor(200,200,200,255),tocolor(255,255,255,255),tocolor(100,100,100,255)})
</syntaxhighlight>

==See Also==
{{DGSFUNCTIONS}}

Dgs-dxcombobox

2021-07-28T10:35:21Z

XLive: color property

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

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

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

==Properties==
===arrow===
This property stores the arrow shader of the combo box.
<syntaxhighlight lang="lua">dgsSetProperty(combobox,"arrow",arrow)</syntaxhighlight>
*'''arrow:''' a shader.

===alignment===
Alignment of the caption text within the combo box.
<syntaxhighlight lang="lua">dgsSetProperty(combobox,"alignment",{alignX,alignY})</syntaxhighlight>
*'''alignX:''' Horizontal alignment of the caption text within the combo box. Can be "left", "center" or "right".
*'''alignY:''' Vertical alignment of the caption text within the combo box. Can be "top", "center" or "bottom".

===autoHideAfterSelected===
This property determines whether the drop down will be hide automatically after selected.
<syntaxhighlight lang="lua">dgsSetProperty(combobox,"autoHideAfterSelected",autoHideAfterSelected)</syntaxhighlight>
*'''autoHideAfterSelected:''' A bool indicates whether the drop down will be hide automatically after selected.

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

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

===buttonLen===
This property stores the width of the arrow button.
<syntaxhighlight lang="lua">dgsSetProperty(combobox,"buttonLen",{buttonLen,relative})</syntaxhighlight>
*'''buttonLen:''' A float of the width of arrow button, which is affected by '''relative'''.
*'''relative:''' If set to ''true'', '''buttonLen''' will range from 0 to 1 relative to combo box's height, otherwise the '''buttonLen''' will be absolute pixels.

===captionEdit===
This property stores the caption edit when the caption is editable with [[dgsComboBoxSetEditEnabled]].
<syntaxhighlight lang="lua">dgsSetProperty(combobox,"captionEdit",captionEdit)</syntaxhighlight>
*'''captionEdit:''' A dgs-dxedit element.

===caption===
This property stores the caption text of combo box.
<syntaxhighlight lang="lua">dgsSetProperty(combobox,"caption",caption)</syntaxhighlight>
*'''caption:''' A string of the caption text of the combo box.

===clip===
Whether the clip property is enabled (include caption text and item text). ''Learn More [[dxDrawText]]''
<syntaxhighlight lang="lua">dgsSetProperty(combobox,"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.

===color===
The color which can be translated by [[tocolor]] of the background of the combobox (behind arrow).
<syntaxhighlight lang="lua">dgsSetProperty(combobox,"color",{normalColor,hoveringColor,clickedColor})</syntaxhighlight>
*'''normalColor:''' An integer of the color of the combobox ( neither selected nor clicked by mouse ).
*'''hoveringColor:''' An integer of the color of the combobox which is selected.
*'''clickedColor:''' An integer of the color of the comboox which is clicked.

===colorcoded===
Whether the color code is enabled (include caption text and item text). ''Learn More [[dxDrawText]]''
<syntaxhighlight lang="lua">dgsSetProperty(combobox,"colorcoded",colorcoded)</syntaxhighlight>
*'''colorcoded:''' Set to true to enable embedded #FFFFFF color codes.

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

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

===shadow===
The shadow of the text of the combo box.
<syntaxhighlight lang="lua">dgsSetProperty(combobox,"shadow",{offsetX,offsetY,color,outline})</syntaxhighlight>
*'''offsetX:''' A float of the 2D X offset of the shadow text of the combo box.
*'''offsetY:''' A float of the 2D Y offset of the shadow text of the combo box.
*'''color:''' An integer of the color of the shadow text of the combo box.
*'''outline:''' A bool of the outline state of the shadow text.

===myBox===
Combo box is composed by dgs-dxcombobox and dgs-dxcombobox-Box. This property stores the dgs-combobox-Box of dgs-dxcombobox.
<syntaxhighlight lang="lua">dgsSetProperty(combobox,"myBox",myBox)</syntaxhighlight>
*'''myBox:''' A dgs-dxcombobox-box element.

===image===
The image of combo box ( under arrow ).
<syntaxhighlight lang="lua">dgsSetProperty(combobox,"image",{normalImage,hoveringImage,clickedImage})</syntaxhighlight>
*'''normalImage:''' A texture element of the background of the combobox ( no mouse enter and no mouse click ).
*'''hoveringImage:''' A texture element of the background of the combobox which is selected.
*'''clickedImage:''' A texture element of the background of the combobox which is clicked.

===itemAlignment===
Alignment of the item text within the combo box.
<syntaxhighlight lang="lua">dgsSetProperty(combobox,"itemAlignment",{alignX,alignY})</syntaxhighlight>
*'''alignX:''' Horizontal alignment of the item text within the combo box. Can be "left", "center" or "right".
*'''alignY:''' Vertical alignment of the item text within the combo box. Can be "top", "center" or "bottom".

===itemTextPadding===
This property determines the item text padding of combo box.
<syntaxhighlight lang="lua">dgsSetProperty(combobox,"itemTextPadding",{paddingX,alignY})</syntaxhighlight>
*'''paddingX''' : An integer of 2D x padding value.
*'''paddingY''' : An integer of 2D y padding value.

===itemColor===
This property determines the 3 states' back ground colors of item.
<syntaxhighlight lang="lua">dgsSetProperty(combobox,"itemColor",{colorNormal,colorHoving,colorSelected})</syntaxhighlight>
*'''colorNormal:''' An integer of the color of the item (Normal State).
*'''colorHoving:''' An integer of the color of the item (Hoving State).
*'''colorSelected:''' An integer of the color of the item (Selected State).

===itemData===
This property stores item data.
<syntaxhighlight lang="lua">dgsSetProperty(gridlist,"itemData",itemData)</syntaxhighlight>
*'''columnData:''' A table stores all item data.
'''Item Structure'''
<syntaxhighlight lang="lua">
{
textColor BackGround Image BackGround Color Text
{[-2]=color, [-1]={normal,hovering,selected}, [0]={normal,hovering,selected}, text },
{[-2]=color, [-1]={normal,hovering,selected}, [0]={normal,hovering,selected}, text },
{[-2]=color, [-1]={normal,hovering,selected}, [0]={normal,hovering,selected}, text },
{ ... },
}
]]
</syntaxhighlight>

===itemImage===
This property determines the 3 states' background image of item.
<syntaxhighlight lang="lua">dgsSetProperty(combobox,"itemImage",{imageDefault,cimageHoving,imageSelected})</syntaxhighlight>
*'''imageNormal:''' A texture of the image of the row (Normal State).
*'''cimageHoving:''' A texture of the image of the row (Hoving State).
*'''imageSelected:''' A texture of the image of the row (Selected State).

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

===itemTextColor===
This property determines the color of the item text of the combo box.
<syntaxhighlight lang="lua">dgsSetProperty(combobox,"itemTextColor",itemTextColor)</syntaxhighlight>
*'''itemTextColor:''' An integer of the color that can be converted by [[tocolor]].

===itemTextSize===
This property determines the scale of the item text of the combo box.
<syntaxhighlight lang="lua">dgsSetProperty(combobox,"itemTextSize",{scaleX,scaleY})</syntaxhighlight>
*'''scaleX:''' A float of the 2D X scale of the text of the item.
*'''scaleY:''' A float of the 2D Y scale of the text of the item.

===listState===
This property stores the state of combo box which determines whether the combo box is opened(1) or closed(-1).
See: [[dgsComboBoxGetState]]/[[dgsComboBoxSetState]]
<syntaxhighlight lang="lua">dgsSetProperty(combobox,"listState",listState)</syntaxhighlight>
*'''listState:''' An integer of the state of combo box.

===moveHardness===
This property determines how hard will the combo box moves when scrolling.
<syntaxhighlight lang="lua">dgsSetProperty(combobox,"moveHardness",moveHardness)</syntaxhighlight>
*'''moveHardness:''' A float determins how hard will the combo box moves when scrolling ( should be larger than 0, lower than 1 ).

===scrollbar===
This property stores the scroll bar of combo box.
<syntaxhighlight lang="lua">dgsSetProperty(combobox,"scrollbar",scrollbar)</syntaxhighlight>
*'''scrollbar:''' a dgs-dxscrollbar element.

===select===
This property stores the selected item of combo box.
<syntaxhighlight lang="lua">dgsSetProperty(combobox,"select",select)</syntaxhighlight>
*'''select:''' A integer of the index of selected item .

===textColor===
The color which can be translated by [[tocolor]] of the caption text of the combo box.
<syntaxhighlight lang="lua">dgsSetProperty(combobox,"textColor",textColor)</syntaxhighlight>
*'''textColor:''' An integer of the color of the text of the combo box.

===textPadding===
This property determines the caption text padding of combo box.
<syntaxhighlight lang="lua">dgsSetProperty(combobox,"textPadding",{paddingX,alignY})</syntaxhighlight>
*'''paddingX''' : An integer of 2D x padding value.
*'''paddingY''' : An integer of 2D y padding value.

===textSize===
The scale of the capiton text of the combo box. ''Learn More [[dxDrawText]]''
<syntaxhighlight lang="lua">dgsSetProperty(combobox,"textSize",{scaleX,scaleY})</syntaxhighlight>
*'''scaleX:''' A float of the 2D X scale of the text of the combo box.
*'''scaleY:''' A float of the 2D Y scale of the text of the combo box.

===textBox===
This property determines whether the '''caption''' of combo box is enabled or not.
<syntaxhighlight lang="lua">dgsSetProperty(combobox,"textBox",textBox)</syntaxhighlight>
*'''textBox:''' A bool indicates whether the '''caption''' of combo box is enabled or not.

===wordbreak===
Whether the word-break of capiton text is enabled or not. ''Learn More [[dxDrawText]]''
<syntaxhighlight lang="lua">dgsSetProperty(capiton ,"wordbreak",wordbreak)</syntaxhighlight>
*'''wordbreak:''' If set to true, the text will wrap to a new line whenever it reaches the right side of the bounding box. If false, the text will always be completely on one line.

==Property of dgs-dxcombobox-Box==
===myCombo===
Combo box is composed by dgs-dxcombobox and dgs-dxcombobox-Box. This property stores the dgs-comboboxof dgs-dxcombobox-Box.
<syntaxhighlight lang="lua">dgsSetProperty(myCombo,"myCombo",myCombo)</syntaxhighlight>
*'''myComboyBox:''' A dgs-dxcombobox element.

==See Also==
{{DGSPROPERTIES}}