SCR_DayTimeInfoBase Interface Reference

Inheritance diagram for SCR_DayTimeInfoBase:

Public Member Functions
SCR_UIInfo	GetDayTimeUIInfo ()
	Gets time of day UI info.
EDayTimeEnums	GetDaytimeEnum ()
	Gets time of day enum.
float	GetDayTime ()
	Gets time of day in seconds.
void	Clear ()
	Clear the data.
float	GetDayTime (notnull array< ref SCR_DayTimeInfoBase > daytimeInfo, TimeAndWeatherManagerEntity timeAndWeatherEntity)
	Gets time of day in seconds.
void	SetDayTime (notnull array< ref SCR_DayTimeInfoBase > daytimeInfo, TimeAndWeatherManagerEntity timeAndWeatherEntity, int year=-1, int month=-1, int day=-1)
	Sets the starting time of the time of day in seconds.

Protected Attributes
EDayTimeEnums	m_DayTimeEnum
ref SCR_UIInfo	m_UIInfo
float	m_fTimeOfDay = -1

Member Function Documentation

Clear()

void SCR_DayTimeInfoBase.Clear

(

)

Clear the data.

GetDayTime() [1/2]

float SCR_DayTimeInfoBase.GetDayTime

(

)

Gets time of day in seconds.

This is when the time of day starts

Returns

seconds of starting time of time of day

GetDayTime() [2/2]

float SCR_DayTimeInfoBase.GetDayTime	(	notnull array< ref SCR_DayTimeInfoBase >	daytimeInfo,
		TimeAndWeatherManagerEntity	timeAndWeatherEntity
	)

Gets time of day in seconds.

This is when the time of day starts. Used when init other times of day

Parameters

daytimeInfo

array of other time of days to get info from

Returns

seconds of starting time of time of day

GetDaytimeEnum()

EDayTimeEnums SCR_DayTimeInfoBase.GetDaytimeEnum

(

)

Gets time of day enum.

Returns

time of day enum

GetDayTimeUIInfo()

SCR_UIInfo SCR_DayTimeInfoBase.GetDayTimeUIInfo

(

)

Gets time of day UI info.

Returns

SCR_UIInfo ui info of time of day

SetDayTime()

void SCR_DayTimeInfoBase.SetDayTime	(	notnull array< ref SCR_DayTimeInfoBase >	daytimeInfo,
		TimeAndWeatherManagerEntity	timeAndWeatherEntity,
		int	year = -1,
		int	month = -1,
		int	day = -1
	)

Sets the starting time of the time of day in seconds.

Parameters

daytimeInfo	array of other time of days to get info from
timeAndWeatherEntity
year
month
day

Implemented in SCR_DayTimeInfoStatic, SCR_DayTimeInfoAuto, and SCR_DayTimeInfoBetween.

Member Data Documentation

m_DayTimeEnum

EDayTimeEnums SCR_DayTimeInfoBase.m_DayTimeEnum

protected

m_fTimeOfDay

float SCR_DayTimeInfoBase.m_fTimeOfDay = -1

protected

m_UIInfo

ref SCR_UIInfo SCR_DayTimeInfoBase.m_UIInfo

protected

---

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

• GameCode/World/TimeAndWeatherManagerEntity.c