OnColShapeLeave: Difference between revisions
Jump to navigation
Jump to search
m (→Variables) |
No edit summary |
||
| (7 intermediate revisions by 7 users not shown) | |||
| Line 1: | Line 1: | ||
__NOTOC__ | __NOTOC__ | ||
This event is triggered when a player leaves a collision shape. | {{Server event}} | ||
This event is triggered when a player or a vehicle leaves a collision shape. | |||
== | ==Parameters== | ||
<syntaxhighlight lang="lua"> | <syntaxhighlight lang="lua"> | ||
element leaveElement, bool matchingDimension | |||
</syntaxhighlight> | </syntaxhighlight> | ||
*'''leaveElement''': The [[element]] that who exited the col shape. This can be a player or a vehicle. | |||
*'''matchingDimension''': a [[boolean]] referring to whether the collision shape was in the same [[dimension]] as the element. | |||
== | ==Source== | ||
The [[event system#Event source|source]] of this event is the [[colshape]] that the element no longer is in contact with. | |||
==Example== | ==Example== | ||
This example kills the player whenever they leave a certain collision shape: | This example kills the player whenever they leave a certain collision shape: | ||
<syntaxhighlight lang="lua"> | <syntaxhighlight lang="lua"> | ||
jailZone = createColCircle ( 1024, 1024, 15 | local jailZone = createColCircle ( 1024, 1024, 15 ) -- create a collision shape | ||
-- call 'jailZoneLeave' whenever a player leaves the collision shape: | -- call 'jailZoneLeave' whenever a player leaves the collision shape: | ||
function jailZoneLeave ( thePlayer ) | function jailZoneLeave ( thePlayer ) | ||
killPlayer ( thePlayer ) -- kill the player | if getElementType ( thePlayer ) == "player" then -- if the element that left was player | ||
killPlayer ( thePlayer ) -- kill the player | |||
outputChatBox ( "You are not allowed to leave the jail!", thePlayer ) | |||
end | |||
end | end | ||
addEventHandler ( "onColShapeLeave", jailZone, jailZoneLeave ) | |||
</syntaxhighlight> | </syntaxhighlight> | ||
{{See also/Server event|Colshape events}} | |||
{{ | |||
Latest revision as of 02:55, 27 September 2018
This event is triggered when a player or a vehicle leaves a collision shape.
Parameters
element leaveElement, bool matchingDimension
- leaveElement: The element that who exited the col shape. This can be a player or a vehicle.
- matchingDimension: a boolean referring to whether the collision shape was in the same dimension as the element.
Source
The source of this event is the colshape that the element no longer is in contact with.
Example
This example kills the player whenever they leave a certain collision shape:
local jailZone = createColCircle ( 1024, 1024, 15 ) -- create a collision shape
-- call 'jailZoneLeave' whenever a player leaves the collision shape:
function jailZoneLeave ( thePlayer )
if getElementType ( thePlayer ) == "player" then -- if the element that left was player
killPlayer ( thePlayer ) -- kill the player
outputChatBox ( "You are not allowed to leave the jail!", thePlayer )
end
end
addEventHandler ( "onColShapeLeave", jailZone, jailZoneLeave )
See Also
Colshape events
Event functions
- addEvent
- addEventHandler
- cancelEvent
- cancelLatentEvent
- getEventHandlers
- getLatentEventHandles
- getLatentEventStatus
- removeEventHandler
- triggerEvent
- wasEventCancelled