room_flags.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 TITANIC_ROOM_FLAGS_H
#define TITANIC_ROOM_FLAGS_H

#include "titanic/support/string.h"
#include "titanic/game_location.h"

namespace Titanic {

class CRoomFlags {
private:
    uint _data;
private:
    int getConditionally() const;

    bool isTransportRoom() const;

    int getRoomCategory() const;

    int getRoomArea() const;

    void setElevatorBits(uint val);

    void setFloorBits(uint val);

    uint decodeFloorBits(uint bits) const;

    static bool is2To19(uint v) { return v >= 2 && v <= 19; }
    static bool is20To27(uint v) { return v >= 20 && v <= 27; }
    static bool is28To38(uint v) { return v >= 28 && v <= 38; }
public:
    static bool compareLocation(uint flags1, uint flags2);

    static bool compareClassElevator(uint flags1, uint flags2);

    static bool isTitania(uint flags1, uint flags2);
public:
    CRoomFlags() : _data(0) {}
    CRoomFlags(uint data) : _data(data) {}
    operator uint() { return _data; }

    void set(uint data) { _data = data; }

    uint get() const { return _data; }

    static uint getSpecialRoomFlags(const CString &roomName);

    bool isSuccUBusRoomFlags() const;

    CString getRoomDesc() const;

    uint getElevatorBits() const;

    void setElevatorNum(uint val) { setElevatorBits(val - 1); }

    uint getElevatorNum() const { return getElevatorBits() + 1; }

    uint getPassengerClassBits() const;

    void setPassengerClassBits(uint val);

    PassengerClass getPassengerClassNum() const {
        return (PassengerClass)getPassengerClassBits();
    }

    CString getPassengerClassDesc() const;

    uint getFloorBits() const;

    void setFloorNum(uint floorNum);

    uint getFloorNum() const;

    void setRoomBits(uint roomBits);

    uint getRoomBits() const;

    uint getRoomNum() const { return getRoomBits(); }

    CString getElevatorDesc() const;

    CString getFloorDesc() const;

    CString getRoomNumDesc() const;

    bool getBit0() const;

    void changeClass(PassengerClass newClassNum);

    void setRandomLocation(PassengerClass classNum, bool flag);

    PassengerClass getSuccUBusClass(const CString &roomName) const;

    CString getSuccUBusRoomName() const;

    static PassengerClass whatPassengerClass(int floorNum);

    bool isSuccUBusDest() const { return getConditionally() != 5; }

    bool isFirstClassSuite() const {
        return _data == 0x59706;
    }
};

} // End of namespace Titanic

#endif /* TITANIC_ROOM_FLAGS_H */