SetElementID: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
No edit summary
Line 1: Line 1:
{{Server function}}
[[Category:Incomplete]]
[[Category:Incomplete]]
__NOTOC__  
__NOTOC__  
This function sets the ''ID'' of an ''element'' to a ''string''. This can be anything from an identifying number, to a name.
This function sets the ID of an element to a string. This can be anything from an identifying number, to a name.


==Syntax==  
==Syntax==  
Line 10: Line 11:
===Required Arguments===  
===Required Arguments===  
*'''theElement:''' The ''element'' you want to set the ID of.
*'''theElement:''' The ''element'' you want to set the ID of.
*'''name:''' The ID you want to set to ''theElement''.
*'''name:''' The new ID for ''theElement''.


===Returns===
===Returns===
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.
This returns ''true'' if successful. It will return ''false'' if '''theElement''' is invalid, or does not exist, or if '''name''' is invalid, or is not a string.


==Example==  
==Example==  

Revision as of 12:37, 16 August 2007

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

Syntax

bool setElementID ( element theElement, string name ) 

Required Arguments

  • theElement: The element you want to set the ID of.
  • name: The new ID for theElement.

Returns

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

Example

Example goes here...

See Also