FInGameTime Struct Reference

Struct to refer to ingame time in a type safe way to not confuse it with realtime seconds like GetWorld()->TimeSeconds. This contains the time in ingame-seconds since the player has started a new game, counting ingame days, hours, minutes and seconds. More...

Public Member Functions
Functions
bool	IsMoreThanXHoursAgo (int Hours,) const
int	opCmp (FInGameTime Other) const
FInGameTime	opAdd (FInGameTime Other) const
FInGameTime &	opAddAssign (FInGameTime Other)
FInGameTime	opSub (FInGameTime Other) const
FInGameTime &	opSubAssign (FInGameTime Other)
FClockTime	GetClockTime () const
int	GetDay () const
bool	IsInfinite () const
FString	ToString () const
float32	GetAgeInIngameSeconds () const
	How far before the current time is this? (Might be negative if it stores a time that is in the future).
float32	GetAgeInRealtimeSeconds () const
	How far before the current time is this? (Might be negative if it stores a time that is in the future).
bool	IsAtLeastXDaysAgo (int Days,) const
bool	IsAtLeastXHoursAgo (int Hours,) const
bool	IsAtLeastXMinutesAgo (int Minutes,) const
bool	IsAtLeastXSecondsAgo (int Seconds,) const
	Seconds.
bool	IsExactlyXDaysAgo (int Days,) const
bool	IsExactlyXHoursAgo (int Hours,) const
	Hours.
bool	IsExactlyXMinutesAgo (int Minutes,) const
	Minutes.
bool	IsInExactlyXDays (int Days,) const
bool	IsInExactlyXHours (int Hours,) const
bool	IsInExactlyXMinutes (int Minutes,) const
bool	IsInLessThanXDays (int Days,) const
bool	IsInLessThanXHours (int Hours,) const
bool	IsInLessThanXMinutes (int Minutes,) const
bool	IsInMoreThanXDays (int Days,) const
bool	IsInMoreThanXHours (int Hours,) const
bool	IsInMoreThanXMinutes (int Minutes,) const
bool	IsInXDaysOrEarlier (int Days,) const
bool	IsInXDaysOrLater (int Days,) const
bool	IsInXHoursOrEarlier (int Hours,) const
bool	IsInXHoursOrLater (int Hours,) const
bool	IsInXMinutesOrEarlier (int Minutes,) const
bool	IsInXMinutesOrLater (int Minutes,) const
bool	IsLessThanXDaysAgo (int Days,) const
bool	IsLessThanXHoursAgo (int Hours,) const
bool	IsLessThanXMinutesAgo (int Minutes,) const
bool	IsMoreThanXDaysAgo (int Days,) const
bool	opEquals (FInGameTime Other) const
bool	IsMoreThanXMinutesAgo (int Minutes,) const
bool	IsTimeInTheFuture () const
bool	IsTimeInThePast () const
bool	IsToday () const
bool	IsTomorrow () const
bool	IsValid () const
	Is this a valid time?
bool	IsWithinXDaysAgoAndNow (int Days,) const
bool	IsWithinXHoursAgoAndNow (int Hours,) const
bool	IsWithinXMinutesAgoAndNow (int Minutes,) const
bool	IsYesterday () const
FInGameTime &	opAssign (FInGameTime Other)

Static Public Member Functions
Static Functions
static FInGameTime	XIngameHoursAgo (float32 IngameHours)
	Current in game time - X ingame hours.
static FInGameTime	FromHours (float Hours)
	Constructs a new FInGameTime from the given amount of time.
static FInGameTime	FromMinutes (float Minutes)
	Constructs a new FInGameTime from the given amount of time.
static FInGameTime	FromSeconds (float Seconds)
	Constructs a new FInGameTime from the given amount of time.
static FInGameTime	Infinite ()
	Infinite time.
static FInGameTime	Invalid ()
	Invalid time.
static bool	IsAfter (FInGameTime This, FInGameTime Time)
	Returns true if this time is after the given other Time. (This > Time).
static bool	IsBefore (FInGameTime This, FInGameTime Time)
	Returns true if this time is before the given other Time. (This < Time).
static bool	IsBetween (FInGameTime This, FInGameTime A, FInGameTime B)
	Returns true if the time is between the two given other times. (A < This < B).
static FInGameTime	Make (int Days, int Hours, int Minutes, float Seconds)
	Set an explicit time.
static FInGameTime	Now ()
	Current in game time.
static FInGameTime	XIngameDaysAgo (float32 IngameDays)
	Current in game time - X ingame days.
static FInGameTime	XIngameDaysFromNow (float32 IngameDays)
	Current in game time + X ingame days.
static FInGameTime	FromDays (float Days)
	Constructs a new FInGameTime from the given amount of time.
static FInGameTime	XIngameHoursFromNow (float32 IngameHours)
	Current in game time + X ingame hours.
static FInGameTime	XIngameMinutesAgo (float32 IngameMinutes)
	Current in game time - X ingame minutes.
static FInGameTime	XIngameMinutesFromNow (float32 IngameMinutes)
	Current in game time + X ingame minutes.
static FInGameTime	XIngameSecondsAgo (float32 IngameSeconds)
	Current in game time - X ingame seconds.
static FInGameTime	XIngameSecondsFromNow (float32 IngameSeconds)
	Current in game time + X ingame seconds.
static FInGameTime	XRealtimeDaysAgo (float32 RealtimeDays)
	Current in game time - X realtime days.
static FInGameTime	XRealtimeDaysFromNow (float32 RealtimeDays)
	Current in game time + X realtime days.
static FInGameTime	XRealtimeHoursAgo (float32 RealtimeHours)
	Current in game time - X realtime hours.
static FInGameTime	XRealtimeHoursFromNow (float32 RealtimeHours)
	Current in game time + X realtime hours.
static FInGameTime	XRealtimeMinutesAgo (float32 RealtimeMinutes)
	Current in game time - X realtime minutes.
static FInGameTime	XRealtimeMinutesFromNow (float32 RealtimeMinutes)
	Current in game time + X realtime minutes.
static FInGameTime	XRealtimeSecondsAgo (float32 RealtimeSeconds)
	Current in game time - X realtime seconds.
static FInGameTime	XRealtimeSecondsFromNow (float32 RealtimeSeconds)
	Current in game time + X realtime seconds.

Public Attributes
InGameTime
float	TotalSeconds
	Seconds in game-time (usually faster than real time seconds).
Variables
const int	Day
const FClockTime	ClockTime

Detailed Description

Struct to refer to ingame time in a type safe way to not confuse it with realtime seconds like GetWorld()->TimeSeconds. This contains the time in ingame-seconds since the player has started a new game, counting ingame days, hours, minutes and seconds.

Member Function Documentation

FromDays()

FInGameTime FromDays ( float Days )

static

Constructs a new FInGameTime from the given amount of time.

FromHours()

FInGameTime FromHours ( float Hours )

static

Constructs a new FInGameTime from the given amount of time.

FromMinutes()

FInGameTime FromMinutes ( float Minutes )

static

Constructs a new FInGameTime from the given amount of time.

FromSeconds()

FInGameTime FromSeconds ( float Seconds )

static

Constructs a new FInGameTime from the given amount of time.

GetAgeInIngameSeconds()

float32 GetAgeInIngameSeconds

(

)

const

How far before the current time is this? (Might be negative if it stores a time that is in the future).

GetAgeInRealtimeSeconds()

float32 GetAgeInRealtimeSeconds

(

)

const

How far before the current time is this? (Might be negative if it stores a time that is in the future).

GetClockTime()

FClockTime GetClockTime

(

)

const

GetDay()

int GetDay

(

)

const

Infinite()

FInGameTime Infinite ( )

static

Infinite time.

Invalid()

FInGameTime Invalid ( )

static

Invalid time.

IsAfter()

bool IsAfter ( FInGameTime This, FInGameTime Time )

static

Returns true if this time is after the given other Time. (This > Time).

IsAtLeastXDaysAgo()

bool IsAtLeastXDaysAgo

(

int

Days

)

const

IsAtLeastXHoursAgo()

bool IsAtLeastXHoursAgo

(

int

Hours

)

const

IsAtLeastXMinutesAgo()

bool IsAtLeastXMinutesAgo

(

int

Minutes

)

const

IsAtLeastXSecondsAgo()

bool IsAtLeastXSecondsAgo

(

int

Seconds

)

const

Seconds.

IsBefore()

bool IsBefore ( FInGameTime This, FInGameTime Time )

static

Returns true if this time is before the given other Time. (This < Time).

IsBetween()

bool IsBetween ( FInGameTime This, FInGameTime A, FInGameTime B )

static

Returns true if the time is between the two given other times. (A < This < B).

IsExactlyXDaysAgo()

bool IsExactlyXDaysAgo

(

int

Days

)

const

IsExactlyXHoursAgo()

bool IsExactlyXHoursAgo

(

int

Hours

)

const

Hours.

IsExactlyXMinutesAgo()

bool IsExactlyXMinutesAgo

(

int

Minutes

)

const

Minutes.

IsInExactlyXDays()

bool IsInExactlyXDays

(

int

Days

)

const

IsInExactlyXHours()

bool IsInExactlyXHours

(

int

Hours

)

const

IsInExactlyXMinutes()

bool IsInExactlyXMinutes

(

int

Minutes

)

const

IsInfinite()

bool IsInfinite

(

)

const

IsInLessThanXDays()

bool IsInLessThanXDays

(

int

Days

)

const

IsInLessThanXHours()

bool IsInLessThanXHours

(

int

Hours

)

const

IsInLessThanXMinutes()

bool IsInLessThanXMinutes

(

int

Minutes

)

const

IsInMoreThanXDays()

bool IsInMoreThanXDays

(

int

Days

)

const

IsInMoreThanXHours()

bool IsInMoreThanXHours

(

int

Hours

)

const

IsInMoreThanXMinutes()

bool IsInMoreThanXMinutes

(

int

Minutes

)

const

IsInXDaysOrEarlier()

bool IsInXDaysOrEarlier

(

int

Days

)

const

IsInXDaysOrLater()

bool IsInXDaysOrLater

(

int

Days

)

const

IsInXHoursOrEarlier()

bool IsInXHoursOrEarlier

(

int

Hours

)

const

IsInXHoursOrLater()

bool IsInXHoursOrLater

(

int

Hours

)

const

IsInXMinutesOrEarlier()

bool IsInXMinutesOrEarlier

(

int

Minutes

)

const

IsInXMinutesOrLater()

bool IsInXMinutesOrLater

(

int

Minutes

)

const

IsLessThanXDaysAgo()

bool IsLessThanXDaysAgo

(

int

Days

)

const

IsLessThanXHoursAgo()

bool IsLessThanXHoursAgo

(

int

Hours

)

const

IsLessThanXMinutesAgo()

bool IsLessThanXMinutesAgo

(

int

Minutes

)

const

IsMoreThanXDaysAgo()

bool IsMoreThanXDaysAgo

(

int

Days

)

const

IsMoreThanXHoursAgo()

bool IsMoreThanXHoursAgo

(

int

Hours

)

const

IsMoreThanXMinutesAgo()

bool IsMoreThanXMinutesAgo

(

int

Minutes

)

const

IsTimeInTheFuture()

bool IsTimeInTheFuture

(

)

const

IsTimeInThePast()

bool IsTimeInThePast

(

)

const

IsToday()

bool IsToday

(

)

const

IsTomorrow()

bool IsTomorrow

(

)

const

IsValid()

bool IsValid

(

)

const

Is this a valid time?

IsWithinXDaysAgoAndNow()

bool IsWithinXDaysAgoAndNow

(

int

Days

)

const

IsWithinXHoursAgoAndNow()

bool IsWithinXHoursAgoAndNow

(

int

Hours

)

const

IsWithinXMinutesAgoAndNow()

bool IsWithinXMinutesAgoAndNow

(

int

Minutes

)

const

IsYesterday()

bool IsYesterday

(

)

const

Make()

FInGameTime Make ( int Days, int Hours, int Minutes, float Seconds )

static

Set an explicit time.

Now()

FInGameTime Now ( )

static

Current in game time.

opAdd()

FInGameTime opAdd

(

FInGameTime

Other

)

const

opAddAssign()

FInGameTime & opAddAssign

(

FInGameTime

Other

)

opAssign()

FInGameTime & opAssign

(

FInGameTime

Other

)

opCmp()

int opCmp

(

FInGameTime

Other

)

const

opEquals()

bool opEquals

(

FInGameTime

Other

)

const

opSub()

FInGameTime opSub

(

FInGameTime

Other

)

const

opSubAssign()

FInGameTime & opSubAssign

(

FInGameTime

Other

)

ToString()

FString ToString

(

)

const

XIngameDaysAgo()

FInGameTime XIngameDaysAgo ( float32 IngameDays )

static

Current in game time - X ingame days.

XIngameDaysFromNow()

FInGameTime XIngameDaysFromNow ( float32 IngameDays )

static

Current in game time + X ingame days.

XIngameHoursAgo()

FInGameTime XIngameHoursAgo ( float32 IngameHours )

static

Current in game time - X ingame hours.

XIngameHoursFromNow()

FInGameTime XIngameHoursFromNow ( float32 IngameHours )

static

Current in game time + X ingame hours.

XIngameMinutesAgo()

FInGameTime XIngameMinutesAgo ( float32 IngameMinutes )

static

Current in game time - X ingame minutes.

XIngameMinutesFromNow()

FInGameTime XIngameMinutesFromNow ( float32 IngameMinutes )

static

Current in game time + X ingame minutes.

XIngameSecondsAgo()

FInGameTime XIngameSecondsAgo ( float32 IngameSeconds )

static

Current in game time - X ingame seconds.

XIngameSecondsFromNow()

FInGameTime XIngameSecondsFromNow ( float32 IngameSeconds )

static

Current in game time + X ingame seconds.

XRealtimeDaysAgo()

FInGameTime XRealtimeDaysAgo ( float32 RealtimeDays )

static

Current in game time - X realtime days.

XRealtimeDaysFromNow()

FInGameTime XRealtimeDaysFromNow ( float32 RealtimeDays )

static

Current in game time + X realtime days.

XRealtimeHoursAgo()

FInGameTime XRealtimeHoursAgo ( float32 RealtimeHours )

static

Current in game time - X realtime hours.

XRealtimeHoursFromNow()

FInGameTime XRealtimeHoursFromNow ( float32 RealtimeHours )

static

Current in game time + X realtime hours.

XRealtimeMinutesAgo()

FInGameTime XRealtimeMinutesAgo ( float32 RealtimeMinutes )

static

Current in game time - X realtime minutes.

XRealtimeMinutesFromNow()

FInGameTime XRealtimeMinutesFromNow ( float32 RealtimeMinutes )

static

Current in game time + X realtime minutes.

XRealtimeSecondsAgo()

FInGameTime XRealtimeSecondsAgo ( float32 RealtimeSeconds )

static

Current in game time - X realtime seconds.

XRealtimeSecondsFromNow()

FInGameTime XRealtimeSecondsFromNow ( float32 RealtimeSeconds )

static

Current in game time + X realtime seconds.

Member Data Documentation

ClockTime

const FClockTime ClockTime

Day

const int Day

TotalSeconds

float TotalSeconds

Seconds in game-time (usually faster than real time seconds).