Represents parsed metadata for a single layout from layouts.json. More...

#include <project_layout_metadata.hpp>

Public Member Functions
	ProjectLayoutMetadata (std::string id, std::string name, std::size_t width, std::size_t height, std::string primary_tileset, std::string secondary_tileset, std::filesystem::path border_filepath, std::filesystem::path blockdata_filepath)
	Constructs a ProjectLayoutMetadata from parsed layout fields.

const std::string &	id () const

const std::string &	name () const

std::size_t	width () const

std::size_t	height () const

const std::string &	primary_tileset () const

const std::string &	secondary_tileset () const

const std::filesystem::path &	border_filepath () const

const std::filesystem::path &	blockdata_filepath () const

Detailed Description

Represents parsed metadata for a single layout from layouts.json.

ProjectLayoutMetadata captures the key fields from a pokeemerald layout definition:

{
    "id": "LAYOUT_PETALBURG_CITY",
    "name": "PetalburgCity_Layout",
    "width": 20,
    "height": 20,
    "primary_tileset": "gTileset_General",
    "secondary_tileset": "gTileset_Petalburg",
    "border_filepath": "data/layouts/PetalburgCity/border.bin",
    "blockdata_filepath": "data/layouts/PetalburgCity/map.bin"
}

Invariant: id_ is never empty; name_ is never empty; primary_tileset_ is never empty; secondary_tileset_ is never empty

Definition at line 33 of file project_layout_metadata.hpp.

Constructor & Destructor Documentation

◆ ProjectLayoutMetadata()

porytiles::ProjectLayoutMetadata::ProjectLayoutMetadata	(	std::string	id,
		std::string	name,
		std::size_t	width,
		std::size_t	height,
		std::string	primary_tileset,
		std::string	secondary_tileset,
		std::filesystem::path	border_filepath,
		std::filesystem::path	blockdata_filepath
	)

inline

Constructs a ProjectLayoutMetadata from parsed layout fields.

Parameters

id	The layout ID (e.g., "LAYOUT_PETALBURG_CITY")
name	The layout name (e.g., "PetalburgCity_Layout")
width	The layout width in metatiles
height	The layout height in metatiles
primary_tileset	The primary tileset name (e.g., "gTileset_General")
secondary_tileset	The secondary tileset name (e.g., "gTileset_Petalburg")
border_filepath	Relative path to the border file
blockdata_filepath	Relative path to the blockdata file