OnClientColShapeLeave: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
mNo edit summary
 
Line 7: Line 7:
element theElement, bool matchingDimension
element theElement, bool matchingDimension
</syntaxhighlight>
</syntaxhighlight>
*'''theElement:''' the element that left the colshape.
*'''theElement:''' the [[element]] that left the [[colshape]].
*'''matchingDimension:''' ''true'' if theElement is in the same dimension as the colshape, ''false'' otherwise.
*'''matchingDimension:''' a [[boolean]] referring to whether the collision shape was in the same [[dimension]] as the element.


==Source==
==Source==

Latest revision as of 22:17, 2 April 2018

This event is triggered when a physical element leaves a colshape.

Parameters

element theElement, bool matchingDimension
  • theElement: the element that left the colshape.
  • matchingDimension: a boolean referring to whether the collision shape was in the same dimension as the element.

Source

The source of this event is the colshape that the element left.

Example

This example outputs "Out." to the chatbox whenever the local user leaves a collision shape.

function onClientColShapeLeave( theElement, matchingDimension )
    if ( theElement == localPlayer ) then  -- Checks whether the leaving element is the local player
        outputChatBox( "Out." )  --Outputs.
    end
end
addEventHandler("onClientColShapeLeave", root, onClientColShapeLeave)

See Also

Client colshape events


Client event functions