OnElementColShapeHit: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
No edit summary
 
 
(9 intermediate revisions by 7 users not shown)
Line 1: Line 1:
[[Category:Incomplete Event]]
__NOTOC__
{{Server event}}
This event is triggered when an player or vehicle element collides with a colshape.


__NOTOC__
==Parameters==
This event is blahblah and is used for blahblah.
 
==Syntax==  
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
void onElementColShapeHit ( colshape colshape, bool matchingDimension
colshape theColShape, bool matchingDimension
</syntaxhighlight>  
</syntaxhighlight>  
*'''theColShape''': the [[colshape]] that this [[element]] collided with.
*'''matchingDimension''': a [[boolean]] representing if the [[element]] and the [[colshape]] are in the same [[dimension]].
==Source==
The [[event system#Event source|source]] of this event is the [[player]] or [[vehicle]] that collided with the colshape.


==Example==  
==Example==  
This example does...
This example prints type of the element which entered the created colshape to chatbox.
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
--This line does...
colArea = createColCircle( 1400.0, -700.0, 5.0 ) -- create the colshape
blabhalbalhb --abababa
 
--This line does this...
function elementColShapeHit( colShapeHit )
mooo
    if colShapeHit == colArea then -- if element entered the created colshape
        outputChatBox( getElementType( source ) .. " entered the colCircle!" ) -- print the type of the element to chatbox
    end
end
addEventHandler( "onElementColShapeHit", root, elementColShapeHit ) -- add a handler function for the event
</syntaxhighlight>
</syntaxhighlight>
{{See also/Server event|Element events}}

Latest revision as of 14:08, 31 December 2022

This event is triggered when an player or vehicle element collides with a colshape.

Parameters

colshape theColShape, bool matchingDimension

Source

The source of this event is the player or vehicle that collided with the colshape.

Example

This example prints type of the element which entered the created colshape to chatbox.

colArea = createColCircle( 1400.0, -700.0, 5.0 ) -- create the colshape

function elementColShapeHit( colShapeHit )
    if colShapeHit == colArea then -- if element entered the created colshape
        outputChatBox( getElementType( source ) .. " entered the colCircle!" ) -- print the type of the element to chatbox
    end
end
addEventHandler( "onElementColShapeHit", root, elementColShapeHit ) -- add a handler function for the event

See Also

Element events


Event functions