OnElementStopSync: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
m (Updated with template warning)
(Improve example.)
 
(15 intermediate revisions by 6 users not shown)
Line 1: Line 1:
__NOTOC__
__NOTOC__
{{Server event}}
{{Server event}}
{{Warning|PLEASE NOTE: In 1.1.x, Destroying the source of this event could crash the server!}}


This event is triggered when an element is no longer synced by a player.
This event is triggered when an element is no longer synced by a player.
Line 10: Line 9:
</syntaxhighlight>  
</syntaxhighlight>  


*'''oldSyncer''': [[player]] element representing the last player who was syncing the element
*'''oldSyncer''': a [[player]] element representing the last player who was syncing the [[element]].


==Source==
==Source==
The [[event system#Event source|source]] of this event is the [[element]] which is no longer synced by a player.
The [[event system#Event source|source]] of this event is the [[element]] which is no longer synced by a player.


==Example==  
==Example==
This script creates a vehicle in the center of the map and outputs a message to its old syncer if he is not syncing the vehicle anymore.
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
-- TODO
function onResourceStart()
local vehicleElement = createVehicle(434, 0, 0, 3) -- Create vehicle
 
addEventHandler("onElementStopSync", vehicleElement, onElementStopSync) -- Bind handler specifically to it
end
addEventHandler("onResourceStart", resourceRoot, onResourceStart)
 
function onElementStopSync(oldSyncer)
outputChatBox("The vehicle is not being synced by you anymore.", oldSyncer) -- Tell player (oldSyncer) that he's not syncing vehicle
end
</syntaxhighlight>
</syntaxhighlight>


{{See also/Server event|Element events}}
{{See also/Server event|Element events}}
[[Category:Needs_Example]]

Latest revision as of 23:50, 6 January 2023

This event is triggered when an element is no longer synced by a player.

Parameters

player oldSyncer
  • oldSyncer: a player element representing the last player who was syncing the element.

Source

The source of this event is the element which is no longer synced by a player.

Example

This script creates a vehicle in the center of the map and outputs a message to its old syncer if he is not syncing the vehicle anymore.

function onResourceStart()
	local vehicleElement = createVehicle(434, 0, 0, 3) -- Create vehicle

	addEventHandler("onElementStopSync", vehicleElement, onElementStopSync) -- Bind handler specifically to it
end
addEventHandler("onResourceStart", resourceRoot, onResourceStart)

function onElementStopSync(oldSyncer)
	outputChatBox("The vehicle is not being synced by you anymore.", oldSyncer) -- Tell player (oldSyncer) that he's not syncing vehicle
end

See Also

Element events


Event functions