rooms

type BiomeInfo struct {
	// contains filtered or unexported fields
}

type Container struct {
	Lock         gamelock.Lock `yaml:"lock,omitempty"`         // 0 - no lock. greater than zero = difficulty to unlock.
	Items        []items.Item  `yaml:"items,omitempty"`        // Save contents now, since players can put new items in there
	Gold         int           `yaml:"gold,omitempty"`         // Save contents now, since players can put new items in there
	DespawnRound uint64        `yaml:"despawnround,omitempty"` // If this is set, it's a chest that will disappear with time.
	Recipes      map[int][]int `yaml:"recipes,omitempty,flow"` // Item Id's (key) that are created when the recipe is present in the container (values) and it is "used"
}

type Corpse struct {
	UserId       int
	MobId        int
	Character    characters.Character
	RoundCreated uint64
	Prunable     bool // Whether it can be removed
}

type FindFlag uint16

type Room struct {
	//mutex
	RoomId            int                               `yaml:"roomid"`                               // a unique numeric index of the room. Also the filename.
	Zone              string                            `yaml:"zone"`                                 // zone is a way to partition rooms into groups. Also into folders.
	ZoneConfig        ZoneConfig                        `yaml:"zoneconfig,omitempty" instance:"skip"` // If non-null is a root room.
	MusicFile         string                            `yaml:"musicfile,omitempty"`                  // background music to play when in this room
	IsBank            bool                              `yaml:"isbank,omitempty"`                     // Is this a bank room? If so, players can deposit/withdraw gold here.
	IsStorage         bool                              `yaml:"isstorage,omitempty"`                  // Is this a storage room? If so, players can add/remove objects here.
	IsCharacterRoom   bool                              `yaml:"ischaracterroom,omitempty"`            // Is this a room where characters can create new characters to swap between them?
	Title             string                            `yaml:"title"`                                // Title shown to the user
	Description       string                            `yaml:"description"`                          // Description shown to the user
	MapSymbol         string                            `yaml:"mapsymbol,omitempty"`                  // The symbol to use when generating a map of the zone
	MapLegend         string                            `yaml:"maplegend,omitempty"`                  // The text to display in the legend for this room. Should be one word.
	Biome             string                            `yaml:"biome,omitempty"`                      // The biome of the room. Used for weather generation.
	Containers        map[string]Container              `yaml:"containers,omitempty"`                 // If this room has a chest, what is in it?
	Exits             map[string]exit.RoomExit          `yaml:"exits"`                                // Exits to other rooms
	ExitsTemp         map[string]exit.TemporaryRoomExit `yaml:"-"`                                    // Temporary exits that will be removed after a certain time. Don't bother saving on sever shutting down.
	Nouns             map[string]string                 `yaml:"nouns,omitempty"`                      // Interesting nouns to highlight in the room or reveal on succesful searches.
	Items             []items.Item                      `yaml:"items,omitempty"`                      // Items on the floor
	Stash             []items.Item                      `yaml:"stash,omitempty"`                      // list of items in the room that are not visible to players
	Corpses           []Corpse                          `yaml:"-"`                                    // Any corpses laying around from recent deaths
	Gold              int                               `yaml:"gold,omitempty"`                       // How much gold is on the ground?
	SpawnInfo         []SpawnInfo                       `yaml:"spawninfo,omitempty" instance:"skip"`  // key is creature ID, value is spawn chance
	SkillTraining     map[string]TrainingRange          `yaml:"skilltraining,omitempty"`              // list of skills that can be trained in this room
	Signs             []Sign                            `yaml:"sign,omitempty"`                       // list of scribbles in the room
	IdleMessages      []string                          `yaml:"idlemessages,omitempty" `              // list of messages that can be displayed to players in the room
	LastIdleMessage   uint8                             `yaml:"-"`                                    // index of the last idle message displayed
	LongTermDataStore map[string]any                    `yaml:"longtermdatastore,omitempty"`          // Long term data store for the room
	Mutators          mutators.MutatorList              `yaml:"mutators,omitempty"`                   // mutators this room spawns with.
	Pvp               bool                              `yaml:"pvp,omitempty"`                        // if config pvp is set to `limited`, uses this value
	// contains filtered or unexported fields
}

type RoomManager struct {
	// contains filtered or unexported fields
}

type RoomTemplateDetails struct {
	VisiblePlayers []string
	VisibleMobs    []string
	VisibleCorpses []string
	VisibleExits   map[string]exit.RoomExit
	TemporaryExits map[string]exit.TemporaryRoomExit
	UserId         int
	Character      *characters.Character
	RoomSymbol     string
	RoomLegend     string
	Nouns          []string
	Zone           string
	Title          string
	Description    string
	IsDark         bool
	IsNight        bool
	TrackingString string
	RoomAlerts     []string // Messages to show below room description as a special alert
	ShowPvp        bool     // Whether to display that the room is PVP
}

type SaveEqualityChecker interface {
	SkipInstanceSave(other any) bool // Should we skip due to everything looking the same?
}

type Sign struct {
	VisibleUserId int       // What user can see it? If 0, then everyone can see it.
	DisplayText   string    // What text to display
	Expires       time.Time // When this sign expires.
}

type SpawnInfo struct {
	MobId        int      `yaml:"mobid,omitempty"`           // Mob template Id to spawn
	InstanceId   int      `yaml:"-"`                         // Mob instance Id that was spawned (tracks whether exists currently)
	Container    string   `yaml:"container,omitempty"`       // If set, any item or gold spawned will go into the container.
	ItemId       int      `yaml:"itemid,omitempty"`          // Item template Id to spawn on the floor
	Gold         int      `yaml:"gold,omitempty"`            // How much gold to spawn on the floor
	Message      string   `yaml:"message,omitempty"`         // (optional) message to display to the room when this creature spawns, instead of a default
	Name         string   `yaml:"name,omitempty"`            // (optional) if set, will override the mob's name
	ForceHostile bool     `yaml:"forcehostile,omitempty"`    // (optional) if true, forces the mob to be hostile.
	MaxWander    int      `yaml:"maxwander,omitempty"`       // (optional) if set, will override the mob's max wander distance
	IdleCommands []string `yaml:"idlecommands,omitempty"`    // (optional) list of commands to override the default of the mob. Useful when you need a mob to be more unique.
	ScriptTag    string   `yaml:"scripttag,omitempty"`       // (optional) if set, will override the mob's script tag
	QuestFlags   []string `yaml:"questflags,omitempty,flow"` // (optional) list of quest flags to set on the mob
	BuffIds      []int    `yaml:"buffids,omitempty,flow"`    // (optional) list of buffs the mob always has active
	Level        int      `yaml:"level,omitempty"`           // (optional) force this mob to a specific level
	LevelMod     int      `yaml:"levelmod,omitempty"`        // (optional) modify this mobs level by this amount
	// spawn tracking and rate
	DespawnedRound uint64 `yaml:"-"`                     // When this mob was last despawned (killed)
	RespawnRate    string `yaml:"respawnrate,omitempty"` // How long until it respawns when not present?
}

type TrainingRange struct {
	Min int
	Max int
}

type VisitorType string

type ZoneConfig struct {
	RoomId       int `yaml:"roomid,omitempty"`
	MobAutoScale struct {
		Minimum int `yaml:"minimum,omitempty"` // level scaling minimum
		Maximum int `yaml:"maximum,omitempty"` // level scaling maximum
	} `yaml:"autoscale,omitempty"` // level scaling range if any
	Mutators     mutators.MutatorList `yaml:"mutators,omitempty"`     // mutators defined here apply to entire zone
	IdleMessages []string             `yaml:"idlemessages,omitempty"` // list of messages that can be displayed to players in the zone, assuming a room has none defined
	MusicFile    string               `yaml:"musicfile,omitempty"`    // background music to play when in this zone
}

type ZoneInfo struct {
	RootRoomId      int
	DefaultBiome    string // city, swamp etc. see biomes.go
	HasZoneMutators bool   // does it have any zone mutators assigned?
	RoomIds         map[int]struct{}
}