OnClientColShapeHit: Difference between revisions
Jump to navigation
Jump to search
Black Dragon (talk | contribs) mNo edit summary |
No edit summary |
||
| Line 1: | Line 1: | ||
__NOTOC__ | {{Client event}} | ||
This event triggers whenever an element enters a collision shape. | __NOTOC__ | ||
This event triggers whenever an element (a player, a vehicle...) enters a collision shape. | |||
== | ==Parameters== | ||
<syntaxhighlight lang="lua"> | <syntaxhighlight lang="lua"> | ||
element theElement, bool matchingDimension | |||
</syntaxhighlight> | </syntaxhighlight> | ||
*'''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== | ==Example== | ||
This example outputs "In." to the chatbox whenever a local user enters a collision shape. | This example outputs "In." to the chatbox whenever a local user enters a collision shape. | ||
<syntaxhighlight lang="lua"> | <syntaxhighlight lang="lua"> | ||
function onClientColShapeHit( | function onClientColShapeHit( theElement, matchingDimension ) | ||
if ( | if ( theElement == getLocalPlayer() ) then -- Checks whether the entering element is the local player | ||
outputChatBox( "In." ) --Outputs. | outputChatBox( "In." ) --Outputs. | ||
end | end | ||
end | end | ||
</syntaxhighlight> | </syntaxhighlight> | ||
Revision as of 17:01, 30 December 2007
This event triggers whenever an element (a player, a vehicle...) enters a collision shape.
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