TextItemGetPriority: Difference between revisions

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

int textItemGetPriority ( textitem textitemToCheck )

Returns a integer of the priority of a text item, 0 = low, 1 = medium, 2 = high.

This page does not have an example.

--add an example here

@@ Line 1: / Line 1: @@
-[[Category:Incomplete]]
+{{Server function}}
+{{Needs_Example}}
 __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==
 <syntaxhighlight lang="lua">
-int textItemGetPriority ( textitem textitem )
+int textItemGetPriority ( textitem textitemToCheck )
 </syntaxhighlight>
 ===Required Arguments===
-*'''argumentName:''' description
+*'''textitemToCheck:''' The text item you wish to retrieve the priority of.
-===Optional Arguments===
-{{OptionalArg}}
-*'''argumentName2:''' descriptiona
-*'''argumentName3:''' description
 ===Returns===
-Returns ''true'' if blah, ''false'' otherwise.
+Returns a integer of the priority of a text item, 0 = low, 1 = medium, 2 = high.
 ==Example==
-This example does...
+This page does not have an example.
 <syntaxhighlight lang="lua">
---This line does...
+--add an example here
-blabhalbalhb --abababa
---This line does this...
-mooo
 </syntaxhighlight>
 ==See Also==
-{{FunctionArea_Functions}}
+{{Text_functions}}