A class for managing sprites in the overworld and underworld. More...

#include <sprite.h>

Inheritance diagram for yaze::zelda3::Sprite:

Collaboration diagram for yaze::zelda3::Sprite:

Public Member Functions
	Sprite ()=default

	Sprite (const std::vector< uint8_t > &src, uint8_t overworld_map_id, uint8_t id, uint8_t x, uint8_t y, int map_x, int map_y)

	Sprite (uint8_t id, uint8_t x, uint8_t y, uint8_t subtype, uint8_t layer)

void	InitSprite (const std::vector< uint8_t > &src, uint8_t overworld_map_id, uint8_t id, uint8_t x, uint8_t y, int map_x, int map_y)

void	Draw ()

void	RenderPreviewGraphics (std::span< const uint8_t > graphics)

void	ClearPreviewGraphics ()

void	DrawSpriteTile (int x, int y, int srcx, int srcy, int pal, bool mirror_x=false, bool mirror_y=false, int sizex=2, int sizey=2)

void	UpdateMapProperties (uint16_t map_id, const void *context=nullptr) override
	Update entity properties based on map position.

void	UpdateCoordinates (int map_x, int map_y)

auto	preview_graphics () const

auto	id () const

auto	set_id (uint8_t id)

auto	x () const

auto	y () const

auto	nx () const

auto	ny () const

auto	map_id () const

auto	map_x () const

auto	map_y () const

auto	game_state () const

auto	layer () const

auto	subtype () const

auto	width () const

auto	height () const

auto	name ()

auto	deleted () const

auto	set_deleted (bool deleted)

auto	set_key_drop (int key)

auto	key_drop () const

bool	IsOverlord () const

void	set_subtype (int subtype)

void	set_layer (int layer)

Public Member Functions inherited from yaze::zelda3::GameEntity
auto	set_x (int x)

auto	set_y (int y)

	GameEntity ()=default

virtual	~GameEntity ()

Private Attributes
uint8_t	map_id_

uint8_t	game_state_

uint8_t	id_

uint8_t	nx_

uint8_t	ny_

uint8_t	overlord_ = 0

uint8_t	lower_x_ = 32

uint8_t	lower_y_ = 32

uint8_t	higher_x_ = 0

uint8_t	higher_y_ = 0

int	width_ = 16

int	height_ = 16

int	map_x_ = 0

int	map_y_ = 0

int	layer_ = 0

int	subtype_ = 0

int	key_drop_ = 0

bool	deleted_ = false

bool	overworld_

std::string	name_

std::vector< uint8_t >	preview_gfx_

std::vector< uint8_t >	current_gfx_

const uint8_t *	external_gfx_ = nullptr

size_t	external_gfx_size_ = 0

SDL_Rect	bounding_box_

Additional Inherited Members
Public Types inherited from yaze::zelda3::GameEntity
enum	EntityType { kEntrance = 0 , kExit = 1 , kItem = 2 , kSprite = 3 , kTransport = 4 , kMusic = 5 , kTilemap = 6 , kProperties = 7 , kDungeonSprite = 8 }

Public Attributes inherited from yaze::zelda3::GameEntity
enum yaze::zelda3::GameEntity::EntityType	entity_type_

int	x_ = 0

int	y_ = 0

int	game_x_ = 0

int	game_y_ = 0

int	entity_id_ = 0

uint16_t	map_id_ = 0

Detailed Description

A class for managing sprites in the overworld and underworld.

Definition at line 37 of file sprite.h.

Constructor & Destructor Documentation

◆ Sprite() [1/3]

yaze::zelda3::Sprite::Sprite ( )

default

◆ Sprite() [2/3]

yaze::zelda3::Sprite::Sprite	(	const std::vector< uint8_t > &	src,
		uint8_t	overworld_map_id,
		uint8_t	id,
		uint8_t	x,
		uint8_t	y,
		int	map_x,
		int	map_y )

inline

Definition at line 40 of file sprite.h.

References yaze::zelda3::GameEntity::entity_id_, yaze::zelda3::GameEntity::entity_type_, id(), yaze::zelda3::GameEntity::kSprite, map_x_, map_y_, name_, overworld_, yaze::zelda3::ResolveSpriteName(), yaze::zelda3::GameEntity::x_, and yaze::zelda3::GameEntity::y_.

Here is the call graph for this function:

◆ Sprite() [3/3]

yaze::zelda3::Sprite::Sprite	(	uint8_t	id,
		uint8_t	x,
		uint8_t	y,
		uint8_t	subtype,
		uint8_t	layer )

inline

Definition at line 58 of file sprite.h.

References yaze::zelda3::kOverlordNames, name_, overlord_, yaze::zelda3::ResolveSpriteName(), subtype(), x(), yaze::zelda3::GameEntity::x_, y(), and yaze::zelda3::GameEntity::y_.

Here is the call graph for this function:

Member Function Documentation

◆ InitSprite()

void yaze::zelda3::Sprite::InitSprite	(	const std::vector< uint8_t > &	src,
		uint8_t	overworld_map_id,
		uint8_t	id,
		uint8_t	x,
		uint8_t	y,
		int	map_x,
		int	map_y )

inline

Definition at line 69 of file sprite.h.

References current_gfx_, yaze::zelda3::GameEntity::entity_id_, yaze::zelda3::GameEntity::entity_type_, id(), id_, yaze::zelda3::GameEntity::kSprite, map_id_, map_x(), map_x_, map_y(), map_y_, name_, nx_, ny_, overworld_, yaze::zelda3::ResolveSpriteName(), x(), yaze::zelda3::GameEntity::x_, y(), and yaze::zelda3::GameEntity::y_.

◆ Draw()

void yaze::zelda3::Sprite::Draw ( )

Todo: Add something here?

Definition at line 337 of file sprite.cc.

References bounding_box_, DrawSpriteTile(), height_, id_, lower_x_, lower_y_, nx_, ny_, overlord_, width_, x(), and y().

Referenced by RenderPreviewGraphics().

Here is the call graph for this function:

◆ RenderPreviewGraphics()

void yaze::zelda3::Sprite::RenderPreviewGraphics ( std::span< const uint8_t > graphics )

Definition at line 1185 of file sprite.cc.

References bounding_box_, Draw(), external_gfx_, external_gfx_size_, nx_, ny_, preview_gfx_, yaze::zelda3::GameEntity::x_, and yaze::zelda3::GameEntity::y_.

Referenced by yaze::editor::DungeonCanvasViewer::RenderSprites().

Here is the call graph for this function:

◆ ClearPreviewGraphics()

void yaze::zelda3::Sprite::ClearPreviewGraphics ( )

Definition at line 1221 of file sprite.cc.

References preview_gfx_.

◆ DrawSpriteTile()

void yaze::zelda3::Sprite::DrawSpriteTile	(	int	x,
		int	y,
		int	srcx,
		int	srcy,
		int	pal,
		bool	mirror_x = false,
		bool	mirror_y = false,
		int	sizex = 2,
		int	sizey = 2 )

Definition at line 1225 of file sprite.cc.

References current_gfx_, external_gfx_, external_gfx_size_, height(), preview_gfx_, width(), x(), and y().

Referenced by Draw().

Here is the call graph for this function:

◆ UpdateMapProperties()

void yaze::zelda3::Sprite::UpdateMapProperties	(	uint16_t	map_id,
		const void *	context = nullptr )

overridevirtual

Update entity properties based on map position.

Parameters

map_id	Parent map ID to update to
context	Optional context (typically const Overworld* for coordinate calculations)

ZScream equivalent: UpdateMapStuff() / UpdateMapProperties()

This method recalculates derived properties like:

game_x_/game_y_ from world x_/y_ coordinates
Scroll/camera values for exits (if is_automatic_ = true)
Map position encoding for saving

Implements yaze::zelda3::GameEntity.

Definition at line 325 of file sprite.cc.

References id_, map_x_, map_y_, name_, yaze::zelda3::ResolveSpriteName(), yaze::zelda3::GameEntity::x_, and yaze::zelda3::GameEntity::y_.

Referenced by yaze::editor::DrawSpriteEditorPopup().

Here is the call graph for this function:

◆ UpdateCoordinates()

void yaze::zelda3::Sprite::UpdateCoordinates	(	int	map_x,
		int	map_y )

Definition at line 332 of file sprite.cc.

References map_x(), map_x_, map_y(), and map_y_.

Here is the call graph for this function:

◆ preview_graphics()

auto yaze::zelda3::Sprite::preview_graphics ( ) const

inline

Definition at line 98 of file sprite.h.

References preview_gfx_.

Referenced by yaze::editor::DungeonCanvasViewer::RenderSprites().

◆ id()

auto yaze::zelda3::Sprite::id ( ) const

inline

Definition at line 99 of file sprite.h.

References id_.

Referenced by yaze::editor::DrawSpriteEditorPopup(), InitSprite(), yaze::zelda3::Room::LoadSprites(), set_id(), and Sprite().

◆ set_id()

auto yaze::zelda3::Sprite::set_id ( uint8_t id )

inline

Definition at line 100 of file sprite.h.

References id(), and id_.

Referenced by yaze::editor::DrawSpriteEditorPopup(), and yaze::test::OverworldEditorTestSuite::RunEntityManipulationTest().

Here is the call graph for this function:

◆ x()

auto yaze::zelda3::Sprite::x ( ) const

inline

Definition at line 101 of file sprite.h.

References yaze::zelda3::GameEntity::x_.

Referenced by Draw(), DrawSpriteTile(), InitSprite(), yaze::zelda3::Room::LoadSprites(), and Sprite().

◆ y()

auto yaze::zelda3::Sprite::y ( ) const

inline

Definition at line 102 of file sprite.h.

References yaze::zelda3::GameEntity::y_.

Referenced by Draw(), DrawSpriteTile(), InitSprite(), yaze::zelda3::Room::LoadSprites(), and Sprite().

◆ nx()

auto yaze::zelda3::Sprite::nx ( ) const

inline

Definition at line 103 of file sprite.h.

References nx_.

◆ ny()

auto yaze::zelda3::Sprite::ny ( ) const

inline

Definition at line 104 of file sprite.h.

References ny_.

◆ map_id()

auto yaze::zelda3::Sprite::map_id ( ) const

inline

Definition at line 105 of file sprite.h.

References map_id_.

Referenced by yaze::editor::DrawSpriteEditorPopup().

◆ map_x()

auto yaze::zelda3::Sprite::map_x ( ) const

inline

Definition at line 106 of file sprite.h.

References map_x_.

Referenced by InitSprite(), and UpdateCoordinates().

◆ map_y()

auto yaze::zelda3::Sprite::map_y ( ) const

inline

Definition at line 107 of file sprite.h.

References map_y_.

Referenced by InitSprite(), and UpdateCoordinates().

◆ game_state()

auto yaze::zelda3::Sprite::game_state ( ) const

inline

Definition at line 108 of file sprite.h.

References game_state_.

◆ layer()

auto yaze::zelda3::Sprite::layer ( ) const

inline

Definition at line 110 of file sprite.h.

References layer_.

Referenced by yaze::zelda3::Room::LoadSprites(), and set_layer().

◆ subtype()

auto yaze::zelda3::Sprite::subtype ( ) const

inline

Definition at line 111 of file sprite.h.

References subtype_.

Referenced by yaze::zelda3::Room::LoadSprites(), set_subtype(), and Sprite().

◆ width()

auto yaze::zelda3::Sprite::width ( ) const

inline

Definition at line 113 of file sprite.h.

References width_.

Referenced by DrawSpriteTile().

◆ height()

auto yaze::zelda3::Sprite::height ( ) const

inline

Definition at line 114 of file sprite.h.

References height_.

Referenced by DrawSpriteTile().

◆ name()

auto yaze::zelda3::Sprite::name ( )

inline

Definition at line 115 of file sprite.h.

References name_.

Referenced by yaze::editor::DrawSpriteEditorPopup().

◆ deleted()

auto yaze::zelda3::Sprite::deleted ( ) const

inline

Definition at line 116 of file sprite.h.

References deleted_.

Referenced by set_deleted().

◆ set_deleted()

auto yaze::zelda3::Sprite::set_deleted ( bool deleted )

inline

Definition at line 117 of file sprite.h.

References deleted(), and deleted_.

Referenced by yaze::editor::DrawSpriteEditorPopup().

Here is the call graph for this function:

◆ set_key_drop()

auto yaze::zelda3::Sprite::set_key_drop ( int key )

inline

Definition at line 118 of file sprite.h.

References key_drop_.

Referenced by yaze::editor::ObjectEditorContent::DrawSelectedSpriteInfo(), and yaze::zelda3::Room::LoadSprites().

◆ key_drop()

auto yaze::zelda3::Sprite::key_drop ( ) const

inline

Definition at line 119 of file sprite.h.

References key_drop_.

◆ IsOverlord()

bool yaze::zelda3::Sprite::IsOverlord ( ) const

inline

Definition at line 122 of file sprite.h.

References overlord_.

◆ set_subtype()

void yaze::zelda3::Sprite::set_subtype ( int subtype )

inline

Definition at line 125 of file sprite.h.

References subtype(), and subtype_.

Referenced by yaze::editor::ObjectEditorContent::DrawSelectedSpriteInfo().

Here is the call graph for this function:

◆ set_layer()

void yaze::zelda3::Sprite::set_layer ( int layer )

inline

Definition at line 126 of file sprite.h.

References layer(), and layer_.

Referenced by yaze::editor::ObjectEditorContent::DrawSelectedSpriteInfo().

Here is the call graph for this function:

Member Data Documentation

◆ map_id_

uint8_t yaze::zelda3::Sprite::map_id_

private

Definition at line 129 of file sprite.h.

Referenced by InitSprite(), and map_id().

◆ game_state_

uint8_t yaze::zelda3::Sprite::game_state_

private

Definition at line 130 of file sprite.h.

Referenced by game_state().

◆ id_

uint8_t yaze::zelda3::Sprite::id_

private

Definition at line 131 of file sprite.h.

Referenced by Draw(), id(), InitSprite(), set_id(), and UpdateMapProperties().

◆ nx_

uint8_t yaze::zelda3::Sprite::nx_

private

Definition at line 132 of file sprite.h.

Referenced by Draw(), InitSprite(), nx(), and RenderPreviewGraphics().

◆ ny_

uint8_t yaze::zelda3::Sprite::ny_

private

Definition at line 133 of file sprite.h.

Referenced by Draw(), InitSprite(), ny(), and RenderPreviewGraphics().

◆ overlord_

uint8_t yaze::zelda3::Sprite::overlord_ = 0

private

Definition at line 134 of file sprite.h.

Referenced by Draw(), IsOverlord(), and Sprite().

◆ lower_x_

uint8_t yaze::zelda3::Sprite::lower_x_ = 32

private

Definition at line 135 of file sprite.h.

Referenced by Draw().

◆ lower_y_

uint8_t yaze::zelda3::Sprite::lower_y_ = 32

private

Definition at line 136 of file sprite.h.

Referenced by Draw().

◆ higher_x_

uint8_t yaze::zelda3::Sprite::higher_x_ = 0

private

Definition at line 137 of file sprite.h.

◆ higher_y_

uint8_t yaze::zelda3::Sprite::higher_y_ = 0

private

Definition at line 138 of file sprite.h.

◆ width_

int yaze::zelda3::Sprite::width_ = 16

private

Definition at line 140 of file sprite.h.

Referenced by Draw(), and width().

◆ height_

int yaze::zelda3::Sprite::height_ = 16

private

Definition at line 141 of file sprite.h.

Referenced by Draw(), and height().

◆ map_x_

int yaze::zelda3::Sprite::map_x_ = 0

private

Definition at line 142 of file sprite.h.

Referenced by InitSprite(), map_x(), Sprite(), UpdateCoordinates(), and UpdateMapProperties().

◆ map_y_

int yaze::zelda3::Sprite::map_y_ = 0

private

Definition at line 143 of file sprite.h.

Referenced by InitSprite(), map_y(), Sprite(), UpdateCoordinates(), and UpdateMapProperties().

◆ layer_

int yaze::zelda3::Sprite::layer_ = 0

private

Definition at line 144 of file sprite.h.

Referenced by layer(), and set_layer().

◆ subtype_

int yaze::zelda3::Sprite::subtype_ = 0

private

Definition at line 145 of file sprite.h.

Referenced by set_subtype(), and subtype().

◆ key_drop_

int yaze::zelda3::Sprite::key_drop_ = 0

private

Definition at line 146 of file sprite.h.

Referenced by key_drop(), and set_key_drop().

◆ deleted_

bool yaze::zelda3::Sprite::deleted_ = false

private

Definition at line 148 of file sprite.h.

Referenced by deleted(), and set_deleted().

◆ overworld_

bool yaze::zelda3::Sprite::overworld_

private

Definition at line 149 of file sprite.h.

Referenced by InitSprite(), and Sprite().

◆ name_

std::string yaze::zelda3::Sprite::name_

private

Definition at line 151 of file sprite.h.

Referenced by InitSprite(), name(), Sprite(), Sprite(), and UpdateMapProperties().

◆ preview_gfx_

std::vector<uint8_t> yaze::zelda3::Sprite::preview_gfx_

private

Definition at line 152 of file sprite.h.

Referenced by ClearPreviewGraphics(), DrawSpriteTile(), preview_graphics(), and RenderPreviewGraphics().

◆ current_gfx_

std::vector<uint8_t> yaze::zelda3::Sprite::current_gfx_

private

Definition at line 153 of file sprite.h.

Referenced by DrawSpriteTile(), and InitSprite().

◆ external_gfx_

const uint8_t* yaze::zelda3::Sprite::external_gfx_ = nullptr

private

Definition at line 154 of file sprite.h.

Referenced by DrawSpriteTile(), and RenderPreviewGraphics().

◆ external_gfx_size_

size_t yaze::zelda3::Sprite::external_gfx_size_ = 0

private

Definition at line 155 of file sprite.h.

Referenced by DrawSpriteTile(), and RenderPreviewGraphics().

◆ bounding_box_

SDL_Rect yaze::zelda3::Sprite::bounding_box_

private

Definition at line 157 of file sprite.h.

Referenced by Draw(), and RenderPreviewGraphics().

The documentation for this class was generated from the following files:

src/zelda3/sprite/sprite.h
src/zelda3/sprite/sprite.cc

	yaze 0.3.2 Link to the Past ROM Editor

Public Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ Sprite() [1/3]

◆ Sprite() [2/3]

◆ Sprite() [3/3]

Member Function Documentation

◆ InitSprite()

◆ Draw()

◆ RenderPreviewGraphics()

◆ ClearPreviewGraphics()

◆ DrawSpriteTile()

◆ UpdateMapProperties()

◆ UpdateCoordinates()

◆ preview_graphics()

◆ id()

◆ set_id()

◆ x()

◆ y()

◆ nx()

◆ ny()

◆ map_id()

◆ map_x()

◆ map_y()

◆ game_state()

◆ layer()

◆ subtype()

◆ width()

◆ height()

◆ name()

◆ deleted()

◆ set_deleted()

◆ set_key_drop()

◆ key_drop()

◆ IsOverlord()

◆ set_subtype()

◆ set_layer()

Member Data Documentation

◆ map_id_

◆ game_state_

◆ id_

◆ nx_

◆ ny_

◆ overlord_

◆ lower_x_

◆ lower_y_

◆ higher_x_

◆ higher_y_

◆ width_

◆ height_

◆ map_x_

◆ map_y_

◆ layer_

◆ subtype_

◆ key_drop_

◆ deleted_

◆ overworld_

◆ name_

◆ preview_gfx_

◆ current_gfx_

◆ external_gfx_

◆ external_gfx_size_

◆ bounding_box_