aboutsummaryrefslogtreecommitdiff
path: root/internal/combat/doc.go
diff options
context:
space:
mode:
Diffstat (limited to 'internal/combat/doc.go')
-rw-r--r--internal/combat/doc.go11
1 files changed, 11 insertions, 0 deletions
diff --git a/internal/combat/doc.go b/internal/combat/doc.go
new file mode 100644
index 0000000..758be47
--- /dev/null
+++ b/internal/combat/doc.go
@@ -0,0 +1,11 @@
+// Package combat implements OSRS-style combat formulas and per-player
+// combat state tracking.
+//
+// Combat uses attack/defense roll formulas, style bonuses, and max-hit
+// calculations. The State type tracks active combat between a player and
+// a mob instance, with a lock timer preventing immediate disengagement.
+//
+// Combat state is managed through package-level maps protected by a mutex.
+// TickCombat decrements lock timers each tick. EnterCombat and LeaveCombat
+// manage the relationship between player names and mob instance IDs.
+package combat