OnClientElementDataChange: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
No edit summary
 
No edit summary
 
(9 intermediate revisions by 7 users not shown)
Line 1: Line 1:
[[Category:Incomplete Event]]
{{Client event}}
 
__NOTOC__  
__NOTOC__  
This event is blahblah and is used for blahblah.
This event is triggered ''after'' an element's [[element data|data]] entry is changed. Such changes can be made on the client or the server using [[setElementData]].


==Syntax==  
==Parameters==
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
void onClientElementDataChange ( string name )
string theKey, var oldValue, var newValue
</syntaxhighlight>  
</syntaxhighlight>  
*'''theKey''': The name of the element data entry that has changed.
*'''oldValue''': The old value of this entry before it changed. See [[element data]] for a list of possible datatypes.
*'''newValue''': the new value of this entry after it changed. This will be equivalent to [[getElementData]](source, theKey).
==Source==
The [[event system#Event source|source]] of this event is the [[element]] whose [[element data]] changed.


==Example==  
==Example==  
This example does...
This example tells the client whenever a player's "score" element data is changed.
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
--This line does...
function scoreChangeTracker(theKey, oldValue, newValue)
blabhalbalhb --abababa
    if (getElementType(source) == "player") and (theKey == "score") then
--This line does this...
        outputChatBox(getPlayerName(source).."'s new score is "..newValue.."!")
mooo
    end
end
addEventHandler("onClientElementDataChange", root, scoreChangeTracker)
</syntaxhighlight>
</syntaxhighlight>
[[pl:onClientElementDataChange]]
==See Also==
===Client element events===
{{Client_element_events}}
===Client event functions===
{{Client_event_functions}}

Latest revision as of 12:28, 8 October 2018

This event is triggered after an element's data entry is changed. Such changes can be made on the client or the server using setElementData.

Parameters

string theKey, var oldValue, var newValue
  • theKey: The name of the element data entry that has changed.
  • oldValue: The old value of this entry before it changed. See element data for a list of possible datatypes.
  • newValue: the new value of this entry after it changed. This will be equivalent to getElementData(source, theKey).

Source

The source of this event is the element whose element data changed.

Example

This example tells the client whenever a player's "score" element data is changed.

function scoreChangeTracker(theKey, oldValue, newValue)
    if (getElementType(source) == "player") and (theKey == "score") then
        outputChatBox(getPlayerName(source).."'s new score is "..newValue.."!")
    end
end
addEventHandler("onClientElementDataChange", root, scoreChangeTracker)

See Also

Client element events


Client event functions