GetSearchLightStartRadius: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
(Documented function introduced in r7683)
 
No edit summary
 
(3 intermediate revisions by 3 users not shown)
Line 1: Line 1:
__NOTOC__  
__NOTOC__  
{{Client function}}
{{Client function}}
{{New feature/item|3.0160|1.6|7683|This function gets the start radius of a [[Element/Searchlight|searchlight]] element.}}
{{Needs_Example}}
 
This function gets the start radius of a [[Element/Searchlight|searchlight]] element.


==Syntax==  
==Syntax==  
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
searchlight getSearchLightStartRadius ( searchlight theSearchLight )
float getSearchLightStartRadius ( searchlight theSearchLight )
</syntaxhighlight>
</syntaxhighlight>
{{OOP||[[Element/Searchlight|SearchLight]]:getStartRadius|startRadius|setSearchLightStartRadius}}
{{OOP||[[Element/Searchlight|searchLight]]:getStartRadius|startRadius|setSearchLightStartRadius}}


===Required Arguments===
===Required Arguments===

Latest revision as of 11:06, 20 March 2019

Accessories-text-editor.png 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