scripting.h

Go to the documentation of this file.

/*
 * scripting.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 SCRIPTING_HEADER
#define SCRIPTING_HEADER

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

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

// forward declarations
class MathEnvironment;
class MathExpression;
class ActiveSpell;
class EntityManager;
class CacheManager;

enum SCRIPT_TRIGGER
{
    ATTACK,     
    DEFENSE,    
    MOVE,       
    NEARLYDEAD  
};

class ImperativeOp; // forward declaration of private script operation

class ProgressionScript
{
public:
    ~ProgressionScript();
    static ProgressionScript* Create(EntityManager* entitymanager,CacheManager* cachemanager, const char* name, const char* script);
    static ProgressionScript* Create(EntityManager* entitymanager,CacheManager* cachemanager, const char* name, iDocumentNode* top);

    const csString &GetName()
    {
        return name;
    }
    void Run(MathEnvironment* env);

protected:
    ProgressionScript(const char* name) : name(name) { }
    
    csString name;                      
    csArray<ImperativeOp*> ops;         
};

class AppliedOp; // forward declaration of private script operation

class ApplicativeScript
{
public:
    ~ApplicativeScript();
    static ApplicativeScript* Create(EntityManager* entitymanager, CacheManager* cachemanager, const char* script);
    static ApplicativeScript* Create(EntityManager* entitymanager, CacheManager* cachemanager, iDocumentNode* top);
    static ApplicativeScript* Create(EntityManager* entitymanager, CacheManager* cachemanager, iDocumentNode* top, SPELL_TYPE type, const char* name, const char* duration);

    ActiveSpell* Apply(MathEnvironment* env, bool registerCancelEvent = true);
    /***
     * retrieve the description of the Applicativescripts commands
     * @return csString containing a description of the scripts effect
     */
    const csString &GetDescription(MathEnvironment* env);

    void SetImage( csString tImage ) { image=tImage; }

protected:
    ApplicativeScript();        

    SPELL_TYPE type;            
    csString aim;               
    csString name;              
    csString description;       
    csString image;             
    MathExpression* duration;   
    csPDelArray<AppliedOp> ops; 
};

#if 0
// Eventually, we'll want to be able to target items in the inventory,
// and specific points on the ground, as well as entities in the world.
class Target
{
public:
    Target(psItem*  item)   : type(TARGET_PSITEM),    item(item) { }
    Target(gemObject*  obj) : type(TARGET_GEMOBJECT), obj(obj)   { }
    //Target(Location loc) : loc(loc), type(TARGET_LOCATION) { }

protected:
    enum Type
    {
        TARGET_GEMOBJECT,
        TARGET_PSITEM,
        TARGET_LOCATION
    };
    Type type;

    union
    {
        psItem*    item;
        gemObject* obj;
        //Location loc;
    };
};
#endif

#endif