OnClientColShapeHit: Difference between revisions
Jump to navigation
Jump to search
m (Reverted edits by Sukinsyn (talk) to last revision by ThePiotrek) |
Zangomangu (talk | contribs) mNo edit summary |
||
| Line 1: | Line 1: | ||
{{Client event}} | {{Client event}} | ||
__NOTOC__ | __NOTOC__ | ||
This event is triggered when | This event is triggered when a physical [[element]] hits a [[colshape]]. | ||
'''NOTE''': The hit won't be detected if the [[element]] that entered the colshape is a colshape or projectile. | '''NOTE''': The hit won't be detected if the [[element]] that entered the colshape is a colshape or projectile. | ||
| Line 16: | Line 16: | ||
==Example== | ==Example== | ||
This example outputs "In." to the chatbox whenever | This example outputs "In." to the chatbox whenever the local user enters a collision shape. | ||
<syntaxhighlight lang="lua"> | <syntaxhighlight lang="lua"> | ||
function onClientColShapeHit( theElement, matchingDimension ) | function onClientColShapeHit( theElement, matchingDimension ) | ||
if ( theElement == | if ( theElement == localPlayer ) then -- Checks whether the entering element is the local player | ||
outputChatBox( "In." ) --Outputs. | outputChatBox( "In." ) --Outputs. | ||
end | end | ||
end | end | ||
addEventHandler("onClientColShapeHit", | addEventHandler("onClientColShapeHit", root, onClientColShapeHit) | ||
</syntaxhighlight> | </syntaxhighlight> | ||
Revision as of 17:23, 31 August 2017
This event is triggered when a physical element hits a colshape.
NOTE: The hit won't be detected if the element that entered the colshape is a colshape or projectile.
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 the local user enters a collision shape.
function onClientColShapeHit( theElement, matchingDimension )
if ( theElement == localPlayer ) then -- Checks whether the entering element is the local player
outputChatBox( "In." ) --Outputs.
end
end
addEventHandler("onClientColShapeHit", root, onClientColShapeHit)
See Also
Client colshape events
Client event functions
- addEvent
- addEventHandler
- cancelEvent
- cancelLatentEvent
- getEventHandlers
- getLatentEventHandles
- getLatentEventStatus
- removeEventHandler
- triggerEvent
- triggerLatentServerEvent
- triggerServerEvent
- wasEventCancelled