GuiGetText: Difference between revisions
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 --> | <!-- Describe in plain english what this function does. Don't go into details, just give an overview --> | ||
This | This function is used to get text from GUI elements like edit boxes, labels, buttons, etc. | ||
==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 --> | <!-- 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"> | ||
string guiGetText ( element | string guiGetText ( element guiElement ) | ||
</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 --> | <!-- 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 --> | ||
*''' | *'''guiElement:''' element you wish to get text of. | ||
===Returns=== | ===Returns=== | ||
<!-- Make this descriptive. Explain what cases will return false. If you're unsure, add a tag to it so we can check --> | <!-- Make this descriptive. Explain what cases will return false. If you're unsure, add a tag to it so we can check --> | ||
Returns ' | Returns a string containing the requested element's text, or false if the gui element passed to the function is invalid. | ||
==Example== | ==Example== | ||
<!-- Explain what the example is in a single sentance --> | <!-- Explain what the example is in a single sentance --> | ||
This example | This example gets the text of a pre-made gui element and outputs it to chat box. | ||
<!-- 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 --> | <!-- 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"> | ||
-- | function test () | ||
--we create a dummy gui label to get text of | |||
local dummyGuiElement = guiCreateLabel ( 0.45, 0.48, 0.10, 0.04, "Hello world", true ) | |||
--output the text of the label to chat box | |||
outputChatBox ( "Text in the GUI label: "..guiGetText ( dummyGuiElement ) ) | |||
end | |||
</syntaxhighlight> | </syntaxhighlight> | ||
Revision as of 14:04, 30 July 2007
This function is used to get text from GUI elements like edit boxes, labels, buttons, etc.
Syntax
string guiGetText ( element guiElement )
Required Arguments
- guiElement: element you wish to get text of.
Returns
Returns a string containing the requested element's text, or false if the gui element passed to the function is invalid.
Example
This example gets the text of a pre-made gui element and outputs it to chat box.
function test () --we create a dummy gui label to get text of local dummyGuiElement = guiCreateLabel ( 0.45, 0.48, 0.10, 0.04, "Hello world", true ) --output the text of the label to chat box outputChatBox ( "Text in the GUI label: "..guiGetText ( dummyGuiElement ) ) end
See Also
Template:FunctionArea functions -- leave this until syntax is available. Cannot document the function or event without syntax. -- leave this unless you complete the function