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: a boolean referring to whether the hit collision shape was in the same dimension as the element.

Source

element: The source of this event is the colshape that was hit.

Code Examples

Example 1 Example 2

client

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)

client

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) -- Creates a collision sphere.

function dimensionChecker (theElement, 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

Colshape Events

• onClientColShapeHit
• onClientColShapeLeave
• onColShapeHit
• onColShapeLeave

Colshape Functions

• createColCircle
• addColPolygonPoint
• createColCuboid
• createColPolygon
• createColTube
• createColSphere
• getColPolygonHeight
• getColPolygonPointPosition
• createColRectangle
• getColPolygonPoints
• getColShapeRadius
• getColShapeSize
• getColShapeType
• getElementColShape
• getElementsWithinColShape
• isElementWithinColShape
• isInsideColShape
• removeColPolygonPoint
• setColPolygonHeight
• setColPolygonPointPosition
• setColShapeRadius
• setColShapeSize

Reference

• Scripting Events