OnElementModelChange: Difference between revisions
Jump to navigation
Jump to search
m (Grammatical changes.) |
No edit summary |
||
| (9 intermediate revisions by 7 users not shown) | |||
| Line 1: | Line 1: | ||
__NOTOC__ | __NOTOC__ | ||
{{Server event}} | {{Server event}} | ||
This event is triggered when the model of an [[element]] is changed using [[setElementModel]]. | This event is triggered when the model of an [[element]] is changed using [[setElementModel]]. | ||
| Line 11: | Line 8: | ||
</syntaxhighlight> | </syntaxhighlight> | ||
* '''oldModel:''' | * '''oldModel:''' an [[int]] representing the model of the [[element]] before the change occurred. | ||
* '''newModel:''' | * '''newModel:''' an [[int]] representing the new model of the [[element]]. | ||
==Source== | ==Source== | ||
The source of this event is the element that changed its model | The [[event system#Event source|source]] of this event is the [[element]] that changed its model | ||
==Cancel | ==Cancel effect== | ||
This event | This event does NOT support [[Event system#Canceling|cancellation]]. Use [[setElementModel]] with the old value to reverse. | ||
==Example== | ==Example== | ||
| Line 25: | Line 22: | ||
function informPlayerOnModelChange(oldModel, newModel) | function informPlayerOnModelChange(oldModel, newModel) | ||
if ( getElementType(source) == "player" ) then -- Make sure the element is a player | if ( getElementType(source) == "player" ) then -- Make sure the element is a player | ||
outputChatBox("Model ID changing from: "..oldModel.." to: "..newModel, source, 0, 255, 0) -- Message for player | outputChatBox("Model ID changing from: "..oldModel.." to: ".. newModel, source, 0, 255, 0) -- Message for player | ||
end | end | ||
end | end | ||
| Line 31: | Line 28: | ||
</syntaxhighlight> | </syntaxhighlight> | ||
{{See also/Server event|Element events}} | |||
Latest revision as of 20:36, 7 November 2019
This event is triggered when the model of an element is changed using setElementModel.
Parameters
int oldModel, int newModel
- oldModel: an int representing the model of the element before the change occurred.
- newModel: an int representing the new model of the element.
Source
The source of this event is the element that changed its model
Cancel effect
This event does NOT support cancellation. Use setElementModel with the old value to reverse.
Example
This example sends a message to players when their model changes telling them what the model ID is and was.
function informPlayerOnModelChange(oldModel, newModel)
if ( getElementType(source) == "player" ) then -- Make sure the element is a player
outputChatBox("Model ID changing from: "..oldModel.." to: ".. newModel, source, 0, 255, 0) -- Message for player
end
end
addEventHandler("onElementModelChange", root, informPlayerOnModelChange) -- Bind the event to every element
See Also
Element events
- onElementClicked
- onElementColShapeHit
- onElementColShapeLeave
- onElementDataChange
- onElementDestroy
- onElementDimensionChange
- onElementInteriorChange
- onElementModelChange
- onElementStartSync
- onElementStopSync
Event functions
- addEvent
- addEventHandler
- cancelEvent
- cancelLatentEvent
- getEventHandlers
- getLatentEventHandles
- getLatentEventStatus
- removeEventHandler
- triggerEvent
- wasEventCancelled