DgsWindowSetMovable: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
mNo edit summary
No edit summary
Line 1: Line 1:
{{Client function}}
{{Client function}}
__NOTOC__
__NOTOC__
This function allows you to close a DGS window.
This function allows you to specify whether or not a user can move a DGS window.


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


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


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


==Example==  
==Example==  
This example closes a previously created DGS window.
This example creates a DGS window and sets it to be not movable
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
DGS = exports.dgs --shorten the export function prefix
DGS = exports.dgs
 
function initialize ()
-- Create a DGS window.
-- Create a DGS window
window = DGS:dgsDxCreateWindow ( 0.50, 0.50, 0.25, 0.25, "Test", true )
local window = DGS:dgsDxCreateWindow ( 0.50, 0.50, 0.25, 0.25, "Test", true )
 
-- set it to be not movable
function closeDgsGUI ()
DGS:dgsDxWindowSetMovable ( window, false )
-- Close the DGS window.
-- Show cursor to check if our changes work fine
local close = DGS:dgsDxGUICloseWindow(window)
showCursor ( true )
 
-- 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
end
addCommandHandler("close", closeDgsGUI)
addEventHandler ( "onClientResourceStart", resourceRoot, initialize )
</syntaxhighlight>
</syntaxhighlight>


==See Also==
==See Also==
{{DGSFUNCTIONS}}
{{DGSFUNCTIONS}}

Revision as of 13:04, 28 June 2017

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

Syntax

bool dgsDxWindowSetMovable ( element theElement, bool status )

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 

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 )

See Also

Custom Cursor Functions

Multi Language Supports

Animation

3D Element

3D Interface

3D Line

3D Image

3D Text

Browser

Button

Check Box

Combo Box

Custom Renderer

Edit

Detect Area

Drag'N Drop

Grid List

Image

Memo

Menu

Label

Layout

Line

Progress Bar

Radio Button

Scale Pane

Scroll Bar

Scroll Pane

Selector

Style

Switch Button

Tab Panel

Window

Basic Shape Plugins

Circle

Quadrilateral

Rounded Rectangle

Other Plugins

Blur Box

Canvas

Chart

Color Picker

Effect 3D

Gradient

Mask

Media Browser

Nine Slice

Object Preview Supports

Paste Handler

QRCode

Remote Image

Screen Source

SVG

Tooltips

Retrieved from "https://wiki.multitheftauto.com/wiki/DgsWindowSetMovable?oldid=51401"