isElementWithinColShape | Multi Theft Auto: Wiki Skip to content
Multi Theft Auto: Wiki

isElementWithinColShape

Client-side
Server-side
Shared

Manual Review Required

Please finish this page using the corresponding Old Wiki article. Go to Contribution guidelines for more information.

This function is used to determine if an element is within a collision shape. Please note that for legacy reasons, a colshape created on the client does not collide with elements already existing at that location until they first move. Please also note that before 1.0.3, this did not function correctly when moving a colshape.

OOP Syntax Help! I don't understand this!

  • Method:element:isWithinColShape(...)

Syntax 

bool isElementWithinColShape ( element theElement, colshape theShape )
Required Arguments
  • theElement: The element you're checking.
  • theShape: The colshape you're checking

Returns

  • bool: value

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

Code Examples

shared

This small script is an example of detecting if a player is within a certain defined colshape. This could serve as a base to perform many functions, rather than just an output.

local circlearea = createColCircle ( 0, 0, 10 )


function ColShapeHit ( thePlayer, matchingDimension )
  local detection = isElementWithinColShape ( thePlayer, circlearea )
  --A variable 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.
  detection = detection and getElementDimension( thePlayer ) == getElementDimension( circlearea )
  --Let's additionally check element dimensions.
  if detection then
    outputChatBox ( getPlayerName(thePlayer).." 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
addEventHandler ( "onColShapeHit", root, ColShapeHit )

See Also

Element Functions
Element Events
Reference