Difference between revisions of "Script/WeatherReference"

From SF3
Jump to: navigation, search
 
(One intermediate revision by the same user not shown)
Line 16: Line 16:
 
|
 
|
 
| style = 'color: #505050; line-height: 0.5;' |''returns a deterministic random integer in the range [_iFrom; _iTo[''
 
| 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 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 78: Line 84:
 
|-
 
|-
 
| 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;' | '''GetButtScale''' () const
+
| style='color: black; width: 90%; line-height: 0.8;' | '''GetCloudScale''' () const
 
|-
 
|-
 
|
 
|
−
| style = 'color: #505050; line-height: 0.5;' |''get current butt scale''
+
| style = 'color: #505050; line-height: 0.5;' |''get current cloud scale''
 
|-
 
|-
 
| 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;' | '''GetDefaultButtScale''' () const
+
| style='color: black; width: 90%; line-height: 0.8;' | '''GetDefaultCloudScale''' () const
 
|-
 
|-
 
|
 
|
−
| style = 'color: #505050; line-height: 0.5;' |''get default butt scale''
+
| style = 'color: #505050; line-height: 0.5;' |''get default cloud scale''
 
|-
 
|-
 
| 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;' | '''SetButtScale''' (const [[../BasicDataTypes|float]] ''_fValue'')
+
| style='color: black; width: 90%; line-height: 0.8;' | '''SetCloudScale''' (const [[../BasicDataTypes|float]] ''_fValue'')
 
|-
 
|-
 
|
 
|
−
| style = 'color: #505050; line-height: 0.5;' |''set butt scale''
+
| style = 'color: #505050; line-height: 0.5;' |''set cloud scale''
 
|-
 
|-
 
| 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;' | '''GetButtDensity''' () const
+
| style='color: black; width: 90%; line-height: 0.8;' | '''GetCloudDensity''' () const
 
|-
 
|-
 
|
 
|
−
| style = 'color: #505050; line-height: 0.5;' |''get current butt density''
+
| style = 'color: #505050; line-height: 0.5;' |''get current cloud density''
 
|-
 
|-
 
| 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;' | '''GetDefaultButtDensity''' () const
+
| style='color: black; width: 90%; line-height: 0.8;' | '''GetDefaultCloudDensity''' () const
 
|-
 
|-
 
|
 
|
−
| style = 'color: #505050; line-height: 0.5;' |''get default butt density''
+
| style = 'color: #505050; line-height: 0.5;' |''get default cloud density''
 
|-
 
|-
 
| 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;' | '''SetButtDensity''' (const [[../BasicDataTypes|float]] ''_fValue'')
+
| style='color: black; width: 90%; line-height: 0.8;' | '''SetCloudDensity''' (const [[../BasicDataTypes|float]] ''_fValue'')
 
|-
 
|-
 
|
 
|
−
| style = 'color: #505050; line-height: 0.5;' |''set butt scale''
+
| style = 'color: #505050; line-height: 0.5;' |''set cloud scale''
 
|-
 
|-
 
| 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;' | '''GetButtStrength''' () const
+
| style='color: black; width: 90%; line-height: 0.8;' | '''GetCloudStrength''' () const
 
|-
 
|-
 
|
 
|
−
| style = 'color: #505050; line-height: 0.5;' |''get current butt strength''
+
| style = 'color: #505050; line-height: 0.5;' |''get current cloud strength''
 
|-
 
|-
 
| 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;' | '''GetDefaultButtStrength''' () const
+
| style='color: black; width: 90%; line-height: 0.8;' | '''GetDefaultCloudStrength''' () const
 
|-
 
|-
 
|
 
|
−
| style = 'color: #505050; line-height: 0.5;' |''get default butt strength''
+
| style = 'color: #505050; line-height: 0.5;' |''get default cloud strength''
 
|-
 
|-
 
| 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;' | '''SetButtStrength''' (const [[../BasicDataTypes|float]] ''_fValue'')
+
| style='color: black; width: 90%; line-height: 0.8;' | '''SetCloudStrength''' (const [[../BasicDataTypes|float]] ''_fValue'')
 
|-
 
|-
 
|
 
|
−
| style = 'color: #505050; line-height: 0.5;' |''set butt strength''
+
| style = 'color: #505050; line-height: 0.5;' |''set cloud strength''
 
|-
 
|-
 
| 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;' | '''GetButtLayerSpeedA''' ([[../BasicDataTypes|float]]&out ''_fOutX'', [[../BasicDataTypes|float]]&out ''_fOutZ'') const
+
| style='color: black; width: 90%; line-height: 0.8;' | '''GetCloudLayerSpeedA''' ([[../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: #505050; line-height: 0.5;' |''get current cloud speed for layer A''
 
|-
 
|-
 
| 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;' | '''GetDefaultButtLayerSpeedA''' ([[../BasicDataTypes|float]]&out ''_fOutX'', [[../BasicDataTypes|float]]&out ''_fOutZ'') const
+
| style='color: black; width: 90%; line-height: 0.8;' | '''GetDefaultCloudLayerSpeedA''' ([[../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: #505050; line-height: 0.5;' |''get default cloud speed for layer A''
 
|-
 
|-
 
| 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;' | '''SetButtLayerSpeedA''' (const [[../BasicDataTypes|float]] ''_fX'', const [[../BasicDataTypes|float]] ''_fZ'')
+
| style='color: black; width: 90%; line-height: 0.8;' | '''SetCloudLayerSpeedA''' (const [[../BasicDataTypes|float]] ''_fX'', const [[../BasicDataTypes|float]] ''_fZ'')
 
|-
 
|-
 
|
 
|
−
| style = 'color: #505050; line-height: 0.5;' |''set butt speed for layer A''
+
| style = 'color: #505050; line-height: 0.5;' |''set cloud speed for layer A''
 
|-
 
|-
 
| 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;' | '''GetButtLayerSpeedB''' ([[../BasicDataTypes|float]]&out ''_fOutX'', [[../BasicDataTypes|float]]&out ''_fOutZ'') const
+
| style='color: black; width: 90%; line-height: 0.8;' | '''GetCloudLayerSpeedB''' ([[../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: #505050; line-height: 0.5;' |''get current cloud speed for layer B''
 
|-
 
|-
 
| 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;' | '''GetDefaultButtLayerSpeedB''' ([[../BasicDataTypes|float]]&out ''_fOutX'', [[../BasicDataTypes|float]]&out ''_fOutZ'') const
+
| style='color: black; width: 90%; line-height: 0.8;' | '''GetDefaultCloudLayerSpeedB''' ([[../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: #505050; line-height: 0.5;' |''get default cloud speed for layer B''
 
|-
 
|-
 
| 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;' | '''SetButtLayerSpeedB''' (const [[../BasicDataTypes|float]] ''_fX'', const [[../BasicDataTypes|float]] ''_fZ'')
+
| style='color: black; width: 90%; line-height: 0.8;' | '''SetCloudLayerSpeedB''' (const [[../BasicDataTypes|float]] ''_fX'', const [[../BasicDataTypes|float]] ''_fZ'')
 
|-
 
|-
 
|
 
|
−
| style = 'color: #505050; line-height: 0.5;' |''set butt speed for layer B''
+
| style = 'color: #505050; line-height: 0.5;' |''set cloud speed for layer B''
 
|-
 
|-
 
| 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]]  

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

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[
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 GetButtScale () const
get current butt scale
float GetDefaultButtScale () const
get default butt scale
void SetButtScale (const float _fValue)
set butt scale
float GetButtDensity () const
get current butt density
float GetDefaultButtDensity () const
get default butt density
void SetButtDensity (const float _fValue)
set butt scale
float GetButtStrength () const
get current butt strength
float GetDefaultButtStrength () const
get default butt strength
void SetButtStrength (const float _fValue)
set butt strength
void GetButtLayerSpeedA (float&out _fOutX, float&out _fOutZ) const
get current butt speed for layer A
void GetDefaultButtLayerSpeedA (float&out _fOutX, float&out _fOutZ) const
get default butt speed for layer A
void SetButtLayerSpeedA (const float _fX, const float _fZ)
set butt speed for layer A
void GetButtLayerSpeedB (float&out _fOutX, float&out _fOutZ) const
get current butt speed for layer B
void GetDefaultButtLayerSpeedB (float&out _fOutX, float&out _fOutZ) const
get default butt speed for layer B
void SetButtLayerSpeedB (const float _fX, const float _fZ)
set butt 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
Retrieved from "http://sf3scripting.spellforce.com/index.php?title=Script/WeatherReference&oldid=548"