Mirrors/phaser
2
0
Fork 0
mirror of https://github.com/photonstorm/phaser synced 2024-11-26 22:52:14 +00:00
Code Issues Projects Releases Packages Wiki Activity

Docs: correct GetShortestDistance()

Browse source 
Fixes #6322
This commit is contained in:
samme 2022-12-17 06:59:53 -08:00
parent da96b39179
commit 868c299c62
1 changed files with 2 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

6
src/geom/line/GetShortestDistance.js
View file

@ -11,12 +11,10 @@
* @function Phaser.Geom.Line.GetShortestDistance * @function Phaser.Geom.Line.GetShortestDistance
* @since 3.16.0 * @since 3.16.0
* *
* @generic {Phaser.Geom.Point} O - [out,$return]
*
* @param {Phaser.Geom.Line} line - The line to get the distance from. * @param {Phaser.Geom.Line} line - The line to get the distance from.
* @param {(Phaser.Geom.Point|object)} point - The point to get the shortest distance to. * @param {Phaser.Types.Math.Vector2Like} point - The point to get the shortest distance to.
* *
* @return {number} The shortest distance from the line to the point. * @return {(boolean|number)} The shortest distance from the line to the point, or `false`.
*/ */
var GetShortestDistance = function (line, point) var GetShortestDistance = function (line, point)
{ {