iCelPropertyClass Struct ReferenceThis is a property class for an entity. More...
#include <physicallayer/propclas.h>
Detailed DescriptionThis.
Get the parent entity associated with this property class.
Referenced by celStandardLocalEntitySet::IsLocal().
Get the name of this property class.
Return the persistent data of this property class.
Note: this function replaces the Save function.
Return the number of supported properties and actions.
Get a property as bool.
Get a property as a color.
Get a property as entity.
Get a property as float.
Get a property as iBase.
Get a property as long.
Get the description of the given property or action.
Get the ID of the given property or action.
Get the type of the given property or action.
Returns CEL_DATA_NONE if property is not supported. Only the following types are supported:
- CEL_DATA_LONG
- CEL_DATA_FLOAT
- CEL_DATA_BOOL
- CEL_DATA_STRING
- CEL_DATA_VECTOR2
- CEL_DATA_VECTOR3
- CEL_DATA_COLOR
- CEL_DATA_ACTION
- CEL_DATA_PCLASS
- CEL_DATA_ENTITY
Get a property as property class.
Get a property as string.
Get a property as a 3D vector.
Get a property as a 2D vector.
Get the tag of this property class or return 0 if there is no tag.
Return true if a property is read-only.
Load this object from a data buffer.
Load this object from a data buffer.
This is the first pass version. Most property classes will return 0 here.
Perform an action with a generic string parameter.
- Parameters:
-
This method is called by the parent entity when there is a change in property class setting.
i.e. another property class has been added or removed from the entity. This allows this property class to make adjustments to the references it keeps internally for other property classes. here.
Set the entity for this property class.
Read the state of this property class from some persistent data.
Note: this function replaces the Load function.
- Parameters:
-
- Returns:
- Whether a problem has been encountered or not. Cheats can happen only if the type of the persistence source is CEL_PERSIST_TYPE_CLIENT_CONTROL (ie, when we are on the server side and the entity is controlled by a client).
Set a generic property.
Set a generic property.
Set a generic property.
Set a generic property.
Set a generic property.
Set a generic property.
Set a generic property.
Set a generic property.
Set a generic property.
Set a generic property.
In order to make it easier to access properties in a property class from general scripting languages this generic interface to properties is provided. It is always faster and more efficient to set properties directly but this system is usable in general.
This function returns false if the property could not be set for some reason.
The physical layer maintains a registry of ID's to use. The convention is to use property names like: 'cel.property.num'.
Set the optional tag of this property class.
Multiple property classes of the same type (same name) can be attached to the same entity. To do that you need to add a tag so that you can uniquely identify them.
The documentation for this struct was generated from the following file:
- physicallayer/propclas.h
Generated for CEL: Crystal Entity Layer by doxygen 1.4.7