openclonk/docs/sdk/script/fn/GetClimate.xml

22 lines
928 B
XML

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<!DOCTYPE funcs
SYSTEM '../../../clonk.dtd'>
<?xml-stylesheet type="text/xsl" href="../../../clonk.xsl"?>
<funcs>
<func>
<title>GetClimate</title>
<category>Environment</category>
<subcat>Weather</subcat>
<version>5.1 OC</version>
<syntax><rtype>int</rtype></syntax>
<desc>Returns the current climate. This is the median, constant temperature. Actual temperature is calculated by adding the current season and TemperatureRange.</desc>
<remark>The current weather temperature is "Climate - TemperatureRange * cos(Season * Pi / 50)" - the actual temperature approximates this value at a rate of 1 degree per 35 frames.</remark>
<related>
<funclink>GetSeason</funclink>
<funclink>GetTemperature</funclink>
<funclink>SetClimate</funclink>
</related>
</func>
<author>Cucaracha</author><date>2002-05</date>
</funcs>