Difference between revisions of "Script/WeatherReference"
From SF3
| (6 intermediate revisions by the same user not shown) | |||
| Line 5: | Line 5: | ||
{| border='0' style ='border:solid 1px #eeeedd; color: black; width: 1200px;background-color: #ffffcc;' cellspacing='0' cellpadding='7' | {| 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| | + | | style='color: blue; width: 10%; text-align:right;line-height: 0.8;' | [[../BasicDataTypes|int]] |
| − | | style='color: black; width: 90%; line-height: 0.8;' | ''' | + | | 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|uint8]] | ||
| + | | style='color: black; width: 90%; line-height: 1.0;' | '''GetCurrentMapSetting''' () const | ||
|- | |- | ||
| | | | ||
| − | | style = 'color: #505050; line-height: 0.5;' |''get the | + | | style = 'color: #505050; line-height: 0.5;' |''get the setting index of the current level'' |
|- | |- | ||
| style='color: blue; width: 10%; text-align:right;line-height: 0.8;' | [[../BasicDataTypes|void]] | | style='color: blue; width: 10%; text-align:right;line-height: 0.8;' | [[../BasicDataTypes|void]] | ||
| Line 162: | Line 174: | ||
|- | |- | ||
| style='color: blue; width: 10%; text-align:right;line-height: 0.8;' | [[../BasicDataTypes|bool]] | | style='color: blue; width: 10%; text-align:right;line-height: 0.8;' | [[../BasicDataTypes|bool]] | ||
| − | | style='color: black; width: 90%; line-height: 0.8;' | ''' | + | | style='color: black; width: 90%; line-height: 0.8;' | '''IsEffectEnabled''' (const [[../VisualEnums#EWeatherEffect|EWeatherEffect]] ''_Effect'') const |
|- | |- | ||
| | | | ||
| − | | style = 'color: #505050; line-height: 0.5;' |''is | + | | 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: blue; width: 10%; text-align:right;line-height: 0.8;' | [[../BasicDataTypes|bool]] | ||
| − | | style='color: black; width: 90%; line-height: 0.8;' | ''' | + | | style='color: black; width: 90%; line-height: 0.8;' | '''IsEffectEnabledByDefault''' (const [[../VisualEnums#EWeatherEffect|EWeatherEffect]] ''_Effect'') const |
|- | |- | ||
| | | | ||
| − | | style = 'color: #505050; line-height: 0.5;' |''is | + | | 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: blue; width: 10%; text-align:right;line-height: 0.8;' | [[../BasicDataTypes|void]] | ||
| − | | style='color: black; width: 90%; line-height: 0.8;' | ''' | + | | 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 | + | | 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: blue; width: 10%; text-align:right;line-height: 0.8;' | [[../BasicDataTypes|float]] | ||
| − | | style='color: black; width: 90%; line-height: 0.8;' | ''' | + | | 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 | + | | 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: blue; width: 10%; text-align:right;line-height: 0.8;' | [[../BasicDataTypes|float]] | ||
| − | | style='color: black; width: 90%; line-height: 0.8;' | ''' | + | | 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 | + | | 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: blue; width: 10%; text-align:right;line-height: 0.8;' | [[../BasicDataTypes|void]] | ||
| − | | style='color: black; width: 90%; line-height: 0.8;' | ''' | + | | 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 | + | | style = 'color: #505050; line-height: 0.5;' |''set effect intensity'' |
|} | |} | ||
Latest revision as of 16:53, 3 July 2017
class WeatherReference
A script which handles the weather.
Class Methods
| int | GetWorldTimeMS () const |
| get the absolute time in milliseconds that has passed since the level has started | |
| int | GetDeterministicRandomInt (const int _iFrom, const int _iTo) const |
| returns a deterministic random integer in the range [_iFrom; _iTo[ | |
| uint8 | GetCurrentMapSetting () const |
| get the setting index of the current level | |
| void | RestoreDefaultWeather () |
| restore weather settings to default | |
| float | GetShadowStrength () const |
| get current shadow strength | |
| float | GetDefaultShadowStrength () const |
| get default shadow strength | |
| void | SetShadowStrength (const float _fValue) |
| set shadow strength | |
| float | GetRoughness () const |
| get current roughness | |
| float | GetDefaultRoughness () const |
| get default roughness | |
| void | SetRoughness (const float _fValue) |
| set roughness | |
| float | GetViewDependentRoughness () const |
| get current view dependent roughness | |
| float | GetDefaultViewDependentRoughness () const |
| get default view dependent roughness | |
| void | SetViewDependentRoughness (const float _fValue) |
| set view dependent roughness | |
| float | GetCloudScale () const |
| get current cloud scale | |
| float | GetDefaultCloudScale () const |
| get default cloud scale | |
| void | SetCloudScale (const float _fValue) |
| set cloud scale | |
| float | GetCloudDensity () const |
| get current cloud density | |
| float | GetDefaultCloudDensity () const |
| get default cloud density | |
| void | SetCloudDensity (const float _fValue) |
| set cloud scale | |
| float | GetCloudStrength () const |
| get current cloud strength | |
| float | GetDefaultCloudStrength () const |
| get default cloud strength | |
| void | SetCloudStrength (const float _fValue) |
| set cloud strength | |
| void | GetCloudLayerSpeedA (float&out _fOutX, float&out _fOutZ) const |
| get current cloud speed for layer A | |
| void | GetDefaultCloudLayerSpeedA (float&out _fOutX, float&out _fOutZ) const |
| get default cloud speed for layer A | |
| void | SetCloudLayerSpeedA (const float _fX, const float _fZ) |
| set cloud speed for layer A | |
| void | GetCloudLayerSpeedB (float&out _fOutX, float&out _fOutZ) const |
| get current cloud speed for layer B | |
| void | GetDefaultCloudLayerSpeedB (float&out _fOutX, float&out _fOutZ) const |
| get default cloud speed for layer B | |
| void | SetCloudLayerSpeedB (const float _fX, const float _fZ) |
| set cloud speed for layer B | |
| bool | IsEffectEnabled (const EWeatherEffect _Effect) const |
| is effect currently enabled? | |
| bool | IsEffectEnabledByDefault (const EWeatherEffect _Effect) const |
| is effect enabled by default? | |
| void | EnableEffect (const EWeatherEffect _Effect, const bool _bEnabled) |
| enable or disable effect | |
| float | GetEffectIntensity (const EWeatherEffect _Effect) const |
| get current effect intensity | |
| float | GetDefaultEffectIntensity (const EWeatherEffect _Effect) const |
| get default effect intensity | |
| void | SetEffectIntensity (const EWeatherEffect _Effect, const float _fValue) |
| set effect intensity |
