common: add Player.FlashDurationTimeRemaining()

Author: markus-wa

common/player.go

@@ -49,9 +49,9 @@ func (p *Player) IsAlive() bool {
 }
 
 // IsBlinded returns true if the player is currently flashed.
-// This is more accurate than 'FlashDuration != 0' as it takes into account the FlashTick and GameState.IngameTick().
+// This is more accurate than 'FlashDuration != 0' as it also takes into account FlashTick, DemoHeader.TickRate() and GameState.IngameTick().
 func (p *Player) IsBlinded() bool {
-	return p.FlashDuration > float32(p.ingameTickProvider()-p.FlashTick)/float32(p.tickRate)
+	return p.FlashDurationTimeRemaining() > 0
 }
 
 // FlashDurationTime returns the duration of the blinding effect as time.Duration instead of float32 in seconds.
@@ -60,9 +60,30 @@ func (p *Player) FlashDurationTime() time.Duration {
 	if !p.IsBlinded() {
 		return time.Duration(0)
 	}
+	return p.flashDurationTimeFull()
+}
+
+func (p *Player) flashDurationTimeFull() time.Duration {
 	return time.Duration(float32(time.Second) * p.FlashDuration)
 }
 
+// FlashDurationTimeRemaining returns the remaining duration of the blinding effect (or 0 if the player is not currently blinded).
+// It takes into consideration FlashDuration, FlashTick, DemoHeader.TickRate() and GameState.IngameTick().
+func (p *Player) FlashDurationTimeRemaining() time.Duration {
+	// In case the demo header is broken
+	// TODO: read tickRate from CVARs as fallback
+	if p.tickRate == 0 {
+		return time.Duration(p.FlashDuration) * time.Second
+	}
+
+	timeSinceFlash := time.Duration(float64(p.ingameTickProvider()-p.FlashTick) / p.tickRate * float64(time.Second))
+	remaining := p.flashDurationTimeFull() - timeSinceFlash
+	if remaining < 0 {
+		return 0
+	}
+	return remaining
+}
+
 /*
 Some interesting data regarding flashes.
 

common/player_test.go

@@ -69,14 +69,56 @@ func TestPlayerFlashed_FlashDuration_Over(t *testing.T) {
 	assert.False(t, pl.IsBlinded(), "Should not be flashed")
 }
 
+func TestPlayer_FlashDurationTime_Default(t *testing.T) {
+	pl := newPlayer(0)
+
+	assert.Equal(t, time.Duration(0), pl.FlashDurationTime())
+}
+
 func TestPlayer_FlashDurationTime(t *testing.T) {
-	p := newPlayer(0)
+	pl := newPlayer(0)
+
+	pl.FlashDuration = 2.3
+
+	assert.Equal(t, 2300*time.Millisecond, pl.FlashDurationTime())
+}
+
+func TestPlayer_FlashDurationTimeRemaining_Default(t *testing.T) {
+	pl := NewPlayer(0, tickProvider(128))
+
+	assert.Equal(t, time.Duration(0), pl.FlashDurationTimeRemaining())
+}
 
-	assert.Equal(t, time.Duration(0), p.FlashDurationTime())
+func TestPlayer_FlashDurationTimeRemaining(t *testing.T) {
+	pl := newPlayer(128 * 2)
+
+	pl.FlashDuration = 3
+	pl.FlashTick = 128
+	assert.Equal(t, 2*time.Second, pl.FlashDurationTimeRemaining())
+}
+
+func TestPlayer_FlashDurationTimeRemaining_Zero(t *testing.T) {
+	pl := newPlayer(128 * 4)
+
+	pl.FlashDuration = 3
+	pl.FlashTick = 128
+	assert.Equal(t, time.Duration(0), pl.FlashDurationTimeRemaining())
+}
+
+func TestPlayer_FlashDurationTimeRemaining_FlashDuration_Over(t *testing.T) {
+	pl := newPlayer(128 * 4)
+
+	pl.FlashDuration = 1
+	pl.FlashTick = 128
+	assert.Equal(t, time.Duration(0), pl.FlashDurationTimeRemaining())
+}
 
-	p.FlashDuration = 2.3
+func TestPlayer_FlashDurationTimeRemaining_Fallback(t *testing.T) {
+	pl := NewPlayer(0, tickProvider(128))
 
-	assert.Equal(t, 2300*time.Millisecond, p.FlashDurationTime())
+	pl.FlashDuration = 2
+	pl.FlashTick = 128 * 2
+	assert.Equal(t, 2*time.Second, pl.FlashDurationTimeRemaining())
 }
 
 func newPlayer(tick int) *Player {