path: root/engines/wage/entities.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 2
 * 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, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
 *
 * MIT License:
 *
 * Copyright (c) 2009 Alexei Svitkine, Eugene Sandulenko
 *
 * Permission is hereby granted, free of charge, to any person
 * obtaining a copy of this software and associated documentation
 * files (the "Software"), to deal in the Software without
 * restriction, including without limitation the rights to use,
 * copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the
 * Software is furnished to do so, subject to the following
 * conditions:
 *
 * The above copyright notice and this permission notice shall be
 * included in all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
 * OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
 * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
 * HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
 * WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
 * OTHER DEALINGS IN THE SOFTWARE.
 *
 */

#ifndef WAGE_ENTITIES_H
#define WAGE_ENTITIES_H

namespace Wage {

class Design;
class Obj;
class Scene;
class Script;

class Context {
public:
	enum StatVariables {
	/** The base physical accuracy of the player. */
		PHYS_ACC_BAS = 0,
	/** The current physical accuracy of the player. */
		PHYS_ACC_CUR = 1,
	/** The base physical armor of the player. */
		PHYS_ARM_BAS = 2,
	/** The current physical armor of the player. */
		PHYS_ARM_CUR = 3,
	/** The base physical hit points of the player. */
		PHYS_HIT_BAS = 4,
	/** The current physical hit points of the player. */
		PHYS_HIT_CUR = 5,
	/** The base physical speed of the player. */
		PHYS_SPE_BAS = 6,
	/** The current physical speed of the player. */
		PHYS_SPE_CUR = 7,
	/** The base physical strength of the player. */
		PHYS_STR_BAS = 8,
	/** The current physical strength of the player. */
		PHYS_STR_CUR = 9,
	/** The base spiritual accuracy of the player. */
		SPIR_ACC_BAS = 10,
	/** The current spiritual accuracy of the player. */
		SPIR_ACC_CUR = 11,
	/** The base spiritual armor of the player. */
		SPIR_ARM_BAS = 12,
	/** The current spiritual armor of the player. */
		SPIR_ARM_CUR = 13,
	/** The base spiritual hit points of the player. */
		SPIR_HIT_BAS = 14,
	/** The current spiritual hit points of the player. */
		SPIR_HIT_CUR = 15,
	/** The base spiritual strength of the player. */
		SPIR_STR_BAS = 16,
	/** The current spiritual strength of the player. */
		SPIR_STR_CUR = 17
	};

	int16 _visits; // Number of scenes visited, including repeated visits
	int16 _kills;  // Number of characters killed
	int16 _experience;
	int16 _userVariables[26 * 9];
	int16 _statVariables[18];
};

class Designed {
public:
	Designed() : _design(NULL), _designBounds(NULL) {}

	String _name;
	Design *_design;
	Common::Rect *_designBounds;

	Common::Rect *getDesignBounds() { 
		return _designBounds == NULL ? NULL : new Common::Rect(*_designBounds);
	}

	void setDesignBounds(Common::Rect *bounds);

	String toString() { return _name; }
};

class Chr : public Designed {
public:
	enum ChrDestination {
		RETURN_TO_STORAGE = 0,
		RETURN_TO_RANDOM_SCENE = 1,
		RETURN_TO_INITIAL_SCENE = 2
	};

	enum ChrPart {
		HEAD = 0,
		CHEST = 1,
		SIDE = 2
	};

	enum ChrArmorType {
		HEAD_ARMOR = 0,
		BODY_ARMOR = 1,
		SHIELD_ARMOR = 2
	};
	
	Chr(String name, Common::SeekableReadStream *data);

	int _index;
	String _initialScene;
	int _gender;
	bool _nameProperNoun;
	bool _playerCharacter;
	int _maximumCarriedObjects;
	int _returnTo;
	
	int _physicalStrength;
	int _physicalHp;
	int _naturalArmor;
	int _physicalAccuracy;
	int _spiritualStength;
	int _spiritialHp;
	int _resistanceToMagic;
	int _spiritualAccuracy;
	int _runningSpeed;
	int _rejectsOffers;
	int _followsOpponent;
	
	String _initialSound;
	String _scoresHitSound;
	String _receivesHitSound;
	String _dyingSound;

	String _nativeWeapon1;
	String _operativeVerb1;
	int _weaponDamage1;
	String _weaponSound1;
	
	String _nativeWeapon2;
	String _operativeVerb2;
	int _weaponDamage2;
	String _weaponSound2;
	
	int _winningWeapons;
	int _winningMagic;
	int _winningRun;
	int _winningOffer;
	int _losingWeapons;
	int _losingMagic;
	int _losingRun;
	int _losingOffer;
	
	String _initialComment;
	String _scoresHitComment;
	String _receivesHitComment;
	String _makesOfferComment;
	String _rejectsOfferComment;
	String _acceptsOfferComment;
	String _dyingWords;

	Scene *_currentScene;
	Common::List<Obj> _inventory;

	Obj *_armor[3];

	Context _context;

public:
#if 0
	Weapon[] getWeapons() {
		ArrayList<Weapon> weapons = new ArrayList<Weapon>();
		if (hasNativeWeapon1()) {
			weapons.add(new Weapon() {
				String getName() {
					return _getNativeWeapon1();
				}
				String getOperativeVerb() {
					return _getOperativeVerb1();
				}
				int getType() {
					return _Obj.REGULAR_WEAPON;
				}
				int getAccuracy() {
					return _0;
				}
				int getDamage() {
					return _getWeaponDamage1();
				}
				String getSound() {
					return _getWeaponSound1();
				}
				void decrementNumberOfUses() {}
			});
		}
		if (hasNativeWeapon2()) {
			weapons.add(new Weapon() {
				String getName() {
					return _getNativeWeapon2();
				}
				String getOperativeVerb() {
					return _getOperativeVerb2();
				}
				int getType() {
					return _Obj.REGULAR_WEAPON;
				}
				int getAccuracy() {
					return _0;
				}
				int getDamage() {
					return _getWeaponDamage2();
				}
				String getSound() {
					return _getWeaponSound2();
				}
				void decrementNumberOfUses() {}
			});
		}
		for (Obj o : getInventory()) {
			switch (o.getType()) {
				case Obj.REGULAR_WEAPON:
				case Obj.THROW_WEAPON:
				case Obj.MAGICAL_OBJECT:
					weapons.add(o);
			}
		}
		return _(Weapon[]) weapons.toArray(new Weapon[0]);
	}
#endif

	bool hasNativeWeapon1() {
		return (_nativeWeapon1.size() > 0 && _operativeVerb1.size() > 0);
	}

	bool hasNativeWeapon2() {
		return (_nativeWeapon2.size() > 0 && _operativeVerb2.size() > 0);
	}
};

class Weapon {
public:
	uint _accuracy;
	String _operativeVerb;
	int _type;
	int _damage;
	String _sound;
	int _numberOfUses;

	Weapon() : _numberOfUses(0) {}

	void decrementNumberOfUses() { 
		if (_numberOfUses != -1) {
			_numberOfUses--;
		}
	}
};

class Obj : public Weapon, public Designed {
public:
	Obj() : _currentOwner(NULL), _currentScene(NULL) {}
	Obj(String name, Common::SeekableReadStream *data);

	enum ObjectTypes {
		REGULAR_WEAPON = 1,
		THROW_WEAPON = 2,
		MAGICAL_OBJECT = 3,
		HELMET = 4,
		SHIELD = 5,
		CHEST_ARMOR = 6,
		SPIRITUAL_ARMOR = 7,
		MOBILE_OBJECT = 8,
		IMMOBILE_OBJECT = 9
	};

	enum AttackTypes {
		CAUSES_PHYSICAL_DAMAGE = 0,
		CAUSES_SPIRITUAL_DAMAGE = 1,
		CAUSES_PHYSICAL_AND_SPIRITUAL_DAMAGE = 2,
		HEALS_PHYSICAL_DAMAGE = 3,
		HEALS_SPIRITUAL_DAMAGE = 4,
		HEALS_PHYSICAL_AND_SPIRITUAL_DAMAGE = 5,
		FREEZES_OPPONENT = 6
	};

public:
	int _index;
	bool _namePlural;
	uint _value;
	int _attackType;
	int _numberOfUses;
	bool _returnToRandomScene;
	String _sceneOrOwner;
	String _clickMessage;
	String _failureMessage;
	String _useMessage;
	
	Scene *_currentScene;
	Chr *_currentOwner;

public:
	void setCurrentOwner(Chr *currentOwner) {
		_currentOwner = currentOwner;
		if (currentOwner != NULL)
			_currentScene = NULL;
	}

	void setCurrentScene(Scene *currentScene) {
		_currentScene = currentScene;
		if (currentScene != NULL)
			_currentOwner = NULL;
	}

};

class Scene : public Designed {
public:
	enum Directions {
		NORTH = 0,
		SOUTH = 1,
		EAST = 2,
		WEST = 3
	};
	
	enum SceneTypes {
		PERIODIC = 0,
		RANDOM = 1
	};

	Script *_script;
	String _text;
	Common::Rect *_textBounds;
	int _fontSize;
	int _fontType; // 3 => Geneva, 22 => Courier, param to TextFont() function
	bool _blocked[4];
	String _messages[4];
	int _soundFrequency; // times a minute, max 3600
	int _soundType;
	String _soundName;
	int _worldX;
	int _worldY;
	
	Common::List<Obj> _objs;
	Common::List<Chr> _chrs;

	Scene() {}
	Scene(String name, Common::SeekableReadStream *data);

	Common::Rect *getTextBounds() {
		return _textBounds == NULL ? NULL : new Common::Rect(*_textBounds);
	}

#if 0
	String getFontName() { 
		String[] fonts = {
			"Chicago",	// system font
			"Geneva",	// application font
			"New York",
			"Geneva",

			"Monaco",
			"Venice",
			"London",
			"Athens",
	
			"San Francisco",
			"Toronto",
			"Cairo",
			"Los Angeles", // 12

			null, null, null, null, null, null, null, // not in Inside Macintosh

			"Times", // 20
			"Helvetica",
			"Courier",
			"Symbol",
			"Taliesin" // mobile?
		};
		/*
mappings found on some forums:
systemFont(0):System(Swiss)
times(20):Times New Roman(Roman)
helvetica(21):Arial(Modern)
courier(22):Courier New(Modern)
symbol(23):Symbol(Decorative)
applFont(1):Arial(Swiss)
newYork(2):Times New Roman(Roman)
geneva(3):Arial(Swiss)
monaco(4):Courier New(Modern)
venice(5):Times New Roman(Roman)
london(6):Times New Roman(Roman)
athens(7):Times New Roman(Roman)
sanFran(8):Times New Roman(Roman)
toronto(9):Times New Roman(Roman)
cairo(11):Wingdings(Decorative)
losAngeles(12):Times New Roman(Roman)
taliesin(24):Wingdings(Decorative)
		 */
		if (fontType >= 0 && fontType < fonts.length && fonts[fontType] != null) {
			return _fonts[fontType];
		}
		return _"Unknown";
	}
#endif
};

class Sound {
public:
  Sound(String name, Common::SeekableReadStream *data) : _name(name), _data(data) {}
	~Sound() { }

	String _name;
	Common::SeekableReadStream *_data;
};

} // End of namespace Wage
 
#endif