OnClientColShapeHit: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
No edit summary
No edit summary
Line 1: Line 1:
{{Client event}}
{{Client event}}
__NOTOC__
__NOTOC__
This event triggers whenever an element (a player, a vehicle...) enters a collision shape.
This event is triggered when an physical [[element]] hits a [[colshape]].
 
'''NOTE''': The hit won't be detected if the [[element]] that entered the colshape is a colshape.


==Parameters==
==Parameters==

Revision as of 05:07, 26 March 2013

This event is triggered when an physical element hits a colshape.

NOTE: The hit won't be detected if the element that entered the colshape is a colshape.

Parameters

element theElement, bool matchingDimension
  • theElement: the element that entered the colshape.
  • matchingDimension: true if theElement is in the same dimension as the colshape, false otherwise.

Source

The source of this event is the colshape that was hit.

Example

This example outputs "In." to the chatbox whenever a local user enters a collision shape.

function onClientColShapeHit( theElement, matchingDimension )
    if ( theElement == getLocalPlayer() ) then  -- Checks whether the entering element is the local player
        outputChatBox( "In." )  --Outputs.
    end
end
addEventHandler("onClientColShapeHit",getRootElement(),onClientColShapeHit)

See Also

Client colshape events


Client event functions