GuiGetSize: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
No edit summary |
||
| Line 1: | Line 1: | ||
__NOTOC__ | {{Client function}} | ||
This function gets the size of a GUI element | __NOTOC__ | ||
This function gets the size of a GUI element. | |||
==Syntax== | ==Syntax== | ||
| Line 11: | Line 12: | ||
===Returns=== | ===Returns=== | ||
Returns the GUI element size if the function has been | Returns the GUI element size if the function has been successful, ''false'' otherwise. | ||
==Example== | ==Example== | ||
This example creates a random sized gui window and outputs | This example creates a random sized gui window and outputs its size to the chatbox. | ||
<syntaxhighlight lang="lua"> | <syntaxhighlight lang="lua"> | ||
-- Create the window | |||
local window = guiCreateWindow ( 0, 0, randInt ( 0, 100 ) / 100, randInt ( 0, 100 ) / 100, "test", true ) | |||
-- Get its size and output to chatbox | |||
local x, y = guiGetSize ( window ) | |||
outputChatBox ( "Window size: " .. x .. " " .. y ) | |||
</syntaxhighlight> | </syntaxhighlight> | ||
Revision as of 15:03, 18 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 successful, false otherwise.
Example
This example creates a random sized gui window and outputs its size to the chatbox.
-- Create the window local window = guiCreateWindow ( 0, 0, randInt ( 0, 100 ) / 100, randInt ( 0, 100 ) / 100, "test", true ) -- Get its size and output to chatbox local x, y = guiGetSize ( window ) outputChatBox ( "Window size: " .. x .. " " .. y )
See Also
Template:FunctionArea functions -- leave this until syntax is available. Cannot document the function or event without syntax.