Multi Theft Auto: Wiki - User contributions [en]

DgsGetSide

2020-10-23T09:41:53Z

Ihnify: /* Example */

{{Client function}}

This function returns the position of the DGS element side.

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

===Required Arguments===
*'''theElement:''' The DGS element to be checked.
*'''topleft:''' The position of the DGS element in the window.

===Returns===
Returns ''false'' if the element passed is invalid or a string containing one of the following:

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

local window = DGS:dgsCreateWindow(0.40, 0.33, 0.20, 0.21, "DGS Window", true)
local button = DGS:dgsCreateButton(0.0, 0.0, 0.2, 0.1, "OK", true, window)

DGS:dgsSetSide(button, "right", true)

local buttonSide = DGS:dgsGetSide(button)

outputChatBox("dgsSide " .. buttonSide)
</syntaxhighlight>

==See Also==
{{DGSFUNCTIONS}}

DgsGetSide

2019-05-21T10:30:08Z

Ihnify: /* Example */

{{Client function}}

This function returns the position of the DGS element side.

==Syntax==
<syntaxhighlight lang="lua">
int dgsGetSide( element theElement, bool topleft )
</syntaxhighlight>

===Required Arguments===
*'''theElement:''' The DGS element to be checked.
*'''topleft:''' The position of the DGS element in the window.

===Returns===
Returns ''false'' if the element passed is invalid or a string containing one of the following:

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

local window = DGS:dgsCreateWindow(0.40, 0.33, 0.20, 0.21, "DGS Window", true)
local button = DGS:dgsCreateButton(0.0, 0.0, 0.2, 0.1, "OK", true, window)

DGS:dgsSetSide(button, "right", true)

local buttonSide = dgs:dgsGetSide(button)

outputChatBox("dgsSide " .. buttonSide)
</syntaxhighlight>

==See Also==
{{DGSFUNCTIONS}}

DgsGetSide

2019-05-18T15:40:59Z

Ihnify: /* Returns */

{{Client function}}

This function returns the position of the DGS element side.

==Syntax==
<syntaxhighlight lang="lua">
int dgsGetSide( element theElement, bool topleft )
</syntaxhighlight>

===Required Arguments===
*'''theElement:''' The DGS element to be checked.
*'''topleft:''' The position of the DGS element in the window.

===Returns===
Returns ''false'' if the element passed is invalid or a string containing one of the following:

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

local window = DGS:dgsCreateWindow(0.40, 0.33, 0.20, 0.21, "DGS Window", true)
local button = DGS:dgsCreateButton(0.0, 0.0, 0.2, 0.1, "OK", true, window)

dgs:dgsSetSide(button, "right", true)

local buttonSide = dgs:dgsGetSide(button)

outputChatBox("dgsSide " .. buttonSide)
</syntaxhighlight>

==See Also==
{{DGSFUNCTIONS}}

DgsGetSide

2019-05-18T15:40:47Z

Ihnify: /* Returns */

{{Client function}}

This function returns the position of the DGS element side.

==Syntax==
<syntaxhighlight lang="lua">
int dgsGetSide( element theElement, bool topleft )
</syntaxhighlight>

===Required Arguments===
*'''theElement:''' The DGS element to be checked.
*'''topleft:''' The position of the DGS element in the window.

===Returns===
Returns false if the element passed is invalid or a string containing one of the following:

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

local window = DGS:dgsCreateWindow(0.40, 0.33, 0.20, 0.21, "DGS Window", true)
local button = DGS:dgsCreateButton(0.0, 0.0, 0.2, 0.1, "OK", true, window)

dgs:dgsSetSide(button, "right", true)

local buttonSide = dgs:dgsGetSide(button)

outputChatBox("dgsSide " .. buttonSide)
</syntaxhighlight>

==See Also==
{{DGSFUNCTIONS}}

DgsGetSide

2019-05-18T13:01:37Z

Ihnify:

{{Client function}}

This function returns the position of the DGS element side.

==Syntax==
<syntaxhighlight lang="lua">
int dgsGetSide( element theElement, bool topleft )
</syntaxhighlight>

===Required Arguments===
*'''theElement:''' The DGS element to be checked.
*'''topleft:''' The position of the DGS element in the window.

===Returns===
Returns the position of DGS element

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

local window = DGS:dgsCreateWindow(0.40, 0.33, 0.20, 0.21, "DGS Window", true)
local button = DGS:dgsCreateButton(0.0, 0.0, 0.2, 0.1, "OK", true, window)

dgs:dgsSetSide(button, "right", true)

local buttonSide = dgs:dgsGetSide(button)

outputChatBox("dgsSide " .. buttonSide)
</syntaxhighlight>

==See Also==
{{DGSFUNCTIONS}}

DgsGetSide

2019-05-18T13:01:01Z

Ihnify: Created page with "{{Client function}} This function returns the position of the DOGS element side. ==Syntax== <syntaxhighlight lang="lua"> int dgsGetSide( element theElement, bool topleft ) <..."

{{Client function}}

This function returns the position of the DOGS element side.

==Syntax==
<syntaxhighlight lang="lua">
int dgsGetSide( element theElement, bool topleft )
</syntaxhighlight>

===Required Arguments===
*'''theElement:''' The DGS element to be checked.
*'''topleft:''' The position of the DGS element in the window.

===Returns===
Returns the position of DGS element

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

local window = DGS:dgsCreateWindow(0.40, 0.33, 0.20, 0.21, "DGS Window", true)
local button = DGS:dgsCreateButton(0.0, 0.0, 0.2, 0.1, "OK", true, window)

dgs:dgsSetSide(button, "right", true)

local buttonSide = dgs:dgsGetSide(button)

outputChatBox("dgsSide " .. buttonSide)
</syntaxhighlight>

==See Also==
{{DGSFUNCTIONS}}

DgsSetSide

2019-05-18T12:54:54Z

Ihnify: Created page with "{{Client function}} This function to set the position of the DGS element. ==Syntax== <syntaxhighlight lang="lua"> int dgsSetSide( element theElement, string display, bool to..."

{{Client function}}

This function to set the position of the DGS element.

==Syntax==
<syntaxhighlight lang="lua">
int dgsSetSide( element theElement, string display, bool topleft )
</syntaxhighlight>

===Required Arguments===
*'''theElement:''' The DGS element to change position for.
*'''display:''' A position string, "right" or "bottom".
*'''topleft:''' The position of the DGS element in the window.

===Returns===
If the function succeeds it returns ''true'', if it fails it returns ''false''.

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

local window = DGS:dgsCreateWindow(0.40, 0.33, 0.20, 0.21, "DGS Window", true)
local button = DGS:dgsCreateButton(0.0, 0.0, 0.2, 0.1, "Ok", true, window)

dgs:dgsSetSide(button, "right", true) -- in right top left of the window
</syntaxhighlight>

==See Also==
{{DGSFUNCTIONS}}

DgsGridListGetSelectedItem

2019-05-18T11:05:51Z

Ihnify: /* Example */

{{Client function}}

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

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

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

===Returns===
Returns the row of the selected item if the specified grid list is valid and has a selected item, (-1) if no item 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 Selected = DGS:dgsGridListGetSelectedItem(GridList)
if Selected ~= -1 then
local output= DGS:dgsGridListGetItemText(GridList,Selected,column)
outputChatBox(""..output.."",255,0,0)
end
end
end )
</syntaxhighlight>

==See Also==
{{DGSFUNCTIONS}}

DgsGridListGetSelectedItem

2019-05-17T17:03:37Z

Ihnify: /* Example */

{{Client function}}

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

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

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

===Returns===
Returns the row of the selected item if the specified grid list is valid and has a selected item, (-1) if no item is selected, ''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 )
local row = DGS:dgsGridListAddRow ( GridList )
DGS:dgsGridListSetItemText (GridList, row, column, "1" )

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

==See Also==
{{DGSFUNCTIONS}}

DgsCreateEdit

2019-05-17T17:02:47Z

Ihnify:

__NOTOC__
{{Client function}}
[[Image:Dx_5.PNG|frame|Example Dx edit field.]]
<table><tr><td valign=top height=80>

This function is for creating a new DGS edit box. This is a text box in which the user can input text. Edit boxes only allow a single line of text. If you want to allow multiple lines of text create a memo box using [[guiCreateMemo]].

</td></tr></table>

==Syntax==
<syntaxhighlight lang="lua">
element dgsCreateEdit ( float x, float y, float width, float height, string text, bool relative, [element parent = nil, int textcolor = FF000000, float scalex = 1, float scaley = 1,element imagebg = nil, element colorbg = FFC8C8C8, bool selectmode = false] )
</syntaxhighlight>

===Required Arguments===
*'''x:''' A float of the 2D x position of the DGS edit box on a player's screen. This is affected by the ''relative'' argument.
*'''y:''' A float of the 2D y position of the DGS edit box on a player's screen. This is affected by the ''relative'' argument.
*'''width:''' A float of the width of the DGS edit box. This is affected by the ''relative'' argument.
*'''height:''' A float of the height of the DGS edit box. This is affected by the ''relative'' argument.
*'''text:''' A string of the text that will be displayed by default in the edit box.
*'''relative:''' This is whether sizes and positioning are relative. If this is ''true'', then all x,y,width,height floats must be between 0 and 1, representing measures relative to the parent.
===Optional Arguments===
{{OptionalArg}}
*'''parent:''' This is the parent that the DGS edit box is attached to. If the ''relative'' argument is true, sizes and positioning will be made relative to this parent. If the ''relative'' argument is false, positioning will be the number of offset pixels from the parent's origin. If no parent is passed, the parent will become the screen - causing positioning and sizing according to screen positioning.
*'''textcolor:''' An int of the color of the text.
*'''scalex:''' A float of the multiplier of the width of the text.
*'''scaley:''' A float of the multiplier of the height of the text.
*'''imagebg:''' A texture element of the background of the DGS edit box.
*'''colorbg:''' An int of the color of the background of the DGS edit box.
*'''selectmode :''' A bool of whether the select background color is above the text or under the text.

===Returns===
Returns a dgs-dxedit element of the created edit box if it was successfully created, false otherwise.

==Example==
This example creates an edit box alongside an "Output!" button. When the button is clicked, it will output the message in the edit box into the Chat Box.
<syntaxhighlight lang="lua">
DGS = exports.dgs
--create our button
button = DGS:dgsCreateButton( 0.7, 0.1, 0.2, 0.1, "OK", true )
--Create an edit box and define it as "editBox".
editBox = DGS:dgsCreateEdit( 0.3, 0.1, 0.4, 0.1, "", true )

--setup our function to output the message to the chatbox
function outputEditBox ( button, state )
local text = DGS:dgsGetText ( editBox )--get the text from the edit box
outputChatBox ( text ) --output that text
end
addEventHandler ( "onDgsMouseClick", button, outputEditBox )

</syntaxhighlight>

This example creates an edit box and sets the input focus so the player does not have to click before typing:
<syntaxhighlight lang="lua">
DGS = exports.dgs
local editBox = DGS:dgsCreateEdit( 0.3, 0.1, 0.4, 0.1, "", true )
DGS:dgsBringToFront( editBox )
DGS:dgsEditSetCaretPosition( editBox, 1 )
</syntaxhighlight>

Edit by: Senpai
This example masks the password:
<syntaxhighlight lang="lua">
DGS = exports.dgs
local editBox = DGS:dgsCreateEdit( 0.3, 0.1, 0.4, 0.1, "", true )
DGS:dgsSetProperty(editBox,"masked",true) --if its true then it will be masked
</syntaxhighlight>

==See Also==
{{DGSFUNCTIONS}}

DgsCreateEdit

2019-05-17T16:59:39Z

Ihnify:

__NOTOC__
{{Client function}}
[[Image:Dx_5.PNG|frame|Example Dx edit field.]]
<table><tr><td valign=top height=80>

This function is for creating a new DGS edit box. This is a text box in which the user can input text. Edit boxes only allow a single line of text. If you want to allow multiple lines of text create a memo box using [[guiCreateMemo]].

</td></tr></table>

==Syntax==
<syntaxhighlight lang="lua">
element dgsCreateEdit ( float x, float y, float width, float height, string text, bool relative, [element parent = nil, int textcolor = FF000000, float scalex = 1, float scaley = 1,element imagebg = nil, element colorbg = FFC8C8C8, bool selectmode = false] )
</syntaxhighlight>

===Required Arguments===
*'''x:''' A float of the 2D x position of the DGS edit box on a player's screen. This is affected by the ''relative'' argument.
*'''y:''' A float of the 2D y position of the DGS edit box on a player's screen. This is affected by the ''relative'' argument.
*'''width:''' A float of the width of the DGS edit box. This is affected by the ''relative'' argument.
*'''height:''' A float of the height of the DGS edit box. This is affected by the ''relative'' argument.
*'''text:''' A string of the text that will be displayed by default in the edit box.
*'''relative:''' This is whether sizes and positioning are relative. If this is ''true'', then all x,y,width,height floats must be between 0 and 1, representing measures relative to the parent.
===Optional Arguments===
{{OptionalArg}}
*'''parent:''' This is the parent that the DGS edit box is attached to. If the ''relative'' argument is true, sizes and positioning will be made relative to this parent. If the ''relative'' argument is false, positioning will be the number of offset pixels from the parent's origin. If no parent is passed, the parent will become the screen - causing positioning and sizing according to screen positioning.
*'''textcolor:''' An int of the color of the text.
*'''scalex:''' A float of the multiplier of the width of the text.
*'''scaley:''' A float of the multiplier of the height of the text.
*'''imagebg:''' A texture element of the background of the DGS edit box.
*'''colorbg:''' An int of the color of the background of the DGS edit box.
*'''selectmode :''' A bool of whether the select background color is above the text or under the text.

===Returns===
Returns a dgs-dxedit element of the created edit box if it was successfully created, false otherwise.

==Example==
This example creates an edit box alongside an "Output!" button. When the button is clicked, it will output the message in the edit box into the Chat Box.
<syntaxhighlight lang="lua">
DGS = exports.dgs
--create our button
button = DGS:dgsCreateButton( 0.7, 0.1, 0.2, 0.1, "OK", true )
--Create an edit box and define it as "editBox".
editBox = DGS:dgsCreateEdit( 0.3, 0.1, 0.4, 0.1, "", true )

--setup our function to output the message to the chatbox
function outputEditBox ()
local text = DGS:dgsGetText ( editBox )--get the text from the edit box
outputChatBox ( text ) --output that text
end
addEventHandler ( "onDgsMouseClick", button, outputEditBox )

</syntaxhighlight>

This example creates an edit box and sets the input focus so the player does not have to click before typing:
<syntaxhighlight lang="lua">
DGS = exports.dgs
local editBox = DGS:dgsCreateEdit( 0.3, 0.1, 0.4, 0.1, "", true )
DGS:dgsBringToFront( editBox )
DGS:dgsEditSetCaretPosition( editBox, 1 )
</syntaxhighlight>

Edit by: Senpai
This example masks the password:
<syntaxhighlight lang="lua">
DGS = exports.dgs
local editBox = DGS:dgsCreateEdit( 0.3, 0.1, 0.4, 0.1, "", true )
DGS:dgsSetProperty(editBox,"masked",true) --if its true then it will be masked
</syntaxhighlight>

==See Also==
{{DGSFUNCTIONS}}

DgsGridListGetSelectedItem

2019-05-17T16:59:14Z

Ihnify:

{{Client function}}

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

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

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

===Returns===
Returns the row of the selected item if the specified grid list is valid and has a selected item, (-1) if no item is selected, ''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 )
local row = DGS:dgsGridListAddRow ( GridList )
DGS:dgsGridListSetItemText (GridList, row, column, "1" )

addEventHandler ( "onDgsMouseClick", root, function ( )
if source == GridList then
local Selected = DGS:dgsGridListGetSelectedItem(GridList)
if Selected ~= -1 then
local output= DGS:dgsGridListGetItemText(GridList,Selected,column)
outputChatBox(""..output.."",255,0,0)
end
end
end )
</syntaxhighlight>

==See Also==
{{DGSFUNCTIONS}}