TextItemSetPriority: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
No edit summary
No edit summary
Line 1: Line 1:
{{Needs_Checking|Is the 2nd argument a string or an int?  Should be a string for consistency --[[User:Talidan2|Talidan2]] 09:03, 29 August 2007 (CDT)}}
{{Needs_Checking|Is the 2nd argument a string or an int?  Should be a string for consistency --[[User:Talidan2|Talidan2]] 09:03, 29 August 2007 (CDT)}}
__NOTOC__  
__NOTOC__  
This function sets the priority for a text item.  Priority is the rate at which a text item is updated.
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==  

Revision as of 13:50, 20 December 2007

Dialog-information.png This article needs checking.

Reason(s): Is the 2nd argument a string or an int? Should be a string for consistency --Talidan2 09:03, 29 August 2007 (CDT)

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