OnClientColShapeLeave: Difference between revisions
Jump to navigation
Jump to search
ThePiotrek (talk | contribs) mNo edit summary |
Zangomangu (talk | contribs) mNo edit summary |
||
| Line 1: | Line 1: | ||
__NOTOC__ | __NOTOC__ | ||
{{Client event}} | {{Client event}} | ||
This event | This event is triggered when a physical [[element]] leaves a [[colshape]]. | ||
==Parameters== | ==Parameters== | ||
| Line 14: | Line 14: | ||
==Example== | ==Example== | ||
This example outputs "Out." to the chatbox whenever | This example outputs "Out." to the chatbox whenever the local user leaves a collision shape. | ||
<syntaxhighlight lang="lua"> | <syntaxhighlight lang="lua"> | ||
function onClientColShapeLeave( theElement, matchingDimension ) | function onClientColShapeLeave( theElement, matchingDimension ) | ||
if ( theElement == | 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", | addEventHandler("onClientColShapeLeave", root, onClientColShapeLeave) | ||
</syntaxhighlight> | </syntaxhighlight> | ||
Revision as of 17:31, 31 August 2017
This event is triggered when a physical element leaves a colshape.
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 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
- addEvent
- addEventHandler
- cancelEvent
- cancelLatentEvent
- getEventHandlers
- getLatentEventHandles
- getLatentEventStatus
- removeEventHandler
- triggerEvent
- triggerLatentServerEvent
- triggerServerEvent
- wasEventCancelled