Map properties and canvas appearance controls share the same edit path. More...

#include <overworld_sidebar.h>

Classes
struct	LabelTarget

Public Types
using	RenameLabelCallback

Public Member Functions
	OverworldSidebar (zelda3::Overworld overworld, Rom rom, MapPropertiesSystem *map_properties_system)

void	Draw (int &current_world, int &current_map, bool &current_map_lock, int &game_state, bool &show_custom_bg_color_editor, bool &show_overlay_editor, project::YazeProject *project=nullptr)

void	DrawQuickProperties (int current_map, bool current_map_lock, project::YazeProject *project=nullptr, bool compact=false)

void	SetRenameLabelCallback (RenameLabelCallback callback)

Public Attributes
std::function< void(int)>	on_story_changed

Private Member Functions
void	DrawHeader (int current_world, int current_map, int property_map, bool &current_map_lock, int game_state)

void	DrawAreaSection (int property_map, int &game_state)

void	DrawGraphicsSection (int property_map, int game_state)

void	DrawPaletteSection (int property_map, int game_state, bool &show_custom_bg_color_editor)

void	DrawMusicSection (int property_map)

void	DrawEffectsSection (int property_map, bool &show_overlay_editor)

bool	BeginFieldTable (const char *id)

void	FieldLabel (const char label, const char tooltip)

bool	HexByteField (const char id, const char label, const char tooltip, OverworldPropertyField field, int index, int property_map, uint8_t value, const LabelTarget label_target=nullptr)

void	LabelContextMenu (const LabelTarget &target)

void	DrawLabelPopup ()

void	Apply (OverworldPropertyField field, int index, int property_map, int value)

Private Attributes
zelda3::Overworld *	overworld_

Rom *	rom_

MapPropertiesSystem *	map_properties_system_

project::YazeProject *	project_ = nullptr

RenameLabelCallback	rename_label_

std::string	edit_error_

int	edit_error_map_ = -1

bool	open_label_popup_ = false

LabelTarget	label_target_

std::array< char, 128 >	label_buffer_ {}

std::string	label_error_

Detailed Description

Map properties and canvas appearance controls share the same edit path.

Definition at line 21 of file overworld_sidebar.h.

Member Typedef Documentation

◆ RenameLabelCallback

using yaze::editor::OverworldSidebar::RenameLabelCallback

Initial value:

std::function<absl::Status(const std::string&, int, const std::string&)>

Definition at line 23 of file overworld_sidebar.h.

Constructor & Destructor Documentation

◆ OverworldSidebar()

yaze::editor::OverworldSidebar::OverworldSidebar	(	zelda3::Overworld *	overworld,
		Rom *	rom,
		MapPropertiesSystem *	map_properties_system )

explicit

Definition at line 45 of file overworld_sidebar.cc.

Member Function Documentation

◆ Draw()

void yaze::editor::OverworldSidebar::Draw	(	int &	current_world,
		int &	current_map,
		bool &	current_map_lock,
		int &	game_state,
		bool &	show_custom_bg_color_editor,
		bool &	show_overlay_editor,
		project::YazeProject *	project = nullptr )

Definition at line 51 of file overworld_sidebar.cc.

References DrawAreaSection(), DrawEffectsSection(), DrawGraphicsSection(), DrawHeader(), DrawLabelPopup(), DrawMusicSection(), DrawPaletteSection(), edit_error_, edit_error_map_, yaze::gui::GetErrorColor(), yaze::zelda3::Overworld::is_loaded(), yaze::zelda3::kNumOverworldMaps, map_properties_system_, overworld_, yaze::zelda3::Overworld::overworld_map(), and project_.

◆ DrawQuickProperties()

void yaze::editor::OverworldSidebar::DrawQuickProperties	(	int	current_map,
		bool	current_map_lock,
		project::YazeProject *	project = nullptr,
		bool	compact = false )

◆ SetRenameLabelCallback()

void yaze::editor::OverworldSidebar::SetRenameLabelCallback ( RenameLabelCallback callback )

inline

Renames a project resource label (map names, gfx/palette/music labels) through the editor so the change is undoable.

Definition at line 41 of file overworld_sidebar.h.

References rename_label_.

◆ DrawHeader()

void yaze::editor::OverworldSidebar::DrawHeader	(	int	current_world,
		int	current_map,
		int	property_map,
		bool &	current_map_lock,
		int	game_state )

private

Definition at line 215 of file overworld_sidebar.cc.

References yaze::editor::BuildOverworldMapMetadata(), ICON_MD_EDIT, ICON_MD_GPS_FIXED, ICON_MD_INFO, ICON_MD_MAP, ICON_MD_PUSH_PIN, label_target_, open_label_popup_, overworld_, project_, rom_, and yaze::gui::ToolbarIconButton().

Referenced by Draw().

Here is the call graph for this function:

◆ DrawAreaSection()

void yaze::editor::OverworldSidebar::DrawAreaSection	(	int	property_map,
		int &	game_state )

private

◆ DrawGraphicsSection()

void yaze::editor::OverworldSidebar::DrawGraphicsSection	(	int	property_map,
		int	game_state )

private

Definition at line 435 of file overworld_sidebar.cc.

References BeginFieldTable(), yaze::zelda3::OverworldVersionHelper::GetVersion(), HexByteField(), yaze::editor::kAnimatedGraphics, yaze::editor::kAreaGraphics, yaze::editor::kCustomTileset, yaze::editor::kGameStateNames, yaze::editor::kSpriteGraphics, overworld_, yaze::zelda3::Overworld::overworld_map(), rom_, yaze::zelda3::OverworldVersionHelper::SupportsAnimatedGFX(), and yaze::zelda3::OverworldVersionHelper::SupportsExpandedSpace().

Referenced by Draw().

◆ DrawPaletteSection()

void yaze::editor::OverworldSidebar::DrawPaletteSection	(	int	property_map,
		int	game_state,
		bool &	show_custom_bg_color_editor )

private

Definition at line 485 of file overworld_sidebar.cc.

References BeginFieldTable(), yaze::zelda3::OverworldVersionHelper::GetVersion(), HexByteField(), ICON_MD_FORMAT_COLOR_FILL, yaze::editor::kAreaPalette, yaze::editor::kGameStateNames, yaze::editor::kMainPalette, yaze::editor::kSpritePalette, overworld_, yaze::zelda3::Overworld::overworld_map(), rom_, and yaze::zelda3::OverworldVersionHelper::SupportsCustomBGColors().

Referenced by Draw().

◆ DrawMusicSection()

void yaze::editor::OverworldSidebar::DrawMusicSection ( int property_map )

private

Definition at line 526 of file overworld_sidebar.cc.

References BeginFieldTable(), HexByteField(), yaze::editor::kMusic, overworld_, and yaze::zelda3::Overworld::overworld_map().

Referenced by Draw().

Here is the call graph for this function:

◆ DrawEffectsSection()

void yaze::editor::OverworldSidebar::DrawEffectsSection	(	int	property_map,
		bool &	show_overlay_editor )

private

Definition at line 542 of file overworld_sidebar.cc.

References Apply(), yaze::zelda3::OverworldVersionHelper::GetVersion(), ICON_MD_LAYERS, yaze::editor::kMosaic, yaze::editor::kMosaicExpanded, yaze::zelda3::kVanilla, yaze::zelda3::Overworld::mutable_overworld_map(), overworld_, rom_, and yaze::zelda3::OverworldVersionHelper::SupportsCustomBGColors().

Referenced by Draw().

Here is the call graph for this function:

◆ BeginFieldTable()

bool yaze::editor::OverworldSidebar::BeginFieldTable ( const char * id )

private

Definition at line 264 of file overworld_sidebar.cc.

Referenced by DrawAreaSection(), DrawGraphicsSection(), DrawMusicSection(), and DrawPaletteSection().

◆ FieldLabel()

void yaze::editor::OverworldSidebar::FieldLabel	(	const char *	label,
		const char *	tooltip )

private

Definition at line 274 of file overworld_sidebar.cc.

Referenced by DrawAreaSection(), and HexByteField().

◆ HexByteField()

bool yaze::editor::OverworldSidebar::HexByteField	(	const char *	id,
		const char *	label,
		const char *	tooltip,
		OverworldPropertyField	field,
		int	index,
		int	property_map,
		uint8_t	value,
		const LabelTarget *	label_target = nullptr )