UGameTimeSubsystem Class Reference

Public Member Functions
Functions
float32	GetRealTimeFromGameTime (FInGameTime GameTime) const
	Returns RealTime equivalent of given GameTime in InGameTime.
void	FreezeTime ()
	Set FreezeCurrentTime to true, preventing current Game Time from increasing.
FClockTime	GetClockTimeFromRealTime (float32 RealTimeInput) const
	Returns GameTime equivalent of given RealTime FClockTime.
FClockTime	GetCurrentClockTime () const
EWeekDay	GetCurrentDayOfWeek () const
	Returns the current day of the week.
FInGameTime	GetCurrentGameTime () const
float32	GetCurrentGameTimeInRealTime () const
	Returns CurrentGameTime with GameTimeSpeed Multiplier (Real Time Equivalent).
EDayTimeType	GetDayTimeType () const
	Returns EDayTimeType Enum based on Current Game Time.
FInGameTime	GetGameTimeFromRealTime (float32 RealTimeInput) const
	Returns GameTime equivalent of given RealTime in FInGameTime.
float32	GetRealTimeFromClockTime (FClockTime ClockTimeInput) const
	Returns RealTime equivalent of given GameTime in InGameTime.
void	AdvanceToClockTime (FClockTime ClockTime)
	Advances the clock until it reaches the given clock time. Might end up on the next day.
float32	GetRealTimeSince (float32 PastRealTime) const
	Returns time between now and given time int he past.
FInGameTime	GetTimeSince (FInGameTime PastTime) const
	Returns time between now and given time int he past.
FInGameTime	GetTimeUntil (FInGameTime FutureTime) const
	Returns time between now and given time in the future.
void	SetCurrentClockTime (int Hours, int Minutes, float32 Seconds)
	Sets the clock time on the current day. May go back in time.
void	SetCurrentGameTime (int Days, int Hours, int Minutes, float32 Seconds)
void	SkipTime (FInGameTime Duration)
	Skips ahead for given time.
void	UnfreezeTime ()
	Set FreezeCurrentTime to false, allowing current Game Time to increase again.

Static Public Member Functions
Static Functions
static UClass	StaticClass ()
static UGameTimeSubsystem	Get ()
static UGameTimeSubsystem	GetGameTime ()
	Access to this worlds GameTime Subsystem. Note: Attention! Returns NULLPTR on clients while GameState is not replicated!

Public Attributes
Variables
const EWeekDay	CurrentDayOfWeek
	Returns the current day of the week.
const FInGameTime	CurrentGameTime
	InGame time passed since creating of the save file.
const float32	CurrentGameTimeInRealTime
	Returns CurrentGameTime with GameTimeSpeed Multiplier (Real Time Equivalent).
const EDayTimeType	DayTimeType
	Returns EDayTimeType Enum based on Current Game Time.
const FClockTime	CurrentClockTime

Member Function Documentation

AdvanceToClockTime()

void AdvanceToClockTime

(

FClockTime

ClockTime

)

Advances the clock until it reaches the given clock time. Might end up on the next day.

FreezeTime()

void FreezeTime

(

)

Set FreezeCurrentTime to true, preventing current Game Time from increasing.

Get()

UGameTimeSubsystem Get ( )

static

GetClockTimeFromRealTime()

FClockTime GetClockTimeFromRealTime

(

float32

RealTimeInput

)

const

Returns GameTime equivalent of given RealTime FClockTime.

GetCurrentClockTime()

FClockTime GetCurrentClockTime

(

)

const

GetCurrentDayOfWeek()

EWeekDay GetCurrentDayOfWeek

(

)

const

Returns the current day of the week.

GetCurrentGameTime()

FInGameTime GetCurrentGameTime

(

)

const

GetCurrentGameTimeInRealTime()

float32 GetCurrentGameTimeInRealTime

(

)

const

Returns CurrentGameTime with GameTimeSpeed Multiplier (Real Time Equivalent).

GetDayTimeType()

EDayTimeType GetDayTimeType

(

)

const

Returns EDayTimeType Enum based on Current Game Time.

GetGameTime()

UGameTimeSubsystem GetGameTime ( )

static

Access to this worlds GameTime Subsystem. Note: Attention! Returns NULLPTR on clients while GameState is not replicated!

GetGameTimeFromRealTime()

FInGameTime GetGameTimeFromRealTime

(

float32

RealTimeInput

)

const

Returns GameTime equivalent of given RealTime in FInGameTime.

GetRealTimeFromClockTime()

float32 GetRealTimeFromClockTime

(

FClockTime

ClockTimeInput

)

const

Returns RealTime equivalent of given GameTime in InGameTime.

GetRealTimeFromGameTime()

float32 GetRealTimeFromGameTime

(

FInGameTime

GameTime

)

const

Returns RealTime equivalent of given GameTime in InGameTime.

GetRealTimeSince()

float32 GetRealTimeSince

(

float32

PastRealTime

)

const

Returns time between now and given time int he past.

GetTimeSince()

FInGameTime GetTimeSince

(

FInGameTime

PastTime

)

const

Returns time between now and given time int he past.

GetTimeUntil()

FInGameTime GetTimeUntil

(

FInGameTime

FutureTime

)

const

Returns time between now and given time in the future.

SetCurrentClockTime()

void SetCurrentClockTime	(	int	Hours,
		int	Minutes,
		float32	Seconds )

Sets the clock time on the current day. May go back in time.

SetCurrentGameTime()

void SetCurrentGameTime	(	int	Days,
		int	Hours,
		int	Minutes,
		float32	Seconds )

SkipTime()

void SkipTime

(

FInGameTime

Duration

)

Skips ahead for given time.

StaticClass()

UClass StaticClass ( )

static

UnfreezeTime()

void UnfreezeTime

(

)

Set FreezeCurrentTime to false, allowing current Game Time to increase again.

Member Data Documentation

CurrentClockTime

const FClockTime CurrentClockTime

CurrentDayOfWeek

const EWeekDay CurrentDayOfWeek

Returns the current day of the week.

CurrentGameTime

const FInGameTime CurrentGameTime

InGame time passed since creating of the save file.

CurrentGameTimeInRealTime

const float32 CurrentGameTimeInRealTime

Returns CurrentGameTime with GameTimeSpeed Multiplier (Real Time Equivalent).

DayTimeType

const EDayTimeType DayTimeType

Returns EDayTimeType Enum based on Current Game Time.