MapDefines.h File Reference

#include "Define.h"
#include "EnumFlag.h"
#include <array>

Include dependency graph for MapDefines.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes
struct	map_fileheader
struct	map_areaHeader
struct	map_heightHeader
struct	map_liquidHeader

Typedefs
using	u_map_magic = std::array< char, 4 >
	Represents a map magic value of 4 bytes (used in versions) More...

Enumerations
enum	map_areaHeaderFlags : uint16 { map_areaHeaderFlags::None = 0x0000, map_areaHeaderFlags::NoArea = 0x0001 }
enum	map_heightHeaderFlags : uint32 {   map_heightHeaderFlags::None = 0x0000, map_heightHeaderFlags::NoHeight = 0x0001, map_heightHeaderFlags::HeightAsInt16 = 0x0002, map_heightHeaderFlags::HeightAsInt8 = 0x0004,   map_heightHeaderFlags::HasFlightBounds = 0x0008 }
enum	map_liquidHeaderFlags : uint8 { map_liquidHeaderFlags::None = 0x0000, map_liquidHeaderFlags::NoType = 0x0001, map_liquidHeaderFlags::NoHeight = 0x0002 }
enum	map_liquidHeaderTypeFlags : uint8 {   map_liquidHeaderTypeFlags::NoWater = 0x00, map_liquidHeaderTypeFlags::Water = 0x01, map_liquidHeaderTypeFlags::Ocean = 0x02, map_liquidHeaderTypeFlags::Magma = 0x04,   map_liquidHeaderTypeFlags::Slime = 0x08, map_liquidHeaderTypeFlags::DarkWater = 0x10, map_liquidHeaderTypeFlags::AllLiquids = Water | Ocean | Magma | Slime }

Functions
	DEFINE_ENUM_FLAG (map_areaHeaderFlags)
	DEFINE_ENUM_FLAG (map_heightHeaderFlags)
	DEFINE_ENUM_FLAG (map_liquidHeaderFlags)
	DEFINE_ENUM_FLAG (map_liquidHeaderTypeFlags)

Variables
TC_COMMON_API u_map_magic const	MapMagic
TC_COMMON_API uint32 const	MapVersionMagic
TC_COMMON_API u_map_magic const	MapAreaMagic
TC_COMMON_API u_map_magic const	MapHeightMagic
TC_COMMON_API u_map_magic const	MapLiquidMagic

Typedef Documentation

u_map_magic

using u_map_magic = std::array<char, 4>

Represents a map magic value of 4 bytes (used in versions)

Enumeration Type Documentation

map_areaHeaderFlags

enum map_areaHeaderFlags : uint16

strong

Enumerator
None
NoArea

 : uint16
{
 None = 0x0000,
 NoArea = 0x0001
};

map_heightHeaderFlags

enum map_heightHeaderFlags : uint32

strong

Enumerator
None
NoHeight
HeightAsInt16
HeightAsInt8
HasFlightBounds

 : uint32
{
 None = 0x0000,
 NoHeight = 0x0001,
 HeightAsInt16 = 0x0002,
 HeightAsInt8 = 0x0004,
 HasFlightBounds = 0x0008
};

map_liquidHeaderFlags

enum map_liquidHeaderFlags : uint8

strong

Enumerator
None
NoType
NoHeight

 : uint8
{
 None = 0x0000,
 NoType = 0x0001,
 NoHeight = 0x0002
};

map_liquidHeaderTypeFlags

enum map_liquidHeaderTypeFlags : uint8

strong

Enumerator
NoWater
Water
Ocean
Magma
Slime
DarkWater
AllLiquids

 : uint8
{
 NoWater = 0x00,
 Water = 0x01,
 Ocean = 0x02,
 Magma = 0x04,
 Slime = 0x08,

 DarkWater = 0x10,

 AllLiquids = Water | Ocean | Magma | Slime
};

Function Documentation

DEFINE_ENUM_FLAG() [1/4]

DEFINE_ENUM_FLAG

(

map_areaHeaderFlags

)

DEFINE_ENUM_FLAG() [2/4]

DEFINE_ENUM_FLAG

(

map_heightHeaderFlags

)

DEFINE_ENUM_FLAG() [3/4]

DEFINE_ENUM_FLAG

(

map_liquidHeaderFlags

)

DEFINE_ENUM_FLAG() [4/4]

DEFINE_ENUM_FLAG

(

map_liquidHeaderTypeFlags

)

Variable Documentation

MapAreaMagic

TC_COMMON_API u_map_magic const MapAreaMagic

MapHeightMagic

TC_COMMON_API u_map_magic const MapHeightMagic

MapLiquidMagic

TC_COMMON_API u_map_magic const MapLiquidMagic

MapMagic

TC_COMMON_API u_map_magic const MapMagic

MapVersionMagic

TC_COMMON_API uint32 const MapVersionMagic