TextItemGetPriority: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
mNo edit summary |
||
| (One intermediate revision by one other user not shown) | |||
| Line 1: | Line 1: | ||
{{Server function}} | {{Server function}} | ||
{{ | {{Needs_Example}} | ||
__NOTOC__ | __NOTOC__ | ||
This function retrieves the priority of a text item. Priority defines the rate at whihc a text item is updated | This function retrieves the priority of a text item. Priority defines the rate at whihc a text item is updated | ||
| Line 6: | Line 6: | ||
==Syntax== | ==Syntax== | ||
<syntaxhighlight lang="lua"> | <syntaxhighlight lang="lua"> | ||
int textItemGetPriority ( textitem textitemToCheck ) | |||
</syntaxhighlight> | </syntaxhighlight> | ||
| Line 13: | Line 13: | ||
===Returns=== | ===Returns=== | ||
Returns a | Returns a integer of the priority of a text item, 0 = low, 1 = medium, 2 = high. | ||
==Example== | ==Example== | ||
| Line 23: | Line 23: | ||
==See Also== | ==See Also== | ||
{{Text_functions}} | {{Text_functions}} | ||
Revision as of 12:55, 2 January 2014
|
Script Example Missing Function TextItemGetPriority needs a script example, help out by writing one. |
Before submitting check out Editing Guidelines Script Examples. |
This function retrieves the priority of a text item. Priority defines the rate at whihc a text item is updated
Syntax
int textItemGetPriority ( textitem textitemToCheck )
Required Arguments
- textitemToCheck: The text item you wish to retrieve the priority of.
Returns
Returns a integer of the priority of a text item, 0 = low, 1 = medium, 2 = high.
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