TextItemSetPriority: Difference between revisions

Revision as of 14:03, 29 August 2007

	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 rate at which a text item is updated.

void textItemSetPriority ( textitem theTextItem, string priority )

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.

This page does not have an example

--add an example here

@@ Line 1: / Line 1: @@
-[[Category:Incomplete]]
+{{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__
-This fake function is for use with blah & blah and does blahblahblabhalbhl
+This function sets the priority for a text item.  Priority is the rate at which a text item is updated.
 ==Syntax==
 <syntaxhighlight lang="lua">
-void textItemSetPriority ( textitem textitem, int priority )
+void textItemSetPriority ( textitem theTextItem, string priority )
 </syntaxhighlight>
 ===Required Arguments===
-*'''argumentName:''' description
+*'''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.
-===Optional Arguments===
-{{OptionalArg}}
-*'''argumentName2:''' descriptiona
-*'''argumentName3:''' description
-===Returns===
-Returns ''true'' if blah, ''false'' otherwise.
 ==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}}
+[[Category:Needs_Example]]