SetSearchLightEndPosition - Revision history

Fernando187: add desc

2025-06-01T17:00:24Z

add desc

← Older revision		Revision as of 17:00, 1 June 2025
Line 1:		Line 1:
	__NOTOC__		__NOTOC__
	{{Client function}}		{{Client function}}
			This function sets the end position of a [[searchlight]] element.

	==Syntax==		==Syntax==

DezZolation at 11:12, 20 March 2019

2019-03-20T11:12:03Z

← Older revision		Revision as of 11:12, 20 March 2019
Line 4:		Line 4:
	==Syntax==		==Syntax==
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	~~searchlight~~ setSearchLightEndPosition ( searchlight theSearchLight, float endX, float endY, float endZ )		bool setSearchLightEndPosition ( searchlight theSearchLight, float endX, float endY, float endZ )
	</syntaxhighlight>		</syntaxhighlight>
	{{OOP\|\|[[Element/Searchlight\|searchLight]]:setEndPosition\|endPosition\|getSearchLightEndPosition}}		{{OOP\|\|[[Element/Searchlight\|searchLight]]:setEndPosition\|endPosition\|getSearchLightEndPosition}}

CodyJ: Functional in 1.5

2017-06-25T18:15:01Z

Functional in 1.5

← Older revision		Revision as of 18:15, 25 June 2017
Line 1:		Line 1:
	__NOTOC__		__NOTOC__
	{{Client function}}		{{Client function}}
	~~{{New feature/item\|3.0160\|1.6\|7683\|This function sets the end position of a [[Element/Searchlight\|searchlight]] element.}}~~

	==Syntax==		==Syntax==

Qaisjp: fix oop

2016-01-11T18:51:55Z

fix oop

← Older revision		Revision as of 18:51, 11 January 2016
Line 7:		Line 7:
	searchlight setSearchLightEndPosition ( searchlight theSearchLight, float endX, float endY, float endZ )		searchlight setSearchLightEndPosition ( searchlight theSearchLight, float endX, float endY, float endZ )
	</syntaxhighlight>		</syntaxhighlight>
	{{OOP\|\|[[Element/Searchlight\|~~SearchLight~~]]:setEndPosition\|endPosition\|getSearchLightEndPosition}}		{{OOP\|\|[[Element/Searchlight\|searchLight]]:setEndPosition\|endPosition\|getSearchLightEndPosition}}

	===Required Arguments===		===Required Arguments===

AlexTMjugador at 16:30, 11 December 2015

2015-12-11T16:30:27Z

← Older revision		Revision as of 16:30, 11 December 2015
Line 5:		Line 5:
	==Syntax==		==Syntax==
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	searchlight setSearchLightEndPosition ( float endX, float endY, float endZ )		searchlight setSearchLightEndPosition ( searchlight theSearchLight, float endX, float endY, float endZ )
	</syntaxhighlight>		</syntaxhighlight>
	{{OOP\|\|[[Element/Searchlight\|SearchLight]]:setEndPosition\|endPosition\|getSearchLightEndPosition}}		{{OOP\|\|[[Element/Searchlight\|SearchLight]]:setEndPosition\|endPosition\|getSearchLightEndPosition}}

	===Required Arguments===		===Required Arguments===
	*'''~~startX~~''': the X coordinate where the searchlight light cone will end.		*'''theSearchLight''': the searchlight to modify the property of.
	*'''~~startY~~''': the Y coordinate where the searchlight light cone will end.		*'''endX''': the X coordinate where the searchlight light cone will end.
	*'''~~startZ~~''': the Z coordinate where the searchlight light cone will end.		*'''endY''': the Y coordinate where the searchlight light cone will end.
			*'''endZ''': the Z coordinate where the searchlight light cone will end.

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

AlexTMjugador: Documented function introduced in 7683

2015-12-11T16:17:07Z

Documented function introduced in 7683

New page

__NOTOC__
{{Client function}}
{{New feature/item|3.0160|1.6|7683|This function sets the end position of a [[Element/Searchlight|searchlight]] element.}}

==Syntax==
<syntaxhighlight lang="lua">
searchlight setSearchLightEndPosition ( float endX, float endY, float endZ )
</syntaxhighlight>
{{OOP||[[Element/Searchlight|SearchLight]]:setEndPosition|endPosition|getSearchLightEndPosition}}

===Required Arguments===
*'''startX''': the X coordinate where the searchlight light cone will end.
*'''startY''': the Y coordinate where the searchlight light cone will end.
*'''startZ''': the Z coordinate where the searchlight light cone will end.

===Returns===
If every argument is correct, this function returns ''true''. If not, it will return ''false'' plus an error message.

==Example==
This example creates a searchlight that originates in the camera position and targets to the front of it.
<syntaxhighlight lang="lua">
local searchLight = createSearchLight(0, 0, 0, 0, 0, 0, 0, 10)

if searchLight then
local function updateSearchLight()
-- Get camera position and look at point
local sx, sy, sz, ex, ey, ez = getCameraMatrix()
-- Set searchlight's start position to the camera position, and end position to the look at point
setSearchLightStartPosition(searchLight, sx, sy, sz)
setSearchLightEndPosition(searchLight, ex, ey, ez)
end
addEventHandler("onClientPreRender", root, updateSearchLight)
end
</syntaxhighlight>

==See also==
{{Client_searchlight_functions}}