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