GetHeatHaze: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
(Created page with "__NOTOC__ {{Server client function}} This function will return the current heat haze effect settings. '''Note:''' The server can only return the heat haze settings if it has act...")
 
(Created a template for heat haze values and added it to 'returns' section)
Line 11: Line 11:


===Returns===
===Returns===
Returns 9 values, which are the same used in [[SetHeatHaze]].
Returns 9 values, which are the same used as arguments in [[SetHeatHaze]]:
{{HeatHazeValues}}


==Example==  
==Example==  

Revision as of 07:17, 17 July 2011

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

--TODO

See Also

Retrieved from "https://wiki.multitheftauto.com/wiki/GetHeatHaze?oldid=26373"