GetHeatHaze: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
mNo edit summary |
||
| Line 16: | Line 16: | ||
==Example== | ==Example== | ||
<section name="Client" class="client" show="true"> | <section name="Client" class="client" show="true"> | ||
This example outputs current heat haze settings to the chat when player uses command 'get_haze'. | |||
<syntaxhighlight lang="lua"> | <syntaxhighlight lang="lua"> | ||
addCommandHandler( 'get_haze', | addCommandHandler( 'get_haze', | ||
| Line 33: | Line 34: | ||
==See Also== | ==See Also== | ||
{{World functions}} | {{World functions}} | ||
Latest revision as of 22:51, 8 March 2012
This function will return the current heat haze effect settings.
Note: The server can only return the heat haze settings if it has actually been set by script.
Syntax
int, int, int, int, int, int, int, int, bool getHeatHaze ( )
Returns
Returns 9 values, which are the same used as arguments in SetHeatHaze:
- intensity: The intensity of the effect, from 0 to 255.
- randomShift: Sets a random jitter, from 0 to 255.
- speedMin: The slowest effect speed, from 0 to 1000.
- speedMax: The fastest effect speed, from 0 to 1000.
- scanSizeX: The X size in pixels of the chunk grabbed from the screen, from -1000 to 1000.
- scanSizeY: The Y size in pixels of the chunk grabbed from the screen, from -1000 to 1000.
- renderSizeX: The X size in pixels the chunk will be when rendered back to the screen, from 0 to 1000.
- renderSizeY: The Y size in pixels the chunk will be when rendered back to the screen, from 0 to 1000.
- bShowInside: Set to true to enable the heat haze effect when inside a building.
Example
Click to collapse [-]
ClientThis example outputs current heat haze settings to the chat when player uses command 'get_haze'.
addCommandHandler( 'get_haze',
function( )
local tNew = { getHeatHaze ( ) }
outputChatBox(
string.format(
'intensity = %s ;randomShift = %s ;speedMin = %s ;speedMax = %s ;scanSizeX = %s ;scanSizeY = %s ;renderSizeX = %s \
;renderSizeY = %s ;bShowInside = %s ;', unpack( tNew )
)
)
end
)
See Also
- areTrafficLightsLocked
- getAircraftMaxVelocity
- getCloudsEnabled
- getFarClipDistance
- getFogDistance
- getGameSpeed
- getGravity
- getHeatHaze
- getJetpackMaxHeight
- getJetpackWeaponEnabled
- getMinuteDuration
- getMoonSize
- getOcclusionsEnabled
- getRainLevel
- getSkyGradient
- getSunColor
- getSunSize
- getTime
- getTrafficLightState
- getWeather
- getWindVelocity
- getZoneName
- isGarageOpen
- removeWorldModel
- resetColorFilter
- resetFarClipDistance
- resetFogDistance
- resetHeatHaze
- resetMoonSize
- resetRainLevel
- resetSkyGradient
- resetSunColor
- resetSunSize
- resetWindVelocity
- restoreAllWorldModels
- restoreWorldModel
- setAircraftMaxVelocity
- setCloudsEnabled
- setColorFilter
- setFarClipDistance
- setFogDistance
- setGameSpeed
- setGarageOpen
- setGravity
- setHeatHaze
- setInteriorSoundsEnabled
- setJetpackWeaponEnabled
- setMinuteDuration
- setMoonSize
- setOcclusionsEnabled
- setRainLevel
- setSkyGradient
- setSunColor
- setSunSize
- setTime
- setTrafficLightState
- setTrafficLightsLocked
- setWeather
- setWeatherBlended
- setWindVelocity