Public API Reference

propclass/inv.h

/*
    Crystal Space Entity Layer
    Copyright (C) 2001 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_PF_INV__
#define __CEL_PF_INV__

#include "cstypes.h"
#include "csutil/scf.h"
#include "behaviourlayer/behave.h"

struct iCelEntity;
struct iPcInventory;

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

  virtual void AddChild (iPcInventory* inventory, iCelEntity* entity) = 0;

  virtual void RemoveChild (iPcInventory* inventory, iCelEntity* entity) = 0;
};


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

  virtual iCelEntity* GetEntity (iCelParameterBlock* params) = 0;

  virtual bool AddEntity (iCelEntity* entity, iCelParameterBlock* params) = 0;

  virtual bool RemoveEntity (iCelEntity* entity) = 0;

  virtual int GetCount () = 0;

  virtual void RemoveAll () = 0;

  virtual bool IsEmpty () = 0;
};

struct iCelInventorySpace : public virtual iBase
{
  SCF_INTERFACE (iCelInventorySpace, 0, 0, 1);
  
  virtual int GetSpaceTotal () const = 0;
  
  virtual int GetSpaceLeft () const = 0;
  
  // Return how much space is taken.
  virtual int GetSpaceTaken () const = 0;
  
  virtual bool AddEntity (iCelEntity* entity) = 0;
  virtual bool RemoveEntity (iCelEntity* entity) = 0;
  
  virtual bool AddEntity (iCelEntity* entity, iCelParameterBlock* params) = 0;
  virtual bool RemoveEntity (iCelParameterBlock* params) = 0;
  
  //. Get rid of all entities inside space.
  virtual void RemoveAll () = 0;
  
  virtual iCelInventorySpaceSlot* GetSlot (iCelParameterBlock* params) = 0;
  
  virtual iCelEntity* GetEntity (iCelParameterBlock* params) = 0;
};


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

  virtual void AddInventoryListener (iPcInventoryListener* listener) = 0;
  virtual void RemoveInventoryListener (iPcInventoryListener* listener) = 0;

  virtual bool AddEntity (iCelEntity* entity) = 0;

  virtual bool AddEntity (iCelEntity* entity, iCelParameterBlock* params) = 0;

  virtual bool RemoveEntity (iCelEntity* entity) = 0;
  virtual bool RemoveEntity (iCelParameterBlock* params) = 0;

  virtual bool RemoveAll () = 0;

  virtual size_t GetEntityCount () const = 0;

  virtual iCelEntity* GetEntity (size_t idx) const = 0;

  virtual bool In (iCelEntity* entity) const = 0;

  virtual bool In (const char* name) const = 0;

  virtual size_t FindEntity (iCelEntity* entity) const = 0;

  virtual size_t FindEntity (const char* name) const = 0;

  virtual iCelEntity* GetEntitySlot (iCelParameterBlock* params) const = 0;

  virtual bool SetStrictCharacteristics (const char* charName, bool strict) = 0;

  virtual bool HasStrictCharacteristics (const char* charName) const = 0;

  virtual bool SetConstraints (const char* charName,
        float minValue, float maxValue, float totalMaxValue) = 0;

  virtual bool GetConstraints (const char* charName,
        float& minValue, float& maxValue, float& totalMaxValue) const = 0;

  virtual void RemoveConstraints (const char* charName) = 0;

  virtual void RemoveAllConstraints () = 0;

  virtual float GetCurrentCharacteristic (const char* charName) const = 0;
  
  virtual void MarkDirty (const char* charName) = 0;

  virtual bool TestConstraints (const char* charName) = 0;

  virtual void Dump () = 0;
  
  virtual void SetSpace (iCelInventorySpace* space) = 0;

  virtual iCelInventorySpace* GetSpace () = 0;
};

#endif // __CEL_PF_INV__

---