OnColShapeHit: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
No edit summary
Line 1: Line 1:
__NOTOC__  
__NOTOC__  
This event is triggered when the player hits a [[colshape]].
{{Server event}}
This event is triggered when the player or a vehicle hits a [[colshape]].


==Syntax==  
==Syntax==  
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
void onColShapeHit ( element hitElement, bool matchingDimension
element hitElement, bool matchingDimension
</syntaxhighlight>  
</syntaxhighlight>  


==Parameters==
==Parameters==
*The '''source''' of this event refers to the [[colshape]] which was hit by the element.
*'''hitElement''': the [[element]] that entered the colshape.
*'''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.
*'''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==  
==Example==  

Revision as of 04:07, 30 December 2007

This event is triggered when the player or a vehicle hits a colshape.

Syntax

element hitElement, bool matchingDimension

Parameters

  • 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 = 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