CWeather Class¶

Overview
Quick Reference
Constructors
Methods

Overview¶

Note

The CWeather class handles general weather state in a game area for wind, fog, rain, snow

The structure used for this class is CWeather

Quick Reference¶

Quick Ref

void CWeather::CWeather()

void CWeather::~CWeather()

void CWeather::AdvanceWeatherLevel(unsigned long nCurrentTime)

void CWeather::CancelCurrentWeather(CGameArea* pArea, unsigned long nCurrentTime)

void CWeather::CheckWeather()

void CWeather::CompressTime()

unsigned char CWeather::GetWind()

short CWeather::MapWindLevel(short nWeatherLevel)

unsigned short CWeather::Marshal()

void CWeather::OnAreaChange(unsigned char bForceOff)

void CWeather::ResetWeather(CGameArea* pArea, bool bPreDisperseFog)

void CWeather::SetCurrentWeather(CGameArea* pArea, unsigned short wWeatherFlags)

void CWeather::SetCurrentWeather(CGameArea* pArea, unsigned long nCurrentTime, unsigned char nWeatherType)

void CWeather::SetRainSound(short nRainLevel, unsigned long nLevelPercentage)

void CWeather::SetWind(short nWindLevel, unsigned long nLevelPercentage, unsigned char bResetAmbients)

void CWeather::Unmarshal(unsigned short wWeatherFlags)

void CWeather::Update()

void CWeather::UpdateFog()

void CWeather::UpdateRain()

void CWeather::UpdateSnow()

Constructors¶

Name	Description
CWeather::CWeather	Constructs a `CWeather` object
CWeather::CWeather	Destroys a `CWeather` object

CWeather::CWeather¶

Constructs a CWeather object

void CWeather::CWeather();

Remarks

Constructs a CWeather object

CWeather::~CWeather¶

Destroys the CWeather object

void CWeather::~CWeather();

Remarks

Destroys the CWeather object

Methods¶

Name	Description
CWeather::AdvanceWeatherLevel
CWeather::CancelCurrentWeather
CWeather::CheckWeather
CWeather::CompressTime
CWeather::GetWind
CWeather::MapWindLevel
CWeather::Marshal
CWeather::OnAreaChange
CWeather::ResetWeather
CWeather::SetCurrentWeather
CWeather::SetRainSound
CWeather::SetWind
CWeather::Unmarshal
CWeather::Update
CWeather::UpdateFog
CWeather::UpdateRain
CWeather::UpdateSnow

CWeather::AdvanceWeatherLevel¶

void CWeather::AdvanceWeatherLevel(unsigned long nCurrentTime);

Parameters

unsigned long nCurrentTime -

Remarks

CWeather::CancelCurrentWeather¶

void CWeather::CancelCurrentWeather(
   CGameArea* pArea,
   unsigned long nCurrentTime);

Parameters

CGameArea* pArea - pointer to game area object
unsigned long nCurrentTime -

Remarks

CWeather::CheckWeather¶

void CWeather::CheckWeather();

Remarks

CWeather::CompressTime¶

void CWeather::CompressTime();

Remarks

CWeather::GetWind¶

unsigned char CWeather::GetWind();

Return Value

Returns unsigned char

Remarks

CWeather::MapWindLevel¶

short CWeather::MapWindLevel(short nWeatherLevel);

Parameters

short nWeatherLevel -

Return Value

Returns short

Remarks

CWeather::Marshal¶

unsigned short CWeather::Marshal();

Return Value

Returns unsigned short

Remarks

CWeather::OnAreaChange¶

void CWeather::OnAreaChange(unsigned char bForceOff);

Parameters

unsigned char bForceOff -

Remarks

CWeather::ResetWeather¶

void CWeather::ResetWeather(
   CGameArea* pArea,
   bool bPreDisperseFog);

Parameters

CGameArea* pArea -
bool bPreDisperseFog -

Remarks

CWeather::SetCurrentWeather¶

void CWeather::SetCurrentWeather(
   CGameArea* pArea,
   unsigned short wWeatherFlags);

Parameters

CGameArea* pArea -
unsigned short wWeatherFlags -

Remarks

CWeather::SetCurrentWeather¶

void CWeather::SetCurrentWeather(
   CGameArea* pArea,
   unsigned long nCurrentTime,
   unsigned char nWeatherType);

Parameters

CGameArea* pArea -
unsigned long nCurrentTime -
unsigned char nWeatherType -

Remarks

CWeather::SetRainSound¶

void CWeather::SetRainSound(
   short nRainLevel,
   unsigned long nLevelPercentage);

Parameters

short nRainLevel -
unsigned long nLevelPercentage -

Remarks

CWeather::SetWind¶

void CWeather::SetWind(
   short nWindLevel,
   unsigned long nLevelPercentage,
   unsigned char bResetAmbients);

Parameters

short nWindLevel -
unsigned long nLevelPercentage -
unsigned char bResetAmbients -

Remarks

CWeather::Unmarshal¶

void CWeather::Unmarshal(unsigned short wWeatherFlags);

Parameters

unsigned short wWeatherFlags -

Remarks

CWeather::Update¶

void CWeather::Update();

Remarks

CWeather::UpdateFog¶

void CWeather::UpdateFog();

Remarks

CWeather::UpdateRain¶

void CWeather::UpdateRain();

Remarks

CWeather::UpdateSnow¶

void CWeather::UpdateSnow();

Remarks