isElementOnScreen | Multi Theft Auto: Wiki Skip to content
Multi Theft Auto: Wiki

isElementOnScreen

Client-side
Server-side
Shared

This function will check if an element is on the screen. Elements behind objects but still in the camera view count as being on screen.

OOP Syntax Help! I don't understand this!

  • Method:element:isOnScreen(...)
  • Variable: .onScreen

Syntax 

​bool isElementOnScreen ( ​element theElement )
Required Arguments
  • theElement: The element of which you wish to check whether it's being rendered on screen.

Returns

  • bool: result

Returns true if element is on screen, false if not.

Code Examples

client

This function will check if you can see your killer when you die.

function player_Wasted(killer, weapon, bodypart)
    -- if there even was a killer and the killer isn't the killed player itself
    if (killer) and (killer ~= source) then
        -- there was a killer
        if (isElementOnScreen(killer)) then
            -- the killer was on screen
            outputChatBox("You can still see your killer!", 255, 0, 0)
        else
            -- the killer was not on screen
            outputChatBox("You can not see your killer!", 255, 0, 0)
        end
    end
end
-- call player_Wasted when only the local player dies
addEventHandler("onClientPlayerWasted", localPlayer, player_Wasted)

Issues

ID Description
2029

isElementOnScreen doesn't work for markers.

See Also

Element Functions
Element Events
Reference