Manual Review Required

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

---

This function gets the Z level of the highest ground below a point.

Syntax

float getGroundPosition ( float x, float y, float z )

Required Arguments

• x: A floating point number representing the X world coordinate of the point.
• y: A floating point number representing the Y world coordinate of the point.
• z: A floating point number representing the Z world coordinate of the point.

Returns

• float: value

Returns a float with the highest ground-level Z coord if parameters are valid, 0 if the point you tried to test is outside the loaded world map, false otherwise.

Code Examples

Example 1 Example 2

shared

This clientside function determines if a player is under a ceiling or not.

function isPlayerUnderCover ( thePlayer )
  --we get the player's position
  local px, py, pz = getElementPosition ( thePlayer )
  --we'll check for ground level at the player's position, and also 500 units over him.
  --if these ground levels match, it must mean there were no obstacles (such as a ceiling) over the player,
  return getGroundPosition ( px, py, pz ) ~= getGroundPosition ( px, py, pz + 530 )
end

shared

This clientside function returns the distance between you and the ground (if there is)

function getGroundDistance( thePlayer, zHeight  )
  local x,y,z = getElementPosition(thePlayer) -- get position
    local groundPosition = getGroundPosition(x,y,z) -- get default ground pos
  local hit, x1, y1, groundPosition = processLineOfSight(x,y,z+1,x,y,z-(zHeight+0.7))  -- using zHeight get a better ground position
  local distance = getDistanceBetweenPoints3D(x, y, z, x,y, (groundPosition or z))  -- get distance between both positions
  return distance -- return the distance
end

-- Some cool examples:
addCommandHandler("gdistance",function(_, amount)
    local distance = getGroundDistance(localPlayer, tonumber(amount))
    outputChatBox("The distance to reach ground is: " .. distance)
end)

addCommandHandler("do_im_flying",function()
    local distance = getGroundDistance(localPlayer, 20)
    if distance > 1 then
        outputChatBox("Superman!! the distance between you and ground is: " .. distance)
    else
        outputChatBox("naah")
    end
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