OnClientColShapeHit: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
m (Reverted edits by Sukinsyn (talk) to last revision by ThePiotrek) |
||
Line 1: | Line 1: | ||
{{Client event}} | |||
__NOTOC__ | |||
This event is triggered when an 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== | |||
<syntaxhighlight lang="lua"> | |||
element theElement, bool matchingDimension | |||
</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== | |||
This example outputs "In." to the chatbox whenever a local user enters a collision shape. | |||
<syntaxhighlight lang="lua"> | |||
function onClientColShapeHit( theElement, matchingDimension ) | |||
if ( theElement == getLocalPlayer() ) then -- Checks whether the entering element is the local player | |||
outputChatBox( "In." ) --Outputs. | |||
end | |||
end | |||
addEventHandler("onClientColShapeHit",getRootElement(),onClientColShapeHit) | |||
</syntaxhighlight> | |||
[[pl:onClientColShapeHit]] | |||
==See Also== | |||
===Client colshape events=== | |||
{{Client_colshape_events}} | |||
===Client event functions=== | |||
{{Client_event_functions}} |
Revision as of 14:07, 27 May 2017
This event is triggered when an 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 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 addEventHandler("onClientColShapeHit",getRootElement(),onClientColShapeHit)
See Also
Client colshape events
Client event functions
- triggerLatentServerEvent
- triggerServerEvent
- Shared
- addEvent
- addEventHandler
- cancelEvent
- cancelLatentEvent
- getEventHandlers
- getLatentEventHandles
- getLatentEventStatus
- removeEventHandler
- triggerEvent
- wasEventCancelled