CreateSearchLight - Revision history

AlexTMjugador: Added information about searchlight limit

2016-06-04T09:39:43Z

Added information about searchlight limit

← Older revision		Revision as of 09:39, 4 June 2016
Line 25:		Line 25:

	===Returns===		===Returns===
	If every argument is correct, this function returns a [[Element/Searchlight\|searchlight element]]. Otherwise, it returns ''false''.		If every argument is correct and the limit of 1000 searchlights has not been reached, this function returns a [[Element/Searchlight\|searchlight element]]. Otherwise, it returns ''false''.

	==Example==		==Example==

Jusonex at 16:51, 14 January 2016

2016-01-14T16:51:21Z

← Older revision		Revision as of 16:51, 14 January 2016
Line 1:		Line 1:
	__NOTOC__		__NOTOC__
	{{Client function}}		{{Client function}}
	{{New feature/item\|3.~~0160~~\|1.6\|~~7675~~\|This function creates a [[Element/Searchlight\|searchlight]]. A [[Element/Searchlight\|searchlight]] is a spotlight which looks like the one available in the Police Maverick.}}		{{New feature/item\|3.0152\|1.5.2\|\|This function creates a [[Element/Searchlight\|searchlight]]. A [[Element/Searchlight\|searchlight]] is a spotlight which looks like the one available in the Police Maverick.}}
	{{Tip\|''You should only use this function when you are sure that the searchlight will point upwards or downwards''. Using them horizontally or almost horizontally will generate visual artifacts in the searchlight.}}		{{Tip\|''You should only use this function when you are sure that the searchlight will point upwards or downwards''. Using them horizontally or almost horizontally will generate visual artifacts in the searchlight.}}

Qaisjp: fix oop syntax

2016-01-05T12:06:14Z

fix oop syntax

← Older revision		Revision as of 12:06, 5 January 2016
Line 8:		Line 8:
	searchlight createSearchLight ( float startX, float startY, float startZ, float endX, float endY, float endZ, float startRadius, float endRadius [, bool renderSpot = true ] )		searchlight createSearchLight ( float startX, float startY, float startZ, float endX, float endY, float endZ, float startRadius, float endRadius [, bool renderSpot = true ] )
	</syntaxhighlight>		</syntaxhighlight>
	{{OOP\|\|[[Element/Searchlight\|SearchLight]]~~.create~~}}		{{OOP\|\|[[Element/Searchlight\|SearchLight]]}}

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

AlexTMjugador: Updated example to use functions introduced in 7683

2015-12-11T16:22:40Z

Updated example to use functions introduced in 7683

← Older revision		Revision as of 16:22, 11 December 2015
Line 30:		Line 30:
	This example allows players to wear a helmet lantern, which can be toggled on or off by pressing O or using ''/togglelantern''. It uses createSearchLight to create the illumination effect.		This example allows players to wear a helmet lantern, which can be toggled on or off by pressing O or using ''/togglelantern''. It uses createSearchLight to create the illumination effect.
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	local ~~helmetLanterns~~		local helmetLantern

	local function updateHelmetLantern()		local function updateHelmetLantern()
	~~-- We need to do it this way because there isn't a setSearchLightStart/EndPosition for now~~
	-- Calculate light properties		-- Calculate light properties
	local helmetPos, playerMatrix = Vector3(getPedBonePosition(localPlayer, 6)), getElementMatrix(localPlayer)		local helmetPos, playerMatrix = Vector3(getPedBonePosition(localPlayer, 6)), getElementMatrix(localPlayer)
	local targetPos = Vector3(playerMatrix[4][1] + playerMatrix[2][1] * 3, playerMatrix[4][2] + playerMatrix[2][2] * 3, playerMatrix[4][3] + playerMatrix[2][3] * 3)		local targetPos = Vector3(playerMatrix[4][1] + playerMatrix[2][1] * 3, playerMatrix[4][2] + playerMatrix[2][2] * 3, playerMatrix[4][3] + playerMatrix[2][3] * 3)
	-- ~~Finally~~, create ~~the updated searchlight~~		-- If the searchlight we use for the effect doesn't exist, create it
	~~helmetLanterns[#helmetLanterns + 1]~~ = createSearchLight(helmetPos, targetPos, 0, 15)		-- If it is already created, then simply update its start and end positions
	~~-- We need to keep two searchlights, so they have time to render visible and look nice~~		if not helmetLantern then
	~~if #helmetLanterns > 2 then~~		helmetLantern = createSearchLight(helmetPos, targetPos, 0, 15)
	~~destroyElement~~(~~helmetLanterns[1]~~)		else
	~~table.remove~~(~~helmetLanterns~~, 1)		setSearchLightStartPosition(helmetLantern, helmetPos)
			setSearchLightEndPosition(helmetLantern, targetPos)
	end		end
	end		end

	local function manageHelmetLantern()		local function manageHelmetLantern()
	local helmetLanternOff = not ~~helmetLanterns~~		local helmetLanternOff = not helmetLantern
	playSoundFrontEnd(helmetLanternOff and 37 or 38)		playSoundFrontEnd(helmetLanternOff and 37 or 38)
	if helmetLanternOff then		if helmetLanternOff then
	-- Let updateHelmetLantern take care of creating and updating the effect		-- Let updateHelmetLantern take care of creating and updating the effect
	~~helmetLanterns = {}~~
	addEventHandler("onClientPreRender", root, updateHelmetLantern)		addEventHandler("onClientPreRender", root, updateHelmetLantern)
	else		else
	-- Stop updateHelmetLantern doing its job and clear variables		-- Stop updateHelmetLantern doing its job and clear variables
	removeEventHandler("onClientPreRender", root, updateHelmetLantern)		removeEventHandler("onClientPreRender", root, updateHelmetLantern)
	~~for _, helmetLantern in ipairs(helmetLanterns) do~~		destroyElement(helmetLantern)
	destroyElement(helmetLantern)		helmetLantern = nil
	~~end~~
	~~helmetLanterns~~ = nil
	end		end
	end		end

AlexTMjugador: Added tip about rendering bugs in searchlights

2015-12-09T18:00:01Z

Added tip about rendering bugs in searchlights

← Older revision		Revision as of 18:00, 9 December 2015
Line 2:		Line 2:
	{{Client function}}		{{Client function}}
	{{New feature/item\|3.0160\|1.6\|7675\|This function creates a [[Element/Searchlight\|searchlight]]. A [[Element/Searchlight\|searchlight]] is a spotlight which looks like the one available in the Police Maverick.}}		{{New feature/item\|3.0160\|1.6\|7675\|This function creates a [[Element/Searchlight\|searchlight]]. A [[Element/Searchlight\|searchlight]] is a spotlight which looks like the one available in the Police Maverick.}}
			{{Tip\|''You should only use this function when you are sure that the searchlight will point upwards or downwards''. Using them horizontally or almost horizontally will generate visual artifacts in the searchlight.}}

	==Syntax==		==Syntax==

AlexTMjugador: /* Example */

2015-12-08T18:18:58Z

Example

← Older revision		Revision as of 18:18, 8 December 2015
Line 27:		Line 27:

	==Example==		==Example==
			This example allows players to wear a helmet lantern, which can be toggled on or off by pressing O or using ''/togglelantern''. It uses createSearchLight to create the illumination effect.
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	local helmetLanterns		local helmetLanterns
Line 54:		Line 55:
	-- Stop updateHelmetLantern doing its job and clear variables		-- Stop updateHelmetLantern doing its job and clear variables
	removeEventHandler("onClientPreRender", root, updateHelmetLantern)		removeEventHandler("onClientPreRender", root, updateHelmetLantern)
	for _, ~~helmetLight~~ in ipairs(helmetLanterns) do		for _, helmetLantern in ipairs(helmetLanterns) do
	destroyElement(~~helmetLight~~)		destroyElement(helmetLantern)
	end		end
	helmetLanterns = nil		helmetLanterns = nil
Line 61:		Line 62:
	end		end

	-- Allow the player to turn the helmet ~~light~~ or on off using /~~turnlight~~ or pressing O		-- Allow the player to turn the helmet lantern or on off by using /togglelantern or pressing O
	addCommandHandler("~~turnlight~~", manageHelmetLantern)		addCommandHandler("togglelantern", manageHelmetLantern)
	bindKey("o", "down", manageHelmetLantern)		bindKey("o", "down", manageHelmetLantern)
	</syntaxhighlight>		</syntaxhighlight>

AlexTMjugador: Added a nice example

2015-12-08T18:16:49Z

Added a nice example

@@ Line 28: / Line 28: @@
 ==Example==
 <syntaxhighlight lang="lua">
--- TODO
+local helmetLanterns
 </syntaxhighlight>
 ==See also==
 {{Client_searchlight_functions}}

AlexTMjugador at 17:52, 8 December 2015

2015-12-08T17:52:58Z

← Older revision		Revision as of 17:52, 8 December 2015
Line 1:		Line 1:
	__NOTOC__		__NOTOC__
	{{Client function}}		{{Client function}}
	{{New feature/item\|3.0160\|1.6\|7675\|This function creates a [[Element/Searchlight\|searchlight]]. A [[Element/Searchlight\|searchlight]] a spotlight which looks like the one available in the Police Maverick.}}		{{New feature/item\|3.0160\|1.6\|7675\|This function creates a [[Element/Searchlight\|searchlight]]. A [[Element/Searchlight\|searchlight]] is a spotlight which looks like the one available in the Police Maverick.}}

	==Syntax==		==Syntax==

AlexTMjugador: Corrected "See also" section template

2015-12-08T17:52:42Z

Corrected "See also" section template

← Older revision		Revision as of 17:52, 8 December 2015
Line 32:		Line 32:

	==See also==		==See also==
	{{~~Client_world_functions~~}}		{{Client_searchlight_functions}}

AlexTMjugador: Added Template:OptionalArg

2015-12-08T17:52:10Z

Added Template:OptionalArg

← Older revision		Revision as of 17:52, 8 December 2015
Line 20:		Line 20:

	===Optional Arguments===		===Optional Arguments===
			{{OptionalArg}}
	*'''renderSpot''': if ''true'', the searchlight will lighten the surface where it ends.		*'''renderSpot''': if ''true'', the searchlight will lighten the surface where it ends.