View source for Vector3:compare

{{Useful Function}}
<lowercasetitle></lowercasetitle>
__NOTOC__
This method checks whether two [[Vector3|vectors]] match (optionally with precision defined).

==Syntax==
<syntaxhighlight lang="lua">
bool Vector3:compare ( Vector3 comparison [ , float precision ] )
</syntaxhighlight>

===Required Arguments=== 
* '''comparison:''' The [[Vector3]] to compare to.

===Optional Arguments=== 
* '''precision:''' A [[float]] representing the precision of the comparison.

===Returns===
A [[boolean]] representing whether the vectors match taking into account the precision.

==Code==
<syntaxhighlight lang="lua">
function Vector3:compare( comparison, precision )
	assert( type( comparison.getLength ) == 'function', "First argument must be a Vector3." )
	assert( not precision or type( precision ) == 'number', "Precision type must be a number, got " .. type( precision ) .. "." )

	if ( not precision ) then
		if ( self:getX( ) ~= comparison:getX( ) ) or
		   ( self:getY( ) ~= comparison:getY( ) ) or
		   ( self:getZ( ) ~= comparison:getZ( ) ) then
			return false
		end
	else
		if ( math.abs( self:getX( ) - comparison:getX( ) ) > precision ) or
		   ( math.abs( self:getY( ) - comparison:getY( ) ) > precision ) or
		   ( math.abs( self:getZ( ) - comparison:getZ( ) ) > precision ) then
			return false
		end
	end

	return true
end
</syntaxhighlight>

==See Also==
{{Useful_Functions}}