Weather.c

Go to the documentation of this file.

 
//-----------------------------------------------------------------------------
enum EWeatherPhenomenon
{
    OVERCAST,
    FOG,
    RAIN
};
 
 
//-----------------------------------------------------------------------------
class WeatherPhenomenon
{
    private void WeatherPhenomenon() {}
    private void ~WeatherPhenomenon() {}
    
    proto native EWeatherPhenomenon GetType();
 
    proto native float GetActual();
 
    proto native float GetForecast();
 
    proto native void Set( float forecast, float time = 0, float minDuration = 0 );
 
    proto native float GetNextChange();
    proto native void SetNextChange( float time );
 
    proto void GetLimits( out float fnMin, out float fnMax );
    proto native void SetLimits( float fnMin, float fnMax );
 
    proto void GetForecastChangeLimits( out float fcMin, out float fcMax );
    proto native void SetForecastChangeLimits( float fcMin, float fcMax );
 
    proto void GetForecastTimeLimits( out float ftMin, out float ftMax );
    proto native void SetForecastTimeLimits( float ftMin, float ftMax );
 
    bool OnBeforeChange( float change, float time )
    {
        // check if mission forces use of custom weather
        Weather weather = g_Game.GetWeather();
        
        if ( weather.GetMissionWeather() )
            return false;
        
        // check for active worlddata with custom onbeforechange behaviour
        Mission currentMission = g_Game.GetMission();
 
        if ( currentMission )
        {
            WorldData worldData = currentMission.GetWorldData();
            if ( worldData )
            {
                return worldData.WeatherOnBeforeChange( GetType(), GetActual(), change, time );
            }
        }
 
        return false;
    }
};
 
 
typedef WeatherPhenomenon Overcast;
typedef WeatherPhenomenon Fog;
typedef WeatherPhenomenon Rain;
 
 
 
 
//-----------------------------------------------------------------------------
class Weather
{
    protected bool m_missionWeather;
    
    private void Weather()
    {
        m_missionWeather = false;
    }
    
    private void ~Weather() {}
    
    proto native float GetTime();
 
    proto native Overcast GetOvercast();
 
    proto native Fog GetFog();
 
    proto native Rain GetRain();
 
    proto native void SetStorm( float density, float threshold, float timeOut );
    
    proto native void SuppressLightningSimulation(bool state);
 
    proto native vector GetWind();
    proto native void SetWind( vector wind );
    proto native float GetWindSpeed();
    proto native void SetWindSpeed( float speed );
    proto native float GetWindMaximumSpeed();
    proto native void SetWindMaximumSpeed( float maxSpeed );
    proto void GetWindFunctionParams( out float fnMin, out float fnMax, out float fnSpeed );
    proto native void SetWindFunctionParams( float fnMin, float fnMax, float fnSpeed );
 
    proto native void SetRainThresholds( float tMin, float tMax, float tTime );
 
    void MissionWeather( bool use )
    {
        m_missionWeather = use;
    }
    
    bool GetMissionWeather()
    {
        return m_missionWeather;
    }
 
};