OnClientElementDataChange: Difference between revisions
Jump to navigation
Jump to search
m (→Source) |
No edit summary |
||
| Line 1: | Line 1: | ||
{{Client event}} | {{Client event}} | ||
__NOTOC__ | __NOTOC__ | ||
This event is triggered | 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]]. | ||
==Parameters== | ==Parameters== | ||
<syntaxhighlight lang="lua"> | <syntaxhighlight lang="lua"> | ||
string | string theKey, var oldValue, var newValue | ||
</syntaxhighlight> | </syntaxhighlight> | ||
*''' | *'''theKey''': The name of the element data entry that has changed. | ||
*'''oldValue''': | *'''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== | ==Source== | ||
The [[event system#Event source|source]] of this event is the [[element]] | The [[event system#Event source|source]] of this event is the [[element]] whose [[element data]] changed. | ||
==Example== | ==Example== | ||
This example tells the client whenever a player's "score" element data is changed. | This example tells the client whenever a player's "score" element data is changed. | ||
<syntaxhighlight lang="lua"> | <syntaxhighlight lang="lua"> | ||
function scoreChangeTracker(theKey, oldValue, newValue) | |||
if (getElementType(source) == "player") and (theKey == "score") then | |||
outputChatBox(getPlayerName(source).."'s new score is "..newValue.."!") | |||
end | |||
end | |||
end ) | addEventHandler("onClientElementDataChange", root, scoreChangeTracker) | ||
</syntaxhighlight> | </syntaxhighlight> | ||
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
- onClientElementColShapeHit
- onClientElementColShapeLeave
- onClientElementDataChange
- onClientElementDestroy
- onClientElementDimensionChange
- onClientElementInteriorChange
- onClientElementModelChange
- onClientElementStreamIn
- onClientElementStreamOut
Client event functions
- addEvent
- addEventHandler
- cancelEvent
- cancelLatentEvent
- getEventHandlers
- getLatentEventHandles
- getLatentEventStatus
- removeEventHandler
- triggerEvent
- triggerLatentServerEvent
- triggerServerEvent
- wasEventCancelled