psspell.h

Go to the documentation of this file.

/*
 * psspell.h
 *
 * Copyright (C) 2003 Atomic Blue (info@planeshift.it, http://www.atomicblue.org)
 *
 *
 * 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 (version 2 of the License)
 * 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., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
 *
 */

#ifndef __PSSPELL_H__
#define __PSSPELL_H__

//=============================================================================
// Crystal Space Includes
//=============================================================================
#include <csutil/csstring.h>

//=============================================================================
// Project Includes
//=============================================================================
#include <idal.h>
#include "util/scriptvar.h"
#include "util/gameevent.h"

//=============================================================================
// Local Includes
//=============================================================================
#include "psskills.h"
#include "psitemstats.h"
#include "deleteobjcallback.h"

class Client;
class gemObject;
class gemActor;
class ProgressionScript;
class MathExpression;

struct psWay
{
    unsigned int     id;
    PSSKILL          skill;    // for example, Crystal Way
    PSSKILL                      related_stat_skill; // for example, Charisma
    csString         name;
};

struct psSpellCost
{
    float mana;
    float stamina;
};

typedef csArray <psItemStats*> glyphList_t;


class psSpell : public iScriptableVar
{
public:
    psSpell();
    ~psSpell();

    bool Load(iResultRow &row);
    int GetID() const
    {
        return id;
    }
    const csString &GetName() const
    {
        return name;
    }
    const csString &GetImage() const
    {
        return image;
    }
    const csString &GetDescription() const
    {
        return description;
    }
    psSpellCost ManaCost(psCharacter* caster, float kFactor) const;
    float PowerLevel(psCharacter* caster, float kFactor) const;
    float ChanceOfCastSuccess(psCharacter* caster, float kFactor) const;
    float ChanceOfResearchSuccess(psCharacter* researcher);

    bool MatchGlyphs(const csArray<psItemStats*> &glyphs);

    bool CanCast(gemActor* caster, float kFactor, csString &reason, bool canCastAllSpells);

    void Cast(gemActor* caster, float kFactor, Client* client) const;

    /*
     * @param castingDuration The time it was waited before the spell could affect targets.
     */
    void Affect(gemActor* caster, gemObject* target, float range, float kFactor, float power, Client* client, csTicks castingDuration) const;

    int GetRealm()
    {
        return realm;
    }
    psWay* GetWay()
    {
        return way;
    }
    csArray<psItemStats*> &GetGlyphList()
    {
        return glyphList;
    }

    double GetProperty(MathEnvironment* env, const char* ptr);
    double CalcFunction(MathEnvironment* env, const char* functionName, const double* params);
    const char* ToString()
    {
        return name.GetDataSafe();
    }

protected:
    bool AffectTarget(gemActor* caster, gemObject* origTarget, gemObject* target, float power, Client* client) const;

    int id;
    csString name;
    psWay* way;
    int realm;
    csString image;
    csString description;
    csString castingEffect;
    bool offensive;

    float maxPower;

    int targetTypes;

    MathExpression* castDuration;
    MathExpression* range;
    MathExpression* aoeRadius;
    MathExpression* aoeAngle;
    ProgressionScript* outcome;

    csArray<psItemStats*> glyphList;

    csString npcSpellCategory;

    uint32_t npcSpellCategoryID;

    float    npcSpellRelativePower;
};

//-----------------------------------------------------------------------------

class psSpellCastGameEvent : public psGameEvent, public iDeleteObjectCallback
{
public:
    gemActor*      caster; 
    gemObject*     target; 
    Client*        client; 
    const psSpell* spell;  

    float max_range;
    float kFactor;
    float powerLevel;
    csTicks duration;

    psSpellCastGameEvent(const psSpell* spell,
                         gemActor* caster,
                         gemObject* target,
                         csTicks castingDuration,
                         float max_range,
                         float kFactor,
                         float power,
                         Client* client);

    ~psSpellCastGameEvent();

    void Interrupt();

    virtual void Trigger();  // Abstract event processing function
    virtual void DeleteObjectCallback(iDeleteNotificationObject* object);
};

#endif