SCR_DateTimeHelper Interface Reference

Static Public Member Functions
static string	GetDateTimeLocal ()
static string	GetDateTimeUTC ()
static string	GetDateString (int day, int month, int year, bool verbose=true)
	Returns translated date expression, either in short or verbose style.
static string	GetMonthString (int month, bool standalone=false)
	Returns translation key for the month.
static string	GetAbbreviatedMonthString (int month)
	Returns translation key for the abbrev.
static int	GetTimeDifference (int hour0, int minute0, int second0, int hour1, int minute1, int second1, out int hour=0, out int minute=0, out int second=0)
static string	GetTimeDifferenceFormatted (int hour0, int minute0, int second0, int hour1, int minute1, int second1)
static string	GetTimeLocal ()
static string	GetTimeUTC ()
static void	GetDayHourMinuteSecondFromSeconds (int totalSeconds, out int outDays, out int outHours, out int outMinutes, out int outSeconds)
	Splits given seconds to days, hours, minutes and remaining seconds.
static void	GetHourMinuteSecondFromSeconds (int totalSeconds, out int outHours, out int outMinutes, out int outSeconds)
	Splits given seconds to hours, minutes and remaining seconds.
static int	GetSecondsFromHourMinuteSecond (int hour=0, int minute=0, int second=0)
static int	ConvertDateIntoMinutes (int year=0, int month=0, int day=0, int hour=0, int minutes=0)
	Grabs all given values and convert it to minutes.
static void	ConvertMinutesIntoDate (int totalDateMinutes, out int year, out int month, out int day, out int hour, out int minutes)
	Grabs the given total minutes and converts it into years, months, days, hours and minutes.

Member Function Documentation

ConvertDateIntoMinutes()

static int SCR_DateTimeHelper.ConvertDateIntoMinutes ( int  year = 0, int  month = 0, int  day = 0, int  hour = 0, int  minutes = 0  )

static

Grabs all given values and convert it to minutes.

Parameters

[out]	year	Years to convert into minutes. Note that max years is around 4000
[out]	month	Months to convert into minutes.
[out]	day	Days to convert into minutes.
[out]	hour	Hours to convert into minutes.
[out]	minutes	To add to the total minutes

ConvertMinutesIntoDate()

static void SCR_DateTimeHelper.ConvertMinutesIntoDate ( int  totalDateMinutes, out int  year, out int  month, out int  day, out int  hour, out int  minutes  )

static

Grabs the given total minutes and converts it into years, months, days, hours and minutes.

Parameters

	totalDateMinutes	total minutes to be converted - absolute value will be used
[out]	year	Returns amount of years 0..x
[out]	month	Returns amount of months 0..12
[out]	day	Returns amount of days 0..31
[out]	hour	Returns amount of hours 0..23
[out]	minutes	Returns amount of minutes 0..59

GetAbbreviatedMonthString()

static string SCR_DateTimeHelper.GetAbbreviatedMonthString ( int  month )

static

Returns translation key for the abbrev.

month.

Parameters

month

number (from 1 to 12)

Returns

month's short translation key

GetDateString()

static string SCR_DateTimeHelper.GetDateString ( int  day, int  month, int  year, bool  verbose = true  )

static

Returns translated date expression, either in short or verbose style.

Parameters

day	number
month	number (from 1 to 12)
year	number
verbose	bool

Returns

translated date expression

GetDateTimeLocal()

static string SCR_DateTimeHelper.GetDateTimeLocal ( )

static

Returns

local datetime in format "yyyy-mm-dd hh:ii:ss"

GetDateTimeUTC()

static string SCR_DateTimeHelper.GetDateTimeUTC ( )

static

Returns

UTC datetime in format "yyyy-mm-dd hh:ii:ss"

GetDayHourMinuteSecondFromSeconds()

static void SCR_DateTimeHelper.GetDayHourMinuteSecondFromSeconds ( int  totalSeconds, out int  outDays, out int  outHours, out int  outMinutes, out int  outSeconds  )

static

Splits given seconds to days, hours, minutes and remaining seconds.

Parameters

	totalSeconds	total seconds to be converted - absolute value will be used
[out]	outDays	Returns amount of Days
[out]	outHours	Returns amount of Hours 0..23
[out]	outMinutes	Returns amount of Minutes 0..59
[out]	outSeconds	Returns remaining amount of Seconds 0..59

GetHourMinuteSecondFromSeconds()

static void SCR_DateTimeHelper.GetHourMinuteSecondFromSeconds ( int  totalSeconds, out int  outHours, out int  outMinutes, out int  outSeconds  )

static

Splits given seconds to hours, minutes and remaining seconds.

Parameters

	totalSeconds	total seconds to be converted - absolute value will be used
[out]	outHours	Returns amount of Hours 0..x (can be above 24)
[out]	outMinutes	Returns amount of Minutes 0..59
[out]	outSeconds	Returns remaining amount of Seconds 0..59

GetMonthString()

static string SCR_DateTimeHelper.GetMonthString ( int  month, bool  standalone = false  )

static

Returns translation key for the month.

Parameters

month	number (from 1 to 12)
standalone	bool - is the month name going to be displayed as standalone string or part of the date (default: false)

Returns

month's translation key

GetSecondsFromHourMinuteSecond()

static int SCR_DateTimeHelper.GetSecondsFromHourMinuteSecond ( int  hour = 0, int  minute = 0, int  second = 0  )

static

Parameters

hour
minute
second

Returns

seconds

GetTimeDifference()

static int SCR_DateTimeHelper.GetTimeDifference ( int  hour0, int  minute0, int  second0, int  hour1, int  minute1, int  second1, out int  hour = 0, out int  minute = 0, out int  second = 0  )

static

Returns

the absolute difference in seconds

GetTimeDifferenceFormatted()

static string SCR_DateTimeHelper.GetTimeDifferenceFormatted ( int  hour0, int  minute0, int  second0, int  hour1, int  minute1, int  second1  )

static

Returns

total absolute difference in hh:ii:ss format

GetTimeLocal()

static string SCR_DateTimeHelper.GetTimeLocal ( )

static

Returns

local time in format "hh:ii:ss"

GetTimeUTC()

static string SCR_DateTimeHelper.GetTimeUTC ( )

static

Returns

UTC time in format "hh:ii:ss"

---

The documentation for this interface was generated from the following file:

• Game/Helpers/SCR_DateTimeHelper.c