TextItemSetPriority: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
m (Remove spaces) |
||
| (6 intermediate revisions by 4 users not shown) | |||
| Line 1: | Line 1: | ||
__NOTOC__ | |||
{{Server function}} | |||
{{Needs_Example}} | |||
This | This function sets the priority for a text item. Priority is the importance of sending updated text to the client. The system is implemented as 3 queues, with the ''high'' queue being emptied before the ''medium'' queue is processed, and with one update sent per server frame. Hence, if you set all your text items to ''medium'' priority it has the same effect as if you set them all to ''high'' or ''low''. | ||
==Syntax== | ==Syntax== | ||
<syntaxhighlight lang="lua"> | <syntaxhighlight lang="lua"> | ||
void textItemSetPriority ( textitem | void textItemSetPriority ( textitem theTextItem, string priority ) | ||
</syntaxhighlight> | </syntaxhighlight> | ||
===Required Arguments=== | ===Required Arguments=== | ||
*''' | *'''theTextItem:''' The text item you wish to set priority to. | ||
*'''priority:''' The priority you wish to set to the item, which can be ''"high"'', ''"medium"'', or ''"low"'' respective of their 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}} | ||
Latest revision as of 21:15, 29 October 2023
|
Script Example Missing Function TextItemSetPriority needs a script example, help out by writing one. |
Before submitting check out Editing Guidelines Script Examples. |
This function sets the priority for a text item. Priority is the importance of sending updated text to the client. The system is implemented as 3 queues, with the high queue being emptied before the medium queue is processed, and with one update sent per server frame. Hence, if you set all your text items to medium priority it has the same effect as if you set them all to high or low.
Syntax
void textItemSetPriority ( textitem theTextItem, string priority )
Required Arguments
- theTextItem: The text item you wish to set priority to.
- priority: The priority you wish to set to the item, which can be "high", "medium", or "low" respective of their 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