OnClientElementStreamOut: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
(Add parameters section (without parameters))
No edit summary
Line 8: Line 8:
==Source==
==Source==
The [[event system#Event source|source]] of this event is the [[element]] that streamed out.
The [[event system#Event source|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==  
==Example==  

Revision as of 18:26, 17 November 2021

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.

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 a marker was streamed out and the distance between player and the marker.

addEventHandler( "onClientElementStreamOut", root,
    function ( )
        if getElementType( source ) == "marker" then
            local myPosTab = { getElementPosition( localPlayer ) };
            local markerPosTab = { getElementPosition( source ) };
            local distance = getDistanceBetweenPoints3D( unpack( myPosTab ), unpack( markerPosTab ) );
            outputChatBox( "A marker has just streamed out. Distance to the marker: " .. tostring( distance ) .."." );
        end
    end
);

See Also

Client element events


Client event functions