GetPlayerContactElement: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
(Removed comments, updated page, improved example)
m (Changed "DeprecatedWithAlt" template to "Deprecated")
 
(4 intermediate revisions by 4 users not shown)
Line 1: Line 1:
__NOTOC__
__NOTOC__
{{Client function}}
{{Server client function}}
This function detects the element a player is standing on. This can be a vehicle or an object.
{{Deprecated|getPedContactElement|}}
 
This function detects the element a player is standing on. This can be a vehicle or an object.  Note that the server is unable to retrieve contact elements that are created clientside.


==Syntax==  
==Syntax==  

Latest revision as of 16:30, 13 February 2015

Emblem-important.png This function is deprecated. This means that its use is discouraged and that it might not exist in future versions.

Please use getPedContactElement instead.


This function detects the element a player is standing on. This can be a vehicle or an object. Note that the server is unable to retrieve contact elements that are created clientside.

Syntax

element getPlayerContactElement ( player thePlayer )

Required Arguments

  • thePlayer: The player you want to get the element he is touching from.

Returns

Returns an object or a vehicle if the player is standing on one, false if he is touching none or is a invalid player.

Example

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 = getPlayerContactElement( thePlayer )
  if getElementType( elementStandingOn ) == "vehicle" then
    local vehicleName = getVehicleName( elementStandingOn )
    outputChatBox( "The player is standing on a " .. vehicleName .. "." )
  else
    outputChatBox( "The player isn't standing on any vehicle." )
  end
end

See Also