container.h

/* ScummVM - Graphic Adventure Engine
 *
 * ScummVM is the legal property of its developers, whose names
 * are too numerous to list here. Please refer to the COPYRIGHT
 * file distributed with this source distribution.
 *
 * This program 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.
 *
 * This program 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 ULTIMA8_WORLD_CONTAINER_H
#define ULTIMA8_WORLD_CONTAINER_H

#include "common/list.h"
#include "ultima/ultima8/world/item.h"
#include "ultima/ultima8/usecode/intrinsics.h"
#include "ultima/ultima8/misc/classtype.h"

namespace Ultima {
namespace Ultima8 {

class UCList;

class Container : public Item {
    friend class ItemFactory;
    friend class ContainerGump;
    friend class PaperdollGump;
public:
    Container();
    ~Container() override;

    ENABLE_RUNTIME_CLASSTYPE()

    
    virtual bool CanAddItem(Item *item, bool checkwghtvol = false);

    virtual bool addItem(Item *item, bool checkwghtvol = false);

    virtual bool removeItem(Item *item);

    virtual bool moveItemToEnd(Item *item);

    void removeContents();

    void destroyContents();

    void setFlagRecursively(uint32 mask) override;

    void containerSearch(UCList *itemlist, const uint8 *loopscript,
                         uint32 scriptsize, bool recurse) const;

    Item *getFirstItemWithShape(uint16 shapeno, bool recurse);

    void getItemsWithShapeFamily(Common::Array<Item *> &itemlist, uint16 family, bool recurse);

    uint32 getTotalWeight() const override;

    virtual uint32 getCapacity() const;

    virtual uint32 getContentVolume() const;

    ObjId assignObjId() override;

    void clearObjId() override;

    void destroy(bool delnow = false) override;

    Common::String dumpInfo() const override;

    bool loadData(Common::ReadStream *rs, uint32 version);
    void saveData(Common::WriteStream *ws) override;

    INTRINSIC(I_removeContents);
    INTRINSIC(I_destroyContents);

protected:
    Common::List<Item *> _contents;
};

} // End of namespace Ultima8
} // End of namespace Ultima

#endif