GuiGetSize: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
(Fixed syntax)
Line 5: Line 5:
==Syntax==  
==Syntax==  
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
float, float guiGetSize ( element theElement )
float, float guiGetSize ( element theElement, bool relative )
</syntaxhighlight>  
</syntaxhighlight>  


===Required Arguments===  
===Required Arguments===  
*'''theElement:''' The GUI element to get size of
*'''theElement:''' The GUI element to get size of.
*'''relative:''' A boolean representing whether the size should be relative to the element's parent width, or an absolute size in pixels.


===Returns===
===Returns===
Returns the GUI element size if the function has been successful, ''false'' otherwise.
Returns the GUI element size ''x'' and ''y'' if the function has been successful, ''false'' otherwise.


==Example==  
==Example==  
Line 25: Line 26:
==See Also==
==See Also==
{{GUI functions}}
{{GUI functions}}
[[Category:Need_Syntax]] -- leave this until syntax is available. Cannot document the function or event without syntax.
[[Category:Need_Syntax]]

Revision as of 01:36, 4 November 2007

This function gets the size of a GUI element.

Syntax

float, float guiGetSize ( element theElement, bool relative )

Required Arguments

  • theElement: The GUI element to get size of.
  • relative: A boolean representing whether the size should be relative to the element's parent width, or an absolute size in pixels.

Returns

Returns the GUI element size x and y if the function has been successful, false otherwise.

Example

This example creates a random sized gui window and outputs its size to the chatbox.

local window = guiCreateWindow ( 0, 0, (math.random ( 0, 100 ) / 100), (math.random ( 0, 100 ) / 100), "test", true ) 
-- Create the window
local x, y = guiGetSize ( window ) -- Get the gui window size
outputChatBox ( "Window size: " .. x .. " " .. y ) --output the gui window size

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