common: add helper methods to Player around ducking

Author: markus-wa

pkg/demoinfocs/common/player.go

@@ -186,12 +186,30 @@ func (p *Player) IsScoped() bool {
 	return getBool(p.Entity, "m_bIsScoped")
 }
 
-// IsDucking returns true if the player is currently crouching.
+// IsDucking returns true if the player is currently fully crouching.
 // See also: Flags().Ducking() & Flags().DuckingKeyPressed()
 func (p *Player) IsDucking() bool {
 	return p.Flags().Ducking() && p.Flags().DuckingKeyPressed()
 }
 
+// IsDuckingInProgress returns true if the player is currently in the progress of going from standing to crouched.
+// See also: Flags().Ducking() & Flags().DuckingKeyPressed()
+func (p *Player) IsDuckingInProgress() bool {
+	return !p.Flags().Ducking() && p.Flags().DuckingKeyPressed()
+}
+
+// IsUnDuckingInProgress returns true if the player is currently in the progress of going from crouched to standing.
+// See also: Flags().Ducking() & Flags().DuckingKeyPressed()
+func (p *Player) IsUnDuckingInProgress() bool {
+	return p.Flags().Ducking() && !p.Flags().DuckingKeyPressed()
+}
+
+// IsStaning returns true if the player is currently fully standing upright.
+// See also: Flags().Ducking() & Flags().DuckingKeyPressed()
+func (p *Player) IsStanding() bool {
+	return !p.Flags().Ducking() && !p.Flags().DuckingKeyPressed()
+}
+
 // HasDefuseKit returns true if the player currently has a defuse kit in his inventory.
 func (p *Player) HasDefuseKit() bool {
 	return getBool(p.Entity, "m_bHasDefuser")

pkg/demoinfocs/common/player_test.go

@@ -212,18 +212,30 @@ func TestPlayer_IsDucking(t *testing.T) {
 	pl := playerWithProperty("m_fFlags", st.PropertyValue{IntVal: 0})
 
 	assert.False(t, pl.IsDucking())
+	assert.True(t, pl.IsStanding())
+	assert.False(t, pl.IsDuckingInProgress())
+	assert.False(t, pl.IsUnDuckingInProgress())
 
 	pl = playerWithProperty("m_fFlags", st.PropertyValue{IntVal: 1 << 1})
 
 	assert.False(t, pl.IsDucking())
+	assert.False(t, pl.IsStanding())
+	assert.False(t, pl.IsDuckingInProgress())
+	assert.True(t, pl.IsUnDuckingInProgress())
 
 	pl = playerWithProperty("m_fFlags", st.PropertyValue{IntVal: 1 << 2})
 
 	assert.False(t, pl.IsDucking())
+	assert.False(t, pl.IsStanding())
+	assert.True(t, pl.IsDuckingInProgress())
+	assert.False(t, pl.IsUnDuckingInProgress())
 
 	pl = playerWithProperty("m_fFlags", st.PropertyValue{IntVal: 1<<1 | 1<<2})
 
 	assert.True(t, pl.IsDucking())
+	assert.False(t, pl.IsStanding())
+	assert.False(t, pl.IsDuckingInProgress())
+	assert.False(t, pl.IsUnDuckingInProgress())
 }
 
 func TestPlayerFlags_OnGround(t *testing.T) {