GuiWindowSetCloseButtonEnabled: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
No edit summary
(Removing all content from page)
 
Line 1: Line 1:
__NOTOC__
{{Needs Checking|This function has been disabled in the code.}}
<!-- Describe in plain english what this function does. Don't go into details, just give an overview -->
This function enables or disables the close button from the title bar of a GUI window.


==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">
bool guiWindowSetCloseButtonEnabled ( [[element]] theElement, [[bool]] status )
</syntaxhighlight>
===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.
*'''status:''' A boolean value indicating whether the close button is to be enabled or disabled.
===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.
==Example==
<!-- Explain what the example is in a single sentance -->
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">
--This line does...
blabhalbalhb --abababa
--This line does this...
mooo
</syntaxhighlight>
==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}}
[[Category:Incomplete]]

Latest revision as of 19:48, 23 June 2009