View source for Script/WeatherReference

==class WeatherReference==
A script which handles the weather.
  
=== Class Methods ===
{| border='0' style ='border:solid 1px #eeeedd; color: black; width: 1200px;background-color: #ffffcc;' cellspacing='0' cellpadding='7'
|-
| style='color: blue; width: 10%; text-align:right;line-height: 0.8;' | [[../BasicDataTypes|int]] 
| style='color: black; width: 90%; line-height: 1.0;' | '''GetWorldTimeMS''' () const
|-
|
| style = 'color: #505050; line-height: 0.5;' |''get the absolute time in milliseconds that has passed since the level has started''
|-
| style='color: blue; width: 10%; text-align:right;line-height: 0.8;' | [[../BasicDataTypes|int]] 
| style='color: black; width: 90%; line-height: 1.0;' | '''GetDeterministicRandomInt''' (const [[../BasicDataTypes|int]] ''_iFrom'', const [[../BasicDataTypes|int]] ''_iTo'') const
|-
|
| style = 'color: #505050; line-height: 0.5;' |''returns a deterministic random integer in the range [_iFrom; _iTo[''
|-
| style='color: blue; width: 10%; text-align:right;line-height: 0.8;' | [[../BasicDataTypes|void]] 
| style='color: black; width: 90%; line-height: 0.8;' | '''RestoreDefaultWeather''' ()
|-
|
| style = 'color: #505050; line-height: 0.5;' |''restore weather settings to default''
|-
| style='color: blue; width: 10%; text-align:right;line-height: 0.8;' | [[../BasicDataTypes|float]] 
| style='color: black; width: 90%; line-height: 0.8;' | '''GetShadowStrength''' () const
|-
|
| style = 'color: #505050; line-height: 0.5;' |''get current shadow strength''
|-
| style='color: blue; width: 10%; text-align:right;line-height: 0.8;' | [[../BasicDataTypes|float]] 
| style='color: black; width: 90%; line-height: 0.8;' | '''GetDefaultShadowStrength''' () const
|-
|
| style = 'color: #505050; line-height: 0.5;' |''get default shadow strength''
|-
| style='color: blue; width: 10%; text-align:right;line-height: 0.8;' | [[../BasicDataTypes|void]] 
| style='color: black; width: 90%; line-height: 0.8;' | '''SetShadowStrength''' (const [[../BasicDataTypes|float]] ''_fValue'')
|-
|
| style = 'color: #505050; line-height: 0.5;' |''set shadow strength''
|-
| style='color: blue; width: 10%; text-align:right;line-height: 0.8;' | [[../BasicDataTypes|float]] 
| style='color: black; width: 90%; line-height: 0.8;' | '''GetRoughness''' () const
|-
|
| style = 'color: #505050; line-height: 0.5;' |''get current roughness''
|-
| style='color: blue; width: 10%; text-align:right;line-height: 0.8;' | [[../BasicDataTypes|float]] 
| style='color: black; width: 90%; line-height: 0.8;' | '''GetDefaultRoughness''' () const
|-
|
| style = 'color: #505050; line-height: 0.5;' |''get default roughness''
|-
| style='color: blue; width: 10%; text-align:right;line-height: 0.8;' | [[../BasicDataTypes|void]] 
| style='color: black; width: 90%; line-height: 0.8;' | '''SetRoughness''' (const [[../BasicDataTypes|float]] ''_fValue'')
|-
|
| style = 'color: #505050; line-height: 0.5;' |''set roughness''
|-
| style='color: blue; width: 10%; text-align:right;line-height: 0.8;' | [[../BasicDataTypes|float]] 
| style='color: black; width: 90%; line-height: 0.8;' | '''GetViewDependentRoughness''' () const
|-
|
| style = 'color: #505050; line-height: 0.5;' |''get current view dependent roughness''
|-
| style='color: blue; width: 10%; text-align:right;line-height: 0.8;' | [[../BasicDataTypes|float]] 
| style='color: black; width: 90%; line-height: 0.8;' | '''GetDefaultViewDependentRoughness''' () const
|-
|
| style = 'color: #505050; line-height: 0.5;' |''get default view dependent roughness''
|-
| style='color: blue; width: 10%; text-align:right;line-height: 0.8;' | [[../BasicDataTypes|void]] 
| style='color: black; width: 90%; line-height: 0.8;' | '''SetViewDependentRoughness''' (const [[../BasicDataTypes|float]] ''_fValue'')
|-
|
| style = 'color: #505050; line-height: 0.5;' |''set view dependent roughness''
|-
| style='color: blue; width: 10%; text-align:right;line-height: 0.8;' | [[../BasicDataTypes|float]] 
| style='color: black; width: 90%; line-height: 0.8;' | '''GetButtScale''' () const
|-
|
| style = 'color: #505050; line-height: 0.5;' |''get current butt scale''
|-
| style='color: blue; width: 10%; text-align:right;line-height: 0.8;' | [[../BasicDataTypes|float]] 
| style='color: black; width: 90%; line-height: 0.8;' | '''GetDefaultButtScale''' () const
|-
|
| style = 'color: #505050; line-height: 0.5;' |''get default butt scale''
|-
| style='color: blue; width: 10%; text-align:right;line-height: 0.8;' | [[../BasicDataTypes|void]] 
| style='color: black; width: 90%; line-height: 0.8;' | '''SetButtScale''' (const [[../BasicDataTypes|float]] ''_fValue'')
|-
|
| style = 'color: #505050; line-height: 0.5;' |''set butt scale''
|-
| style='color: blue; width: 10%; text-align:right;line-height: 0.8;' | [[../BasicDataTypes|float]] 
| style='color: black; width: 90%; line-height: 0.8;' | '''GetButtDensity''' () const
|-
|
| style = 'color: #505050; line-height: 0.5;' |''get current butt density''
|-
| style='color: blue; width: 10%; text-align:right;line-height: 0.8;' | [[../BasicDataTypes|float]] 
| style='color: black; width: 90%; line-height: 0.8;' | '''GetDefaultButtDensity''' () const
|-
|
| style = 'color: #505050; line-height: 0.5;' |''get default butt density''
|-
| style='color: blue; width: 10%; text-align:right;line-height: 0.8;' | [[../BasicDataTypes|void]] 
| style='color: black; width: 90%; line-height: 0.8;' | '''SetButtDensity''' (const [[../BasicDataTypes|float]] ''_fValue'')
|-
|
| style = 'color: #505050; line-height: 0.5;' |''set butt scale''
|-
| style='color: blue; width: 10%; text-align:right;line-height: 0.8;' | [[../BasicDataTypes|float]] 
| style='color: black; width: 90%; line-height: 0.8;' | '''GetButtStrength''' () const
|-
|
| style = 'color: #505050; line-height: 0.5;' |''get current butt strength''
|-
| style='color: blue; width: 10%; text-align:right;line-height: 0.8;' | [[../BasicDataTypes|float]] 
| style='color: black; width: 90%; line-height: 0.8;' | '''GetDefaultButtStrength''' () const
|-
|
| style = 'color: #505050; line-height: 0.5;' |''get default butt strength''
|-
| style='color: blue; width: 10%; text-align:right;line-height: 0.8;' | [[../BasicDataTypes|void]] 
| style='color: black; width: 90%; line-height: 0.8;' | '''SetButtStrength''' (const [[../BasicDataTypes|float]] ''_fValue'')
|-
|
| style = 'color: #505050; line-height: 0.5;' |''set butt strength''
|-
| style='color: blue; width: 10%; text-align:right;line-height: 0.8;' | [[../BasicDataTypes|void]] 
| style='color: black; width: 90%; line-height: 0.8;' | '''GetButtLayerSpeedA''' ([[../BasicDataTypes|float]]&out ''_fOutX'', [[../BasicDataTypes|float]]&out ''_fOutZ'') const
|-
|
| style = 'color: #505050; line-height: 0.5;' |''get current butt speed for layer A''
|-
| style='color: blue; width: 10%; text-align:right;line-height: 0.8;' | [[../BasicDataTypes|void]] 
| style='color: black; width: 90%; line-height: 0.8;' | '''GetDefaultButtLayerSpeedA''' ([[../BasicDataTypes|float]]&out ''_fOutX'', [[../BasicDataTypes|float]]&out ''_fOutZ'') const
|-
|
| style = 'color: #505050; line-height: 0.5;' |''get default butt speed for layer A''
|-
| style='color: blue; width: 10%; text-align:right;line-height: 0.8;' | [[../BasicDataTypes|void]] 
| style='color: black; width: 90%; line-height: 0.8;' | '''SetButtLayerSpeedA''' (const [[../BasicDataTypes|float]] ''_fX'', const [[../BasicDataTypes|float]] ''_fZ'')
|-
|
| style = 'color: #505050; line-height: 0.5;' |''set butt speed for layer A''
|-
| style='color: blue; width: 10%; text-align:right;line-height: 0.8;' | [[../BasicDataTypes|void]] 
| style='color: black; width: 90%; line-height: 0.8;' | '''GetButtLayerSpeedB''' ([[../BasicDataTypes|float]]&out ''_fOutX'', [[../BasicDataTypes|float]]&out ''_fOutZ'') const
|-
|
| style = 'color: #505050; line-height: 0.5;' |''get current butt speed for layer B''
|-
| style='color: blue; width: 10%; text-align:right;line-height: 0.8;' | [[../BasicDataTypes|void]] 
| style='color: black; width: 90%; line-height: 0.8;' | '''GetDefaultButtLayerSpeedB''' ([[../BasicDataTypes|float]]&out ''_fOutX'', [[../BasicDataTypes|float]]&out ''_fOutZ'') const
|-
|
| style = 'color: #505050; line-height: 0.5;' |''get default butt speed for layer B''
|-
| style='color: blue; width: 10%; text-align:right;line-height: 0.8;' | [[../BasicDataTypes|void]] 
| style='color: black; width: 90%; line-height: 0.8;' | '''SetButtLayerSpeedB''' (const [[../BasicDataTypes|float]] ''_fX'', const [[../BasicDataTypes|float]] ''_fZ'')
|-
|
| style = 'color: #505050; line-height: 0.5;' |''set butt speed for layer B''
|-
| style='color: blue; width: 10%; text-align:right;line-height: 0.8;' | [[../BasicDataTypes|bool]] 
| style='color: black; width: 90%; line-height: 0.8;' | '''IsEffectEnabled''' (const [[../VisualEnums#EWeatherEffect|EWeatherEffect]] ''_Effect'') const
|-
|
| style = 'color: #505050; line-height: 0.5;' |''is effect currently enabled?''
|-
| style='color: blue; width: 10%; text-align:right;line-height: 0.8;' | [[../BasicDataTypes|bool]] 
| style='color: black; width: 90%; line-height: 0.8;' | '''IsEffectEnabledByDefault''' (const [[../VisualEnums#EWeatherEffect|EWeatherEffect]] ''_Effect'') const
|-
|
| style = 'color: #505050; line-height: 0.5;' |''is effect enabled by default?''
|-
| style='color: blue; width: 10%; text-align:right;line-height: 0.8;' | [[../BasicDataTypes|void]] 
| style='color: black; width: 90%; line-height: 0.8;' | '''EnableEffect''' (const [[../VisualEnums#EWeatherEffect|EWeatherEffect]] ''_Effect'', const [[../BasicDataTypes|bool]] ''_bEnabled'')
|-
|
| style = 'color: #505050; line-height: 0.5;' |''enable or disable effect''
|-
| style='color: blue; width: 10%; text-align:right;line-height: 0.8;' | [[../BasicDataTypes|float]] 
| style='color: black; width: 90%; line-height: 0.8;' | '''GetEffectIntensity''' (const [[../VisualEnums#EWeatherEffect|EWeatherEffect]] ''_Effect'') const
|-
|
| style = 'color: #505050; line-height: 0.5;' |''get current effect intensity''
|-
| style='color: blue; width: 10%; text-align:right;line-height: 0.8;' | [[../BasicDataTypes|float]] 
| style='color: black; width: 90%; line-height: 0.8;' | '''GetDefaultEffectIntensity''' (const [[../VisualEnums#EWeatherEffect|EWeatherEffect]] ''_Effect'') const
|-
|
| style = 'color: #505050; line-height: 0.5;' |''get default effect intensity''
|-
| style='color: blue; width: 10%; text-align:right;line-height: 0.8;' | [[../BasicDataTypes|void]] 
| style='color: black; width: 90%; line-height: 0.8;' | '''SetEffectIntensity''' (const [[../VisualEnums#EWeatherEffect|EWeatherEffect]] ''_Effect'', const [[../BasicDataTypes|float]] ''_fValue'')
|-
|
| style = 'color: #505050; line-height: 0.5;' |''set effect intensity''
|}