GetSearchLightStartRadius: Difference between revisions
Jump to navigation
Jump to search
(Documented function introduced in r7683) |
DezZolation (talk | contribs) No edit summary |
||
(3 intermediate revisions by 3 users not shown) | |||
Line 1: | Line 1: | ||
__NOTOC__ | __NOTOC__ | ||
{{Client function}} | {{Client function}} | ||
{{ | {{Needs_Example}} | ||
This function gets the start radius of a [[Element/Searchlight|searchlight]] element. | |||
==Syntax== | ==Syntax== | ||
<syntaxhighlight lang="lua"> | <syntaxhighlight lang="lua"> | ||
float getSearchLightStartRadius ( searchlight theSearchLight ) | |||
</syntaxhighlight> | </syntaxhighlight> | ||
{{OOP||[[Element/Searchlight| | {{OOP||[[Element/Searchlight|searchLight]]:getStartRadius|startRadius|setSearchLightStartRadius}} | ||
===Required Arguments=== | ===Required Arguments=== |
Latest revision as of 11:06, 20 March 2019
Script Example Missing Function GetSearchLightStartRadius needs a script example, help out by writing one. | |
Before submitting check out Editing Guidelines Script Examples. |
This function gets the start radius of a searchlight element.
Syntax
float 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