#pragma once

#ifndef CL_MOD_WORLD

#define CL_MOD_WORLD

#include "Export.h"

#include "Module.h"

#include "modules/Persistence.h"

#include <ostream>

#include "DataDefs.h"

namespace df

{

struct tile_bitmask;

struct map_block;

}

namespace DFHack

{

typedef df::game_mode GameMode;

typedef df::game_type GameType;

#define GAMEMODE_ADVENTURE df::enums::game_mode::ADVENTURE

/**

struct t_gamemodes

};

class DFContextShared;

/**

namespace World

{

///true if paused, false if not

DFHACK_EXPORT bool ReadPauseState();

///true if paused, false if not

DFHACK_EXPORT void SetPauseState(bool paused);

DFHACK_EXPORT uint32_t ReadCurrentTick();

DFHACK_EXPORT uint32_t ReadCurrentYear();

DFHACK_EXPORT uint32_t ReadCurrentMonth();

DFHACK_EXPORT uint32_t ReadCurrentDay();

DFHACK_EXPORT uint8_t ReadCurrentWeather();

DFHACK_EXPORT void SetCurrentWeather(uint8_t weather);

DFHACK_EXPORT bool ReadGameMode(t_gamemodes& rd);

DFHACK_EXPORT bool WriteGameMode(const t_gamemodes & wr); // this is very dangerous

DFHACK_EXPORT std::string ReadWorldFolder();

DFHACK_EXPORT bool isFortressMode(df::game_type t = (df::game_type)-1);

DFHACK_EXPORT bool isAdventureMode(df::game_type t = (df::game_type)-1);

DFHACK_EXPORT bool isArena(df::game_type t = (df::game_type)-1);

DFHACK_EXPORT bool isLegends(df::game_type t = (df::game_type)-1);

DFHACK_EXPORT std::string getWorldName(bool in_english = false);

DFHACK_EXPORT df::unit * getAdventurer();

DFHACK_EXPORT int32_t GetCurrentSiteId();

DFHACK_EXPORT bool IsSiteLoaded();

// Store DFHack tool data in the game save directory.

// Use the relevant API depending on whether you are storing world-global data,

// site-specific data, or data specific to some other historical entity (including

// sites that may not be the current one).

DFHACK_EXPORT PersistentDataItem AddPersistentEntityData(int entity_id, const std::string &key);

DFHACK_EXPORT PersistentDataItem AddPersistentWorldData(const std::string &key);

DFHACK_EXPORT PersistentDataItem AddPersistentSiteData(const std::string &key);

// Calls GetPersistent*Data(key); if not found, creates and returns a new entry.

// The result can still be not isValid() e.g. if a world is not loaded.

DFHACK_EXPORT PersistentDataItem GetPersistentEntityData(int entity_id, const std::string &key, bool create = false);

DFHACK_EXPORT PersistentDataItem GetPersistentWorldData(const std::string &key, bool create = false);

DFHACK_EXPORT PersistentDataItem GetPersistentSiteData(const std::string &key, bool create = false);

// Get all items with the given key.

// If prefix is true, search for keys starting with key+"/".

// GetPersistent*Data(&vec, "", true) returns all items in the specified namespace.

// Items have alphabetic order by key; same key ordering is undefined.

DFHACK_EXPORT void GetPersistentEntityData(std::vector<PersistentDataItem> *vec, int entity_id,

const std::string &key, bool prefix = false);

DFHACK_EXPORT void GetPersistentWorldData(std::vector<PersistentDataItem> *vec,

const std::string &key, bool prefix = false);

DFHACK_EXPORT void GetPersistentSiteData(std::vector<PersistentDataItem> *vec,

const std::string &key, bool prefix = false);

// Deletes the item; returns true if success.

DFHACK_EXPORT bool DeletePersistentData(const PersistentDataItem &item);

// Create or delete block data associated with the given persistent data item

DFHACK_EXPORT df::tile_bitmask *getPersistentTilemask(PersistentDataItem &item, df::map_block *block, bool create = false);

DFHACK_EXPORT bool deletePersistentTilemask(PersistentDataItem &item, df::map_block *block);

}

}

#endif