Defines | Functions | Variables

date_func.h File Reference

Functions related to dates. More...

#include "date_type.h"
#include "core/random_func.hpp"

Go to the source code of this file.

Defines

#define BEGIN_HEAD_TO_HEAD()   { Randomizer rand_backup = _random; _head_to_head = 1; do { _random = rand_backup;
#define END_HEAD_TO_HEAD()   _head_to_head++; } while(_head_to_head <= _settings_game.game_creation.head_to_head_areas); _head_to_head = 0; }

Functions

void SetDate (Date date, DateFract fract)
 Set the date.
void ConvertDateToYMD (Date date, YearMonthDay *ymd)
 Converts a Date to a Year, Month & Day.
Date ConvertYMDToDate (Year year, Month month, Day day)
 Converts a tupe of Year, Month and Day to a Date.
static bool IsLeapYear (Year yr)
 Checks whether the given year is a leap year or not.

Variables

Year _cur_year
 Current year, starting at 0.
Month _cur_month
 Current month (0..11).
Date _date
 Current date in days (day counter).
DateFract _date_fract
 Fractional part of the day.
uint16 _tick_counter
 Ever incrementing (and sometimes wrapping) tick counter for setting off various events.
uint8 _head_to_head

Detailed Description

Functions related to dates.

Definition in file date_func.h.


Function Documentation

void ConvertDateToYMD ( Date  date,
YearMonthDay ymd 
)
Date ConvertYMDToDate ( Year  year,
Month  month,
Day  day 
)
static bool IsLeapYear ( Year  yr  )  [inline, static]

Checks whether the given year is a leap year or not.

Parameters:
yr The year to check.
Returns:
True if yr is a leap year, otherwise false.

Definition at line 33 of file date_func.h.

Referenced by ConvertDateToYMD(), ConvertYMDToDate(), GetGlobalVariable(), and OnNewYear().

void SetDate ( Date  date,
DateFract  fract 
)

Set the date.

Parameters:
date New date
fract The number of ticks that have passed on this date.

Definition at line 41 of file date.cpp.

References _cur_month, _cur_year, _date, _date_fract, ConvertDateToYMD(), DAY_TICKS, YearMonthDay::month, and YearMonthDay::year.

Referenced by AfterLoadGame(), ClickChangeDateCheat(), and ScenarioEditorToolbarWindow::OnQueryTextFinished().