OnClientElementStreamOut: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
(Add info)
(Example)
Line 15: Line 15:


==Example==  
==Example==  
This example shows you how to tell player that a marker was streamed out and the distance between player and the marker.
This example shows you how to tell player that another player was streamed out and the distance between them and said player
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
addEventHandler( "onClientElementStreamOut", root,
addEventHandler( "onClientElementStreamOut", root,  
     function ( )
     function ()
         if getElementType( source ) == "marker" then
         if getElementType(source) == "player" then
             local myPosTab = { getElementPosition( localPlayer ) };
             local x, y, z = getElementPosition(localPlayer)
             local markerPosTab = { getElementPosition( source ) };
             local xh, xy, xz = getElementPosition(source)
             local distance = getDistanceBetweenPoints3D( unpack( myPosTab ), unpack( markerPosTab ) );
             local distance = getDistanceBetweenPoints3D(x, y, z, xh, xy, xz )
             outputChatBox( "A marker has just streamed out. Distance to the marker: " .. tostring( distance ) .."." );
             outputChatBox( "A player has just streamed out. Distance to the player: " .. tostring(distance) .."." )
         end
         end
     end
     end
);
)
</syntaxhighlight>
</syntaxhighlight>



Revision as of 03:14, 22 January 2023

This event is triggered whenever a physical element is streamed out. This is triggered for all elements that are streamable, such as players, peds, vehicles, objects and markers when the local player is leaving the element. When this event is triggered, that element is no longer physical and is now virtualized by MTA.

Be aware that this event triggers for local player (as itself being the element that got streamed out) when said local player dies and respawns, as this is the removal & recreation of entity local ped.

Parameters

No parameters.

Source

The source of this event is the element that streamed out.

Remarks

This event is not triggered for elements that are streamed-in at the point of a destroyElement call. Use the onClientElementDestroy event in combination with the isElementStreamedIn function to handle such a case.

Example

This example shows you how to tell player that another player was streamed out and the distance between them and said player

addEventHandler( "onClientElementStreamOut", root, 
    function ()
        if getElementType(source) == "player" then
            local x, y, z = getElementPosition(localPlayer)
            local xh, xy, xz = getElementPosition(source)
            local distance = getDistanceBetweenPoints3D(x, y, z, xh, xy, xz )
            outputChatBox( "A player has just streamed out. Distance to the player: " .. tostring(distance) .."." )
        end
    end
)

See Also

Client element events


Client event functions