GetPedContactElement: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
mNo edit summary
(Added OOP syntax)
Line 6: Line 6:
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
element getPedContactElement ( ped thePed )
element getPedContactElement ( ped thePed )
</syntaxhighlight>  
</syntaxhighlight>
{{OOP||[[ped]]:getContactElement|contactElement}}


===Required Arguments===  
===Required Arguments===  

Revision as of 17:04, 26 November 2014

This function detects the element a ped is standing on. This can be a vehicle or an object.

Syntax

element getPedContactElement ( ped thePed )

OOP Syntax Help! I don't understand this!

Method: ped:getContactElement(...)
Variable: .contactElement


Required Arguments

  • thePed: The ped of which you want to get the element he is standing on.

Returns

Returns an object or a vehicle if the ped is standing on one, false if he is touching none or an invalid element was passed.

Example

Click to collapse [-]
Client

This clientside function outputs the name of the vehicle the specified player is standing on, or a message saying he isn't on one.

function outputContactVehicleMessage ( thePlayer )
    local elementStandingOn = getPedContactElement ( thePlayer )
    if elementStandingOn and getElementType ( elementStandingOn ) == "vehicle" then
        local vehicleName = getVehicleName ( elementStandingOn )
        outputChatBox( "You're standing on a " .. vehicleName .. "." )
    else
        outputChatBox( "You're not standing on any vehicle." )
    end
end

See Also