OnClientColShapeHit: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
mNo edit summary
 
(5 intermediate revisions by 3 users not shown)
Line 2: Line 2:
__NOTOC__
__NOTOC__
This event is triggered when a physical [[element]] hits a [[colshape]].
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.}}
'''NOTE''': The hit won't be detected if the [[element]] that entered the colshape is a colshape or projectile.


==Parameters==
==Parameters==
Line 9: Line 8:
element theElement, bool matchingDimension
element theElement, bool matchingDimension
</syntaxhighlight>
</syntaxhighlight>
*'''theElement:''' the element that entered the colshape.
*'''theElement:''' the [[element]] that entered the [[colshape]].
*'''matchingDimension:''' ''true'' if theElement is in the same dimension as the colshape, ''false'' otherwise.
*'''matchingDimension:''' a [[boolean]] referring to whether the hit collision shape was in the same [[dimension]] as the element.


==Source==
==Source==
Line 28: Line 27:
This example outputs to the chatbox if the local user is in the same dimension as the collision shape or not.
This example outputs to the chatbox if the local user is in the same dimension as the collision shape or not.
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
myZone = createColSphere (2490, -1668, 12.5, 25)
myZone = createColSphere (2490, -1668, 12.5, 25) -- Creates a collision sphere.


function dimensionChecker (hitElement, matchingDimension)
function dimensionChecker (theElement, matchingDimension)
     if matchingDimension then -- Checks whether the entering element is in the same dimension as the collision shape.
     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.")
         outputChatBox ("The element is in the same dimension.")
Line 37: Line 36:
     end
     end
end
end
addEventHandler( "onClientColShapeHit", myZone, dimensionChecker)
addEventHandler ("onClientColShapeHit", myZone, dimensionChecker)
</syntaxhighlight>
</syntaxhighlight>



Latest revision as of 06:33, 24 June 2019

This event is triggered when a physical element hits a colshape.

[[{{{image}}}|link=|]] 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

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

Example

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)

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

Client colshape events


Client event functions