setSearchLightEndPosition | Multi Theft Auto: Wiki Skip to content
Multi Theft Auto: Wiki

setSearchLightEndPosition

Client-side
Server-side
Shared

Pair: getSearchLightEndPosition

Manual Review Required

Please finish this page using the corresponding Old Wiki article. Go to Contribution guidelines for more information.

This function sets the end position of a searchlight element.

OOP Syntax Help! I don't understand this!

  • Method: searchlight:setEndPosition(...)
  • Variable: .endPosition

Syntax

bool setSearchLightEndPosition ( searchlight theSearchLight, float endX, float endY, float endZ )
Required Arguments
  • theSearchLight: the searchlight to modify the property of.
  • endX: the X coordinate where the searchlight light cone will end.
  • endY: the Y coordinate where the searchlight light cone will end.
  • endZ: the Z coordinate where the searchlight light cone will end.

Returns

  • bool: value

If every argument is correct, this function returns true . If not, it will return false plus an error message.

Code Examples

shared

This example creates a searchlight that originates in the camera position and targets to the front of it.

local searchLight = createSearchLight(0, 0, 0, 0, 0, 0, 0, 10)


if searchLight then
    local function updateSearchLight()
        -- Get camera position and look at point
        local sx, sy, sz, ex, ey, ez = getCameraMatrix()
        -- Set searchlight's start position to the camera position, and end position to the look at point
        setSearchLightStartPosition(searchLight, sx, sy, sz)
        setSearchLightEndPosition(searchLight, ex, ey, ez)
    end
    addEventHandler("onClientPreRender", root, updateSearchLight)
end

See Also

Searchlight Functions
Reference