TextItemGetPriority: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
No edit summary
m (Remove spaces)
 
(2 intermediate revisions by 2 users not shown)
Line 1: Line 1:
{{Server function}}
{{Server function}}
{{Needs_Checking|Does this retrieve a string or an integer? --[[User:Talidan2|Talidan2]] 08:55, 29 August 2007 (CDT)}}
{{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">
string textItemGetPriority ( textitem textitemToCheck )            
int textItemGetPriority ( textitem textitemToCheck )
</syntaxhighlight>  
</syntaxhighlight>  


Line 13: Line 13:


===Returns===
===Returns===
Returns a string of the priority of a text item, either "high", "medium" or "low" respective of its priority.
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}}
[[Category:Needs_Example]]

Latest revision as of 21:16, 29 October 2023

Accessories-text-editor.png 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