IsElementWithinColShape: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
No edit summary
No edit summary
Line 10: Line 10:


===Returns===
===Returns===
Returns ''true'' if the element is withing the colshape.
Returns ''true'' if the element is within the colshape, false otherwise


==Example==
==Example==
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
addEventHandler ( "onColShapeHit", getRootElement(), "ColShapeHit" )
function ColShapeHit ( player, matchingDimension )
detection = isElementWithinColShape ( player, circlearea )
--A varible called 'detection' stores the result of asking if the player
--who entered a colshape is within the specific colshape called 'circlearea'.
--The result is either true or false.
if detection == true then
outputChatBox ( "Player is in the 'circle area' col shape" )
end
--if detection was true then the player is in the col shape. Output a
--message to confirm this
end
</syntaxhighlight>
</syntaxhighlight>


==See Also==
==See Also==
{{element functions}}
{{element functions}}
[[Category:Incomplete]]

Revision as of 05:55, 11 April 2007

This function is used to tell if an element is within a collision shape.

Syntax

bool isElementWithinColShape ( element theElement, colshape theShape )

Required Arguments

  • theElement: The element you're checking.
  • theShape: The colshape you're checking

Returns

Returns true if the element is within the colshape, false otherwise

Example

addEventHandler ( "onColShapeHit", getRootElement(), "ColShapeHit" )
function ColShapeHit ( player, matchingDimension )
detection = isElementWithinColShape ( player, circlearea )
--A varible called 'detection' stores the result of asking if the player
--who entered a colshape is within the specific colshape called 'circlearea'.
--The result is either true or false.
	if detection == true then
	outputChatBox ( "Player is in the 'circle area' col shape" )
	end
	--if detection was true then the player is in the col shape. Output a
	--message to confirm this
end

See Also


Retrieved from "https://wiki.multitheftauto.com/wiki/IsElementWithinColShape?oldid=7794"