GetSearchLightEndRadius: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
mNo edit summary
No edit summary
 
(One intermediate revision by one other user not shown)
Line 3: Line 3:
{{Needs_Example}}
{{Needs_Example}}


{{New feature/item|3.0160|1.6|7683|This function gets the end radius of a [[Element/Searchlight|searchlight]] element.}}
This function gets the end radius of a [[Element/Searchlight|searchlight]] element.


==Syntax==  
==Syntax==  
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
searchlight getSearchLightEndRadius ( searchlight theSearchLight )
float getSearchLightEndRadius ( searchlight theSearchLight )
</syntaxhighlight>
</syntaxhighlight>
{{OOP||[[Element/Searchlight|searchLight]]:getEndRadius|endRadius|setSearchLightEndRadius}}
{{OOP||[[Element/Searchlight|searchLight]]:getEndRadius|endRadius|setSearchLightEndRadius}}

Latest revision as of 11:05, 20 March 2019

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

float 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