CEL

Public API Reference

propclass/chars.h

00001 /*
00002     Crystal Space Entity Layer
00003     Copyright (C) 2001 by Jorrit Tyberghein
00004   
00005     This library is free software; you can redistribute it and/or
00006     modify it under the terms of the GNU Library General Public
00007     License as published by the Free Software Foundation; either
00008     version 2 of the License, or (at your option) any later version.
00009   
00010     This library is distributed in the hope that it will be useful,
00011     but WITHOUT ANY WARRANTY; without even the implied warranty of
00012     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
00013     Library General Public License for more details.
00014   
00015     You should have received a copy of the GNU Library General Public
00016     License along with this library; if not, write to the Free
00017     Software Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
00018 */
00019 
00020 #ifndef __CEL_PF_CHARS__
00021 #define __CEL_PF_CHARS__
00022 
00023 #include "cstypes.h"
00024 #include "csutil/scf.h"
00025 
00026 struct iCelEntity;
00027 struct iPcInventory;
00028 
00032 struct iPcCharacteristics : public virtual iBase
00033 {
00034   SCF_INTERFACE (iPcCharacteristics, 0, 0, 1);
00035 
00041   virtual bool SetCharacteristic (const char* name, float value) = 0;
00042 
00053   virtual bool SetInheritedCharacteristic (const char* name,
00054                   float factor, float add) = 0;
00055 
00060   virtual float GetCharacteristic (const char* name) const = 0;
00061 
00066   virtual float GetLocalCharacteristic (const char* name) const = 0;
00067 
00072   virtual float GetInheritedCharacteristic (const char* name) const = 0;
00073 
00079   virtual bool ClearCharacteristic (const char* name) = 0;
00080 
00084   virtual bool HasCharacteristic (const char* name) const = 0;
00085 
00092   virtual bool ClearAll () = 0;
00093 
00099   virtual void AddToInventory (iPcInventory* inv) = 0;
00100 
00106   virtual void RemoveFromInventory (iPcInventory* inv) = 0;
00107 
00113   virtual void MarkDirty (const char* charName) = 0;
00114 
00120   virtual bool TestConstraints (const char* charName) = 0;
00121 
00125   virtual void Dump () = 0;
00126 };
00127 
00128 #endif // __CEL_PF_CHARS__
00129 

Generated for CEL: Crystal Entity Layer by doxygen 1.4.6