aboutsummaryrefslogtreecommitdiff
path: root/internal/world/doc.go
diff options
context:
space:
mode:
authorhistoria <[not public]>2026-06-14 21:07:26 -0400
committerhistoria <[not public]>2026-06-14 21:07:26 -0400
commit1aba2bdd23aebed4032333e74aa553c40a31fcbd (patch)
treec004f4c2a139df5c3cf4029b2611bdfa09b40f86 /internal/world/doc.go
parenta19e6b6ab01670a5932308c7bd0e0e5eed8cbcad (diff)
downloadthehouseoficarus-1aba2bdd23aebed4032333e74aa553c40a31fcbd.tar.gz
refactor: added docs, split up some components in game package
Diffstat (limited to 'internal/world/doc.go')
-rw-r--r--internal/world/doc.go18
1 files changed, 18 insertions, 0 deletions
diff --git a/internal/world/doc.go b/internal/world/doc.go
new file mode 100644
index 0000000..cc11535
--- /dev/null
+++ b/internal/world/doc.go
@@ -0,0 +1,18 @@
+// Package world manages rooms, exits, ground items, mob instances,
+// and object instance state for the game world.
+//
+// Rooms are loaded from YAML files on every access (live-editable). Exits
+// support conditional blocking via the action.Condition system. Ground
+// items have independent despawn timers and combat-loot reservations.
+//
+// Object instance state (ObjState) tracks per-instance properties:
+// depletion with regen timers, shared depletion for trees with countdown,
+// quality for fire objects, and wandering for fishing spots.
+//
+// MobDef and MobInstance cover mob definitions and runtime instances.
+// The MobStore manages YAML loading, instance seeding, and per-room
+// mob lists. Mobs wander via legal (unconditioned) room exits.
+//
+// WordPrefixMatch provides bidirectional prefix matching used by
+// commands and object lookups.
+package world