GuiWindowSetMovable: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
No edit summary
 
No edit summary
Line 1: Line 1:
__NOTOC__  
__NOTOC__  
<!-- Describe in plain english what this function does. Don't go into details, just give an overview -->
This function allows you to specify whether or not a user can move a GUI window.
This function allows you to specify whether or not a user can move a GUI window.


==Syntax==  
==Syntax==  
<!-- NOTE: don't use 'special' names for variable names, e.g. you shouldn't be writing things like 'player player, vehicle vehicle', instead write something like 'player thePlayer, vehicle vehicleToGetInto'. This is less confusing and prevents the syntax highlighting being odd -->
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
bool guiWindowSetMovable ( element theElement, bool status )
bool guiWindowSetMovable ( element theElement, bool status )
Line 10: Line 8:


===Required Arguments===  
===Required Arguments===  
<!-- List each argument one per line. This should be the argument's name as in the argument list above, NOT the argument's data type -->
*'''theElement:''' The window to be changed.
*'''theElement:''' The window to be changed.
*'''status:''' A boolean value indicating whether the window is movable or not.
*'''status:''' A boolean value indicating whether the window is movable or not.


===Returns===
===Returns===
<!-- Make this descriptive. Explain what cases will return false. If you're unsure, add a tag to it so we can check -->
Returns ''true'' if the function is successful, ''false'' otherwise.
Returns ''true'' if the function is successful, ''false'' otherwise.


==Example==  
==Example==  
<!-- Explain what the example is in a single sentance -->
This example creates a gui window and sets it to be not movable
This example does...
<!-- Add the code below, an emphasis should be on making it clear, not optimized. You could provide two versions if you wish, one clear and well commented, the other optimized -->
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
--This line does...
function initialize ()
blabhalbalhb --abababa
--Create a gui window
--This line does this...
local window = guiCreateWindow ( 0.50, 0.50, 0.25, 0.25, "Test", true )
mooo
--set it to be not movable
guiWindowSetMovable ( window, false )
--Show cursor to check if our changes work fine
showCursor ( true )
end
addEventHandler ( "onClientResourceStart", getRootElement(), initialize )
</syntaxhighlight>
</syntaxhighlight>


==See Also==
==See Also==
<!-- Change FunctionArea to the area that this function is in on the main function list page, e.g. Server, Player, Vehicle etc -->
{{GUI_functions}}
{{GUI_functions}}
[[Category:Incomplete]]

Revision as of 17:48, 7 August 2007

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

Syntax

bool guiWindowSetMovable ( 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 gui window and sets it to be not movable 

function initialize ()
	--Create a gui window
	local window = guiCreateWindow ( 0.50, 0.50, 0.25, 0.25, "Test", true )
	--set it to be not movable
	guiWindowSetMovable ( window, false )
	--Show cursor to check if our changes work fine
	showCursor ( true )
end
addEventHandler ( "onClientResourceStart", getRootElement(), initialize )

See Also

General functions

Browsers

Buttons

Checkboxes

Comboboxes

Edit Boxes

Gridlists

Memos

Progressbars

Radio Buttons

Scrollbars

Scrollpanes

Static Images

Tab Panels

Tabs

Text Labels

Windows

Retrieved from "https://wiki.multitheftauto.com/wiki/GuiWindowSetMovable?oldid=9961"