Gameplay::getGroundZFor3dCoord - Revision history

Shr0x: updated 'see also'

2024-04-29T12:10:23Z

updated 'see also'

← Older revision		Revision as of 12:10, 29 April 2024
Line 33:		Line 33:
	}}		}}
	==See also==		==See also==
	{{~~Gameplay_s_function_c~~}}		{{Gameplay_definition_c}}
	[[Category:Clientside API]]		[[Category:Clientside API]]
	~~[[Category:TODO: Example]]~~

Shr0x: updated params

2024-04-29T08:42:24Z

updated params

← Older revision		Revision as of 08:42, 29 April 2024
Line 1:		Line 1:
	Returns the first surface ''beneath'' the specified elevation (at the given location).~~<br>~~		{{ClientsideJsFunction}}
	This can be a roof, an elevated road, or the ground.~~<br>~~		{{JSContainer\|
	(If no surface can be found beneath, then the returned boolean will be false, and the float will contain 0.)~~<br>~~
			Returns the first surface ''beneath'' the specified elevation (at the given location).

			This can be a roof, an elevated road, or the ground.

			(If no surface can be found beneath, then the returned boolean will be false, and the float will contain 0.)

	For water positions the sea floor will be returned (negative value).		For water positions the sea floor will be returned (negative value).

	For the function to work reliably, the position tested should have been streamed already (i.e. close to the player); otherwise it might return 0.		For the function to work reliably, the position tested should have been streamed already (i.e. close to the player); otherwise it might return 0.

			== Required Params ==
			*'''x:''' {{RageType\|float}} - X-coordinate of location to test
			*'''y:''' {{RageType\|float}} - Y-coordinate of location to test
			*'''z:''' {{RageType\|float}} - Z-coordinate, beneath which to test
			*'''waterAsGround:''' {{RageType\|Boolean}}
			*'''waterLevelCheck:''' {{RageType\|boolean}}


	==Syntax==		==Syntax==
	<syntaxhighlight lang="javascript">mp.game.gameplay.getGroundZFor3dCoord(x, y, z, ~~unknowna~~, ~~unknownb~~);</syntaxhighlight>		<syntaxhighlight lang="javascript">
	~~=== Required Arguments ===~~		mp.game.gameplay.getGroundZFor3dCoord(x, y, z, waterAsGround, waterLevelCheck);
	*'''x:''' float - X-coordinate of location to test		</syntaxhighlight>
	*'''y:''' float - Y-coordinate of location to test
	*'''z:''' float - Z-coordinate, beneath which to test
	*'''unknowna:''' float - this is ignored
	*'''unknownb:''' boolean - unknown (normally 0)
	~~===Return value===~~
	*'''float''' - Elevation above the ground
	==Example==		==Example==
	<syntaxhighlight lang="javascript">		<syntaxhighlight lang="javascript">
	const getGroundZ = mp.game.gameplay.getGroundZFor3dCoord(position.x, position.y, position.z, ~~parseFloat(~~0), false);		const {position} = mp.players.local;
			const getGroundZ = mp.game.gameplay.getGroundZFor3dCoord(position.x, position.y, position.z, 0.0, false);
	mp.markers.new(1, new mp.Vector3(position.x, position.y,getGroundZ), 1.5,		mp.markers.new(1, new mp.Vector3(position.x, position.y, getGroundZ), 1.5, { color: [0, 255, 0, 100], visible: true });
	{
	color: [0, 255, 0, 100],
	visible: true
	});
	</syntaxhighlight>		</syntaxhighlight>
			}}
	==See also==		==See also==
	{{Gameplay_s_function_c}}		{{Gameplay_s_function_c}}
	[[Category:Clientside API]]		[[Category:Clientside API]]
	[[Category:TODO: Example]]		[[Category:TODO: Example]]

Wdoyle2: /* Example */

2019-09-17T19:18:09Z

Example

← Older revision		Revision as of 19:18, 17 September 2019
Line 20:		Line 20:
	const getGroundZ = mp.game.gameplay.getGroundZFor3dCoord(position.x, position.y, position.z, parseFloat(0), false);		const getGroundZ = mp.game.gameplay.getGroundZFor3dCoord(position.x, position.y, position.z, parseFloat(0), false);

	mp.markers.new(1, new mp.Vector3(position.x, position.y,~~groundZCords~~), 1.5,		mp.markers.new(1, new mp.Vector3(position.x, position.y,getGroundZ), 1.5,
	{		{
	color: [0, 255, 0, 100],		color: [0, 255, 0, 100],
Line 26:		Line 26:
	});		});
	</syntaxhighlight>		</syntaxhighlight>

	==See also==		==See also==
	{{Gameplay_s_function_c}}		{{Gameplay_s_function_c}}
	[[Category:Clientside API]]		[[Category:Clientside API]]
	[[Category:TODO: Example]]		[[Category:TODO: Example]]

Wdoyle2: Implement client side JS function and correct defintion of the function and response

2019-09-17T19:17:50Z

Implement client side JS function and correct defintion of the function and response

← Older revision		Revision as of 19:17, 17 September 2019
Line 7:		Line 7:

	==Syntax==		==Syntax==
	<syntaxhighlight lang="javascript">mp.game.gameplay.getGroundZFor3dCoord(x, y, z, ~~groundZ~~, ~~unk~~);</syntaxhighlight>		<syntaxhighlight lang="javascript">mp.game.gameplay.getGroundZFor3dCoord(x, y, z, unknowna, unknownb);</syntaxhighlight>
	=== Required Arguments ===		=== Required Arguments ===
	*'''x:''' float - X-coordinate of location to test		*'''x:''' float - X-coordinate of location to test
	*'''y:''' float - Y-coordinate of location to test		*'''y:''' float - Y-coordinate of location to test
	*'''z:''' float - Z-coordinate, beneath which to test		*'''z:''' float - Z-coordinate, beneath which to test
	*'''~~unk~~:''' boolean - unknown (normally 0)		*'''unknowna:''' float - this is ignored
			*'''unknownb:''' boolean - unknown (normally 0)
	===Return value===		===Return value===
	*'''~~found:~~''' ~~Boolean - true if surface is found, false if not~~		*'''float''' - Elevation above the ground
	*'''groundZ:''' float - Elevation ~~of surface found~~
	==Example==		==Example==
	<syntaxhighlight lang="javascript">		<syntaxhighlight lang="javascript">
	~~// todo~~		const getGroundZ = mp.game.gameplay.getGroundZFor3dCoord(position.x, position.y, position.z, parseFloat(0), false);

			mp.markers.new(1, new mp.Vector3(position.x, position.y,groundZCords), 1.5,
			{
			color: [0, 255, 0, 100],
			visible: true
			});
	</syntaxhighlight>		</syntaxhighlight>
	==See also==		==See also==

MrPancakers: Removed example, incomplete and wrong language

2019-06-24T21:36:59Z

Removed example, incomplete and wrong language

← Older revision		Revision as of 21:36, 24 June 2019
Line 18:		Line 18:
	==Example==		==Example==
	<syntaxhighlight lang="javascript">		<syntaxhighlight lang="javascript">
	~~local chk,groundZ = GetGroundZFor_3dCoord(playerPos.x,playerPos.y,playerPos.z+1,0)~~		// todo
	</syntaxhighlight>		</syntaxhighlight>
	==See also==		==See also==

Kronzky: expanded description

2019-05-14T21:38:47Z

expanded description

← Older revision		Revision as of 21:38, 14 May 2019
Line 1:		Line 1:
	~~Gets~~ the ~~ground~~ elevation at the ~~specified position~~. ~~Note that if the specified position is below ground level, the function will output zero!~~<br>~~<br>x: Position on~~ the ~~X-axis to get~~ ground ~~elevation at~~.<br>~~y: Position on~~ the ~~Y-axis to get ground elevation at~~.<br>~~z: Position on~~ the ~~Z-axis~~ to ~~get ground elevation at.<br>groundZ: The ground elevation at~~ the ~~specified~~ position.~~<br>unk: Nearly always false, very rarely true in~~ the ~~scripts~~.		Returns the first surface ''beneath'' the specified elevation (at the given location).<br>
			This can be a roof, an elevated road, or the ground.<br>
			(If no surface can be found beneath, then the returned boolean will be false, and the float will contain 0.)<br>
			For water positions the sea floor will be returned (negative value).

			For the function to work reliably, the position tested should have been streamed already (i.e. close to the player); otherwise it might return 0.

	==Syntax==		==Syntax==
	<syntaxhighlight lang="javascript">mp.game.gameplay.getGroundZFor3dCoord(x, y, z, groundZ, unk);</syntaxhighlight>		<syntaxhighlight lang="javascript">mp.game.gameplay.getGroundZFor3dCoord(x, y, z, groundZ, unk);</syntaxhighlight>
	=== Required Arguments ===		=== Required Arguments ===
	*'''x:''' float		*'''x:''' float - X-coordinate of location to test
	*'''y:''' float		*'''y:''' float - Y-coordinate of location to test
	*'''z:''' float		*'''z:''' float - Z-coordinate, beneath which to test
	*'''groundZ:''' float		*'''unk:''' boolean - unknown (normally 0)
	*'''unk:''' ~~Boolean~~
	===Return value===		===Return value===
	*'''~~float~~'''		*'''found:''' Boolean - true if surface is found, false if not
			*'''groundZ:''' float - Elevation of surface found
	==Example==		==Example==
	<syntaxhighlight lang="javascript">		<syntaxhighlight lang="javascript">
	~~// todo~~		local chk,groundZ = GetGroundZFor_3dCoord(playerPos.x,playerPos.y,playerPos.z+1,0)
	</syntaxhighlight>		</syntaxhighlight>
	==See also==		==See also==

Kar at 17:32, 2 February 2019

2019-02-02T17:32:53Z

← Older revision		Revision as of 17:32, 2 February 2019
Line 1:		Line 1:
	Gets the ground elevation at the specified position. Note that if the specified position is below ground level, the function will output zero!<br><br>x: Position on the X-axis to get ground elevation at.<br>y: Position on the Y-axis to get ground elevation at.<br>z: Position on the Z-axis to get ground elevation at.<br>groundZ: The ground elevation at the specified position.<br>unk: Nearly always 0, very rarely 1 in the scripts.		Gets the ground elevation at the specified position. Note that if the specified position is below ground level, the function will output zero!<br><br>x: Position on the X-axis to get ground elevation at.<br>y: Position on the Y-axis to get ground elevation at.<br>z: Position on the Z-axis to get ground elevation at.<br>groundZ: The ground elevation at the specified position.<br>unk: Nearly always false, very rarely true in the scripts.
	==Syntax==		==Syntax==
	<syntaxhighlight lang="javascript">mp.game.gameplay.getGroundZFor3dCoord(x, y, z, groundZ, unk);</syntaxhighlight>		<syntaxhighlight lang="javascript">mp.game.gameplay.getGroundZFor3dCoord(x, y, z, groundZ, unk);</syntaxhighlight>

Marty uploader: yay

2017-05-06T21:12:52Z

yay

← Older revision		Revision as of 21:12, 6 May 2017
Line 1:		Line 1:
	Gets the ground elevation at the specified position. Note that if the specified position is below ground level, the function will output zero!<br><br>x: Position on the X-axis to get ground elevation at.<br>y: Position on the Y-axis to get ground elevation at.<br>z: Position on the Z-axis to get ground elevation at.<br>groundZ: The ground elevation at the specified position.<br>unk: Nearly always 0, very rarely 1 in the scripts.		Gets the ground elevation at the specified position. Note that if the specified position is below ground level, the function will output zero!<br><br>x: Position on the X-axis to get ground elevation at.<br>y: Position on the Y-axis to get ground elevation at.<br>z: Position on the Z-axis to get ground elevation at.<br>groundZ: The ground elevation at the specified position.<br>unk: Nearly always 0, very rarely 1 in the scripts.
	==Syntax==		==Syntax==
	<syntaxhighlight lang="javascript">gameplay.getGroundZFor3dCoord(x, y, z, groundZ, unk);</syntaxhighlight>		<syntaxhighlight lang="javascript">mp.game.gameplay.getGroundZFor3dCoord(x, y, z, groundZ, unk);</syntaxhighlight>
	=== Required Arguments ===		=== Required Arguments ===
	*'''x:''' float		*'''x:''' float
Line 12:		Line 12:
	==Example==		==Example==
	<syntaxhighlight lang="javascript">		<syntaxhighlight lang="javascript">
	todo		// todo
	</syntaxhighlight>		</syntaxhighlight>
	==See also==		==See also==
	{{~~Gameplay_function_c~~}}		{{Gameplay_s_function_c}}
	[[Category:Clientside API]]		[[Category:Clientside API]]
	[[Category:TODO: Example]]		[[Category:TODO: Example]]

Marty uploader: yay

2017-05-06T20:14:45Z

yay

New page

Gets the ground elevation at the specified position. Note that if the specified position is below ground level, the function will output zero! x: Position on the X-axis to get ground elevation at. y: Position on the Y-axis to get ground elevation at. z: Position on the Z-axis to get ground elevation at. groundZ: The ground elevation at the specified position. unk: Nearly always 0, very rarely 1 in the scripts.
==Syntax==
<syntaxhighlight lang="javascript">gameplay.getGroundZFor3dCoord(x, y, z, groundZ, unk);</syntaxhighlight>
=== Required Arguments ===
*'''x:''' float
*'''y:''' float
*'''z:''' float
*'''groundZ:''' float
*'''unk:''' Boolean
===Return value===
*'''float'''
==Example==
<syntaxhighlight lang="javascript">
todo
</syntaxhighlight>
==See also==
{{Gameplay_function_c}}
[[Category:Clientside API]]
[[Category:TODO: Example]]