GetWeaponIDFromName: Difference between revisions

Revision as of 04:11, 3 October 2006

This function will obtain the ID of a particular weapon from its name.

int getWeaponIDFromName ( string name )

Returns an int if the name matches that of a weapon, false otherwise.

This example does...

--This line does...
blabhalbalhb --abababa
--This line does this...
mooo

@@ Line 2: / Line 2: @@
 __NOTOC__
-This fake function is for use with blah & blah and does blahblahblabhalbhl
+This function will obtain the ID of a particular weapon from its name.
 ==Syntax==
@@ Line 10: / Line 10: @@
 ===Required Arguments===
-*'''argumentName:''' description
+*'''name:''' A [[string]] containing the name of the weapon.
-===Optional Arguments===
-{{OptionalArg}}
-*'''argumentName2:''' descriptiona
-*'''argumentName3:''' description
 ===Returns===
-Returns ''true'' if blah, ''false'' otherwise.
+Returns an [[int]] if the name matches that of a weapon, ''false'' otherwise.
 ==Example==
@@ Line 30: / Line 25: @@
 ==See Also==
-{{FunctionArea_Functions}}
+{{Weapon functions}}