GetNearestElement - Revision history

AirNewSCR: added if element ~= player then in getNearestElement to prevent return player passed to call function

2024-10-17T02:10:20Z

added if element ~= player then in getNearestElement to prevent return player passed to call function

← Older revision		Revision as of 02:10, 17 October 2024
Line 24:		Line 24:
	for i = 1, #elements do		for i = 1, #elements do
	local element = elements[i]		local element = elements[i]
	if ~~not dist then~~		if element ~= player then
	~~result =~~ element		if not dist then
	~~dist~~ = ~~getDistanceBetweenPoints3D(Vector3(getElementPosition(~~player~~)), Vector3(getElementPosition(element)))~~
	~~else~~
	~~local newDist = getDistanceBetweenPoints3D(Vector3(getElementPosition(player)), Vector3(getElementPosition(element)))~~
	if ~~newDist <=~~ dist then
	result = element		result = element
	dist = newDist		dist = getDistanceBetweenPoints3D(Vector3(getElementPosition(player)), Vector3(getElementPosition(element)))
			else
			local newDist = getDistanceBetweenPoints3D(Vector3(getElementPosition(player)), Vector3(getElementPosition(element)))
			if newDist <= dist then
			result = element
			dist = newDist
			end
	end		end
	end		end

IManGaaX: add note

2023-11-01T07:37:59Z

add note

← Older revision		Revision as of 07:37, 1 November 2023
Line 1:		Line 1:
	__NOTOC__		__NOTOC__
	{{Useful Function}}		{{Useful Function}}
			<!-- i think you can use 'getElementsWithinRange', not need to this.-->
	This function returns the nearest [[Element\|element]] (of a specific type) to a [[Player\|player]].		This function returns the nearest [[Element\|element]] (of a specific type) to a [[Player\|player]].

IManGaaX: change code style

2023-10-29T11:01:56Z

change code style

← Older revision		Revision as of 11:01, 29 October 2023
Line 14:		Line 14:

	==Code==		==Code==
	<section name="~~Server/Clientside script~~" class="both" show="true">		<section name="Shared" class="both" show="true">
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	function getNearestElement(player, type, distance)		function getNearestElement(player, type, distance)
	local result = false		local result = false
	local dist = nil		local dist = nil
	if player and isElement(player) then		if player and isElement(player) then
	local elements = getElementsWithinRange(Vector3(getElementPosition(player)), distance, type, getElementInterior(player), getElementDimension(player))		local elements = getElementsWithinRange(Vector3(getElementPosition(player)), distance, type, getElementInterior(player), getElementDimension(player))
	for i = 1, #elements do		for i = 1, #elements do
	local element = elements[i]		local element = elements[i]
	if not dist then		if not dist then
	result = element		result = element
	dist = getDistanceBetweenPoints3D(Vector3(getElementPosition(player)), Vector3(getElementPosition(element)))		dist = getDistanceBetweenPoints3D(Vector3(getElementPosition(player)), Vector3(getElementPosition(element)))
	else		else
	local newDist = getDistanceBetweenPoints3D(Vector3(getElementPosition(player)), Vector3(getElementPosition(element)))		local newDist = getDistanceBetweenPoints3D(Vector3(getElementPosition(player)), Vector3(getElementPosition(element)))
	if newDist <= dist then		if newDist <= dist then
	result = element		result = element
	dist = newDist		dist = newDist
	end		end
	end		end
	end		end
	end		end
	return result		return result
	end		end
	</syntaxhighlight></section>		</syntaxhighlight>
			</section>

	==Example==		==Example==
			This example outputs the name of the nearest vehicle within 300 metres.
	<section name="Client" class="client" show="true">		<section name="Client" class="client" show="true">
	~~This example outputs the name of the nearest vehicle within 300 metres.~~
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	addCommandHandler("findVehicle", function()		addCommandHandler("findVehicle", function()
Line 54:		Line 55:
	</section>		</section>

	Modified version of [[GetNearestVehicle\|getNearestVehicle]]		'''Modified version of''' [[GetNearestVehicle\|getNearestVehicle]]

	==See Also==		==See Also==
	{{Useful_Functions}}		{{Useful_Functions}}

AirNewSCR: for better processing without using getElementsByType, avoiding a large "for" that can cause server delay.

2023-04-30T19:37:11Z

for better processing without using getElementsByType, avoiding a large "for" that can cause server delay.

← Older revision		Revision as of 19:37, 30 April 2023
Line 6:		Line 6:
	<syntaxhighlight lang="lua">element getNearestElement( player thePlayer, string elementType, float distance)</syntaxhighlight>		<syntaxhighlight lang="lua">element getNearestElement( player thePlayer, string elementType, float distance)</syntaxhighlight>
	===Required Arguments===		===Required Arguments===
	* '''~~thePlayer~~''': The player who you want to get the nearest element from.		* '''player''': The player who you want to get the nearest element from.
	* '''~~elementType~~''': The type of the element you want to get. ("player", "ped", "object", etc.)		* '''type''': The type of the element you want to get. ("player", "ped", "object", etc.)
	* '''distance''': A number for the maximum distance the element can be from the player.		* '''distance''': A number for the maximum distance the element can be from the player.

Line 16:		Line 16:
	<section name="Server/Clientside script" class="both" show="true">		<section name="Server/Clientside script" class="both" show="true">
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	function getNearestElement(~~thePlayer~~, ~~elementType~~, distance)		function getNearestElement(player, type, distance)
	local ~~lastMinDis = distance-0.0001~~		local result = false
	~~local nearestElement~~ = false		local dist = nil
	local ~~px,py,pz~~ = ~~getElementPosition(thePlayer)~~		if player and isElement(player) then
	~~local pInt = getElementInterior~~(~~thePlayer~~)		local elements = getElementsWithinRange(Vector3(getElementPosition(player)), distance, type, getElementInterior(player), getElementDimension(player))
	local ~~pDim~~ = ~~getElementDimension~~(~~thePlayer)~~		for i = 1, #elements do
			local element = elements[i]
	~~for _,e in pairs~~(~~getElementsByType~~(~~elementType~~)) do		if not dist then
	~~local eInt~~,~~eDim =~~ getElementInterior(e),getElementDimension(e)		result = element
	~~if eInt~~ == ~~pInt and eDim~~ == ~~pDim and e ~= thePlayer then~~		dist = getDistanceBetweenPoints3D(Vector3(getElementPosition(player)), Vector3(getElementPosition(element)))
	~~local ex~~,~~ey,ez =~~ getElementPosition(e)		else
	local ~~dis~~ = getDistanceBetweenPoints3D(px,~~py,pz,ex,ey,ez~~)		local newDist = getDistanceBetweenPoints3D(Vector3(getElementPosition(player)), Vector3(getElementPosition(element)))
	~~if dis < distance then~~		if newDist <= dist then
	if ~~dis~~ < ~~lastMinDis~~ then		result = element
	~~lastMinDis~~ = ~~dis~~		dist = newDist
	~~nearestElement~~ = e
	end		end
	end		end
	end		end
	end		end
	return ~~nearestElement~~		return result
	end		end
	</syntaxhighlight></section>		</syntaxhighlight></section>

JessePinkman: Edit layout

2020-08-22T02:09:33Z

Edit layout

← Older revision		Revision as of 02:09, 22 August 2020
Line 1:		Line 1:
			__NOTOC__
	{{Useful Function}}		{{Useful Function}}
	~~__NOTOC__~~
	This function returns the nearest [[Element\|element]] (of a specific type) to a [[Player\|player]].		This function returns the nearest [[Element\|element]] (of a specific type) to a [[Player\|player]].

	==Syntax==		==Syntax==
	<syntaxhighlight lang="lua">element getNearestElement( player thePlayer, string elementType, float distance)</syntaxhighlight>		<syntaxhighlight lang="lua">element getNearestElement( player thePlayer, string elementType, float distance)</syntaxhighlight>

	===Required Arguments===		===Required Arguments===
	* '''thePlayer''': The player who you want to get the nearest element from.		* '''thePlayer''': The player who you want to get the nearest element from.

JessePinkman: Add an example code.

2020-08-22T02:07:30Z

Add an example code.

@@ Line 40: / Line 40: @@
 end
 </syntaxhighlight></section>
 Modified version of [[GetNearestVehicle|getNearestVehicle]]

JessePinkman: Add new useful function getNearestElement, "inspired" by getNearestVehicle.

2020-08-22T01:51:01Z

Add new useful function getNearestElement, "inspired" by getNearestVehicle.

New page

{{Useful Function}}
__NOTOC__
This function returns the nearest [[Element|element]] (of a specific type) to a [[Player|player]].

==Syntax==
<syntaxhighlight lang="lua">element getNearestElement( player thePlayer, string elementType, float distance)</syntaxhighlight>

===Required Arguments===
* '''thePlayer''': The player who you want to get the nearest element from.
* '''elementType''': The type of the element you want to get. ("player", "ped", "object", etc.)
* '''distance''': A number for the maximum distance the element can be from the player.

===Returns===
Returns an [[Element|element]] if it's within the specified '''distance''', ''false'' otherwise.

==Code==
<section name="Server/Clientside script" class="both" show="true">
<syntaxhighlight lang="lua">
function getNearestElement(thePlayer, elementType, distance)
local lastMinDis = distance-0.0001
local nearestElement = false
local px,py,pz = getElementPosition(thePlayer)
local pInt = getElementInterior(thePlayer)
local pDim = getElementDimension(thePlayer)

for _,e in pairs(getElementsByType(elementType)) do
local eInt,eDim = getElementInterior(e),getElementDimension(e)
if eInt == pInt and eDim == pDim and e ~= thePlayer then
local ex,ey,ez = getElementPosition(e)
local dis = getDistanceBetweenPoints3D(px,py,pz,ex,ey,ez)
if dis < distance then
if dis < lastMinDis then
lastMinDis = dis
nearestElement = e
end
end
end
end
return nearestElement
end
</syntaxhighlight></section>

Modified version of [[GetNearestVehicle|getNearestVehicle]]

==See Also==
{{Useful_Functions}}