GetRoofPosition: Difference between revisions
Jump to navigation
Jump to search
mNo edit summary |
No edit summary |
||
(4 intermediate revisions by 2 users not shown) | |||
Line 1: | Line 1: | ||
__NOTOC__ | __NOTOC__ | ||
{{Client function}} | {{Client function}} | ||
{{ | {{Added feature/item|1.5.9|1.5.8|20675|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.}} | ||
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== | ==Syntax== | ||
Line 11: | Line 9: | ||
===Required Arguments=== | ===Required Arguments=== | ||
*'''x''': A [[float]] | *'''x''': A [[float]] representing the X world coordinate of the point. | ||
*'''y''': A [[float]] | *'''y''': A [[float]] representing the Y world coordinate of the point. | ||
*'''z''': A [[float]] | *'''z''': A [[float]] representing the Z world coordinate of the point. | ||
===Returns=== | ===Returns=== | ||
Line 19: | Line 17: | ||
==Example== | ==Example== | ||
This example starts to shake the player's camera if there is no roof over him | This example starts to shake the player's camera if there is no roof over him: | ||
<syntaxhighlight lang="lua"> | <syntaxhighlight lang="lua"> | ||
setTimer ( | setTimer ( | ||
function () | |||
local playerX, playerY, playerZ = getElementPosition (localPlayer) | |||
local roofZ = getRoofPosition (playerX, playerY, playerZ) | |||
setCameraShakeLevel ((roofZ) and 0 or 255 ) | |||
end, 100, 0 | |||
) | ) | ||
</syntaxhighlight> | </syntaxhighlight> |
Latest revision as of 15:59, 23 September 2021
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 )
Requirements
Minimum server version | n/a |
---|---|
Minimum client version | 1.5.8-9.20675 |
Note: Using this feature requires the resource to have the above minimum version declared in the meta.xml <min_mta_version> section. e.g. <min_mta_version client="1.5.8-9.20675" />
See Also
- createSWATRope
- getBirdsEnabled
- getCoronaReflectionsEnabled
- getGarageBoundingBox
- getGaragePosition
- getGarageSize
- getGroundPosition
- getInteriorFurnitureEnabled
- getNearClipDistance
- getPedsLODDistance
- getRoofPosition
- getScreenFromWorldPosition
- getVehiclesLODDistance
- getWorldFromScreenPosition
- isAmbientSoundEnabled
- isLineOfSightClear
- isWorldSoundEnabled
- processLineOfSight
- resetAmbientSounds
- resetBlurLevel
- resetColorFilter
- resetCoronaReflectionsEnabled
- resetNearClipDistance
- resetPedsLODDistance
- resetVehiclesLODDistance
- resetWorldSounds
- setAmbientSoundEnabled
- setBirdsEnabled
- setColorFilter
- setCoronaReflectionsEnabled
- setInteriorFurnitureEnabled
- setInteriorSoundsEnabled
- setNearClipDistance
- setPedsLODDistance
- setVehiclesLODDistance
- setWorldSoundEnabled
- testLineAgainstWater
Shared
- areTrafficLightsLocked
- getAircraftMaxHeight
- getAircraftMaxVelocity
- getCloudsEnabled
- getFarClipDistance
- getFogDistance
- getGameSpeed
- getGravity
- getHeatHaze
- getInteriorSoundsEnabled
- getJetpackMaxHeight
- getMinuteDuration
- getMoonSize
- getOcclusionsEnabled
- getRainLevel
- getSunColor
- getSunSize
- getTime
- getTrafficLightState
- getWeather
- getWindVelocity
- getSkyGradient
- getPlayerBlurLevel
- getZoneName
- isGarageOpen
- removeWorldModel
- resetFarClipDistance
- resetFogDistance
- resetHeatHaze
- resetMoonSize
- resetRainLevel
- resetSkyGradient
- resetSunColor
- resetSunSize
- resetWindVelocity
- restoreAllWorldModels
- restoreWorldModel
- setAircraftMaxHeight
- setAircraftMaxVelocity
- setCloudsEnabled
- setFarClipDistance
- setFogDistance
- setGameSpeed
- setGarageOpen
- setGravity
- setHeatHaze
- setInteriorSoundsEnabled
- setMinuteDuration
- setMoonSize
- setOcclusionsEnabled
- setRainLevel
- setSkyGradient
- setSunColor
- setSunSize
- setTime
- setTrafficLightState
- setTrafficLightsLocked
- setWeather
- setWeatherBlended
- setWindVelocity
- setJetpackMaxHeight
- setPlayerBlurLevel