SetSearchLightStartPosition - Revision history

DezZolation at 11:12, 20 March 2019

2019-03-20T11:12:21Z

← Older revision		Revision as of 11:12, 20 March 2019
Line 6:		Line 6:
	==Syntax==		==Syntax==
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	~~searchlight~~ setSearchLightStartPosition ( searchlight theSearchLight, float startX, float startY, float startZ )		bool setSearchLightStartPosition ( searchlight theSearchLight, float startX, float startY, float startZ )
	</syntaxhighlight>		</syntaxhighlight>
	{{OOP\|\|[[Element/Searchlight\|searchLight]]:setStartPosition\|startPosition\|getSearchLightStartPosition}}		{{OOP\|\|[[Element/Searchlight\|searchLight]]:setStartPosition\|startPosition\|getSearchLightStartPosition}}

CodyJ at 18:17, 25 June 2017

2017-06-25T18:17:21Z

← Older revision		Revision as of 18:17, 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 start position of a [[Element/Searchlight\|searchlight]] element.}}
			This function sets the start position of a [[Element/Searchlight\|searchlight]] element.

	==Syntax==		==Syntax==

Qaisjp: fix oop

2016-01-11T18:52:19Z

fix oop

← Older revision		Revision as of 18:52, 11 January 2016
Line 7:		Line 7:
	searchlight setSearchLightStartPosition ( searchlight theSearchLight, float startX, float startY, float startZ )		searchlight setSearchLightStartPosition ( searchlight theSearchLight, float startX, float startY, float startZ )
	</syntaxhighlight>		</syntaxhighlight>
	{{OOP\|\|[[Element/Searchlight\|~~SearchLight~~]]:setStartPosition\|startPosition\|getSearchLightStartPosition}}		{{OOP\|\|[[Element/Searchlight\|searchLight]]:setStartPosition\|startPosition\|getSearchLightStartPosition}}

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

AlexTMjugador: Added a missing argument

2015-12-11T16:29:19Z

Added a missing argument

← Older revision		Revision as of 16:29, 11 December 2015
Line 5:		Line 5:
	==Syntax==		==Syntax==
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	searchlight setSearchLightStartPosition ( float startX, float startY, float startZ )		searchlight setSearchLightStartPosition ( searchlight theSearchLight, float startX, float startY, float startZ )
	</syntaxhighlight>		</syntaxhighlight>
	{{OOP\|\|[[Element/Searchlight\|SearchLight]]:setStartPosition\|startPosition\|getSearchLightStartPosition}}		{{OOP\|\|[[Element/Searchlight\|SearchLight]]:setStartPosition\|startPosition\|getSearchLightStartPosition}}

	===Required Arguments===		===Required Arguments===
			*'''theSearchLight''': the searchlight to modify the property of.
	*'''startX''': the X coordinate where the searchlight light cone will start.		*'''startX''': the X coordinate where the searchlight light cone will start.
	*'''startY''': the Y coordinate where the searchlight light cone will start.		*'''startY''': the Y coordinate where the searchlight light cone will start.

AlexTMjugador at 16:17, 11 December 2015

2015-12-11T16:17:24Z

← Older revision		Revision as of 16:17, 11 December 2015
Line 24:		Line 24:
	if searchLight then		if searchLight then
	local function updateSearchLight()		local function updateSearchLight()
	~~assert(searchLight, "Searchlight was deleted") -- We assume that the searchlight exists~~
	-- Set its start position to the camera position		-- Set its start position to the camera position
	setSearchLightStartPosition(searchLight, getCameraMatrix())		setSearchLightStartPosition(searchLight, getCameraMatrix())

AlexTMjugador: Documented function introduced in 7683

2015-12-11T16:17:04Z

Documented function introduced in 7683

New page

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

==Syntax==
<syntaxhighlight lang="lua">
searchlight setSearchLightStartPosition ( float startX, float startY, float startZ )
</syntaxhighlight>
{{OOP||[[Element/Searchlight|SearchLight]]:setStartPosition|startPosition|getSearchLightStartPosition}}

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

===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 the center of the map.
<syntaxhighlight lang="lua">
local searchLight = createSearchLight(0, 0, 0, 0, 0, 0, 0, 10)

if searchLight then
local function updateSearchLight()
assert(searchLight, "Searchlight was deleted") -- We assume that the searchlight exists
-- Set its start position to the camera position
setSearchLightStartPosition(searchLight, getCameraMatrix())
end
addEventHandler("onClientPreRender", root, updateSearchLight)
end
</syntaxhighlight>

==See also==
{{Client_searchlight_functions}}