SetSearchLightStartRadius: Difference between revisions

Revision as of 20:03, 18 March 2018

This function sets the start radius of a searchlight element.

Syntax

searchlight setSearchLightStartRadius ( searchlight theSearchlight, float startRadius )

OOP Syntax Help! I don't understand this!

Method: searchLight:setStartRadius(...)

Variable: .startRadius

Counterpart: getSearchLightStartRadius

Required Arguments

theSearchLight: the searchlight to modify the property of.
startRadius: the radius of the searchlight's light cone in its beginning.

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 skywalker light on top of Los Santos' skyscraper and turns it on/off every second by setting it's ending radius and starting radius to 0.

skywalkerLight = createSearchLight (1544, -1353.5, 330, 1528, -1347, 360, 0.2, 3, false)

setTimer (function ()	
	if not off then
		setSearchLightStartRadius (skywalkerLight, 0)
		setSearchLightEndRadius (skywalkerLight, 0)
		off = true
	else
		setSearchLightStartRadius (skywalkerLight, 0.2)
		setSearchLightEndRadius (skywalkerLight, 3)
		off = false
	end
end, 1000, 0)

@@ Line 1: / Line 1: @@
 __NOTOC__
 {{Client function}}
-{{Needs_Example}}
 This function sets the start radius of a [[Element/Searchlight|searchlight]] element.