OnClientElementStreamIn

From Multi Theft Auto: Wiki
Revision as of 03:10, 22 January 2023 by Dutchman101 (talk | contribs) (unexpected behavior note)
Jump to navigation Jump to search

This event is triggered whenever a physical element is streamed in. This is triggered for all elements that are streamable, such as players, peds, vehicles, objects and markers. When this event is triggered, that element is guaranteed to be physically created as a GTA object.

Be aware that this event triggers for local player (as itself being the element that got streamed in) when said local player spawns, as this is the creation of entity local ped. It also triggers for a remote player that dies in front of local player, even if they respawn far away.. the moment they do so, this event will be triggered, and if you'd measure distance between local and said remote player (that spawned far away) it would output the distance at which they died in front of local player, e.g 2 metres. This is bug-prone behavior and likely incorrect, to be fixed in the future, but for now be aware.

Parameters

No parameters.

Source

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

Example

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

addEventHandler( "onClientElementStreamIn", 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 in. Distance to the player: " .. tostring(distance) .."." )
        end
    end
)

See Also

Client element events


Client event functions