SetSearchLightStartRadius: Difference between revisions
Jump to navigation
Jump to search
DezZolation (talk | contribs) No edit summary |
|||
| (2 intermediate revisions by one other user not shown) | |||
| Line 1: | Line 1: | ||
__NOTOC__ | __NOTOC__ | ||
{{Client function}} | {{Client function}} | ||
This function sets the start radius of a [[Element/Searchlight|searchlight]] element. | This function sets the start radius of a [[Element/Searchlight|searchlight]] element. | ||
| Line 7: | Line 6: | ||
==Syntax== | ==Syntax== | ||
<syntaxhighlight lang="lua"> | <syntaxhighlight lang="lua"> | ||
bool setSearchLightStartRadius ( searchlight theSearchlight, float startRadius ) | |||
</syntaxhighlight> | </syntaxhighlight> | ||
{{OOP||[[Element/Searchlight|searchLight]]:setStartRadius|startRadius|getSearchLightStartRadius}} | {{OOP||[[Element/Searchlight|searchLight]]:setStartRadius|startRadius|getSearchLightStartRadius}} | ||
| Line 19: | Line 18: | ||
==Example== | ==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. | |||
<syntaxhighlight lang="lua"> | <syntaxhighlight lang="lua"> | ||
-- | 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) | |||
</syntaxhighlight> | </syntaxhighlight> | ||
==See also== | ==See also== | ||
{{Client_searchlight_functions}} | {{Client_searchlight_functions}} | ||
Latest revision as of 11:12, 20 March 2019
This function sets the start radius of a searchlight element.
Syntax
bool 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)
See also
- createSearchLight
- getSearchLightEndPosition
- getSearchLightEndRadius
- getSearchLightStartPosition
- getSearchLightStartRadius
- setSearchLightEndPosition
- setSearchLightEndRadius
- setSearchLightStartPosition
- setSearchLightStartRadius