GuiGetSize: 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 gets the size of a GUI element
This fake function is for use with blah & blah and does blahblahblabhalbhl


==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">
guiGetSize ( element guielement )
float, float guiGetSize ( element theElement )
</syntaxhighlight>  
</syntaxhighlight>  


===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 GUI element to get size of
*'''argumentName:''' description
 
<!-- Only include this section below if there are optional arguments -->
===Optional Arguments===
{{OptionalArg}}
*'''argumentName2:''' description
*'''argumentName3:''' description


===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 the GUI element size if the function has been successfull, ''false'' otherwise.
*Returns ''true'' if blah, ''false'' otherwise.
*x
*y


==Example==  
==Example==  
<!-- Explain what the example is in a single sentance -->
This example creates a random sized gui window and outputs it's size to chatbox...
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 test ()
blabhalbalhb --abababa
        --Create the window
--This line does this...
        local window = guiCreateWindow ( 0, 0, randInt ( 0, 100 ) / 100, randInt ( 0, 100 ) / 100, "test", true )
mooo
        local x, y = guiGetSize ( window )
        outputChatBox ( "Window size: "..x.." "..y )
end
</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 -->
{{FunctionArea_functions}}
{{FunctionArea_functions}}
[[Category:Need_Syntax]]  -- leave this until syntax is available. Cannot document the function or event without syntax.
[[Category:Need_Syntax]]  -- leave this until syntax is available. Cannot document the function or event without syntax.
[[Category:Incomplete]] -- leave this unless you complete the function

Revision as of 18:27, 9 August 2007

This function gets the size of a GUI element

Syntax

float, float guiGetSize ( element theElement )

Required Arguments

  • theElement: The GUI element to get size of

Returns

Returns the GUI element size if the function has been successfull, false otherwise.

Example

This example creates a random sized gui window and outputs it's size to chatbox... 

function test ()
        --Create the window
        local window = guiCreateWindow ( 0, 0, randInt ( 0, 100 ) / 100, randInt ( 0, 100 ) / 100, "test", true )
        local x, y = guiGetSize ( window )
        outputChatBox ( "Window size: "..x.." "..y )
end

See Also

Template:FunctionArea functions -- leave this until syntax is available. Cannot document the function or event without syntax.

Retrieved from "https://wiki.multitheftauto.com/wiki/GuiGetSize?oldid=10005"