mapdbentrysprite.h

Go to the documentation of this file.

/*
  * Copyright 2020 Twilight
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
  * You may obtain a copy of the License at
  *
  *   http://www.apache.org/licenses/LICENSE-2.0
  *
  * Unless required by applicable law or agreed to in writing, software
  * distributed under the License is distributed on an "AS IS" BASIS,
  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  * See the License for the specific language governing permissions and
  * limitations under the License.
*/
#pragma once
#include <QObject>
#include "../db_autoport.h"
 
class MapDBEntry;
class MissableDBEntry;
class SpriteDBEntry;
class QQmlEngine;
class MapsDB;
 
// Sprites are a tad complicated only becuase there are different kinds of
// sprites having different set of options and all rolled into one data set.
// Sprites are the 2nd most complicated data structure mainly because sprite
// data is all over the place and in so many different forms and variables
// it's actually a very messy system because it feels like this is one area
// the developers were most trying to figure out through development.
struct DB_AUTOPORT MapDBEntrySprite : public QObject
{
  Q_OBJECT
  Q_PROPERTY(int adjustedX READ adjustedX CONSTANT)     
  Q_PROPERTY(int adjustedY READ adjustedY CONSTANT)     
  Q_PROPERTY(SpriteType type READ type CONSTANT)        
  Q_PROPERTY(QString getSprite READ getSprite CONSTANT) 
  Q_PROPERTY(int getX READ getX CONSTANT)               
  Q_PROPERTY(int getY READ getY CONSTANT)               
  Q_PROPERTY(QString getMove READ getMove CONSTANT)     
  Q_PROPERTY(int getText READ getText CONSTANT)         
  Q_PROPERTY(int getRange READ getRange CONSTANT)       
  Q_PROPERTY(QString getFace READ getFace CONSTANT)     
  Q_PROPERTY(int getMissable READ getMissable CONSTANT) 
  Q_PROPERTY(MissableDBEntry* getToMissable READ getToMissable CONSTANT) 
  Q_PROPERTY(SpriteDBEntry* getToSprite READ getToSprite CONSTANT)       
  Q_PROPERTY(MapDBEntry* getParent READ getParent CONSTANT)             
 
public:
  // Details on all the maps in the game

  enum SpriteType
  {
    // The sprite is a simple NPC
    NPC,
 
    // The sprite is an item that can be obtained
    ITEM,
 
    // The sprite is a one-time Pokemon that can be battled and beaten
    POKEMON,
 
    // The sprite is a trainer which has a team that can be battled and beaten
    TRAINER,
 
    // There's no child class for some reason, your asking the parent who doesn't
    // know
    ERROR
  };
  Q_ENUM(SpriteType)
 
  // X & Y Coordinates adjusted for the gen 1 games
  int adjustedX() const; 
  int adjustedY() const; 
  virtual SpriteType type() const; 
  const QString getSprite() const; 
  int getX() const;                
  int getY() const;                
  const QString getMove() const;   
  int getText() const;             
  int getRange() const;            
  const QString getFace() const;   
  int getMissable() const;         
  MissableDBEntry* getToMissable() const; 
  SpriteDBEntry* getToSprite() const;     
  MapDBEntry* getParent() const;          
 
public slots:
  void qmlProtect(const QQmlEngine* const engine) const; 
 
protected:
  MapDBEntrySprite();                    
  MapDBEntrySprite(const QJsonValue& data, MapDBEntry* const parent); 
  virtual void deepLink();               
  virtual void qmlRegister() const;      
 
  // Name of sprite
  QString sprite; 
 
  // X & Y position on map
  int x = 0; 
  int y = 0; 
 
  // Whether the sprite is moving or remaining still
  // Walk, Stay
  // The game only uses those 2 options but if a 3rd value is present it will
  // move without collision detection
  QString move = ""; 
 
  // Text when interacting with sprite
  int text = -1; 
 
  // Is the sprite allowed room to move?
  // Or is it given a static facing position
  // Only one or the other can be filled in, not both
  int range = -1;    
  QString face = ""; 
 
  // Is this sprite a missable, if so to which missable?
  int missable = -1;                     
  MissableDBEntry* toMissable = nullptr; 
 
  // To Sprite
  SpriteDBEntry* toSprite = nullptr; 
 
  // Parent Map Entry
  MapDBEntry* parent = nullptr; 
 
  friend class MapsDB;
  friend class MapDBEntry;
};