Multi Theft Auto: Wiki - User contributions [en]

DgsWindowSetMovable

2017-06-28T13:04:07Z

ZoNe:

{{Client function}}
__NOTOC__
This function allows you to specify whether or not a user can move a DGS window.

==Syntax==
<syntaxhighlight lang="lua">
bool dgsDxWindowSetMovable ( element theElement, bool status )
</syntaxhighlight>

===Required Arguments===
*'''theElement:''' The window to be changed.
*'''status:''' A boolean value indicating whether the window is movable or not.

===Returns===
Returns ''true'' if the function is successful, ''false'' otherwise.

==Example==
This example creates a DGS window and sets it to be not movable
<syntaxhighlight lang="lua">
DGS = exports.dgs
function initialize ()
-- Create a DGS window
local window = DGS:dgsDxCreateWindow ( 0.50, 0.50, 0.25, 0.25, "Test", true )
-- set it to be not movable
DGS:dgsDxWindowSetMovable ( window, false )
-- Show cursor to check if our changes work fine
showCursor ( true )
end
addEventHandler ( "onClientResourceStart", resourceRoot, initialize )
</syntaxhighlight>

==See Also==
{{DGSFUNCTIONS}}

DgsCloseWindow

2017-06-28T13:01:04Z

ZoNe:

{{Client function}}
__NOTOC__
This function allows you to close a DGS window.

==Syntax==
<syntaxhighlight lang="lua">
bool dgsDxGUICloseWindow ( element theElement )
</syntaxhighlight>

===Required Arguments===
*'''theElement:''' The window to be closed.

===Returns===
Returns ''true'' if the window was closed, ''false'' otherwise.

==Example==
This example closes a previously created DGS window.
<syntaxhighlight lang="lua">
DGS = exports.dgs

-- Create a DGS window.
window = DGS:dgsDxCreateWindow ( 0.50, 0.50, 0.25, 0.25, "Test", true )

function closeDgsGUI ()
-- Close the DGS window.
local close = DGS:dgsDxGUICloseWindow(window)

-- if the DGS window was closed output a message and hide the player's cursor.
if close then
-- Output a message saying that the DGS window was closed.
outputChatBox("DGS window closed!")
-- Hide cursor
showCursor(false)
end
end
addCommandHandler("close", closeDgsGUI)
</syntaxhighlight>

==See Also==
{{DGSFUNCTIONS}}

DgsWindowSetMovable

2017-06-28T12:21:18Z

ZoNe:

{{Client function}}
__NOTOC__
This function allows you to close a DGS window.

==Syntax==
<syntaxhighlight lang="lua">
bool dgsDxGUICloseWindow ( element theElement )
</syntaxhighlight>

===Required Arguments===
*'''theElement:''' The window to be closed.

===Returns===
Returns ''true'' if the window was closed, ''false'' otherwise.

==Example==
This example closes a previously created DGS window.
<syntaxhighlight lang="lua">
DGS = exports.dgs --shorten the export function prefix

-- Create a DGS window.
window = DGS:dgsDxCreateWindow ( 0.50, 0.50, 0.25, 0.25, "Test", true )

function closeDgsGUI ()
-- Close the DGS window.
local close = DGS:dgsDxGUICloseWindow(window)

-- if the DGS window was closed output a message and hide the player's cursor.
if close then
-- Output a message saying that the window was closed.
outputChatBox("DGS window closed!")
-- Hide cursor
showCursor(false)
end
end
addCommandHandler("close", closeDgsGUI)
</syntaxhighlight>

==See Also==
{{DGSFUNCTIONS}}

DgsWindowSetMovable

2017-06-28T12:20:48Z

ZoNe:

{{Client function}}
__NOTOC__
This function allows you to close a DGS window.

==Syntax==
<syntaxhighlight lang="lua">
bool dgsDxGUICloseWindow ( element theElement )
</syntaxhighlight>

===Required Arguments===
*'''theElement:''' The window to be closed.

===Returns===
Returns ''true'' if the window was closed, ''false'' otherwise.

==Example==
This example closes a previously created DGS window.
<syntaxhighlight lang="lua">
DGS = exports.dgs --shorten the export function prefix

-- Create a DGS window.
window = DGS:dgsDxCreateWindow ( 0.50, 0.50, 0.25, 0.25, "Test", true )

function closeDgsGUI ()
-- Close the DGS window.
local close = DGS:dgsDxGUICloseWindow(window)

-- if the DGS window was closed output a message and hide the player's cursor.
if close then
-- Output a message saying that he window was closed.
outputChatBox("DGS window closed!")
-- Hide cursor
showCursor(false)
end
end
addCommandHandler("close", closeDgsGUI)
</syntaxhighlight>

==See Also==
{{DGSFUNCTIONS}}

DgsWindowSetMovable

2017-06-28T12:18:58Z

ZoNe:

{{Client function}}
__NOTOC__
This function allows you to close a DGS window.

==Syntax==
<syntaxhighlight lang="lua">
bool dgsDxGUICloseWindow ( element theElement )
</syntaxhighlight>

===Required Arguments===
*'''theElement:''' The window to be closed.

===Returns===
Returns ''true'' if the window was closed, ''false'' otherwise.

==Example==
This example closes a previously created DGS window.
<syntaxhighlight lang="lua">
DGS = exports.dgs --shorten the export function prefix

-- Create a DGS window.
window = DGS:dgsDxCreateWindow ( 0.50, 0.50, 0.25, 0.25, "Test", true )

function closeDgsGUI ()
-- Close the DGS window.
local close = DGS:dgsDxGUICloseWindow(window)

-- if the DGS window was closed output a message and hide the player's cursor.
if close then
outputChatBox("DGS window closed!")
-- Hide cursor
showCursor(false)
end
end
addCommandHandler("close", closeDgsGUI)
</syntaxhighlight>

==See Also==
{{DGSFUNCTIONS}}

DgsCloseWindow

2017-06-28T12:18:19Z

ZoNe: Created page with "{{Client function}} __NOTOC__ This function allows you to close a DGS window. ==Syntax== <syntaxhighlight lang="lua"> bool dgsDxGUICloseWindow ( element theElement ) </synta..."

{{Client function}}
__NOTOC__
This function allows you to close a DGS window.

==Syntax==
<syntaxhighlight lang="lua">
bool dgsDxGUICloseWindow ( element theElement )
</syntaxhighlight>

===Required Arguments===
*'''theElement:''' The window to be closed.

===Returns===
Returns ''true'' if the window was closed, ''false'' otherwise.

==Example==
This example closes a previously created DGS window.
<syntaxhighlight lang="lua">
DGS = exports.dgs

-- Create a DGS window.
window = DGS:dgsDxCreateWindow ( 0.50, 0.50, 0.25, 0.25, "Test", true )

function closeDgsGUI ()
-- Close the DGS window.
local close = DGS:dgsDxGUICloseWindow(window)

-- if the DGS window was closed output a message and hide the player's cursor.
if close then
outputChatBox("DGS window closed!")
-- Hide cursor
showCursor(false)
end
end
addCommandHandler("close", closeDgsGUI)
</syntaxhighlight>

==See Also==
{{DGSFUNCTIONS}}

DgsWindowSetMovable

2017-06-27T22:59:31Z

ZoNe: Created page with "{{Client function}} __NOTOC__ This function allows you to specify whether or not a user can move a DGS window. ==Syntax== <syntaxhighlight lang="lua"> bool dgsDxWindowSetMov..."

OnDgsMouseClick

2017-06-27T22:43:47Z

ZoNe: /* Example */

{{Client event}}
__NOTOC__
This event happens when any dgs-element clicked
{{Note|The '''player''' who clicked the dgs-element is always the [[localPlayer]].}}

==Parameters==
<syntaxhighlight lang="lua">
string button, string state, int absoluteX, int absoluteY
</syntaxhighlight>
*'''button:''' the name of the button which will be clicked , it can be ''left'', ''right'', ''middle''
*'''state:''' the state of the mouse button, will be ''down'' if the mouse button was pushed, or ''up'' if it was released. '''Please note currently both ''up'' and ''down'' state are supported that is different from ''onClientGUIClick''.'''
*'''absoluteX:''' the X position of the mouse cursor, in pixels, measured from the left side of the screen.
*'''absoluteY:''' the Y position of the mouse cursor, in pixels, measured from the top of the screen.

==Source==
The [[event system#Event source|source]] of this event is the DGS element that was clicked.

==Example==
This example creates an edit box alongside an "Output!" button. When the button is clicked with the left mouse button, it will output the message in the edit box into the chat box.
<syntaxhighlight lang="lua">
DGS = exports.dgs
-- When client's resource starts, create the GUI
function initGUI( )
-- Create our button
btnOutput = DGS:dgsDxCreateButton( 0.7, 0.1, 0.2, 0.1, "Output!", true )

-- And attach our button to the outputEditBox function
addEventHandler ( "onClientDgsDxMouseClick", btnOutput, outputEditBox )

-- Create an edit box and define it as "editBox".
editBox = DGS:dgsDxCreateEdit( 0.3, 0.1, 0.4, 0.1, "Type your message here!", true )
end
addEventHandler( "onClientResourceStart", getResourceRootElement( getThisResource( ) ), initGUI )

-- Setup our function to output the message to the chatbox
function outputEditBox ( button )
if button == "left" then
local text = DGS:dgsDxGUIGetText( editBox )-- Get the text from the edit box
outputChatBox ( text ) -- Output that text
end
end
</syntaxhighlight>

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