AreaSign Class Reference

The current map's list of signs. More...

#include <areasign.h>

Inheritance diagram for AreaSign:

Collaboration diagram for AreaSign:

Public Member Functions
	AreaSign (SaveFile *saveFile=nullptr)
virtual	~AreaSign ()
void	load (SaveFile *saveFile=nullptr)
	Expand the sign list from the save.
void	save (SaveFile *saveFile)
	Flatten the sign list to the save.
int	signCount ()
	Number of signs.
int	signMax ()
	Capacity (maxSigns).
SignData *	signAt (int ind)
	Sign ind (GC-protected return).
void	signSwap (int from, int to)
	Reorder signs.
void	signRemove (int ind)
	Remove sign ind.
void	signNew ()
	Add a fresh sign.
protected::void	signsChanged ()
void	reset ()
	Empty the sign list.
void	randomize (MapDBEntry *mapData)
	Randomize signs for mapData.
void	setTo (MapDBEntry *mapData)
	Rebuild the list from mapData's signs.

Public Attributes
QVector< SignData * >	signs
	The map's signs.

Detailed Description

The current map's list of signs.

A variable-length list of SignData (up to maxSigns) with QML add/remove/ swap/access. setTo()/randomize() rebuild the list from a chosen map's signs. Standard expanded-node convention (see SaveFileExpanded).

See also

SignData (a sign), Area, MapDBEntry.

Definition at line 37 of file areasign.h.

Constructor & Destructor Documentation

AreaSign()

AreaSign::AreaSign

(

SaveFile *

saveFile = nullptr

)

Definition at line 32 of file areasign.cpp.

References load().

~AreaSign()

AreaSign::~AreaSign ( )

virtual

Definition at line 37 of file areasign.cpp.

References signs.

Member Function Documentation

load()

void AreaSign::load

(

SaveFile *

saveFile = nullptr

)

Expand the sign list from the save.

Definition at line 88 of file areasign.cpp.

References reset(), signs, signsChanged(), and SaveFile::toolset.

Referenced by AreaSign().

randomize()

void AreaSign::randomize

(

MapDBEntry *

mapData

)

Randomize signs for mapData.

Definition at line 124 of file areasign.cpp.

References MapDBEntry::getSigns(), SignData::randomizeAll(), reset(), signs, and signsChanged().

Referenced by signsChanged().

reset()

void AreaSign::reset

(

)

Empty the sign list.

Definition at line 114 of file areasign.cpp.

References signs, and signsChanged().

Referenced by load(), randomize(), setTo(), and signsChanged().

save()

void AreaSign::save

(

SaveFile *

saveFile

)

Flatten the sign list to the save.

Definition at line 104 of file areasign.cpp.

References SaveFileToolset::setByte(), signs, and SaveFile::toolset.

setTo()

void AreaSign::setTo

(

MapDBEntry *

mapData

)

Rebuild the list from mapData's signs.

Definition at line 137 of file areasign.cpp.

References MapDBEntry::getSigns(), reset(), SignData::setToAll(), signs, and signsChanged().

Referenced by signsChanged().

signAt()

SignData * AreaSign::signAt

(

int

ind

)

Sign ind (GC-protected return).

Definition at line 53 of file areasign.cpp.

References qmlCppOwned(), and signs.

signCount()

int AreaSign::signCount

(

)

Number of signs.

Definition at line 43 of file areasign.cpp.

References signs.

signMax()

int AreaSign::signMax

(

)

Capacity (maxSigns).

Definition at line 48 of file areasign.cpp.

References maxSigns.

signNew()

void AreaSign::signNew

(

)

Add a fresh sign.

Definition at line 79 of file areasign.cpp.

References maxSigns, signs, and signsChanged().

signRemove()

void AreaSign::signRemove

(

int

ind

)

Remove sign ind.

Definition at line 69 of file areasign.cpp.

References signs, and signsChanged().

signsChanged()

protected::void AreaSign::signsChanged

(

)

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

Referenced by load(), randomize(), reset(), setTo(), signNew(), signRemove(), and signSwap().

signSwap()

void AreaSign::signSwap	(	int	from,
		int	to )

Reorder signs.

Definition at line 58 of file areasign.cpp.

References signs, and signsChanged().

Member Data Documentation

signs

QVector<SignData*> AreaSign::signs

The map's signs.

Definition at line 64 of file areasign.h.

Referenced by load(), randomize(), reset(), save(), setTo(), signAt(), signCount(), signNew(), signRemove(), signSwap(), and ~AreaSign().

---

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

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