iPcProperties Struct Reference
This is a general property class. More...
#include <propclass/prop.h>
Public Member Functions | |
virtual void | AddPropertyListener (iPcPropertyListener *listener)=0 |
Add a property listener. | |
virtual void | Clear ()=0 |
Clear all properties. | |
virtual void | ClearProperty (size_t index)=0 |
Clear a property. | |
virtual void | Dump ()=0 |
Debug dump information. | |
virtual bool | GetPropertyBool (size_t index) const =0 |
Get property as bool. | |
virtual bool | GetPropertyColor (size_t index, csColor &v) const =0 |
Get property as bool. | |
virtual size_t | GetPropertyCount () const =0 |
Get the number of properties defined in this property class. | |
virtual iCelEntity * | GetPropertyEntity (size_t index) const =0 |
Get property as entity. | |
virtual float | GetPropertyFloat (size_t index) const =0 |
Get property as float. | |
virtual size_t | GetPropertyIndex (const char *name)=0 |
Get the specified property index for a named property. | |
virtual long | GetPropertyLong (size_t index) const =0 |
Get property as long. | |
virtual const char * | GetPropertyName (size_t idx) const =0 |
Get the specified property name. | |
virtual iCelPropertyClass * | GetPropertyPClass (size_t index) const =0 |
Get property as property class. | |
virtual const char * | GetPropertyString (size_t index) const =0 |
Get property as string. | |
virtual celDataType | GetPropertyType (size_t index) const =0 |
Get the type of a property. | |
virtual bool | GetPropertyVector (size_t index, csVector3 &v) const =0 |
Get property as bool. | |
virtual bool | GetPropertyVector (size_t index, csVector2 &v) const =0 |
Get property as bool. | |
virtual void | RemovePropertyListener (iPcPropertyListener *listener)=0 |
Remove a property listener. | |
virtual void | SetProperty (const char *name, iCelEntity *entity)=0 |
Set property. | |
virtual void | SetProperty (const char *name, iCelPropertyClass *pclass)=0 |
Set property. | |
virtual void | SetProperty (const char *name, const csColor &value)=0 |
Set property. | |
virtual void | SetProperty (const char *name, const csVector3 &value)=0 |
Set property. | |
virtual void | SetProperty (const char *name, const csVector2 &value)=0 |
Set property. | |
virtual void | SetProperty (const char *name, const char *value)=0 |
Set property. | |
virtual void | SetProperty (const char *name, bool value)=0 |
Set property. | |
virtual void | SetProperty (const char *name, long value)=0 |
Set property. | |
virtual void | SetProperty (const char *name, float value)=0 |
Set property. | |
virtual void | SetPropertyIndex (size_t index, iCelEntity *entity)=0 |
Set property based on index. | |
virtual void | SetPropertyIndex (size_t index, iCelPropertyClass *pc)=0 |
Set property based on index. | |
virtual void | SetPropertyIndex (size_t index, const char *value)=0 |
Set property based on index. | |
virtual void | SetPropertyIndex (size_t index, const csColor &value)=0 |
Set property based on index. | |
virtual void | SetPropertyIndex (size_t index, const csVector3 &value)=0 |
Set property based on index. | |
virtual void | SetPropertyIndex (size_t index, const csVector2 &value)=0 |
Set property based on index. | |
virtual void | SetPropertyIndex (size_t index, bool value)=0 |
Set property based on index. | |
virtual void | SetPropertyIndex (size_t index, long value)=0 |
Set property based on index. | |
virtual void | SetPropertyIndex (size_t index, float value)=0 |
Set property based on index. |
Detailed Description
This is a general property class.This property class can send out the following messages to the behaviour (add prefix 'cel.parameter.' to get the ID for parameters):
- pcproperties_setproperty: sets the property (index)
- pcproperties_clearproperty: clears the property (index)
Definition at line 59 of file prop.h.
Member Function Documentation
|
Add a property listener. Property listeners are called right before the behaviour is called. |
|
Clear all properties.
|
|
Clear a property.
|
|
Debug dump information.
|
|
Get property as bool. Returns false if wrong type. |
|
Get property as bool. Returns false if wrong type. |
|
Get the number of properties defined in this property class.
|
|
Get property as entity. Returns 0 if wrong type. |
|
Get property as float. Returns 0 if wrong type. |
|
Get the specified property index for a named property. Returns -1 if not found. |
|
Get property as long. Returns 0 if wrong type. |
|
Get the specified property name.
|
|
Get property as property class. Returns 0 if wrong type. |
|
Get property as string. Returns 0 if wrong type. |
|
Get the type of a property. Returns CEL_DATA_NONE if the property is undefined. Note that only the following data types are supported:
|
|
Get property as bool. Returns false if wrong type. |
|
Get property as bool. Returns false if wrong type. |
|
Remove a property listener.
|
|
Set property.
|
|
Set property.
|
|
Set property.
|
|
Set property.
|
|
Set property.
|
|
Set property.
|
|
Set property.
|
|
Set property.
|
|
Set property.
|
|
Set property based on index.
|
|
Set property based on index.
|
|
Set property based on index.
|
|
Set property based on index.
|
|
Set property based on index.
|
|
Set property based on index.
|
|
Set property based on index.
|
|
Set property based on index.
|
|
Set property based on index.
|
The documentation for this struct was generated from the following file:
- propclass/prop.h
Generated for CEL: Crystal Entity Layer by doxygen 1.4.6