Area Class Reference

The current map's complete live state – everything about "where you are". More...

#include <area.h>

Inheritance diagram for Area:

Collaboration diagram for Area:

Public Member Functions
	Area (SaveFile *saveFile=nullptr)
	< Map music/audio settings.
virtual	~Area ()
void	load (SaveFile *saveFile=nullptr)
	Expand the whole area from the save.
void	save (SaveFile *saveFile)
	Flatten the whole area to the save.
void	reset ()
	Blank the whole area.
void	randomize ()
	Randomize the area (constrained, playable).
void	setTo (MapDBEntry *map)
	Reconfigure the area to map (the "place on any map" feature).

Public Attributes
AreaAudio *	audio = nullptr
AreaLoadedSprites *	preloadedSprites = nullptr
AreaGeneral *	general = nullptr
AreaMap *	map = nullptr
AreaNPC *	npc = nullptr
AreaPlayer *	player = nullptr
AreaPokemon *	pokemon = nullptr
AreaSign *	signs = nullptr
AreaSprites *	sprites = nullptr
AreaTileset *	tileset = nullptr
AreaWarps *	warps = nullptr

Protected Member Functions
void	preloadedSpritesChanged ()
void	generalChanged ()
void	mapChanged ()
void	npcChanged ()
void	playerChanged ()
void	pokemonChanged ()
void	signsChanged ()
void	spritesChanged ()
void	tilesetChanged ()
void	warpsChanged ()

Protected Attributes
	: void audioChanged()

Detailed Description

The current map's complete live state – everything about "where you are".

Groups the eleven facets of the map the player currently stands on: audio, preloadedSprites, general, map, npc, player position, wild pokemon, signs, sprites, tileset, and warps. Follows the standard expanded-node convention (load/save/reset/randomize – see SaveFileExpanded), and adds setTo(MapDBEntry*) which is the heart of the "place the player on any map" feature: it reconfigures the whole area to a chosen map with correct warps/sprites/music/tileset.

Note

Only general is QML-traversed, so only it is a full include here; the other ten children are kept opaque above purely for build speed (see the in-code note). This mirrors savefile_autoport.h's opaque list.

See also

SaveFileExpanded, MapDBEntry, and the system map.

Definition at line 81 of file area.h.

Constructor & Destructor Documentation

Area()

Area::Area

(

SaveFile *

saveFile = nullptr

)

< Map music/audio settings.

Sprite sets loaded for the map. Contrast, letter delay, playtime toggle (QML-traversed). Map id, size, pointers, connections. NPC movement state. Player position/facing on the map. Wild-encounter data. The map's signs. The map's sprites/NPCs. The map's tileset. The map's warps.

Definition at line 43 of file area.cpp.

References audio, general, load(), map, npc, player, pokemon, preloadedSprites, signs, sprites, tileset, and warps.

~Area()

Area::~Area ( )

virtual

Definition at line 60 of file area.cpp.

References audio, general, map, npc, player, pokemon, preloadedSprites, signs, sprites, tileset, and warps.

Member Function Documentation

generalChanged()

void Area::generalChanged ( )

protected

load()

void Area::load

(

SaveFile *

saveFile = nullptr

)

Expand the whole area from the save.

Definition at line 75 of file area.cpp.

References audio, general, map, npc, player, pokemon, preloadedSprites, reset(), signs, sprites, tileset, and warps.

Referenced by Area().

mapChanged()

void Area::mapChanged ( )

protected

npcChanged()

void Area::npcChanged ( )

protected

playerChanged()

void Area::playerChanged ( )

protected

pokemonChanged()

void Area::pokemonChanged ( )

protected

preloadedSpritesChanged()

void Area::preloadedSpritesChanged ( )

protected

randomize()

void Area::randomize

(

)

Randomize the area (constrained, playable).

Definition at line 123 of file area.cpp.

References audio, general, MapsDB::inst(), Random::inst(), map, npc, player, pokemon, preloadedSprites, MapsDB::search(), signs, sprites, tileset, and warps.

Referenced by warpsChanged().

reset()

void Area::reset

(

)

Blank the whole area.

Definition at line 108 of file area.cpp.

References audio, general, map, npc, player, pokemon, preloadedSprites, signs, sprites, tileset, and warps.

Referenced by load(), and warpsChanged().

save()

void Area::save

(

SaveFile *

saveFile

)

Flatten the whole area to the save.

Definition at line 93 of file area.cpp.

References audio, general, map, npc, player, pokemon, preloadedSprites, signs, sprites, tileset, and warps.

setTo()

void Area::setTo

(

MapDBEntry *

map

)

Reconfigure the area to map (the "place on any map" feature).

Definition at line 155 of file area.cpp.

References audio, general, Random::inst(), map, npc, player, pokemon, preloadedSprites, signs, sprites, tileset, and warps.

Referenced by warpsChanged().

signsChanged()

void Area::signsChanged ( )

protected

spritesChanged()

void Area::spritesChanged ( )

protected

tilesetChanged()

void Area::tilesetChanged ( )

protected

warpsChanged()

void Area::warpsChanged ( )

protected

References map, randomize(), reset(), and setTo().

Member Data Documentation

__pad0__

Area::__pad0__

protected

Definition at line 102 of file area.h.

audio

AreaAudio* Area::audio = nullptr

See also

audio property.

Definition at line 124 of file area.h.

Referenced by Area(), load(), randomize(), reset(), save(), setTo(), and ~Area().

general

AreaGeneral* Area::general = nullptr

See also

general property.

Definition at line 126 of file area.h.

Referenced by Area(), load(), randomize(), reset(), save(), setTo(), and ~Area().

map

AreaMap* Area::map = nullptr

See also

map property.

Definition at line 127 of file area.h.

Referenced by Area(), load(), randomize(), reset(), save(), setTo(), warpsChanged(), and ~Area().

npc

AreaNPC* Area::npc = nullptr

See also

npc property.

Definition at line 128 of file area.h.

Referenced by Area(), load(), randomize(), reset(), save(), setTo(), and ~Area().

player

AreaPlayer* Area::player = nullptr

See also

player property.

Definition at line 129 of file area.h.

Referenced by Area(), load(), randomize(), reset(), save(), setTo(), and ~Area().

pokemon

AreaPokemon* Area::pokemon = nullptr

See also

pokemon property.

Definition at line 130 of file area.h.

Referenced by Area(), load(), randomize(), reset(), save(), setTo(), and ~Area().

preloadedSprites

AreaLoadedSprites* Area::preloadedSprites = nullptr

See also

preloadedSprites property.

Definition at line 125 of file area.h.

Referenced by Area(), load(), randomize(), reset(), save(), setTo(), and ~Area().

signs

AreaSign* Area::signs = nullptr

See also

signs property.

Definition at line 131 of file area.h.

Referenced by Area(), load(), randomize(), reset(), save(), setTo(), and ~Area().

sprites

AreaSprites* Area::sprites = nullptr

See also

sprites property.

Definition at line 132 of file area.h.

Referenced by Area(), load(), randomize(), reset(), save(), setTo(), and ~Area().

tileset

AreaTileset* Area::tileset = nullptr

See also

tileset property.

Definition at line 133 of file area.h.

Referenced by Area(), load(), randomize(), reset(), save(), setTo(), and ~Area().

warps

AreaWarps* Area::warps = nullptr

See also

warps property.

Definition at line 134 of file area.h.

Referenced by Area(), load(), randomize(), reset(), save(), setTo(), and ~Area().

---

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

• projects/savefile/src/pse-savefile/expanded/area/area.h
• projects/savefile/src/pse-savefile/expanded/area/area.cpp