tibia-rme/source/item.cpp

//////////////////////////////////////////////////////////////////////
// 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/>.
//////////////////////////////////////////////////////////////////////

#include "main.h"

#include "brush.h"
#include "graphics.h"
#include "gui.h"
#include "tile.h"
#include "complexitem.h"
#include "iomap.h"
#include "item.h"
#include "object_pool.h"

#include "ground_brush.h"
#include "carpet_brush.h"
#include "table_brush.h"
#include "wall_brush.h"

namespace {
	bool itemTypeHasSubtype(const ItemType &type) {
		return type.isFluidContainer() || type.stackable || type.charges != 0 || type.isSplash() || type.isClientCharged() || type.isExtraCharged();
	}
}

void* Item::operator new(size_t size) {
	return rme::allocatePooledObject(size);
}

void Item::operator delete(void* ptr) noexcept {
	rme::deallocatePooledObject(ptr);
}

#ifdef DEBUG_MEM
void* Item::operator new(size_t size, const char*, int) {
	return rme::allocatePooledObject(size);
}

void Item::operator delete(void* ptr, const char*, int) noexcept {
	rme::deallocatePooledObject(ptr);
}
#endif

Item* Item::Create(uint16_t id, uint16_t subtype /*= 0xFFFF*/) {
	if (id == 0) {
		return nullptr;
	}

	const ItemType &type = g_items.getItemType(id);
	return Create(id, type, subtype);
}

Item* Item::Create(uint16_t id, const ItemType &type, uint16_t subtype /*= 0xFFFF*/) {
	if (id == 0) {
		return nullptr;
	}

	if (type.id == 0) {
		return newd Item(id, subtype, false);
	}

	if (!type.sprite) {
		return nullptr;
	}

	if (type.isDepot()) {
		return new Depot(id); // NOSONAR - item factories return raw pointers owned by tiles and maps.
	} else if (type.isContainer()) {
		return new Container(id); // NOSONAR - item factories return raw pointers owned by tiles and maps.
	} else if (type.isTeleport()) {
		return new Teleport(id); // NOSONAR - item factories return raw pointers owned by tiles and maps.
	} else if (type.isDoor()) {
		return new Door(id); // NOSONAR - item factories return raw pointers owned by tiles and maps.
	} else if (subtype == 0xFFFF) {
		const bool hasSubtype = itemTypeHasSubtype(type);
		if (type.isFluidContainer()) {
			return new Item(id, LIQUID_NONE, hasSubtype); // NOSONAR - item factories return raw pointers owned by tiles and maps.
		} else if (type.isSplash()) {
			return new Item(id, LIQUID_WATER, hasSubtype); // NOSONAR - item factories return raw pointers owned by tiles and maps.
		} else if (type.charges > 0) {
			return new Item(id, type.charges, hasSubtype); // NOSONAR - item factories return raw pointers owned by tiles and maps.
		} else {
			return new Item(id, 1, hasSubtype); // NOSONAR - item factories return raw pointers owned by tiles and maps.
		}
	}
	return new Item(id, subtype, itemTypeHasSubtype(type)); // NOSONAR - item factories return raw pointers owned by tiles and maps.
}

Item::Item(unsigned short _type, unsigned short _count) :
	Item(_type, _count, itemTypeHasSubtype(g_items.getItemType(_type))) {
}

Item::Item(unsigned short _type, unsigned short _count, bool typeHasSubtype) :
	id(_type),
	subtype(1),
	selected(false),
	frame(0) {
	if (typeHasSubtype) {
		subtype = _count;
	}
}

Item::~Item() {
	////
}

Item* Item::deepCopy() const {
	Item* copy = Create(id, subtype);
	if (copy) {
		copy->selected = selected;
		if (attributes) {
			copy->attributes = newd ItemAttributeMap(*attributes);
		}
	}
	return copy;
}

Item* transformItem(Item* old_item, uint16_t new_id, Tile* parent) {
	if (old_item == nullptr) {
		return nullptr;
	}

	old_item->setID(new_id);
	// Through the magic of deepCopy, this will now be a pointer to an item of the correct type.
	Item* new_item = old_item->deepCopy();
	if (parent) {
		// Find the old item and remove it from the tile, insert this one instead!
		if (old_item == parent->ground) {
			delete old_item;
			parent->ground = new_item;
			return new_item;
		}

		std::queue<Container*> containers;
		for (ItemVector::iterator item_iter = parent->items.begin(); item_iter != parent->items.end(); ++item_iter) {
			if (*item_iter == old_item) {
				delete old_item;
				item_iter = parent->items.erase(item_iter);
				parent->items.insert(item_iter, new_item);
				return new_item;
			}

			Container* c = dynamic_cast<Container*>(*item_iter);
			if (c) {
				containers.push(c);
			}
		}

		while (containers.size() != 0) {
			Container* container = containers.front();
			ItemVector &v = container->getVector();
			for (ItemVector::iterator item_iter = v.begin(); item_iter != v.end(); ++item_iter) {
				Item* i = *item_iter;
				Container* c = dynamic_cast<Container*>(i);
				if (c) {
					containers.push(c);
				}

				if (i == old_item) {
					// Found it!
					item_iter = v.erase(item_iter);
					v.insert(item_iter, new_item);
					return new_item;
				}
			}
			containers.pop();
		}
	}

	delete new_item;
	return nullptr;
}

uint32_t Item::memsize() const {
	uint32_t mem = sizeof(*this);
	return mem;
}

void Item::setID(uint16_t new_id) {
	id = new_id;
}

void Item::setSubtype(uint16_t _subtype) {
	subtype = _subtype;
	setAttribute("subtype", subtype);
}

bool Item::hasSubtype() const {
	return hasSubtype(g_items.getItemType(id));
}

bool Item::hasSubtype(const ItemType &type) const noexcept {
	return itemTypeHasSubtype(type);
}

uint16_t Item::getSubtype() const {
	return getSubtype(g_items.getItemType(id));
}

uint16_t Item::getSubtype(const ItemType &type) const noexcept {
	return hasSubtype(type) ? subtype : 0;
}

bool Item::hasProperty(enum ITEMPROPERTY prop) const {
	const ItemType &type = g_items.getItemType(id);
	switch (prop) {
		case BLOCKSOLID:
			if (type.unpassable) {
				return true;
			}
			break;

		case MOVEABLE:
			if (type.moveable && getUniqueID() == 0) {
				return true;
			}
			break;
			/*
					case HASHEIGHT:
						if(it.height != 0 )
							return true;
						break;
			*/
		case BLOCKPROJECTILE:
			if (type.blockMissiles) {
				return true;
			}
			break;

		case BLOCKPATHFIND:
			if (type.blockPathfinder) {
				return true;
			}
			break;

		case HOOK_SOUTH:
			if (type.hookSouth || type.hook == ITEM_HOOK_SOUTH) {
				return true;
			}
			break;

		case HOOK_EAST:
			if (type.hookEast || type.hook == ITEM_HOOK_EAST) {
				return true;
			}
			break;

		case BLOCKINGANDNOTMOVEABLE:
			if (type.unpassable && (!type.moveable || getUniqueID() != 0)) {
				return true;
			}
			break;

		default:
			return false;
	}
	return false;
}

wxPoint Item::getDrawOffset() const {
	const ItemType &type = g_items.getItemType(id);
	if (type.sprite) {
		return type.sprite->getDrawOffset();
	}

	return wxPoint(0, 0);
}

uint16_t Item::getGroundSpeed() const {
	const auto &type = g_items.getItemType(id);
	if (type.sprite) {
		return type.sprite->ground_speed;
	}
	return 0;
}

bool Item::hasLight() const {
	const ItemType &type = g_items.getItemType(id);
	if (type.sprite) {
		return type.sprite->hasLight();
	}
	return false;
}

SpriteLight Item::getLight() const {
	const ItemType &type = g_items.getItemType(id);
	if (type.sprite) {
		return type.sprite->getLight();
	}
	return SpriteLight { 0, 0 };
}

double Item::getWeight() const {
	const ItemType &type = g_items.getItemType(id);
	if (type.stackable) {
		return type.weight * std::max(1, (int)subtype);
	}
	return type.weight;
}

void Item::setUniqueID(unsigned short n) {
	setAttribute("uid", n);
}

void Item::setActionID(unsigned short n) {
	setAttribute("aid", n);
}

void Item::setText(const std::string &str) {
	setAttribute("text", str);
}

void Item::setDescription(const std::string &str) {
	setAttribute("desc", str);
}

double Item::getWeight() {
	const ItemType &type = g_items.getItemType(id);
	if (type.isStackable()) {
		return type.weight * subtype;
	}
	return type.weight;
}

bool Item::canHoldText() const {
	return isReadable() || canWriteText();
}

bool Item::canHoldDescription() const {
	return g_items.getItemType(id).allowDistRead;
}

uint8_t Item::getMiniMapColor() const {
	GameSprite* sprite = g_items.getItemType(id).sprite;
	if (sprite) {
		return sprite->getMiniMapColor();
	}
	return 0;
}

GroundBrush* Item::getGroundBrush() const {
	const ItemType &type = g_items.getItemType(id);
	if (type.isGroundTile() && type.brush && type.brush->isGround()) {
		return type.brush->asGround();
	}
	return nullptr;
}

TableBrush* Item::getTableBrush() const {
	const ItemType &type = g_items.getItemType(id);
	if (type.isTable && type.brush && type.brush->isTable()) {
		return type.brush->asTable();
	}
	return nullptr;
}

CarpetBrush* Item::getCarpetBrush() const {
	const ItemType &type = g_items.getItemType(id);
	if (type.isCarpet && type.brush && type.brush->isCarpet()) {
		return type.brush->asCarpet();
	}
	return nullptr;
}

DoorBrush* Item::getDoorBrush() const {
	const ItemType &type = g_items.getItemType(id);
	if (!type.isWall || !type.isBrushDoor || !type.brush || !type.brush->isWall()) {
		return nullptr;
	}

	DoorType door_type = type.brush->asWall()->getDoorTypeFromID(id);
	DoorBrush* door_brush = nullptr;
	// Quite a horrible dependency on a global here, meh.
	switch (door_type) {
		case WALL_DOOR_NORMAL: {
			door_brush = g_gui.normal_door_brush;
			break;
		}
		case WALL_DOOR_LOCKED: {
			door_brush = g_gui.locked_door_brush;
			break;
		}
		case WALL_DOOR_QUEST: {
			door_brush = g_gui.quest_door_brush;
			break;
		}
		case WALL_DOOR_MAGIC: {
			door_brush = g_gui.magic_door_brush;
			break;
		}
		case WALL_WINDOW: {
			door_brush = g_gui.window_door_brush;
			break;
		}
		case WALL_HATCH_WINDOW: {
			door_brush = g_gui.hatch_door_brush;
			break;
		}
		default: {
			break;
		}
	}
	return door_brush;
}

WallBrush* Item::getWallBrush() const {
	const ItemType &type = g_items.getItemType(id);
	if (type.isWall && type.brush && type.brush->isWall()) {
		return type.brush->asWall();
	}
	return nullptr;
}

BorderType Item::getWallAlignment() const {
	const ItemType &type = g_items.getItemType(id);
	if (!type.isWall) {
		return BORDER_NONE;
	}
	return type.border_alignment;
}

BorderType Item::getBorderAlignment() const {
	const ItemType &type = g_items.getItemType(id);
	return type.border_alignment;
}

void Item::animate() {
	const ItemType &type = g_items.getItemType(id);
	GameSprite* sprite = type.sprite;
	if (!sprite || !sprite->animator) {
		return;
	}

	frame = sprite->animator->getFrame();
}

// ============================================================================
// Static conversions

uint8_t Item::liquidSubTypeToSpriteSubType(uint8_t id) {
	switch (id) {
		case LIQUID_WATER:
			return 1;
		case LIQUID_BLOOD:
		case LIQUID_LIFEFLUID:
			return 2;
		case LIQUID_BEER:
		case LIQUID_MUD:
		case LIQUID_OIL:
		case LIQUID_RUM:
		case LIQUID_MEAD:
		case LIQUID_TEA:
			return 3;
		case LIQUID_SLIME:
			return 4;
		case LIQUID_URINE:
		case LIQUID_LEMONADE:
		case LIQUID_FRUIT_JUICE:
			return 5;
		case LIQUID_MILK:
		case LIQUID_COCONUT_MILK:
			return 6;
		case LIQUID_MANAFLUID:
		case LIQUID_WINE:
			return 7;
		case LIQUID_INK:
			return 8;
		case LIQUID_CHOCOLATE:
			return 9;
		case LIQUID_CANDY:
			return 10;
		default:
			return 0;
	}
}

std::string Item::LiquidID2Name(uint8_t id) {
	switch (id) {
		case LIQUID_NONE:
			return "None";
		case LIQUID_WATER:
			return "Water";
		case LIQUID_WINE:
			return "Wine";
		case LIQUID_BEER:
			return "Beer";
		case LIQUID_MUD:
			return "Mud";
		case LIQUID_BLOOD:
			return "Blood";
		case LIQUID_SLIME:
			return "Slime";
		case LIQUID_OIL:
			return "Oil";
		case LIQUID_URINE:
			return "Urine";
		case LIQUID_MILK:
			return "Milk";
		case LIQUID_MANAFLUID:
			return "Manafluid";
		case LIQUID_LIFEFLUID:
			return "Lifefluid";
		case LIQUID_LEMONADE:
			return "Lemonade";
		case LIQUID_RUM:
			return "Rum";
		case LIQUID_FRUIT_JUICE:
			return "Fruit Juice";
		case LIQUID_COCONUT_MILK:
			return "Coconut Milk";
		case LIQUID_MEAD:
			return "Mead";
		case LIQUID_TEA:
			return "Tea";
		case LIQUID_INK:
			return "Ink";
		case LIQUID_CANDY:
			return "Candyfluid";
		case LIQUID_CHOCOLATE:
			return "Chocolate";
		default:
			return "Unknown";
	}
}

uint8_t Item::LiquidName2ID(std::string liquid) {
	to_lower_str(liquid);
	if (liquid == "none") {
		return LIQUID_NONE;
	}
	if (liquid == "water") {
		return LIQUID_WATER;
	}
	if (liquid == "wine") {
		return LIQUID_WINE;
	}
	if (liquid == "beer") {
		return LIQUID_BEER;
	}
	if (liquid == "mud") {
		return LIQUID_MUD;
	}
	if (liquid == "blood") {
		return LIQUID_BLOOD;
	}
	if (liquid == "slime") {
		return LIQUID_SLIME;
	}
	if (liquid == "oil") {
		return LIQUID_OIL;
	}
	if (liquid == "urine") {
		return LIQUID_URINE;
	}
	if (liquid == "milk") {
		return LIQUID_MILK;
	}
	if (liquid == "manafluid") {
		return LIQUID_MANAFLUID;
	}
	if (liquid == "lifefluid") {
		return LIQUID_LIFEFLUID;
	}
	if (liquid == "lemonade") {
		return LIQUID_LEMONADE;
	}
	if (liquid == "rum") {
		return LIQUID_RUM;
	}
	if (liquid == "fruit juice") {
		return LIQUID_FRUIT_JUICE;
	}
	if (liquid == "coconut milk") {
		return LIQUID_COCONUT_MILK;
	}
	if (liquid == "mead") {
		return LIQUID_MEAD;
	}
	if (liquid == "tea") {
		return LIQUID_TEA;
	}
	if (liquid == "ink") {
		return LIQUID_INK;
	}
	if (liquid == "candyfluid") {
		return LIQUID_CANDY;
	}
	if (liquid == "chocolate") {
		return LIQUID_CHOCOLATE;
	}
	return LIQUID_NONE;
}

// ============================================================================
// XML Saving & loading

Item* Item::Create(pugi::xml_node xml) {
	pugi::xml_attribute attribute;

	uint16_t id = 0;
	if ((attribute = xml.attribute("id"))) {
		id = attribute.as_uint();
	}

	uint16_t count = 1;
	if ((attribute = xml.attribute("count")) || (attribute = xml.attribute("subtype"))) {
		count = attribute.as_uint();
	}

	return Create(id, count);
}