GetSearchLightStartPosition: Difference between revisions
Jump to navigation
Jump to search
(Documented function introduced in r7683) |
m (fix oop) |
||
| Line 7: | Line 7: | ||
searchlight getSearchLightStartPosition ( searchlight theSearchLight ) | searchlight getSearchLightStartPosition ( searchlight theSearchLight ) | ||
</syntaxhighlight> | </syntaxhighlight> | ||
{{OOP||[[Element/Searchlight| | {{OOP||[[Element/Searchlight|searchLight]]:getStartPosition|startPosition|setSearchLightStartPosition}} | ||
===Required Arguments=== | ===Required Arguments=== | ||
Revision as of 18:52, 11 January 2016
This function gets the start position of a searchlight element.
Syntax
searchlight 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
- createSearchLight
- getSearchLightEndPosition
- getSearchLightEndRadius
- getSearchLightStartPosition
- getSearchLightStartRadius
- setSearchLightEndPosition
- setSearchLightEndRadius
- setSearchLightStartPosition
- setSearchLightStartRadius