mmo-ref/tibia-rme
1
0
Fork 0
mirror of https://github.com/opentibiabr/remeres-map-editor synced 2026-08-15 18:26:04 -04:00
Code Issues Projects Releases Packages Wiki Activity
tibia-rme/source/items.h
Victor 2f5cf89792
fix: correct start_frame type mismatch from protobuf loading (#163) 
## What was changed  
  
Fixes an assertion failure in the `Animator` constructor caused by
`start_frame`
receiving the value `255` (uint32) from protobuf `default_start_phase`,
instead of
`-1` (int8) as expected.  
  
## Why  
  
The `.dat` loading path reads `start_frame` as `int8_t`, so the byte
`255` becomes
`-1`, which is a valid sentinel value for the `Animator`. However, the
protobuf
loading path stores `default_start_phase` as `uint32_t`,   
preserving the value `255`, which fails the assertion   
`ASSERT(start_frame >= -1 && start_frame < frame_count)`.  
  
## Changes  
  
- `source/items.h`: Changed `start_frame` type from `uint32_t` to
`int32_t`
- `source/items.cpp`: Added `static_cast<int8_t>` when reading
`default_start_phase` from protobuf
- `source/graphics.cpp`: Added `static_cast<int8_t>` in
`loadOutfitSpriteMetadata` and `static_cast<int>` in
`loadItemSpriteMetadata` when creating `Animator`

<!-- This is an auto-generated comment: release notes by coderabbit.ai
-->

## Summary by CodeRabbit

* **Bug Fixes**
* Fixed animation frame value handling for items and sprite metadata to
ensure consistent initialization and proper animation playback
sequences.

<!-- end of auto-generated comment: release notes by coderabbit.ai -->
2026-04-14 13:39:40 -03:00

485 lines
11 KiB
C++
Raw Permalink Blame History

//////////////////////////////////////////////////////////////////////
// This file is part of Remere's Map Editor
//////////////////////////////////////////////////////////////////////
// Remere's Map Editor is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// Remere's Map Editor is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with this program. If not, see <http://www.gnu.org/licenses/>.
//////////////////////////////////////////////////////////////////////
#ifndef RME_ITEMS_H_
#define RME_ITEMS_H_
#include "filehandle.h"
#include "brush_enums.h"
namespace canary {
namespace protobuf {
namespace appearances {
class Appearances;
}
}
}
class Brush;
class GroundBrush;
class WallBrush;
class CarpetBrush;
class TableBrush;
class HouseBrush;
class HouseExitBrush;
class OptionalBorderBrush;
class EraserBrush;
class SpawnMonsterBrush;
class SpawnNpcBrush;
class DoorBrush;
class FlagBrush;
class RAWBrush;
class ItemType;
class GameSprite;
class GameSprite;
class ItemDatabase;
typedef uint8_t attribute_t;
typedef uint32_t flags_t;
typedef uint16_t datasize_t;
enum ItemGroup_t {
ITEM_GROUP_NONE = 0,
ITEM_GROUP_GROUND,
ITEM_GROUP_CONTAINER,
ITEM_GROUP_WEAPON,
ITEM_GROUP_AMMUNITION,
ITEM_GROUP_ARMOR,
ITEM_GROUP_RUNE,
ITEM_GROUP_TELEPORT,
ITEM_GROUP_MAGICFIELD,
ITEM_GROUP_WRITEABLE,
ITEM_GROUP_KEY,
ITEM_GROUP_SPLASH,
ITEM_GROUP_FLUID,
ITEM_GROUP_DOOR,
ITEM_GROUP_DEPRECATED,
ITEM_GROUP_LAST
};
enum ItemTypes_t {
ITEM_TYPE_NONE = 0,
ITEM_TYPE_DEPOT,
ITEM_TYPE_MAILBOX,
ITEM_TYPE_TRASHHOLDER,
ITEM_TYPE_CONTAINER,
ITEM_TYPE_DOOR,
ITEM_TYPE_MAGICFIELD,
ITEM_TYPE_TELEPORT,
ITEM_TYPE_BED,
ITEM_TYPE_KEY,
ITEM_TYPE_LAST
};
enum ItemHook_t {
ITEM_HOOK_NONE = 0,
ITEM_HOOK_SOUTH = 1,
ITEM_HOOK_EAST = 2,
};
/////////OTB specific//////////////
enum rootattrib_t {
ROOT_ATTR_VERSION = 0x01
};
enum itemattrib_t {
ITEM_ATTR_FIRST = 0x10,
ITEM_ATTR_SERVERID = ITEM_ATTR_FIRST,
ITEM_ATTR_CLIENTID,
ITEM_ATTR_NAME,
ITEM_ATTR_DESCR,
ITEM_ATTR_SPEED,
ITEM_ATTR_SLOT,
ITEM_ATTR_MAXITEMS,
ITEM_ATTR_WEIGHT,
ITEM_ATTR_WEAPON,
ITEM_ATTR_AMU,
ITEM_ATTR_ARMOR,
ITEM_ATTR_MAGLEVEL,
ITEM_ATTR_MAGFIELDTYPE,
ITEM_ATTR_WRITEABLE,
ITEM_ATTR_ROTATETO,
ITEM_ATTR_DECAY,
ITEM_ATTR_SPRITEHASH,
ITEM_ATTR_MINIMAPCOLOR,
ITEM_ATTR_07,
ITEM_ATTR_08,
ITEM_ATTR_LIGHT,
// 1-byte aligned
ITEM_ATTR_DECAY2,
ITEM_ATTR_WEAPON2,
ITEM_ATTR_AMU2,
ITEM_ATTR_ARMOR2,
ITEM_ATTR_WRITEABLE2,
ITEM_ATTR_LIGHT2,
ITEM_ATTR_TOPORDER,
ITEM_ATTR_WRITEABLE3,
ITEM_ATTR_LAST
};
enum itemflags_t {
FLAG_UNPASSABLE = 1 << 0,
FLAG_BLOCK_MISSILES = 1 << 1,
FLAG_BLOCK_PATHFINDER = 1 << 2,
FLAG_HAS_ELEVATION = 1 << 3,
FLAG_USEABLE = 1 << 4,
FLAG_PICKUPABLE = 1 << 5,
FLAG_MOVEABLE = 1 << 6,
FLAG_STACKABLE = 1 << 7,
FLAG_FLOORCHANGEDOWN = 1 << 8,
FLAG_FLOORCHANGENORTH = 1 << 9,
FLAG_FLOORCHANGEEAST = 1 << 10,
FLAG_FLOORCHANGESOUTH = 1 << 11,
FLAG_FLOORCHANGEWEST = 1 << 12,
FLAG_ALWAYSONTOP = 1 << 13,
FLAG_READABLE = 1 << 14,
FLAG_ROTABLE = 1 << 15,
FLAG_HANGABLE = 1 << 16,
FLAG_HOOK_EAST = 1 << 17,
FLAG_HOOK_SOUTH = 1 << 18,
FLAG_CANNOTDECAY = 1 << 19,
FLAG_ALLOWDISTREAD = 1 << 20,
FLAG_UNUSED = 1 << 21,
FLAG_CLIENTCHARGES = 1 << 22,
FLAG_IGNORE_LOOK = 1 << 23
};
enum slotsOTB_t {
OTB_SLOT_DEFAULT,
OTB_SLOT_HEAD,
OTB_SLOT_BODY,
OTB_SLOT_LEGS,
OTB_SLOT_BACKPACK,
OTB_SLOT_WEAPON,
OTB_SLOT_2HAND,
OTB_SLOT_FEET,
OTB_SLOT_AMULET,
OTB_SLOT_RING,
OTB_SLOT_HAND,
};
enum ShootTypeOtb_t {
OTB_SHOOT_NONE = 0,
OTB_SHOOT_BOLT = 1,
OTB_SHOOT_ARROW = 2,
OTB_SHOOT_FIRE = 3,
OTB_SHOOT_ENERGY = 4,
OTB_SHOOT_POISONARROW = 5,
OTB_SHOOT_BURSTARROW = 6,
OTB_SHOOT_THROWINGSTAR = 7,
OTB_SHOOT_THROWINGKNIFE = 8,
OTB_SHOOT_SMALLSTONE = 9,
OTB_SHOOT_SUDDENDEATH = 10,
OTB_SHOOT_LARGEROCK = 11,
OTB_SHOOT_SNOWBALL = 12,
OTB_SHOOT_POWERBOLT = 13,
OTB_SHOOT_SPEAR = 14,
OTB_SHOOT_POISONFIELD = 15,
OTB_SHOOT_INFERNALBOLT = 16
};
// 1-byte aligned structs
#pragma pack(1)
struct VERSIONINFO {
uint32_t dwMajorVersion;
uint32_t dwMinorVersion;
uint32_t dwBuildNumber;
uint8_t CSDVersion[128];
};
struct decayBlock2 {
uint16_t decayTo;
uint16_t decayTime;
};
struct weaponBlock2 {
uint8_t weaponType;
uint8_t amuType;
uint8_t shootType;
uint8_t attack;
uint8_t defence;
};
struct amuBlock2 {
uint8_t amuType;
uint8_t shootType;
uint8_t attack;
};
struct armorBlock2 {
uint16_t armor;
double weight;
uint16_t slot_position;
};
struct writeableBlock2 {
uint16_t readOnlyId;
};
struct lightBlock2 {
uint16_t lightLevel;
uint16_t lightColor;
};
struct writeableBlock3 {
uint16_t readOnlyId;
uint16_t maxTextLen;
};
#pragma pack()
class ItemType {
private:
ItemType(const ItemType &) { }
public:
ItemType() = default;
bool isGroundTile() const noexcept {
return group == ITEM_GROUP_GROUND;
}
bool isSplash() const noexcept {
return group == ITEM_GROUP_SPLASH;
}
bool isFluidContainer() const noexcept {
return group == ITEM_GROUP_FLUID;
}
bool isClientCharged() const {
return client_chargeable;
}
bool isExtraCharged() const {
return !client_chargeable && extra_chargeable;
}
bool isDepot() const noexcept {
return type == ITEM_TYPE_DEPOT;
}
bool isMailbox() const noexcept {
return type == ITEM_TYPE_MAILBOX;
}
bool isTrashHolder() const noexcept {
return type == ITEM_TYPE_TRASHHOLDER;
}
bool isContainer() const noexcept {
return type == ITEM_TYPE_CONTAINER;
}
bool isDoor() const noexcept {
return type == ITEM_TYPE_DOOR;
}
bool isMagicField() const noexcept {
return type == ITEM_TYPE_MAGICFIELD;
}
bool isTeleport() const noexcept {
return type == ITEM_TYPE_TELEPORT;
}
bool isBed() const noexcept {
return type == ITEM_TYPE_BED;
}
bool isKey() const noexcept {
return type == ITEM_TYPE_KEY;
}
bool isStackable() const noexcept {
return stackable;
}
bool isMetaItem() const noexcept {
return is_metaitem;
}
bool isFloorChange() const noexcept;
float getWeight() const noexcept {
return weight;
}
uint16_t getVolume() const noexcept {
return volume;
}
public:
GameSprite* sprite = nullptr;
Brush* brush = nullptr;
Brush* doodad_brush = nullptr;
RAWBrush* raw_brush = nullptr;
std::vector<std::pair<int, int>> m_animationPhases;
int m_numPatternX { 0 }, m_numPatternY { 0 }, m_numPatternZ { 0 };
int m_layers { 0 };
std::vector<int> m_sprites;
uint8_t sprite_phase_size = 0;
uint16_t id = 0;
uint16_t clientID = 0;
uint16_t volume = 0;
uint16_t maxTextLen = 0;
uint16_t write_once_item_id = 0;
uint16_t ground_equivalent = 0;
uint16_t rotateTo = 0;
uint32_t border_group = 0;
uint32_t pattern_width = 0;
uint32_t pattern_height = 0;
uint32_t pattern_depth = 0;
uint32_t layers = 0;
uint32_t width = 0;
uint32_t height = 0;
uint32_t sprite_id = 0;
uint32_t loop_count = 0;
int32_t start_frame = 0;
uint32_t patternWidth = 0;
uint32_t charges = 0;
std::string name;
std::string editorsuffix;
std::string description;
float weight = 0.0;
int attack = 0;
int defense = 0;
int armor = 0;
int alwaysOnTopOrder = 0;
bool is_metaitem = false;
// This is needed as a consequence of the item palette & the raw palette
// using the same brushes ("others" category consists of items with this
// flag set to false)
bool has_raw = false;
bool in_other_tileset = false;
bool async_animation = false;
bool has_equivalent = false; // True if any item has this as ground_equivalent
bool wall_hate_me = false; // (For wallbrushes, regard this as not part of the wall)
bool client_chargeable = false;
bool extra_chargeable = false;
bool ignoreLook = false;
bool isHangable = false;
bool isCorpse = false;
bool isVertical = false;
bool isHorizontal = false;
bool isPodium = false;
bool hookEast = false;
bool hookSouth = false;
bool canReadText = false;
bool canWriteText = false;
bool allowDistRead = false;
bool replaceable = true;
bool decays = false;
bool stackable = false;
bool moveable = true;
bool alwaysOnBottom = false;
bool pickupable = false;
bool rotable = false;
bool isBorder = false;
bool isOptionalBorder = false;
bool isWall = false;
bool isBrushDoor = false;
bool isOpen = false;
bool isTable = false;
bool isCarpet = false;
bool floorChangeDown = false;
bool floorChangeNorth = false;
bool floorChangeSouth = false;
bool floorChangeEast = false;
bool floorChangeWest = false;
bool floorChange = false;
bool unpassable = false;
bool blockPickupable = false;
bool blockMissiles = false;
bool blockPathfinder = false;
bool hasElevation = false;
bool forceUse = false;
bool hasHeight = false;
bool walkStack = false;
bool spriteInfo = false;
bool noMoveAnimation = false;
BorderType border_alignment = BORDER_NONE;
ItemGroup_t group = ITEM_GROUP_NONE;
ItemTypes_t type = ITEM_TYPE_NONE;
ItemHook_t hook = ITEM_HOOK_NONE;
};
class ItemDatabase {
public:
~ItemDatabase();
ItemType &operator[](uint16_t id);
void clear();
uint16_t getMinID() const noexcept {
return 100;
}
uint16_t getMaxID() const noexcept {
return maxItemId;
}
ItemType &getItemType(uint16_t id);
std::shared_ptr<ItemType> getRawItemType(uint16_t id);
bool isValidID(uint16_t id) const;
bool loadFromOtb(const FileName &datafile, wxString &error, wxArrayString &warnings);
bool loadFromProtobuf(wxString &error, wxArrayString &warnings, canary::protobuf::appearances::Appearances &appearances);
bool loadFromGameXml(const FileName &datafile, wxString &error, wxArrayString &warnings);
bool loadItemFromGameXml(pugi::xml_node itemNode, uint16_t id);
bool loadMetaItem(pugi::xml_node node);
// typedef std::map<int32_t, std::shared_ptr<ItemType>> ItemMap;
typedef contigous_vector<std::shared_ptr<ItemType>> ItemMap;
typedef std::map<std::string, std::shared_ptr<ItemType>> ItemNameMap;
// Version information
uint32_t MajorVersion;
uint32_t MinorVersion;
uint32_t BuildNumber;
protected:
bool loadGroupByOtbVersion(const std::shared_ptr<ItemType> &item, wxArrayString &warnings) const;
bool loadFlagsByOtbVersion(const std::shared_ptr<ItemType> &item, BinaryNode* itemNode) const;
bool handleAttributes(const std::shared_ptr<ItemType> &item, uint8_t &attribute, uint16_t &datalen, BinaryNode* itemNode, wxString &error, wxArrayString &warnings);
bool loadAttributesByOtbVersion(const std::shared_ptr<ItemType> &item, BinaryNode* itemNode, wxString &error, wxArrayString &warnings);
bool loadFromOtb(BinaryNode* itemNode, wxString &error, wxArrayString &warnings);
protected:
ItemMap items;
// Count of GameSprite types
uint16_t item_count = 0;
uint16_t effect_count = 0;
uint16_t monster_count = 0;
uint16_t distance_count = 0;
uint16_t maxItemId = 0;
ItemType dummy;
friend class GameSprite;
friend class Item;
};
extern ItemDatabase g_items;
#endif
Reference in a new issue View git blame Copy permalink