Multi Theft Auto: Wiki - User contributions [en]

Resource:DGS

2021-04-07T17:26:28Z

FlyingFork:

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

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

'''Developer''': [[User:thisdp|thisdp]], [[User:XNawaf|xLive]]

'''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 Source''': https://github.com/thisdp/dgs/tree/master

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

'''Current Version''': 3.506

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

'''Syntax Highlighting''':

*Visual Studio Code, made by [BW]~ERAGON > https://marketplace.visualstudio.com/items?itemName=ERAGON.mtasa-dgs-lua
*Notepad, made by thisdp > https://drive.google.com/file/d/1H_PiG2gmEz1AyXqZN4956IVgtZOjgMi6/view?usp=sharing
</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

'''Auto Completion'''

DGS Official Auto Completion:
*Use the following command in server console to crawl and generate the latest auto completion (Only support notepad++/sumlime).
*'''g2d -crawl npp/sublime'''

3rd Party Auto Completion:
*1. Link: http://www.mediafire.com/file/m6dm7815d5dihax/lua.zip By [[User:Ahmed Ly|Ahmed Ly]]
*2. '''Note''': You must put it in file Notepad++\plugins\APIs.
*3. Not all of DGS Functions are added, but the rest will be added soon.

'''Debug'''
* You can enter the debug mode by executing the command "'''debugdgs'''".
* "'''debugdgs 2 '''": To see dgs elements' scale with a rainbow border
* "'''debugdgs 3 '''": To trace where the dgs elements' were created.

'''DGS Type'''
[[Image:Dx Dgs.jpg|400px|thumb|right|Hurt World GUI Example]]
Basic Types:
* 3D Image (dgs-dx3dimage)
* 3D Interface (dgs-dx3dinterface)
* 3D Line (dgs-dx3dline)
* 3D Text(dgs-dx3dtext)
* Browser (dgs-browser)
* Button (dgs-dxbutton)
* Check Box (dgs-dxcheckbox)
* Combo Box (dgs-dxcombobox + dgs-dxcombobox-Box)
* Custom Renderer (dgs-dxcustomrenderer)
* Detect Area (dgs-dxdetectarea)
* Edit (dgs-dxedit)
* Gridlist (dgs-dxgridlist)
* Image (dgs-dximage)
* Label (dgs-dxlabel)
* Media Browser (dgs-dxmedia)
* Memo (dgs-dxmemo)
* Progress Bar (dgs-dxprogressbar)
* Radio Button (dgs-dxradiobutton)
* Scale Pane (dgs-dxscalepane)
* Scroll Bar (dgs-dxscrollbar)
* Scroll Pane (dgs-dxscrollpane)
* Selector (dgs-dxselector)
* Switch Button(dgs-dxswitchbutton)
* Tab Panel (dgs-dxtabpanel + dgs-dxtab)
* Window (dgs-dxwindow)

Plugins:
* Blur Box (dgs-dxblurbox)
* Canvas (dgs-dxcanvas)
* Circle (dgs-dxcircle)
* Color Picker (dgs-dxcolorpicker + dgs-dxcomponentselector)
* Effect 3D (dgs-dxeffect3d)
* Mask (dgs-dxmask)
* Media Browser (dgs-dxmediabrowser)
* Nine Slice (dgs-dxnineslice)
* Object Preview Supports (dgs-dxobjectpreviewhandle)
* Paste Handler (dgs-dxpastehandler)
* QRCode (dgs-dxqrcode)
* Remote Image (dgs-dxremoteimage)
* Rounded Rectangle (dgs-dxroundrect)

'''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>

'''Want to talk to us?'''
*Join Discord Server: https://discord.gg/QEs8q6W

'''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, xLive
Special thanks to:
* Ahmed Ly
* ᴛᴇᴍᴏɪꜱ

='''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:Dgs]]
[[ZH-CN:Dgs]]
[[PL:Dgs]]

Resource:DGS

2021-04-07T17:22:06Z

FlyingFork: Added Syntax Highlighting links

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

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

'''Developer''': [[User:thisdp|thisdp]], [[User:XNawaf|xLive]]

'''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 Source''': https://github.com/thisdp/dgs/tree/master

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

'''Current Version''': 3.506

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

'''Syntax Highlighting''':

*Visual Studio Code, made by [BW]~ERAGON > https://marketplace.visualstudio.com/items?itemName=ERAGON.mtasa-dgs-lua
*Notepad, made by xLive > https://drive.google.com/file/d/1H_PiG2gmEz1AyXqZN4956IVgtZOjgMi6/view?usp=sharing
</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

'''Auto Completion'''

DGS Official Auto Completion:
*Use the following command in server console to crawl and generate the latest auto completion (Only support notepad++/sumlime).
*'''g2d -crawl npp/sublime'''

3rd Party Auto Completion:
*1. Link: http://www.mediafire.com/file/m6dm7815d5dihax/lua.zip By [[User:Ahmed Ly|Ahmed Ly]]
*2. '''Note''': You must put it in file Notepad++\plugins\APIs.
*3. Not all of DGS Functions are added, but the rest will be added soon.

'''Debug'''
* You can enter the debug mode by executing the command "'''debugdgs'''".
* "'''debugdgs 2 '''": To see dgs elements' scale with a rainbow border
* "'''debugdgs 3 '''": To trace where the dgs elements' were created.

'''DGS Type'''
[[Image:Dx Dgs.jpg|400px|thumb|right|Hurt World GUI Example]]
Basic Types:
* 3D Image (dgs-dx3dimage)
* 3D Interface (dgs-dx3dinterface)
* 3D Line (dgs-dx3dline)
* 3D Text(dgs-dx3dtext)
* Browser (dgs-browser)
* Button (dgs-dxbutton)
* Check Box (dgs-dxcheckbox)
* Combo Box (dgs-dxcombobox + dgs-dxcombobox-Box)
* Custom Renderer (dgs-dxcustomrenderer)
* Detect Area (dgs-dxdetectarea)
* Edit (dgs-dxedit)
* Gridlist (dgs-dxgridlist)
* Image (dgs-dximage)
* Label (dgs-dxlabel)
* Media Browser (dgs-dxmedia)
* Memo (dgs-dxmemo)
* Progress Bar (dgs-dxprogressbar)
* Radio Button (dgs-dxradiobutton)
* Scale Pane (dgs-dxscalepane)
* Scroll Bar (dgs-dxscrollbar)
* Scroll Pane (dgs-dxscrollpane)
* Selector (dgs-dxselector)
* Switch Button(dgs-dxswitchbutton)
* Tab Panel (dgs-dxtabpanel + dgs-dxtab)
* Window (dgs-dxwindow)

Plugins:
* Blur Box (dgs-dxblurbox)
* Canvas (dgs-dxcanvas)
* Circle (dgs-dxcircle)
* Color Picker (dgs-dxcolorpicker + dgs-dxcomponentselector)
* Effect 3D (dgs-dxeffect3d)
* Mask (dgs-dxmask)
* Media Browser (dgs-dxmediabrowser)
* Nine Slice (dgs-dxnineslice)
* Object Preview Supports (dgs-dxobjectpreviewhandle)
* Paste Handler (dgs-dxpastehandler)
* QRCode (dgs-dxqrcode)
* Remote Image (dgs-dxremoteimage)
* Rounded Rectangle (dgs-dxroundrect)

'''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>

'''Want to talk to us?'''
*Join Discord Server: https://discord.gg/QEs8q6W

'''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, xLive
Special thanks to:
* Ahmed Ly
* ᴛᴇᴍᴏɪꜱ

='''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:Dgs]]
[[ZH-CN:Dgs]]
[[PL:Dgs]]

DgsAttachToGridList

2020-05-28T10:06:13Z

FlyingFork: Created page with "__NOTOC__ {{Client function}} This function allows you to attach a specific dgs element to a dgs gridlist. This will make something like dgsSetParent, but there will be n..."

__NOTOC__
{{Client function}}
This function allows you to attach a specific dgs element to a dgs gridlist. This will make something like [[dgsSetParent]], but there will be no "parent-child" relationship.

==Syntax==
<syntaxhighlight lang="lua">
bool dgsAttachToGridList( element dgsElement, element gridList, int rowIndex, int columnIndex, int/float offsetX, int/float offsetY, int/float offsetW, int/float offsetH [, bool relativePos = false, bool relativeSize = false ] )
</syntaxhighlight>

===Required Arguments===
*'''dgsElement:''' An element you want to get attached
*'''gridList:''' A dgs gridList you want to attach to
*'''rowIndex:''' An integer of the row index.
*'''columnIndex:''' End Column ID
*'''offsetX:''' A float of the 2D x position of the element on a player's screen. This is affected by the relative argument.
*'''offsetY:''' A float of the 2D x position of the element on a player's screen. This is affected by the relative argument.
*'''offsetW:''' A float of the width of the element. This is affected by the relative argument.
*'''offsetH:''' A float of the height of the window. This is affected by the relative argument.

===Optional Arguments===
*'''relativePos:''' This is whether sizes and positioning are relative. If this is true, then all x,y floats must be between 0 and 1, representing sizes/positions as a fraction of the screen size. If false, then the size and co-ordinates are based on client's resolution.
*'''relativeSize:''' This is whether sizes and positioning are relative. If this is true, then all width,height floats must be between 0 and 1, representing sizes/positions as a fraction of the screen size. If false, then the size and co-ordinates are based on client's resolution.

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

==Example==
This example attach label to window
<syntaxhighlight lang="lua">
DGS = exports.dgs

gridlist= DGS:dgsCreateGridList(50,50,100,100,false) -- create a gridlist
row = DGS:dgsGridListAddRow(gridlist) -- create a row for the gridlist
column = DGS:dgsGridListAddColumn(gridlist,"Title",1) -- create a column for the gridlist
label = DGS:dgsCreateLabel(0,200,100,100,"label", false) -- create a label
DGS:dgsAttachToGridList(label,gridlist,row,column,10,20,_,_,false) -- attach label to gridlist
</syntaxhighlight>

==See Also==
{{DGSFUNCTIONS}}

DgsMediaGetCurrentPosition

2020-05-28T09:42:40Z

FlyingFork:

__NOTOC__
{{Client function}}
This function gets the position of the loaded media.

==Syntax==
<syntaxhighlight lang="lua">
int dgsMediaGetCurrentPosition( element multiMediaBrowser )
</syntaxhighlight>

===Required Arguments===
*'''multiMediaBrowser :''' The multi media browser you want to operate.

===Returns===
Returns a float representing the ''current time'' in seconds of the media, or false if the position could not be retrieved.

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

addEventHandler("onDgsMediaLoaded", browser, function() -- on loaded
outputChatBox("Position: "..dgsMediaGetCurrentPosition(browser))
end)
</syntaxhighlight>

==See Also==
{{DGSFUNCTIONS}}

DgsMediaGetCurrentPosition

2020-05-28T09:41:12Z

FlyingFork: Created page with "__NOTOC__ {{Client function}} This function gets the position of the loaded media. ==Syntax== <syntaxhighlight lang="lua"> int dgsMediaGetCurrentPosition( element multiMedi..."

__NOTOC__
{{Client function}}
This function gets the position of the loaded media.

==Syntax==
<syntaxhighlight lang="lua">
int dgsMediaGetCurrentPosition( element multiMediaBrowser )
</syntaxhighlight>

===Required Arguments===
*'''multiMediaBrowser :''' The multi media browser you want to operate.

===Returns===
Returns a float representing the ''time'' in seconds of the media, or false if the position could not be retrieved.

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

addEventHandler("onDgsMediaLoaded", browser, function() -- on loaded
outputChatBox("Position: "..dgsMediaGetCurrentPosition(browser))
end)
</syntaxhighlight>

==See Also==
{{DGSFUNCTIONS}}

DgsGridListGetItemSelectable

2020-05-25T20:16:55Z

FlyingFork: Created page with "{{Client function}} __NOTOC__ This function gets whether the item is selectable. ==Syntax== <syntaxhighlight lang="lua"> bool dgsGridListGetItemSelectable( element gridlist,..."

{{Client function}}
__NOTOC__
This function gets whether the item is selectable.

==Syntax==
<syntaxhighlight lang="lua">
bool dgsGridListGetItemSelectable( element gridlist, int row, int column )
</syntaxhighlight>

===Required Arguments===
*'''gridlist:''' The dgs grid list you want to set.
*'''row:''' The row index of the grid list.
*'''column:''' The row index of the grid list.

===Returns===
Returns ''true'' if the item is selected, ''false'' otherwise

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

local playerList = DGS:dgsCreateGridList (346, 163, 433, 403, false ) --Create the grid list element
local column = DGS:dgsGridListAddColumn( playerList, "Player", 0.5 ) --Create a players column in the list
for id, player in ipairs(getElementsByType("player")) do
local row = DGS:dgsGridListAddRow ( playerList )
DGS:dgsGridListSetItemText ( playerList, row, column, getPlayerName ( player ) )
DGS:dgsGridListSetRowSelectable(playerList, row, false)
iprint(DGS:dgsGridListGetItemSelectable(playerList, row, column))
end
</syntaxhighlight>

==See Also==
{{DGSFUNCTIONS}}

DgsGridListSetItemSelectable

2020-05-25T20:15:48Z

FlyingFork: Created page with "{{Client function}} __NOTOC__ This function sets whether the item is selectable, which has a lower priority than dgsGridListSetRowSelectable. ==Syntax== <syntaxhighlight..."

{{Client function}}
__NOTOC__
This function sets whether the item is selectable, which has a lower priority than [[dgsGridListSetRowSelectable]].

==Syntax==
<syntaxhighlight lang="lua">
bool dgsGridListSetItemSelectable( element gridlist, int row, int column, boolean state )
</syntaxhighlight>

===Required Arguments===
*'''gridlist:''' The dgs grid list you want to set.
*'''row:''' The row index of the grid list.
*'''column:''' The column index of the grid list.
*'''state:''' Whether the row of grid list is selectable.

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

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

local playerList = DGS:dgsCreateGridList (346, 163, 433, 403, false ) --Create the grid list element
local column = DGS:dgsGridListAddColumn( playerList, "Player", 0.5 ) --Create a players column in the list
for id, player in ipairs(getElementsByType("player")) do
local row = DGS:dgsGridListAddRow ( playerList )
DGS:dgsGridListSetItemText ( playerList, row, column, getPlayerName ( player ) )
DGS:dgsGridListSetItemSelectable(playerList, row, column, false)
end
</syntaxhighlight>

==See Also==
{{DGSFUNCTIONS}}

DgsGridListGetItemHoverable

2020-05-25T20:14:20Z

FlyingFork: Created page with "{{Client function}} __NOTOC__ This function returns whether the item is hoverable. ==Syntax== <syntaxhighlight lang="lua"> string dgsGridListGetItemHoverable( element gridli..."

{{Client function}}
__NOTOC__
This function returns whether the item is hoverable.

==Syntax==
<syntaxhighlight lang="lua">
string dgsGridListGetItemHoverable( element gridlist, int row, int column )
</syntaxhighlight>

===Required Arguments===
*'''gridlist:''' The dgs grid list you want to get.
*'''row:''' The row index of the grid list.
*'''column:''' The column index of the grid list.

===Returns===
Returns true if the column is hoverable, ''false'' otherwise.

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

local playerList = DGS:dgsCreateGridList (346, 163, 433, 403, false ) --Create the grid list element
local column = DGS:dgsGridListAddColumn( playerList, "Player", 0.5 ) --Create a players column in the list
for id, player in ipairs(getElementsByType("player")) do
local row = DGS:dgsGridListAddRow ( playerList )
DGS:dgsGridListSetItemText ( playerList, row, column, getPlayerName ( player ) )
DGS:dgsGridListSetRowHoverable( playerList, row, false )
iprint(DGS:dgsGridListGetItemHoverable(playerList, row, column))
end
</syntaxhighlight>

==See Also==
{{DGSFUNCTIONS}}

DgsGridListSetItemHoverable

2020-05-25T20:10:50Z

FlyingFork: Created page with "{{Client function}} __NOTOC__ This function sets whether the item is hoverable, which has a lower priority than dgsGridListSetRowHoverable. ==Syntax== <syntaxhighlight l..."

{{Client function}}
__NOTOC__
This function sets whether the item is hoverable, which has a lower priority than [[dgsGridListSetRowHoverable]].

==Syntax==
<syntaxhighlight lang="lua">
string dgsGridListSetItemHoverable( element gridlist, int row, int column, boolean state )
</syntaxhighlight>

===Required Arguments===
*'''gridlist:''' The dgs grid list you want to set.
*'''row:''' The row index of the grid list.
*'''column:''' The column index of the grid list.
*'''state:''' A bool indicates whether the row of grid list is hoverable or not.

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

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

local playerList = DGS:dgsCreateGridList (346, 163, 433, 403, false ) --Create the grid list element
local column = DGS:dgsGridListAddColumn( playerList, "Player", 0.5 ) --Create a players column in the list
for id, player in ipairs(getElementsByType("player")) do
local row = DGS:dgsGridListAddRow ( playerList )
DGS:dgsGridListSetItemText ( playerList, row, column, getPlayerName ( player ) )
DGS:dgsGridListSetItemHoverable( playerList, row, column, false)
end
</syntaxhighlight>

==See Also==
{{DGSFUNCTIONS}}