GetSearchLightEndRadius: Difference between revisions
Jump to navigation
Jump to search
mNo edit summary |
No edit summary |
||
Line 3: | Line 3: | ||
{{Needs_Example}} | {{Needs_Example}} | ||
This function gets the end radius of a [[Element/Searchlight|searchlight]] element. | |||
==Syntax== | ==Syntax== |
Revision as of 18:19, 25 June 2017
Script Example Missing Function GetSearchLightEndRadius needs a script example, help out by writing one. | |
Before submitting check out Editing Guidelines Script Examples. |
This function gets the end radius of a searchlight element.
Syntax
searchlight getSearchLightEndRadius ( searchlight theSearchLight )
OOP Syntax Help! I don't understand this!
- Method: searchLight:getEndRadius(...)
- Variable: .endRadius
- Counterpart: setSearchLightEndRadius
Required Arguments
- theSearchLight: the searchlight to get the radius of the searchlight's light cone in its end.
Returns
If the specified searchlight element is valid, this function will return one float, which is the searchlight's end radius. If not, it will return false plus an error message.
Example
-- TODO
See also
- createSearchLight
- getSearchLightEndPosition
- getSearchLightEndRadius
- getSearchLightStartPosition
- getSearchLightStartRadius
- setSearchLightEndPosition
- setSearchLightEndRadius
- setSearchLightStartPosition
- setSearchLightStartRadius