tools/rewards.h

/*
    Crystal Space Entity Layer
    Copyright (C) 2004-2006 by Jorrit Tyberghein
  
    This library is free software; you can redistribute it and/or
    modify it under the terms of the GNU Library General Public
    License as published by the Free Software Foundation; either
    version 2 of the License, or (at your option) any later version.
  
    This library 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
    Library General Public License for more details.
  
    You should have received a copy of the GNU Library General Public
    License along with this library; if not, write to the Free
    Software Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
*/

#ifndef __CEL_REWARDS__
#define __CEL_REWARDS__

#include "behaviourlayer/behave.h"
#include "iutil/document.h"
#include "tools/parameters.h"
#include "tools/sequences.h"

//-------------------------------------------------------------------------
// Rewards
//-------------------------------------------------------------------------

struct iReward : public virtual iBase
{
  SCF_INTERFACE (iReward, 0, 0, 1);
  virtual void Reward (iCelParameterBlock* params) = 0;
};

struct iRewardFactory : public virtual iBase
{
  SCF_INTERFACE (iRewardFactory, 0, 0, 1);

  virtual csPtr<iReward> CreateReward (const celParams& params) = 0;

  virtual bool Load (iDocumentNode* node) = 0;
};

struct iRewardType : public virtual iBase
{
  SCF_INTERFACE (iRewardType, 0, 0, 1);

  virtual const char* GetName () const = 0;
  
  virtual csPtr<iRewardFactory> CreateRewardFactory () = 0;
};


//-------------------------------------------------------------------------
// Specific reward implementations.
//-------------------------------------------------------------------------

struct iActionRewardFactory : public virtual iBase
{
  SCF_INTERFACE (iActionRewardFactory, 0, 0, 1);

  virtual void SetEntityParameter (const char* entity) = 0;

  virtual void SetClassParameter (const char* ent_class) = 0;

  virtual void SetIDParameter (const char* id) = 0;

  virtual void SetPropertyClassParameter (const char* propertyclass) = 0;

  virtual void SetTagParameter (const char* tag) = 0;

  virtual void AddParameter (celDataType type, csStringID id,
      const char* name, const char* value) = 0;
};

struct iChangePropertyRewardFactory : public virtual iBase
{
  SCF_INTERFACE (iChangePropertyRewardFactory, 0, 0, 1);

  virtual void SetEntityParameter (const char* entity) = 0;

  virtual void SetClassParameter (const char* ent_class) = 0;

  virtual void SetPCParameter (const char* pc, const char* tag) = 0;

  virtual void SetPropertyParameter (const char* prop) = 0;

  virtual void SetStringParameter (const char* pstring) = 0;

  virtual void SetLongParameter (const char* plong) = 0;

  virtual void SetFloatParameter (const char* pfloat) = 0;

  virtual void SetBoolParameter (const char* pbool) = 0;

  virtual void SetDiffParameter (const char* pdiff) = 0;

  virtual void SetToggle () = 0;
};

struct iCreateEntityRewardFactory : public virtual iBase
{
  SCF_INTERFACE (iCreateEntityRewardFactory, 0, 0, 1);

  virtual void SetEntityTemplateParameter (const char* entity_tpl) = 0;

  virtual void SetNameParameter (const char* name) = 0;

  virtual void AddParameter (const char* name, const char* value) = 0;
};

struct iDestroyEntityRewardFactory : public virtual iBase
{
  SCF_INTERFACE (iDestroyEntityRewardFactory, 0, 0, 1);

  virtual void SetEntityParameter (const char* entity) = 0;

  virtual void SetClassParameter (const char* ent_class) = 0;


};

struct iDebugPrintRewardFactory : public virtual iBase
{
  SCF_INTERFACE (iDebugPrintRewardFactory, 0, 0, 1);

  virtual void SetMessageParameter (const char* msg) = 0;
};

struct iInventoryRewardFactory : public virtual iBase
{
  SCF_INTERFACE (iInventoryRewardFactory, 0, 0, 1);

  virtual void SetEntityParameter (const char* entity, const char* tag = 0) = 0;

  virtual void SetChildEntityParameter (const char* entity,
        const char* tag = 0) = 0;
};

struct iMessageRewardFactory : public virtual iBase
{
  SCF_INTERFACE (iMessageRewardFactory, 0, 0, 1);

  virtual void SetEntityParameter (const char* entity) = 0;

  virtual void SetClassParameter (const char* ent_class) = 0;

  virtual void SetIDParameter (const char* id) = 0;

  virtual void AddParameter (celDataType type, csStringID id,
      const char* name, const char* value) = 0;
};

struct iCsSequenceRewardFactory : public virtual iBase
{
  SCF_INTERFACE (iCsSequenceRewardFactory, 0, 0, 1);

  virtual void SetSequenceParameter (const char* sequence) = 0;

  virtual void SetDelayParameter (const char* delay) = 0;
};

struct iSequenceRewardFactory : public virtual iBase
{
  SCF_INTERFACE (iSequenceRewardFactory, 0, 0, 1);

  virtual void SetEntityParameter (const char* entity, const char* tag = 0) = 0;

  virtual void SetTagParameter (const char* tag_par) = 0;

  virtual void SetClassParameter (const char* ent_class) = 0;

  virtual void SetSequenceParameter (const char* sequence) = 0;

  virtual void SetSequence (iCelSequence* sequence) = 0;

  virtual void SetDelayParameter (const char* delay) = 0;
};

struct iSequenceFinishRewardFactory : public virtual iBase
{
  SCF_INTERFACE (iSequenceFinishRewardFactory, 0, 0, 1);

  virtual void SetEntityParameter (const char* entity, const char* tag = 0) = 0;

  virtual void SetTagParameter (const char* tag_par) = 0;

  virtual void SetClassParameter (const char* ent_class) = 0;

  virtual void SetSequenceParameter (const char* sequence) = 0;

  virtual void SetSequence (iCelSequence* sequence) = 0;
};

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

#define CEL_DECLARE_REWARDTYPE(name,id)                                 \
class cel##name##RewardType : public scfImplementation2<                \
                cel##name##RewardType,iRewardType, iComponent>                  \
{                                                                       \
public:                                                                 \
  iObjectRegistry* object_reg;                                          \
  csWeakRef<iCelPlLayer> pl;                                            \
  cel##name##RewardType (iBase* parent);                        \
  virtual ~cel##name##RewardType () { }                                 \
  virtual bool Initialize (iObjectRegistry*);                   \
  virtual const char* GetName () const { return id; }                   \
  virtual csPtr<iRewardFactory> CreateRewardFactory ();         \
};

#define CEL_IMPLEMENT_REWARDTYPE(name)                                  \
cel##name##RewardType::cel##name##RewardType (                          \
        iBase* parent) : scfImplementationType (this, parent),  \
        object_reg(0)                                                                                   \
{                                                                                                                       \
}                                                                                                                       \
bool cel##name##RewardType::Initialize (                                        \
        iObjectRegistry* object_reg)                                                    \
{                                                                       \
  cel##name##RewardType::object_reg = object_reg;                       \
  pl = csQueryRegistry<iCelPlLayer> (object_reg);                       \
  return true;                                                                                          \
}                                                                       \
csPtr<iRewardFactory> cel##name##RewardType::CreateRewardFactory ()\
{                                                                       \
  cel##name##RewardFactory* fact = new                                  \
        cel##name##RewardFactory (this);                                \
  return fact;                                                          \
}

#endif // __CEL_REWARDS__