OnColShapeHit: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
|||
Line 1: | Line 1: | ||
__NOTOC__ | |||
{{Server event}} | |||
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. | |||
==Parameters== | |||
<syntaxhighlight lang="lua"> | |||
element hitElement, bool matchingDimension | |||
</syntaxhighlight> | |||
*'''hitElement''': 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== | |||
The [[event system#Event source|source]] of this event is the [[colshape]] that got hit by a player or vehicle. | |||
==Example== | |||
This example creates a hill area for a ''King of the hill'' gamemode. When a player enters or leaves the area, it's announced in the chatbox. | |||
<syntaxhighlight lang="lua"> | |||
-- create our hill area for our gamemode | |||
local hillArea = createColRectangle ( -2171.0678710938, 678.17950439453, 15, 15 ) | |||
-- add hill_Enter as a handler for when a player enters the hill area | |||
function hill_Enter ( thePlayer, matchingDimension ) | |||
if getElementType ( thePlayer ) == "player" then --if the element that entered was player | |||
--let's get the name of the player | |||
local nameOfThePlayer = getPlayerName ( thePlayer ) | |||
--announce to everyone that the player entered the hill | |||
outputChatBox ( nameOfThePlayer.." entered the zone!", getRootElement(), 255, 255, 109 ) | |||
end | |||
end | |||
addEventHandler ( "onColShapeHit", hillArea, hill_Enter ) | |||
-- add hill_Enter as a handler for when a player leaves the hill area | |||
function hill_Exit ( thePlayer, matchingDimension ) | |||
if getElementType ( thePlayer ) == "player" then --if the element that left was player | |||
--check if the player is not dead | |||
if isPlayerDead ( thePlayer ) ~= true then | |||
--let's get the name of the player | |||
local nameOfThePlayer = getPlayerName ( thePlayer ) | |||
--if he was alive, announce to everyone that the player has left the hill | |||
outputChatBox ( nameOfThePlayer.." left the zone!", getRootElement(), 255, 255, 109 ) | |||
end | |||
end | |||
end | |||
addEventHandler ( "onColShapeLeave", hillArea, hill_Exit ) | |||
</syntaxhighlight> | |||
{{See also/Server event|Colshape events}} |
Revision as of 14:07, 27 May 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.
Parameters
element hitElement, bool matchingDimension
- hitElement: 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
The source of this event is the colshape that got hit by a player or vehicle.
Example
This example creates a hill area for a King of the hill gamemode. When a player enters or leaves the area, it's announced in the chatbox.
-- create our hill area for our gamemode local hillArea = createColRectangle ( -2171.0678710938, 678.17950439453, 15, 15 ) -- add hill_Enter as a handler for when a player enters the hill area function hill_Enter ( thePlayer, matchingDimension ) if getElementType ( thePlayer ) == "player" then --if the element that entered was player --let's get the name of the player local nameOfThePlayer = getPlayerName ( thePlayer ) --announce to everyone that the player entered the hill outputChatBox ( nameOfThePlayer.." entered the zone!", getRootElement(), 255, 255, 109 ) end end addEventHandler ( "onColShapeHit", hillArea, hill_Enter ) -- add hill_Enter as a handler for when a player leaves the hill area function hill_Exit ( thePlayer, matchingDimension ) if getElementType ( thePlayer ) == "player" then --if the element that left was player --check if the player is not dead if isPlayerDead ( thePlayer ) ~= true then --let's get the name of the player local nameOfThePlayer = getPlayerName ( thePlayer ) --if he was alive, announce to everyone that the player has left the hill outputChatBox ( nameOfThePlayer.." left the zone!", getRootElement(), 255, 255, 109 ) end end end addEventHandler ( "onColShapeLeave", hillArea, hill_Exit )
See Also
Colshape events
Event functions
- addEvent
- addEventHandler
- cancelEvent
- cancelLatentEvent
- getEventHandlers
- getLatentEventHandles
- getLatentEventStatus
- removeEventHandler
- triggerEvent
- wasEventCancelled