scummvm/engines/saga2/spellbuk.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.
 *
 *
 * Based on the original sources
 *   Faery Tale II -- The Halls of the Dead
 *   (c) 1993-1996 The Wyrmkeep Entertainment Co.
 */

#ifndef SAGA2_SPELLBUK_H
#define SAGA2_SPELLBUK_H

namespace Saga2 {

struct ResourceSpellEffect;
struct ResourceSpellItem;

class SpellTarget;
class ProtoEffect;

// Mana IDs as spells see them

enum SpellManaID {
	sManaIDRed      = 0,
	sManaIDOrange   = 1,
	sManaIDYellow   = 2,
	sManaIDGreen    = 3,
	sManaIDBlue     = 4,
	sManaIDViolet   = 5,
	sManaIDSkill    = 6         // skills are here for convenience
};

//-------------------------------------------------------------------
// targeting bits
//   These two types are used to determine :
//     The types of screen object a spell can be used on
//     The type of target the spell will eventually be applied to
//   respectively.

//-------------------------------------------------------------------
// legal target selections
enum SpellTargetingTypes {
	spellTargNone       = 0,
	spellTargWorld      = 1 << 0, // instant spell
	spellTargLocation   = 1 << 1, // cast at any location on map
	spellTargTAG        = 1 << 2, // cast at tileactivity inst.
	spellTargObject     = 1 << 3, // cast at objects
	spellTargActor      = 1 << 4,
	spellTargCaster     = 1 << 5
};

//-------------------------------------------------------------------
// target type the spell uses when implemented
enum SpellApplicationTypes {
	spellApplyNone      = spellTargNone,
	spellApplyWorld     = spellTargWorld,
	spellApplyLocation  = spellTargLocation,
	spellApplyTAG       = spellTargTAG,
	spellApplyObject    = spellTargObject,
	spellApplyActor     = spellTargObject,
	spellApplyTracking  = 1 << 6  // track object targets
};


//-------------------------------------------------------------------
// effect templates
//   These are the shapes of the visible effects of spells

enum effectAreas {
	eAreaInvisible = 0,
	eAreaAura,
	eAreaProjectile,
	eAreaExchange,
	eAreaBolt,
	eAreaCone,
	eAreaBall,
	eAreaSquare,
	eAreaWave,
	eAreaStorm,
	eAreaMissle,
	eAreaGlow,
	eAreaBeam,
	eAreaWall
};



//-------------------------------------------------------------------
// SpellStuff
//   The master spell list is an array of these records.
//   Unfortunately this class and the SpellDisplayProto could have been
//   implemented as one larger structure, but the evolved from separate
//   parts of the code

class SpellStuff {
	SpellID             master;             // index in array
	SkillProto          *prototype;         // ponts back to object prototype
	SpellID             display;            // currently same as master
	SpellTargetingTypes targetableTypes;    // valid targeting types
	SpellApplicationTypes targetTypes;      // the targeting type to implement
	ProtoEffect         *effects;           // the effects of this spell
	SpellTarget         *targets;           // transient target list
	SpellManaID         manaType;           // color mana used
	int8                manaUse;            // mana points used
	effectAreas         shape;
	int32               size;
	int32               range;
	int16               sound;

public:

	SpellStuff();

	void setProto(SkillProto *p)           {
		prototype = p;
	}
	SkillProto *getProto(void)             {
		return prototype;
	}

	void setupFromResource(ResourceSpellItem *rsi);

	void addEffect(ProtoEffect *pe);
	void addEffect(ResourceSpellEffect *rse);
	void killEffects(void);

	bool canTarget(SpellTargetingTypes t)  {
		return targetableTypes & t;
	}
	bool shouldTarget(SpellApplicationTypes t) {
		return targetTypes & t;
	}

	bool untargetable(void)    {
		return (targetableTypes == spellTargNone);
	}
	bool untargeted(void)      {
		return false;    //(targetableTypes == spellTargWorld ) ||
	}
	//(targetableTypes == spellTargCaster ) ||
	//(targetableTypes == targetableTypes &
	//                   (spellTargWorld | spellTargCaster)); }

	void implement(GameObject *enactor, SpellTarget *target);
	void implement(GameObject *enactor, GameObject *target);
	void implement(GameObject *enactor, ActiveItem *target);
	void implement(GameObject *enactor, Location   target);

	SpellID getDisplayID(void)            {
		return display;
	}
	SpellManaID getManaType(void)           {
		return manaType;
	}
	void setManaType(SpellManaID smid)    {
		manaType = smid;
	}
	int8 getManaAmt(void)                   {
		return manaUse;
	}
	int32 getRange(void)                   {
		return range;
	}

	void buildTargetList(GameObject *, SpellTarget &);
	void addTarget(SpellTarget *trg);
	void removeTargetList();

	void apply(ProtoEffect *pe, GameObject *target);
	void apply(ProtoEffect *pe, ActiveItem *target);

	void playSound(GameObject *go);
	void show(GameObject *, SpellTarget &);
	bool safe(void);
	bool isOffensive(void);
};

/* ===================================================================== *
   Prototypes
 * ===================================================================== */

//-------------------------------------------------------------------
// At this point these are the effects requiring special handling

SPECIALSPELL(DeathSpell);
SPECIALSPELL(DispellProtections);
SPECIALSPELL(DispellCurses);
SPECIALSPELL(Resurrect);
SPECIALSPELL(CreateWallOfFire);
SPECIALSPELL(CreateFireWisp);
SPECIALSPELL(CreateWindWisp);
SPECIALSPELL(Timequake);
SPECIALSPELL(TeleportToShrine);
SPECIALSPELL(TeleportToLocation);
SPECIALSPELL(Rejoin);
SPECIALSPELL(CreateRingOfForce);
SPECIALSPELL(DispellPoison);
SPECIALSPELL(CreateWraith);
SPECIALSPELL(SagaSpellCall);
SPECIALSPELL(CreateWWisp);
SPECIALSPELL(CreateFWisp);
SPECIALSPELL(CreateWraith);
SPECIALSPELL(CreateFood);

} // End of namespace Saga2

#endif  //SPELLBUK_H