OnClientColShapeHit

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)

This example outputs to the chatbox if the local user is in the same dimension as the collision shape or not.

myZone = createColSphere (2490, -1668, 12.5, 25)

function dimensionChecker (hitElement, matchingDimension)
    if matchingDimension then -- Checks whether the entering element is in the same dimension as the collision shape.
        outputChatBox ("The element is in the same dimension.")
    else
        outputChatBox ("The element is not in the same dimension.")
    end
end
addEventHandler( "onClientColShapeHit", myZone, dimensionChecker)

See Also

Client colshape events

• onClientColShapeHit
• onClientColShapeLeave

Client event functions

• triggerLatentServerEvent
• triggerServerEvent


• Shared
• addEvent
• addEventHandler
• cancelEvent
• cancelLatentEvent
• getEventHandlers
• getLatentEventHandles
• getLatentEventStatus
• removeEventHandler
• triggerEvent
• wasEventCancelled