Skip to content

Commit

Permalink
Added missing comments on TimeSpace properties.+
Browse files Browse the repository at this point in the history
Fixes T2688 -

Differential Revision: https://dev.zeroengine.io/D794
  • Loading branch information
jodavis42 committed Sep 17, 2018
1 parent b38a4ac commit 93b850d
Showing 1 changed file with 7 additions and 3 deletions.
10 changes: 7 additions & 3 deletions Systems/Engine/Time.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -74,11 +74,11 @@ class TimeSpace : public Component
/// Useful for debugging one frame at a time.
void Step();

// Gets the current frame time, or zero if the time space is paused
// This dt will include frame time
/// Gets the current frame time, or zero if the time space is paused.
/// This dt will include frame time.
float GetDtOrZero();

// Returns true if either the space is paused, or the game is globally paused
/// Returns true if either the space is paused, or the game is globally paused
bool GetGloballyPaused();

/// Scale the speed of time for interesting effects like bullet time or
Expand Down Expand Up @@ -120,10 +120,14 @@ class TimeSpace : public Component
/// This value counts up regardless of if the space is paused
int mFrame;

/// The real amount of time that has passed since this space was created (unscaled and unclamped).
float mRealTimePassed;
/// The amount of time that has passed since this space was created (TimeSpace.TimeScale affects this value).
float mScaledClampedTimePassed;

/// The real amount of time that passed between this frame and the last (unscaled and unclamped).
float mRealDt;
/// The amount of time that passed between this frame and the last (scaled by TimeSpace.TimeScale).
float mScaledClampedDt;

/// Causes the engine to update multiple times before rendering a frame.
Expand Down

0 comments on commit 93b850d

Please sign in to comment.