Keeps information about currently loaded world, like temperature. More...

Private Member Functions
void	WorldData ()

void	Init ()

float	GetApproxSunriseTime (float monthday)

float	GetApproxSunsetTime (float monthday)

int	GetDaytime ()

protected float	CalcBaseEnvironmentTemperature (float monthday, float daytime)

void	UpdateBaseEnvTemperature (float timeslice)

void	UpdateWeatherEffects (Weather weather, float timeslice)
	Updates local weather effects.

float	ComputeSnowflakeScale (Weather weather)
	Returns the desired snowflake scale based on weather simulation state.

float	GetBaseEnvTemperature ()

float	GetBaseEnvTemperatureAtObject (notnull Object object)

float	GetBaseEnvTemperatureAtPosition (vector pos)

float	GetBaseEnvTemperatureExact (int month, int day, int hour, int minute)

float	GetLiquidTypeEnviroTemperature (int liquidType)

bool	WeatherOnBeforeChange (EWeatherPhenomenon type, float actual, float change, float time)

array< vector >	GetArtyFiringPos ()

float	GetAgentSpawnChance (eAgents agent)

float	GetColdAreaToolDamageModifier ()

void	BaseTempDebug (int month, int day)

int	GetPollution ()

float	GetWindCoef ()

float	GetUniversalTemperatureSourceCapModifier ()

float	GetTemperature (Object object, EEnvironmentTemperatureComponent properties=EEnvironmentTemperatureComponent.BASE)
	Return actual temperature of environment based on provided parameters.

float	GetTemperatureComponentValue (float temperatureIn, EEnvironmentTemperatureComponent properties=0)
	Return value of queried EEnvironmentTemperatureComponent which can be used in future calculation(s)

protected float	WindEffectTemperatureValue (float temperatureInput)

protected void	CalculateWind (int newWeather, bool suddenChange, out float magnitude, out float direction)

protected void	CalculateVolFog (float lerpValue, float windMagnitude, float changeTime)

protected void	CreateYieldBank ()

protected void	InitYieldBank ()
	override this to properly register world-specific yields

protected void	SetupWeatherSettings ()

protected void	SetupLiquidTemperatures ()

CatchYieldBank	GetCatchYieldBank ()

TStringArray	GetDefaultPRAPaths ()

float	GetDayTemperature ()

float	GetNightTemperature ()

Private Attributes
const float	SPAWN_CHANCE_CHOLERA_DEF = 50

const float	COLD_AREA_TOOL_DMG_MODIF_DEF = 1

float	m_TemperaturePerHeightReductionModifier
	directly accesible (defined/overriden in Init())

float	m_CloudsTemperatureEffectModifier
	amount of °C reduced for each 100 meteres of height above water level

float	m_TemperatureInsideBuildingsModifier
	how many % of environment temperature can be lowered by clouds

float	m_WaterContactTemperatureModifier

protected float	SUDDENCHANGE_TIME_MULTIPLIER = 0.2

protected float	SUDDENCHANGE_LENGTH_MULTIPLIER = 0.4

protected float	WIND_MAGNITUDE_TIME_MULTIPLIER = 0.1

protected float	WIND_DIRECTION_TIME_MULTIPLIER = 0.05

protected Weather	m_Weather

protected float	m_EnvironmentTemperature

protected bool	m_EnTempUpdated

protected float	m_Timer

protected float	m_MaxTemps [12]

protected float	m_MinTemps [12]

protected float	m_Sunrise_Jan

protected float	m_Sunset_Jan

protected float	m_Sunrise_Jul

protected float	m_Sunset_Jul

protected ref array< vector >	m_FiringPos

protected bool	m_Pollution

protected ref CatchYieldBank	m_YieldBank

protected ref WorldDataWeatherSettings	m_WeatherDefaultSettings

protected ref WorldDataLiquidSettings	m_LiquidSettings

protected ref TStringArray	m_DefaultPlayerRestrictedAreas

protected int	m_BadWeatherChance
	weather related

protected int	m_ClearWeatherChance

protected bool	m_IsSuddenChange

protected float	m_WorldWindCoef

protected float	m_UniversalTemperatureSourceCapModifier

protected int	m_SameWeatherCnt = 0

protected int	m_StepValue = 5

protected int	m_Chance = 50

protected int	m_ChoosenWeather = 1

protected int	m_LastWeather = 0

protected float	m_DayTemperature = 10

protected float	m_NightTemperature = 6

Detailed Description

Keeps information about currently loaded world, like temperature.

Constructor & Destructor Documentation

◆ WorldData()

void WorldData ( )

inlineprivate

References CreateYieldBank(), Init(), InitYieldBank(), and UpdateBaseEnvTemperature().

Member Function Documentation

◆ BaseTempDebug()

void BaseTempDebug	(	int	month,
		int	day
	)

inlineprivate

References GetBaseEnvTemperatureExact(), and Print().

◆ CalcBaseEnvironmentTemperature()

protected float CalcBaseEnvironmentTemperature	(	float	monthday,
		float	daytime
	)

inlineprivate

References Math::AbsFloat(), Math::Floor(), GetApproxSunriseTime(), GetApproxSunsetTime(), Math::Lerp(), m_MaxTemps, and m_MinTemps.

Referenced by GetBaseEnvTemperatureExact(), and UpdateBaseEnvTemperature().

◆ CalculateVolFog()

protected void CalculateVolFog	(	float	lerpValue,
		float	windMagnitude,
		float	changeTime
	)

private

◆ CalculateWind()

protected void CalculateWind	(	int	newWeather,
		bool	suddenChange,
		out float	magnitude,
		out float	direction
	)

private

◆ ComputeSnowflakeScale()

float ComputeSnowflakeScale ( Weather weather )

inlineprivate

Returns the desired snowflake scale based on weather simulation state.

Parameters

weather Weather instance

References Math::Clamp(), WeatherPhenomenon::GetActual(), Weather::GetOvercast(), Weather::GetWindMaximumSpeed(), Weather::GetWindSpeed(), Math::InverseLerp(), and Math::Lerp().

Referenced by UpdateWeatherEffects().

◆ CreateYieldBank()

protected void CreateYieldBank ( )

inlineprivate

References m_YieldBank.

Referenced by WorldData().

◆ GetAgentSpawnChance()

float GetAgentSpawnChance ( eAgents agent )

inlineprivate

References SPAWN_CHANCE_CHOLERA_DEF.

Referenced by Bottle_Base::EEOnCECreate().

◆ GetApproxSunriseTime()

float GetApproxSunriseTime ( float monthday )

inlineprivate

References m_Sunrise_Jan, and m_Sunrise_Jul.

Referenced by CalcBaseEnvironmentTemperature(), and GetDaytime().

◆ GetApproxSunsetTime()

float GetApproxSunsetTime ( float monthday )

inlineprivate

References m_Sunset_Jan, and m_Sunset_Jul.

Referenced by CalcBaseEnvironmentTemperature(), and GetDaytime().

◆ GetArtyFiringPos()

array< vector > GetArtyFiringPos ( )

inlineprivate

References m_FiringPos.

◆ GetBaseEnvTemperature()

float GetBaseEnvTemperature ( )

inlineprivate

References m_EnvironmentTemperature.

Referenced by GetDebugMessage(), and GetTemperature().

◆ GetBaseEnvTemperatureAtObject()

float GetBaseEnvTemperatureAtObject ( notnull Object object )

inlineprivate

References GetBaseEnvTemperatureAtPosition(), and GetPosition().

Referenced by GetDebugMessage(), GetTemperature(), Init(), and SetAreaGenericColdness().

◆ GetBaseEnvTemperatureAtPosition()

float GetBaseEnvTemperatureAtPosition ( vector pos )

inlineprivate

References m_EnvironmentTemperature, m_TemperaturePerHeightReductionModifier, and Math::Max().

Referenced by GetBaseEnvTemperatureAtObject().

◆ GetBaseEnvTemperatureExact()

float GetBaseEnvTemperatureExact	(	int	month,
		int	day,
		int	hour,
		int	minute
	)

inlineprivate

References CalcBaseEnvironmentTemperature().

Referenced by BaseTempDebug().

◆ GetCatchYieldBank()

CatchYieldBank GetCatchYieldBank ( )

inlineprivate

References m_YieldBank.

◆ GetColdAreaToolDamageModifier()

float GetColdAreaToolDamageModifier ( )

inlineprivate

References COLD_AREA_TOOL_DMG_MODIF_DEF.

◆ GetDayTemperature()

float GetDayTemperature ( )

inlineprivate

References m_DayTemperature.

◆ GetDaytime()

int GetDaytime ( )

inlineprivate

References WorldDataDaytime::DAWN, WorldDataDaytime::DAY, WorldDataDaytime::DUSK, g_Game, GetApproxSunriseTime(), GetApproxSunsetTime(), and WorldDataDaytime::NIGHT.

Referenced by SetTimeOfDate().

◆ GetDefaultPRAPaths()

TStringArray GetDefaultPRAPaths ( )

inlineprivate

References m_DefaultPlayerRestrictedAreas.

◆ GetLiquidTypeEnviroTemperature()

float GetLiquidTypeEnviroTemperature ( int liquidType )

inlineprivate

References ErrorEx, INDEX_NOT_FOUND, m_EnvironmentTemperature, and m_LiquidSettings.

Referenced by ManBase::Consume(), GetEnvironmentTemperature(), and SetProcessedItemTemperature().

◆ GetNightTemperature()

float GetNightTemperature ( )

inlineprivate

References m_NightTemperature.

◆ GetPollution()

int GetPollution ( )

inlineprivate

References m_Pollution.

Referenced by ManBase::Consume().

◆ GetTemperature()

float GetTemperature	(	Object	object,
		EEnvironmentTemperatureComponent	properties = `EEnvironmentTemperatureComponent.BASE`
	)

inlineprivate

Return actual temperature of environment based on provided parameters.

Parameters

object	Reference to object that is used mainly for sea height related calculation
properties	Flag made of EEnvironmentTemperatureComponent which will influence the resulting value of temperature based on combination of the parts

References GameConstants::ENVIRO_FOG_TEMP_EFFECT, WeatherPhenomenon::GetActual(), GetBaseEnvTemperature(), GetBaseEnvTemperatureAtObject(), Weather::GetFog(), Weather::GetOvercast(), m_CloudsTemperatureEffectModifier, m_Weather, and WindEffectTemperatureValue().

Referenced by GetEnvironmentTemperature().

◆ GetTemperatureComponentValue()

float GetTemperatureComponentValue	(	float	temperatureIn,
		EEnvironmentTemperatureComponent	properties = `0`
	)

inlineprivate

Return value of queried EEnvironmentTemperatureComponent which can be used in future calculation(s)

Parameters

temperature	Base temperature which will be used in component calculation (currently WIND only)
properties	Flag made of EEnvironmentTemperatureComponent which will influence the resulting value of temperature based on combination of the parts

References GameConstants::ENVIRO_FOG_TEMP_EFFECT, WeatherPhenomenon::GetActual(), Weather::GetFog(), Weather::GetOvercast(), Debug::Log(), m_CloudsTemperatureEffectModifier, m_Weather, and WindEffectTemperatureValue().

Referenced by GetEnvironmentTemperature().