Skip to content

Commit b1b5431

Browse files
committed
improve PlayerHurt event documentation (#151)
- Attacker may be nil for world damage - Weapon may be EqUnknown for world damage
1 parent 6f36fec commit b1b5431

File tree

1 file changed

+3
-3
lines changed

1 file changed

+3
-3
lines changed

events/events.go

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -350,11 +350,11 @@ const (
350350
// PlayerHurt signals that a player has been damaged.
351351
type PlayerHurt struct {
352352
Player *common.Player
353-
Attacker *common.Player
353+
Attacker *common.Player // May be nil if the player is taking world damage (e.g. fall damage).
354354
Health int
355355
Armor int
356-
Weapon *common.Equipment
357-
WeaponString string // Wrong for CZ, M4A1-S etc.
356+
Weapon *common.Equipment // May be EqUnknown for world-damage (falling / bomb).
357+
WeaponString string // Wrong for CZ, M4A1-S etc.
358358
HealthDamage int
359359
ArmorDamage int
360360
HitGroup HitGroup

0 commit comments

Comments
 (0)