IsInsideColShape: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
m (→‎Syntax: consistency)
Line 5: Line 5:
==Syntax==  
==Syntax==  
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
bool isInsideColShape( colshape theShape, float posX, float posY, float posZ )
bool isInsideColShape ( colshape theShape, float posX, float posY, float posZ )
</syntaxhighlight>  
</syntaxhighlight>  
{{OOP||[[colshape]]:isInside}}
{{OOP||[[colshape]]:isInside}}

Revision as of 19:51, 9 July 2018

This function checks if a 3D position is inside a colshape or not.

Syntax

bool isInsideColShape ( colshape theShape, float posX, float posY, float posZ )

OOP Syntax Help! I don't understand this!

Method: colshape:isInside(...)


Required Arguments

  • theShape: The colshape you're checking the position against.
  • posX: The X coordinate of the position you're checking.
  • posY: The Y coordinate of the position you're checking.
  • posZ: The Z coordinate of the position you're checking.

Returns

Returns true if the position is inside the colshape, false if it isn't or if any parameters are invalid.

Example

This function checks if an element is within a colshape.

function isElementInsideColShape( theElement, theColShape )
    return isInsideColShape( theColShape, getElementPosition( theElement ) )
end

See Also