CTimerWorld Class¶

Overview
Quick Reference
Constructors
Methods

Overview¶

Note

The CTimerWorld class handles timers in the game world

The structure used for this class is CTimerWorld

Quick Reference¶

Quick Ref

void CTimerWorld::CTimerWorld()

void CTimerWorld::AddCurrentTime(unsigned long gameTime)

void CTimerWorld::AdvanceCurrentTime(unsigned long gameTime)

void CTimerWorld::CheckForTriggerEventAbsolute()

void CTimerWorld::CheckForTriggerEventPast()

unsigned char CTimerWorld::GetCurrentHour()

unsigned char CTimerWorld::GetCurrentHourRoundedUp()

virtual void __cdecl CTimerWorld::GetCurrentTimeString(unsigned long nFromTime, unsigned long strTimeFormat, CString& sTime)

unsigned char CTimerWorld::IsDawn()

unsigned char CTimerWorld::IsDay()

unsigned char CTimerWorld::IsDusk()

unsigned char CTimerWorld::IsNight()

void CTimerWorld::StartTime()

void CTimerWorld::StopTime()

void CTimerWorld::UpdateTime(unsigned char forceUpdate)

Constructors¶

Name	Description
CTimerWorld::CTimerWorld	Constructs a `CTimerWorld` object

CTimerWorld::CTimerWorld¶

Constructs a CTimerWorld object

void CTimerWorld::CTimerWorld();

Remarks

Constructs a CTimerWorld object

Methods¶

Name	Description
CTimerWorld::AddCurrentTime
CTimerWorld::AdvanceCurrentTime
CTimerWorld::CheckForTriggerEventAbsolute
CTimerWorld::CheckForTriggerEventPast
CTimerWorld::GetCurrentHour
CTimerWorld::GetCurrentHourRoundedUp
CTimerWorld::GetCurrentTimeString
CTimerWorld::IsDawn
CTimerWorld::IsDay
CTimerWorld::IsDusk
CTimerWorld::IsNight
CTimerWorld::StartTime
CTimerWorld::StopTime
CTimerWorld::UpdateTime

CTimerWorld::AddCurrentTime¶

void CTimerWorld::AddCurrentTime(unsigned long gameTime);

Parameters

unsigned long gameTime -

Remarks

CTimerWorld::AdvanceCurrentTime¶

void CTimerWorld::AdvanceCurrentTime(unsigned long gameTime);

Parameters

unsigned long gameTime -

Remarks

CTimerWorld::CheckForTriggerEventAbsolute¶

void CTimerWorld::CheckForTriggerEventAbsolute();

Remarks

CTimerWorld::CheckForTriggerEventPast¶

void CTimerWorld::CheckForTriggerEventPast();

Remarks

CTimerWorld::GetCurrentHour¶

unsigned char CTimerWorld::GetCurrentHour();

Return Value

Returns unsigned char

Remarks

CTimerWorld::GetCurrentHourRoundedUp¶

unsigned char CTimerWorld::GetCurrentHourRoundedUp();

Return Value

Returns unsigned char

Remarks

CTimerWorld::GetCurrentTimeString¶

virtual void __cdecl CTimerWorld::GetCurrentTimeString(
   unsigned long nFromTime,
   unsigned long strTimeFormat,
   CString& sTime);

Parameters

unsigned long nFromTime -
unsigned long strTimeFormat -
CString& sTime -

Remarks

CTimerWorld::IsDawn¶

unsigned char CTimerWorld::IsDawn();

Return Value

Returns unsigned char

Remarks

CTimerWorld::IsDay¶

unsigned char CTimerWorld::IsDay();

Return Value

Returns unsigned char

Remarks

CTimerWorld::IsDusk¶

unsigned char CTimerWorld::IsDusk();

Return Value

Returns unsigned char

Remarks

CTimerWorld::IsNight¶

unsigned char CTimerWorld::IsNight();

Return Value

Returns unsigned char

Remarks

CTimerWorld::StartTime¶

void CTimerWorld::StartTime();

Remarks

CTimerWorld::StopTime¶

void CTimerWorld::StopTime();

Remarks

CTimerWorld::UpdateTime¶

void CTimerWorld::UpdateTime(unsigned char forceUpdate);

Parameters

unsigned char forceUpdate -

Remarks