GetRoofPosition - Revision history

Fernando187: Remove obsolete Requirements section

2024-11-07T17:24:42Z

Remove obsolete Requirements section

← Older revision		Revision as of 17:24, 7 November 2024
Line 27:		Line 27:
	)		)
	</syntaxhighlight>		</syntaxhighlight>

	~~==Requirements==~~
	~~{{Requirements\|n/a\|1.5.8-9.20675\|}}~~

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

Lvrent at 15:59, 23 September 2021

2021-09-23T15:59:11Z

← Older revision		Revision as of 15:59, 23 September 2021
Line 1:		Line 1:
	__NOTOC__		__NOTOC__
	{{Client function}}		{{Client function}}
	{{Added feature/item~~\|3.0160~~\|1.5.9\|1.5.8\|20675\|This function gets the Z level of the lowest roof above 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.}}		{{Added feature/item\|1.5.9\|1.5.8\|20675\|This function gets the Z level of the lowest roof above 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.}}

	==Syntax==		==Syntax==

Lvrent at 12:09, 23 September 2021

2021-09-23T12:09:34Z

← Older revision		Revision as of 12:09, 23 September 2021
Line 1:		Line 1:
	__NOTOC__		__NOTOC__
	{{Client function}}		{{Client function}}
	{{Added feature/item\|3.~~0159~~\|1.5.9\|1.5.8\|20675\|This function gets the Z level of the lowest roof above 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.}}		{{Added feature/item\|3.0160\|1.5.9\|1.5.8\|20675\|This function gets the Z level of the lowest roof above 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.}}

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

	===Required Arguments===		===Required Arguments===
	*'''x''': A [[float]]~~ing point number~~ representing the X world coordinate of the point.		*'''x''': A [[float]] representing the X world coordinate of the point.
	*'''y''': A [[float]]~~ing point number~~ representing the Y world coordinate of the point.		*'''y''': A [[float]] representing the Y world coordinate of the point.
	*'''z''': A [[float]]~~ing point number~~ representing the Z world coordinate of the point.		*'''z''': A [[float]] representing the Z world coordinate of the point.

	===Returns===		===Returns===
Line 17:		Line 17:

	==Example==		==Example==
	This example starts to shake the player's camera if there is no roof over him.		This example starts to shake the player's camera if there is no roof over him:
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	setTimer (		setTimer (
	function ()		function ()
	local playerX, playerY, playerZ = getElementPosition (localPlayer)		local playerX, playerY, playerZ = getElementPosition (localPlayer)
	local roofZ = getRoofPosition (playerX, playerY, playerZ)		local roofZ = getRoofPosition (playerX, playerY, playerZ)
	setCameraShakeLevel ((roofZ) and 0 or 255 )		setCameraShakeLevel ((roofZ) and 0 or 255 )
	end, 100, 0		end, 100, 0
	)		)
	</syntaxhighlight>		</syntaxhighlight>

Lvrent at 11:23, 20 September 2021

2021-09-20T11:23:00Z

← Older revision		Revision as of 11:23, 20 September 2021
Line 20:		Line 20:
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	setTimer (		setTimer (
	function ( )		function ()
	local playerX, playerY, playerZ = getElementPosition ( localPlayer )		local playerX, playerY, playerZ = getElementPosition (localPlayer)
	local roofZ = getRoofPosition ( playerX, playerY, playerZ )		local roofZ = getRoofPosition (playerX, playerY, playerZ)
	setCameraShakeLevel ( ( roofZ ) and 0 or 255 )		setCameraShakeLevel ((roofZ) and 0 or 255 )
	end, 100, 0		end, 100, 0
	)		)

Lvrent at 11:22, 20 September 2021

2021-09-20T11:22:25Z

← Older revision		Revision as of 11:22, 20 September 2021
Line 1:		Line 1:
	__NOTOC__		__NOTOC__
	{{Client function}}		{{Client function}}
	{{~~New~~ feature/item\|3.0159\|1.5.8\|20675\|		{{Added feature/item\|3.0159\|1.5.9\|1.5.8\|20675\|This function gets the Z level of the lowest roof above 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.}}
	This function gets the Z level of the lowest roof above 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.}}

	==Syntax==		==Syntax==

Myonlake at 11:32, 11 April 2021

2021-04-11T11:32:41Z

← Older revision		Revision as of 11:32, 11 April 2021
Line 1:		Line 1:
	__NOTOC__		__NOTOC__
	{{Client function}}		{{Client function}}
	{{New feature/item\|3.~~0160~~\|1.5.8\|20675\|		{{New feature/item\|3.0159\|1.5.8\|20675\|
	This function gets the Z level of the lowest roof above a point.		This function gets the Z level of the lowest roof above 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.}}		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.}}

Zver-CR at 21:52, 3 January 2021

2021-01-03T21:52:00Z

← Older revision		Revision as of 21:52, 3 January 2021
Line 19:		Line 19:

	==Example==		==Example==
	This example starts to shake the player's camera if there is no roof over it.		This example starts to shake the player's camera if there is no roof over him.
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	setTimer (		setTimer (

Zver-CR: Created page with "NOTOC {{Client function}} {{New feature/item|3.0160|1.5.8|20675| This function gets the Z level of the lowest roof above a point. It is required that the point is near eno..."

2021-01-03T21:37:17Z

Created page with "__NOTOC__ {{Client function}} {{New feature/item|3.0160|1.5.8|20675| This function gets the Z level of the lowest roof above a point. It is required that the point is near eno..."

New page

__NOTOC__
{{Client function}}
{{New feature/item|3.0160|1.5.8|20675|
This function gets the Z level of the lowest roof above 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.}}

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

===Required Arguments===
*'''x''': A [[float]]ing point number representing the X world coordinate of the point.
*'''y''': A [[float]]ing point number representing the Y world coordinate of the point.
*'''z''': A [[float]]ing point number representing the Z world coordinate of the point.

===Returns===
Returns a [[float]] with the lowest roof-level Z coord if parameters are valid, ''false'' if the point you tried to test is outside the loaded world map.

==Example==
This example starts to shake the player's camera if there is no roof over it.
<syntaxhighlight lang="lua">
setTimer (
function ( )
local playerX, playerY, playerZ = getElementPosition ( localPlayer )
local roofZ = getRoofPosition ( playerX, playerY, playerZ )
setCameraShakeLevel ( ( roofZ ) and 0 or 255 )
end, 100, 0
)
</syntaxhighlight>

==Requirements==
{{Requirements|n/a|1.5.8-9.20675|}}

==See Also==
{{Client_world_functions}}