GetRoofPosition

From Multi Theft Auto: Wiki
Revision as of 17:24, 7 November 2024 by Fernando187 (talk | contribs) (Remove obsolete Requirements section)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search

This function gets the Z level of the lowest roof above a point. It is required that the point is near enough to the local player so that it's within the area where collision data is loaded.

Syntax

float getRoofPosition ( float x, float y, float z )

Required Arguments

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

Returns

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

Example

This example starts to shake the player's camera if there is no roof over him: 

setTimer (
    function ()
        local playerX, playerY, playerZ = getElementPosition (localPlayer)
        local roofZ = getRoofPosition (playerX, playerY, playerZ)
        setCameraShakeLevel ((roofZ) and 0 or 255 )
    end, 100, 0
)

See Also



Retrieved from "https://wiki.multitheftauto.com/wiki/GetRoofPosition?oldid=81280"