SetElementID: Difference between revisions

Revision as of 17:06, 22 August 2006

This function sets the ID of an element to a string. This can be anything from an identifying number, to a name.

bool setElementID ( element theElement, string name )

This returns true if sucessful. It will return false if theElement is invalid, or does not exist, or if name is invalid, or is not a string.

Example goes here...

@@ Line 1: / Line 1: @@
 [[Category:Incomplete]]
 __NOTOC__
-This fake function is for use with blah & blah and does blahblahblabhalbhl
+This function sets the ''ID'' of an ''element'' to a ''string''. This can be anything from an identifying number, to a name.
 ==Syntax==
 <syntaxhighlight lang="lua">
-bool setElementID ( element element, string name )
+bool setElementID ( element theElement, string name )
 </syntaxhighlight>
 ===Required Arguments===
-*'''argumentName:''' description
+*'''theElement:''' The ''element'' you want to set the ID of.
+*'''name:'' The ID you want to set to ''theElement''
-===Optional Arguments===
-{{OptionalArg}}
-*'''argumentName2:''' descriptiona
-*'''argumentName3:''' description
 ===Returns===
-Returns ''true'' if blah, ''false'' otherwise.
+This returns ''true'' if sucessful. It will return false if ''theElement'' is invalid, or does not exist, or if ''name'' is invalid, or is not a string.
 ==Example==
-This example does...
 <syntaxhighlight lang="lua">
---This line does...
+Example goes here...
-blabhalbalhb --abababa
---This line does this...
-mooo
 </syntaxhighlight>
 ==See Also==
-{{FunctionArea_Functions}}
+{{element_functions}}