GetWeather: Difference between revisions
Jump to navigation
Jump to search
m (→Example) |
No edit summary |
||
| (10 intermediate revisions by 5 users not shown) | |||
| Line 1: | Line 1: | ||
__NOTOC__ | __NOTOC__ | ||
This function returns the current | {{Server client function}} | ||
This function returns the current [[Weather]] ID. | |||
==Syntax== | ==Syntax== | ||
<syntaxhighlight lang="lua"> | <syntaxhighlight lang="lua"> | ||
int getWeather ( | int, int getWeather() | ||
</syntaxhighlight> | </syntaxhighlight> | ||
===Returns=== | ===Returns=== | ||
Returns | Returns two integers indicating the weather type that is currently active. The first integer says what weather is currently considered to be active. The second integer is the weather id that is being blended into if any, otherwise it is ''nil''. | ||
==Example== | ==Example== | ||
This example outputs the current weather ID in that chat box. | This example outputs the current weather ID in that chat box. | ||
<syntaxhighlight lang="lua">weatherID = getWeather() | <syntaxhighlight lang="lua">local weatherID = getWeather() | ||
outputChatBox ( "The current weather ID is " .. weatherID )</syntaxhighlight> | outputChatBox ( "The current weather ID is " .. weatherID )</syntaxhighlight> | ||
==See Also== | ==See Also== | ||
{{World functions}} | {{World functions}} | ||
[[ru:getWeather]] | |||
Latest revision as of 14:13, 7 October 2012
This function returns the current Weather ID.
Syntax
int, int getWeather()
Returns
Returns two integers indicating the weather type that is currently active. The first integer says what weather is currently considered to be active. The second integer is the weather id that is being blended into if any, otherwise it is nil.
Example
This example outputs the current weather ID in that chat box.
local weatherID = getWeather() outputChatBox ( "The current weather ID is " .. weatherID )
See Also
- 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