OnColShapeHit: Difference between revisions
Jump to navigation
Jump to search
mNo edit summary |
mNo edit summary |
||
Line 8: | Line 8: | ||
==Parameters== | ==Parameters== | ||
* The source of this event refers to the | *The '''source''' of this event refers to the [[colshape]] which was hit by the player. | ||
*'''thePlayer''': | *'''thePlayer''': a [[player]] element referring to the player who entered the colshape. | ||
*'''matchingDimension''': | *'''matchingDimension''': a boolean referring to whether the hit collision shape was in the same dimension as the player. | ||
==Example== | ==Example== | ||
This example creates a hill area for a | 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"> | <syntaxhighlight lang="lua"> | ||
hillArea = createColSquare ( -2171.0678710938, 678.17950439453, 0, 15, 15 ) | -- create our hill area for our gamemode | ||
local hillArea = createColSquare ( -2171.0678710938, 678.17950439453, 0, 15, 15 ) | |||
addEventHandler ( "onColShapeHit", hillArea, "hill_Enter" ) | -- add hill_Enter as a handler for when a player enters the hill area | ||
function hill_Enter ( thePlayer, matchingDimension ) | addEventHandler ( "onColShapeHit", hillArea, "hill_Enter" ) | ||
function hill_Enter ( thePlayer, matchingDimension ) | |||
--announce to everyone that the player entered the hill | |||
outputChatBox( getClientName(thePlayer).." entered the zone!", getRootElement(),255, 255, 109, ) | |||
end | end | ||
-- add hill_Enter as a handler for when a player leaves the hill area | |||
addEventHandler ( "onColShapeLeave", hillArea, "hill_Exit" ) | addEventHandler ( "onColShapeLeave", hillArea, "hill_Exit" ) | ||
function hill_Exit ( thePlayer, matchingDimension ) | function hill_Exit ( thePlayer, matchingDimension ) | ||
--check if the player is not dead | |||
if isPlayerDead ( thePlayer ) ~= true then | |||
--if he was alive, announce to everyone that the player has left the hill | |||
outputChatBox ( getClientName(thePlayer).." left the zone!", getRootElement(), 255, 255, 109 ) | |||
end | |||
end | end | ||
</syntaxhighlight> | </syntaxhighlight> |
Revision as of 19:40, 22 April 2007
This event is triggered when the player hits a colshape.
Syntax
void onColShapeHit ( player thePlayer, bool matchingDimension )
Parameters
- The source of this event refers to the colshape which was hit by the player.
- thePlayer: a player element referring to the player who entered the colshape.
- matchingDimension: a boolean referring to whether the hit collision shape was in the same dimension as the player.
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 = createColSquare ( -2171.0678710938, 678.17950439453, 0, 15, 15 ) -- add hill_Enter as a handler for when a player enters the hill area addEventHandler ( "onColShapeHit", hillArea, "hill_Enter" ) function hill_Enter ( thePlayer, matchingDimension ) --announce to everyone that the player entered the hill outputChatBox( getClientName(thePlayer).." entered the zone!", getRootElement(),255, 255, 109, ) end -- add hill_Enter as a handler for when a player leaves the hill area addEventHandler ( "onColShapeLeave", hillArea, "hill_Exit" ) function hill_Exit ( thePlayer, matchingDimension ) --check if the player is not dead if isPlayerDead ( thePlayer ) ~= true then --if he was alive, announce to everyone that the player has left the hill outputChatBox ( getClientName(thePlayer).." left the zone!", getRootElement(), 255, 255, 109 ) end end
See Also
- addEvent
- addEventHandler
- cancelEvent
- cancelLatentEvent
- getEventHandlers
- getLatentEventHandles
- getLatentEventStatus
- removeEventHandler
- triggerEvent
- wasEventCancelled