Public API Reference

iTemplateCharacteristics Struct Reference

This interface is used to represent characteristics for entity templates. More...

#include <propclass/chars.h>

Inheritance diagram for iTemplateCharacteristics:

List of all members.

Public Member Functions

virtual void ClearAll ()=0
 Clear all properties.
virtual void ClearCharacteristic (const char *name)=0
 Clear a characteristic.
virtual csPtr
< iCharacteristicsIterator
GetAllCharacteristics () const =0
 Return all characteristics.
virtual float GetCharacteristic (const char *name) const =0
 Get characteristic property.
virtual bool HasCharacteristic (const char *name) const =0
 Returns true if a property is present.
virtual void SetCharacteristic (const char *name, float value)=0
 Set characteristic property.

Detailed Description

This interface is used to represent characteristics for entity templates.

This is a more limited interface since entity templates can be in multiple inventories at the same time so they have no notion of 'current entity' or 'current inventory'. Also entity templates have no children so there are only local characteristics.

Definition at line 154 of file chars.h.

Member Function Documentation

virtual void iTemplateCharacteristics::ClearAll (  )  [pure virtual]

Clear all properties.

virtual void iTemplateCharacteristics::ClearCharacteristic ( const char *  name  )  [pure virtual]

Clear a characteristic.

virtual csPtr<iCharacteristicsIterator> iTemplateCharacteristics::GetAllCharacteristics (  )  const [pure virtual]

Return all characteristics.

virtual float iTemplateCharacteristics::GetCharacteristic ( const char *  name  )  const [pure virtual]

Get characteristic property.

virtual bool iTemplateCharacteristics::HasCharacteristic ( const char *  name  )  const [pure virtual]

Returns true if a property is present.

virtual void iTemplateCharacteristics::SetCharacteristic ( const char *  name,
float  value 
) [pure virtual]

Set characteristic property.

The documentation for this struct was generated from the following file:

Generated for CEL: Crystal Entity Layer 2.1 by doxygen 1.6.1