Класс WeatherPhenomenon

Закрытые члены
void	WeatherPhenomenon ()
void	~WeatherPhenomenon ()
proto native EWeatherPhenomenon	GetType ()
	Returns type of this phenomenon.
proto native float	GetActual ()
	Returns actual value of phenomenon in range <0, 1>.
proto native float	GetForecast ()
	Returns a forecast value the phenomenon is heading towards.
proto native void	Set (float forecast, float time=0, float minDuration=0)
	Sets the forecast.
proto native float	GetNextChange ()
	Reads the time in seconds when the next forecast will be computed.
proto native void	SetNextChange (float time)
	Sets the time in seconds when the next forecast will be computed.
proto void	GetLimits (out float fnMin, out float fnMax)
	Reads limits of this phenomenon.
proto native void	SetLimits (float fnMin, float fnMax)
	Sets limits of this phenomenon.
proto void	GetForecastChangeLimits (out float fcMin, out float fcMax)
	Reads limits of change when forecast is computed.
proto native void	SetForecastChangeLimits (float fcMin, float fcMax)
	Sets limits of change when forecast is computed.
proto void	GetForecastTimeLimits (out float ftMin, out float ftMax)
	Reads time range in which next forecast can be computed.
proto native void	SetForecastTimeLimits (float ftMin, float ftMax)
	Sets time range in which next forecast can be computed.
bool	OnBeforeChange (float change, float time)
	Is called every time the Phenomenon computes new forecast.

Подробное описание

Weather phenomenon

Конструктор(ы)

WeatherPhenomenon()

void WeatherPhenomenon ( )

inlineprivate

{}

~WeatherPhenomenon()

void ~WeatherPhenomenon ( )

inlineprivate

{}

Методы

GetActual()

proto native float GetActual ( )

private

Returns actual value of phenomenon in range <0, 1>.

Используется в OnBeforeChange().

GetForecast()

proto native float GetForecast ( )

private

Returns a forecast value the phenomenon is heading towards.

GetForecastChangeLimits()

proto void GetForecastChangeLimits ( out float fcMin, out float fcMax )

private

Reads limits of change when forecast is computed.

Аргументы

fcMin	Forecast change minimum (in range <0, 1>).
fcMax	Forecast change maximum (in range <0, 1>).

GetForecastTimeLimits()

proto void GetForecastTimeLimits ( out float ftMin, out float ftMax )

private

Reads time range in which next forecast can be computed.

Аргументы

ftMin	Minimal number of seconds.
ftMax	Maximal number of seconds.

GetLimits()

proto void GetLimits ( out float fnMin, out float fnMax )

private

Reads limits of this phenomenon.

Аргументы

fnMin	Function minimum (in range <0, 1>).
fnMax	Function maximum (in range <0, 1>).

GetNextChange()

proto native float GetNextChange ( )

private

Reads the time in seconds when the next forecast will be computed.

GetType()

proto native EWeatherPhenomenon GetType ( )

private

Returns type of this phenomenon.

Используется в OnBeforeChange().

OnBeforeChange()

bool OnBeforeChange ( float change, float time )

inlineprivate

Is called every time the Phenomenon computes new forecast.

Заметки

Called on server only.

Аргументы

change	Computed change of forecast value.
time	Seconds when the next forecast will be computed.

Возвращает

True when script modifies state of this phenomenon false otherwise.

    {
        // 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;
    }

Перекрестные ссылки g_Game, GetActual() и GetType().

Set()

proto native void Set ( float forecast, float time = 0, float minDuration = 0 )

private

Sets the forecast.

Аргументы

forecast	Desired forecast value that should be met in given time.
time	A time of the next change (how long it takes in seconds to interpolate to given value).
minDuration	A minimal time in seconds the change will last.

SetForecastChangeLimits()

proto native void SetForecastChangeLimits ( float fcMin, float fcMax )

private

Sets limits of change when forecast is computed.

These limits govern how much the forecast value can change when it is computed by weather controller.

Default values are: fcMin = 0 fcMax = 1

Аргументы

fcMin	Forecast change minimum (in range <0, 1>).
fcMax	Forecast change maximum (in range <0, 1>).

SetForecastTimeLimits()

proto native void SetForecastTimeLimits ( float ftMin, float ftMax )

private

Sets time range in which next forecast can be computed.

Default values are: ftMin = 300 (5 minutes) ftMax = 3600 (1 hour)

Аргументы

ftMin	Minimal number of seconds.
ftMax	Maximal number of seconds.

SetLimits()

proto native void SetLimits ( float fnMin, float fnMax )

private

Sets limits of this phenomenon.

Actual value of this phenomenon will be always held in range <fnMin, fnMax>.

Default values are: fnMin = 0 fnMax = 1

Аргументы

fnMin	Function minimum (in range <0, 1>).
fnMax	Function maximum (in range <0, 1>).

SetNextChange()

proto native void SetNextChange ( float time )

private

Sets the time in seconds when the next forecast will be computed.

---

Объявления и описания членов класса находятся в файле:

• D:/Ishodniki/scripts/3_Game/Weather.c