This page is incomplete! Help wanted!

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

---

This function casts a ray between two points in the world, and tells you information about the point that was hit, if any. The two positions must be within the local player's draw distance as the collision data is not loaded outside this area, and the call will just fail as if the ray didn't hit.

Note

Due to a bug, shootThroughStuff argument does currently check for seeThroughStuff!

Note

Due to a bug, seeThroughStuff argument has no effect. It mistakenly checks for "shootThrough" surfaces and will always behave as if the argument is set to FALSE (It will never hit).

Syntax

 processLineOfSight ( )

Code Examples

Example 1 Example 2

client

This example shows how you can tell what position and element the camera is looking at, up to 50 units away.

local w, h = guiGetScreenSize ()
local tx, ty, tz = getWorldFromScreenPosition ( w/2, h/2, 50 )
local px, py, pz = getCameraMatrix()
hit, x, y, z, elementHit = processLineOfSight ( px, py, pz, tx, ty, tz )
if hit then
    outputChatBox ( "Looking at " .. x .. ", " .. y .. ", " ..  z )
    if elementHit then
        outputChatBox ( "Hit element " .. getElementType(elementHit) )
    end
end

client

This example shows how you can get the surface type a vehicle is on. This is useful if you want to do a script to dirt cars over time. Please note that this function doesn't count if the vehicle is streamed in or not, so expect this function to fail or return incorrect values on unloaded vehicles.

function getSurfaceVehicleIsOn(vehicle)
    if isElement(vehicle) and (isVehicleOnGround(vehicle) or isElementInWater(vehicle)) then -- Is an element and is touching any surface?
        local cx, cy, cz = getElementPosition(vehicle) -- Get the position of the vehicle
        local gz = getGroundPosition(cx, cy, cz) - 0.001 -- Get the Z position of the ground the vehicle is on (-0.001 because of processLineOfSight)
        local hit, _, _, _, _, _, _, _, surface = processLineOfSight(cx, cy, cz, cx, cy, gz) -- This will get the material of the thing the car is standing on
        if hit then
            return surface -- If everything is correct, stop executing this function and return the surface type
        end
    end
    return false -- If something isn't correct, return false
end

See Also

World Functions

• areTrafficLightsLocked
• createSWATRope
• getAircraftMaxHeight
• getAircraftMaxVelocity
• getBirdsEnabled
• getCloudsEnabled
• getColorFilter
• getCoronaReflectionsEnabled
• getFarClipDistance
• getFogDistance
• getGameSpeed
• getGarageBoundingBox
• getGaragePosition
• getGarageSize
• getGravity
• getGroundPosition
• getHeatHaze
• getInteriorFurnitureEnabled
• getInteriorSoundsEnabled
• getJetpackMaxHeight
• getJetpackWeaponEnabled
• getMinuteDuration
• getMoonSize
• getNearClipDistance
• getOcclusionsEnabled
• getPedsLODDistance
• getRainLevel
• getRoofPosition
• getScreenFromWorldPosition
• getSkyGradient
• getSunColor
• getSunSize
• getTime
• getTrafficLightState
• getVehiclesLODDistance
• getWeather
• getWindVelocity
• getWorldFromScreenPosition
• getWorldProperty
• getZoneName
• isAmbientSoundEnabled
• isGarageOpen
• isLineOfSightClear
• isTimeFrozen
• isVolumetricShadowsEnabled
• isWorldSoundEnabled
• isWorldSpecialPropertyEnabled
• processLineAgainstMesh
• processLineOfSight
• removeGameWorld
• removeWorldModel
• resetAmbientSounds
• resetBlurLevel
• resetColorFilter
• resetCoronaReflectionsEnabled
• resetFarClipDistance
• resetFogDistance
• resetHeatHaze
• resetMoonSize
• resetNearClipDistance
• resetPedsLODDistance
• resetRainLevel
• resetSkyGradient
• resetSunColor
• resetSunSize
• resetTimeFrozen
• resetVehiclesLODDistance
• resetVolumetricShadows
• resetWindVelocity
• resetWorldProperties
• resetWorldProperty
• resetWorldSounds
• restoreAllWorldModels
• restoreGameWorld
• restoreWorldModel
• setAircraftMaxHeight
• setAircraftMaxVelocity
• setAmbientSoundEnabled
• setBirdsEnabled
• setCloudsEnabled
• setColorFilter
• setCoronaReflectionsEnabled
• setFarClipDistance
• setFogDistance
• setGameSpeed
• setGarageOpen
• setGrainLevel
• setGrainMultiplier
• setGravity
• setHeatHaze
• setInteriorFurnitureEnabled
• setInteriorSoundsEnabled
• setJetpackMaxHeight
• setJetpackWeaponEnabled
• setMinuteDuration
• setMoonSize
• setNearClipDistance
• setOcclusionsEnabled
• setPedsLODDistance
• setRainLevel
• setSkyGradient
• setSunColor
• setSunSize
• setTime
• setTimeFrozen
• setTrafficLightsLocked
• setTrafficLightState
• setVehiclesLODDistance
• setVolumetricShadowsEnabled
• setWeather
• setWeatherBlended
• setWindVelocity
• setWorldProperty
• setWorldSoundEnabled
• setWorldSpecialPropertyEnabled
• testLineAgainstWater
• testSphereAgainstWorld

Reference

• Scripting Functions