WarpData Class Reference

One warp point on the current map: its tile and where it leads. More...

#include <warpdata.h>

Inheritance diagram for WarpData:

Collaboration diagram for WarpData:

Public Member Functions
	WarpData (SaveFile *saveFile=nullptr, var8 index=0)
	< Warp tile Y.
	WarpData (MapDBEntryWarpOut *warp)
	From a map-defined warp.
virtual	~WarpData ()
void	load (SaveFile *saveFile=nullptr, var8 index=0)
	Expand warp index from the save.
void	load (MapDBEntryWarpOut *warp)
	Populate from a map-defined warp.
void	save (SaveFile *saveFile, var8 index)
	Flatten warp index to the save.
MapDBEntry *	toMap ()
	The destination map's DB entry.
protected::void	yChanged ()
void	xChanged ()
void	destWarpChanged ()
void	destMapChanged ()
void	reset ()
	Blank this warp.
void	randomize ()
	Randomize this warp.

Public Attributes
int	y
int	x
int	destWarp
int	destMap

Detailed Description

One warp point on the current map: its tile and where it leads.

Holds the warp's x / y tile position and its destination (destMap + destWarp index on that map). Can be built from the save or from a map DB warp definition. toMap() resolves the destination to its map entry.

See also

AreaWarps (the container), MapDBEntryWarpOut (map-defined warp).

Definition at line 35 of file warpdata.h.

Constructor & Destructor Documentation

WarpData() [1/2]

WarpData::WarpData	(	SaveFile *	saveFile = nullptr,
		var8	index = 0 )

< Warp tile Y.

Warp tile X. Destination warp index on the target map. Destination map id. From the save at warp index.

Definition at line 33 of file warpdata.cpp.

References load().

WarpData() [2/2]

WarpData::WarpData

(

MapDBEntryWarpOut *

warp

)

From a map-defined warp.

Definition at line 38 of file warpdata.cpp.

References load().

~WarpData()

WarpData::~WarpData ( )

virtual

Definition at line 43 of file warpdata.cpp.

Member Function Documentation

destMapChanged()

void WarpData::destMapChanged

(

)

References randomize(), and reset().

Referenced by load(), load(), randomize(), and reset().

destWarpChanged()

void WarpData::destWarpChanged

(

)

Referenced by load(), load(), randomize(), and reset().

load() [1/2]

void WarpData::load

(

MapDBEntryWarpOut *

warp

)

Populate from a map-defined warp.

Definition at line 69 of file warpdata.cpp.

References destMap, destMapChanged(), destWarp, destWarpChanged(), MapDBEntry::getInd(), MapDBEntryWarpOut::getToMap(), MapDBEntryWarpOut::getWarp(), MapDBEntryWarpOut::getX(), MapDBEntryWarpOut::getY(), x, xChanged(), y, and yChanged().

load() [2/2]

void WarpData::load	(	SaveFile *	saveFile = nullptr,
		var8	index = 0 )

Expand warp index from the save.

Definition at line 45 of file warpdata.cpp.

References destMap, destMapChanged(), destWarp, destWarpChanged(), SaveFile::iterator(), SaveFileIterator::offsetTo(), reset(), x, xChanged(), y, and yChanged().

Referenced by WarpData(), and WarpData().

randomize()

void WarpData::randomize

(

)

Randomize this warp.

Definition at line 111 of file warpdata.cpp.

References destMap, destMapChanged(), destWarp, destWarpChanged(), MapsDB::inst(), Random::inst(), Random::rangeExclusive(), reset(), MapsDB::search(), x, xChanged(), y, and yChanged().

Referenced by destMapChanged().

reset()

void WarpData::reset

(

)

Blank this warp.

Definition at line 96 of file warpdata.cpp.

References destMap, destMapChanged(), destWarp, destWarpChanged(), x, xChanged(), y, and yChanged().

Referenced by destMapChanged(), load(), and randomize().

save()

void WarpData::save	(	SaveFile *	saveFile,
		var8	index )

Flatten warp index to the save.

Definition at line 84 of file warpdata.cpp.

References destMap, destWarp, SaveFile::iterator(), SaveFileIterator::offsetTo(), SaveFileIterator::setByte(), x, and y.

toMap()

MapDBEntry * WarpData::toMap

(

)

The destination map's DB entry.

Definition at line 134 of file warpdata.cpp.

References destMap, MapsDB::getIndAt(), and MapsDB::inst().

xChanged()

void WarpData::xChanged

(

)

Referenced by load(), load(), randomize(), and reset().

yChanged()

protected::void WarpData::yChanged

(

)

Referenced by load(), load(), randomize(), and reset().

Member Data Documentation

destMap

int WarpData::destMap

See also

destMap property.

Definition at line 69 of file warpdata.h.

Referenced by load(), load(), randomize(), reset(), save(), and toMap().

destWarp

int WarpData::destWarp

See also

destWarp property.

Definition at line 68 of file warpdata.h.

Referenced by load(), load(), randomize(), reset(), and save().

x

int WarpData::x

See also

x property.

Definition at line 67 of file warpdata.h.

Referenced by load(), load(), randomize(), reset(), and save().

y

int WarpData::y

See also

y property.

Definition at line 66 of file warpdata.h.

Referenced by load(), load(), randomize(), reset(), and save().

---

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

• projects/savefile/src/pse-savefile/expanded/fragments/warpdata.h
• projects/savefile/src/pse-savefile/expanded/fragments/warpdata.cpp