SetSearchLightStartRadius: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
|||
Line 2: | Line 2: | ||
{{Client function}} | {{Client function}} | ||
{{Needs_Example}} | {{Needs_Example}} | ||
This function sets the start radius of a [[Element/Searchlight|searchlight]] element. | |||
==Syntax== | ==Syntax== |
Revision as of 18:17, 25 June 2017
Script Example Missing Function SetSearchLightStartRadius needs a script example, help out by writing one. | |
Before submitting check out Editing Guidelines Script Examples. |
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
-- TODO
See also
- createSearchLight
- getSearchLightEndPosition
- getSearchLightEndRadius
- getSearchLightStartPosition
- getSearchLightStartRadius
- setSearchLightEndPosition
- setSearchLightEndRadius
- setSearchLightStartPosition
- setSearchLightStartRadius