Public API Reference

propclass/chars.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_CHARS__
#define __CEL_PF_CHARS__

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

struct iCelEntity;
struct iPcInventory;

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

  virtual bool SetCharacteristic (const char* name, float value) = 0;

  virtual bool SetInheritedCharacteristic (const char* name,
                  float factor, float add) = 0;

  virtual float GetCharacteristic (const char* name) const = 0;

  virtual float GetLocalCharacteristic (const char* name) const = 0;

  virtual float GetInheritedCharacteristic (const char* name) const = 0;

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

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

  virtual bool ClearAll () = 0;

  virtual void AddToInventory (iPcInventory* inv) = 0;

  virtual void RemoveFromInventory (iPcInventory* inv) = 0;

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

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

  virtual void Dump () = 0;
};

#endif // __CEL_PF_CHARS__

---