Pokered Save Editor 2
Pokemon Red & Blue save file editor - Qt 6 C++/QML
Loading...
Searching...
No Matches
MapDBEntrySign Struct Reference

One sign defined on a map: its position and text id. More...

#include <mapdbentrysign.h>

Inheritance diagram for MapDBEntrySign:
Collaboration diagram for MapDBEntrySign:

Public Member Functions

int getX () const
 < Sign tile X.
int getY () const
int getTextID () const
MapDBEntry * getParent () const
void qmlProtect (const QQmlEngine *const engine) const
 Pin to C++ ownership.

Protected Member Functions

 MapDBEntrySign ()
 Empty entry.
 MapDBEntrySign (const QJsonValue &data, MapDBEntry *const parent)
 Build from JSON under parent.
void qmlRegister () const
 Register with QML.

Protected Attributes

int x = 0
 Sign tile X.
int y = 0
 Sign tile Y.
int textID = 0
 Text id shown when read.
MapDBEntry * parent = nullptr
 Owning map.

Friends

class MapDBEntry

Detailed Description

One sign defined on a map: its position and text id.

The DB counterpart to the save's SignData. A leaf of MapDBEntry. See db.md.

See also
MapDBEntry (parent), SignData (the save-side sign).

Definition at line 32 of file mapdbentrysign.h.

Constructor & Destructor Documentation

◆ MapDBEntrySign() [1/2]

MapDBEntrySign::MapDBEntrySign ( )
protected

Empty entry.

Definition at line 26 of file mapdbentrysign.cpp.

References qmlRegister().

◆ MapDBEntrySign() [2/2]

MapDBEntrySign::MapDBEntrySign ( const QJsonValue & data,
MapDBEntry *const parent )
protected

Build from JSON under parent.

Definition at line 54 of file mapdbentrysign.cpp.

References MapDBEntry, parent, qmlRegister(), textID, x, and y.

Member Function Documentation

◆ getParent()

MapDBEntry * MapDBEntrySign::getParent ( ) const
See also
getParent property.

Definition at line 30 of file mapdbentrysign.cpp.

References MapDBEntry, and parent.

◆ getTextID()

int MapDBEntrySign::getTextID ( ) const
See also
getTextID property.

Definition at line 40 of file mapdbentrysign.cpp.

References textID.

Referenced by SignData::setTo().

◆ getX()

int MapDBEntrySign::getX ( ) const

< Sign tile X.

Sign tile Y. Text id shown when read. Owning map.

See also
getX property.

Definition at line 50 of file mapdbentrysign.cpp.

References x.

Referenced by SignData::setTo().

◆ getY()

int MapDBEntrySign::getY ( ) const
See also
getY property.

Definition at line 45 of file mapdbentrysign.cpp.

References y.

Referenced by SignData::setTo().

◆ qmlProtect()

void MapDBEntrySign::qmlProtect ( const QQmlEngine *const engine) const

Pin to C++ ownership.

Definition at line 35 of file mapdbentrysign.cpp.

References Utility::qmlProtectUtil().

◆ qmlRegister()

void MapDBEntrySign::qmlRegister ( ) const
protected

Register with QML.

Definition at line 63 of file mapdbentrysign.cpp.

Referenced by MapDBEntrySign(), and MapDBEntrySign().

◆ MapDBEntry

friend class MapDBEntry
friend

Definition at line 64 of file mapdbentrysign.h.

References MapDBEntry.

Referenced by getParent(), MapDBEntry, and MapDBEntrySign().

Member Data Documentation

◆ parent

MapDBEntry* MapDBEntrySign::parent = nullptr
protected

Owning map.

Definition at line 62 of file mapdbentrysign.h.

Referenced by getParent(), and MapDBEntrySign().

◆ textID

int MapDBEntrySign::textID = 0
protected

Text id shown when read.

Definition at line 60 of file mapdbentrysign.h.

Referenced by getTextID(), and MapDBEntrySign().

◆ x

int MapDBEntrySign::x = 0
protected

Sign tile X.

Definition at line 56 of file mapdbentrysign.h.

Referenced by getX(), and MapDBEntrySign().

◆ y

int MapDBEntrySign::y = 0
protected

Sign tile Y.

Definition at line 57 of file mapdbentrysign.h.

Referenced by getY(), and MapDBEntrySign().

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