IsElementOnScreen: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
No edit summary
mNo edit summary
Line 1: Line 1:
__NOTOC__
__NOTOC__
{{Client function}}
{{Client function}}
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.
This function is particularly useful for detecting if dynamic objects are in "destroyed" state. Destroyed objects will return false.
==Syntax==  
==Syntax==  
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">

Revision as of 06:46, 3 February 2011

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.

This function is particularly useful for detecting if dynamic objects are in "destroyed" state. Destroyed objects will return false.

Syntax

bool isElementOnScreen ( element theElement )

Required Arguments

  • theElement: The element of which you wish to check wether it's being rendered on screen.

Returns

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

Example

This function will check if you can see your kill 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 player who was killed can see his killer
            outputChatBox ( "You can still see your killer!", source, 255, 0, 0 )
        else
            -- the player who was killed can not see his killer
            outputChatBox ( "You can not see your killer!", source, 255, 0, 0 )
        end
    end
end
addEventHandler ( "onClientPlayerWasted", getRootElement(), player_Wasted )

See Also


Retrieved from "https://wiki.multitheftauto.com/wiki/IsElementOnScreen?oldid=25329"