GetGroundPosition - Revision history

Fernando187: Fix examples header

2025-06-08T13:46:53Z

Fix examples header

← Older revision		Revision as of 13:46, 8 June 2025
Line 18:		Line 18:
	Returns a float with the highest ground-level Z coord if parameters are valid, ''0'' if the point you tried to test is outside the loaded world map, ''false'' otherwise.		Returns a float with the highest ground-level Z coord if parameters are valid, ''0'' if the point you tried to test is outside the loaded world map, ''false'' otherwise.

	==~~Example~~==		==Examples==
	This clientside function determines if a player is under a ceiling or not.		This clientside function determines if a player is under a ceiling or not.
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
Line 30:		Line 30:
	</syntaxhighlight>		</syntaxhighlight>

	~~==Another example==~~
	This clientside function returns the distance between you and the ground (if there is)		This clientside function returns the distance between you and the ground (if there is)
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">

Tracer: Fixed typo; improved example

2023-12-12T05:23:01Z

Fixed typo; improved example

← Older revision		Revision as of 05:23, 12 December 2023
Line 30:		Line 30:
	</syntaxhighlight>		</syntaxhighlight>

	==Another ~~exmaple~~==		==Another example==
	clientside function returns the distance between you and the ground (if there is)		This clientside function returns the distance between you and the ground (if there is)
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	function getGroundDistance( thePlayer, zHeight )		function getGroundDistance( thePlayer, zHeight )
Line 43:		Line 43:
	-- Some cool examples:		-- Some cool examples:
	addCommandHandler("gdistance",function(_, amount)		addCommandHandler("gdistance",function(_, amount)
	distance = getGroundDistance(localPlayer, tonumber(amount))		local distance = getGroundDistance(localPlayer, tonumber(amount))
	outputChatBox("The distance to reach ground is: " .. distance)		outputChatBox("The distance to reach ground is: " .. distance)
	end)		end)

	addCommandHandler("do_im_flying",function()		addCommandHandler("do_im_flying",function()
	distance = getGroundDistance(localPlayer, 20)		local distance = getGroundDistance(localPlayer, 20)
	if (distance>1) then		if distance > 1 then
	outputChatBox("Superman!! the distance between you and ground is: " .. distance)		outputChatBox("Superman!! the distance between you and ground is: " .. distance)
	else		else

1Lorenzo at 00:51, 12 December 2023

2023-12-12T00:51:22Z

@@ Line 28: / Line 28: @@
 	return getGroundPosition ( px, py, pz ) ~= getGroundPosition ( px, py, pz + 530 )
 end
 </syntaxhighlight>

Tracer: Changed syntax a little bit

2023-02-12T16:21:08Z

Changed syntax a little bit

← Older revision		Revision as of 16:21, 12 February 2023
Line 26:		Line 26:
	--we'll check for ground level at the player's position, and also 500 units over him.		--we'll check for ground level at the player's position, and also 500 units over him.
	--if these ground levels match, it must mean there were no obstacles (such as a ceiling) over the player,		--if these ground levels match, it must mean there were no obstacles (such as a ceiling) over the player,
	if getGroundPosition ( px, py, pz ) == getGroundPosition ( px, py, pz + 530 ) ~~then~~		return getGroundPosition ( px, py, pz ) ~= getGroundPosition ( px, py, pz + 530 )
	~~-- so the player is not under cover~~
	~~return false~~
	~~--otherwise, there was an object over him,~~
	~~else~~
	~~-- so the player is under cover~~
	~~return true~~
	~~end~~
	end		end
	</syntaxhighlight>		</syntaxhighlight>

LordHenry: /* Example */

2019-10-12T22:26:50Z

Example

← Older revision		Revision as of 22:26, 12 October 2019
Line 26:		Line 26:
	--we'll check for ground level at the player's position, and also 500 units over him.		--we'll check for ground level at the player's position, and also 500 units over him.
	--if these ground levels match, it must mean there were no obstacles (such as a ceiling) over the player,		--if these ground levels match, it must mean there were no obstacles (such as a ceiling) over the player,
	if getGroundPosition ( px, py, pz ) == getGroundPosition ( px, py, pz + ~~500~~ ) then		if getGroundPosition ( px, py, pz ) == getGroundPosition ( px, py, pz + 530 ) then
	-- so the player is not under cover		-- so the player is not under cover
	return false		return false

PoliticalOrel at 12:23, 8 March 2010

2010-03-08T12:23:29Z

← Older revision		Revision as of 12:23, 8 March 2010
Line 39:		Line 39:
	==See Also==		==See Also==
	{{Client_world_functions}}		{{Client_world_functions}}

			[[ru:getGroundPosition]]

EAi at 16:14, 17 September 2007

2007-09-17T16:14:13Z

← Older revision		Revision as of 16:14, 17 September 2007
Line 1:		Line 1:
	__NOTOC__		__NOTOC__
	{{Client function}}		{{Client function}}
	This function gets the Z level of the highest ground below a point. It is required that the point is near enough to the local player so that it's within the area where ~~world map~~ data is loaded.		This function gets the Z level of the highest ground below a point.

			It is required that the point is near enough to the local player so that it's within the area where collision data is loaded. If this is not the case, an incorrect position will be returned.

	==Syntax==		==Syntax==

Jbeta: Added template

2007-08-04T20:48:59Z

Added template

← Older revision		Revision as of 20:48, 4 August 2007
Line 1:		Line 1:
	__NOTOC__		__NOTOC__
			{{Client function}}
	This function gets the Z level of the highest ground below a point. It is required that the point is near enough to the local player so that it's within the area where world map data is loaded.		This function gets the Z level of the highest ground below a point. It is required that the point is near enough to the local player so that it's within the area where world map data is loaded.

Jbeta at 12:33, 2 August 2007

2007-08-02T12:33:59Z

← Older revision		Revision as of 12:33, 2 August 2007
Line 1:		Line 1:
	~~{{Needs_Checking\|what's the maximum distance from the player we can check?}}~~
	__NOTOC__		__NOTOC__
	This function gets the Z level of the highest ground below a point. It is required that the point is near enough to the local player so that it's within the area where world map data is loaded.		This function gets the Z level of the highest ground below a point. It is required that the point is near enough to the local player so that it's within the area where world map data is loaded.

Jbeta: Example fixed

2007-08-02T12:32:04Z

Example fixed

← Older revision		Revision as of 12:32, 2 August 2007
Line 1:		Line 1:
	{{Needs_Checking\|what's the maximum distance from the player we can check?}}		{{Needs_Checking\|what's the maximum distance from the player we can check?}}
	__NOTOC__		__NOTOC__
	This function gets the ~~ground~~ level of the ~~nearest floor level~~ below a point. It is required that the point is near enough to the player so that it's within the area where world map data is loaded.		This function gets the Z level of the highest ground below a point. It is required that the point is near enough to the local player so that it's within the area where world map data is loaded.

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

	===Required Arguments===		===Required Arguments===
	*'''x:''' A floating point number representing the X coordinate on the ~~map~~.		*'''x:''' A floating point number representing the X world coordinate of the point.
	*'''y:''' A floating point number representing the Y coordinate on the ~~map~~.		*'''y:''' A floating point number representing the Y world coordinate of the point.
	*'''z:''' A floating point number representing the Z coordinate on the ~~map~~.		*'''z:''' A floating point number representing the Z world coordinate of the point.

	===Returns===		===Returns===
	Returns a float with the highest ~~floor~~-level Z coord if parameters are valid, ''false'' otherwise.		Returns a float with the highest ground-level Z coord if parameters are valid, ''0'' if the point you tried to test is outside the loaded world map, ''false'' otherwise.

	==Example==		==Example==
	This clientside function determines if a player is under a ceiling.		This clientside function determines if a player is under a ceiling or not.
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	function ~~isPlayerUndercover~~ ( ~~player~~ )		function isPlayerUnderCover ( thePlayer )
	--we get the player's position ~~and store it in three variables~~		--we get the player's position
	local px, py, pz = ~~getPlayerPosition~~ ( ~~player~~ )		local px, py, pz = getElementPosition ( thePlayer )
	--~~if the floor~~ level ~~for~~ the player ~~is the same when we measure it way up (let~~'s ~~say 200~~ units),		--we'll check for ground level at the player's position, and also 500 units over him.
	--it must mean there ~~are~~ no obstacles (~~ceilings~~) over the player~~: the function returns false (not undercover)~~		--if these ground levels match, it must mean there were no obstacles (such as a ceiling) over the player,
	if getGroundPosition ( px, py, pz ) == getGroundPosition ( px, py, pz + ~~200~~ ) then return false		if getGroundPosition ( px, py, pz ) == getGroundPosition ( px, py, pz + 500 ) then
	--otherwise, there ~~must be~~ an object over him~~: the function returns true (undercover)~~		-- so the player is not under cover
	else return true		return false
			--otherwise, there was an object over him,
			else
			-- so the player is under cover
			return true
	end		end
	end		end