activespell.h

Go to the documentation of this file.

/*
 * activespell.h by Kenneth Graunke <kenneth@whitecape.org>
 *
 * Copyright (C) 2009 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 ACTIVESPELL_HEADER
#define ACTIVESPELL_HEADER

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

//=============================================================================
// Project Includes
//=============================================================================
#include "util/psconst.h"

//=============================================================================
// Local Includes
//=============================================================================
#include "buffable.h"


struct iDocumentNode;
class gemActor;

class iCancelAction
{
public:
    virtual ~iCancelAction() { }
    virtual void Cancel() = 0;
};

class ActiveSpell : public CS::Utility::WeakReferenced
{
public:
    ActiveSpell(const csString &name, SPELL_TYPE type, csTicks duration);
    ActiveSpell(const csString &name, SPELL_TYPE type, csTicks duration, const csString &image);
    ~ActiveSpell() { }

    // These are only used by progression scripts, for loading/initializing it.
    void Add(iSpellModifier &mod, const char* fmt, ...);
    void Add(iCancelAction* action, const char* fmt, ...);

    void Register(gemActor* target);
    void Link(ActiveSpell* other);

    void SetCancelOnDeath(bool x)
    {
        cancelOnDeath = x;
    }
    bool CancelOnDeath()
    {
        return cancelOnDeath;
    }

    void MarkAsDamagingHP()
    {
        damagesHP = true;
    }
    bool DamagesHP()
    {
        return damagesHP;
    }

    const csString &Name() const
    {
        return name;
    }
    const csString &Image() const
    {
        return image;
    }
    SPELL_TYPE      Type() const
    {
        return type;
    }
    csTicks Duration() const
    {
        return duration;
    }
    csTicks RegistrationTime() const
    {
        return registrationTime;
    }
    void SetImage(csString imageName);
    csString GetImage();

    bool Cancel();

    bool HasExpired() const;

    csString Persist() const;

protected:
    csString name;            
    csString image;            
    SPELL_TYPE type;          
    csString script;          
    csTicks duration;         
    bool cancelOnDeath;       
    bool damagesHP;           

    gemActor* target;         
    csTicks registrationTime; 

    csArray<iSpellModifier*> modifiers; 
    csPDelArray<iCancelAction> actions; 
};

#endif