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

One hidden pickup's location: its map and tile coordinates. More...

#include <hiddenitemdbentry.h>

Inheritance diagram for HiddenItemDBEntry:
Collaboration diagram for HiddenItemDBEntry:

Public Member Functions

QString getMap () const
 < Map name the pickup is on.
int getX () const
int getY () const
MapDBEntry * getToMap () const
void qmlProtect (const QQmlEngine *const engine) const
 Pin to C++ ownership.

Protected Member Functions

 HiddenItemDBEntry ()
 Empty entry (built by the DB).
 HiddenItemDBEntry (const QJsonValue &data)
 Build from a JSON value.
void deepLink ()
 Resolve the map link.
void qmlRegister () const
 Register with QML.

Protected Attributes

QString map = ""
 Backing field (read via getMap()).
int x = 0
 Backing field (read via getX()).
int y = 0
 Backing field (read via getY()).
MapDBEntry * toMap = nullptr
 Resolved map (deepLink).

Friends

class AbstractHiddenItemDB
 Owning DB constructs/populates entries.

Detailed Description

One hidden pickup's location: its map and tile coordinates.

QObject-getter style DB entry shared by both hidden databases (items and coins, via AbstractHiddenItemDB). toMap is resolved in deepLink(). See db.md.

See also
AbstractHiddenItemDB, HiddenItemsDB, HiddenCoinsDB, WorldHidden.

Definition at line 35 of file hiddenitemdbentry.h.

Constructor & Destructor Documentation

◆ HiddenItemDBEntry() [1/2]

HiddenItemDBEntry::HiddenItemDBEntry ( )
protected

Empty entry (built by the DB).

Definition at line 30 of file hiddenitemdbentry.cpp.

References qmlRegister().

◆ HiddenItemDBEntry() [2/2]

HiddenItemDBEntry::HiddenItemDBEntry ( const QJsonValue & data)
protected

Build from a JSON value.

Definition at line 34 of file hiddenitemdbentry.cpp.

References map, qmlRegister(), x, and y.

Member Function Documentation

◆ deepLink()

void HiddenItemDBEntry::deepLink ( )
protected

Resolve the map link.

Definition at line 44 of file hiddenitemdbentry.cpp.

References MapsDB::getIndAt(), MapsDB::inst(), map, and toMap.

◆ getMap()

QString HiddenItemDBEntry::getMap ( ) const

< Map name the pickup is on.

Tile X. Tile Y. Resolved map.

See also
getMap property.

Definition at line 68 of file hiddenitemdbentry.cpp.

References map.

◆ getToMap()

MapDBEntry * HiddenItemDBEntry::getToMap ( ) const
See also
getToMap property.

Definition at line 83 of file hiddenitemdbentry.cpp.

References toMap.

◆ getX()

int HiddenItemDBEntry::getX ( ) const
See also
getX property.

Definition at line 73 of file hiddenitemdbentry.cpp.

References x.

◆ getY()

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

Definition at line 78 of file hiddenitemdbentry.cpp.

References y.

◆ qmlProtect()

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

Pin to C++ ownership.

Definition at line 88 of file hiddenitemdbentry.cpp.

References Utility::qmlProtectUtil().

◆ qmlRegister()

void HiddenItemDBEntry::qmlRegister ( ) const
protected

Register with QML.

Definition at line 57 of file hiddenitemdbentry.cpp.

Referenced by HiddenItemDBEntry(), and HiddenItemDBEntry().

◆ AbstractHiddenItemDB

friend class AbstractHiddenItemDB
friend

Owning DB constructs/populates entries.

Definition at line 62 of file hiddenitemdbentry.h.

References AbstractHiddenItemDB.

Referenced by AbstractHiddenItemDB.

Member Data Documentation

◆ map

QString HiddenItemDBEntry::map = ""
protected

Backing field (read via getMap()).

Definition at line 57 of file hiddenitemdbentry.h.

Referenced by deepLink(), getMap(), and HiddenItemDBEntry().

◆ toMap

MapDBEntry* HiddenItemDBEntry::toMap = nullptr
protected

Resolved map (deepLink).

Definition at line 60 of file hiddenitemdbentry.h.

Referenced by deepLink(), and getToMap().

◆ x

int HiddenItemDBEntry::x = 0
protected

Backing field (read via getX()).

Definition at line 58 of file hiddenitemdbentry.h.

Referenced by getX(), and HiddenItemDBEntry().

◆ y

int HiddenItemDBEntry::y = 0
protected

Backing field (read via getY()).

Definition at line 59 of file hiddenitemdbentry.h.

Referenced by getY(), and HiddenItemDBEntry().

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