TextItemGetPriority: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
No edit summary
 
m (Remove spaces)
 
(4 intermediate revisions by 4 users not shown)
Line 1: Line 1:
[[Category:Incomplete]]
{{Server function}}
 
{{Needs_Example}}
__NOTOC__  
__NOTOC__
This fake function is for use with blah & blah and does blahblahblabhalbhl
This function retrieves the priority of a text item.  Priority defines the rate at whihc a text item is updated


==Syntax==  
==Syntax==  
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
int textItemGetPriority ( textitem textitem )            
int textItemGetPriority ( textitem textitemToCheck )
</syntaxhighlight>  
</syntaxhighlight>  


===Required Arguments===  
===Required Arguments===  
*'''argumentName:''' description
*'''textitemToCheck:''' The text item you wish to retrieve the priority of.
 
===Optional Arguments===
{{OptionalArg}}
*'''argumentName2:''' descriptiona
*'''argumentName3:''' description


===Returns===
===Returns===
Returns ''true'' if blah, ''false'' otherwise.
Returns a integer of the priority of a text item, 0 = low, 1 = medium, 2 = high.


==Example==  
==Example==  
This example does...
This page does not have an example.
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
--This line does...
--add an example here
blabhalbalhb --abababa
--This line does this...
mooo
</syntaxhighlight>
</syntaxhighlight>


==See Also==
==See Also==
{{FunctionArea_Functions}}
{{Text_functions}}

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