OnClientElementColShapeLeave: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
No edit summary
 
mNo edit summary
 
(4 intermediate revisions by 4 users not shown)
Line 1: Line 1:
[[Category:Incomplete Event]]
{{Client event}}
 
__NOTOC__  
__NOTOC__  
This event is blahblah and is used for blahblah.
This event is triggered when an element (like a player or vehicle) leaves a collision shape.


==Syntax==  
==Parameters==
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
void onClientElementColShapeLeave ( colshape theShape, bool matchingDimension )
colshape theShape, bool matchingDimension
</syntaxhighlight>  
</syntaxhighlight>
*'''theShape:''' the colshape that the element left.
*'''matchingDimension:''' ''true'' if the element is in the same dimension as the colshape, ''false'' otherwise.
 
==Source==
The source of this event is the element that left the colshape.


==Example==  
==Example==  
This example does...
This example tells player when he/she left any collision shapes that were created.
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
--This line does...
addEventHandler( "onClientElementColShapeLeave", getRootElement( ),
blabhalbalhb --abababa
    function ( )
--This line does this...
        if ( getElementType( source ) == "player" ) and ( source == getLocalPlayer( ) ) then
mooo
            outputChatBox( "You left colshape" );
        end
    end
);
</syntaxhighlight>
</syntaxhighlight>
[[pl:onClientElementColShapeLeave]]
==See Also==
===Client element events===
{{Client_element_events}}
===Client event functions===
{{Client_event_functions}}

Latest revision as of 19:59, 21 July 2016

This event is triggered when an element (like a player or vehicle) leaves a collision shape.

Parameters

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

Source

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

Example

This example tells player when he/she left any collision shapes that were created.

addEventHandler( "onClientElementColShapeLeave", getRootElement( ),
    function ( )
        if ( getElementType( source ) == "player" ) and ( source == getLocalPlayer( ) ) then
            outputChatBox( "You left colshape" );
        end
    end
);

See Also

Client element events


Client event functions