TextItemGetText: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
JonChappell (talk | contribs) No edit summary |
||
| Line 1: | Line 1: | ||
__NOTOC__ | __NOTOC__ | ||
This | This function returns the current text of the specified [[textitem]]. | ||
==Syntax== | ==Syntax== | ||
<syntaxhighlight lang="lua"> | <syntaxhighlight lang="lua"> | ||
string textItemGetText ( textitem | string textItemGetText ( textitem theTextitem ) | ||
</syntaxhighlight> | </syntaxhighlight> | ||
===Required Arguments=== | ===Required Arguments=== | ||
*''' | *'''theTextitem:''' A valid [[textitem]]. | ||
===Returns=== | ===Returns=== | ||
Returns | Returns a [[string]] containing the text if the function was successful, ''false'' otherwise. | ||
==Example== | ==Example== | ||
| Line 30: | Line 23: | ||
==See Also== | ==See Also== | ||
{{ | {{Text functions}} | ||
[[Category:Incomplete]] | |||
Revision as of 04:34, 3 October 2006
This function returns the current text of the specified textitem.
Syntax
string textItemGetText ( textitem theTextitem )
Required Arguments
- theTextitem: A valid textitem.
Returns
Returns a string containing the text if the function was successful, false otherwise.
Example
This example does...
--This line does... blabhalbalhb --abababa --This line does this... mooo
See Also
- textCreateDisplay
- textCreateTextItem
- textDestroyDisplay
- textDestroyTextItem
- textDisplayAddObserver
- textDisplayAddText
- textDisplayGetObservers
- textDisplayIsObserver
- textDisplayRemoveObserver
- textDisplayRemoveText
- textItemGetColor
- textItemGetPosition
- textItemGetPriority
- textItemGetScale
- textItemGetText
- textItemSetColor
- textItemSetPosition
- textItemSetPriority
- textItemSetScale
- textItemSetText