TextItemGetText: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
(Remove spaces) |
||
| (5 intermediate revisions by 3 users not shown) | |||
| Line 1: | Line 1: | ||
[[ | __NOTOC__ | ||
{{Server function}} | |||
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== | ||
Increment a score display. In real scripts it's of course better to keep a global 'score' variable which can be incremented directly. | |||
<syntaxhighlight lang="lua"> | <syntaxhighlight lang="lua"> | ||
-- | function givePoint ( thePlayer ) | ||
local scoretextitem = scoretextitems[thePlayer] -- find the score text item that belongs to this player | |||
-- | local score = textItemGetText ( scoretextitem ) -- read the text (a score number) | ||
score = tostring(tonumber(score) + 1) -- convert to number, add 1, convert to text | |||
textItemSetText ( scoretextitem, score ) -- put the new score on the text item | |||
end | |||
</syntaxhighlight> | </syntaxhighlight> | ||
==See Also== | ==See Also== | ||
{{ | {{Text functions}} | ||
Latest revision as of 21:13, 29 October 2023
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
Increment a score display. In real scripts it's of course better to keep a global 'score' variable which can be incremented directly.
function givePoint ( thePlayer )
local scoretextitem = scoretextitems[thePlayer] -- find the score text item that belongs to this player
local score = textItemGetText ( scoretextitem ) -- read the text (a score number)
score = tostring(tonumber(score) + 1) -- convert to number, add 1, convert to text
textItemSetText ( scoretextitem, score ) -- put the new score on the text item
end
See Also
- textCreateDisplay
- textCreateTextItem
- textDestroyDisplay
- textDestroyTextItem
- textDisplayAddObserver
- textDisplayAddText
- textDisplayGetObservers
- textDisplayIsObserver
- textDisplayRemoveObserver
- textDisplayRemoveText
- textItemGetColor
- textItemGetPosition
- textItemGetPriority
- textItemGetScale
- textItemGetText
- textItemSetColor
- textItemSetPosition
- textItemSetPriority
- textItemSetScale
- textItemSetText