SetElementID: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
No edit summary
 
(23 intermediate revisions by 11 users not shown)
Line 1: Line 1:
[[Category:Incomplete]]
{{Server client function}}
__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.
 
You can only change the ID of an element clientside if that element has been created clientside as well.
==Syntax==  
==Syntax==  
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
bool setElementID ( element theElement, string name )  
bool setElementID ( element theElement, string name )  
</syntaxhighlight>  
</syntaxhighlight>  
{{OOP||[[element]]:setID|id|getElementID}}


===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==  
<syntaxhighlight lang="lua">
local players = getElementsByType( "player" )
for i=1,#players do
  setElementID( players[i], "player" .. i ) -- Change element IDs to 'player1', 'players2', 'players3'...
  outputDebugString( "Player[" .. i .. "] = " .. getElementID( players[i] ) ) -- Output all the new element IDs
end


<syntaxhighlight lang="lua">
 
Example goes here...
-- Could also be --
 
for i=1,#players do
  setElementID( players[i], getPlayerName( players[i] ) ) -- Change the element ID to the players name.
  outputDebugString( "Player[" .. i .. "] = " .. getElementID( players[i] ) )
end
</syntaxhighlight>
</syntaxhighlight>


==See Also==
==See Also==
{{element_functions}}
{{element_functions}}

Latest revision as of 19:54, 15 January 2018

This function sets the ID of an element to a string. This can be anything from an identifying number, to a name. You can only change the ID of an element clientside if that element has been created clientside as well.

Syntax

bool setElementID ( element theElement, string name )

OOP Syntax Help! I don't understand this!

Method: element:setID(...)
Variable: .id
Counterpart: getElementID


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

local players = getElementsByType( "player" )
 
for i=1,#players do
   setElementID( players[i], "player" .. i )	-- Change element IDs to 'player1', 'players2', 'players3'...
   outputDebugString( "Player[" .. i .. "] = " .. getElementID( players[i] ) ) -- Output all the new element IDs
end


-- Could also be --

for i=1,#players do
   setElementID( players[i], getPlayerName( players[i] ) )	-- Change the element ID to the players name.
   outputDebugString( "Player[" .. i .. "] = " .. getElementID( players[i] ) )
end

See Also


Retrieved from "https://wiki.multitheftauto.com/wiki/SetElementID?oldid=53342"