GetDistanceBetweenPoints2D - Revision history

Qaisjp: prefer normal note

2019-09-07T08:30:43Z

prefer normal note

← Older revision		Revision as of 08:30, 7 September 2019
Line 1:		Line 1:
	__NOTOC__		__NOTOC__
	{{Server client function}}		{{Server client function}}{{Note\|This function is equivalent to the [[Vector2]] class ''getLength'' method when used with a vector that holds the direction and distance between two points. In other words, it produces exactly the same result as substracting the points' coordinates and getting the length of the result vector.}}
	{{Note ~~box~~\|This function is equivalent to the [[Vector2]] class ''getLength'' method when used with a vector that holds the direction and distance between two points. In other words, it produces exactly the same result as substracting the points' coordinates and getting the length of the result vector.}}

	This function returns the distance between two 2 dimensional points using the pythagorean theorem.		This function returns the distance between two 2 dimensional points using the pythagorean theorem.

Arran Fortuna: /* Example */

2018-11-05T17:27:30Z

Example

← Older revision		Revision as of 17:27, 5 November 2018
Line 24:		Line 24:
	vehicle2x, vehicle2y, vehicle2z = getElementPosition ( vehicle2 )		vehicle2x, vehicle2y, vehicle2z = getElementPosition ( vehicle2 )
	outputChatBox ( "The map distance between vehicle1 and vehicle2 is ", getDistanceBetweenPoints2D ( vehicle1x, vehicle1y, vehicle2x, vehicle2y ) )		outputChatBox ( "The map distance between vehicle1 and vehicle2 is ", getDistanceBetweenPoints2D ( vehicle1x, vehicle1y, vehicle2x, vehicle2y ) )
			</syntaxhighlight>
			</section>

			<section name="Server and client" class="both" show="true">
			This example shows the maths behind getting the distance between points and is also more efficient if your script is calling this function extremely often.
			<syntaxhighlight lang="lua">
			math.sqrt((p2x - p1x) * (p2x - p1x) + (p2y - p1y) * (p2y - p1y))
	</syntaxhighlight>		</syntaxhighlight>
	</section>		</section>

AlexTMjugador: Added note about Vector2:getLength() equivalence

2016-04-27T14:45:40Z

Added note about Vector2:getLength() equivalence

← Older revision		Revision as of 14:45, 27 April 2016
Line 1:		Line 1:
			__NOTOC__
	{{Server client function}}		{{Server client function}}
	~~__NOTOC__~~		{{Note box\|This function is equivalent to the [[Vector2]] class ''getLength'' method when used with a vector that holds the direction and distance between two points. In other words, it produces exactly the same result as substracting the points' coordinates and getting the length of the result vector.}}

	This function returns the distance between two 2 dimensional points using the pythagorean theorem.		This function returns the distance between two 2 dimensional points using the pythagorean theorem.

Sebassje at 19:08, 7 July 2010

2010-07-07T19:08:47Z

← Older revision		Revision as of 19:08, 7 July 2010
Line 4:		Line 4:

	==Syntax==		==Syntax==
	~~<section name="Server and client" class="both" show="true">~~
	<syntaxhighlight lang="lua">float getDistanceBetweenPoints2D ( float x1, float y1, float x2, float y2 )</syntaxhighlight>		<syntaxhighlight lang="lua">float getDistanceBetweenPoints2D ( float x1, float y1, float x2, float y2 )</syntaxhighlight>

Line 15:		Line 14:
	===Returns===		===Returns===
	Returns a float containing the 2D distance between the two points. Returns ''false'' if invalid parameters are passed.		Returns a float containing the 2D distance between the two points. Returns ''false'' if invalid parameters are passed.
	~~</section>~~

	==Example==		==Example==

Jbeta at 15:42, 16 September 2007

2007-09-16T15:42:33Z

← Older revision		Revision as of 15:42, 16 September 2007
Line 14:		Line 14:

	===Returns===		===Returns===
	Returns a [[float]] containing the 2D distance between the two points. Returns ''false'' if invalid parameters are passed.		Returns a float containing the 2D distance between the two points. Returns ''false'' if invalid parameters are passed.
	</section>		</section>

Jbeta: Changed template, added sections

2007-09-16T15:41:03Z

Changed template, added sections

← Older revision		Revision as of 15:41, 16 September 2007
Line 1:		Line 1:
	{{Server function}}		{{Server client function}}
	__NOTOC__		__NOTOC__
	This function returns the distance between two 2 dimensional points using the pythagorean theorem.		This function returns the distance between two 2 dimensional points using the pythagorean theorem.

	==Syntax==		==Syntax==
			<section name="Server and client" class="both" show="true">
	<syntaxhighlight lang="lua">float getDistanceBetweenPoints2D ( float x1, float y1, float x2, float y2 )</syntaxhighlight>		<syntaxhighlight lang="lua">float getDistanceBetweenPoints2D ( float x1, float y1, float x2, float y2 )</syntaxhighlight>

Line 14:		Line 15:
	===Returns===		===Returns===
	Returns a [[float]] containing the 2D distance between the two points. Returns ''false'' if invalid parameters are passed.		Returns a [[float]] containing the 2D distance between the two points. Returns ''false'' if invalid parameters are passed.
			</section>

	==Example==		==Example==
			<section name="Server and client" class="both" show="true">
	This example gets the distance between two vehicles, stored in variables ''vehicle1'' and ''vehicle2''.		This example gets the distance between two vehicles, stored in variables ''vehicle1'' and ''vehicle2''.
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
Line 22:		Line 25:
	outputChatBox ( "The map distance between vehicle1 and vehicle2 is ", getDistanceBetweenPoints2D ( vehicle1x, vehicle1y, vehicle2x, vehicle2y ) )		outputChatBox ( "The map distance between vehicle1 and vehicle2 is ", getDistanceBetweenPoints2D ( vehicle1x, vehicle1y, vehicle2x, vehicle2y ) )
	</syntaxhighlight>		</syntaxhighlight>
			</section>

	==See Also==		==See Also==
	{{Utility functions}}		{{Utility functions}}

Arc at 15:21, 20 August 2007

2007-08-20T15:21:12Z

← Older revision		Revision as of 15:21, 20 August 2007
Line 1:		Line 1:
			{{Server function}}
	__NOTOC__		__NOTOC__
	This function returns the distance between two 2 dimensional points using the pythagorean theorem.		This function returns the distance between two 2 dimensional points using the pythagorean theorem.
Line 16:		Line 17:
	==Example==		==Example==
	This example gets the distance between two vehicles, stored in variables ''vehicle1'' and ''vehicle2''.		This example gets the distance between two vehicles, stored in variables ''vehicle1'' and ''vehicle2''.
	<syntaxhighlight lang="lua">vehicle1x, vehicle1y, vehicle1z = getElementPosition ( vehicle1 )		<syntaxhighlight lang="lua">
			vehicle1x, vehicle1y, vehicle1z = getElementPosition ( vehicle1 )
	vehicle2x, vehicle2y, vehicle2z = getElementPosition ( vehicle2 )		vehicle2x, vehicle2y, vehicle2z = getElementPosition ( vehicle2 )
	outputChatBox ( "The map distance between vehicle1 and ~~vehicl2~~ is ", getDistanceBetweenPoints2D ( vehicle1x, vehicle1y, vehicle2x, vehicle2y ) )</syntaxhighlight>		outputChatBox ( "The map distance between vehicle1 and vehicle2 is ", getDistanceBetweenPoints2D ( vehicle1x, vehicle1y, vehicle2x, vehicle2y ) )
			</syntaxhighlight>

	==See Also==		==See Also==
	{{Utility functions}}		{{Utility functions}}

EAi at 14:25, 14 August 2006

2006-08-14T14:25:43Z

← Older revision		Revision as of 14:25, 14 August 2006
Line 3:		Line 3:

	==Syntax==		==Syntax==
	<syntaxhighlight lang="lua">getDistanceBetweenPoints2D ( float x1, float y1, float x2, float y2 )</syntaxhighlight>		<syntaxhighlight lang="lua">float getDistanceBetweenPoints2D ( float x1, float y1, float x2, float y2 )</syntaxhighlight>

	===Required Arguments===		===Required Arguments===

EAi at 14:25, 14 August 2006

2006-08-14T14:25:03Z

← Older revision		Revision as of 14:25, 14 August 2006
Line 1:		Line 1:
	__NOTOC__		__NOTOC__
	~~==Description==~~
	This function returns the distance between two 2 dimensional points using the pythagorean theorem.		This function returns the distance between two 2 dimensional points using the pythagorean theorem.

	==Syntax==		==Syntax==
	<syntaxhighlight lang="lua">getDistanceBetweenPoints2D ( x1, y1, x2, y2 )</syntaxhighlight>		<syntaxhighlight lang="lua">getDistanceBetweenPoints2D ( float x1, float y1, float x2, float y2 )</syntaxhighlight>

	===Required Arguments===		===Required Arguments===

	* '''x1''': The X position of the first point		* '''x1''': The X position of the first point
	* '''y1''': The Y position of the first point		* '''y1''': The Y position of the first point
	* '''x2''': The X position of the second point		* '''x2''': The X position of the second point
	* '''y2''': The Y position of the second point		* '''y2''': The Y position of the second point

			===Returns===
			Returns a [[float]] containing the 2D distance between the two points. Returns ''false'' if invalid parameters are passed.

	==Example==		==Example==
	<syntaxhighlight lang="lua">~~vehiclex~~, ~~vehicley~~, ~~vehiclez~~ = ~~getVehiclePosition~~ ( ~~vehicle~~ )		This example gets the distance between two vehicles, stored in variables ''vehicle1'' and ''vehicle2''.
	vehicle2x, vehicle2y, vehicle2z = ~~getVehiclePosition~~ ( vehicle2 )		<syntaxhighlight lang="lua">vehicle1x, vehicle1y, vehicle1z = getElementPosition ( vehicle1 )
	outputChatBox ( "The map distance between ~~vehicle~~ and vehicl2 is ", getDistanceBetweenPoints2D ( ~~vehiclex~~, ~~vehicley~~, vehicle2x, vehicle2y ) )</syntaxhighlight>		vehicle2x, vehicle2y, vehicle2z = getElementPosition ( vehicle2 )
			outputChatBox ( "The map distance between vehicle1 and vehicl2 is ", getDistanceBetweenPoints2D ( vehicle1x, vehicle1y, vehicle2x, vehicle2y ) )</syntaxhighlight>

	==See Also==		==See Also==
	{{Utility functions}}		{{Utility functions}}

Ransom at 20:26, 20 May 2006

2006-05-20T20:26:02Z

← Older revision		Revision as of 20:26, 20 May 2006
Line 17:		Line 17:
	vehicle2x, vehicle2y, vehicle2z = getVehiclePosition ( vehicle2 )		vehicle2x, vehicle2y, vehicle2z = getVehiclePosition ( vehicle2 )
	outputChatBox ( "The map distance between vehicle and vehicl2 is ", getDistanceBetweenPoints2D ( vehiclex, vehicley, vehicle2x, vehicle2y ) )</syntaxhighlight>		outputChatBox ( "The map distance between vehicle and vehicl2 is ", getDistanceBetweenPoints2D ( vehiclex, vehicley, vehicle2x, vehicle2y ) )</syntaxhighlight>

			==See Also==
			{{Utility functions}}