RemoveElementData: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
No edit summary
Line 1: Line 1:
{{Server function}}
{{Server client function}}
__NOTOC__  
__NOTOC__  
This function removes the [[element data]] with the given key for that element. The element data removal is synced with all the clients.
This function removes the [[element data]] with the given key for that element. The element data removal is synced with all the clients.

Revision as of 23:58, 19 June 2011

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 )

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

Click to collapse [-]
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=26107"