IsElementOnScreen: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
mNo edit summary
mNo edit summary
Line 13: Line 13:
Returns ''true'' if element is on screen, ''false'' if not.
Returns ''true'' if element is on screen, ''false'' if not.
==Example==
==Example==
This function will check if you can see your kill when you die.
This function will check if you can see your killer when you die.
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
function player_Wasted ( killer, weapon, bodypart )
function player_Wasted ( killer, weapon, bodypart )
Line 20: Line 20:
         -- there was a killer
         -- there was a killer
         if ( isElementOnScreen ( killer ) ) then
         if ( isElementOnScreen ( killer ) ) then
             -- the player who was killed can see his killer
             -- the killer was on screen
             outputChatBox ( "You can still see your killer!", source, 255, 0, 0 )
             outputChatBox ( "You can still see your killer!", 255, 0, 0 )
         else
         else
             -- the player who was killed can not see his killer
             -- the killer was not on screen
             outputChatBox ( "You can not see your killer!", source, 255, 0, 0 )
             outputChatBox ( "You can not see your killer!", 255, 0, 0 )
         end
         end
     end
     end
end
end
addEventHandler ( "onClientPlayerWasted", getRootElement(), player_Wasted )
-- call player_Wasted when only the local player dies
addEventHandler ( "onClientPlayerWasted", localPlayer, player_Wasted )
</syntaxhighlight>
</syntaxhighlight>


==See Also==
==See Also==
{{Client element functions}}
{{Client element functions}}

Revision as of 13:27, 2 June 2013

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 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 )

See Also



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