OnClientColShapeLeave: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
No edit summary
 
(5 intermediate revisions by 5 users not shown)
Line 1: Line 1:
__NOTOC__  
__NOTOC__
This event triggers whenever an element leaves a collision shape.
{{Client event}}
This event is triggered when a physical [[element]] leaves a [[colshape]].


==Syntax==  
==Parameters==
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
void onClientColShapeLeave ( entity theEntity, bool matchingDimension )
element theElement, bool matchingDimension
</syntaxhighlight>  
</syntaxhighlight>
*'''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==  
==Example==  
This example outputs "Out." to the chatbox whenever a local user leaves a collision shape.
This example outputs "Out." to the chatbox whenever the local user leaves a collision shape.
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
function onClientColShapeLeave( theEntity, matchingDimension )
function onClientColShapeLeave( theElement, matchingDimension )
     if ( theEntity == getLocalPlayer() ) then  --Checks whether the leaving entity is the local player
     if ( theElement == localPlayer ) then  -- Checks whether the leaving element is the local player
         outputChatBox( "Out." )  --Outputs.
         outputChatBox( "Out." )  --Outputs.
     end
     end
end
end
addEventHandler("onClientColShapeLeave", root, onClientColShapeLeave)
</syntaxhighlight>
</syntaxhighlight>
[[pl:onClientColShapeLeave]]
==See Also==
===Client colshape events===
{{Client_colshape_events}}
===Client event functions===
{{Client_event_functions}}

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



Retrieved from "https://wiki.multitheftauto.com/wiki/OnClientColShapeLeave?oldid=54478"