GetSearchLightStartPosition: 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 position of a [[Element/Searchlight|searchlight]] element.}}
{{Needs_Example}}
 
This function gets the start position of a [[Element/Searchlight|searchlight]] element.


==Syntax==  
==Syntax==  
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
searchlight getSearchLightStartPosition ( searchlight theSearchLight )
float, float, float getSearchLightStartPosition ( searchlight theSearchLight )
</syntaxhighlight>
</syntaxhighlight>
{{OOP||[[Element/Searchlight|SearchLight]]:getStartPosition|startPosition|setSearchLightStartPosition}}
{{OOP||[[Element/Searchlight|searchLight]]:getStartPosition|startPosition|setSearchLightStartPosition}}


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

Latest revision as of 11:05, 20 March 2019

Accessories-text-editor.png Script Example Missing Function GetSearchLightStartPosition needs a script example, help out by writing one.

Before submitting check out Editing Guidelines Script Examples.


This function gets the start position of a searchlight element.

Syntax

float, float, float getSearchLightStartPosition ( searchlight theSearchLight )

OOP Syntax Help! I don't understand this!

Method: searchLight:getStartPosition(...)
Variable: .startPosition
Counterpart: setSearchLightStartPosition


Required Arguments

  • theSearchLight: the searchlight to get the position where the searchlight's light cone starts.

Returns

If the specified searchlight element is valid, this function will return three float, which are the three coordinates of searchlight's start position. If not, it will return false plus an error message.

Example

-- TODO

See also