Difference between revisions of "Script/WeatherReference"

From SF3
Jump to: navigation, search
(Class Methods)
Line 162: Line 162:
 
|-
 
|-
 
| 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;' | '''IsEffectEnabled''' (const [[../VisualEnums#enum EWeatherEffect|EWeatherEffect]] ''_Effect'') const
+
| style='color: black; width: 90%; line-height: 0.8;' | '''IsEffectEnabled''' (const [[../VisualEnums#EWeatherEffect|EWeatherEffect]] ''_Effect'') const
 
|-
 
|-
 
|
 
|
Line 168: Line 168:
 
|-
 
|-
 
| 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;' | '''IsEffectEnabledByDefault''' (const [[../VisualEnums#enum EWeatherEffect|EWeatherEffect]] ''_Effect'') const
+
| style='color: black; width: 90%; line-height: 0.8;' | '''IsEffectEnabledByDefault''' (const [[../VisualEnums#EWeatherEffect|EWeatherEffect]] ''_Effect'') const
 
|-
 
|-
 
|
 
|
Line 174: Line 174:
 
|-
 
|-
 
| 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;' | '''EnableEffect''' (const [[../VisualEnums#enum EWeatherEffect|EWeatherEffect]] ''_Effect'', const [[../BasicDataTypes|bool]] ''_bEnabled'')
+
| style='color: black; width: 90%; line-height: 0.8;' | '''EnableEffect''' (const [[../VisualEnums#EWeatherEffect|EWeatherEffect]] ''_Effect'', const [[../BasicDataTypes|bool]] ''_bEnabled'')
 
|-
 
|-
 
|
 
|
Line 180: Line 180:
 
|-
 
|-
 
| 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;' | '''GetEffectIntensity''' (const [[../VisualEnums#enum EWeatherEffect|EWeatherEffect]] ''_Effect'') const
+
| style='color: black; width: 90%; line-height: 0.8;' | '''GetEffectIntensity''' (const [[../VisualEnums#EWeatherEffect|EWeatherEffect]] ''_Effect'') const
 
|-
 
|-
 
|
 
|
Line 186: Line 186:
 
|-
 
|-
 
| 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;' | '''GetDefaultEffectIntensity''' (const [[../VisualEnums#enum EWeatherEffect|EWeatherEffect]] ''_Effect'') const
+
| style='color: black; width: 90%; line-height: 0.8;' | '''GetDefaultEffectIntensity''' (const [[../VisualEnums#EWeatherEffect|EWeatherEffect]] ''_Effect'') const
 
|-
 
|-
 
|
 
|
Line 192: Line 192:
 
|-
 
|-
 
| 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;' | '''SetEffectIntensity''' (const [[../VisualEnums#enum EWeatherEffect|EWeatherEffect]] ''_Effect'', const [[../BasicDataTypes|float]] ''_fValue'')
+
| 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''
 
| style = 'color: #505050; line-height: 0.5;' |''set effect intensity''
 
|}
 
|}

Revision as of 10:40, 7 September 2016

class WeatherReference

A script which handles the weather.

Class Methods

float GetWorldTime () const
get the absolute time in seconds that has passed since the level has started
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

float GetWorldTime () const
get the absolute time in seconds that has passed since the level has started
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