GetSearchLightStartRadius: Difference between revisions
Jump to navigation
Jump to search
(Documented function introduced in r7683) |
m (fix oop) |
||
| Line 7: | Line 7: | ||
searchlight getSearchLightStartRadius ( searchlight theSearchLight ) | searchlight getSearchLightStartRadius ( searchlight theSearchLight ) | ||
</syntaxhighlight> | </syntaxhighlight> | ||
{{OOP||[[Element/Searchlight| | {{OOP||[[Element/Searchlight|searchLight]]:getStartRadius|startRadius|setSearchLightStartRadius}} | ||
===Required Arguments=== | ===Required Arguments=== | ||
Revision as of 18:53, 11 January 2016
This function gets the start radius of a searchlight element.
Syntax
searchlight getSearchLightStartRadius ( searchlight theSearchLight )
OOP Syntax Help! I don't understand this!
- Method: searchLight:getStartRadius(...)
- Variable: .startRadius
- Counterpart: setSearchLightStartRadius
Required Arguments
- theSearchLight: the searchlight to get the radius of the searchlight's light cone in its beginning.
Returns
If the specified searchlight element is valid, this function will return one float, which is the searchlight's start radius. If not, it will return false plus an error message.
Example
-- TODO
See also
- createSearchLight
- getSearchLightEndPosition
- getSearchLightEndRadius
- getSearchLightStartPosition
- getSearchLightStartRadius
- setSearchLightEndPosition
- setSearchLightEndRadius
- setSearchLightStartPosition
- setSearchLightStartRadius