TextItemGetPriority: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
No edit summary |
||
Line 1: | Line 1: | ||
[[ | {{Server function}} | ||
{{Needs_Checking|Does this retrieve a string or an integer? --[[User:Talidan2|Talidan2]] 08:55, 29 August 2007 (CDT)}} | |||
__NOTOC__ | __NOTOC__ | ||
This function retrieves the priority of a text item. Priority defines the rate at whihc a text item is updated | |||
This | |||
==Syntax== | ==Syntax== | ||
<syntaxhighlight lang="lua"> | <syntaxhighlight lang="lua"> | ||
string textItemGetPriority ( textitem textitemToCheck ) | |||
</syntaxhighlight> | </syntaxhighlight> | ||
===Required Arguments=== | ===Required Arguments=== | ||
*''' | *'''textitemToCheck:''' The text item you wish to retrieve the priority of. | ||
===Returns=== | ===Returns=== | ||
Returns | Returns a string of the priority of a text item, either "high", "medium" or "low" respective of its priority. | ||
==Example== | ==Example== | ||
This example | This page does not have an example. | ||
<syntaxhighlight lang="lua"> | <syntaxhighlight lang="lua"> | ||
-- | --add an example here | ||
</syntaxhighlight> | </syntaxhighlight> | ||
==See Also== | ==See Also== | ||
{{ | {{Text_functions}} | ||
[[Category:Needs_Example]] |
Revision as of 13:55, 29 August 2007
This article needs checking. | |
Reason(s): Does this retrieve a string or an integer? --Talidan2 08:55, 29 August 2007 (CDT) |
This function retrieves the priority of a text item. Priority defines the rate at whihc a text item is updated
Syntax
string textItemGetPriority ( textitem textitemToCheck )
Required Arguments
- textitemToCheck: The text item you wish to retrieve the priority of.
Returns
Returns a string of the priority of a text item, either "high", "medium" or "low" respective of its priority.
Example
This page does not have an example.
--add an example here
See Also
- textCreateDisplay
- textCreateTextItem
- textDestroyDisplay
- textDestroyTextItem
- textDisplayAddObserver
- textDisplayAddText
- textDisplayGetObservers
- textDisplayIsObserver
- textDisplayRemoveObserver
- textDisplayRemoveText
- textItemGetColor
- textItemGetPosition
- textItemGetPriority
- textItemGetScale
- textItemGetText
- textItemSetColor
- textItemSetPosition
- textItemSetPriority
- textItemSetScale
- textItemSetText