Revision Difference
Vector:DistToSqr#512396
<function name="DistToSqr" parent="Vector" type="classfunc">⤶
<description>Returns the squared distance of 2 vectors, this is faster than <page>Vector:Distance</page> as calculating the square root is an expensive process.</description>⤶
<realm>Shared</realm>⤶
<args>⤶
<arg name="otherVec" type="Vector">The vector to calculate the distance to.</arg>⤶
</args>⤶
<rets>⤶
<ret name="" type="number">Squared distance to the vector</ret>⤶
</rets>⤶
</function>⤶
⤶
<example>⤶
<description>Checks if a player is within `dist` units of another player in the most efficient way possible.</description>⤶
<code>⤶
function PlayerWithinBounds(ply,otherPly, dist)⤶
return ply:GetPos():DistToSqr(otherPly:GetPos()) &lt; (dist*dist)⤶
-- This is computationally faster than:⤶
-- ply:GetPos():Distance(otherPly:GetPos()) &lt; dist⤶
end⤶
print(PlayerWithinBounds(Entity(1),Entity(2),500))⤶
</code>⤶
<output>true</output>⤶
⤶
</example>