RemoveElementData: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
m (→‎Example: No need for section)
m (→‎Syntax: OOP)
Line 7: Line 7:
bool removeElementData ( element theElement, string key )  
bool removeElementData ( element theElement, string key )  
</syntaxhighlight>  
</syntaxhighlight>  
{{OOP|This function is also a static function underneath the Element class.|[[element]]:removeData||}}


===Required Arguments===  
===Required Arguments===  

Revision as of 16:33, 16 August 2014

This function removes the element data with the given key for that element. The element data removal is synced with all the clients.

Syntax

bool removeElementData ( element theElement, string key )

OOP Syntax Help! I don't understand this!

Note: This function is also a static function underneath the Element class.
Method: element:removeData(...)


Required Arguments

  • theElement: The element you wish to remove the data from.
  • key: The key string you wish to remove.

Returns

Returns true if the data was removed succesfully, false if the given key does not exist in the element or the element is invalid.

Example

This will create an element data for know if a player has spawned. 

function spawn()
    setElementData(source,"spawned",true)
end
addEventHandler ( "onPlayerSpawn", getRootElement(), spawn )
function wasted()
    removeElementData(source,"spawned")
end
addEventHandler ( "onPlayerWasted", getRootElement(), wasted )

See Also


Retrieved from "https://wiki.multitheftauto.com/wiki/RemoveElementData?oldid=41474"