GetWorldFromScreenPosition - Revision history

Pirulax: fixed typo in description (thaft -> that)

2018-07-07T11:16:07Z

fixed typo in description (thaft -> that)

← Older revision		Revision as of 11:16, 7 July 2018
Line 5:		Line 5:
	If you want to detect what element is at a particular point on the screen, use [[processLineOfSight]] between the camera position and the position returned from this function when passed a high depth value (100 or so, depending how far away you want to detect elements at).		If you want to detect what element is at a particular point on the screen, use [[processLineOfSight]] between the camera position and the position returned from this function when passed a high depth value (100 or so, depending how far away you want to detect elements at).

	As expected, setting 0 as the distance will cause the point retrived to be within the camera itself. That means ~~thaf~~ drawing any 3D thing in that point would result in it not being visible. Depending on the camera near clip distance, however, the minimum distance to be able to view it can vary.		As expected, setting 0 as the distance will cause the point retrived to be within the camera itself. That means that drawing any 3D thing in that point would result in it not being visible. Depending on the camera near clip distance, however, the minimum distance to be able to view it can vary.

	==Syntax==		==Syntax==

AlexTMjugador: Tidied up the new note

2015-01-18T10:20:03Z

Tidied up the new note

← Older revision		Revision as of 10:20, 18 January 2015
Line 1:		Line 1:
	__NOTOC__		__NOTOC__
	{{Client function}}		{{Client function}}
	This function allows you to retrieve the world position corresponding to ~~the~~ 2D position on the screen, at a certain depth.		This function allows you to retrieve the world position corresponding to a 2D position on the screen, at a certain depth.

	If you want to detect what element is at a particular point on the screen, use [[processLineOfSight]] between the camera position and the position returned from this function when passed a high depth value (100 or so, depending how far away you want to detect elements at).		If you want to detect what element is at a particular point on the screen, use [[processLineOfSight]] between the camera position and the position returned from this function when passed a high depth value (100 or so, depending how far away you want to detect elements at).

	* Note - setting 0 as a distance will cause the ~~points~~ retrived to be ~~right ontop of~~ the ~~screen, so if used for~~ drawing ~~ideas~~ on the ~~screen - using~~ distance ~~0 (or a very close value to 0~~, ~~will result in~~ the ~~image being not visible)~~.		As expected, setting 0 as the distance will cause the point retrived to be within the camera itself. That means thaf drawing any 3D thing in that point would result in it not being visible. Depending on the camera near clip distance, however, the minimum distance to be able to view it can vary.

	==Syntax==		==Syntax==

HyPeX at 02:09, 18 January 2015

2015-01-18T02:09:16Z

← Older revision		Revision as of 02:09, 18 January 2015
Line 4:		Line 4:

	If you want to detect what element is at a particular point on the screen, use [[processLineOfSight]] between the camera position and the position returned from this function when passed a high depth value (100 or so, depending how far away you want to detect elements at).		If you want to detect what element is at a particular point on the screen, use [[processLineOfSight]] between the camera position and the position returned from this function when passed a high depth value (100 or so, depending how far away you want to detect elements at).

			* Note - setting 0 as a distance will cause the points retrived to be right ontop of the screen, so if used for drawing ideas on the screen - using distance 0 (or a very close value to 0, will result in the image being not visible).

	==Syntax==		==Syntax==

Paul Cortez: It's in pixels, it's not relative.

2008-10-25T11:39:55Z

It's in pixels, it's not relative.

← Older revision		Revision as of 11:39, 25 October 2008
Line 22:		Line 22:
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	function explosion ()		function explosion ()
	local x, y, z = getWorldFromScreenPosition ( ~~0.5~~, ~~0.5~~, 10 )		local w, h = guiGetScreenSize ()
			local x, y, z = getWorldFromScreenPosition ( w/2, h/2, 10 )
	createExplosion ( x, y, z, 11 )		createExplosion ( x, y, z, 11 )
	end		end

EAi at 01:15, 13 November 2007

2007-11-13T01:15:36Z

← Older revision		Revision as of 01:15, 13 November 2007
Line 2:		Line 2:
	{{Client function}}		{{Client function}}
	This function allows you to retrieve the world position corresponding to the 2D position on the screen, at a certain depth.		This function allows you to retrieve the world position corresponding to the 2D position on the screen, at a certain depth.

			If you want to detect what element is at a particular point on the screen, use [[processLineOfSight]] between the camera position and the position returned from this function when passed a high depth value (100 or so, depending how far away you want to detect elements at).

	==Syntax==		==Syntax==

Jbeta at 18:39, 12 November 2007

2007-11-12T18:39:33Z

← Older revision		Revision as of 18:39, 12 November 2007
Line 1:		Line 1:
	__NOTOC__		__NOTOC__
	{{Client function}}		{{Client function}}
	This function allows you to retrieve the world position corresponding to the 2D position on the screen.		This function allows you to retrieve the world position corresponding to the 2D position on the screen, at a certain depth.

	==Syntax==		==Syntax==
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	float float float getWorldFromScreenPosition ( float x, float y, float z )		float, float, float getWorldFromScreenPosition ( float x, float y, float depth )
	</syntaxhighlight>		</syntaxhighlight>

	===Required Arguments===		===Required Arguments===
	*'''x:''' A float value ~~between ? and ?~~ indicating the x position on the screen.		*'''x:''' A float value indicating the x position on the screen, in pixels.
	*'''y:''' A float value ~~between ? and ?~~ indicating the y position on the screen.		*'''y:''' A float value indicating the y position on the screen, in pixels.
	*'''z:''' ?		*'''depth:''' A float value indicating the distance from the camera of the point whose coordinates we are retrieving, in units.

	===Returns===		===Returns===
	Returns three ~~[[float]]s indicating the world position,~~ ''x'', ''y'' ~~and~~ ''z'' ~~respectively~~, ''false'' otherwise.		Returns three ''x'', ''y'', ''z'' [[float]]s indicating the world position if successful, ''false'' otherwise.

	==Example==		==Example==
	This example binds the local player's "'''i'''" key to a function that creates an explosion in the middle of the screen.		This example binds the local player's "'''i'''" key to a function that creates an explosion in the middle of the screen.
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	function explosion ( ~~key, keyState~~ )		function explosion ()
	local x, y, z = getWorldFromScreenPosition ( 0.5, 0.5, ? )		local x, y, z = getWorldFromScreenPosition ( 0.5, 0.5, 10 )
	createExplosion ( x, y, z, 11 )		createExplosion ( x, y, z, 11 )
	end		end
	bindKey ( "i", "down~~", "create explosion~~", explosion )		bindKey ( "i", "down", explosion )
	</syntaxhighlight>		</syntaxhighlight>

	==See Also==		==See Also==
	{{Client_world_functions}}		{{Client_world_functions}}

Norby89 at 14:02, 11 August 2007

2007-08-11T14:02:58Z

← Older revision		Revision as of 14:02, 11 August 2007
Line 9:		Line 9:

	===Required Arguments===		===Required Arguments===
	*'''x:''' A float value between 0 and 1 indicating the x position on the screen.		*'''x:''' A float value between ? and ? indicating the x position on the screen.
	*'''y:''' A float value between 0 and 1 indicating the y position on the screen.		*'''y:''' A float value between ? and ? indicating the y position on the screen.
			*'''z:''' ?

	===Returns===		===Returns===
Line 19:		Line 20:
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	function explosion ( key, keyState )		function explosion ( key, keyState )
	local x, y, z = getWorldFromScreenPosition ( 0.5, 0.5 )		local x, y, z = getWorldFromScreenPosition ( 0.5, 0.5, ? )
	createExplosion ( x, y, z, 11 )		createExplosion ( x, y, z, 11 )
	end		end

Norby89: /* Syntax */

2007-08-11T12:53:50Z

Syntax

← Older revision		Revision as of 12:53, 11 August 2007
Line 5:		Line 5:
	==Syntax==		==Syntax==
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	float float float getWorldFromScreenPosition ( float x, float y )		float float float getWorldFromScreenPosition ( float x, float y, float z )
	</syntaxhighlight>		</syntaxhighlight>

Norby89: /* Example */

2007-08-11T12:33:09Z

Example

← Older revision		Revision as of 12:33, 11 August 2007
Line 19:		Line 19:
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	function explosion ( key, keyState )		function explosion ( key, keyState )
	local x, y, z = getWorldFromScreenPosition ( ~~x, y, z,~~ 0.5, 0.5 )		local x, y, z = getWorldFromScreenPosition ( 0.5, 0.5 )
	createExplosion ( x, y, z, 11 )		createExplosion ( x, y, z, 11 )
	end		end

Norby89 at 12:30, 11 August 2007

2007-08-11T12:30:30Z

← Older revision		Revision as of 12:30, 11 August 2007
Line 1:		Line 1:
	__NOTOC__		__NOTOC__
	{{Client function}}		{{Client function}}
	This function allows you to retrieve the world position ~~coresponding~~ to the 2D position on the screen.		This function allows you to retrieve the world position corresponding to the 2D position on the screen.

	==Syntax==		==Syntax==
Line 9:		Line 9:

	===Required Arguments===		===Required Arguments===
	*'''x:''' A float value between ? and ? indicating the x position on the screen.		*'''x:''' A float value between 0 and 1 indicating the x position on the screen.
	*'''y:''' A float value between ? and ? indicating the y position on the screen.		*'''y:''' A float value between 0 and 1 indicating the y position on the screen.

	===Returns===		===Returns===